Class Paragraph

단락

단락을 나타내는 요소입니다. Paragraph에는 Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak, Text 요소가 포함될 수 있습니다. 문서 구조에 관한 자세한 내용은 Google Docs 확장 가이드를 참고하세요.

Paragraphs에는 줄바꿈 문자가 포함될 수 없습니다. 줄바꿈 문자 ('\n')는 줄바꿈 문자 ('\r')로 변환됩니다. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a tab header paragraph.
const header = body.appendParagraph('A Document');
header.setHeading(DocumentApp.ParagraphHeading.HEADING1);

// Append a section header paragraph.
const section = body.appendParagraph('Section 1');
section.setHeading(DocumentApp.ParagraphHeading.HEADING2);

// Append a regular paragraph.
body.appendParagraph('This is a typical paragraph.');

메서드

메서드반환 유형간략한 설명
addPositionedImage(image)PositionedImage지정된 이미지 블롭에서 새 PositionedImage를 만들고 삽입합니다.
appendHorizontalRule()HorizontalRule새 HorizontalRule를 만들고 추가합니다.
appendInlineImage(image)InlineImage지정된 이미지 블롭에서 새 InlineImage를 만들고 추가합니다.
appendInlineImage(image)InlineImage지정된 InlineImage를 추가합니다.
appendPageBreak()PageBreak새 PageBreak를 만들고 추가합니다.
appendPageBreak(pageBreak)PageBreak지정된 PageBreak를 추가합니다.
appendText(text)Text지정된 콘텐츠가 포함된 새 Text 요소를 만들고 추가합니다.
appendText(text)Text지정된 Text 요소를 추가합니다.
clear()Paragraph요소의 콘텐츠를 지웁니다.
copy()Paragraph현재 요소의 분리된 전체 사본을 반환합니다.
editAsText()Text수정할 현재 요소의 Text 버전을 가져옵니다.
findElement(elementType)RangeElement요소의 콘텐츠에서 지정된 유형의 하위 요소를 검색합니다.
findElement(elementType, from)RangeElement지정된 RangeElement에서 시작하여 지정된 유형의 하위 요소에 대한 요소의 콘텐츠를 검색합니다.
findText(searchPattern)RangeElement정규 표현식을 사용하여 요소의 콘텐츠에서 지정된 텍스트 패턴을 검색합니다.
findText(searchPattern, from)RangeElement지정된 검색 결과에서 시작하여 요소의 콘텐츠에서 지정된 텍스트 패턴을 검색합니다.
getAlignment()HorizontalAlignmentHorizontalAlignment를 검색합니다.
getAttributes()Object요소의 속성을 검색합니다.
getChild(childIndex)Element지정된 하위 색인의 하위 요소를 검색합니다.
getChildIndex(child)Integer지정된 하위 요소의 하위 색인을 검색합니다.
getHeading()ParagraphHeadingParagraphHeading를 검색합니다.
getIndentEnd()Number끝 들여쓰기를 포인트 단위로 검색합니다.
getIndentFirstLine()Number첫 번째 줄 들여쓰기를 포인트 단위로 검색합니다.
getIndentStart()Number시작 들여쓰기를 가져옵니다.
getLineSpacing()Number줄 간격(단위: 포인트)을 가져옵니다.
getLinkUrl()String링크 URL을 가져옵니다.
getNextSibling()Element요소의 다음 동료 요소를 검색합니다.
getNumChildren()Integer하위 요소 수를 가져옵니다.
getParent()ContainerElement요소의 상위 요소를 가져옵니다.
getPositionedImage(id)PositionedImage이미지 ID로 PositionedImage를 가져옵니다.
getPositionedImages()PositionedImage[]단락에 고정된 모든 PositionedImage 객체를 가져옵니다.
getPreviousSibling()Element요소의 이전 동료 요소를 검색합니다.
getSpacingAfter()Number요소 뒤의 간격을 포인트 단위로 가져옵니다.
getSpacingBefore()Number요소 앞의 간격을 포인트 단위로 가져옵니다.
getText()String요소의 콘텐츠를 텍스트 문자열로 검색합니다.
getTextAlignment()TextAlignment텍스트 정렬을 가져옵니다.
getType()ElementType요소의 ElementType를 검색합니다.
insertHorizontalRule(childIndex)HorizontalRule지정된 색인에 HorizontalRule를 만들고 삽입합니다.
insertInlineImage(childIndex, image)InlineImage지정된 이미지 블롭에서 새 InlineImage를 만들어 지정된 색인에 삽입합니다.
insertInlineImage(childIndex, image)InlineImage지정된 색인에 지정된 InlineImage를 삽입합니다.
insertPageBreak(childIndex)PageBreak지정된 색인에 새 PageBreak를 만들고 삽입합니다.
insertPageBreak(childIndex, pageBreak)PageBreak지정된 색인에 지정된 PageBreak를 삽입합니다.
insertText(childIndex, text)Text지정된 인덱스에 새 텍스트 요소를 만들고 삽입합니다.
insertText(childIndex, text)Text지정된 색인에 지정된 텍스트 콘텐츠와 함께 지정된 Text 요소를 삽입합니다.
isAtDocumentEnd()Boolean요소가 Document의 끝에 있는지 확인합니다.
isLeftToRight()Boolean왼쪽에서 오른쪽 설정을 가져옵니다.
merge()Paragraph요소를 동일한 유형의 앞쪽 형제 요소와 병합합니다.
removeChild(child)Paragraph지정된 하위 요소를 삭제합니다.
removeFromParent()Paragraph상위 요소에서 요소를 삭제합니다.
removePositionedImage(id)Boolean이미지 ID별로 PositionedImage를 삭제합니다.
replaceText(searchPattern, replacement)Element정규 표현식을 사용하여 지정된 텍스트 패턴이 발견된 모든 위치를 지정된 대체 문자열로 바꿉니다.
setAlignment(alignment)ParagraphHorizontalAlignment를 설정합니다.
setAttributes(attributes)Paragraph요소의 속성을 설정합니다.
setHeading(heading)ParagraphParagraphHeading를 설정합니다.
setIndentEnd(indentEnd)Paragraph끝 들여쓰기를 포인트 단위로 설정합니다.
setIndentFirstLine(indentFirstLine)Paragraph첫 줄 들여쓰기를 포인트 단위로 설정합니다.
setIndentStart(indentStart)Paragraph시작 들여쓰기를 포인트 단위로 설정합니다.
setLeftToRight(leftToRight)Paragraph왼쪽에서 오른쪽 설정을 설정합니다.
setLineSpacing(multiplier)Paragraph줄 간격을 줄 간격에 사용할 줄 수를 나타내는 수량으로 설정합니다.
setLinkUrl(url)Paragraph링크 URL을 설정합니다.
setSpacingAfter(spacingAfter)Paragraph요소 뒤의 간격을 포인트 단위로 설정합니다.
setSpacingBefore(spacingBefore)Paragraph요소 앞의 간격을 포인트 단위로 설정합니다.
setText(text)void단락의 콘텐츠를 텍스트로 설정합니다.
setTextAlignment(textAlignment)Paragraph텍스트 정렬을 설정합니다.

