Element Templates

Classes
struct	ElementTemplateNode
	Element templates define symbology properties. More...
struct	ElementTemplateParamsHelper
	The ElementTemplateParamsHelper class provide methods to add and set properties in the default instance of an element template. More...
struct	ElementTemplateUtils
	The ElementTemplateUtils class is a utility class used to locate, write, and delete Element Templates. More...
struct	elementfillcolordata
	Element fill color data. More...

Typedefs
typedef enum Bentley::DgnPlatform::ElementParameterType	ElementParameterType
	ElementParameterType is an enum of the built-in element parameter types that can be defined within an element template. More...
typedef struct Bentley::elementfillcolordata	ElementFillColorData
	Element fill color data. More...

Enumerations
enum	ElementParameterType {   ELEMENTPARAM_Level = 0, ELEMENTPARAM_Color = 1, ELEMENTPARAM_Weight = 2, ELEMENTPARAM_LineStyle = 3,   ELEMENTPARAM_LineStyleParam = 4, ELEMENTPARAM_Class = 5, ELEMENTPARAM_Transparency = 6, ELEMENTPARAM_Priority = 7,   ELEMENTPARAM_AreaMode = 8, ELEMENTPARAM_FillColor = 9, ELEMENTPARAM_FillMode = 10, ELEMENTPARAM_CellName = 11,   ELEMENTPARAM_Scale = 12, ELEMENTPARAM_Terminator = 13, ELEMENTPARAM_TerminatorScale = 14, ELEMENTPARAM_ActivePoint = 15,   ELEMENTPARAM_TextStyle = 16, ELEMENTPARAM_TextStyleOverride = 17, ELEMENTPARAM_PatternCell = 18, ELEMENTPARAM_PatternDelta = 19,   ELEMENTPARAM_PatternAngle = 20, ELEMENTPARAM_PatternScale = 21, ELEMENTPARAM_AreaPatternDelta = 22, ELEMENTPARAM_AreaPatternAngle = 23,   ELEMENTPARAM_MlineStyle = 24, ELEMENTPARAM_DimensionStyle = 25, ELEMENTPARAM_Material = 26, ELEMENTPARAM_DetailSymbolStyle = 27,   ELEMENTPARAM_PatternIsAnnotation = 28 }
	ElementParameterType is an enum of the built-in element parameter types that can be defined within an element template. More...
enum	ElementTemplateStatus {   ETSTATUS_Success = BSISUCCESS, ETSTATUS_BadArg = 1, ETSTATUS_InvalidFile = 2, ETSTATUS_InvalidDataTreeOwner = 3,   ETSTATUS_InvalidPath = 4, ETSTATUS_PathAlreadyDefined = 5, ETSTATUS_UnableToAccessDataTree = 6, ETSTATUS_UnableToCreateNewGroupNode = 7,   ETSTATUS_UnableToCreateNewTemplateNode = 8, ETSTATUS_InvalidArgument = 9, ETSTATUS_UnableToDeleteReadOnly = 10, ETSTATUS_UnableToDeleteReferenceNode = 11,   ETSTATUS_UnableToDeleteNode = 12, ETSTATUS_NoDefaultInstanceFound = 13, ETSTATUS_InvalidTemplateParameter = 14, ETSTATUS_InvalidPropertySpecification = 15,   ETSTATUS_BadPropertyValue = 16, ETSTATUS_NullPropertyValue = 17, ETSTATUS_InvalidLevelId = 18, ETSTATUS_UnableToAddParameter = 19,   ETSTATUS_NoStructInstanceFound = 20, ETSTATUS_TemplateNotInFile = 21, ETSTATUS_InvalidMaterialId = 22, ETSTATUS_NullModelRef = 23,   ETSTATUS_NoTemplateId = 24, ETSTATUS_UnableToAddGradientKeys = 25, ETSTATUS_InvalidMlineStyleId = 26, ETSTATUS_InvalidDimensionStyleId = 27,   ETSTATUS_UnableToImportItemSchema = 28, ETSTATUS_InvalidElementRefForNode = 29, ETSTATUS_InvalidEnabler = 30, ETSTATUS_UnableToSetParameter = 31,   ETSTATUS_InvalidArrayIndex = 32, ETSTATUS_UnableToRemoveParameter = 33, ETSTATUS_LevelNameDoesNotExist = 34, ETSTATUS_NoColorTypeSpecified = 35,   ETSTATUS_InvalidLineWeightValue = 36, ETSTATUS_UnableToLoadMaterialById = 37, ETSTATUS_InvalidParameterValue = 38, ETSTATUS_NoTemplateReferenceFound = 39,   ETSTATUS_UnableToWriteToReadOnlyFile = 40, ETSTATUS_Error = BSIERROR }
	Indicates status from ElementTemplate API methods. More...
