Class Person

Person

Element reprezentujący link do osoby. Link do osoby odnosi się do adresu e-mail i opcjonalnie może mieć powiązaną z nim nazwę. Jeśli nazwa jest ustawiona, to ona jest wyświetlana w treści dokumentu.

Metody

MetodaZwracany typKrótki opis
copy()PersonZwraca odłączoną, głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getEmail()StringZwraca adres e-mail osoby.
getName()String|nullZwraca wyświetlaną nazwę osoby, jeśli jest ustawiona.
getNextSibling()Element|nullPobiera następny element równorzędny.
getParent()ContainerElement|nullPobiera element nadrzędny.
getPreviousSibling()Element|nullPobiera poprzedni element równorzędny.
getType()ElementTypePobiera ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()Person|nullScala element z poprzedzającym elementem równorzędnym tego samego typu.
removeFromParent()Person|nullUsuwa element z elementu nadrzędnego.
setAttributes(attributes)PersonUstawia atrybuty elementu.

Szczegółowa dokumentacja

copy()

Zwraca odłączoną, głęboką kopię bieżącego elementu.

Kopiowane są też wszystkie elementy podrzędne znajdujące się w elemencie. Nowy element nie ma elementu nadrzędnego.

Powrót

Person – nowa kopia.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

getAttributes()

Pobiera atrybuty elementu.

Wynikiem jest obiekt zawierający właściwość dla każdego prawidłowego atrybutu elementu, gdzie nazwa każdej właściwości odpowiada elementowi w wyliczeniu 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]}`);
}

Powrót

Object – atrybuty elementu.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

getEmail()

Zwraca adres e-mail osoby.

Powrót

String – adres e-mail osoby.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

getName()

Zwraca wyświetlaną nazwę osoby, jeśli jest ustawiona.

Powrót

String|null – wyświetlana nazwa linku do osoby lub null, jeśli element wyświetla adres e-mail zamiast tego.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

getNextSibling()

Pobiera następny element równorzędny.

Następny element równorzędny ma ten sam element nadrzędny i znajduje się za bieżącym elementem.

Powrót

Element|null – następny element równorzędny.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

getParent()

Pobiera element nadrzędny.

Element nadrzędny zawiera bieżący element.

Powrót

ContainerElement|null – element nadrzędny.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

getPreviousSibling()

Pobiera poprzedni element równorzędny.

Poprzedni element równorzędny ma ten sam element nadrzędny i znajduje się przed bieżącym elementem.

Powrót

Element|null – poprzedni element równorzędny.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

getType()

Pobiera ElementType elementu.

Użyj getType(), aby określić dokładny typ danego elementu. 

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.');
}

Powrót

ElementType – typ elementu.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

isAtDocumentEnd()

Określa, czy element znajduje się na końcu Document.

Powrót

Boolean – czy element znajduje się na końcu karty.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

merge()

Scala element z poprzedzającym elementem równorzędnym tego samego typu.

Można scalać tylko elementy tego samego ElementType. Wszystkie elementy podrzędne zawarte w bieżącym elemencie są przenoszone do poprzedzającego elementu równorzędnego.

Bieżący element jest usuwany z dokumentu. 

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

Powrót

Person|null – scalony element.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

removeFromParent()

Usuwa element z elementu nadrzędnego. 

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

Powrót

Person|null – usunięty element.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

setAttributes(attributes)

Ustawia atrybuty elementu.

Określony parametr atrybutów musi być obiektem, w którym nazwa każdej właściwości jest elementem w wyliczeniu DocumentApp.Attribute, a wartość każdej właściwości jest nową wartością, która ma zostać zastosowana. 

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);

Parametry

NazwaTypOpis
attributesObjectAtrybuty elementu.

Powrót

Person – bieżący element.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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