Visio.Page class

Paket:

visio

Stellt die Page-Klasse dar.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: 1.1 ]

Eigenschaften

allShapes	Alle Shapes auf der Seite, einschließlich Unterformen.
comments	Gibt die Kommentarauflistung zurück.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
height	Gibt die Höhe der Seite zurück.
index	Der Index der Seite.
isBackground	Ob die Seite eine Hintergrundseite ist oder nicht.
name	Seitenname.
shapes	Alle Shapes der obersten Ebene auf der Seite.
view	Gibt die Ansicht der Seite zurück.
width	Gibt die Breite der Seite zurück.

Methoden

activate()	Legt die Seite als Aktive Seite des Dokuments fest.
load(options)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
set(properties, options)	Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties)	Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
setMockData(data)	Festlegen von Modelldaten
toJSON()	Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Visio.Page-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Visio.Interfaces.PageData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

allShapes

Alle Shapes auf der Seite, einschließlich Unterformen.

readonly allShapes: Visio.ShapeCollection;

Eigenschaftswert

Visio.ShapeCollection

Hinweise

[ API-Satz: 1.1 ]

comments

Gibt die Kommentarauflistung zurück.

readonly comments: Visio.CommentCollection;

Eigenschaftswert

Visio.CommentCollection

Hinweise

[ API-Satz: 1.1 ]

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Visio.RequestContext

height

Gibt die Höhe der Seite zurück.

readonly height: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: 1.1 ]

index

Der Index der Seite.

readonly index: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: 1.1 ]

isBackground

Ob die Seite eine Hintergrundseite ist oder nicht.

readonly isBackground: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: 1.1 ]

name

Seitenname.

readonly name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: 1.1 ]

shapes

Alle Shapes der obersten Ebene auf der Seite.

readonly shapes: Visio.ShapeCollection;

Eigenschaftswert

Visio.ShapeCollection

Hinweise

[ API-Satz: 1.1 ]

view

Gibt die Ansicht der Seite zurück.

readonly view: Visio.PageView;

Eigenschaftswert

Visio.PageView

Hinweise

[ API-Satz: 1.1 ]

width

Gibt die Breite der Seite zurück.

readonly width: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: 1.1 ]

Details zur Methode

activate()

Legt die Seite als Aktive Seite des Dokuments fest.

activate(): void;

Gibt zurück

void

Hinweise

[ API-Satz: 1.1 ]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Visio.Interfaces.PageLoadOptions): Visio.Page;

Parameter

options

Visio.Interfaces.PageLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Visio.Page

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Visio.Page;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Visio.Page

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Visio.Page;

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Visio.Page

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties

Visio.Interfaces.PageUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options

OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Visio.Page): void;

Parameter

properties

Visio.Page

Gibt zurück

void

setMockData(data)

Festlegen von Modelldaten

setMockData(data: Visio.Interfaces.PageData): void;

Parameter

data

Visio.Interfaces.PageData

Gibt zurück

void

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Visio.Page-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Visio.Interfaces.PageData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Visio.Interfaces.PageData;

Gibt zurück

Visio.Interfaces.PageData