TextProperties Class

Contains text formatting properties.

Declaration

public class TextProperties extends OfficeObject

Remarks

Note

Different presentation viewers may prioritize paragraph-level and level-specific settings differently. In some instances, top-level paragraphs may use either getParagraphProperties() or getLevel1ParagraphProperties() settings.

Inherited Members

deepClone()

notifyChange(Object sender, String propertyName)

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.initFields()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

JavaObject

OfficeObject

TextProperties

TextProperties()

Initializes a new instance of the TextProperties class.

Declaration

public TextProperties()

Methods

deepClone() Method

Returns a deep copy of this TextProperties instance.

Declaration

public TextProperties deepClone()

Returns

Type	Description
TextProperties	A deep copy of this TextProperties.

getAlternativeLanguage() Method

Returns the secondary language used by the application when displaying UI controls.

Declaration

public Locale getAlternativeLanguage()

Returns

Type	Description
Locale	The secondary language.

getBold() Method

Returns whether the text is bold.

Declaration

public @Nullable Boolean getBold()

Returns

Type	Description
	true if the text is bold; otherwise, false.

getCaps() Method

Returns the capitalization type for the text.

Declaration

public @Nullable TextCapType getCaps()

Returns

Type	Description
TextCapType	The text capitalization type.

getComplexScriptFont() Method

Returns the minor theme font for Complex Script characters (right-to-left languages).

Declaration

public @Nullable TextFont getComplexScriptFont()

Returns

Type	Description
TextFont	The font used for complex script characters.

getDirty() Method

Indicates if the text has changed since the last time it was processed.

Declaration

public @Nullable Boolean getDirty()

Returns

Type	Description
	true if the text has changed and requires updating; otherwise, false.

getEastAsianFont() Method

Returns the font name for East Asian characters.

Declaration

public @Nullable TextFont getEastAsianFont()

Returns

Type	Description
TextFont	The font used for East Asian characters.

getEffects() Method

Returns the text effect properties.

Declaration

public EffectProperties getEffects()

Returns

Type	Description
EffectProperties	Effects applied to the text.

getFill() Method

Returns the fill settings for the text.

Declaration

public Fill getFill()

Returns

Type	Description
Fill	Fill settings.

getFontSize() Method

Returns the text font size.

Declaration

public @Nullable Float getFontSize()

Returns

Type	Description
	The font size.

getHasSpellingError() Method

Indicates whether the text has a spelling error.

Declaration

public @Nullable Boolean getHasSpellingError()

Returns

Type	Description
	true if the text contains a spelling error; otherwise, false.

getHighlightColor() Method

Returns the text highlight color.

Declaration

public OfficeColor getHighlightColor()

Returns

Type	Description
OfficeColor	The highlight color.

getItalic() Method

Indicates whether the text is italicized.

Declaration

public @Nullable Boolean getItalic()

Returns

Type	Description
	true if the text is italic; otherwise, false.

getKerningThreshold() Method

Returns the minimum font size for which the kerning is adjusted automatically.

Declaration

public @Nullable Float getKerningThreshold()

Returns

Type	Description
	The kerning threshold.

getKumimoji() Method

Returns whether the numbers contained within vertical text continue vertically with the text or whether they are to be displayed horizontally while the surrounding characters continue in a vertical fashion.

Declaration

public @Nullable Boolean getKumimoji()

Returns

Type	Description
	true if Kumimoji formatting is enabled; otherwise, false.

getLanguage() Method

Returns the language used by the application when displaying UI controls.

Declaration

public Locale getLanguage()

Returns

Type	Description
Locale	The language.

getLatinFont() Method

Returns the font name for Latin characters.

Declaration

public @Nullable TextFont getLatinFont()

Returns

Type	Description
TextFont	The font used for Latin characters.

getNoProof() Method

Returns whether the text should be proofread by the spell checker.

Declaration

public @Nullable Boolean getNoProof()

Returns

Type	Description
	true if proofing is disabled; otherwise, false.

getNormalizeHeight() Method

Returns whether to normalize the text height.

Declaration

public @Nullable Boolean getNormalizeHeight()

Returns

Type	Description
	true if character height is normalized; otherwise, false.

getOffsetFromBaseline() Method

