Excel.PageBreak class
- Extends
column |
Specifies the column index for the page break. |
context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
row |
Specifies the row index for the page break. |
delete() | Deletes a page break object. |
get |
Gets the first cell after the page break. |
load(options) | Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
toJSON() | Overrides the JavaScript |
Specifies the column index for the page break.
readonly columnIndex: number;
Property Value
number
Remarks
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;
Property Value
Specifies the row index for the page break.
readonly rowIndex: number;
Property Value
number
Remarks
Gets the first cell after the page break.
getCellAfterBreak(): Excel.Range;
Returns
Remarks
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(options?: Excel.Interfaces.PageBreakLoadOptions): Excel.PageBreak;
Parameters
Provides options for which properties of the object to load.
Returns
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNames?: string | string[]): Excel.PageBreak;
Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.PageBreak;
Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand
is a comma-delimited string that specifies the navigation properties to load.
Returns
Overrides the JavaScript toJSON()
method in order to provide more useful output when an API object is passed to JSON.stringify()
. (JSON.stringify
, in turn, calls the toJSON
method of the object that is passed to it.) Whereas the original Excel.PageBreak
object is an API object, the toJSON
method returns a plain JavaScript object (typed as Excel.Interfaces.PageBreakData
) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.PageBreakData;
Returns
Office Add-ins feedback
Office Add-ins is an open source project. Select a link to provide feedback: