Visio.Page class

Page クラスを表します。

Extends

プロパティ

allShapes

ページ内のすべての図形 (サブ図形を含む)。

comments

Comments コレクションを返します。

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

height

ページの高さを返します。

index

ページのインデックス。

isBackground

ページが背景ページかどうか。

name

ページの名前。

shapes

ページ内のすべての最上位図形。

view

ページのビューを返します。

width

ページの幅を返します。

メソッド

activate()

ドキュメントのページをアクティブ ページとして設定します。

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

toJSON()

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify は、渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Visio.Page オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Visio.Interfaces.PageData と型指定) を返します。

プロパティの詳細

allShapes

ページ内のすべての図形 (サブ図形を含む)。

readonly allShapes: Visio.ShapeCollection;

プロパティ値

注釈

API セット: 1.1

comments

Comments コレクションを返します。

readonly comments: Visio.CommentCollection;

プロパティ値

注釈

API セット: 1.1

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

height

ページの高さを返します。

readonly height: number;

プロパティ値

number

注釈

API セット: 1.1

index

ページのインデックス。

readonly index: number;

プロパティ値

number

注釈

API セット: 1.1

isBackground

ページが背景ページかどうか。

readonly isBackground: boolean;

プロパティ値

boolean

注釈

API セット: 1.1

name

ページの名前。

readonly name: string;

プロパティ値

string

注釈

API セット: 1.1

shapes

ページ内のすべての最上位図形。

readonly shapes: Visio.ShapeCollection;

プロパティ値

注釈

API セット: 1.1

view

ページのビューを返します。

readonly view: Visio.PageView;

プロパティ値

注釈

API セット: 1.1

width

ページの幅を返します。

readonly width: number;

プロパティ値

number

注釈

API セット: 1.1

メソッドの詳細

activate()

ドキュメントのページをアクティブ ページとして設定します。

activate(): void;

返品

void

注釈

API セット: 1.1

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

options
Visio.Interfaces.PageLoadOptions

読み込むオブジェクトのプロパティのオプションを指定します。

返品

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。

返品

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNamesAndPaths

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

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。

返品

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

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

パラメーター

properties
Visio.Interfaces.PageUpdateData

メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

返品

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Visio.Page): void;

パラメーター

properties
Visio.Page

返品

void

toJSON()

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify は、渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Visio.Page オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Visio.Interfaces.PageData と型指定) を返します。

toJSON(): Visio.Interfaces.PageData;

返品