Returns the baseline offset for superscript and subscript fonts. The value is a percentage of the font size (for example, 50% equals half the font size and 100% equals the full font size).

Declaration

public @Nullable Float getOffsetFromBaseline()

Returns

Type	Description
	The offset from the baseline.

getOutlineStyle() Method

Returns the character outline style.

Declaration

public OutlineStyle getOutlineStyle()

Returns

Type	Description
OutlineStyle	The outline style applied to the text.

getSmartTagClean() Method

Indicates whether the text was checked for smart tags.

Declaration

public @Nullable Boolean getSmartTagClean()

Returns

Type	Description
	true if the smart tag state is clean; otherwise, false.

getSmartTagId() Method

Returns a smart tag identifier for the text.

Declaration

public @Nullable Long getSmartTagId()

Returns

Type	Description
	The smart tag identifier.

getSpacing() Method

Returns the spacing (in twips) between characters.

Declaration

public @Nullable Float getSpacing()

Returns

Type	Description
	The character spacing.

getStrikethroughType() Method

Returns the strikethrough type for the text.

Declaration

public @Nullable TextStrikethroughType getStrikethroughType()

Returns

Type	Description
TextStrikethroughType	The strikethrough type.

getSymbolFont() Method

Returns the font name for symbol characters.

Declaration

public @Nullable TextFont getSymbolFont()

Returns

Type	Description
TextFont	The font used for symbol characters.

getUnderlineFill() Method

Returns underline fill settings for the text.

Declaration

public @Nullable UnderlineFill getUnderlineFill()

Returns

Type	Description
UnderlineFill	Underline fill settings.

getUnderlineStyle() Method

Returns underline settings for the text.

Declaration

public @Nullable UnderlineStyle getUnderlineStyle()

Returns

Type	Description
UnderlineStyle	Underline style settings.

getUnderlineType() Method

The underline type for the text.

Declaration

public @Nullable TextUnderlineType getUnderlineType()

Returns

Type	Description
TextUnderlineType	The underline type.

setAlternativeLanguage(Locale value) Method

Sets the secondary language used by the application when displaying UI controls.

Declaration

public void setAlternativeLanguage(Locale value)

Parameters

Name	Type	Description
value	Locale	The secondary language.

setBold(@Nullable Boolean value) Method

Sets whether to apply bold formatting.

Declaration

public void setBold(@Nullable Boolean value)

Parameters

Name	Type	Description
value		true to apply bold formatting; otherwise, false.

setCaps(@Nullable TextCapType value) Method

Sets the text capitalization type.

Declaration

public void setCaps(@Nullable TextCapType value)

Parameters

Name	Type	Description
value	TextCapType	The text capitalization type.

setComplexScriptFont(@Nullable TextFont value) Method

Sets the font used for complex script characters.

Declaration

public void setComplexScriptFont(@Nullable TextFont value)

Parameters

Name	Type	Description
value	TextFont	The font used for complex script characters.

setDirty(@Nullable Boolean value) Method

Sets whether the text has changed and requires updating.

Declaration

public void setDirty(@Nullable Boolean value)

Parameters

Name	Type	Description
value		true if the text has changed and requires updating; otherwise, false.

setEastAsianFont(@Nullable TextFont value) Method

Sets the font used for East Asian characters.

Declaration

public void setEastAsianFont(@Nullable TextFont value)

Parameters

Name	Type	Description
value	TextFont	The font used for East Asian characters.

setEffects(EffectProperties value) Method

Sets text effect properties.

Declaration

public void setEffects(EffectProperties value)

Parameters

Name	Type	Description
value	EffectProperties	Effects applied to the text.

setFill(Fill value) Method

Sets fill settings for the text.

Declaration

public void setFill(Fill value)

Parameters

Name	Type	Description
value	Fill	Fill settings for the text.

setFontSize(@Nullable Float value) Method

Sets the font size.

Declaration

public void setFontSize(@Nullable Float value)

Parameters

Name	Type	Description
value		The font size.

setHasSpellingError(@Nullable Boolean value) Method

Sets whether the text contains a spelling error.

Declaration

public void setHasSpellingError(@Nullable Boolean value)

Parameters

Name	Type	Description
value		true if the text contains a spelling error; otherwise, false.

