Excel.Interfaces.ShapeFontData interface
An interface describing the data returned by calling shapeFont.toJSON().
Properties
| bold | Represents the bold status of font. Returns |
| color | HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns |
| italic | Represents the italic status of font. Returns |
| name | Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. |
| size | Represents font size in points (e.g., 11). Returns |
| strikethrough | Specifies the strikethrough status of font. A |
| subscript | Specifies the subscript status of font. Returns |
| superscript | Specifies the superscript status of font. Returns |
| tint |
Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A |
| underline | Type of underline applied to the font. Returns |
Property Details
bold
Represents the bold status of font. Returns null if the TextRange includes both bold and non-bold text fragments.
bold?: boolean;Property Value
boolean
Remarks
color
HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns null if the TextRange includes text fragments with different colors.
color?: string;Property Value
string
Remarks
italic
Represents the italic status of font. Returns null if the TextRange includes both italic and non-italic text fragments.
italic?: boolean;Property Value
boolean
Remarks
name
Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
name?: string;Property Value
string
Remarks
size
Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
size?: number;Property Value
number
Remarks
strikethrough
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the strikethrough status of font. A null value indicates that the entire range doesn't have a uniform strikethrough setting.
strikethrough?: boolean;Property Value
boolean
Remarks
subscript
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the subscript status of font. Returns true if all the fonts of the range are subscript. Returns false if all the fonts of the range are superscript or normal (neither superscript, nor subscript). Returns null otherwise.
subscript?: boolean;Property Value
boolean
Remarks
superscript
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the superscript status of font. Returns true if all the fonts of the range are superscript. Returns false if all the fonts of the range are subscript or normal (neither superscript, nor subscript). Returns null otherwise.
superscript?: boolean;Property Value
boolean
Remarks
tintAndShade
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the entire range doesn't have a uniform font tintAndShade setting.
tintAndShade?: number;Property Value
number
Remarks
underline
Type of underline applied to the font. Returns null if the TextRange includes text fragments with different underline styles. See Excel.ShapeFontUnderlineStyle for details.
underline?: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";Property Value
Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"