`CTextCharFormat`

GUI and styling

Describes character-level formatting in a rich-text document.

Module gui/CTextCharFormat.js. This class is available through the browser modules in the download.

Declared members

constructor(other?: CTextCharFormat | null);

Creates a new CTextCharFormat instance. @param other Other.

clone(): CTextCharFormat;

Creates an independent copy of this object. @returns The resulting value.

fontWeight(): CFontWeight;

Returns the font weight setting. @returns The resulting value.

setFontWeight(weight: CFontWeight): void;

Sets the font weight. @param weight Weight.

fontBold(): boolean;

Returns the font bold setting. @returns The resulting value.

setFontBold(bold: boolean): void;

Sets the font bold. @param bold Bold.

fontItalic(): boolean;

Returns the font italic setting. @returns The resulting value.

setFontItalic(italic: boolean): void;

Sets the font italic. @param italic Italic.

foreground(): string | null;

Returns or updates the foreground value. @returns The resulting value.

setForeground(color: string | null): void;

Sets the foreground. @param color Color.

fontFamily(): string | null;

Returns the font family setting. @returns The resulting value.

setFontFamily(family: string | null): void;

Sets the font family. @param family Family.

fontSize(): number | null;

Returns the font size setting. @returns The resulting value.

setFontSize(size: number | null): void;

Sets the font size. @param size Size.

fontUnderline(): boolean;

Returns the font underline setting. @returns The resulting value.

setFontUnderline(underline: boolean): void;

Sets the font underline. @param underline Underline.

anchorHref(): string | null;

Returns or updates the anchor href value. @returns The resulting value.

setAnchorHref(href: string | null): void;

Sets the anchor href. @param href Href.

equals(other: CTextCharFormat): boolean;

Returns whether this object is equal to another object. @param other Other. @returns The resulting value.