자세한 문서

addPositionedImage(image)

지정된 이미지 블롭에서 새 PositionedImage를 만들고 삽입합니다. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the specified image URL.
const image = UrlFetchApp.fetch(
    'https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-24dp/logo_apps_script_color_1x_web_24dp.png',
);

// Adds the image to the tab, anchored to the first paragraph.
paragraph.addPositionedImage(image);

매개변수

이름유형설명
imageBlobSource이미지 데이터입니다.

리턴

PositionedImage: 새롭게 배치된 이미지입니다.

승인

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

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

appendHorizontalRule()

새 HorizontalRule를 만들고 추가합니다. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a horizontal line under the first paragraph.
paragraph.appendHorizontalRule();

리턴

HorizontalRule: 새 가로줄입니다.

승인

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

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

appendInlineImage(image)

지정된 이미지 블롭에서 새 InlineImage를 만들고 추가합니다. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the image from the specified image URL.
const image = UrlFetchApp.fetch(
    'https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-96dp/logo_apps_script_color_1x_web_96dp.png',
);

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

매개변수

이름유형설명
imageBlobSource이미지 데이터입니다.

리턴

InlineImage: 추가된 이미지입니다.

승인

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

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

appendInlineImage(image)

지정된 InlineImage를 추가합니다. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Makes a copy of the first image in the body.
const image = body.getImages()[0].copy();

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

매개변수

이름유형설명
imageInlineImage이미지 데이터입니다.

리턴

InlineImage: 추가된 이미지입니다.

승인

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

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

appendPageBreak()

새 PageBreak를 만들고 추가합니다.

참고: PageBreaks는 TableCells 내에 포함되지 않을 수 있습니다. 현재 요소가 표 셀에 포함된 경우 예외가 발생합니다. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
paragraph.appendPageBreak();

리턴

PageBreak: 새 페이지 나누기 요소입니다.

승인

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

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

appendPageBreak(pageBreak)

지정된 PageBreak를 추가합니다.

참고: PageBreaks는 TableCells 내에 포함될 수 없습니다. 현재 요소가 테이블 셀에 있으면 스크립트에서 예외가 발생합니다. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
const pageBreak = paragraph.appendPageBreak();

// Makes a copy of the page break.
const newPageBreak = pageBreak.copy();

// Adds the copied page break to the paragraph.
paragraph.appendPageBreak(newPageBreak);

매개변수

이름유형설명
pageBreakPageBreak추가할 페이지 나누기입니다.

리턴

PageBreak: 추가된 페이지 나누기 요소입니다.

승인

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

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

appendText(text)

지정된 콘텐츠가 포함된 새 Text 요소를 만들고 추가합니다. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a string to the paragraph.
paragraph.appendText('This is a new sentence.');

매개변수

이름유형설명
textString텍스트 콘텐츠입니다.

리턴

Text: 새 텍스트 요소입니다.

승인

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

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

appendText(text)

지정된 Text 요소를 추가합니다. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the text from the first paragraph in the body.
const paragraph1 = body.getParagraphs()[0];
const text = paragraph1.getText();

// Gets the third paragraph in the body.
const paragraph3 = body.getParagraphs()[2];

// Adds the text from the first paragraph to the third paragraph.
paragraph3.appendText(text);

매개변수

이름유형설명
textText추가할 텍스트 요소입니다.

리턴

Text: 추가된 텍스트 요소입니다.

승인

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

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

clear()

요소의 콘텐츠를 지웁니다.

리턴

Paragraph: 현재 요소입니다.

copy()

현재 요소의 분리된 전체 사본을 반환합니다.

요소에 있는 모든 하위 요소도 복사됩니다. 새 요소에 상위 요소가 없습니다.

리턴

Paragraph: 새 사본입니다.

승인

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

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

editAsText()

수정할 현재 요소의 Text 버전을 가져옵니다.

editAsText를 사용하여 요소 콘텐츠를 서식 있는 텍스트로 조작합니다. editAsText 모드는 텍스트가 아닌 요소 (예: InlineImage 및 HorizontalRule)를 무시합니다.

삭제된 텍스트 범위 내에 완전히 포함된 하위 요소는 요소에서 삭제됩니다. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

리턴

Text: 현재 요소의 텍스트 버전

findElement(elementType)

요소의 콘텐츠에서 지정된 유형의 하위 요소를 검색합니다.

매개변수

이름유형설명
elementTypeElementType검색할 요소의 유형입니다.

리턴

RangeElement: 검색 요소의 위치를 나타내는 검색 결과입니다.

승인

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

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

findElement(elementType, from)

지정된 RangeElement에서 시작하여 지정된 유형의 하위 요소에 대한 요소의 콘텐츠를 검색합니다. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

매개변수

이름유형설명
elementTypeElementType검색할 요소의 유형입니다.
fromRangeElement검색할 검색 결과입니다.

리턴

RangeElement: 검색 요소의 다음 위치를 나타내는 검색 결과입니다.

승인

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

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

findText(searchPattern)

정규 표현식을 사용하여 요소의 콘텐츠에서 지정된 텍스트 패턴을 검색합니다.

캡처 그룹, 모드 수정자와 같은 JavaScript 정규 표현식 기능의 하위 집합은 완전히 지원되지 않습니다.

제공된 정규 표현식 패턴은 현재 요소에 포함된 각 텍스트 블록과 독립적으로 일치합니다.

매개변수

이름유형설명
searchPatternString검색할 패턴

리턴

RangeElement: 검색 텍스트의 위치를 나타내는 검색 결과 또는 일치 항목이 없는 경우 null

승인

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

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

findText(searchPattern, from)

지정된 검색 결과에서 시작하여 요소의 콘텐츠에서 지정된 텍스트 패턴을 검색합니다.

캡처 그룹, 모드 수정자와 같은 JavaScript 정규 표현식 기능의 하위 집합은 완전히 지원되지 않습니다.

제공된 정규 표현식 패턴은 현재 요소에 포함된 각 텍스트 블록과 독립적으로 일치합니다.

매개변수

이름유형설명
searchPatternString검색할 패턴
fromRangeElement검색할 검색 결과

리턴

RangeElement: 검색 텍스트의 다음 위치를 나타내는 검색 결과 또는 일치 항목이 없는 경우 null

승인

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

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

getAlignment()

HorizontalAlignment를 검색합니다. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Sets the horizontal alignment to left for the first paragraph.
paragraph.setAlignment(DocumentApp.HorizontalAlignment.LEFT);

// Gets the horizontal alignment of the first paragraph and logs it to the
// console.
console.log(paragraph.getAlignment().toString());

리턴

HorizontalAlignment - 정렬입니다.

승인

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

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

getAttributes()

요소의 속성을 검색합니다.

결과는 유효한 각 요소 속성에 관한 속성을 포함하는 객체이며 각 속성 이름은 DocumentApp.Attribute 열거형의 항목에 해당합니다. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

리턴

Object: 요소의 속성입니다.

승인

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

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

getChild(childIndex)

지정된 하위 색인의 하위 요소를 검색합니다. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

매개변수

이름유형설명
childIndexInteger검색할 하위 요소의 색인입니다.

리턴

Element: 지정된 색인의 하위 요소입니다.

승인

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

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

getChildIndex(child)

지정된 하위 요소의 하위 색인을 검색합니다.

매개변수

이름유형설명
childElement색인을 검색할 하위 요소입니다.

리턴

Integer: 하위 색인입니다.

승인

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

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

getHeading()

ParagraphHeading를 검색합니다. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Adds a paragraph to the body.
const paragraph = body.appendParagraph('Title heading');

// Sets the paragraph heading style to 'Title.'
paragraph.setHeading(DocumentApp.ParagraphHeading.TITLE);

// Gets the heading style and logs it to the console.
console.log(paragraph.getHeading().toString());

리턴

ParagraphHeading - 제목입니다.

승인

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

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

getIndentEnd()

끝 들여쓰기를 포인트 단위로 검색합니다.

리턴

Number: 끝 들여쓰기(단위: 포인트)

승인

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

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

getIndentFirstLine()

첫 번째 줄 들여쓰기를 포인트 단위로 검색합니다.

리턴

Number: 첫 줄 들여쓰기(단위: 포인트)

승인

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

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

getIndentStart()

시작 들여쓰기를 가져옵니다.

리턴

Number: 시작 들여쓰기

승인

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

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

getLineSpacing()

줄 간격(단위: 포인트)을 가져옵니다.

리턴

Number: 줄 간격(단위: 포인트)

승인

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

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

getLinkUrl()

링크 URL을 가져옵니다.

리턴

String: 링크 URL 또는 요소에 이 속성의 값이 여러 개 포함된 경우 null

승인

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

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

getNextSibling()

요소의 다음 동료 요소를 검색합니다.

다음 형제 요소는 동일한 상위 요소를 갖고 현재 요소 뒤에 나옵니다.

리턴

Element: 다음 동료 요소입니다.

승인

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

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

getNumChildren()

하위 요소 수를 가져옵니다. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

리턴

Integer - 하위 요소 수입니다.

승인

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

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

getParent()

요소의 상위 요소를 가져옵니다.

상위 요소에 현재 요소가 포함되어 있습니다.

리턴

ContainerElement: 상위 요소입니다.

승인

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

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

getPositionedImage(id)

이미지 ID로 PositionedImage를 가져옵니다.

매개변수

이름유형설명
idString이미지 ID

리턴

PositionedImage: 배치된 이미지

승인

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

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

getPositionedImages()

단락에 고정된 모든 PositionedImage 객체를 가져옵니다.

리턴

PositionedImage[]: 배치된 이미지 목록

승인

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

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

getPreviousSibling()

요소의 이전 동료 요소를 검색합니다.

이전 동료 요소는 상위 요소가 동일하며 현재 요소 앞에 있습니다.

리턴

Element: 이전 동료 요소입니다.

승인

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

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

getSpacingAfter()

요소 뒤의 간격을 포인트 단위로 가져옵니다.

리턴

Number: 요소 뒤의 간격(단위: 포인트)

승인

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

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

getSpacingBefore()

요소 앞의 간격을 포인트 단위로 가져옵니다.

리턴

Number: 요소 앞의 간격(단위: 포인트)

승인

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

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

getText()

