Represents a string with mixed formatting in a cell or cell comment.
Constructors
Section titled "Constructors"FormattedString
new FormattedString(workbook: Workbook, element: StringElement): FormattedStringReturns FormattedString
Properties
Section titled "Properties"$t: TypeunformattedString
Section titled "unformattedString"unformattedString: stringMethods
Section titled "Methods"clone
Section titled "clone"Creates a new [[FormattedString]] that is a copy of this one.
clone(): FormattedStringReturns FormattedString
equals
Section titled "equals"Determines whether the specified [[Object]] is equal to this [[FormattedString]].
equals(obj: any): booleanParameters
- obj:
anyThe value to test for equality to this FormattedString.
Returns boolean
getFont
Section titled "getFont"Gets the font which controls the formatting properties in the string from the specified start index to the end of the string.
getFont(startIndex: number): FormattedStringFontParameters
- startIndex:
numberThe index of the first character the returned font controls.
Returns FormattedStringFont
getFormattingRuns
Section titled "getFormattingRuns"getFormattingRuns(): IEnumerable$1<FormattedStringFont>Returns IEnumerable$1<FormattedStringFont>
getHashCode
Section titled "getHashCode"Calculates the has code for this [[FormattedString]].
getHashCode(): numberReturns number
toString
Section titled "toString"Returns the [[String]] that represents this [[FormattedString]]. This is just the unformatted string.
toString(): string