PowerPoint.Interfaces.TextRangeLoadOptions interface

Package:

powerpoint

Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.

Remarks

[ API set: PowerPointApi 1.4 ]

Properties

$all	Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
font	Returns a ShapeFont object that represents the font attributes for the text range.
length	Gets or sets the length of the range that this TextRange represents. Throws an InvalidArgument exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
paragraphFormat	Represents the paragraph format of the text range. See PowerPoint.ParagraphFormat for details.
start	Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this TextRange represents. Throws an InvalidArgument exception when set with a negative value or if the value is greater than the length of the text.
text	Represents the plain text content of the text range.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

font

Returns a ShapeFont object that represents the font attributes for the text range.

font?: PowerPoint.Interfaces.ShapeFontLoadOptions;

Property Value

PowerPoint.Interfaces.ShapeFontLoadOptions

Remarks

[ API set: PowerPointApi 1.4 ]

length

Gets or sets the length of the range that this TextRange represents. Throws an InvalidArgument exception when set with a negative value or if the value is greater than the length of the available text from the starting point.

length?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.5 ]

paragraphFormat

Represents the paragraph format of the text range. See PowerPoint.ParagraphFormat for details.

paragraphFormat?: PowerPoint.Interfaces.ParagraphFormatLoadOptions;

Property Value

PowerPoint.Interfaces.ParagraphFormatLoadOptions

Remarks

[ API set: PowerPointApi 1.4 ]

start

Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this TextRange represents. Throws an InvalidArgument exception when set with a negative value or if the value is greater than the length of the text.

start?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.5 ]

text

Represents the plain text content of the text range.

text?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.4 ]