enum	ActivePointType { ACTIVEPOINTTYPE_ZeroLengthLine = 0, ACTIVEPOINTTYPE_Character = 1, ACTIVEPOINTTYPE_Cell = 2 }
	ActivePoint types. More...
enum	ElementColorSource { COLORSOURCE_Element = 0, COLORSOURCE_ByLevel = 1, COLORSOURCE_ByCell = 2 }
	ColorSource types. More...
enum	ElementFillModeType { FILLMODE_UseActive = -1, FILLMODE_NotFilled = 0, FILLMODE_Filled = 1, FILLMODE_Outlined = 2 }
	ElementFillMode types. More...
enum	ElementColorType {   COLORTYPE_None = 0, COLORTYPE_Indexed = 1, COLORTYPE_RGB = 2, COLORTYPE_ColorBook = 3,   COLORTYPE_GradientFill = 4 }
	ColorType types. More...

Detailed Description

Typedef Documentation

typedef struct Bentley::elementfillcolordata ElementFillColorData

Element fill color data.

typedef enum Bentley::DgnPlatform::ElementParameterType ElementParameterType

ElementParameterType is an enum of the built-in element parameter types that can be defined within an element template.

Enumeration Type Documentation

enum ActivePointType

ActivePoint types.

Enumerator
ACTIVEPOINTTYPE_ZeroLengthLine
ACTIVEPOINTTYPE_Character
ACTIVEPOINTTYPE_Cell

enum ElementColorSource

ColorSource types.

Enumerator
COLORSOURCE_Element
COLORSOURCE_ByLevel
COLORSOURCE_ByCell

enum ElementColorType

ColorType types.

Enumerator
COLORTYPE_None
COLORTYPE_Indexed
COLORTYPE_RGB
COLORTYPE_ColorBook
COLORTYPE_GradientFill

enum ElementFillModeType

ElementFillMode types.

Enumerator
FILLMODE_UseActive
FILLMODE_NotFilled
FILLMODE_Filled
FILLMODE_Outlined

enum ElementParameterType

ElementParameterType is an enum of the built-in element parameter types that can be defined within an element template.

