ArcObjects Library Reference  (Schematic)    

INgElementType Interface

Provides access to members that control the graphic element type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Schematics Extension.

Description

An element type holds the common properties of one element’s type in a project. The common properties of an element are stored and defined by the element type. Element types support parent–child relationships, allowing a child element type to inherit the parameters set for its parent. Typically, a parent element type may not be displayed in a diagram; only the child element types are displayed by associating them with a diagram type.

Generally, an element group is also associated with an element type. An element group is a set of elements that have the same graphic effects. When you create a new element type, you have to decide if your new element type will be associated with an element group or not. Even if you can redefine element types as a group at any time, this decision is important. It determines what you will afterward be authorized to define for your element type. When your element type is a group, you can define any graphic effects and create any property on it. If your element type is not a group, it is impossible. By default, if an element type inherits from another element type, and if it is not a group, it inherits the graphic effects and properties defined for the first of its ancestor element types, which is a group itself.


When you define an element type, you typically declare:

- The name of this element type,

- The type of the elements (node, link, drawing, sublink or node-on-link),

- Eventually, the name of its parent element type.

If you want to create an element type, you can use the ArcGIS Schematics Designer or call the CreateElementType method available from the INgProjectBuilder interface in your program code.


Your element type definition can be then completed by defining:

- The query returning all the elements of this element type,

- The fields used to build up each element identifier for this type,

- The attributes associated with this element type,

- The properties associated with this element type,

- The userdata associated with this element type.

All these characteristics can be defined through the ArcGIS Schematics Designer, or in your program code through the INgObjectType interface associated with your INgElementType interface.

Members

Description
Method AddFlagModel Associates the specified flag model with the element type. The optional 'mode' parameter specifies the connection mode for the flag pole. Its default value is 'esriNgStandard'.
Method AddPatternModel Associates the specified pattern model with the element type.
Read-only property Ancestors List of the ancestor element types for the element type.
Read-only property AssociatedDiagramTypes List of the diagram types the element type is associated with.
Read-only property AssociatedProperties List of properties related to the element type that are associated with the attribute named 'attributeName' or the list of all the properties related to the element type when no attribute name is specified.
Read-only property AssociatedPropertyAttribute Attribute associated with the property named 'propertyName' that is defined for the element type.
Read-only property AssociatedUserDataAttribute Attribute associated with the userdata named 'userdataName' that is defined for the element type.
Read-only property AssociatedUserDatas List of userdata related to the element type that are associated with the attribute named 'attributeName' or the list of all the userdata related to the element type when no attribute name is specified.
Method AssociateProperty Relates the specified property to the element type and associates this property with the attribute named 'attributeName'.
Method AssociateUserData Relates the specified userdata to the element type and associates this userdata with the attribute named 'attributeName'.
Read-only property Children List of the child element types for the element type.
Method CreateProperty Creates the new property named 'name' for the element type. The 'propertyType' parameter specifies the property type and the 'propertyValue' parameter specifies the type of property value.
Method Delete Deletes the element type. When setting the 'deleteDescendants' parameter to TRUE, all the element types that inherit from this element type are also deleted.
Read-only property Descendants List of the descendant element types for the element type.
Method DissociateProperty Deletes the association between the specified property and the element type.
Method DissociateUserData Deletes the association between the specified userdata and the element type.
Read-only property ElementGroup Element group related to the element type. It is the current element type itself or one of its ancestor element types.
Read-only property Elements List of the elements implemented by the element type.
Read-only property ElementTypeEffects List of the effects set for the element type.
Read-only property FlagModels List of flag models associated with the element type.
Method GetEffect Returns the effect 'effect' set for the element type (see esriNgElementTypeEffect).
Method GetElement Returns the element named 'eltName' implemented by the element type.
Method GetElementsByUserData Returns the list of the elements that are implemented by this element type and which each associated user-data in the 'userDatas' list verifies the 'values' list corresponding values.
Method GetFlagModel Returns the flag model named 'flagModelName' associated with the element type.
Method GetPatternModel Returns the pattern model named 'patternModelName' associated with the element type.
Method GetPoleEffect Returns the effect 'effect' set for the pole that connects the flags of the flag model named 'flagModelName' associated with the element type.
Method GetProperty Returns the property named 'propertyName' associated with the element type.
Method GetSubSymbolEffect Returns the effect 'effect' set for the sub-symbol named 'subName' that represents the element type.
Method IsEffectSet Indicates if the effect 'effect' related to the element type is set (see esriNgElementTypeEffect).
Read/write property IsElementGroup Indicates if the element type is associated with an element group.
Method IsPoleEffectSet Indicates if the effect 'effect' related to the pole that connects the flags of the flag model named 'flagModelName' associated with the element type is set.
Method IsSubSymbolEffectSet Indicates if the effect 'effect' related to the sub-symbol named 'subName' that represents the element type is set.
Read/write property Name Name of the element type.
Read/write property Parent Parent element type of the element type.
Read-only property PatternModels List of pattern models associated with the element type.
Read-only property Properties List of the properties associated with the element type.
Method RemoveEffect Removes the effect or restores the effect 'effect' set for the element type (see esriNgElementTypeEffect).
Method RemoveFlagModel Removes the association between the specified flag model and the element type.
Method RemovePatternModel Removes the association between the specified pattern model and the element type.
Method RemovePoleEffect Removes the effect or restores the default effect 'effect' for the pole that connects the flags of the flag model named 'flagModelName' associated with the element type.
Method RemoveSubSymbolEffect Removes the effect 'effect' set for the sub-symbol named 'subName' that represents the element type.
Method SetEffect Modifies the effect 'effect' set for the element type (see esriNgElementTypeEffect).
Method SetPoleEffect Modifies the effect 'effect' set for the pole that connects the flags of the flag model named 'flagModelName' associated with the element type.
Method SetSubSymbolEffect Modifies the effect 'effect' set for the sub-symbol named 'subName' that represents the element type.
Read-only property Type Type of the element type (see esriNgElementTypeEnum).

CoClasses that implement INgElementType

CoClasses and Classes Description
NgElementType Graphic element type object.

See Also

INgElement Interface | ISchematicElementClass Interface

 


Feedback Send feedback on this page