A Note Cell is-a a sub-type of cell. More...

#include <NoteHandler.h>

Inheritance diagram for NoteCellHeaderHandler:

Public Types
typedef bvector< DPoint3d >	StdDPointVector

Public Types inherited from ITextEdit
enum	ReplaceStatus { ReplaceStatus_Success = 0, ReplaceStatus_Error = 1, ReplaceStatus_Delete = 2 }

Public Member Functions
DGNPLATFORM_EXPORT BentleyStatus	GetNoteLeader (ElementHandleR leader, ElementHandleCR noteElement)
	Get Leader element. More...

DGNPLATFORM_EXPORT DimensionStylePtr	GetNoteDimensionStyle (ElementHandleCR noteElement)
	Get dimension style associated with a note. More...

DGNPLATFORM_EXPORT BentleyStatus	SetNoteDimensionStyle (EditElementHandleR noteElement, EditElementHandleP leaderElement, DimensionStyleCR dimStyle)
	Set dimension style associated with a note. More...

Public Member Functions inherited from DisplayHandler
void	GetPathDescription (ElementHandleCR el, WStringR string, DisplayPathCP path, WCharCP levelStr, WCharCP modelStr, WCharCP groupStr, WCharCP delimiterStr)
	Return a full description of the path to be used to inform the user which element is under consideration. More...

void	GetTransformOrigin (ElementHandleCR el, DPoint3dR origin)
	Get the Transform Origin for this element. More...

void	GetSnapOrigin (ElementHandleCR el, DPoint3dR origin)
	Get the snap origin for this element. More...

void	GetOrientation (ElementHandleCR el, RotMatrixR orientation)
	Get an "orientation" RotMatrix for this element. More...

bool	GetBasisTransform (ElementHandleCR eh, TransformR transform)
	Get an "basis" Transform for this element. More...

bool	GetBasisRange (ElementHandleCR eh, DRange3dR range)
	Get an basis Range for this element. More...

void	SetBasisRange (EditElementHandleR eh, DRange3dCR range)
	Set an basis Range for this element. More...

void	SetBasisTransform (EditElementHandleR eh, TransformCR transform)
	Set an basis Transform for this element. More...

bool	IsRenderable (ElementHandleCR el)
	Determine whether this element is renderable (i.e., subject to lighting). More...

bool	IsPlanar (ElementHandleCR el, DVec3dP normal, DPoint3dP point, DVec3dCP inputDefaultNormal)
	Test whether this element is planar. More...

bool	IsVisible (ElementHandleCR el, ViewContextR context, bool testRange, bool testLevel, bool testClass)
	Determine whether this element is visible in the supplied context. More...

StatusInt	Drop (ElementHandleCR eh, ElementAgendaR dropGeom, DropGeometryCR geometry)
	Drop this element to a group of (simpler) primitive elements. More...

Public Member Functions inherited from Handler
void	GetDescription (ElementHandleCR el, WStringR string, UInt32 desiredLength)
	Get a brief string describing the element. More...

void	GetTypeName (WStringR string, UInt32 desiredLength)
	Get the type name for this handler. More...

DisplayHandlerP	GetDisplayHandler ()
	Use this method instead of dynamic_cast<DisplayHandlerP> (handler) More...

ITransactionHandlerP	GetITransactionHandler ()
	Use this method instead of dynamic_cast<ITransactionHandlerP> (handler) More...

IDependencyHandlerP	GetIDependencyHandler ()
	Use this method instead of dynamic_cast<IDependencyHandlerP> (handler) More...

StatusInt	ApplyTransform (EditElementHandleR element, TransformInfoCR transform)
	Transform the element. More...

StatusInt	FenceStretch (EditElementHandleR element, TransformInfoCR transform, FenceParamsP fp, FenceStretchFlags options)
	The handler is requested to "stretch" the specified element, that is, to transform the portions of the element that meet the clip criteria. More...

StatusInt	FenceClip (ElementAgendaP inside, ElementAgendaP outside, ElementHandleCR element, FenceParamsP fp, FenceClipFlags options)
	The handler is requested to clip the specified element, that is, to return the portions of the element that are inside/outside the clip criteria. More...

void	ConvertTo3d (EditElementHandleR eeh, double elevation)
	Convert a 2d element to it's 3d form. More...

void	ConvertTo2d (EditElementHandleR eeh, TransformCR flattenTrans, DVec3dCR flattenDir)
	Convert a 3d element to it's 2d form. More...

