! Provides methods for inspecting the current symbology properties of an element. More...

#include <SymbologyReporter.h>

Inheritance diagram for SymbologyReporter:

Public Types
typedef bvector< Int32 >	T_StdInt32Vector

typedef bvector< UInt32 >	T_StdUInt32Vector

typedef bvector< double >	T_StdDoubleVector

typedef bvector< DPoint3d >	T_StdDPoint3dVector

typedef bvector< bool >	T_StdBoolVector

typedef bvector< Bentley::WString >	T_StdWStringVector

typedef bvector < ElementFillColorData >	T_StdFillColorVector

typedef bvector < LineStyleReportingData >	T_StdLineStyleReportingDataVector

typedef bvector< PatternParamsPtr >	T_StdPatternParamsVector

typedef bvector< MaterialId >	T_StdMaterialIdVector

Public Member Functions
DGNPLATFORM_EXPORT	SymbologyReporter (ElementHandleCR eh)
	Construct an SymbologyReporter object to report on a specific element. More...

DGNPLATFORM_EXPORT StatusInt	GetLevelId (DgnPlatform::LevelId &levelID, UInt index=0)
	Return the level ID. More...

DGNPLATFORM_EXPORT StatusInt	GetFontID (UInt32 &fontID, UInt index=0)
	Return the ID of the font if the element contains text. More...

DGNPLATFORM_EXPORT StatusInt	GetColorID (UInt32 &colorID, UInt index=0)
	Return the ID of the element color. More...

DGNPLATFORM_EXPORT StatusInt	GetTextStyleId (UInt32 &textStyleID, UInt index=0)
	Return the ID of the TextStyle if the element contains text. More...

DGNPLATFORM_EXPORT StatusInt	GetLineStyleID (Int32 &lineStyleID, UInt index=0)
	Return the ID of the LineStyle. More...

DGNPLATFORM_EXPORT StatusInt	GetDimStyleID (DgnPlatform::ElementId &dimStyleID, UInt index=0)
	Return the ID of the Dimension Style if the element is a dimension element. More...

DGNPLATFORM_EXPORT StatusInt	GetLineStyleParams (DgnPlatform::LineStyleParams &lineStyleParams, UInt index=0)
	Return the LineStyle Parameters if the element uses a named line style. More...

DGNPLATFORM_EXPORT StatusInt	GetMlineStyleID (DgnPlatform::ElementId &mlineStyleID, UInt index=0)
	Return the ID of the Multi-Line Style if the element is a Multi-line element. More...

DGNPLATFORM_EXPORT StatusInt	GetMaterialId (DgnPlatform::MaterialId &materialID, UInt index=0)
	Return the Material ID if the element contains a material specification. More...

DGNPLATFORM_EXPORT StatusInt	GetWeight (UInt32 &weight, UInt index=0)
	Return the line weight. More...

DGNPLATFORM_EXPORT StatusInt	GetElementClass (DgnElementClass &elClass, UInt index=0)
	Return the class of the element. More...

DGNPLATFORM_EXPORT StatusInt	GetDisplayPriority (Int32 &displayPriority, UInt index=0)
	Return the display of the element. More...

DGNPLATFORM_EXPORT StatusInt	GetTransparency (double &transparency, UInt index=0)
	Return the transparency value of the element. More...

DGNPLATFORM_EXPORT StatusInt	GetElementTemplateID (DgnPlatform::ElementId &elementTemplateID, UInt index=0)
	Return the ID of the element template associate with the element. More...

DGNPLATFORM_EXPORT StatusInt	GetScale (DPoint3dR scale, UInt index=0)
	Return the Scale of the element if the element supports scaling. More...

DGNPLATFORM_EXPORT StatusInt	GetAnnotationScale (double &scale, UInt index=0)
	Return the Annotation Scale of the element if the element supports annotation scale. More...

DGNPLATFORM_EXPORT StatusInt	GetCellName (WString &cellName, UInt index=0)
	Return the Cell Name if the element is a named cell. More...

