Class DocumentTab

지정된 Position에 Bookmark를 추가합니다.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the tab body and adds a paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = documentTab.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = documentTab.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

매개변수

리턴

Bookmark: 새 북마크입니다.

승인

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

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

탭 바닥글 섹션이 없는 경우 추가합니다.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Adds a footer to the tab.
const footer = documentTab.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

리턴

FooterSection: 탭 바닥글입니다.

승인

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

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

탭 헤더 섹션이 없는 경우 추가합니다.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Adds a header to the tab.
const header = documentTab.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

리턴

HeaderSection: 탭 헤더입니다.

승인

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

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

나중에 검색하는 데 사용할 이름과 ID가 있는 Range인 NamedRange를 추가합니다. 이름은 탭 간에 고유하지 않아도 됩니다. HTML의 클래스와 마찬가지로 동일한 문서의 여러 범위가 동일한 이름을 공유할 수 있습니다. 반면 ID는 HTML의 ID와 같이 문서 내에서 고유합니다. NamedRange를 추가한 후에는 수정할 수 없으며 삭제만 할 수 있습니다.

탭에 액세스하는 모든 스크립트는 NamedRange에 액세스할 수 있습니다. 스크립트 간에 의도치 않은 충돌을 방지하려면 범위 이름 앞에 고유한 문자열을 접두사로 지정하는 것이 좋습니다.

// Creates a named range that includes every table in a tab by its ID.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('Tab t.0 tables', rangeBuilder.build());

매개변수

리턴

NamedRange: NamedRange입니다.

승인

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

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

탭의 Body를 검색합니다.

탭에는 다양한 유형의 섹션 (예: HeaderSection, FooterSection)이 포함될 수 있습니다. 탭의 활성 섹션은 Body입니다.

DocumentTab의 요소 메서드는 Body에 위임합니다.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the tab body.
const body = documentTab.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

리턴

Body: 탭의 본문 섹션입니다.

승인

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

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

지정된 ID의 Bookmark를 가져옵니다. 이 탭에 이러한 Bookmark가 없으면 이 메서드는 null를 반환합니다.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the bookmark by its ID.
const bookmark = documentTab.getBookmark('id.xyz654321');

// If the bookmark exists within the tab, logs the character offset of its
// position to the console. Otherwise, logs 'No bookmark exists with the given
// ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

매개변수

리턴

Bookmark: 지정된 ID의 Bookmark 또는 탭 내에 이러한 Bookmark가 없는 경우 null입니다.

승인

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

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

탭의 모든 Bookmark 객체를 가져옵니다.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets all of the bookmarks in the tab.
const bookmarks = documentTab.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

리턴

Bookmark[]: 탭의 Bookmark 객체 배열입니다.

승인

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

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

탭의 바닥글 섹션을 가져옵니다(있는 경우).

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the text of the tab's footer and logs it to the console.
console.log(documentTab.getFooter().getText());

리턴

FooterSection: 탭의 바닥글입니다.

승인

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

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

탭 본문의 모든 Footnote 요소를 검색합니다.

getFootnotes를 호출하면 탭의 요소가 반복됩니다. 탭이 큰 경우 이 메서드를 불필요하게 호출하지 마세요.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the first footnote.
const footnote = documentTab.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

리턴

Footnote[]: 탭의 각주입니다.

승인

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

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

탭의 헤더 섹션을 검색합니다(있는 경우).

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the text of the tab's header and logs it to the console.
console.log(documentTab.getHeader().getText());

리턴

HeaderSection: 탭의 헤더입니다.

승인

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

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

지정된 ID의 NamedRange를 가져옵니다. 탭에 이러한 NamedRange가 없으면 이 메서드는 null를 반환합니다. 이름은 탭 간에 고유하지 않아도 됩니다. HTML의 클래스와 마찬가지로 동일한 문서의 여러 범위가 동일한 이름을 공유할 수 있습니다. 반면 ID는 HTML의 ID와 같이 탭 내에서 고유합니다.

매개변수

리턴

NamedRange: 지정된 ID의 NamedRange 또는 탭에 이러한 범위가 없는 경우 null입니다.

승인

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

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

탭의 모든 NamedRange 객체를 가져옵니다.

NamedRange는 탭에 액세스하는 모든 스크립트에서 액세스할 수 있습니다. 스크립트 간에 의도치 않은 충돌을 방지하려면 범위 이름 앞에 고유한 문자열을 접두사로 지정하는 것이 좋습니다.

리턴

NamedRange[]: 탭의 NamedRange 객체 배열로, 이름이 같은 여러 범위가 포함될 수 있습니다.

승인

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

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

지정된 이름의 탭에 있는 모든 NamedRange 객체를 가져옵니다. 이름은 탭 간에 고유하지 않아도 됩니다. HTML의 클래스와 마찬가지로 동일한 문서의 여러 범위가 동일한 이름을 공유할 수 있습니다. 반면 ID는 HTML의 ID와 같이 탭 내에서 고유합니다.

NamedRange는 탭에 액세스하는 모든 스크립트에서 액세스할 수 있습니다. 스크립트 간에 의도치 않은 충돌을 방지하려면 범위 이름 앞에 고유한 문자열을 접두사로 지정하는 것이 좋습니다.

매개변수

리턴

NamedRange[]: 지정된 이름의 탭에 있는 NamedRange 객체 배열입니다.

승인

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

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

특정 요소를 기준으로 탭의 위치를 참조하는 새 Position를 만듭니다. 사용자의 커서는 다른 용도 중에서도 Position로 표시됩니다.

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
// TODO(developer): Replace the IDs with your own.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

매개변수

리턴

Position: 새 Position입니다.

승인

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

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

탭 요소에서 Range 객체를 구성하는 데 사용되는 빌더를 만듭니다.

// Change the user's selection to a range that includes every table in the tab.
// TODO(developer): Replace the IDs with your own.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

리턴

RangeBuilder: 새 빌더입니다.

승인

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

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