Namespaces | Classes | Typedefs | Functions

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...
 

Detailed Description

Typedef Documentation

typedef RefCountedPtr<ITagCreateData> ITagCreateDataPtr

Function Documentation

static DGNPLATFORM_EXPORT ITagCreateDataPtr Create ( WCharCP  tagName,
WCharCP  tagSetName,
DgnTextStyleCR  style,
DgnFileR  dgnFile 
)
static

Fill the tag create data structure with values required to create a tag.

Parameters
tagNameIN name of the tag element
tagSetNameIN name of the tag set
styleIN style associated with the tag element. A tag element only supports a subset of all the text style properties.
dgnFileIN Destination file for the tag element.
Remarks
by default tags created are visible.
static DGNPLATFORM_EXPORT BentleyStatus Create ( EditElementHandleR  tagOut,
ElementHandleCP  templateElement,
ITagCreateDataCR  tagInfo,
DgnModelRefR  model,
bool  is3d,
DPoint3dCR  origin,
RotMatrixCR  orientation,
ElementRefP  target 
)
static

Create a new tag element.

Parameters
tagOutOUT Newly created tag element.
templateElementIN an element template to base the properties on. Can be null.
tagInfoIN Required data structure which specifies the tag element details.
modelIN Model associated with the element.
is3dIN Is a 3d element.
originIN Origin of the tag element.
orientationIN Orientation of the tag element.
targetIN Target of the tag element. Can be null
static DGNPLATFORM_EXPORT BentleyStatus Extract ( DgnTagDefinitionR  tagDef,
ElementHandleCR  in,
DgnModelR  dgnCache 
)
static

Extract the tag definitions associated with a tag element.

Parameters
tagDefOUT filled tag definition information
inIN tag element
dgnCacheIN the loaded DGN cache to search for tag definition
static DGNPLATFORM_EXPORT BentleyStatus Extract ( DgnTagSpec tagSpec,
ElementHandleCR  in,
DgnModelR  dgnCache 
)
static

Extract the tagspec associated with a tag element.

Parameters
tagSpecOUT filled tagspec information
inIN tag element
dgnCacheIN the loaded DGN cache to search for tag definition
static DGNPLATFORM_EXPORT BentleyStatus GetAttributeValue ( ElementHandleCR  tagElement,
DgnTagValueR  value 
)
static

Get the attribute value associated with the tag element.

Parameters
tagElementIN tag element.
valueOUT value.
static DGNPLATFORM_EXPORT ElementId GetSetDefinitionID ( ElementHandleCR  in)
static

Gets element Id of the tagset associated with this tag element.

Parameters
inIN tag element
static DGNPLATFORM_EXPORT BentleyStatus GetSetName ( WCharP  name,
int  bufferSize,
ElementHandleCR  in,
DgnModelR  dgnCache 
)
static

Gets tag set name.

Parameters
nameOUT tag set name
bufferSizeIN sizeof(allocated) name bugger
inIN tag element
dgnCacheIN the loaded DGN cache to search for tag definition
static DGNPLATFORM_EXPORT BentleyStatus GetTargetElement ( ElementHandleR  targetOut,
ElementHandleCR  tagElement 
)
static

Get the target element associated with the tag element.

Parameters
targetOutOUT Target element.
tagElementIN 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

Parameters
valueIN tag value.
static DGNPLATFORM_EXPORT BentleyStatus SetAttributeValue ( EditElementHandleR  tagElement,
DgnTagValueCR  value 
)
static

Modify the attribute value associated with the tag element.

Parameters
tagElementIN Target element.
valueIN The new value to set.
static DGNPLATFORM_EXPORT void SetOffset ( EditElementHandleR  tagElement,
DPoint3dCR  offset 
)
static

Modify the origin offset stored in the tag element.

Parameters
tagElementIN tag element
offsetIN new offset
static DGNPLATFORM_EXPORT BentleyStatus SetSetDefinitionID ( EditElementHandleR  in,
ElementId  id 
)
static

Sets element Id of the tagset associated with this tag element.

Parameters
inIN tag element
idIN tagset element id
DGNPLATFORM_EXPORT void SetTagVisibility ( bool  hide)

Set the value associated with the tag.

Parameters
hideIN set true to hide the tag element.
static DGNPLATFORM_EXPORT BentleyStatus SetVisibility ( EditElementHandleR  tagElement,
bool  hide,
bool  isSharedCell 
)
static

Modify the visibility of a tag element.

Parameters
tagElementIN tag element
hideIN bool whether to hide the tag element
isSharedCellIN bool whether it is associated with a shared cell
DGNPLATFORM_EXPORT ~ITagCreateData ( )

Destructor.


Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.