DGNPLATFORM_EXPORT StatusInt	GetFillColorIdOrGradientSpecification (UInt32 &color, GradientSymbPtr &gradientsymbPtr, UInt index=0)
	Return the Color Fill specificate if defined for a closed element. More...

DGNPLATFORM_EXPORT StatusInt	GetAreaMode (bool &isHole, UInt index=0)
	Return the AreaMode for a closed element. More...

DGNPLATFORM_EXPORT StatusInt	GetDetailingSymbolStylePath (WString &stylePath, UInt index=0)
	Return the path/name of the Detailing Symbol Style if the element is a Detailing Symbol. More...

DGNPLATFORM_EXPORT StatusInt	GetPatternParams (DgnPlatform::PatternParams &params, UInt index=0)
	Return the pattern parameter of a patterned closed element. More...

DGNPLATFORM_EXPORT StatusInt	GetPatternOrigin (DPoint3dR origin, UInt index=0)
	Return the pattern origin of a patterned closed element. More...

DGNPLATFORM_EXPORT bool	IsStandardCell ()
	Return true if the element is a standard cell instance. More...

DGNPLATFORM_EXPORT bool	IsSharedCell ()
	Return true if the element is a shared cell instance. More...

DGNPLATFORM_EXPORT bool	IsPointCell ()
	Return true if the element is a point cell. More...

DGNPLATFORM_EXPORT bool	Is3dElement ()
	Return true if the element is a 3D element. More...

DGNPLATFORM_EXPORT bool	IsText ()
	Return true if the element is a Text String element. More...

DGNPLATFORM_EXPORT bool	IsTextNode ()
	Return true if the element is a Text Node element. More...

DGNPLATFORM_EXPORT bool	IsClosedElement ()
	Return true if the element is close element. More...

DGNPLATFORM_EXPORT bool	IsRenderableElement ()
	Return true if the element can be rendered. More...

DGNPLATFORM_EXPORT bool	IsDetailingSymbol ()
	Return true if the element is a Detailing Symbol. More...

DGNPLATFORM_EXPORT bool	IsMultiLineElement ()
	Return true if the element is a Multi-Line. More...

DGNPLATFORM_EXPORT bool	IsDimensionElement ()
	Return true if the element is a Dimension. More...

Public Member Functions inherited from IQueryProperties
virtual ElementProperties	_GetQueryPropertiesMask ()
	Called by the element handler to find out which property types are of interest. More...

virtual QueryPropertyPurpose	_GetQueryPropertiesPurpose ()
	Return purpose for which properties are being requested. More...

virtual bool	_WantSharedChildren ()
	Whether to include shared children in property query. More...

Public Member Functions inherited from IProcessProperties
virtual void	_EachLevelCallback (EachLevelArg &)
	Called by the element handler to report levels stored on an element. More...

virtual void	_EachColorCallback (EachColorArg &)
	Called by the element handler to report colors stored on an element. More...

virtual void	_EachLineStyleCallback (EachLineStyleArg &)
	Called by the element handler to report line styles stored on an element. More...

virtual void	_EachFontCallback (EachFontArg &)
	Called by the element handler to report fonts stored on an element. More...

virtual void	_EachTextStyleCallback (EachTextStyleArg &)
	Called by the element handler to report text styles stored on an element. More...

virtual void	_EachDimStyleCallback (EachDimStyleArg &)
	Called by the element handler to report dimension styles stored on an element. More...

virtual void	_EachMLineStyleCallback (EachMLineStyleArg &)
	Called by the element handler to report multiline styles stored on an element. More...

virtual void	_EachMaterialCallback (EachMaterialArg &)
	Called by the element handler to report materials stored on an element. More...

virtual void	_EachWeightCallback (EachWeightArg &)
	Called by the element handler to report weights stored on an element. More...

virtual void	_EachElementClassCallback (EachElementClassArg &)
	Called by the element handler to report classes stored on an element. More...

virtual void	_EachTransparencyCallback (EachTransparencyArg &)
	Called by the element handler to report transparencies stored on an element. More...

