Document Solutions for Imaging
DS.Documents.Imaging Assembly / GrapeCity.Documents.Text Namespace / TextFormat Class
Properties Methods

In This Topic
    TextFormat Class Members
    In This Topic

    The following tables list the members exposed by TextFormat.

    Public Constructors
     NameDescription
    Public ConstructorTextFormat ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyAllowFallbackToEudcFontsGets or sets a value indicating whether EUDC fonts should be searched for missing user-defined characters.

    The default is true.

     
    Public PropertyAllowFontSbitsGets or sets a value indicating if the embedded bitmaps from the EBDT font table can be used.

    The default is true.

    This property affects text drawing on GcBitmapGraphics only. Also, it has no effect if UseBitmapCache is set to false.

     
    Public PropertyBackColorGets or sets the text background color. The default is transparent.  
    Public PropertyCharWidthFactorGets or sets the character width scale factor (or height scale factor for vertical text).

    Valid values are between 0.1 and 10.0. The default is 1.0.

     
    Public PropertyDoubleUnderlineGets or sets a value indicating if the text is double underlined.  
    Public PropertyEnableFontHintingGets or sets a value indicating whether font hinting should be enabled for TrueType fonts.

    The default is true.

    This property affects text drawing on GcBitmapGraphics only.

     
    Public PropertyFillBrushGets or sets the GrapeCity.Documents.Drawing.Brush to fill the glyphs.

    The FillBrush property has a priority over the ForeColor.

     
    Public PropertyFontGets or sets a Font used by this format.

    If not null, this value overrides the FontName property.

     
    Public PropertyFontBoldGets or sets a value indicating whether the font should be bolded.  
    Public PropertyFontFeaturesProvides access to a set of Microsoft OpenType typography properties.  
    Public PropertyFontItalicGets or sets whether the font should be italicized.  
    Public PropertyFontNameGets or sets a font family name.

    This value is used only if the Font property is null.

    This value is case insensitive.

     
    Public PropertyFontSizeGets or sets the logical font size, in points or in graphic units.

    The default value is 12.

    See also the description of the FontSizeInGraphicUnits property.

     
    Public PropertyFontSizeInGraphicUnitsGets or sets a value indicating whether FontSize specifies the font size in graphic units or in points.  
    Public PropertyFontStyleGets or sets the flags indicating the desired or emulated style of the font.  
    Public PropertyForeColorGets or sets the text foreground color. The default is black.

    The FillBrush property has a priority over the ForeColor.

     
    Public PropertyGlyphAdvanceFactorGets or sets the scaling factor for the glyph advance value relative to font's Average Character Width.

    Valid values are from 0.5 up. The default is 1.

     
    Public PropertyGlyphAdvanceOffsetGets or sets the absolute increment (delta) for the glyph advance value, in graphic units.  
    Public PropertyGlyphWidthsGets or sets the preferred glyph widths (generally used in CJKV fonts).  
    Public PropertyHollowGets or sets a value indicating if the glyphs are hollow (outlined), otherwise they are solid.

    The StrokePen property must be set in order to draw outlined glyphs.

     
    Public PropertyLanguageGets or sets a value identifying the language system.  
    Public PropertyLineGapGets or sets a value specifying the explicit line gap (if not null), in graphic units.  
    Public PropertyPaletteGets or sets a palette used for drawing color fonts.  
    Public PropertyRecalcFontSizeForFallbackFontsGets or sets a value indicating whether the size of fallback font should be coerced to the size of original font (true by default).

    This property does not affect behavior of linked fonts with specified scale factor.

     
    Public PropertyScriptGets or sets an OpenType script tag.  
    Public PropertySidewaysInVerticalTextGets or sets a value indicating if all characters should appear as rotated 90 or -90 degrees in vertical text.  
    Public PropertySkipNormalizationGets or sets a value indicating whether the canonical decomposition, reordering, and composition stages should be omitted.  
    Public PropertyStrictCanonicalDecompositionGets or sets a value indicating whether to apply normalization to Singleton Decompositions and Post Composition Version precomposed characters.

    By default this property is false. If set to true, CJK compatibility ideographs can be changed to CJK unified ideographs during the normalization process.

     
    Public PropertyStrikethroughGets or sets a value indicating if the strikethrough style is applied to the text.  
    Public PropertyStrokePenGets or sets the GrapeCity.Documents.Drawing.Pen to draw glyph outlines.  
    Public PropertySubscriptGets or sets a value indicating if the glyphs should be displayed as subscript.

    Setting this property to true also sets the Superscript property to false.

     
    Public PropertySuperscriptGets or sets a value indicating whether the glyphs should be displayed as superscript.

    Setting this property to true also sets the Subscript property to false.

     
    Public PropertyTagGets or sets an arbitrary custom data associated with this TextFormat.  
    Public PropertyTextDecorationsGets or sets the flags indicating which decorations are applied to the text.  
    Public PropertyTextRunAsClusterGets or sets a value indicating whether the whole TextRun should be considered as a single Grapheme Cluster.

    It allows displaying several characters side-by-side horizontally in a vertical text.

     
    Public PropertyTransformToFullWidthGets or sets a value indicating if ASCII characters should be transformed into fullwidth characters.  
    Public PropertyTransverseOffsetGets or sets the offset of the text in the orthogonal direction, in graphic units.

    The default is 0.

     
    Public PropertyTreatHyphenMinusAsHyphenGets or sets a value indicating whether the character 'HYPHEN-MINUS' (U+002D) is treated as the character 'HYPHEN' (U+2010) by the Unicode line breaking algorithm.  
    Public PropertyUnderlineGets or sets a value indicating if the text is underlined.  
    Public PropertyUnderlineOrDoubleUnderlineGets a value indicating if the text is underlined or double underlined.  
    Public PropertyUprightInVerticalTextGets or sets a value indicating if the normally sideways characters should be drawn upright in vertical text.  
    Public PropertyUseBitmapCacheGets or sets a value indicating if the Bitmap Glyph Cache is allowed.

    The default is true.

    This property affects text drawing on GcBitmapGraphics only.

     
    Public PropertyUseHorizontalMetricsForVerticalTextGets or sets a value indicating if the horizontal ascending, descending, and line gap settings should be applied to vertical text. The special vertical metrics are used by default.  
    Public PropertyUseTypoMetricsGets or sets a value indicating whether the typographical font metrics should be applied instead of Windows-specific and Apple-specific font metrics.

    Font Ascender, Descender, and Line Gap are affected.

     
    Public PropertyUseVerticalLineGapForSidewaysGets or sets a value indicating that for sideways text in vertical flow (see TextLayout.FlowDirection, line gap will be set according to Font.VerticalLineGap.

    If false (the default), line gap for lines containing sideways text is set according to Font.HorizontalLineGap or GrapeCity.Documents.Text.Font.TypoLineGap, which can lead to different gaps between columns that contain sideways text runs and those that do not.

     
    Top
    Public Methods
     NameDescription
    Public MethodCopyToCopies the current text format settings to another TextFormat object.  
    Public Methodstatic (Shared in Visual Basic)CultureToLanguageReturns the Language value corresponding to a given System.Globalization.CultureInfo.  
    Public MethodResolveFontNameReturns the Font object for the current settings in the FontName, FontBold, FontItalic properties. Note that if the FontName is specified (not empty), this method will return the same font that would be used by a TextLayout given the same settings.  
    Public Methodstatic (Shared in Visual Basic)ScriptCodeToTagConverts a ScriptCode value to the corresponding ScriptTag.  
    Top
    See Also

    Reference

    TextFormat Class
    GrapeCity.Documents.Text Namespace