요소의 콘텐츠를 텍스트 문자열로 검색합니다.

리턴

String: 요소의 콘텐츠(텍스트 문자열)

승인

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

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

getTextAlignment()

텍스트 정렬을 가져옵니다. 사용 가능한 정렬 유형은 DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, DocumentApp.TextAlignment.SUPERSCRIPT입니다.

리턴

TextAlignment: 텍스트 정렬 유형 또는 텍스트에 여러 유형의 텍스트 정렬이 포함되어 있거나 텍스트 정렬이 설정되지 않은 경우 null

승인

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

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

getType()

요소의 ElementType를 검색합니다.

getType()을 사용하여 특정 요소의 정확한 유형을 확인합니다. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

리턴

ElementType: 요소 유형입니다.

승인

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

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

insertHorizontalRule(childIndex)

지정된 색인에 HorizontalRule를 만들고 삽입합니다.

매개변수

이름유형설명
childIndexInteger요소를 삽입할 색인

리턴

HorizontalRule: 새 가로줄 요소

승인

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

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

insertInlineImage(childIndex, image)

지정된 이미지 블롭에서 새 InlineImage를 만들어 지정된 색인에 삽입합니다.

매개변수

이름유형설명
childIndexInteger요소를 삽입할 색인
imageBlobSource이미지 데이터

리턴

InlineImage: 삽입된 인라인 이미지 요소

승인

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

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

insertInlineImage(childIndex, image)

지정된 색인에 지정된 InlineImage를 삽입합니다.

매개변수

이름유형설명
childIndexInteger요소를 삽입할 색인
imageInlineImage이미지 데이터

리턴

InlineImage: 삽입된 인라인 이미지 요소

승인

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

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

insertPageBreak(childIndex)

지정된 색인에 새 PageBreak를 만들고 삽입합니다.

참고: PageBreaks는 TableCells 내에 포함되지 않을 수 있습니다. 현재 요소가 표 셀에 포함된 경우 예외가 발생합니다.

매개변수

이름유형설명
childIndexInteger요소를 삽입할 색인

리턴

PageBreak - 새 페이지 나누기 요소

승인

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

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

insertPageBreak(childIndex, pageBreak)

지정된 색인에 지정된 PageBreak를 삽입합니다.

참고: PageBreaks는 TableCells 내에 포함되지 않을 수 있습니다. 현재 요소가 표 셀에 포함된 경우 예외가 발생합니다.

매개변수

이름유형설명
childIndexInteger요소를 삽입할 색인
pageBreakPageBreak삽입할 페이지 나누기

리턴

PageBreak: 삽입된 페이지 나누기 요소

승인

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

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

insertText(childIndex, text)

지정된 인덱스에 새 텍스트 요소를 만들고 삽입합니다.

매개변수

이름유형설명
childIndexInteger요소를 삽입할 색인
textString텍스트 콘텐츠

리턴

Text: 새 텍스트 요소

승인

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

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

insertText(childIndex, text)

지정된 색인에 지정된 텍스트 콘텐츠와 함께 지정된 Text 요소를 삽입합니다.

매개변수

이름유형설명
childIndexInteger요소를 삽입할 색인
textText삽입할 텍스트 요소

리턴

Text: 삽입된 텍스트 요소

승인

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

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

isAtDocumentEnd()

요소가 Document의 끝에 있는지 확인합니다.

리턴

Boolean: 요소가 탭의 끝에 있는지 여부입니다.

승인

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

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

isLeftToRight()

왼쪽에서 오른쪽 설정을 가져옵니다.

리턴

Boolean: 왼쪽에서 오른쪽 설정

승인

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

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

merge()

요소를 동일한 유형의 앞쪽 형제 요소와 병합합니다.

동일한 ElementType의 요소만 병합할 수 있습니다. 현재 요소에 포함된 모든 하위 요소가 이전에 있는 상위 요소로 이동합니다.

현재 요소가 문서에서 삭제됩니다. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

리턴

Paragraph: 병합된 요소입니다.

승인

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

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

removeChild(child)

지정된 하위 요소를 삭제합니다.

매개변수

이름유형설명
childElement삭제할 하위 요소

리턴

Paragraph: 현재 요소

승인

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

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

removeFromParent()

상위 요소에서 요소를 삭제합니다. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

리턴

Paragraph: 삭제된 요소입니다.

승인

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

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

removePositionedImage(id)

이미지 ID별로 PositionedImage를 삭제합니다.

