OdDbMLeader Class

Class Hierarchy

Syntax

C++

class OdDbMLeader : public OdDbEntity;

File

DbMLeader.h

Description

This class is the main class used for the multiple leader (MLeader) objects.

Group

OdDb Classes

Public Methods

	Name	Description
	OdDbMLeader

OdDbMLeader Enumerations

	Name	Description
	gsMarkType	Enumeration for MLeader GS mark type.
	LeaderLineOverrideType	Enumeration of the individual leader line properties which can be overridden.
	MoveType	Enumeration for MLeader move type.
	PropertyOverrideType	Enumeration for MLeader properties which can be overridden.

OdDbMLeader Methods

	Name	Description
	addFirstVertex	Inserts a new first vertex into the specified leader line.
	addLastVertex	Appends a new last vertex onto the specified leader line.
	addLeader	Causes a new cluster to be added to this MLeader object, and returns the index of the new cluster.
	addLeaderLine	This is the overview for the addLeaderLine method overload.
	arrowSize	This is the overview for the arrowSize method overload.
	arrowSymbolId	This is the overview for the arrowSymbolId method overload.
	blockColor	Returns the color used for block content.
	blockConnectionType	Returns the block connection type for this MLeader, which specifies how the referenced block is connected to the leader lines.
	blockContentId	Returns the referenced block for this MLeader, by block ObjectId.
	blockRotation	Returns the rotation used by the referenced block.
	blockScale	Returns the scale used by the referenced block.
	connectionPoint	This is the overview for the connectionPoint method overload.
	contentType	Returns the content type for this MLeader object.
	copyFrom	Copies the contents of the specified object into this object when possible.
	doglegLength	This is the overview for the doglegLength method overload.
	dwgInFields	Reads the .dwg file data of this object.
	dwgOutFields	Writes the .dwg file data of this object.
	dxfInFields	Reads the DXF data of this object.
	dxfOutFields	Writes the DXF data of this object.
	enableAnnotationScale	Returns the annotation scale enabled status for this MLeader.
	enableDogleg	Returns the enabled/disabled status for dog-leg leader line.
	enableFrameText	Returns the text frame visibility for MText content.
	enableLanding	Returns the enabled/disabled status for leader landing line.
	extendLeaderToText	Returns extend to text mode flag.
	getBlockAttributeValue	Returns the specified attribute from the associated block content.
	getBlockPosition	Returns the position for the block referenced by this MLeader.
	getContentGeomExtents	Returns the the extents of the content for this MLeader.
	getContextDataManager	Returns the context data manager for this MLeader object.
	getDoglegDirection	Returns the dog-leg direction for the specified leader cluster.
	getFirstVertex	Returns the first vertex from the specified leader line.
	getLastVertex	Returns the last vertex from the specified leader line.
	getLeaderIndex	Returns the index of the leader cluster which contains the specified leader line.
	getLeaderIndexes
	getLeaderLineIndexes	This is the overview for the getLeaderLineIndexes method overload.
	getOverridedMLeaderStyle	Returns the property set for the MLeader, including override values.
	getPlane	Returns the plane that contains this entity.
	getTextLocation	Returns the location for the MText content associated with this MLeader.
	getToleranceLocation	Returns the location for MLeader tolerance content.
	getVertex	Returns the position of a specified vertex in a specified leader line.
	hasContent	Returns true if this MLeader has content, false otherwise.
	isOverride	This is the overview for the isOverride method overload.
	isPlanar	Returns true if and only if this entity is planar.
	landingGap	Returns the landing gap for this MLeader (gap between the leader tail and associated MText).
	leaderLineColor	This is the overview for the leaderLineColor method overload.
	leaderLineType	This is the overview for the leaderLineType method overload.
	leaderLineTypeId	This is the overview for the leaderLineTypeId method overload.
	leaderLineWeight	This is the overview for the leaderLineWeight method overload.
	MLeaderStyle	Returns the MLeaderStyle used for this MLeader, by ObjectId.
	moveMLeader	Moves this MLeader object as specified by an input vector.
	mtext	Returns the MText content associated with this MLeader.
	normal
	numLeaderLines	Deprecated (Instead, use the method getLeaderLineIndexes(...))
	numLeaders	Deprecated (Instead, use the method getLeaderIndexes(...))
	numVertices	Returns the number of vertices in the specified leader line.
	ODDB_DECLARE_MEMBERS
	plane	Returns the WCS plane containing this MLeader object.
	postMLeaderToDb	Adds this MLeader object to the Model Space block of the specified database.
	recomputeBreakPoints	Recomputes the dimension break points.
	removeFirstVertex	Removes the first vertex from the specified leader line.
	removeLastVertex	Removes the last vertex from the specified leader line.
	removeLeader	Removes the leader cluster specified by the passed-in index.
	removeLeaderLine	Removes the leader line specified by the passed-in index.
	removeLeaderLineRefAssoc	Removes the specified leader line's geometry association.
	scale	Returns the MLeader scale, which affects arrowhead size and content scale.
	setArrowSize	This is the overview for the setArrowSize method overload.
	setArrowSymbolId	This is the overview for the setArrowSymbolId method overload.
	setBlockAttributeValue	Sets the specified attribute within associated block content.
	setBlockColor	Sets the color used for block content.
	setBlockConnectionType	Sets the block connection type for this MLeader, which specifies how the referenced block is connected to the leader lines.
	setBlockContentId	Sets the referenced block for this MLeader, by block ObjectId.
	setBlockPosition	Sets the position for the block referenced by this MLeader.
	setBlockRotation	Sets the rotation used by the referenced block.
	setBlockScale	Sets the scale used by the referenced block.
	setContentType	Sets the content type for this MLeader object.
	setContextDataManager	Sets the context data manager for this MLeader object.
	setDoglegDirection	Sets the dog-leg direction for the specified leader cluster.
	setDoglegLength	This is the overview for the setDoglegLength method overload.
	setEnableAnnotationScale	Sets the annotation scale enabled status for this MLeader.
	setEnableDogleg	Sets the enabled/disabled status for dog-leg leader line.
	setEnableFrameText	Sets the text frame visibility for MText content.
	setEnableLanding	Sets the enabled/disabled status for leader landing line.
	setExtendLeaderToText	Set extend to text mode.
	setFirstVertex	Sets the first vertex of the specified leader line.
	setLandingGap	Sets the landing gap for this MLeader (gap between the leader tail and associated MText).
	setLastVertex	Sets the last vertex of the specified leader line.
	setLeaderLineColor	This is the overview for the setLeaderLineColor method overload.
	setLeaderLineType	This is the overview for the setLeaderLineType method overload.
	setLeaderLineTypeId	This is the overview for the setLeaderLineTypeId method overload.
	setLeaderLineWeight	This is the overview for the setLeaderLineWeight method overload.
	setMLeaderStyle	Sets the MLeaderStyle used for this MLeader, by ObjectId.
	setMText	Sets the MText object to be associated with this MLeader.
	setOverride	Sets the override status for the specified PropertyOverrideType.
	setPlane	Sets the WCS plane containing this MLeader object.
	setScale	Sets the MLeader scale, which affects arrowhead size and content scale.
	setTextAlignmentType	Sets the text alignment type for MText content.
	setTextAngleType	Sets the angle type for MText content, with respect to the last leader line segment.
	setTextAttachmentDirection	Sets the text attachment direction of MText.
	setTextAttachmentType	Sets the text attachment type used by MText content.
	setTextColor	Sets the text color for MText content.
	setTextHeight	Sets the text height for MText content.
	setTextLocation	Sets the location for the MText content associated with this MLeader.
	setTextStyleId	Sets the textstyle used by MText content (by ObjectId).
	setToleranceLocation	Sets the location for MLeader tolerance content.
	setVertex	Sets the position for a specified vertex in a specified leader line.
	textAlignmentType	Returns the text alignment type for MText content.
	textAngleType	Returns the angle type for MText content, with respect to the last leader line segment.
	textAttachmentDirection	Returns the text attachment direction of MText.
	textAttachmentType	Returns the text attachment type used by MText content.
	textColor	Returns the text color for MText content.
	textHeight	Returns the text height for MText content.
	textStyleId	Return the textstyle used by MText content (by ObjectId).
	updateContentScale	Updates this MLeaders's arrow head, landing gap, dog-leg length, and text height or block scale.
	updateLeaderLinePosition	Updates leader line positions.

Send feedback about this topic