Class Paragraph

Akapit

Element reprezentujący akapit. Paragraph może zawierać elementy Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak i Text. Więcej informacji o strukturze dokumentów znajdziesz w przewodniku na temat rozszerzania Dokumentów Google.

Pole Paragraphs nie może zawierać znaków nowego wiersza. Znaki nowego wiersza („\n”) są konwertowane na znaki podziału wiersza („\"”).

var body = DocumentApp.getActiveDocument().getBody();

// Append a document header paragraph.
var header = body.appendParagraph("A Document");
header.setHeading(DocumentApp.ParagraphHeading.HEADING1);

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

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

Metody

MetodaZwracany typKrótki opis
addPositionedImage(image)PositionedImageTworzy i wstawia nowy obiekt PositionedImage z podanego obiektu blob obrazu.
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendInlineImage(image)InlineImageTworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu.
appendInlineImage(image)InlineImageDołącza podany argument InlineImage.
appendPageBreak()PageBreakTworzy i dołącza nowy element PageBreak.
appendPageBreak(pageBreak)PageBreakDołącza podany argument PageBreak.
appendText(text)TextTworzy i dołącza nowy element Text o podanej zawartości.
appendText(text)TextDodaje podany element Text.
clear()ParagraphUsuwa zawartość elementu.
copy()ParagraphZwraca odłączoną głęboką kopię bieżącego elementu.
editAsText()TextUzyskuje wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu dla elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu dla elementu podrzędnego określonego typu, począwszy od podanego RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu w przypadku określonego wzorca tekstowego przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu w określonym wzorcu tekstowym, zaczynając od określonego wyniku wyszukiwania.
getAlignment()HorizontalAlignmentPobiera HorizontalAlignment.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny wybranego elementu podrzędnego.
getHeading()ParagraphHeadingPobiera ParagraphHeading.
getIndentEnd()NumberPobiera wcięcia końcowe (w punktach).
getIndentFirstLine()NumberPobiera wcięcia pierwszego wiersza w punktach.
getIndentStart()NumberPobiera wcięcie początkowe.
getLineSpacing()NumberPobiera odstępy między wierszami w punktach.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera następny element równorzędny.
getNumChildren()IntegerPobiera liczbę elementów podrzędnych.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPositionedImage(id)PositionedImagePobiera PositionedImage na podstawie identyfikatora obrazu.
getPositionedImages()PositionedImage[]Pobiera wszystkie obiekty PositionedImage zakotwiczone do akapitu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getSpacingAfter()NumberPobiera odstępy po elemencie w punktach.
getSpacingBefore()NumberPobiera odstępy przed elementem w punktach.
getText()StringPobiera zawartość elementu w postaci ciągu tekstowego.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera element ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia wartość HorizontalRule w określonym indeksie.
insertInlineImage(childIndex, image)InlineImageTworzy i wstawia nowy obiekt InlineImage z określonego obiektu blob obrazu w określonym indeksie.
insertInlineImage(childIndex, image)InlineImageWstawia podaną wartość InlineImage w określonym indeksie.
insertPageBreak(childIndex)PageBreakTworzy i wstawia nowy element PageBreak w określonym indeksie.
insertPageBreak(childIndex, pageBreak)PageBreakWstawia podaną wartość PageBreak w określonym indeksie.
insertText(childIndex, text)TextTworzy i wstawia nowy element tekstowy w określonym indeksie.
insertText(childIndex, text)TextWstawia podany element Text w określonym indeksie z określoną zawartością.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu elementu Document.
isLeftToRight()BooleanPobiera ustawienie od lewej do prawej.
merge()ParagraphScala element z poprzednim elementem równorzędnym.
removeChild(child)ParagraphUsuwa określony element podrzędny.
removeFromParent()ParagraphUsuwa element z jego elementu nadrzędnego.
removePositionedImage(id)BooleanUsuwa PositionedImage na podstawie identyfikatora obrazu.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym przy użyciu wyrażeń regularnych.
setAlignment(alignment)ParagraphUstawia HorizontalAlignment.
setAttributes(attributes)ParagraphUstawia atrybuty elementu.
setHeading(heading)ParagraphUstawia ParagraphHeading.
setIndentEnd(indentEnd)ParagraphUstawia wcięcie na końcu w punktach.
setIndentFirstLine(indentFirstLine)ParagraphUstawia wcięcie pierwszego wiersza w punktach.
setIndentStart(indentStart)ParagraphUstawia wcięcie początkowe w punktach.
setLeftToRight(leftToRight)ParagraphUstawia ustawienie tekstu od lewej do prawej.
setLineSpacing(multiplier)ParagraphUstawia odstępy między wierszami, czyli liczbę określającą liczbę wierszy, które mają być użyte dla odstępów.
setLinkUrl(url)ParagraphUstawia adres URL linku.
setSpacingAfter(spacingAfter)ParagraphUstawia odstępy po elemencie w punktach.
setSpacingBefore(spacingBefore)ParagraphUstawia odstępy przed elementem w punktach.
setText(text)voidUstawia treść akapitu.
setTextAlignment(textAlignment)ParagraphUstawia wyrównanie tekstu.

Szczegółowa dokumentacja

addPositionedImage(image)

Tworzy i wstawia nowy obiekt PositionedImage z podanego obiektu blob obrazu.

// 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('abc123456');

// Gets the document body.
const body = doc.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 document, anchored to the first paragraph.
paragraph.addPositionedImage(image);

Parametry

NazwaTypOpis
imageBlobSourceDane obrazu.

Powrót

PositionedImage – nowe pozycjonowane zdjęcie.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

appendHorizontalRule()

Tworzy i dołącza nowy element 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('abc123456');

// Gets the document body.
const body = doc.getBody();

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

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

Powrót

HorizontalRule – nowa reguła pozioma.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

appendInlineImage(image)

Tworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu.

// 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('abc123456');

// Gets the document body.
const body = doc.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);

