Word.OleFormat class
OLE オブジェクト、ActiveX コントロール、またはフィールドの (リンク以外の) OLE 特性を表します。
- Extends
プロパティ
| class |
指定された OLE オブジェクト、画像、またはフィールドのクラス型を指定します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| icon |
|
| icon |
OLE オブジェクトのアイコンの下に表示されるテキストを指定します。 |
| icon |
OLE オブジェクトのアイコンが格納されているプログラム ファイルを指定します。 |
| icon |
OLE オブジェクトのアイコンが格納されているファイルのパスを取得します。 |
| is |
指定したオブジェクトがアイコンとして表示されるかどうかを取得します。 |
| is |
リンクされた OLE オブジェクトに対して Microsoft Word で設定された書式設定を保持するかどうかを指定します。 |
| label | リンクされるソース ファイルの部分を識別するために使用される文字列を取得します。 |
| prog |
指定された OLE オブジェクトのプログラム識別子 ( |
メソッド
| activate() |
|
| activate |
指定された OLE オブジェクトをアクティブにするときに使用する既定のアプリケーションを決定する Windows のレジストリ値を設定します。 |
| do |
OLE オブジェクトに対して使用可能な動詞のいずれかを実行するように要求します。 |
| do |
OLE オブジェクトに対して使用可能な動詞のいずれかを実行するように要求します。 |
| edit() | OLE オブジェクトを開いて、作成元のアプリケーションで編集します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| open() |
|
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 |
プロパティの詳細
classType
指定された OLE オブジェクト、画像、またはフィールドのクラス型を指定します。
classType: string;プロパティ値
string
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
iconIndex
displayAsIcon プロパティがtrueされているときに使用されるアイコンを指定します。
iconIndex: number;プロパティ値
number
注釈
iconLabel
iconName
OLE オブジェクトのアイコンが格納されているプログラム ファイルを指定します。
iconName: string;プロパティ値
string
注釈
iconPath
OLE オブジェクトのアイコンが格納されているファイルのパスを取得します。
readonly iconPath: string;プロパティ値
string
注釈
isDisplayedAsIcon
指定したオブジェクトがアイコンとして表示されるかどうかを取得します。
readonly isDisplayedAsIcon: boolean;プロパティ値
boolean
注釈
isFormattingPreservedOnUpdate
リンクされた OLE オブジェクトに対して Microsoft Word で設定された書式設定を保持するかどうかを指定します。
isFormattingPreservedOnUpdate: boolean;プロパティ値
boolean
注釈
label
リンクされるソース ファイルの部分を識別するために使用される文字列を取得します。
readonly label: string;プロパティ値
string
注釈
progId
指定された OLE オブジェクトのプログラム識別子 (ProgId) を取得します。
readonly progId: string;プロパティ値
string
注釈
メソッドの詳細
activate()
activateAs(classType)
指定された OLE オブジェクトをアクティブにするときに使用する既定のアプリケーションを決定する Windows のレジストリ値を設定します。
activateAs(classType: string): void;パラメーター
- classType
-
string
アクティブ化するクラスの型。
返品
void
注釈
doVerb(verbIndex)
OLE オブジェクトに対して使用可能な動詞のいずれかを実行するように要求します。
doVerb(verbIndex: Word.OleVerb): void;パラメーター
- verbIndex
- Word.OleVerb
省略可能。 実行する動詞のインデックス。
返品
void
注釈
doVerb(verbIndex)
OLE オブジェクトに対して使用可能な動詞のいずれかを実行するように要求します。
doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void;パラメーター
- verbIndex
-
"Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"
省略可能。 実行する動詞のインデックス。
返品
void
注釈
edit()
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.OleFormatLoadOptions): Word.OleFormat;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.OleFormat;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.OleFormat;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
open()
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.OleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.OleFormatUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.OleFormat): void;パラメーター
- properties
- Word.OleFormat
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.OleFormat オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.OleFormatData と型指定) を返します。
toJSON(): Word.Interfaces.OleFormatData;返品
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.OleFormat;返品
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。
untrack(): Word.OleFormat;