このページは Cloud Translation API によって翻訳されました。

Class Position

特定の要素を基準としたドキュメントタブ内の位置への参照。ユーザーのカーソルは、Position として表されます。スクリプトは、スクリプトを実行しているユーザーのカーソルにのみアクセスできます。ただし、スクリプトがドキュメントにバインドされている場合に限られます。

// Insert some text at the cursor position and make it bold.
const cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns
  // null, the cursor's containing element doesn't allow insertions, so show the
  // user an error message.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

メソッド

メソッド	戻り値の型	概要
`getElement()`	`Element`	この `Position` を含む要素を取得します。
`getOffset()`	`Integer`	この `Position` を含む要素内の相対位置を取得します。
`getSurroundingText()`	`Text`	`Position` を含む `Paragraph` または `ListItem` のテキストとフォーマットを表す人工的な `Text` 要素を作成します。これは、直接または子要素の連鎖を介して作成できます。
`getSurroundingTextOffset()`	`Integer`	`getSurroundingText()` によって返された `Text` 要素内のこの `Position` のオフセットを取得します。
`insertBookmark()`	`Bookmark`	この `Position` に新しい `Bookmark` を作成して挿入します。
`insertInlineImage(image)`	`InlineImage`	指定されたイメージ blob からこの `Position` に新しい `InlineImage` を作成して挿入します。
`insertText(text)`	`Text`	この `Position` に指定したテキストを挿入します。

詳細なドキュメント

`getElement()`

この Position を含む要素を取得します。これは、Text 要素または Paragraph などのコンテナ要素のいずれかです。どちらの場合も、要素内の相対位置は getOffset() で特定できます。

戻る

Element - この Position オブジェクトが配置されているコンテナまたは Text 要素

`getOffset()`

この Position を含む要素内の相対位置を取得します。要素が Text 要素の場合、オフセットは Position の前の文字数（つまり、この Position の後の文字のインデックス）です。他の要素の場合、オフセットは同じコンテナ要素内のこの Position の前の子要素の数（つまり、Position の後の子要素のインデックス）です。

戻る

Integer - Text 要素の場合は、この Position の前の文字数。他の要素の場合は、同じコンテナ要素内のこの Position の前の子要素の数

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getSurroundingText()`

Position を含む Paragraph または ListItem のテキストとフォーマットを表す人工的な Text 要素を作成します。これは、直接作成することも、子要素の連鎖を介して作成することもできます。返された Text 要素内の Position のオフセットを特定するには、getSurroundingTextOffset() を使用します。

戻る

Text - Position を含む Paragraph または ListItem で editAsText() を直接呼び出すか、子要素のチェーン経由で呼び出した結果と同等の要素

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getSurroundingTextOffset()`

getSurroundingText() によって返された Text 要素内のこの Position のオフセットを取得します。オフセットは、Position の前の文字数（つまり、この Position の後の文字のインデックス）です。

戻る

Integer - Position を含む Paragraph または ListItem で、この Position の前の文字数（直接、または子要素の連鎖を介して）

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertBookmark()`

この Position に新しい Bookmark を作成して挿入します。

戻る

Bookmark - 新しいブックマーク

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertInlineImage(image)`

指定されたイメージ blob からこの Position に新しい InlineImage を作成して挿入します。

パラメータ

名前	型	説明
`image`	`BlobSource`	この `Position` に挿入する画像データ

戻る

InlineImage - 新しい画像要素。この Position が配置されている要素で画像の挿入が許可されていない場合は null

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertText(text)`

この Position に指定したテキストを挿入します。このメソッドは、文字列が既存の Text 要素内に挿入されている場合でも、新しい Text 要素を作成するため、新しい要素のスタイルを簡単に設定できます。

パラメータ

名前	型	説明
`text`	`String`	この `Position` に挿入する文字列

戻る

Text - 新しいテキスト要素。この Position が配置されている要素でテキストの挿入が許可されていない場合は null

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents