Word.Interfaces.StyleLoadOptions interface

Word ドキュメントのスタイルを表します。

注釈

[ API セット: WordApi 1.3 ]

プロパティ

$all

LoadOptions を指定すると $all 、すべてのスカラー プロパティ (例: Range.address) が読み込まれますが、ナビゲーション プロパティ (例: Range.format.fill.color) は読み込まれません。

baseStyle

別のスタイルの基本書式として使用する既存のスタイルの名前を指定します。

borders

指定したスタイルのすべての罫線を表す BorderCollection オブジェクトを指定します。

builtIn

指定したスタイルが組み込みスタイルであるかどうかを取得します。

description

指定したスタイルの説明を取得します。

font

指定したスタイルの文字書式を表すフォント オブジェクトを取得します。

inUse

指定したスタイルが、ドキュメント内で変更または適用された組み込みスタイルであるか、ドキュメント内に作成された新しいスタイルであるかを取得します。

linked

スタイルが、段落と文字の書式設定の両方に使用できるリンクされたスタイルであるかどうかを取得します。

listTemplate

指定した Style オブジェクトのリストの書式設定を表す ListTemplate オブジェクトを取得します。

nameLocal

ユーザーの言語でスタイルの名前を取得します。

nextParagraphStyle

指定したスタイルで書式設定された段落の後に挿入される新しい段落に自動的に適用されるスタイルの名前を指定します。

paragraphFormat

指定したスタイルの段落設定を表す ParagraphFormat オブジェクトを取得します。

priority

優先順位を指定します。

quickStyle

スタイルが使用可能なクイック スタイルに対応するかどうかを指定します。

shading

指定したスタイルの網かけを表す Shading オブジェクトを取得します。 リスト スタイルには適用されません。

tableStyle

テーブルに適用できる Style プロパティを表す TableStyle オブジェクトを取得します。

type

スタイルの種類を取得します。

unhideWhenUsed

指定したスタイルを文書で使用した後、[スタイル] および Microsoft Wordの [スタイル] 作業ウィンドウで推奨スタイルとして表示するかどうかを指定します。

visibility

[スタイル] ギャラリーと [スタイル] 作業ウィンドウで、指定したスタイルを推奨スタイルとして表示するかどうかを指定します。

プロパティの詳細

$all

LoadOptions を指定すると $all 、すべてのスカラー プロパティ (例: Range.address) が読み込まれますが、ナビゲーション プロパティ (例: Range.format.fill.color) は読み込まれません。

$all?: boolean;

プロパティ値

boolean

baseStyle

別のスタイルの基本書式として使用する既存のスタイルの名前を指定します。

baseStyle?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

注: 設定 baseStyle 機能は WordApi 1.6 で導入されました。

borders

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

指定したスタイルのすべての罫線を表す BorderCollection オブジェクトを指定します。

borders?: Word.Interfaces.BorderCollectionLoadOptions;

プロパティ値

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

builtIn

指定したスタイルが組み込みスタイルであるかどうかを取得します。

builtIn?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

description

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

指定したスタイルの説明を取得します。

description?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

font

指定したスタイルの文字書式を表すフォント オブジェクトを取得します。

font?: Word.Interfaces.FontLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.5 ]

inUse

指定したスタイルが、ドキュメント内で変更または適用された組み込みスタイルであるか、ドキュメント内に作成された新しいスタイルであるかを取得します。

inUse?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

linked

スタイルが、段落と文字の書式設定の両方に使用できるリンクされたスタイルであるかどうかを取得します。

linked?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

listTemplate

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

指定した Style オブジェクトのリストの書式設定を表す ListTemplate オブジェクトを取得します。

listTemplate?: Word.Interfaces.ListTemplateLoadOptions;

プロパティ値

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

nameLocal

ユーザーの言語でスタイルの名前を取得します。

nameLocal?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

nextParagraphStyle

指定したスタイルで書式設定された段落の後に挿入される新しい段落に自動的に適用されるスタイルの名前を指定します。

nextParagraphStyle?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

注: 設定 nextParagraphStyle 機能は WordApi 1.6 で導入されました。

paragraphFormat

指定したスタイルの段落設定を表す ParagraphFormat オブジェクトを取得します。

paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.5 ]

priority

優先順位を指定します。

priority?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

quickStyle

スタイルが使用可能なクイック スタイルに対応するかどうかを指定します。

quickStyle?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

shading

指定したスタイルの網かけを表す Shading オブジェクトを取得します。 リスト スタイルには適用されません。

shading?: Word.Interfaces.ShadingLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.6 ]

tableStyle

テーブルに適用できる Style プロパティを表す TableStyle オブジェクトを取得します。

tableStyle?: Word.Interfaces.TableStyleLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.6 ]

type

スタイルの種類を取得します。

type?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

unhideWhenUsed

指定したスタイルを文書で使用した後、[スタイル] および Microsoft Wordの [スタイル] 作業ウィンドウで推奨スタイルとして表示するかどうかを指定します。

unhideWhenUsed?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

visibility

[スタイル] ギャラリーと [スタイル] 作業ウィンドウで、指定したスタイルを推奨スタイルとして表示するかどうかを指定します。

visibility?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]