Class Position

위치

문서 탭에서 특정 요소와 관련된 위치의 참조입니다. 사용자의 커서 Position로 표현되는 등의 여러 가지 용도가 있습니다. 스크립트는 스크립트가 문서에 바인딩된 경우에만 사용할 수 있습니다. 

// Insert some text at the cursor position and make it bold.
var 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.
  var 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객체의 텍스트와 서식을 나타내는 인위적인 Text 요소를 만듭니다. 직접 또는 하위 요소 체인을 통해 Position가 포함된 Paragraph 또는 ListItem입니다.
getSurroundingTextOffset()IntegergetSurroundingText()에서 반환된 Text 요소 내에서 이 Position의 오프셋을 가져옵니다.
insertBookmark()Bookmark이 Position에 새 Bookmark를 만들고 삽입합니다.
insertInlineImage(image)InlineImage지정된 이미지에서 이 Position에 새 InlineImage를 만들고 삽입합니다. blob을 참조하세요.
insertText(text)Text이 Position에 지정된 텍스트를 삽입합니다.

자세한 문서

getElement()

이 Position가 포함된 요소를 가져옵니다. Text입니다. 요소 또는 컨테이너 요소(예: Paragraph)가 포함될 수 있습니다. 두 경우 모두 상대적 요소 내 위치는 getOffset()로 결정할 수 있습니다.

리턴

Element: 이 Position 객체가 있는 컨테이너 또는 Text 요소

getOffset()

이 Position가 포함된 요소 내에서 상대 위치를 가져옵니다. 만약 요소가 Text 요소인 경우 오프셋은 Position 앞의 문자 수 (즉, 이 Position 뒤의 문자 색인)입니다. 기타 요소의 경우 오프셋은 Position 동일한 컨테이너 요소 (즉, Position 뒤에 오는 하위 요소의 색인)

리턴

Integer: Text 요소의 경우 이 Position 이전의 문자 수입니다. 대상: 다른 요소, 동일한 내 이 Position 이전의 하위 요소 수 컨테이너 요소

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.

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

getSurroundingText()

객체의 텍스트와 서식을 나타내는 인위적인 Text 요소를 만듭니다. 직접 또는 하위 요소 체인을 통해 Position가 포함된 Paragraph 또는 ListItem입니다. 반환된 Text 요소에서 Position의 오프셋을 확인하려면 getSurroundingTextOffset()를 사용합니다.

리턴

Text: editAsText() 호출 결과와 동일한 요소 Position가 포함된 Paragraph 또는 ListItem에서 직접 또는 하위 요소 체인을 통해

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.

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

getSurroundingTextOffset()

getSurroundingText()에서 반환된 Text 요소 내에서 이 Position의 오프셋을 가져옵니다. 오프셋은 Position 앞의 문자 수입니다. 즉, 이 Position 뒤에 오는 문자의 색인입니다.

리턴

Integer: Position가 포함된 Paragraph 또는 ListItem에서 이 Position 앞에 있는 문자 수(직접 또는 하위 요소 체인을 통해)

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.

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

insertBookmark()

이 Position에 새 Bookmark를 만들고 삽입합니다.

리턴

Bookmark: 새 북마크

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.

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

insertInlineImage(image)

지정된 이미지에서 이 Position에 새 InlineImage를 만들고 삽입합니다. blob을 참조하세요.

매개변수

이름유형설명
imageBlobSource이 Position에 삽입할 이미지 데이터

리턴

InlineImage: 새 이미지 요소 또는 null(이 Position이 있는 요소인 경우) 위치가 있으면 이미지를 삽입할 수 없습니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.

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

insertText(text)

이 Position에 지정된 텍스트를 삽입합니다. 이 메서드는 새 Text를 만듭니다. 요소(문자열이 기존 Text 요소 내에 삽입되어도 새로운 요소의 스타일을 쉽게 지정할 수 있습니다.

매개변수

이름유형설명
textString이 Position에 삽입할 문자열입니다.

리턴

Text: 새 텍스트 요소 또는 null(이 Position이 있는 요소인 경우) 을(를) 사용하면 텍스트를 삽입할 수 없습니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.

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