ArcGIS Pro 3.2 API Reference Guide
ArcGIS.Core.CIM Namespace / CIMTextSymbol Class
Properties Methods Events


In This Topic
    CIMTextSymbol Class Members
    In This Topic

    The following tables list the members exposed by CIMTextSymbol.

    Public Constructors
     NameDescription
    Public Constructor  
    Top
    Public Properties
     NameDescription
    Public Property Gets or sets the amount of rotation applied to the text symbol, measured in degrees, around the geometry.  
    Public Property Gets or sets the amount of rotation of the text symbol around the X axis, measured in degrees, around the geometry. This type of rotation is also referred to as tilt. It is applied in 3D.  
    Public Property Gets or sets the amount of rotation of the text symbol around the Y axis, measured in degrees, around the geometry. This type of rotation is also referred to as roll. It is applied in 3D.  
    Public Property Gets or sets the billboard mode of the text symbol.  
    Public Property Gets or sets the direction in which multi-line text is stacked.  
    Public Property Gets or sets the callout or background of the text with optional leader lines.  
    Public Property Gets or sets a value indicating whether to draw the text in a fashion compatible with ArcMap.  
    Public Property Gets or sets the ISO code for the base country of the text.  
    Public Property Gets or sets the depth of the glyph when drawn in 3D. This is an extrusion of the characters of the text in the Z axis.  
    Public Property Gets or sets a value indicating whether fonts that are drawn as rasters at some scales to draw as vectors instead.  
    Public Property Gets or sets a value indicating whether soft hyphens should be drawn. Soft hyphens are invisible markers that indicate where a hyphenated break is allowed within the text. They are only drawn if there is word wrapping at the end of a line.  
    Public Property Gets or sets a value indicating whether the baseline of the text geometry should be expanded in the same manner as the existing geometry if the text extends beyond the baseline.  
    Public Property Gets or sets the angle (in degrees from vertical) at which point rotated text is flipped (mirrored) in place.  
    Public Property Gets or sets whether the text is drawn as subscript or superscript.  
    Public Property Gets or sets the font encoding.  
    Public Property Gets or sets the font family name of the font. e.g. Comic Sans.  
    Public Property Gets or sets the style name for the font family. e.g. Regular, Bold, or Italic.  
    Public Property Gets or sets the type of font that the font family/style name reference.  
    Public Property Gets or sets an array of CIM font variation objects, describing a particular instance of a variable font through the font axis tags and their values. The number of CIM font variations will correspond to the number of variation axes specified by the font. This is only used for variable fonts.  
    Public Property Gets or sets an additional rotation that is applied to the individual glyphs contained in the text. This is applied to the individual glyphs whereas Angle, AngleX and AngleY are affect how the entire text string is oriented.  
    Public Property Gets or sets the size of the halo that extends beyond the symbol shape.  
    Public Property Gets or sets the polygon symbol that is used to draw the halo for a text symbol.  
    Public Property Gets or sets the size of the text in points.  
    Public Property Gets or sets if hinting from the font is used for text rendering. Hinting is information included with most fonts to effectively fit the vector glyphs of the font into the raster grid onto which they are displayed.  
    Public Property Gets or sets the alignment type used to align the text to the geometry horizontally. Affects which side of a point geometry the point text is drawn or which end of a line it is drawn close to. Commonly used to define how stacked text appears.  
    Public Property Gets or sets how many points to indent the text back from the end of the baseline.  
    Public Property Gets or sets how many points to indent the text from the beginning of the baseline.  
    Public Property Gets or sets how many points to indent the text from the beginning of the baseline for the first line only.  
    Public Property Gets or sets a value indicating whether the text is drawn with metric kerning, which adjusts the spacing between individual letter forms.  
    Public Property Gets or sets whether the ISO code for the base language of the text.  
    Public Property Gets or sets the additional spacing that is added to each glyph beyond what is defined by its character box in the font. Value indicates the percentage of a glyph's width. Also known as tracking.  
    Public Property Gets or sets the width that is added to each glyph beyond what is defined by its character box in its font. This is a percentage of the original glyph.  
    Public Property Gets or sets a value indicating whether text is to be drawn with ligatures, which occur when two or more letters or portions of letters are joined to form a single glyph.  
    Public Property Gets or sets the spacing between lines of text. This is also known as leading or line spacing.  
    Public Property Gets or sets the type of line gap that is applied.  
    Public Property Gets or sets the X offset.  
    Public Property Gets or sets the Y offset.  
    Public Property Gets or sets the Z offset.  
    Public Property Gets or sets a value indicating whether or not the symbol should overprint in press printing.  
    Public Property Gets or sets the color of the shadow that is defined for the text symbol. The shadow is drawn as an offset copy of the text.  
    Public Property Gets or sets the shadow offset from the text symbol in the horizontal direction. If X and Y are zero, no shadow is drawn.  
    Public Property Gets or sets the shadow offset from the text symbol in the vertical direction. If X and Y are zero, no shadow is drawn.  
    Public Property Gets or sets a value indicating whether the text should be drawn as Small Capitals, where lower case text is converted to small caps and upper case text is left as upper case.  
    Public Property Gets or sets a value indicating whether to draw the text with a strike through it.  
    Public Property Gets or sets the polygon symbol that is used to draw the glyphs of the text.  
    Public Property Gets or sets the collection of properties that are applied to the text symbol only in a 3D context.  
    Public Property Gets or sets the letter case used to draw the text.  
    Public Property Gets or sets the base text direction to draw the text.  
    Public Property Gets or sets a value indicating whether to draw the text with an underline.  
    Public Property Gets or sets the vertical alignment of the text.  
    Public Property Gets or sets the orientation for the non-vertical text in a vertical layout. For example, an English fragment in a Japanese text.  
    Public Property Gets or sets the additional spacing that is added to between the words of the text string. 100% indicates that regular spacing is used.  
    Top
    Public Methods
     NameDescription
    Public Method Creates a deep copy of CIMTextSymbol.  
    Public Methodstatic (Shared in Visual Basic) Reconstructs the CIMTextSymbol with a specified state from a JSON encoding.  
    Public Method Not implemented, reserved for future use. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Public Method Reads the element inside the reader. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Public MethodOverridden.  Creates a JSON encoding of the CIMTextSymbol and its current state.  
    Public Method Writes the element inside the writer. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Top
    Protected Methods
     NameDescription
    Protected Method Called from a property setter to notify the framework that an Object member has changed. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Protected MethodOverridden.  Reads the child element inside the reader.  
    Protected MethodOverridden.  Writes a child element to the writer.  
    Top
    Extension Methods
     NameDescription
    Public Extension Method Gets color of a symbol.
    Public Extension Method Gets size of a symbol.
    Public Extension Method Determines whether a symbol color is in mixed state.
    Public Extension Method Makes symbol reference for a symbol.
    Public Extension Method Sets color of a symbol.
    Public Extension Method Sets whether symbol should be displayed with real world size or with fixed screen size.
    Public Extension Method Sets size of a symbol.
    Top
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Top
    See Also