Parametry

NazwaTypOpis
imageBlobSourceDane obrazu.

Powrót

InlineImage – załączony obraz.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

appendInlineImage(image)

Dołącza podany argument 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('abc123456');

// Gets the document body.
const body = doc.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);

Parametry

NazwaTypOpis
imageInlineImageDane obrazu.

Powrót

InlineImage – załączony obraz.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

appendPageBreak()

Tworzy i dołącza nowy element PageBreak.

Uwaga: PageBreaks nie może być częścią elementu TableCells. Jeśli bieżący element znajduje się w komórce tabeli, zostanie zgłoszony wyjątek.

// 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('abc123456');

// Gets the document body.
const body = doc.getBody();

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

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

Powrót

PageBreak – nowy element podziału strony.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

appendPageBreak(pageBreak)

Dołącza podany argument PageBreak.

Uwaga: pole PageBreaks nie może się znajdować w elemencie TableCells. Jeśli bieżący element występuje w komórce tabeli, skrypt zgłasza wyjątek.

// 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('abc123456');

// Gets the document body.
const body = doc.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);

Parametry

NazwaTypOpis
pageBreakPageBreakPodział strony do dołączenia.

Powrót

PageBreak – dołączony element podziału strony.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

appendText(text)

Tworzy i dołącza nowy element Text o podanej zawartości.

// 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('abc123456');

// Gets the document body.
const body = doc.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.');

Parametry

NazwaTypOpis
textStringZawartość tekstowa.

Powrót

Text – nowy element tekstowy.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

appendText(text)

Dodaje podany element 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('abc123456');

// Gets the document body.
const body = doc.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);

Parametry

NazwaTypOpis
textTextElement tekstowy do dołączenia.

Powrót

Text – dołączony element tekstowy.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

clear()

Usuwa zawartość elementu.

Powrót

Paragraph – bieżący element


copy()

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

Wszystkie elementy podrzędne zawarte w elemencie też są kopiowane. Nowy element nie ma elementu nadrzędnego.

Powrót

Paragraph – nowa kopia.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

editAsText()

Uzyskuje wersję Text bieżącego elementu do edycji.

Aby manipulować treścią elementów jako tekstem sformatowanym, użyj editAsText. Tryb editAsText ignoruje elementy inne niż tekstowe (np. InlineImage i HorizontalRule).

Elementy podrzędne w całości zawartego w usuniętym zakresie tekstowym są usuwane z elementu.

var body = DocumentApp.getActiveDocument().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);

Powrót

Text – wersja tekstowa bieżącego elementu.


findElement(elementType)

Przeszukuje zawartość elementu dla elementu podrzędnego określonego typu.

Parametry