매개변수

이름유형설명
idString이미지 ID

리턴

Boolean: 지정된 이미지가 삭제되었는지 여부

승인

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

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

replaceText(searchPattern, replacement)

정규 표현식을 사용하여 지정된 텍스트 패턴이 발견된 모든 위치를 지정된 대체 문자열로 바꿉니다.

검색 패턴은 JavaScript 정규 표현식 객체가 아닌 문자열로 전달됩니다. 따라서 패턴에서 백슬래시를 이스케이프 처리해야 합니다.

이 메서드는 Google의 RE2 정규 표현식 라이브러리를 사용하므로 지원되는 문법이 제한됩니다.

제공된 정규 표현식 패턴은 현재 요소에 포함된 각 텍스트 블록과 독립적으로 일치합니다. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

매개변수

이름유형설명
searchPatternString검색할 정규식 패턴
replacementString대체할 텍스트

리턴

Element: 현재 요소

승인

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

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

setAlignment(alignment)

HorizontalAlignment를 설정합니다.

매개변수

이름유형설명
alignmentHorizontalAlignment가로 정렬

리턴

Paragraph: 현재 요소

승인

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

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

setAttributes(attributes)

요소의 속성을 설정합니다.

지정된 attributes 매개변수는 각 속성 이름이 DocumentApp.Attribute 열거형의 항목이고 각 속성 값이 적용할 새 값인 객체여야 합니다. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

매개변수

이름유형설명
attributesObject요소의 속성

리턴

Paragraph: 현재 요소입니다.

승인

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

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

setHeading(heading)

ParagraphHeading를 설정합니다.

매개변수

이름유형설명
headingParagraphHeading제목

리턴

Paragraph: 현재 요소

승인

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

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

setIndentEnd(indentEnd)

끝 들여쓰기를 포인트 단위로 설정합니다.

매개변수

이름유형설명
indentEndNumber끝 들여쓰기(단위: 포인트)

리턴

Paragraph: 현재 요소

승인

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

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

setIndentFirstLine(indentFirstLine)

첫 줄 들여쓰기를 포인트 단위로 설정합니다.

매개변수

이름유형설명
indentFirstLineNumber첫 줄 들여쓰기(단위: 포인트)

리턴

Paragraph: 현재 요소

승인

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

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

setIndentStart(indentStart)

시작 들여쓰기를 포인트 단위로 설정합니다.

매개변수

이름유형설명
indentStartNumber시작 들여쓰기(단위: 포인트)

리턴

Paragraph: 현재 요소

승인

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

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

setLeftToRight(leftToRight)

왼쪽에서 오른쪽 설정을 설정합니다.

매개변수

이름유형설명
leftToRightBoolean왼쪽에서 오른쪽 설정

리턴

Paragraph: 현재 요소

승인

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

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

setLineSpacing(multiplier)

줄 간격을 줄 간격에 사용할 줄 수를 나타내는 수량으로 설정합니다.

매개변수

이름유형설명
multiplierNumber선 수

리턴

Paragraph: 현재 요소

승인

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

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

setLinkUrl(url)

링크 URL을 설정합니다.

매개변수

이름유형설명
urlString링크 URL

리턴

Paragraph: 현재 요소

승인

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

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

setSpacingAfter(spacingAfter)

요소 뒤의 간격을 포인트 단위로 설정합니다.

매개변수

이름유형설명
spacingAfterNumber요소 뒤의 간격(단위: 포인트)

리턴

Paragraph: 현재 요소

승인

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

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

setSpacingBefore(spacingBefore)

요소 앞의 간격을 포인트 단위로 설정합니다.

매개변수

이름유형설명
spacingBeforeNumber요소 앞의 간격(단위: 포인트)

리턴

Paragraph: 현재 요소

승인

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

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

setText(text)

단락의 콘텐츠를 텍스트로 설정합니다.

참고: 기존 콘텐츠는 삭제됩니다.

매개변수

이름유형설명
textString새 텍스트 콘텐츠

승인

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

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

setTextAlignment(textAlignment)

텍스트 정렬을 설정합니다. 사용 가능한 정렬 유형은 DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, DocumentApp.TextAlignment.SUPERSCRIPT입니다. 

// Make the entire first paragraph in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

매개변수

이름유형설명
textAlignmentTextAlignment적용할 텍스트 정렬 유형

리턴

Paragraph: 현재 요소

승인

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

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