OdDbMText Class

Class Hierarchy

Syntax

C++

class OdDbMText : public OdDbEntity;

File

DbMText.h

Description

This class represents paragraph (multi-line) text (MText) entities in an OdDbDatabase instance.

Corresponding C++ library: TD_Db

See Also

Working with Multi-Line Text

OdDbText, OdDbMline classes

Group

OdDb Classes

Public Methods

	Name	Description
	OdDbMText	This is OdDbMText, a member of class OdDbMText.

OdDbMText Enumerations

	Name	Description
	AttachmentPoint	This is record OdDbMText::AttachmentPoint.
	ColumnType	This is record OdDbMText::ColumnType.
	FlowDirection	This is record OdDbMText::FlowDirection.

OdDbMText Methods

	Name	Description
	actualHeight	Returns the actual height of this MText entity (depends on contents).
	actualWidth	Returns the width of the bounding box of this MText entity.
	alignChange	Returns the alignment change string "A".
	ascent	Returns the ascent of this MText entity.
	attachment	Returns the type of the attachment point of this MText entity (DXF 71).
	backgroundFillOn	Returns true if and only if background fill is on of this MText entity (DXF 90, bit 0x01).
	blockBegin	Returns the begin block string "{".
	blockEnd	Returns the end block string "}".
	colorChange	Returns the color change string "C".
	contents	Returns a copy of the character content of this MText entity (DXF 1 & 3).
	convertFieldToText	Converts the fields in this MText entity to text, and removes the fields.
	descent	Returns the descent of this MText entity.
	direction	Returns the WCS X-axis direction vector of this MText entity (DXF 11).
	dwgInFields	Reads the .dwg file data of this object.
	DWGMAP_DECLARE_MEMBERS	This is DWGMAP_DECLARE_MEMBERS, a member of class OdDbMText.
	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.
	explodeFragments	Explodes this MText entity into a sequence of simple text fragments, passing each fragment to the specified function
	explodeGeometry	Explodes this entity into a set of simpler entities.
	flowDirection	Returns the flow direction of this MText entity (DXF 72).
	fontChange	Returns the font change string "F".
	getActualBoundingPoints	Returns the WCS actual bounding points of this MText entity.
	getBackgroundFillColor	Returns the background fill color of this MText entity (DXF 63 and optionally 421 & 431).
	getBackgroundScaleFactor	Returns the background scale factor of this MText entity (DXF 45).
	getBackgroundTransparency	Returns the background transparency of this MText entity (DXF 441).
	getBoundingPoints	Returns the WCS bounding points of this MText entity box.
	getColumnAutoHeight	Returns the column auto height status of this MText entity.
	getColumnCount	Returns the column count of this MText entity.
	getColumnFlowReversed	Returns the column flow reverse status of this MText entity.
	getColumnGutterWidth	Returns the column gutter of this MText entity.
	getColumnHeight	Returns the column height of this MText entity.
	getColumnType	Returns the column type of this MText entity.
	getColumnWidth	Returns the column width of this MText entity.
	getEcs	Returns the entity coordinate system matrix.
	getParagraphsIndent	Returns the paragraph indentation and tab data of this MText entity.
	getPlane	Returns the plane that contains this entity.
	height	Returns the height of the box of this MText entity.
	heightChange	Returns the height change string "H".
	horizontalMode	Returns the horizontal mode of this MText entity (used for DXF 71).
	isPlanar	Returns true if and only if this entity is planar.
	lineBreak	Returns the line break string "p".
	lineSpacingFactor	Returns the linespacing factor of this MText entity (DXF 44).
	lineSpacingStyle	Returns the linespacing style of this MText entity (DXF 73).
	location	Returns the insertion point of this MText entity (WCS equivalent of DXF 10).
	nonBreakSpace	Returns the non-break space string "~".
	normal	Returns the WCS normal to the plane of this entity (DXF 210).
	obliqueChange	Returns the oblique angle change string "Q".
	overlineOff	Returns the overline off string "o".
	overlineOn	Returns the overline on string "O".
	paragraphBreak	Returns the paragraph break string "P".
	removeField	This is the overview for the removeField method overload.
	rotation	Returns the rotation angle of this MText entity in radians (DXF 50).
	setAttachment	Sets the type of the attachment point of this MText entity (DXF 71).
	setAttachmentMovingLocation	Sets the type of the attachment point of this MText entity (DXF 71).
	setBackgroundFill	Controls the background fill of this MText entity (DXF 90, bit 0x01).
	setBackgroundFillColor	Sets the background fill color of this MText entity (DXF 63 and optionally 421 & 431).
	setBackgroundScaleFactor	Sets the background scale factor of this MText entity (DXF 45).
	setBackgroundTransparency	Sets the background transparency of this MText entity (DXF 441).
	setColumnAutoHeight	Switches the column auto height status of this MText entity.
	setColumnCount	Sets the column count of this MText entity.
	setColumnFlowReversed	Switches the column flow reverse status of this MText entity.
	setColumnGutterWidth	Sets the column gutter of this MText entity.
	setColumnHeight	Sets the column height of this MText entity.
	setColumnType	Sets the column type of this MText entity.
	setColumnWidth	Sets the column width of this MText entity.
	setContents	Sets the character content of this MText entity (DXF 1 & 3).
	setContentsRTF	Sets the character content of this MText entity (DXF 1 & 3) from the RTF-encoded text string.
	setDirection	Sets the WCS X-axis direction vector of this MText entity (DXF 11).
	setDynamicColumns	This is setDynamicColumns, a member of class OdDbMText.
	setField	Adds the specified field to the field dictionary of this object.
	setFlowDirection	Sets the flow direction of this MText entity (DXF 72).
	setHeight	Sets the height of the box of this MText entity.
	setHorizontalMode	Sets the horizontal mode of this MText entity (used for DXF 71).
	setLineSpacingFactor	Sets the linespacing factor of this MText entity (DXF 44).
	setLineSpacingStyle	Sets the linespacing style of this MText entity (DXF 73).
	setLocation	Sets the insertion point of this MText entity (WCS equivalent of DXF 10).
	setNormal	Sets the WCS normal to the plane of this entity (DXF 210).
	setRotation	Sets the rotation angle of this MText entity in radians (DXF 50).
	setShowBorders	Sets the flag controlling mtext border's visibility.
	setStaticColumns	This is setStaticColumns, a member of class OdDbMText.
	setTextHeight	Sets the text height of this MText entity (DXF 40).
	setTextStyle	Sets the Object ID of the text style of this MText entity (DXF 7).
	setUseBackgroundColor	Controls the use of the screen background color as the background color of this MText entity (DXF 90, bit 0x02).
	setVerticalMode	Sets the vertical mode of this MText entity (used for DXF 71).
	setWidth	Sets the word-wrap width of this MText entity (DXF 41).
	showBorders	Gets the flag controlling mtext border's visibility.
	stackStart	Returns the stacked text start string "S".
	strikethroughOff	Returns the strike through off string "k".
	strikethroughOn	Returns the strike through on string "K".
	subClose	Called as the first operation as this object is being closed, for database -resident objects only.
	subExplode	This is subExplode, a member of class OdDbMText.
	subGetClassID	overridables
	subGetGeomExtents	This is subGetGeomExtents, a member of class OdDbMText.
	subGetTransformedCopy	This is subGetTransformedCopy, a member of class OdDbMText.
	subSetAttributes	Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.
	subSetDatabaseDefaults	This function is an override for OdDbEntity::subSetDatabaseDefaults() to set the dimension style of this entity to the current style for the specified database.
	subTransformBy	This is subTransformBy, a member of class OdDbMText.
	subViewportDraw	This is subViewportDraw, a member of class OdDbMText.
	subWorldDraw	This is subWorldDraw, a member of class OdDbMText.
	text	Gets contents without formate codes.
	textHeight	Returns the text height of this MText entity (DXF 40).
	textStyle	Returns the Object ID of the text style of this MText entity (DXF 7).
	trackChange	Returns the track change string "T".
	underlineOff	Returns the underline off string "l".
	underlineOn	Returns the underline on string "L".
	useBackgroundColorOn	Returns true if and only if the screen background color is used as the/ background color/ of this MText entity (DXF 90, bit 0x02).
	verticalMode	Returns the vertical mode of this MText entity (used for DXF 71).
	width	Returns the word-wrap width of this MText entity (DXF 41).
	widthChange	Returns the width change string "W".

Send feedback about this topic