ig.excel.FormattedString
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 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
-
ig.excel.FormattedString
Constructor- new $.ig.excel.FormattedString( unformattedString:string );
Creates a new instance of the FormattedString class.
- unformattedString
- Type:string
- The string that will be displayed in the cell with the formatting.
Exceptions
Exception Description ig.ArgumentNullException unformattedString is null. -
clone
- .clone( );
- Return Type:
- ig.excel.FormattedString
- Return Type Description:
- A new FormattedString that is a copy of this one.
Creates a new FormattedString that is a copy of this one.
Remarks
This should be used if the same formatted string needs to be used in multiple cells. The FormattedString class can only exist as the WorksheetCell.value of one cell at a time. If the FormattedString is already the value of a cell, and needs to be set as the value of another cell, clone the FormattedString and set the returned clone as value of the cell.
The cloned FormattedString only takes its original configuration for this instance. If this instance is cloned and than changed, the clone will not be changed as well; it will remain as it was when it was cloned.
-
equals
- .equals( obj:object );
- Return Type:
- boolean
- Return Type Description:
- True if the obj is a FormattedString instance and it contains the same unformatted string and formatting as this FormattedString; False otherwise.
Determines whether the specified Object is equal to this FormattedString.
- obj
- Type:object
- The value to test for equality to this FormattedString.
-
getFont
- .getFont( startIndex:number );
- Return Type:
- ig.excel.FormattedStringFont
- Return Type Description:
- A FormattedStringFont instance which controls the formatting of the end portion of the string.
Gets the font which controls the formatting properties in the string from the specified start index to the end of the string.
- startIndex
- Type:number
- The index of the first character the returned font controls.
Exceptions
Exception Description ig.ArgumentOutOfRangeException startIndex is less than zero. Remarks
If the start index is greater than or equal to the length of the unformatted string, no exception will be thrown. It will be thrown later when one of the formatting properties of the returned FormattedStringFont is set.
-
getFont
- .getFont( startIndex:number, length:number );
- Return Type:
- ig.excel.FormattedStringFont
- Return Type Description:
- A FormattedStringFont instance which controls the formatting of a portion of the string.
Gets the font which controls the formatting properties in the string from the specified start index for the specified number of characters.
- startIndex
- Type:number
- The index of the first character the returned font controls.
- length
- Type:number
- The number of characters after the start index controlled by the returned font.
Exceptions
Exception Description ig.ArgumentOutOfRangeException startIndex is less than zero. ig.ArgumentOutOfRangeException length is less than one. A zero length string cannot be controlled by a formatting font. Remarks
If the start index is greater than or equal to the length of the unformatted string, no exception will be thrown. It will be thrown later when one of the formatting properties of the returned FormattedStringFont is set.
-
getFormattingRuns
- .getFormattingRuns( );
Gets the collection of formatting runs representing contiguous blocks of similar formatting starting at the beginning of the string.
-
getHashCode
- .getHashCode( );
- Return Type:
- number
- Return Type Description:
- A number which can be used in hashing functions.
Calculates the has code for this FormattedString.
-
toString
- .toString( );
- Return Type:
- string
- Return Type Description:
- The String that represents this FormattedString.
Returns the String that represents this FormattedString. This is just the unformatted string.
Remarks
This will return the same value as FormattedString.unformattedString.
-
unformattedString
- .unformattedString( );
- Return Type:
- string
- Return Type Description:
- The unformatted string.
Gets the unformatted string.
Exceptions
Exception Description ig.ArgumentNullException The value assigned is a null string. Remarks
If the new unformatted string assigned is shorter than the old unformatted string, all formatting outside the range of the new value will be lost.
-
unformattedString
- .unformattedString( value:string );
- Return Type:
- string
- Return Type Description:
- The unformatted string.
Sets the unformatted string.
- value
- Type:string
Exceptions
Exception Description ig.ArgumentNullException The value assigned is a null string. Remarks
If the new unformatted string assigned is shorter than the old unformatted string, all formatting outside the range of the new value will be lost.