ICustomAttributeServiceGetCustomAttribute(String) Method |
Gets a custom attribute by name.
Namespace: Dundas.BI.AccountServicesAssembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (26.2.0.1000)
SyntaxCustomAttributeInfo? GetCustomAttribute(
string name
)
Function GetCustomAttribute (
name As String
) As CustomAttributeInfo
CustomAttributeInfo^ GetCustomAttribute(
String^ name
)
abstract GetCustomAttribute :
name : string -> CustomAttributeInfo Parameters
- name String
- The name of the custom attribute.
Return Value
CustomAttributeInfo
The custom attribute definition corresponding to the requested attribute, or
if the attribute was not found.
Exceptions
Example
This example demonstrates how to create the Dundas BI engine, start the Dundas BI engine, log on, create a custom attribute called Daves, assign that custom attribute to the Dave accounts, and then shutdown the Dundas BI engine.
using Dundas.BI;
using Dundas.BI.AccountServices;
using Dundas.BI.Services;
using System.Collections.ObjectModel;
...
EngineManager.CreateEngine(
@"C:\Program Files\Dundas Data Visualization Inc\Dundas BI\Instances\Instance1\www\BIWebsite\App_Data"
);
try
{
EngineManager.StartEngine();
using(Engine.Current.GetService<ICallerContextService>().CreateAndSetCurrentContext(null))
{
LogOnResult logOnResult = Engine.Current.GetService<ILogOnService>().LogOn(
"admin",
"1234",
true,
null
);
Engine.Current.GetService<ICallerContextService>().CurrentContext.SetCurrentSessionId(
logOnResult.Session.Id
);
ICustomAttributeService customAttributeService =
Engine.Current.GetService<ICustomAttributeService>();
customAttributeService.SaveCustomAttribute(
new CustomAttributeInfo()
{
Description = "These are the Daves I know",
Name = "Daves",
InheritanceBehavior = CustomAttributeInheritanceBehavior.Override,
IsMultiValue = false
}
);
var davesCustomAttribute = customAttributeService.GetCustomAttribute("Daves");
IAccountService accountService =
Engine.Current.GetService<IAccountService>();
AccountQueryFilterRule accountQueryFilterRule =
new AccountQueryFilterRule(
AccountQueryField.DisplayName,
Dundas.BI.QueryFilterOperator.StartsWith,
"dav"
);
IList<Account> daveAccounts =
accountService.AccountQuery(
0,
0,
null,
new List<AccountQueryFilterRule>() {
accountQueryFilterRule
}
);
foreach(Account daveAccount in daveAccounts)
{
daveAccount.CustomAttributes.Add(
davesCustomAttribute.Id, new CustomAttributeValue(davesCustomAttribute.Id) { SingleValue = "Is a Dave I know" }
);
accountService.SaveAccount(daveAccount);
}
}
}
finally
{
EngineManager.ShutdownEngine();
}
See Also