virtual void	_EachThicknessCallback (EachThicknessArg &)
	Called by the element handler to report thicknesses stored on an element. More...

virtual void	_EachDisplayPriorityCallback (EachDisplayPriorityArg &)
	Called by the element handler to report display priorities stored on an element. More...

virtual void	_EachElementTemplateCallback (EachElementTemplateArg &)
	Called by the element handler to report element templates stored on an element. More...

Detailed Description

! Provides methods for inspecting the current symbology properties of an element.

! If the element is a complex element it may contain a list of symbology ! values.

Remarks: Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib

Member Typedef Documentation

typedef bvector<bool> T_StdBoolVector

typedef bvector<double> T_StdDoubleVector

typedef bvector<DPoint3d> T_StdDPoint3dVector

typedef bvector<ElementFillColorData> T_StdFillColorVector

typedef bvector<Int32> T_StdInt32Vector

typedef bvector<LineStyleReportingData> T_StdLineStyleReportingDataVector

typedef bvector<MaterialId> T_StdMaterialIdVector

typedef bvector<PatternParamsPtr> T_StdPatternParamsVector

typedef bvector<UInt32> T_StdUInt32Vector

typedef bvector<Bentley::WString> T_StdWStringVector

Constructor & Destructor Documentation

DGNPLATFORM_EXPORT SymbologyReporter ( ElementHandleCR eh )

Construct an SymbologyReporter object to report on a specific element.

Parameters

[in] eh The element whose symbology is to be reported

Member Function Documentation

DGNPLATFORM_EXPORT StatusInt GetAnnotationScale	(	double &	scale,
		UInt	index = `0`
	)

Return the Annotation Scale of the element if the element supports annotation scale.

Parameters

[out]	scale	The scale value to return.
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetAreaMode	(	bool &	isHole,
		UInt	index = `0`
	)

Return the AreaMode for a closed element.

The Area mode designates the element either as a solid or a hole.

Parameters

[out]	isHole	If true the element is considered a hole, if false the it is considered solid.
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetCellName	(	WString &	cellName,
		UInt	index = `0`
	)

Return the Cell Name if the element is a named cell.

Parameters

[out]	cellName	The cell name to return.
[in]	index	For future use. Pass 0 for index, or do not pass paramter and allow the default of 0 to be used.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetColorID	(	UInt32 &	colorID,
		UInt	index = `0`
	)

Return the ID of the element color.

This value can be passed as the element color into DgnColorMap::ExtractElementColorInfo to get more specific color information.

Parameters

[out]	colorID	The FontId to return
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetDetailingSymbolStylePath	(	WString &	stylePath,
		UInt	index = `0`
	)

Return the path/name of the Detailing Symbol Style if the element is a Detailing Symbol.

Parameters

[out]	stylePath	If name of the detailing symbol style.
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetDimStyleID	(	DgnPlatform::ElementId &	dimStyleID,
		UInt	index = `0`
	)

Return the ID of the Dimension Style if the element is a dimension element.

Parameters

[out]	dimStyleID	The Dimension Style Id to return
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetDisplayPriority	(	Int32 &	displayPriority,
		UInt	index = `0`
	)

Return the display of the element.

This is only applicable to elements in 2D models.

Parameters

[out]	displayPriority	The display priority of the element.
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetElementClass	(	DgnElementClass &	elClass,
		UInt	index = `0`
	)

Return the class of the element.

Parameters

[out]	elClass	The element class to return. The possible values are defined in the enum .
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetElementTemplateID	(	DgnPlatform::ElementId &	elementTemplateID,
		UInt	index = `0`
	)

Return the ID of the element template associate with the element.

Parameters

[out]	elementTemplateID	The ID of the element template to return.
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetFillColorIdOrGradientSpecification	(	UInt32 &	color,
		GradientSymbPtr &	gradientsymbPtr,
		UInt	index = `0`
	)

Return the Color Fill specificate if defined for a closed element.