NazwaTypOpis
elementTypeElementTypetyp elementu do wyszukania

Powrót

RangeElement – wynik wyszukiwania wskazujący pozycję elementu wyszukiwania,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

findElement(elementType, from)

Przeszukuje zawartość elementu dla elementu podrzędnego określonego typu, począwszy od podanego RangeElement.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Parametry

NazwaTypOpis
elementTypeElementTypetyp elementu do wyszukania
fromRangeElementwynik wyszukiwania z

Powrót

RangeElement – wynik wyszukiwania wskazujący następną pozycję elementu wyszukiwania,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

findText(searchPattern)

Przeszukuje zawartość elementu w przypadku określonego wzorca tekstowego przy użyciu wyrażeń regularnych.

Niektóre funkcje wyrażeń regularnych w języku JavaScript, np. grupy przechwytywania i modyfikatory trybu, nie są w pełni obsługiwane.

Podany wzorzec wyrażenia regularnego jest indywidualnie dopasowywany do każdego bloku tekstu zawartego w bieżącym elemencie.

Parametry

NazwaTypOpis
searchPatternStringwzorzec wyszukiwania

Powrót

RangeElement – wynik wyszukiwania wskazujący pozycję wyszukiwanego tekstu lub wartość null w przypadku braku dopasowania.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

findText(searchPattern, from)

Przeszukuje zawartość elementu w określonym wzorcu tekstowym, zaczynając od określonego wyniku wyszukiwania.

Niektóre funkcje wyrażeń regularnych w języku JavaScript, np. grupy przechwytywania i modyfikatory trybu, nie są w pełni obsługiwane.

Podany wzorzec wyrażenia regularnego jest indywidualnie dopasowywany do każdego bloku tekstu zawartego w bieżącym elemencie.

Parametry

NazwaTypOpis
searchPatternStringwzorzec wyszukiwania
fromRangeElementwynik wyszukiwania z

Powrót

RangeElement – wynik wyszukiwania wskazujący następną pozycję wyszukiwanego tekstu lub wartość null w przypadku braku dopasowania;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getAlignment()

Pobiera 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('abc123456');

// Gets the document body.
const body = doc.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());

Powrót

HorizontalAlignment – wyrównanie.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego 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, w którym każda nazwa właściwości odpowiada elementowi na liście DocumentApp.Attribute.

var body = DocumentApp.getActiveDocument().getBody();

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

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

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

Powrót

Object – atrybuty elementu

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getChild(childIndex)

Pobiera element podrzędny z określonego indeksu podrzędnego.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var 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.");
}

Parametry

NazwaTypOpis
childIndexIntegerindeks elementu podrzędnego do pobrania

Powrót

Element – element podrzędny w określonym indeksie,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getChildIndex(child)

Pobiera indeks podrzędny wybranego elementu podrzędnego.

Parametry

NazwaTypOpis
childElementelement podrzędny, dla którego pobierany jest indeks

Powrót

Integer – indeks podrzędny

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getHeading()

Pobiera 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('abc123456');

// Gets the document body.
const body = doc.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());

Powrót

ParagraphHeading – nagłówek.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getIndentEnd()

Pobiera wcięcia końcowe (w punktach).

Powrót

Number – wcięcie końcowe w punktach

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getIndentFirstLine()

Pobiera wcięcia pierwszego wiersza w punktach.

Powrót

Number – wcięcie pierwszego wiersza w punktach,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getIndentStart()

Pobiera wcięcie początkowe.

Powrót

Number – wcięcie początkowe

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getLineSpacing()

Pobiera odstępy między wierszami w punktach.

Powrót

Number – odstępy między wierszami w punktach,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getLinkUrl()

Pobiera adres URL linku.

Powrót

String – adres URL linku lub wartość null, jeśli element zawiera wiele wartości tego atrybutu,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego 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 podrzędny ma ten sam element nadrzędny i występuje w bieżącym elemencie.

Powrót

Element – kolejny element równorzędny.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getNumChildren()

Pobiera liczbę elementów podrzędnych.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

Powrót

Integer – liczba dzieci

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getParent()

Pobiera element nadrzędny elementu.

Element nadrzędny zawiera bieżący element.

Powrót

ContainerElement – element nadrzędny;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getPositionedImage(id)

Pobiera PositionedImage na podstawie identyfikatora obrazu.

