Type alias TextFormat

TextFormat: {
    alignment: TextHorizontalAlignment;
    bgColor: string;
    boldFlag: boolean;
    fontColor: string;
    fontFamily: string;
    fontSize: number;
    italicFlag: boolean;
    opacity: number;
    strikeFlag: boolean;
    styleId: string | null;
    underlineFlag: boolean;
}

Defines the text format options. All members are optional - and depending on the usage context, a null value would indicate no change and the format will not be adjusted. In the context of a text fields default format though, all values for a standard appareance should be set.

Type declaration

  • alignment: TextHorizontalAlignment

    The horizontal text alignment.

  • bgColor: string

    The background color to add a rectangular background for each glyph. This can be any valid MegaEdit color value.

  • boldFlag: boolean

    Flag to control if the text is bold. Note that the font used must support a bold variant. If italicFlag is true, we need to support a bold italic variant.

  • fontColor: string

    The color of the text/glyphs. This can be any valid MegaEdit color value.

  • fontFamily: string

    The font family to use. This must match an available font available in the resources for the current product

  • fontSize: number

    The font size to use. This is in points.

  • italicFlag: boolean

    Flag to control if the text is italic. Note that the font used must support an italic variant. If boldFlag is true, we need to support a bold italic variant.

  • opacity: number

    The opacity of the text.

  • strikeFlag: boolean

    Add a strike through decoration to the text.

  • styleId: string | null

    The identifier of the style used for this field or null if no style object is applied. id for more details. This is one of the styles in the group assigned to the field (see selectedGroupStyle).

  • underlineFlag: boolean

    Add an underline decoration to the text.

Settings

Member Visibility

Theme

Generated using TypeDoc