PowerPoint.TextRange class
図形に結合するテキストや、テキストを操作するためのプロパティおよびメソッドが含まれます。
- Extends
注釈
[ API セット: PowerPointApi 1.4 ]
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| font | テキスト範囲の |
| length | これが |
| paragraph |
テキスト範囲の段落形式を表します。 詳細については、「 PowerPoint.ParagraphFormat 」を参照してください。 |
| start | 親テキスト フレームを基準にして、これが |
| text | テキスト範囲のプレーン テキスト コンテンツを表します。 |
メソッド
| get |
この |
| get |
指定された範囲内の |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set |
現在のビューでこれを |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
プロパティの詳細
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();
});
length
これが TextRange 表す範囲の長さを取得または設定します。 負の InvalidArgument 値で設定した場合、または値が開始点から使用可能なテキストの長さより大きい場合は、例外をスローします。
length: number;プロパティ値
number
注釈
paragraphFormat
テキスト範囲の段落形式を表します。 詳細については、「 PowerPoint.ParagraphFormat 」を参照してください。
readonly paragraphFormat: PowerPoint.ParagraphFormat;プロパティ値
注釈
start
親テキスト フレームを基準にして、これが TextRange 表す範囲の開始位置の 0 から始まるインデックスを取得または設定します。 負の InvalidArgument 値を設定した場合、または値がテキストの長さより大きい場合は、例外をスローします。
start: number;プロパティ値
number
注釈
text
メソッドの詳細
getParentTextFrame()
この TextRangeを保持する親 PowerPoint.TextFrame オブジェクトを返します。
getParentTextFrame(): PowerPoint.TextFrame;戻り値
注釈
getSubstring(start, length)
指定された範囲内の TextRange 部分文字列の オブジェクトを返します。
getSubstring(start: number, length?: number): PowerPoint.TextRange;パラメーター
- start
-
number
テキスト範囲から取得する最初の文字の 0 から始まるインデックス。
- length
-
number
オプション。 新しいテキスト範囲で返される文字数。 length を省略すると、テキスト範囲の最後の段落の先頭から末尾までのすべての文字が返されます。
戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: PowerPoint.Interfaces.TextRangeLoadOptions): PowerPoint.TextRange;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
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 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
setSelected()
現在のビューでこれを TextRange 選択します。
setSelected(): void;戻り値
void
注釈
[ API セット: PowerPointApi 1.5 ]
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
// Selects the first 10 characters of the selected shape.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
await context.sync();
if (shapeCount.value !== 1) {
console.warn("You must select only one shape with text in it.");
return;
}
const shape = shapes.getItemAt(0);
const textFrame = shape.textFrame.load("textRange,hasText");
await context.sync();
if (textFrame.hasText != true) {
console.warn("You must select only one shape with text in it.");
return;
}
const textRange = textFrame.textRange;
textRange.load("text");
await context.sync();
if (textRange.text.length < 10) {
console.warn("You must select only one shape with at least 10 characters in it.");
return;
}
const textRange10 = textRange.getSubstring(0, 10);
textRange10.setSelected();
await context.sync();
});
...
// Sets the range selection to the range that was saved previously.
await PowerPoint.run(async (context) => {
const slide1 = context.presentation.slides.getItem(savedTextSlideSelection[0]);
const shape1 = slide1.shapes.getItem(savedTextShapeSelection[0]);
const textRange = shape1.textFrame.textRange.getSubstring(savedTextTextRangeStart, savedTextTextRangeLength);
textRange.setSelected();
await context.sync();
});
toJSON()
API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の PowerPoint.TextRange オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として PowerPoint.Interfaces.TextRangeData型指定) を返します。
toJSON(): PowerPoint.Interfaces.TextRangeData;戻り値
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示