Parametry

NazwaTypOpis
idStringIdentyfikator obrazu

Powrót

PositionedImage – pozycjonowany obraz,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getPositionedImages()

Pobiera wszystkie obiekty PositionedImage zakotwiczone do akapitu.

Powrót

PositionedImage[] – lista obrazów

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getPreviousSibling()

Pobiera poprzedni element równorzędny elementu.

Poprzedni element równorzędny ma ten sam element nadrzędny i poprzedza bieżący element.

Powrót

Element – poprzedni element równorzędny

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getSpacingAfter()

Pobiera odstępy po elemencie w punktach.

Powrót

Number – odstęp po elemencie wyrażony w punktach.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getSpacingBefore()

Pobiera odstępy przed elementem w punktach.

Powrót

Number – odstęp przed elementem, w punktach.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getText()

Pobiera zawartość elementu w postaci ciągu tekstowego.

Powrót

String – zawartość elementu w postaci ciągu tekstowego.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getTextAlignment()

Pobiera wyrównanie tekstu. Dostępne typy wyrównania to DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT i DocumentApp.TextAlignment.SUPERSCRIPT.

Powrót

TextAlignment – typ wyrównania tekstu lub null, jeśli tekst zawiera wiele typów dopasowania tekstu lub jeśli wyrównanie tekstu nigdy nie było ustawione

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

getType()

Pobiera element ElementType elementu.

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

var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document body.

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

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

insertHorizontalRule(childIndex)

Tworzy i wstawia wartość HorizontalRule w określonym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element

Powrót

HorizontalRule – nowy element reguł w poziomie

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

insertInlineImage(childIndex, image)

Tworzy i wstawia nowy obiekt InlineImage z określonego obiektu blob obrazu w określonym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element
imageBlobSourcedane obrazu

Powrót

InlineImage – wstawiony element wbudowanego obrazu

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

insertInlineImage(childIndex, image)

Wstawia podaną wartość InlineImage w określonym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element
imageInlineImagedane obrazu

Powrót

InlineImage – wstawiony element wbudowanego obrazu

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

insertPageBreak(childIndex)

Tworzy i wstawia nowy element PageBreak w określonym indeksie.

Uwaga: PageBreaks nie może być częścią elementu TableCells. Jeśli bieżący element znajduje się w komórce tabeli, zostanie zgłoszony wyjątek.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element

Powrót

PageBreak – nowy element podziału strony

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

insertPageBreak(childIndex, pageBreak)

Wstawia podaną wartość PageBreak w określonym indeksie.

Uwaga: PageBreaks nie może być częścią elementu TableCells. Jeśli bieżący element znajduje się w komórce tabeli, zostanie zgłoszony wyjątek.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element
pageBreakPageBreakPodział wiekowy, który ma zostać wstawiony

Powrót

PageBreak – wstawiony element podziału strony

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

insertText(childIndex, text)

Tworzy i wstawia nowy element tekstowy w określonym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element
textStringtreść

Powrót

Text – nowy element tekstowy

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

insertText(childIndex, text)

Wstawia podany element Text w określonym indeksie z określoną zawartością.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element
textTextelement tekstowy, który ma zostać wstawiony

Powrót

Text – wstawiony element tekstowy

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego 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 elementu Document.

Powrót

Boolean – określa, czy element znajduje się na końcu dokumentu;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

isLeftToRight()

Pobiera ustawienie od lewej do prawej.

Powrót

Boolean – ustawienie od lewej do prawej

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

merge()

Scala element z poprzednim elementem równorzędnym.

Łączyć można tylko elementy z tego samego elementu ElementType. Wszelkie elementy podrzędne zawarte w bieżącym elemencie są przenoszone do poprzedniego elementu równorzędnego.

Bieżący element zostanie usunięty z dokumentu.

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var 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.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

Powrót

Paragraph – scalony element,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

removeChild(child)

Usuwa określony element podrzędny.

Parametry

NazwaTypOpis
childElementelement podrzędny do usunięcia

Powrót

Paragraph – bieżący element

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

removeFromParent()

Usuwa element z jego elementu nadrzędnego.

var body = DocumentApp.getActiveDocument().getBody();

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Powrót

Paragraph – usunięty element;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

removePositionedImage(id)

Usuwa PositionedImage na podstawie identyfikatora obrazu.

Parametry

NazwaTypOpis
idStringIdentyfikator obrazu

Powrót

Boolean – określa, czy określone zdjęcie zostało usunięte;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

replaceText(searchPattern, replacement)

Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym przy użyciu wyrażeń regularnych.

Wzorzec wyszukiwania jest przekazywany jako ciąg znaków, a nie obiekt wyrażenia regularnego JavaScript. Z tego względu musisz unikać w kodzie wzorca ukośnika lewego.

Ta metoda korzysta z opracowanej przez Google biblioteki wyrażeń regularnych RE2, która ogranicza obsługiwaną składnię.

Podany wzorzec wyrażenia regularnego jest indywidualnie dopasowywany do każdego bloku tekstu zawartego w bieżącym elemencie.

var body = DocumentApp.getActiveDocument().getBody();

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

Parametry

NazwaTypOpis
searchPatternStringwzorzec wyrażenia regularnego do wyszukania
replacementStringtekst, który ma być zastąpiony

Powrót

Element – bieżący element

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setAlignment(alignment)

Ustawia HorizontalAlignment.

Parametry

NazwaTypOpis
alignmentHorizontalAlignmentwyrównanie w poziomie

Powrót

Paragraph – bieżący element

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setAttributes(attributes)

Ustawia atrybuty elementu.

Podany parametr atrybutów musi być obiektem, w którym każda nazwa właściwości jest elementem w wyliczeniach DocumentApp.Attribute, a każda wartość właściwości jest nową wartością do zastosowania.

var body = DocumentApp.getActiveDocument().getBody();

// Define a custom paragraph style.
var 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.
var par = body.appendParagraph('A paragraph with custom style.');

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

Parametry

NazwaTypOpis
attributesObjectAtrybuty elementu.

Powrót

Paragraph – bieżący element;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setHeading(heading)

Ustawia ParagraphHeading.

Parametry

NazwaTypOpis
headingParagraphHeadingnagłówek

Powrót

Paragraph – bieżący element

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setIndentEnd(indentEnd)

Ustawia wcięcie na końcu w punktach.

Parametry

NazwaTypOpis
indentEndNumberna końcu wcięcia

Powrót

Paragraph – bieżący element

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setIndentFirstLine(indentFirstLine)

Ustawia wcięcie pierwszego wiersza w punktach.

Parametry

NazwaTypOpis
indentFirstLineNumberwcięcie pierwszego wiersza w punktach

Powrót

Paragraph – bieżący element

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setIndentStart(indentStart)

Ustawia wcięcie początkowe w punktach.

Parametry

NazwaTypOpis
indentStartNumberz wcięciem początkowym

Powrót

Paragraph – bieżący element

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setLeftToRight(leftToRight)

Ustawia ustawienie tekstu od lewej do prawej.

Parametry

NazwaTypOpis
leftToRightBooleanustawienie tekstu od lewej do prawej

Powrót

Paragraph – bieżący element

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setLineSpacing(multiplier)

Ustawia odstępy między wierszami, czyli liczbę określającą liczbę wierszy, które mają być użyte dla odstępów.

Parametry

NazwaTypOpis
multiplierNumberliczbę linii

Powrót

Paragraph – bieżący element

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setLinkUrl(url)

Ustawia adres URL linku.

Parametry

NazwaTypOpis
urlStringadres URL linku

Powrót

Paragraph – bieżący element

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setSpacingAfter(spacingAfter)

Ustawia odstępy po elemencie w punktach.

Parametry

NazwaTypOpis
spacingAfterNumberodstępy po elemencie w punktach

Powrót

Paragraph – bieżący element

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setSpacingBefore(spacingBefore)

Ustawia odstępy przed elementem w punktach.

Parametry

NazwaTypOpis
spacingBeforeNumberodstępy przed elementem w punktach

Powrót

Paragraph – bieżący element

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setText(text)

Ustawia treść akapitu.

Uwaga: istniejąca zawartość zostanie wyczyszczona.

Parametry

NazwaTypOpis
textStringnowa zawartość tekstowa

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setTextAlignment(textAlignment)

Ustawia wyrównanie tekstu. Dostępne typy wyrównania to DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT i DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parametry

NazwaTypOpis
textAlignmentTextAlignmenttyp dopasowania tekstu do zastosowania

Powrót

Paragraph – bieżący element

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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