setHighlightColor(OfficeColor value) Method

Sets the text highlight color.

Declaration

public void setHighlightColor(OfficeColor value)

Parameters

Name	Type	Description
value	OfficeColor	The highlight color.

setItalic(@Nullable Boolean value) Method

Sets whether to apply italic formatting.

Declaration

public void setItalic(@Nullable Boolean value)

Parameters

Name	Type	Description
value		true to apply italic formatting; otherwise, false.

setKerningThreshold(@Nullable Float value) Method

Sets the kerning threshold.

Declaration

public void setKerningThreshold(@Nullable Float value)

Parameters

Name	Type	Description
value		The kerning threshold.

setKumimoji(@Nullable Boolean value) Method

Sets whether Kumimoji formatting is enabled.

Declaration

public void setKumimoji(@Nullable Boolean value)

Parameters

Name	Type	Description
value		true to enable Kumimoji formatting; otherwise, false.

setLanguage(Locale value) Method

Sets the language used by the application when displaying UI controls.

Declaration

public void setLanguage(Locale value)

Parameters

Name	Type	Description
value	Locale	The language.

setLatinFont(@Nullable TextFont value) Method

Sets the font for Latin characters.

Declaration

public void setLatinFont(@Nullable TextFont value)

Parameters

Name	Type	Description
value	TextFont	The font for Latin characters.

setNoProof(@Nullable Boolean value) Method

Sets whether proofing is disabled.

Declaration

public void setNoProof(@Nullable Boolean value)

Parameters

Name	Type	Description
value		true to disable proofing; otherwise, false.

setNormalizeHeight(@Nullable Boolean value) Method

Sets whether character height is normalized.

Declaration

public void setNormalizeHeight(@Nullable Boolean value)

Parameters

Name	Type	Description
value		true to normalize character height; otherwise, false.

setOffsetFromBaseline(@Nullable Float value) Method

Sets the offset from the baseline.

Declaration

public void setOffsetFromBaseline(@Nullable Float value)

Parameters

Name	Type	Description
value		The offset from the baseline.

setOutlineStyle(OutlineStyle value) Method

Sets the character outline style.

Declaration

public void setOutlineStyle(OutlineStyle value)

Parameters

Name	Type	Description
value	OutlineStyle	The outline style applied to the text.

setSmartTagClean(@Nullable Boolean value) Method

Sets whether the smart tag state is clean.

Declaration

public void setSmartTagClean(@Nullable Boolean value)

Parameters

Name	Type	Description
value		true if the text was checked for smart tags; otherwise, false.

setSmartTagId(@Nullable Long value) Method

Sets the smart tag identifier.

Declaration

public void setSmartTagId(@Nullable Long value)

Parameters

Name	Type	Description
value		The smart tag identifier.

setSpacing(@Nullable Float value) Method

Sets the character spacing.

Declaration

public void setSpacing(@Nullable Float value)

Parameters

Name	Type	Description
value		The character spacing.

setStrikethroughType(@Nullable TextStrikethroughType value) Method

Sets the strikethrough type.

Declaration

public void setStrikethroughType(@Nullable TextStrikethroughType value)

Parameters

Name	Type	Description
value	TextStrikethroughType	The strikethrough type.

setSymbolFont(@Nullable TextFont value) Method

Sets the font used for symbol characters.

Declaration

public void setSymbolFont(@Nullable TextFont value)

Parameters

Name	Type	Description
value	TextFont	The font used for symbol characters.

setUnderlineFill(@Nullable UnderlineFill value) Method

Sets underline fill settings.

Declaration

public void setUnderlineFill(@Nullable UnderlineFill value)

Parameters

Name	Type	Description
value	UnderlineFill	Underline fill settings.

setUnderlineStyle(@Nullable UnderlineStyle value) Method

Sets underline style settings.

Declaration

public void setUnderlineStyle(@Nullable UnderlineStyle value)

Parameters

Name	Type	Description
value	UnderlineStyle	Underline style settings.

setUnderlineType(@Nullable TextUnderlineType value) Method

Sets the underline type.

Declaration

public void setUnderlineType(@Nullable TextUnderlineType value)

Parameters

Name	Type	Description
value	TextUnderlineType	The underline type.