Type alias StyleItem

StyleItem: {
    alignment: TextHorizontalAlignment;
    applyAlignment: boolean;
    applyBackgroundColor: boolean;
    applyBoldFlag: boolean;
    applyCharSpacing: boolean;
    applyFontColor: boolean;
    applyFontFamily: boolean;
    applyFontSize: boolean;
    applyItalicFlag: boolean;
    applyLeading: boolean;
    applyOpacity: boolean;
    applyParagraphSpacing: boolean;
    applyStrikeFlag: boolean;
    applyUnderlineFlag: boolean;
    applyWordSpacing: boolean;
    bgColor: string;
    boldFlag: boolean;
    charSpacing: number;
    fontColor: string;
    fontFamily: string;
    fontSize: number;
    id: string;
    italicFlag: boolean;
    leading: number;
    name: string;
    opacity: number;
    paragraphSpacing: number;
    strikeFlag: boolean;
    underlineFlag: boolean;
    wordSpacing: number;
}

A style item can be used for text fields. It defines the base style of a text field and can be used to quickly and easily change the style of a text field. Style items can be grouped together to give a meaningful choice to the enduser.

A style item holds possible formating options for a text field where each option is optional. So it can be quite granular to configure what the styles will adjust when applied to a text field.

Type declaration

  • alignment: TextHorizontalAlignment

    The alignment to use. Only used if applyAlignment is true.

  • applyAlignment: boolean

    Flag to indicate that the alignment should be applied.

  • applyBackgroundColor: boolean

    Flag to indicate that the background color should be applied.

  • applyBoldFlag: boolean

    Flag to indicate that the bold flag should be applied. Note that the fonts need to support all the variants for the styles to work.

  • applyCharSpacing: boolean

    Flag to indicate that the character spacing should be applied.

  • applyFontColor: boolean

    Flag to indicate that the font color should be applied.

  • applyFontFamily: boolean

    Flag to indicate that the font family should be applied.

  • applyFontSize: boolean

    Flag to indicate that the font size should be applied.

  • applyItalicFlag: boolean

    Flag to indicate that the italic flag should be applied. Note that the fonts need to support all the variants for the styles to work.

  • applyLeading: boolean

    Flag to indicate that the leading should be applied.

  • applyOpacity: boolean

    Flag to indicate that the opacity should be applied.

  • applyParagraphSpacing: boolean

    Flag to indicate that the paragraph spacing should be applied.

  • applyStrikeFlag: boolean

    Flag to indicate that the strike flag should be applied.

  • applyUnderlineFlag: boolean

    Flag to indicate that the underline flag should be applied.

  • applyWordSpacing: boolean

    Flag to indicate that the word spacing should be applied.

  • bgColor: string

    The background color to use. Only used if applyBackgroundColor is true. Any MegaEdit color format is supported.

  • boldFlag: boolean

    The bold flag to use. Only used if applyBoldFlag is true.

  • charSpacing: number

    The character spacing to use. Only used if applyCharSpacing is true.

  • fontColor: string

    The font color to use. Only used if applyFontColor is true. Any MegaEdit color format is supported.

  • fontFamily: string

    The font family to use. Only used if applyFontFamily is true. This must be a valid available font resource.

  • fontSize: number

    The font size to use. Only used if applyFontSize is true.

  • id: string

    The id of the style item (GUID).

  • italicFlag: boolean

    The italic flag to use. Only used if applyItalicFlag is true.

  • leading: number

    The leading to use. Only used if applyLeading is true. The leading value here is the percentage - e.g. default is 130 for 130%.

  • name: string

    The name of the style item as it appears in the UI.

  • opacity: number

    The opacity to use. Only used if applyOpacity is true. Value between 0 and 1. 0 is fully transparent, 1 is fully opaque.

  • paragraphSpacing: number

    The paragraph spacing to use. Only used if applyParagraphSpacing is true.

  • strikeFlag: boolean

    The strike flag to use. Only used if applyStrikeFlag is true.

  • underlineFlag: boolean

    The underline flag to use. Only used if applyUnderlineFlag is true.

  • wordSpacing: number

    The word spacing to use. Only used if applyWordSpacing is true.

Settings

Member Visibility

Theme

Generated using TypeDoc