Word.CommentContentRange class

  • リファレンス
パッケージ:
word
Extends
OfficeExtension.ClientObject

注釈

[ API セット: WordApi 1.4 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
  const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
  comment.load("contentRange");
  const range: Word.Range = comment.getRange();
  range.load("text");
  await context.sync();

  if (comment.isNullObject) {
    console.warn("No comments in the selection, so no range to get.");
    return;
  }

  console.log(`Comment location: ${range.text}`);
  const contentRange: Word.CommentContentRange = comment.contentRange;
  console.log("Comment content range:", contentRange);
});

プロパティ

bold

コメント テキストが太字かどうかを示す値を指定します。
context

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

範囲内の最初のハイパーリンクを取得するか、または範囲にハイパーリンクを設定します。 範囲に新しいハイパーリンクを設定すると、範囲内のすべてのハイパーリンクが削除されます。
isEmpty

範囲の長さが 0 であるかどうかを確認します。
italic

コメント テキストが斜体かどうかを示す値を指定します。
strikeThrough

コメント テキストに取り消し線があるかどうかを示す値を指定します。
text

コメント範囲のテキストを取得します。
underline

コメント テキストの下線の種類を示す値を指定します。 コメント テキストに下線が付いていない場合は 、'None' です。

メソッド

insertText(text, insertLocation)

指定した場所にテキストを挿入します。 注: モダン コメントの場合、コンテキスト全体で追跡されるコンテンツ範囲は、コメントのリビジョンが UI を介して投稿された場合は空になります。
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 メソッドを呼び出します)。元の Word.CommentContentRange オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.CommentContentRangeData として型指定) を返します。
track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。

プロパティの詳細

bold

コメント テキストが太字かどうかを示す値を指定します。

bold: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.4 ]

context

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

context: RequestContext;

プロパティ値

Word.RequestContext

範囲内の最初のハイパーリンクを取得するか、または範囲にハイパーリンクを設定します。 範囲に新しいハイパーリンクを設定すると、範囲内のすべてのハイパーリンクが削除されます。

hyperlink: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.4 ]

isEmpty

範囲の長さが 0 であるかどうかを確認します。

readonly isEmpty: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.4 ]

italic

コメント テキストが斜体かどうかを示す値を指定します。

italic: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.4 ]

strikeThrough

コメント テキストに取り消し線があるかどうかを示す値を指定します。

strikeThrough: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.4 ]

text

コメント範囲のテキストを取得します。

readonly text: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.4 ]

underline

コメント テキストの下線の種類を示す値を指定します。 コメント テキストに下線が付いていない場合は 、'None' です。

underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";

プロパティ値

Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"

注釈

[ API セット: WordApi 1.4 ]

メソッドの詳細

insertText(text, insertLocation)

指定した場所にテキストを挿入します。 注: モダン コメントの場合、コンテキスト全体で追跡されるコンテンツ範囲は、コメントのリビジョンが UI を介して投稿された場合は空になります。

insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange;

パラメーター

text

string

必須です。 CommentContentRange に挿入するテキスト。

insertLocation

Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

必須。 値は、'Replace'、'Start'、'End'、'Before'、または 'After' である必要があります。

戻り値

Word.CommentContentRange

注釈

[ API セット: WordApi 1.4 ]

load(options)

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

load(options?: Word.Interfaces.CommentContentRangeLoadOptions): Word.CommentContentRange;

パラメーター

options
Word.Interfaces.CommentContentRangeLoadOptions

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

戻り値

Word.CommentContentRange

load(propertyNames)

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

load(propertyNames?: string | string[]): Word.CommentContentRange;

パラメーター

propertyNames

string | string[]

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

戻り値

Word.CommentContentRange

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.CommentContentRange;

パラメーター

propertyNamesAndPaths

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

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

戻り値

Word.CommentContentRange

set(properties, options)

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

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

パラメーター

properties
Word.Interfaces.CommentContentRangeUpdateData

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

options
OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Word.CommentContentRange): void;

パラメーター

properties
Word.CommentContentRange

戻り値

void

toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Word.CommentContentRange オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.CommentContentRangeData として型指定) を返します。

toJSON(): Word.Interfaces.CommentContentRangeData;

戻り値

Word.Interfaces.CommentContentRangeData

track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.CommentContentRange;

戻り値

Word.CommentContentRange

untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。

untrack(): Word.CommentContentRange;

戻り値

Word.CommentContentRange