Word.ListFormat class
範囲のリストの書式設定特性を表します。
- Extends
注釈
使用元
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/format-list-range.yaml
// Gets the range covering the entire body and reads list formatting properties.
await Word.run(async (context) => {
const bodyRange: Word.Range = context.document.body.getRange();
const listFormat: Word.ListFormat = bodyRange.listFormat;
listFormat.load("isSingleList, listType, listLevelNumber, listString, listValue");
await context.sync();
console.log("List format info for the body range:");
console.log(`- Is single list: ${listFormat.isSingleList}`);
console.log(`- List type: ${listFormat.listType}`);
console.log(`- List level number (first paragraph): ${listFormat.listLevelNumber}`);
console.log(`- List string (first paragraph): "${listFormat.listString}"`);
console.log(`- List value (first paragraph): ${listFormat.listValue}`);
});
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| is |
|
| is |
|
| list |
|
| list |
|
| list |
|
| list |
|
| list |
|
| list |
|
メソッド
| apply |
範囲内の段落に箇条書きと書式を追加します。 |
| apply |
範囲内の段落に箇条書きと書式を追加します。 |
| apply |
範囲内の段落に特定のレベルのリスト テンプレートを適用します。 |
| apply |
範囲内の段落に段落番号と書式を追加します。 |
| apply |
範囲内の段落に段落番号と書式を追加します。 |
| apply |
範囲内の段落にアウトライン番号付けと書式設定を追加します。 |
| apply |
範囲内の段落にアウトライン番号付けと書式設定を追加します。 |
| can |
|
| convert |
リスト内の数値をプレーン テキストに変換します。 |
| convert |
リスト内の数値をプレーン テキストに変換します。 |
| count |
一覧内の番号付き項目をカウントします。 |
| list |
リストを 1 レベルインデントします。 |
| list |
リストを 1 レベル下げます。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| remove |
リストから番号付けを削除します。 |
| remove |
リストから番号付けを削除します。 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
isSingleList
ListFormat オブジェクトに 1 つのリストが含まれているかどうかを示します。
readonly isSingleList: boolean;プロパティ値
boolean
注釈
isSingleListTemplate
ListFormat オブジェクトに単一のリスト テンプレートが含まれているかどうかを示します。
readonly isSingleListTemplate: boolean;プロパティ値
boolean
注釈
list
ListFormat オブジェクトに含まれる最初の書式付きリストを表す List オブジェクトを返します。
readonly list: Word.List;プロパティ値
注釈
listLevelNumber
ListFormat オブジェクトの最初の段落のリスト レベル番号を指定します。
listLevelNumber: number;プロパティ値
number
注釈
listString
ListFormat オブジェクトの範囲内の最初の段落のリスト値の文字列表現を取得します。
readonly listString: string;プロパティ値
string
注釈
listTemplate
ListFormat オブジェクトに関連付けられている一覧テンプレートを取得します。
readonly listTemplate: Word.ListTemplate;プロパティ値
注釈
listType
ListFormat オブジェクトのリストの型を取得します。
readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet";プロパティ値
Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"
注釈
listValue
ListFormat オブジェクトの範囲内の最初の段落の数値を取得します。
readonly listValue: number;プロパティ値
number
注釈
メソッドの詳細
applyBulletDefault(defaultListBehavior)
範囲内の段落に箇条書きと書式を追加します。
applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void;パラメーター
- defaultListBehavior
- Word.DefaultListBehavior
省略可能。 リストの既定の動作を指定します。 既定値は word97 です。
返品
void
注釈
applyBulletDefault(defaultListBehavior)
範囲内の段落に箇条書きと書式を追加します。
applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;パラメーター
- defaultListBehavior
-
"Word97" | "Word2000" | "Word2002"
省略可能。 リストの既定の動作を指定します。 既定値は word97 です。
返品
void
注釈
applyListTemplateWithLevel(listTemplate, options)
範囲内の段落に特定のレベルのリスト テンプレートを適用します。
applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void;パラメーター
- listTemplate
- Word.ListTemplate
適用するリスト テンプレート。
- options
- Word.ListTemplateApplyOptions
省略可能。 リスト テンプレートを適用するためのオプション (前のリストを継続するかどうか、リストのどの部分にテンプレートを適用するかなど)。
返品
void
注釈
applyNumberDefault(defaultListBehavior)
範囲内の段落に段落番号と書式を追加します。
applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;パラメーター
- defaultListBehavior
- Word.DefaultListBehavior
省略可能。 リストの既定の動作を指定します。
返品
void
注釈
applyNumberDefault(defaultListBehavior)
範囲内の段落に段落番号と書式を追加します。
applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;パラメーター
- defaultListBehavior
-
"Word97" | "Word2000" | "Word2002"
省略可能。 リストの既定の動作を指定します。
返品
void
注釈
applyOutlineNumberDefault(defaultListBehavior)
範囲内の段落にアウトライン番号付けと書式設定を追加します。
applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;パラメーター
- defaultListBehavior
- Word.DefaultListBehavior
省略可能。 リストの既定の動作を指定します。
返品
void
注釈
applyOutlineNumberDefault(defaultListBehavior)
範囲内の段落にアウトライン番号付けと書式設定を追加します。
applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;パラメーター
- defaultListBehavior
-
"Word97" | "Word2000" | "Word2002"
省略可能。 リストの既定の動作を指定します。
返品
void
注釈
canContinuePreviousList(listTemplate)
ListFormat オブジェクトが前のリストを続行できるかどうかを決定します。
canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult<Word.Continue>;パラメーター
- listTemplate
- Word.ListTemplate
チェックするリスト テンプレート。
返品
継続が可能かどうかを示す Continue 値。
注釈
convertNumbersToText(numberType)
リスト内の数値をプレーン テキストに変換します。
convertNumbersToText(numberType: Word.NumberType): void;パラメーター
- numberType
- Word.NumberType
省略可能。 変換する数値の種類。
返品
void
注釈
convertNumbersToText(numberType)
リスト内の数値をプレーン テキストに変換します。
convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;パラメーター
- numberType
-
"Paragraph" | "ListNum" | "AllNumbers"
省略可能。 変換する数値の種類。
返品
void
注釈
countNumberedItems(options)
一覧内の番号付き項目をカウントします。
countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;パラメーター
省略可能。 番号の種類やカウントするレベルなど、番号付き項目をカウントするためのオプション。
返品
OfficeExtension.ClientResult<number>
項目数。
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/format-list-range.yaml
// Counts all numbered items across every level using numberType: AllNumbers.
await Word.run(async (context) => {
const bodyRange: Word.Range = context.document.body.getRange();
const listFormat: Word.ListFormat = bodyRange.listFormat;
const options: Word.ListFormatCountNumberedItemsOptions = {
numberType: Word.NumberType.allNumbers,
};
const count: OfficeExtension.ClientResult<number> = listFormat.countNumberedItems(options);
await context.sync();
console.log(`Total numbered items (all levels): ${count.value}`);
});
listIndent()
listOutdent()
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.ListFormat;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.ListFormat;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
removeNumbers(numberType)
リストから番号付けを削除します。
removeNumbers(numberType: Word.NumberType): void;パラメーター
- numberType
- Word.NumberType
省略可能。 削除する番号の種類。
返品
void
注釈
removeNumbers(numberType)
リストから番号付けを削除します。
removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;パラメーター
- numberType
-
"Paragraph" | "ListNum" | "AllNumbers"
省略可能。 削除する番号の種類。
返品
void
注釈
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.ListFormatUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.ListFormat): void;パラメーター
- properties
- Word.ListFormat
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.ListFormat オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.ListFormatData と型指定) を返します。
toJSON(): Word.Interfaces.ListFormatData;返品
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.ListFormat;返品
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。
untrack(): Word.ListFormat;