com.aspose.slides
Interface IBasePortionFormat

All Known Subinterfaces:
IChartPortionFormat, IPortionFormat
All Known Implementing Classes:
BasePortionFormat, ChartPortionFormat, PortionFormat

public interface IBasePortionFormat

This class contains the text portion formatting properties. Unlike PortionFormatEffectiveData, all properties of this class are writeable.


This class is used to return and manipulate text portion formatting properties defined for the particular portion. This means that no inheritance is applied when getting values so for the majority of cases you will get values meaning "undefined".

In order to get the effective formatting parameter values including inherited you need to use PortionEx.CreatePortionFormatEffective method which returns a CreatePortionFormatEffective instance.


Method Summary
 java.lang.String getAlternativeLanguageId()
           Returns or sets the Id of an alternative language.
 IFontData getComplexScriptFont()
           Returns or sets the complex script font info.
 IFontData getEastAsianFont()
           Returns or sets the East Asian font info.
 IEffectFormat getEffectFormat()
           Returns the text EffectFormatEx properties.
 float getEscapement()
           Returns or sets the superscript or subscript text.
 IFillFormat getFillFormat()
           Returns the text FillFormatEx properties.
 byte getFontBold()
           Determines whether the font is bold.
 float getFontHeight()
           Returns or sets the font height of a portion.
 byte getFontItalic()
           Determines whether the font is itallic.
 byte getFontUnderline()
           Returns or sets the text underline type.
 IColorFormat getHighlightColor()
           Returns the color used to highlight a text.
 float getKerningMinimalSize()
           Returns or sets the minimal font size, for which kerning should be switched on.
 byte getKumimoji()
           Determines whether the numbers should ignore text eastern language-specific vertical text layout.
 java.lang.String getLanguageId()
           Returns or sets the Id of a language.
 IFontData getLatinFont()
           Returns or sets the Latin font info.
 ILineFormat getLineFormat()
           Returns the LineFormatEx properties for text outlining.
 byte getNormaliseHeight()
           Determines whether the height of a text should be normalized.
 byte getProofDisabled()
           Determines whether the text shouldn't be proofed.
 float getSpacing()
           Returns or sets the intercharacter spacing increment.
 byte getStrikethroughType()
           Returns or sets the strikethrough type of a text.
 IFontData getSymbolFont()
           Returns or sets the symbolic font info.
 byte getTextCapType()
           Returns or sets the type of text capitalization.
 IFillFormat getUnderlineFillFormat()
           Returns the underline line FillFormatEx properties.
 ILineFormat getUnderlineLineFormat()
           Returns the LineFormatEx properties used to outline underline line.
 byte isHardUnderlineFill()
           Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text.
 byte isHardUnderlineLine()
           Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text.
 void setAlternativeLanguageId(java.lang.String value)
           Returns or sets the Id of an alternative language.
 void setComplexScriptFont(IFontData value)
           Returns or sets the complex script font info.
 void setEastAsianFont(IFontData value)
           Returns or sets the East Asian font info.
 void setEscapement(float value)
           Returns or sets the superscript or subscript text.
 void setFontBold(byte value)
           Determines whether the font is bold.
 void setFontHeight(float value)
           Returns or sets the font height of a portion.
 void setFontItalic(byte value)
           Determines whether the font is itallic.
 void setFontUnderline(byte value)
           Returns or sets the text underline type.
 void setHardUnderlineFill(byte value)
           Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text.
 void setHardUnderlineLine(byte value)
           Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text.
 void setKerningMinimalSize(float value)
           Returns or sets the minimal font size, for which kerning should be switched on.
 void setKumimoji(byte value)
           Determines whether the numbers should ignore text eastern language-specific vertical text layout.
 void setLanguageId(java.lang.String value)
           Returns or sets the Id of a language.
 void setLatinFont(IFontData value)
           Returns or sets the Latin font info.
 void setNormaliseHeight(byte value)
           Determines whether the height of a text should be normalized.
 void setProofDisabled(byte value)
           Determines whether the text shouldn't be proofed.
 void setSpacing(float value)
           Returns or sets the intercharacter spacing increment.
 void setStrikethroughType(byte value)
           Returns or sets the strikethrough type of a text.
 void setSymbolFont(IFontData value)
           Returns or sets the symbolic font info.
 void setTextCapType(byte value)
           Returns or sets the type of text capitalization.
 

Method Detail

getLineFormat

ILineFormat getLineFormat()

Returns the LineFormatEx properties for text outlining. No inheritance applied. Read-only ILineFormat.


getFillFormat

IFillFormat getFillFormat()

Returns the text FillFormatEx properties. No inheritance applied. Read-only IFillFormat.


getEffectFormat

IEffectFormat getEffectFormat()

Returns the text EffectFormatEx properties. No inheritance applied. Read-only IEffectFormat.


getHighlightColor

IColorFormat getHighlightColor()

Returns the color used to highlight a text. No inheritance applied. Read-only IColorFormat.


getUnderlineLineFormat

ILineFormat getUnderlineLineFormat()

Returns the LineFormatEx properties used to outline underline line. No inheritance applied. Read-only ILineFormat.


getUnderlineFillFormat

IFillFormat getUnderlineFillFormat()

Returns the underline line FillFormatEx properties. No inheritance applied. Read-only IFillFormat.


