Visio.Page class

パッケージ:

visio

Page クラスを表します。

Extends

OfficeExtension.ClientObject

注釈

[ API セット: 1.1 ]

プロパティ

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;

プロパティ値

Visio.ShapeCollection

注釈

[ API セット: 1.1 ]

comments

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

readonly comments: Visio.CommentCollection;

プロパティ値

Visio.CommentCollection

注釈

[ API セット: 1.1 ]

context

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

context: RequestContext;

プロパティ値

Visio.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;

プロパティ値

Visio.ShapeCollection

注釈

[ API セット: 1.1 ]

view

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

readonly view: Visio.PageView;

プロパティ値

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

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

戻り値

Visio.Page

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Visio.Page

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

Visio.Page

set(properties, options)

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

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

パラメーター

properties

Visio.Interfaces.PageUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options

OfficeExtension.UpdateOptions

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

戻り値

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;

戻り値

Visio.Interfaces.PageData