Class HorizontalRule

HorizontalRule

가로 규칙을 나타내는 요소입니다. HorizontalRule은 ListItem 또는 Paragraph 내에 포함될 수 있지만 다른 요소를 포함할 수는 없습니다. 문서 구조에 대한 자세한 내용은 Google Docs 확장에 관한 가이드를 참고하세요.

메서드

메서드반환 유형간략한 설명
copy()HorizontalRule분리된 현재 요소의 전체 사본을 반환합니다.
getAttributes()Object요소의 속성을 가져옵니다.
getNextSibling()Element|null요소의 다음 동급 요소를 가져옵니다.
getParent()ContainerElement|null요소의 상위 요소를 가져옵니다.
getPreviousSibling()Element|null요소의 이전 동급 요소를 가져옵니다.
getType()ElementType요소의 ElementType를 가져옵니다.
isAtDocumentEnd()Boolean요소가 Document의 끝에 있는지 확인합니다.
removeFromParent()HorizontalRule|null상위 요소에서 요소를 삭제합니다.
setAttributes(attributes)HorizontalRule요소의 속성을 설정합니다.

자세한 문서

copy()

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

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

리턴

HorizontalRule — 새 사본입니다.

승인

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

  • 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

getNextSibling()

요소의 다음 동급 요소를 가져옵니다.

다음 동급 요소는 동일한 상위 요소를 가지며 현재 요소를 따릅니다.

리턴

Element|null — 다음 동급 요소입니다.

승인

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

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

getParent()

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

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

리턴

ContainerElement|null — 상위 요소입니다.

승인

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

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

getPreviousSibling()

요소의 이전 동급 요소를 가져옵니다.

이전 동급 요소는 동일한 상위 요소를 가지며 현재 요소 앞에 있습니다.

리턴

Element|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

isAtDocumentEnd()

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

리턴

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

승인

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

  • 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();
}

리턴

HorizontalRule|null — 삭제된 요소입니다.

승인

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

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

setAttributes(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요소의 속성입니다.

리턴

HorizontalRule — 현재 요소입니다.

승인

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

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