Word JavaScript API 1.5 の新機能
WordApi 1.5 では、脚注、文末脚注、コンテンツ コントロール イベント、スタイル管理のサポートが追加されました。
API リスト
次の表に、Word JavaScript API 要件セット 1.5 の API を示します。 JavaScript API 要件セット 1.5 以前Wordサポートされているすべての API の API リファレンス ドキュメントを表示するには、要件セット 1.5 以前の API のWordに関するページを参照してください。
クラス | フィールド | 説明 |
---|---|---|
Application | retrieveStylesFromBase64(base64File: string) | テンプレート Base64 ファイルからスタイルを解析し、取得したスタイルの JSON 形式を文字列として返します。 |
Body | 文末 | 本文の文末脚注のコレクションを取得します。 |
脚注 | 本文の脚注のコレクションを取得します。 | |
getContentControls(options?: Word。ContentControlOptions) | 本文で現在サポートされているコンテンツ コントロールを取得します。 | |
ContentControl | 文末 | コンテンツ コントロール内の文末脚注のコレクションを取得します。 |
脚注 | コンテンツ コントロール内の脚注のコレクションを取得します。 | |
getContentControls(options?: Word。ContentControlOptions) | このコンテンツ コントロールで現在サポートされている子コンテンツ コントロールを取得します。 | |
onDataChanged | コンテンツ コントロール内のデータが変更されたときに発生します。 | |
onDeleted | コンテンツ コントロールが削除されたときに発生します。 | |
onEntered | コンテンツ コントロールが入力されたときに発生します。 | |
onExited | コンテンツ コントロールが終了すると、たとえば、カーソルがコンテンツ コントロールから離れたときに発生します。 | |
onSelectionChanged | コンテンツ コントロール内の選択が変更されたときに発生します。 | |
ContentControlAddedEventArgs | eventType | イベントの種類。 |
Id | コンテンツ コントロール ID を取得します。 | |
source | イベントのソース。 | |
ContentControlCollection | getByChangeTrackingStates(changeTrackingStates: Word。ChangeTrackingState[]) | 指定した追跡状態のコンテンツ コントロールを取得します。 |
ContentControlDataChangedEventArgs | eventType | イベントの種類。 |
Id | コンテンツ コントロール ID を取得します。 | |
source | イベントのソース。 | |
ContentControlDeletedEventArgs | eventType | イベントの種類。 |
Id | コンテンツ コントロール ID を取得します。 | |
source | イベントのソース。 | |
ContentControlEnteredEventArgs | eventType | イベントの種類。 |
Id | コンテンツ コントロール ID を取得します。 | |
source | イベントのソース。 | |
ContentControlExitedEventArgs | eventType | イベントの種類。 |
Id | コンテンツ コントロール ID を取得します。 | |
source | イベントのソース。 | |
ContentControlOptions | types | コンテンツ コントロールの種類の配列である item は、'RichText' または 'PlainText' である必要があります。 |
ContentControlSelectionChangedEventArgs | eventType | イベントの種類。 |
Id | コンテンツ コントロール ID を取得します。 | |
source | イベントのソース。 | |
ドキュメント | addStyle(name: string, type: Word.StyleType) | 名前と種類によってスタイルをドキュメントに追加します。 |
close(closeBehavior?: Word。CloseBehavior) | 現在のドキュメントを閉じます。 | |
getContentControls(options?: Word。ContentControlOptions) | ドキュメントで現在サポートされているコンテンツ コントロールを取得します。 | |
getEndnoteBody() | 文書の文末脚注を 1 つの本文で取得します。 | |
getFootnoteBody() | 文書の脚注を 1 つの本文で取得します。 | |
getStyles() | ドキュメントのスタイル セット全体を表す StyleCollection オブジェクトを取得します。 | |
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace |Word。InsertLocation.start |Word。InsertLocation.end |"Replace" |"Start" |"End"、insertFileOptions?: Word。InsertFileOptions) | 追加のプロパティを使用して、特定の場所にあるターゲット ドキュメントにドキュメントを挿入します。 | |
onContentControlAdded | コンテンツ コントロールが追加されたときに発生します。 | |
save(saveBehavior?: Word。SaveBehavior,fileName?: string) | ドキュメントを保存します。 | |
Field | code | フィールドのコード命令を指定します。 |
data | "Addin" フィールドにデータを指定します。 | |
delete() | フィールドを削除します。 | |
kind | フィールドの種類を取得します。 | |
locked | フィールドがロックされているかどうかを指定します。 | |
select(selectionMode?: Word。SelectionMode) | フィールドを選択します。 | |
type | フィールドの型を取得します。 | |
updateResult() | フィールドを更新します。 | |
FieldCollection | getByTypes(types: Word。FieldType[]) | 指定した種類のフィールドを含む Field オブジェクト コレクションを取得します。 |
InsertFileOptions | importChangeTrackingMode | ソース ドキュメントからの変更追跡モードの状態をインポートするかどうかを表します。 |
importPageColor | ソース ドキュメントのページの色やその他の背景情報をインポートするかどうかを表します。 | |
importParagraphSpacing | ソース ドキュメントの段落間隔をインポートするかどうかを表します。 | |
importStyles | ソース ドキュメントのスタイルをインポートするかどうかを表します。 | |
importTheme | ソース ドキュメントのテーマをインポートするかどうかを表します。 | |
NoteItem | body | メモ項目の body オブジェクトを表します。 |
delete() | メモ項目を削除します。 | |
getNext() | 同じ型の次のメモ項目を取得します。 | |
getNextOrNullObject() | 同じ型の次のメモ項目を取得します。 | |
reference | メイン ドキュメントの脚注または文末脚注の参照を表します。 | |
type | 脚注または文末脚注の種類を表します。 | |
NoteItemCollection | getFirst() | このコレクション内の最初のメモ項目を取得します。 |
getFirstOrNullObject() | このコレクション内の最初のメモ項目を取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
Paragraph | 文末 | 段落内の文末脚注のコレクションを取得します。 |
脚注 | 段落内の脚注のコレクションを取得します。 | |
getContentControls(options?: Word。ContentControlOptions) | 段落で現在サポートされているコンテンツ コントロールを取得します。 | |
ParagraphFormat | 配置 | 指定した段落の配置を指定します。 |
firstLineIndent | 1 行目またはぶら下げインデントの値をポイント単位で指定します。 | |
Keeptogether | Microsoft Wordがドキュメントを再調整するときに、指定した段落のすべての行が同じページに残るかどうかを指定します。 | |
keepWithNext | 指定した段落が、Microsoft Wordがドキュメントを改ページしたときにその段落の後に続く段落と同じページに残るかどうかを指定します。 | |
leftIndent | 左インデントを指定します。 | |
lineSpacing | 指定した段落の行間をポイント単位で指定します。 | |
lineUnitAfter | 指定した段落の後の間隔 (目盛線) の量を指定します。 | |
lineUnitBefore | 指定した段落の前の間隔 (目盛線) の量を指定します。 | |
mirrorIndents | 左インデントと右インデントが同じ幅かどうかを指定します。 | |
outlineLevel | 指定した段落のアウトライン レベルを指定します。 | |
rightIndent | 指定した段落の右インデント (ポイント単位) を指定します。 | |
spaceAfter | 指定した段落またはテキスト列の後の間隔の量をポイント単位で指定します。 | |
spaceBefore | 指定した段落の前の間隔 (ポイント単位) を指定します。 | |
widowControl | 指定した段落の最初と最後の行が、Microsoft Wordドキュメントの修正時に段落の残りの部分と同じページに残るかどうかを指定します。 | |
Range | 文末 | 範囲内の文末脚注のコレクションを取得します。 |
脚注 | 範囲内の脚注のコレクションを取得します。 | |
getContentControls(options?: Word。ContentControlOptions) | 範囲内で現在サポートされているコンテンツ コントロールを取得します。 | |
insertEndnote(insertText?: string) | 文末脚注を挿入します。 | |
insertField(insertLocation: Word。InsertLocation |"Replace" |"Start" |"End" |"Before" |"After",fieldType?: Word。FieldType、text?: string、removeFormatting?: boolean) | 指定した場所にフィールドを挿入します。 | |
insertFootnote(insertText?: string) | 脚注を挿入します。 | |
スタイル | baseStyle | 別のスタイルの基本書式として使用する既存のスタイルの名前を取得します。 |
組み込み | 指定したスタイルが組み込みスタイルであるかどうかを取得します。 | |
delete() | スタイルを削除します。 | |
font | 指定したスタイルの文字書式を表すフォント オブジェクトを取得します。 | |
inUse | 指定したスタイルが、ドキュメント内で変更または適用された組み込みスタイルであるか、ドキュメント内に作成された新しいスタイルであるかを取得します。 | |
リンク | スタイルが、段落と文字の書式設定の両方に使用できるリンクされたスタイルであるかどうかを取得します。 | |
nameLocal | ユーザーの言語でスタイルの名前を取得します。 | |
nextParagraphStyle | 指定したスタイルで書式設定された段落の後に挿入される新しい段落に自動的に適用されるスタイルの名前を取得します。 | |
paragraphFormat | 指定したスタイルの段落設定を表す ParagraphFormat オブジェクトを取得します。 | |
優先 順位 | 優先順位を指定します。 | |
quickStyle | スタイルが使用可能なクイック スタイルに対応するかどうかを指定します。 | |
type | スタイルの種類を取得します。 | |
unhideWhenUsed | 指定したスタイルを文書で使用した後、[スタイル] および Microsoft Wordの [スタイル] 作業ウィンドウで推奨スタイルとして表示するかどうかを指定します。 | |
可視 性 | [スタイル] ギャラリーと [スタイル] 作業ウィンドウで、指定したスタイルを推奨スタイルとして表示するかどうかを指定します。 | |
StyleCollection | getByName(name: string) | スタイル オブジェクトの名前を取得します。 |
getByNameOrNullObject(name: string) | 対応するスタイルが存在しない場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObject true 返します。 |
|
getCount() | コレクション内のスタイルの数を取得します。 | |
getItem(index: number) | コレクション内のインデックスによってスタイル オブジェクトを取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
表 | 文末 | テーブル内の文末脚注のコレクションを取得します。 |
脚注 | テーブル内の脚注のコレクションを取得します。 | |
TableRow | 文末 | テーブル行の文末脚注のコレクションを取得します。 |
脚注 | テーブル行の脚注のコレクションを取得します。 |
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins