Namespaces | |
Bentley | |
The Bentley namespace contains types defined by the Bentley Library. | |
Bentley::DgnPlatform | |
The DgnPlatform namespace contains types defined by the DgnPlatform. | |
Classes | |
struct | ITagCreateData |
A helper class to provide data while creating tag elements. More... | |
struct | TagElementHandler |
The default type handler for the ATTRIBUTE_ELM type that corresponds to the AttributeElm structure. More... | |
Typedefs | |
typedef RefCountedPtr < ITagCreateData > | ITagCreateDataPtr |
Functions | |
static DGNPLATFORM_EXPORT ITagCreateDataPtr | Create (WCharCP tagName, WCharCP tagSetName, DgnTextStyleCR style, DgnFileR dgnFile) |
Fill the tag create data structure with values required to create a tag. More... | |
DGNPLATFORM_EXPORT BentleyStatus | SetAttributeValue (DgnTagValueCR value) |
Set the value associated with the tag. More... | |
DGNPLATFORM_EXPORT void | SetTagVisibility (bool hide) |
Set the value associated with the tag. More... | |
DGNPLATFORM_EXPORT | ~ITagCreateData () |
Destructor. More... | |
static DGNPLATFORM_EXPORT ElementId | GetSetDefinitionID (ElementHandleCR in) |
Gets element Id of the tagset associated with this tag element. More... | |
static DGNPLATFORM_EXPORT BentleyStatus | SetSetDefinitionID (EditElementHandleR in, ElementId id) |
Sets element Id of the tagset associated with this tag element. More... | |
static DGNPLATFORM_EXPORT BentleyStatus | GetSetName (WCharP name, int bufferSize, ElementHandleCR in, DgnModelR dgnCache) |
Gets tag set name. More... | |
static DGNPLATFORM_EXPORT BentleyStatus | Extract (DgnTagDefinitionR tagDef, ElementHandleCR in, DgnModelR dgnCache) |
Extract the tag definitions associated with a tag element. More... | |
static DGNPLATFORM_EXPORT BentleyStatus | Extract (DgnTagSpec &tagSpec, ElementHandleCR in, DgnModelR dgnCache) |
Extract the tagspec associated with a tag element. More... | |
static DGNPLATFORM_EXPORT BentleyStatus | Create (EditElementHandleR tagOut, ElementHandleCP templateElement, ITagCreateDataCR tagInfo, DgnModelRefR model, bool is3d, DPoint3dCR origin, RotMatrixCR orientation, ElementRefP target) |
Create a new tag element. More... | |
static DGNPLATFORM_EXPORT BentleyStatus | GetTargetElement (ElementHandleR targetOut, ElementHandleCR tagElement) |
Get the target element associated with the tag element. More... | |
static DGNPLATFORM_EXPORT BentleyStatus | SetAttributeValue (EditElementHandleR tagElement, DgnTagValueCR value) |
Modify the attribute value associated with the tag element. More... | |
static DGNPLATFORM_EXPORT BentleyStatus | GetAttributeValue (ElementHandleCR tagElement, DgnTagValueR value) |
Get the attribute value associated with the tag element. More... | |
static DGNPLATFORM_EXPORT BentleyStatus | SetVisibility (EditElementHandleR tagElement, bool hide, bool isSharedCell) |
Modify the visibility of a tag element. More... | |
static DGNPLATFORM_EXPORT void | SetOffset (EditElementHandleR tagElement, DPoint3dCR offset) |
Modify the origin offset stored in the tag element. More... | |
typedef RefCountedPtr<ITagCreateData> ITagCreateDataPtr |
|
static |
Fill the tag create data structure with values required to create a tag.
tagName | IN name of the tag element |
tagSetName | IN name of the tag set |
style | IN style associated with the tag element. A tag element only supports a subset of all the text style properties. |
dgnFile | IN Destination file for the tag element. |
|
static |
Create a new tag element.
tagOut | OUT Newly created tag element. |
templateElement | IN an element template to base the properties on. Can be null. |
tagInfo | IN Required data structure which specifies the tag element details. |
model | IN Model associated with the element. |
is3d | IN Is a 3d element. |
origin | IN Origin of the tag element. |
orientation | IN Orientation of the tag element. |
target | IN Target of the tag element. Can be null |
|
static |
Extract the tag definitions associated with a tag element.
tagDef | OUT filled tag definition information |
in | IN tag element |
dgnCache | IN the loaded DGN cache to search for tag definition |
|
static |
Extract the tagspec associated with a tag element.
tagSpec | OUT filled tagspec information |
in | IN tag element |
dgnCache | IN the loaded DGN cache to search for tag definition |
|
static |
Get the attribute value associated with the tag element.
tagElement | IN tag element. |
value | OUT value. |
|
static |
Gets element Id of the tagset associated with this tag element.
in | IN tag element |
|
static |
Gets tag set name.
name | OUT tag set name |
bufferSize | IN sizeof(allocated) name bugger |
in | IN tag element |
dgnCache | IN the loaded DGN cache to search for tag definition |
|
static |
Get the target element associated with the tag element.
targetOut | OUT Target element. |
tagElement | IN Tag element to query on. |
DGNPLATFORM_EXPORT BentleyStatus SetAttributeValue | ( | DgnTagValueCR | value | ) |
Set the value associated with the tag.
By default, the value comes from the default value of tag in the tagset
value | IN tag value. |
|
static |
Modify the attribute value associated with the tag element.
tagElement | IN Target element. |
value | IN The new value to set. |
|
static |
Modify the origin offset stored in the tag element.
tagElement | IN tag element |
offset | IN new offset |
|
static |
Sets element Id of the tagset associated with this tag element.
in | IN tag element |
id | IN tagset element id |
DGNPLATFORM_EXPORT void SetTagVisibility | ( | bool | hide | ) |
Set the value associated with the tag.
hide | IN set true to hide the tag element. |
|
static |
Modify the visibility of a tag element.
tagElement | IN tag element |
hide | IN bool whether to hide the tag element |
isSharedCell | IN bool whether it is associated with a shared cell |
DGNPLATFORM_EXPORT ~ITagCreateData | ( | ) |
Destructor.