ig.excel.FormattedStringFont
Remarks
The formatting of the string is controlled in a similar fashion as it would be in Microsoft Excel. In Excel, the user must select a portion of the text and set the various formatting properties of that selected text.
With the FormattedStringFont.formattedString, a portion of the string is "selected" by calling either GetFont(int) or GetFont(int,int). Formatting properties are then set on the returned FormattedStringFont and all characters in the font's selection range are given these properties.
Getting the formatting properties of a FormattedStringFont will return the formatting of the first character in font's selection range. This is similar to Excel, which will update the formatting interface to reflect the formatting of the first character in a selection range when a cell's text is selected.
Dependencies
-
bold
Inherited- .bold( );
- Return Type:
- boolean
- Return Type Description:
- The value indicating whether the font is bold.
Gets the value indicating whether the font is bold.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The value assigned is not defined in the ExcelDefaultableBoolean enumeration. ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
-
bold
Inherited- .bold( value:boolean );
- Return Type:
- boolean
- Return Type Description:
- The value indicating whether the font is bold.
Sets the value indicating whether the font is bold.
- value
- Type:boolean
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The value assigned is not defined in the ExcelDefaultableBoolean enumeration. ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
-
colorInfo
Inherited- .colorInfo( );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- The fore color of the font.
Gets the fore color of the font.
Exceptions
Exception Description ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
See Also
-
colorInfo
Inherited- .colorInfo( value:ig.excel.WorkbookColorInfo );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- The fore color of the font.
Sets the fore color of the font.
- value
- Type:ig.excel.WorkbookColorInfo
Exceptions
Exception Description ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
See Also
-
formattedString
- .formattedString( );
- Return Type:
- ig.excel.FormattedString
- Return Type Description:
- The formatted string which is controlled by this font.
Gets the formatted string which is controlled by this font.
See Also
-
height
Inherited- .height( );
- Return Type:
- number
- Return Type Description:
- The height of the font.
Gets the height of the font.
Exceptions
Exception Description ig.ArgumentOutOfRangeException The value assigned is positive and outside the valid font height range of 20 and 8180. ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
-
height
Inherited- .height( value:number );
- Return Type:
- number
- Return Type Description:
- The height of the font.
Sets the height of the font.
- value
- Type:number
Exceptions
Exception Description ig.ArgumentOutOfRangeException The value assigned is positive and outside the valid font height range of 20 and 8180. ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
-
italic
Inherited- .italic( );
- Return Type:
- boolean
- Return Type Description:
- The value indicating whether the font is italic.
Gets the value indicating whether the font is italic.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The value assigned is not defined in the ExcelDefaultableBoolean enumeration. ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
-
italic
Inherited- .italic( value:boolean );
- Return Type:
- boolean
- Return Type Description:
- The value indicating whether the font is italic.
Sets the value indicating whether the font is italic.
- value
- Type:boolean
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The value assigned is not defined in the ExcelDefaultableBoolean enumeration. ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
-
length
Inherited- .length( );
- Return Type:
- number
- Return Type Description:
- The number of characters covered by this font. Zero indicates the font controls from the StartIndex to the end of the string.
Gets the number of characters covered by this font. Zero indicates the font controls from the FormattedFontBase.startIndex to the end of the string.
-
name
Inherited- .name( );
- Return Type:
- string
- Return Type Description:
- The name of the font.
Gets the name of the font.
Exceptions
Exception Description ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
-
name
Inherited- .name( value:string );
- Return Type:
- string
- Return Type Description:
- The name of the font.
Sets the name of the font.
- value
- Type:string
Exceptions
Exception Description ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
-
setFontFormatting
Inherited- .setFontFormatting( source:ig.excel.IWorkbookFont );
Sets all properties of this font to the properties of the specified font.
- source
- Type:ig.excel.IWorkbookFont
- The font whose properties should be copied over to this font.
Exceptions
Exception Description ig.ArgumentNullException source is null. ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, any default values on the specified font will be ignored.
See Also
-
startIndex
Inherited- .startIndex( );
- Return Type:
- number
- Return Type Description:
- The index of the first character covered by this font.
Gets the index of the first character covered by this font.
-
strikeout
Inherited- .strikeout( );
- Return Type:
- boolean
- Return Type Description:
- The value indicating whether the font is struck out.
Gets the value indicating whether the font is struck out.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The value assigned is not defined in the ExcelDefaultableBoolean enumeration. ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
-
strikeout
Inherited- .strikeout( value:boolean );
- Return Type:
- boolean
- Return Type Description:
- The value indicating whether the font is struck out.
Sets the value indicating whether the font is struck out.
- value
- Type:boolean
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The value assigned is not defined in the ExcelDefaultableBoolean enumeration. ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
-
superscriptSubscriptStyle
Inherited- .superscriptSubscriptStyle( );
- Return Type:
- ig.excel.FontSuperscriptSubscriptStyle
- Return Type Description:
- The value indicating whether the font is superscript or subscript.
Gets the value indicating whether the font is superscript or subscript.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The value assigned is not defined in the FontSuperscriptSubscriptStyle enumeration. ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
-
superscriptSubscriptStyle
Inherited- .superscriptSubscriptStyle( value:ig.excel.FontSuperscriptSubscriptStyle );
- Return Type:
- ig.excel.FontSuperscriptSubscriptStyle
- Return Type Description:
- The value indicating whether the font is superscript or subscript.
Sets the value indicating whether the font is superscript or subscript.
- value
- Type:ig.excel.FontSuperscriptSubscriptStyle
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The value assigned is not defined in the FontSuperscriptSubscriptStyle enumeration. ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
-
underlineStyle
Inherited- .underlineStyle( );
- Return Type:
- ig.excel.FontUnderlineStyle
- Return Type Description:
- The underline style of the font.
Gets the underline style of the font.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The value assigned is not defined in the FontUnderlineStyle enumeration. ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
See Also
-
underlineStyle
Inherited- .underlineStyle( value:ig.excel.FontUnderlineStyle );
- Return Type:
- ig.excel.FontUnderlineStyle
- Return Type Description:
- The underline style of the font.
Sets the underline style of the font.
- value
- Type:ig.excel.FontUnderlineStyle
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The value assigned is not defined in the FontUnderlineStyle enumeration. ig.InvalidOperationException The formatted string or text associated with the font is not assigned to a cell, comment, or shape. ig.InvalidOperationException The font's selection range is outside the valid character range of the associated formatted string or text. Remarks
All characters in the selection range of this font will be affected by setting this property. Getting this property will return a value which indicates the formatting of the first character in this font's range.
Note: default values cannot be used in FormattedString values applied to cells. If this font belongs to a FormattedString which is the value of a cell, and a default value is assigned, it will be ignored.
See Also