void	QueryProperties (ElementHandleCR eh, PropertyContextR context)
	Method for enummerating the common properties of elements such as color and level. More...

void	EditProperties (EditElementHandleR eeh, PropertyContextR context)
	Method for changing the common properties of elements such as color and level. More...

bool	ExposeChildren (ElementHandleCR el, ExposeChildrenReason reason)
	Determine whether the children of this element should be exposed to the caller for the intended purpose. More...

Public Member Functions inherited from IAnnotationHandler
bool	HasAnnotationScale (double *annotationScale, ElementHandleCR element) const
	Query if the specified element is an annotation. More...

StatusInt	AddAnnotationScale (EditElementHandleR eh, DgnModelRefP model)
	Set up annotation scale on eh. More...

StatusInt	RemoveAnnotationScale (EditElementHandleR eh)
	Remove annotation scale from eh. More...

Public Member Functions inherited from ITextEdit
DGNPLATFORM_EXPORT ITextEditRestrictionsPtr	GetTextPartEditRestrictions (ElementHandleCR, ITextPartIdCR) const
	Get an ITextEditRestrictions object to determine any restrictions on editing a text part. More...

DGNPLATFORM_EXPORT ReplaceStatus	ReplaceTextPart (EditElementHandleR, ITextPartIdCR, TextBlockCR)
	Replaces an existing piece of text with a new one. More...

Public Member Functions inherited from ITextQuery
DGNPLATFORM_EXPORT bool	IsTextElement (ElementHandleCR) const
	Determines if this element is a standard DGN text element (e.g. type 7 or 17). Many element types support ITextQuery, but it is sometimes useful to know if the element is generic text as opposed to some other element type that exposes formatted text. If a handler returns true, it is guaranteed to provide a single ITextPartId when queried. More...

DGNPLATFORM_EXPORT bool	DoesSupportFields (ElementHandleCR) const
	Determines if this element supports fields. More...

DGNPLATFORM_EXPORT ITextPartIdPtr	GetTextPartId (ElementHandleCR, HitPathCR) const
	Gets the ITextPartId for the piece of text indicated by the hitpath (or NULL). This is most useful for non generic DGN text element handlers, which can store more than just text in them. More...

DGNPLATFORM_EXPORT void	GetTextPartIds (ElementHandleCR, ITextQueryOptionsCR, T_ITextPartIdPtrVectorR) const
	Gets ITextPartIds for all pieces of text in this element. More...

DGNPLATFORM_EXPORT TextBlockPtr	GetTextPart (ElementHandleCR, ITextPartIdCR) const
	Generates and returns a TextBlock representing the provided ITextPartId. More...

Static Public Member Functions
static DGNPLATFORM_EXPORT BentleyStatus	CreateNote (EditElementHandleR noteElem, EditElementHandleCR leaderElement, TextBlockCR text, bool is3d, DgnModelRefR modelRef, DPoint3dCR leaderCellOrigin)
	Creates a new note element. More...

static DGNPLATFORM_EXPORT BentleyStatus	CreateNote (EditElementHandleR noteElem, EditElementHandleR leaderElement, TextBlockCR text, DimensionStyleCR dimStyle, bool is3d, DgnModelRefR modelRef, StdDPointVector const &noteLeaderPoints)
	Creates a new note element. More...

static DGNPLATFORM_EXPORT BentleyStatus	AddToModel (EditElementHandleR noteElement, EditElementHandleR leaderElement, DgnModelR dgnCache)
	Adds the note element to a model. More...

Static Public Member Functions inherited from DisplayHandler
static DisplayHandler &	GetInstance ()

static void	InitializeBasis (EditElementHandleR eh, TransformCR transform, DRange3dCP range)
	Initialize basis for an element - In most cases this should be done only once at creation. More...

Static Public Member Functions inherited from ITransactionHandler
static void	CallOnAdded (ElementHandleR)

static void	CallOnAddedComplete (ElementHandleR)

Additional Inherited Members
Protected Types inherited from ITransactionHandler
enum	PreActionStatus { PRE_ACTION_Ok = 0, PRE_ACTION_Block = 1 }

Protected Member Functions inherited from ITransactionHandler
virtual void	_OnUndoRedo (ElementHandleP afterUndoRedo, ElementHandleP beforeUndoRedo, ChangeTrackAction action, bool isUndo, ChangeTrackSource source)
	Called when an element is changed by either the Undo or Redo command in MicroStation. More...