getFontBold

byte getFontBold()

Determines whether the font is bold. No inheritance applied. Read/write NullableBool.


setFontBold

void setFontBold(byte value)

Determines whether the font is bold. No inheritance applied. Read/write NullableBool.


getFontItalic

byte getFontItalic()

Determines whether the font is itallic. No inheritance applied. Read/write NullableBool.


setFontItalic

void setFontItalic(byte value)

Determines whether the font is itallic. No inheritance applied. Read/write NullableBool.


getKumimoji

byte getKumimoji()

Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Read/write NullableBool.


setKumimoji

void setKumimoji(byte value)

Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Read/write NullableBool.


getNormaliseHeight

byte getNormaliseHeight()

Determines whether the height of a text should be normalized. No inheritance applied. Read/write NullableBool.


setNormaliseHeight

void setNormaliseHeight(byte value)

Determines whether the height of a text should be normalized. No inheritance applied. Read/write NullableBool.


getProofDisabled

byte getProofDisabled()

Determines whether the text shouldn't be proofed. No inheritance applied. Read/write NullableBool.


setProofDisabled

void setProofDisabled(byte value)

Determines whether the text shouldn't be proofed. No inheritance applied. Read/write NullableBool.


getFontUnderline

byte getFontUnderline()

Returns or sets the text underline type. No inheritance applied. Read/write TextUnderlineType.


setFontUnderline

void setFontUnderline(byte value)

Returns or sets the text underline type. No inheritance applied. Read/write TextUnderlineType.


getTextCapType

byte getTextCapType()

Returns or sets the type of text capitalization. No inheritance applied. Read/write TextCapType.


setTextCapType

void setTextCapType(byte value)

Returns or sets the type of text capitalization. No inheritance applied. Read/write TextCapType.


getStrikethroughType

byte getStrikethroughType()

Returns or sets the strikethrough type of a text. No inheritance applied. Read/write TextStrikethroughType.


setStrikethroughType

void setStrikethroughType(byte value)

Returns or sets the strikethrough type of a text. No inheritance applied. Read/write TextStrikethroughType.


isHardUnderlineLine

byte isHardUnderlineLine()

Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Read/write NullableBool.


setHardUnderlineLine

void setHardUnderlineLine(byte value)

Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Read/write NullableBool.


isHardUnderlineFill

byte isHardUnderlineFill()

Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Read/write NullableBool.


setHardUnderlineFill

void setHardUnderlineFill(byte value)

Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Read/write NullableBool.


getFontHeight

float getFontHeight()

Returns or sets the font height of a portion. Float.NaN means height is undefined and should be inherited from the Master. Read/write float.


setFontHeight

void setFontHeight(float value)

Returns or sets the font height of a portion. Float.NaN means height is undefined and should be inherited from the Master. Read/write float.


getLatinFont

IFontData getLatinFont()

Returns or sets the Latin font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.


setLatinFont

void setLatinFont(IFontData value)

Returns or sets the Latin font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.


getEastAsianFont

IFontData getEastAsianFont()

Returns or sets the East Asian font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.


setEastAsianFont

void setEastAsianFont(IFontData value)

Returns or sets the East Asian font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.


getComplexScriptFont

IFontData getComplexScriptFont()

Returns or sets the complex script font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.


setComplexScriptFont

void setComplexScriptFont(IFontData value)

Returns or sets the complex script font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.


getSymbolFont

IFontData getSymbolFont()

Returns or sets the symbolic font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.


setSymbolFont

void setSymbolFont(IFontData value)

Returns or sets the symbolic font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.


getEscapement

float getEscapement()

Returns or sets the superscript or subscript text. Value from -100% (subscript) to 100% (superscript). Float.NaN means value is undefined and should be inherited from the Master. Read/write float.


setEscapement

void setEscapement(float value)

Returns or sets the superscript or subscript text. Value from -100% (subscript) to 100% (superscript). Float.NaN means value is undefined and should be inherited from the Master. Read/write float.


getKerningMinimalSize

float getKerningMinimalSize()

Returns or sets the minimal font size, for which kerning should be switched on. Float.NaN means value is undefined and should be inherited from the Master. Read/write float.


setKerningMinimalSize

void setKerningMinimalSize(float value)

Returns or sets the minimal font size, for which kerning should be switched on. Float.NaN means value is undefined and should be inherited from the Master. Read/write float.


getLanguageId

java.lang.String getLanguageId()

Returns or sets the Id of a language. Read/write String.


setLanguageId

void setLanguageId(java.lang.String value)

Returns or sets the Id of a language. Read/write String.


getAlternativeLanguageId

java.lang.String getAlternativeLanguageId()

Returns or sets the Id of an alternative language. Read/write String.


setAlternativeLanguageId

void setAlternativeLanguageId(java.lang.String value)

Returns or sets the Id of an alternative language. Read/write String.


getSpacing

float getSpacing()

Returns or sets the intercharacter spacing increment. Float.NaN means value is undefined and should be inherited from the Master. Read/write float.


setSpacing

void setSpacing(float value)

Returns or sets the intercharacter spacing increment. Float.NaN means value is undefined and should be inherited from the Master. Read/write float.



Copyright © Copyright 2004-2016 Aspose Pty Ltd. All Rights Reserved.