Class CIMTextSymbol
Represents a text symbol which is used to draw text graphics, bleeds, and annotation. Text symbols do not contain any symbol layers but can have callouts.
public class CIMTextSymbol : CIMSymbol
- Inheritance
-
CIMTextSymbol
- Inherited Members
Constructors
CIMTextSymbol()
public CIMTextSymbol()
Properties
Angle
Gets or sets the amount of rotation applied to the text symbol, measured in degrees, around the geometry.
public double Angle { get; set; }
Property Value
AngleX
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 double AngleX { get; set; }
Property Value
AngleY
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 double AngleY { get; set; }
Property Value
BillboardMode3D
Gets or sets the billboard mode of the text symbol.
public BillboardMode BillboardMode3D { get; set; }
Property Value
BlockProgression
Gets or sets the direction in which multi-line text is stacked.
public BlockProgression BlockProgression { get; set; }
Property Value
Callout
Gets or sets the callout or background of the text with optional leader lines.
public CIMCallout Callout { get; set; }
Property Value
CompatibilityMode
Gets or sets a value indicating whether to draw the text in a fashion compatible with ArcMap.
public bool CompatibilityMode { get; set; }
Property Value
CountryISO
Gets or sets the ISO code for the base country of the text.
public string CountryISO { get; set; }
Property Value
Depth3D
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 double Depth3D { get; set; }
Property Value
DrawGlyphsAsGeometry
Gets or sets a value indicating whether fonts that are drawn as rasters at some scales to draw as vectors instead.
public bool DrawGlyphsAsGeometry { get; set; }
Property Value
DrawSoftHyphen
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 bool DrawSoftHyphen { get; set; }
Property Value
ExtrapolateBaselines
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 bool ExtrapolateBaselines { get; set; }
Property Value
FlipAngle
Gets or sets the angle (in degrees from vertical) at which point rotated text is flipped (mirrored) in place.
public double FlipAngle { get; set; }
Property Value
FontEffects
Gets or sets whether the text is drawn as subscript or superscript.
public FontEffects FontEffects { get; set; }
Property Value
FontEncoding
Gets or sets the font encoding.
public FontEncoding FontEncoding { get; set; }
Property Value
FontFamilyName
Gets or sets the font family name of the font. e.g. Comic Sans.
public string FontFamilyName { get; set; }
Property Value
FontStyleName
Gets or sets the style name for the font family. e.g. Regular, Bold, or Italic.
public string FontStyleName { get; set; }
Property Value
FontType
Gets or sets the type of font that the font family/style name reference.
public FontType FontType { get; set; }
Property Value
FontVariationSettings
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 CIMFontVariation[] FontVariationSettings { get; set; }
Property Value
GlyphRotation
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 double GlyphRotation { get; set; }
Property Value
HaloSize
Gets or sets the size of the halo that extends beyond the symbol shape.
public double HaloSize { get; set; }
Property Value
HaloSymbol
Gets or sets the polygon symbol that is used to draw the halo for a text symbol.
public CIMPolygonSymbol HaloSymbol { get; set; }
Property Value
Height
Gets or sets the size of the text in points.
public double Height { get; set; }
Property Value
Hinting
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 GlyphHinting Hinting { get; set; }
Property Value
HorizontalAlignment
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 HorizontalAlignment HorizontalAlignment { get; set; }
Property Value
IndentAfter
Gets or sets how many points to indent the text back from the end of the baseline.
public double IndentAfter { get; set; }
Property Value
IndentBefore
Gets or sets how many points to indent the text from the beginning of the baseline.
public double IndentBefore { get; set; }
Property Value
IndentFirstLine
Gets or sets how many points to indent the text from the beginning of the baseline for the first line only.
public double IndentFirstLine { get; set; }
Property Value
Kerning
Gets or sets a value indicating whether the text is drawn with metric kerning, which adjusts the spacing between individual letter forms.
public bool Kerning { get; set; }
Property Value
LanguageISO
Gets or sets whether the ISO code for the base language of the text.
public string LanguageISO { get; set; }
Property Value
LetterSpacing
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 double LetterSpacing { get; set; }
Property Value
LetterWidth
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 double LetterWidth { get; set; }
Property Value
Ligatures
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 bool Ligatures { get; set; }
Property Value
LineGap
Gets or sets the spacing between lines of text. This is also known as leading or line spacing.
public double LineGap { get; set; }
Property Value
LineGapType
Gets or sets the type of line gap that is applied.
public LineGapType LineGapType { get; set; }
Property Value
OffsetX
Gets or sets the X offset.
public double OffsetX { get; set; }
Property Value
OffsetY
Gets or sets the Y offset.
public double OffsetY { get; set; }
Property Value
OffsetZ
Gets or sets the Z offset.
public double OffsetZ { get; set; }
Property Value
Overprint
Gets or sets a value indicating whether or not the symbol should overprint in press printing.
public bool Overprint { get; set; }
Property Value
ShadowColor
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 CIMColor ShadowColor { get; set; }
Property Value
ShadowOffsetX
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 double ShadowOffsetX { get; set; }
Property Value
ShadowOffsetY
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 double ShadowOffsetY { get; set; }
Property Value
SmallCaps
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 bool SmallCaps { get; set; }
Property Value
Strikethrough
Gets or sets a value indicating whether to draw the text with a strike through it.
public bool Strikethrough { get; set; }
Property Value
Symbol
Gets or sets the polygon symbol that is used to draw the glyphs of the text.
public CIMPolygonSymbol Symbol { get; set; }
Property Value
Symbol3DProperties
Gets or sets the collection of properties that are applied to the text symbol only in a 3D context.
public CIM3DSymbolProperties Symbol3DProperties { get; set; }
Property Value
TextCase
Gets or sets the letter case used to draw the text.
public TextCase TextCase { get; set; }
Property Value
TextDirection
Gets or sets the base text direction to draw the text.
public TextReadingDirection TextDirection { get; set; }
Property Value
Underline
Gets or sets a value indicating whether to draw the text with an underline.
public bool Underline { get; set; }
Property Value
VerticalAlignment
Gets or sets the vertical alignment of the text.
public VerticalAlignment VerticalAlignment { get; set; }
Property Value
VerticalGlyphOrientation
Gets or sets the orientation for the non-vertical text in a vertical layout. For example, an English fragment in a Japanese text.
public VerticalGlyphOrientation VerticalGlyphOrientation { get; set; }
Property Value
VerticalPositioning
Gets or sets the vertical position of the text within its frame.
public VerticalPositioning VerticalPositioning { get; set; }
Property Value
WordSpacing
Gets or sets the additional spacing that is added to between the words of the text string. 100% indicates that regular spacing is used.
public double WordSpacing { get; set; }
Property Value
Methods
FromJson(string, JsonDeserializationSettings)
Reconstructs the CIMTextSymbol with a specified state from a JSON encoding.
public static CIMTextSymbol FromJson(string json, JsonDeserializationSettings settings = null)
Parameters
jsonstringThe JSON string containing the CIMTextSymbol state.
settingsJsonDeserializationSettingsThe JSON deserialization settings.
Returns
ToJson(JsonSerializationSettings)
Creates a JSON encoding of the CIMTextSymbol and its current state.
public override string ToJson(JsonSerializationSettings settings = null)
Parameters
settingsJsonSerializationSettingsThe JSON serialization settings.