Share via


PowerPoint.TextRange class

図形に結合するテキストや、テキストを操作するためのプロパティおよびメソッドが含まれます。

Extends

注釈

[ API セット: PowerPointApi 1.4 ]

プロパティ

context

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

font

テキスト範囲の ShapeFont フォント属性を表す オブジェクトを返します。

paragraphFormat

テキスト範囲の段落形式を表します。 詳細については、「 PowerPoint.ParagraphFormat 」を参照してください。

text

テキスト範囲のプレーン テキスト コンテンツを表します。

メソッド

getSubstring(start, length)

指定された範囲内の TextRange 部分文字列の オブジェクトを返します。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

font

テキスト範囲の ShapeFont フォント属性を表す オブジェクトを返します。

readonly font: PowerPoint.ShapeFont;

プロパティ値

注釈

[ API セット: PowerPointApi 1.4 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml

// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
  const textRange = context.presentation.getSelectedTextRange();
  textRange.font.color = "green";
  await context.sync();
});

paragraphFormat

テキスト範囲の段落形式を表します。 詳細については、「 PowerPoint.ParagraphFormat 」を参照してください。

readonly paragraphFormat: PowerPoint.ParagraphFormat;

プロパティ値

注釈

[ API セット: PowerPointApi 1.4 ]

text

テキスト範囲のプレーン テキスト コンテンツを表します。

text: string;

プロパティ値

string

注釈

[ API セット: PowerPointApi 1.4 ]

メソッドの詳細

getSubstring(start, length)

指定された範囲内の TextRange 部分文字列の オブジェクトを返します。

getSubstring(start: number, length?: number): PowerPoint.TextRange;

パラメーター

start

number

テキスト範囲から取得する最初の文字の 0 から始まるインデックス。

length

number

オプション。 新しいテキスト範囲で返される文字数。 length を省略すると、テキスト範囲の最後の段落の先頭から末尾までのすべての文字が返されます。

戻り値

注釈

[ API セット: PowerPointApi 1.4 ]

load(options)

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

load(options?: PowerPoint.Interfaces.TextRangeLoadOptions): PowerPoint.TextRange;

パラメーター

options
PowerPoint.Interfaces.TextRangeLoadOptions

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

戻り値

load(propertyNames)

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

load(propertyNames?: string | string[]): PowerPoint.TextRange;

パラメーター

propertyNames

string | string[]

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

戻り値

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.TextRange;

パラメーター

propertyNamesAndPaths

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

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

戻り値

toJSON()

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

toJSON(): PowerPoint.Interfaces.TextRangeData;

戻り値