virtual void	_OnHistoryRestore (ElementHandleP after, ElementHandleP before, ChangeTrackAction actionStep, BentleyDgnHistoryElementChangeType effectiveChange)
	Called when an element is changed by design history to restore a historical version. More...

virtual void	_OnUndoRedoFinished (ElementRefP element, bool isUndo)
	Called after undo/redo has restored all elements involved in the transaction and after all undo/redo callbacks have been invoked. More...

virtual void	_OnDeleted (ElementHandleP element)
	Called after an element is deleted from a model. More...

virtual void	_OnAdded (ElementHandleP element)
	Called after an element is added to a model. More...

virtual void	_OnAddedComplete (ElementHandleP element)
	Called after an element is added to a model. More...

virtual void	_OnModified (ElementHandleP newElement, ElementHandleP oldElement, ChangeTrackAction action, bool *cantBeUndoneFlag)
	Called after an element is directly changed in MicroStation and the DgnModel holds the new state of the element. More...

virtual void	_OnUndoRedoXAttributeChange (XAttributeHandleCR xAttr, ChangeTrackAction action, bool isUndo, ChangeTrackSource source)
	Called whenever an XAttribute is changed by either the Undo or Redo command in MicroStation. More...

virtual void	_OnXAttributeChanged (XAttributeHandleCR xAttr, ChangeTrackAction action, bool *cantBeUndoneFlag)
	Called when an XAttribute has been added, removed, or modified on the element. More...

virtual PreActionStatus	_OnAdd (EditElementHandleR)

virtual PreActionStatus	_OnReplace (EditElementHandleR, ElementHandleCR)

virtual PreActionStatus	_OnDelete (ElementHandleCR)

virtual PreActionStatus	_OnRemoveHandler (ElementHandleCR)

Detailed Description

A Note Cell is-a a sub-type of cell.

The note element consists of a leader and a cell which are only accessible through this handler. The properties in a note element is controlled by the dimensionstyle defined by the leader element. The note also stores this data internally for leader less notes.

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

Member Typedef Documentation

typedef bvector<DPoint3d> StdDPointVector

Member Function Documentation

static DGNPLATFORM_EXPORT BentleyStatus AddToModel	(	EditElementHandleR	noteElement,
		EditElementHandleR	leaderElement,
		DgnModelR	dgnCache
	)

static

Adds the note element to a model.

static DGNPLATFORM_EXPORT BentleyStatus CreateNote	(	EditElementHandleR	noteElem,
		EditElementHandleCR	leaderElement,
		TextBlockCR	text,
		bool	is3d,
		DgnModelRefR	modelRef,
		DPoint3dCR	leaderCellOrigin
	)

static

Creates a new note element.

Parameters

noteElem	OUT the newly created note element.
leaderElement	IN The existing dimension element which will be the note Leader.
text	IN The text information for the note element
is3d	IN flag to control whether to create a 3d element.
modelRef	IN destination model of the note.
leaderCellOrigin	IN the point where leader and not cell join

Returns: status. SUCCESS or ERROR

static DGNPLATFORM_EXPORT BentleyStatus CreateNote	(	EditElementHandleR	noteElem,
		EditElementHandleR	leaderElement,
		TextBlockCR	text,
		DimensionStyleCR	dimStyle,
		bool	is3d,
		DgnModelRefR	modelRef,
		StdDPointVector const &	noteLeaderPoints
	)

static

Creates a new note element.

Parameters

noteElem	OUT the newly created note element.
leaderElement	OUT The dimension element which will be the note Leader.
text	IN The text information for the note element
dimStyle	IN A style pointer which will provide the note settings.
is3d	IN flag to control whether to create a 3d element.
modelRef	IN destination model of the note.
noteLeaderPoints	IN the points which would define the note leader dimension.

Returns: status. SUCCESS or ERROR

DGNPLATFORM_EXPORT DimensionStylePtr GetNoteDimensionStyle ( ElementHandleCR noteElement )

Get dimension style associated with a note.

DGNPLATFORM_EXPORT BentleyStatus GetNoteLeader	(	ElementHandleR	leader,
		ElementHandleCR	noteElement
	)

Get Leader element.

DGNPLATFORM_EXPORT BentleyStatus SetNoteDimensionStyle	(	EditElementHandleR	noteElement,
		EditElementHandleP	leaderElement,
		DimensionStyleCR	dimStyle
	)

Set dimension style associated with a note.

Remarks: . Both the leader and note element needs to be replaced in the model after this

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

NoteHandler.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Function Documentation