SetAttribute Method

SetAttribute Method (McDataNodes)

Description

Set the value of an attribute on the Selection or the Current.

Return Type

A Long value.

Syntax

object.SetAttribute (sAttributeDisplayName, sAttributeKeyName, eATBType, sFormat, vValue, bJustCurrentNoSelection, [eFlagsToOr])

The SetAttribute Method syntax has these parts:

Part	Description
object	An expression evaluating to an object of type McDataNodes.
sAttributeDisplayName	Required. A String value. Display name of the attribute
sAttributeKeyName	Required. A String value. KeyName (McAttributeType.Name) name of the attribute.
eATBType	Required. A mcDBAtbType enumeration, as described in settings. Storage type of the attribute.
sFormat	Required. A String value. Optional DisplayFormat for the attribute (vbNullString).
vValue	Required. A Variant value. Required value for attribute that must be compatible with eAtbType.
bJustCurrentNoSelection	Required. A Boolean value. When True the current will be affected rather than the Selection
eFlagsToOr	Optional. A mcDataAttributeFlags enumeration, as described in settings. Flags values to Add to the the McAttributeType to hide or protect the attribute from the user interface.

Settings

The settings for eATBType are:

Constant		Value	Description
	mcdbEmpty	1	No value: not valid for defining an McDBAttributeType
	mcdbOther	2	A value handled by a module other than McDBLib
	mcdbLong	3	A single, integral Long value
	mcdbBlob	4	An array of Byte values
	mcdbDate	5	A single Date value
	mcdbString	6	A single String value
	mcdbDouble	7	A single, real numeric (Double) value
	mcdbObject	8	An OLE object
	mcdbEnum	9	A discrete, pre-defined String Choice value
	mcdbNodeAtb	10	A McDBNode, having its own McDBType, but no location in the McDBNode hierarchy
	mcdbArrayDouble	11	An array of real, numeric (Double) values
	mcdbArrayLong	12	An array of integral Long values
	mcdbArrayString	13	An array of String values

The settings for eFlagsToOr are:

Constant		Value	Description
	mcdataf_AttributeNodeOnly	32768	A McDBNode of this type should only be created as an attribute and not as a Child so that McDBNode::IsContainer is false (McDBType). This value may be used to filter out Attribute hierarchy McDBType instances.
	mcdataf_NoExtract	851968	Do not attempt to extract content for this Object (McDBAttributeType,McDBType)
	mcdataf_RestoreNew	131072	Attempt load of non-existing content from database to an object (McDBAttributeType,McDBType).
	mcdataf_NoArchive	262144	Do not attempt to save content from an object to a database (McDBAttributeType,McDBType).
	mcdataf_NoRestoreExisting	524288	Do not attempt overwrite on existing content from database to an object(McDBAttributeType)
	mcdataf_FolderNode	524288	A McDBNode with a Folder McDBType must have Folder McDBType Parents (McDBType).
	mcdataf_System	1048576	System Attribute disallows user-interface manipulation of object (McDBNode, McDBType, McDBAttributeType). System Attribute may disallow user-interface manipulation
	mcdataf_Hidden	2097152	Hidden Attribute disallows viewing in the user-interface (McDBNode, McDBType, McAttributeType). Hidden Attribute may disallow viewing in the user-interface
	mcdataf_Readonly	4194304	ReadOnly Attribute may disallow user-interface modification (McDBNode, McDBType, McDBAttributeType). ReadOnly Attribute may disallow user-interface modification
	mcdataf_LocalValue	8388608	LocalValue disallows copying to other databases (McDBType,McDBAttributeType). LocalValue may disallow attribute copying to other databases
	mcdataf_AutoList	16777216	AutoList Attributes may populates list of known values (McDBAttributeType). AutoList Attributes may populates list of known values
	mcdataf_Creatable	16777216	A McDBNode of this type may be created by a UI (McDBType).
	mcdataf_AddToMcDBType	16777216	This flag is not persisted in the database but is used by the SetAttribute method to specify that a new McDBAttributeType should be added to McDBNode.Type/
	mcdataf_HideATBType	33554432	Disallows viewing in the user-interface except when value exists (McDBAttributeType).
	mcdataf_Downloadable	33554432	A McDBNode of this type may be downloaded from the web UI (McDBType).
	mcdataf_All_NodeType	67076096	All of the bits that apply to a McDBType
	mcdataf_All_Node	15728640	All of the bits that apply to a McDBNode
	mcdataf_All_Attribute	67043328	All of the bits that apply to a McDBAttributeType
	mcdataf_All	67076096	All of the bits that apply to mcDataAttributeFlags in all objects (McDBNode, McDBType, McDBAttributeType).

Remarks

The McDBAttributeType will be created on each McDBNode instance's McDBType when it does not exist.
A failure will occur when an attribute already exist in the McDBType with .Name = sAttributeKeyName
and a different mcDBAtbType.