M_AML_ListAttribute_ListAttribute_CreateListAttribute

ListAttribute.CreateListAttribute Method

Creates a new list attribute for an element which can have attributes.

Namespace: AML.ListAttribute
Assembly: AMLEngineExtensions (in AMLEngineExtensions.dll) Version: 3.5

Syntax

C#

public static AttributeType CreateListAttribute(
	this IObjectWithAttributes element,
	string attributeName,
	int itemsCount,
	string itemType,
	string itemName = "item",
	bool isOrderedList = false
)

C++

public:
[ExtensionAttribute]
static AttributeType^ CreateListAttribute(
	IObjectWithAttributes^ element, 
	String^ attributeName, 
	int itemsCount, 
	String^ itemType, 
	String^ itemName = L"item", 
	bool isOrderedList = false
)

Parameters

 

element

Type: CAEX_ClassModel.IObjectWithAttributes
The element.

attributeName

Type: System.String
Name of the new list attribute.

itemsCount

Type: System.Int32
The items count for initialization of the containing attribute items.

itemType

Type: System.String
Type of the item (unique for all items).

itemName (Optional)

Type: System.String
Name of the item (ignored if an ordered list is created). When an item attribute is created, the item Name gets the item index added to this name.

isOrderedList (Optional)

Type: System.Boolean
if set to true the list is an ordered list.

Return Value

Type: AttributeType
The list AttributeType.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IObjectWithAttributes. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

See Also

Reference

ListAttribute Class
AML.ListAttribute Namespace