Enumerator
ELEMENTPARAM_Level	Level name defined in value.wCharPFormat.
ELEMENTPARAM_Color	ElementColorData* stored in value.voidPFormat.
ELEMENTPARAM_Weight	Weight stored in value.sLongFormat.
ELEMENTPARAM_LineStyle	Line Style name stored in value.wCharPFormat.
ELEMENTPARAM_LineStyleParam	LineStyleParamData* stored in value.voidPFormat.
ELEMENTPARAM_Class	Element class stored in value.sLongFormat.
ELEMENTPARAM_Transparency	Element transparency stored in value.doubleFormat.
ELEMENTPARAM_Priority	Element priority stored in value.sLongFormat.
ELEMENTPARAM_AreaMode	Element area mode stored in value.sLongFormat. Solid=0, Hole=1.
ELEMENTPARAM_FillColor	ElementColorData* stored in value.voidPFormat.
ELEMENTPARAM_FillMode	Element fill mode stored in value.sLongFormat. None=0, Filled=1, 2=Outlined.
ELEMENTPARAM_CellName	Cell name stored in value.wCharPFormat.
ELEMENTPARAM_Scale	Cell scale DPoint3dP stored in value.voidPFormat.
ELEMENTPARAM_Terminator	Terminator cell name stored in value.wCharPFormat.
ELEMENTPARAM_TerminatorScale	Terminator scale stored in value.doubleFormat.
ELEMENTPARAM_ActivePoint	Active point definition ActivePointData* stored in value.voidPFormat.
ELEMENTPARAM_TextStyle	Text Style name stored in value.wCharPFormat.
ELEMENTPARAM_TextStyleOverride	Text style overrides TextStyleOverrideData* stored in value.voidPFormat.
ELEMENTPARAM_PatternCell	Pattern cell name stored in value.wCharPFormat.
ELEMENTPARAM_PatternDelta	Hatch patterning deltas (in meters) PatternDelta* stored in value.voidPFormat.
ELEMENTPARAM_PatternAngle	Hatch patterning angles (in radians) PatternAngle* stored in value.voidPFormat.
ELEMENTPARAM_PatternScale	Pattern cell scale stored in value.doubleFormat.
ELEMENTPARAM_AreaPatternDelta	Cell patterning deltas (in meters) PatternDelta* stored in value.voidPFormat.
ELEMENTPARAM_AreaPatternAngle	Cell patterning angle (in radians) stored in value.doubleFormat.
ELEMENTPARAM_MlineStyle	Multi-line style name stored in value.wCharPFormat.
ELEMENTPARAM_DimensionStyle	Dimension style name stored in value.wCharPFormat.
ELEMENTPARAM_Material	Material name stored as string.
ELEMENTPARAM_DetailSymbolStyle	Detailing Symbol _DetailCalloutStyle name stored as string.
ELEMENTPARAM_PatternIsAnnotation	Hatch / Pattern is an annotation (can be scaled by annotation scale) stored in value.boolFormat.

enum ElementTemplateStatus

Indicates status from ElementTemplate API methods.

Enumerator
ETSTATUS_Success
ETSTATUS_BadArg
ETSTATUS_InvalidFile
ETSTATUS_InvalidDataTreeOwner
ETSTATUS_InvalidPath
ETSTATUS_PathAlreadyDefined
ETSTATUS_UnableToAccessDataTree
ETSTATUS_UnableToCreateNewGroupNode
ETSTATUS_UnableToCreateNewTemplateNode
ETSTATUS_InvalidArgument
ETSTATUS_UnableToDeleteReadOnly
ETSTATUS_UnableToDeleteReferenceNode
ETSTATUS_UnableToDeleteNode
ETSTATUS_NoDefaultInstanceFound
ETSTATUS_InvalidTemplateParameter
ETSTATUS_InvalidPropertySpecification
ETSTATUS_BadPropertyValue
ETSTATUS_NullPropertyValue
ETSTATUS_InvalidLevelId
ETSTATUS_UnableToAddParameter
ETSTATUS_NoStructInstanceFound
ETSTATUS_TemplateNotInFile
ETSTATUS_InvalidMaterialId
ETSTATUS_NullModelRef
ETSTATUS_NoTemplateId
ETSTATUS_UnableToAddGradientKeys
ETSTATUS_InvalidMlineStyleId
ETSTATUS_InvalidDimensionStyleId
ETSTATUS_UnableToImportItemSchema
ETSTATUS_InvalidElementRefForNode
ETSTATUS_InvalidEnabler
ETSTATUS_UnableToSetParameter
ETSTATUS_InvalidArrayIndex
ETSTATUS_UnableToRemoveParameter
ETSTATUS_LevelNameDoesNotExist
ETSTATUS_NoColorTypeSpecified
ETSTATUS_InvalidLineWeightValue
ETSTATUS_UnableToLoadMaterialById
ETSTATUS_InvalidParameterValue
ETSTATUS_NoTemplateReferenceFound
ETSTATUS_UnableToWriteToReadOnlyFile
ETSTATUS_Error