If a fill color is specified it will be either a solid fill color ID or a Gradient color specification.

Parameters

[out]	color	Solid fill color ID to return.
[out]	gradientsymbPtr	Gradient color specification return.
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetFontID	(	UInt32 &	fontID,
		UInt	index = `0`
	)

Return the ID of the font if the element contains text.

Parameters

[out]	fontID	The FontId to return
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetLevelId	(	DgnPlatform::LevelId &	levelID,
		UInt	index = `0`
	)

Return the level ID.

Parameters

[out]	levelID	The LevelId
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetLineStyleID	(	Int32 &	lineStyleID,
		UInt	index = `0`
	)

Return the ID of the LineStyle.

Parameters

[out]	lineStyleID	The LineStyle Id to return
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetLineStyleParams	(	DgnPlatform::LineStyleParams &	lineStyleParams,
		UInt	index = `0`
	)

Return the LineStyle Parameters if the element uses a named line style.

Parameters

[out]	lineStyleParams	The LineStyle Parameters to return.
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetMaterialId	(	DgnPlatform::MaterialId &	materialID,
		UInt	index = `0`
	)

Return the Material ID if the element contains a material specification.

Parameters

[out]	materialID	The Material Id to return
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetMlineStyleID	(	DgnPlatform::ElementId &	mlineStyleID,
		UInt	index = `0`
	)

Return the ID of the Multi-Line Style if the element is a Multi-line element.

Parameters

[out]	mlineStyleID	The Multi-Line Style Id to return
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetPatternOrigin	(	DPoint3dR	origin,
		UInt	index = `0`
	)

Return the pattern origin of a patterned closed element.

Parameters

[out]	origin	The pattern origin to return.
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetPatternParams	(	DgnPlatform::PatternParams &	params,
		UInt	index = `0`
	)

Return the pattern parameter of a patterned closed element.

Parameters

[out]	params	The pattern parameters to return.
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetScale	(	DPoint3dR	scale,
		UInt	index = `0`
	)

Return the Scale of the element if the element supports scaling.

Parameters

[out]	scale	The scale value to return.
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetTextStyleId	(	UInt32 &	textStyleID,
		UInt	index = `0`
	)

Return the ID of the TextStyle if the element contains text.

Parameters

[out]	textStyleID	The TextStyle Id to return
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetTransparency	(	double &	transparency,
		UInt	index = `0`
	)

Return the transparency value of the element.

Parameters

[out]	transparency	The transparency value.
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT StatusInt GetWeight	(	UInt32 &	weight,
		UInt	index = `0`
	)

Return the line weight.

Parameters

[out]	weight	The line weight to return
[in]	index	The index of the property. Pass 0 if the element is not a complex element.

Returns: SUCCESS if the property can be returned from the element.

DGNPLATFORM_EXPORT bool Is3dElement ( )

Return true if the element is a 3D element.

DGNPLATFORM_EXPORT bool IsClosedElement ( )

Return true if the element is close element.

DGNPLATFORM_EXPORT bool IsDetailingSymbol ( )

Return true if the element is a Detailing Symbol.

DGNPLATFORM_EXPORT bool IsDimensionElement ( )

Return true if the element is a Dimension.

DGNPLATFORM_EXPORT bool IsMultiLineElement ( )

Return true if the element is a Multi-Line.

DGNPLATFORM_EXPORT bool IsPointCell ( )

Return true if the element is a point cell.

DGNPLATFORM_EXPORT bool IsRenderableElement ( )

Return true if the element can be rendered.

DGNPLATFORM_EXPORT bool IsSharedCell ( )

Return true if the element is a shared cell instance.

DGNPLATFORM_EXPORT bool IsStandardCell ( )

Return true if the element is a standard cell instance.

DGNPLATFORM_EXPORT bool IsText ( )

Return true if the element is a Text String element.

DGNPLATFORM_EXPORT bool IsTextNode ( )

Return true if the element is a Text Node element.

The documentation for this struct was generated from the following file:

SymbologyReporter.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation