Visio.Page class
Represents the Page class.
- Extends
Remarks
[ API set: 1.1 ]
Properties
all |
All shapes in the Page, including subshapes. |
comments | Returns the Comments Collection. |
context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
height | Returns the height of the page. |
index | Index of the Page. |
is |
Whether the page is a background page or not. |
name | Page name. |
shapes | All top-level shapes in the Page. |
view | Returns the view of the page. |
width | Returns the width of the page. |
Methods
activate() | Sets the page as Active Page of the document. |
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 |
set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
set |
Set mock data |
toJSON() | Overrides the JavaScript |
Property Details
allShapes
All shapes in the Page, including subshapes.
readonly allShapes: Visio.ShapeCollection;
Property Value
Remarks
[ API set: 1.1 ]
comments
Returns the Comments Collection.
readonly comments: Visio.CommentCollection;
Property Value
Remarks
[ API set: 1.1 ]
context
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
height
Returns the height of the page.
readonly height: number;
Property Value
number
Remarks
[ API set: 1.1 ]
index
isBackground
Whether the page is a background page or not.
readonly isBackground: boolean;
Property Value
boolean
Remarks
[ API set: 1.1 ]
name
shapes
All top-level shapes in the Page.
readonly shapes: Visio.ShapeCollection;
Property Value
Remarks
[ API set: 1.1 ]
view
Returns the view of the page.
readonly view: Visio.PageView;
Property Value
Remarks
[ API set: 1.1 ]
width
Returns the width of the page.
readonly width: number;
Property Value
number
Remarks
[ API set: 1.1 ]
Method Details
activate()
Sets the page as Active Page of the document.
activate(): void;
Returns
void
Remarks
[ API set: 1.1 ]
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(options?: Visio.Interfaces.PageLoadOptions): Visio.Page;
Parameters
- options
- Visio.Interfaces.PageLoadOptions
Provides options for which properties of the object to load.
Returns
load(propertyNames)
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[]): Visio.Page;
Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
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;
}): Visio.Page;
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
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parameters
- properties
- Visio.Interfaces.PageUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Visio.Page): void;
Parameters
- properties
- Visio.Page
Returns
void
setMockData(data)
Set mock data
setMockData(data: Visio.Interfaces.PageData): void;
Parameters
Returns
void
toJSON()
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 Visio.Page object is an API object, the toJSON
method returns a plain JavaScript object (typed as Visio.Interfaces.PageData
) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Visio.Interfaces.PageData;
Returns
Office Add-ins