Class Text

טקסט

רכיב שמייצג אזור של טקסט עשיר. כל הטקסט ב-Document נמצא ברכיבי Text. רכיב Text יכול להופיע בתוך רכיב Equation,‏ EquationFunction,‏ ListItem או Paragraph, אבל הוא לא יכול להכיל רכיב אחר. למידע נוסף על מבנה המסמך, קראו את המדריך להרחבת Google Docs.

// Gets the body contents of the active tab.
const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Use editAsText to obtain a single text element containing
// all the characters in the tab.
const text = body.editAsText();

// Insert text at the beginning of the tab.
text.insertText(0, 'Inserted text.\n');

// Insert text at the end of the tab.
text.appendText('\nAppended text.');

// Make the first half of the tab blue.
text.setForegroundColor(0, text.getText().length / 2, '#00FFFF');

Methods

שיטהסוג הערך המוחזרתיאור קצר
appendText(text)Textהוספת הטקסט שצוין לסוף אזור הטקסט הזה.
copy()Textהפונקציה מחזירה עותק מנותק ומעמיק של הרכיב הנוכחי.
deleteText(startOffset, endOffsetInclusive)Textמחיקת טווח טקסט.
editAsText()Textהצגת גרסת Text של הרכיב הנוכחי לצורך עריכה.
findText(searchPattern)RangeElementחיפוש דפוס הטקסט שצוין בתוכן של האלמנט באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElementחיפוש של דפוס הטקסט שצוין בתוכן הרכיב, החל מתוצאת חיפוש נתונה.
getAttributes()Objectאחזור המאפיינים של האלמנט.
getAttributes(offset)Objectאחזור המאפיינים במרווח התווים שצוין.
getBackgroundColor()Stringאחזור ההגדרה של צבע הרקע.
getBackgroundColor(offset)Stringאחזור של צבע הרקע במרווח התווים שצוין.
getFontFamily()Stringאחזור ההגדרה של משפחת הגופנים.
getFontFamily(offset)Stringאחזור של משפחת הגופנים במרווח התווים שצוין.
getFontSize()Numberאחזור ההגדרה של גודל הגופן.
getFontSize(offset)Numberאחזור גודל הגופן במרווח התווים שצוין.
getForegroundColor()Stringאחזור ההגדרה של צבע החזית.
getForegroundColor(offset)Stringאחזור של צבע החזית במרווח התווים שצוין.
getLinkUrl()Stringאחזור כתובת ה-URL של הקישור.
getLinkUrl(offset)Stringהפונקציה מאחזרת את כתובת ה-URL של הקישור במרווח התווים שצוין.
getNextSibling()Elementאחזור הרכיב הבא של הרכיב.
getParent()ContainerElementאחזור של רכיב ההורה של האלמנט.
getPreviousSibling()Elementאחזור של רכיב האח הקודם של הרכיב.
getText()Stringאחזור התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignmentהפונקציה מקבלת את יישור הטקסט.
getTextAlignment(offset)TextAlignmentהפונקציה מקבלת את יישור הטקסט של תו יחיד.
getTextAttributeIndices()Integer[]הפונקציה מאחזרת את קבוצת אינדקסי הטקסט שתואמים לתחילת רצפי עיצוב טקסט נפרדים.
getType()ElementTypeאחזור הערך של ElementType ברכיב.
insertText(offset, text)Textהוספת הטקסט שצוין בהיסט התווים הנתון.
isAtDocumentEnd()Booleanהפונקציה קובעת אם הרכיב נמצא בסוף ה-Document.
isBold()Booleanאחזור ההגדרה של הגופן המודגש.
isBold(offset)Booleanאחזור ההגדרה של הגופן מודגש בהיסט התווים שצוין.
isItalic()Booleanאחזור ההגדרה של הגופן הנטוי.
isItalic(offset)Booleanאחזור ההגדרה של הגופן הנטוי בהיסט התווים שצוין.
isStrikethrough()Booleanאחזור ההגדרה של קו המחיקה.
isStrikethrough(offset)Booleanאחזור ההגדרה של קו המחיקה בהיסט התווים שצוין.
isUnderline()Booleanאחזור ההגדרה של קו התחתון.
isUnderline(offset)Booleanאחזור ההגדרה של קו תחתון בהיסט התווים שצוין.
merge()Textמיזוג הרכיב עם האח/ה הקודם/ה מאותו סוג.
removeFromParent()Textהסרת הרכיב מהרכיב ההורה שלו.
replaceText(searchPattern, replacement)Elementמחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים.
setAttributes(startOffset, endOffsetInclusive, attributes)Textמחילה את המאפיינים שצוינו על טווח התווים הנתון.
setAttributes(attributes)Textהגדרת המאפיינים של האלמנט.
setBackgroundColor(startOffset, endOffsetInclusive, color)Textהגדרת צבע הרקע של טווח התווים שצוין.
setBackgroundColor(color)Textהגדרת צבע הרקע.
setBold(bold)Textהגדרת העיצוב המודגש.
setBold(startOffset, endOffsetInclusive, bold)Textהגדרת הגופן מודגש לטווח התווים שצוין.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)Textהגדרת משפחת הגופנים לטווח התווים שצוין.
setFontFamily(fontFamilyName)Textהגדרת משפחת הגופנים.
setFontSize(startOffset, endOffsetInclusive, size)Textהגדרת גודל הגופן של טווח התווים שצוין.
setFontSize(size)Textהגדרת גודל הגופן.
setForegroundColor(startOffset, endOffsetInclusive, color)Textהגדרת צבע החזית של טווח התווים שצוין.
setForegroundColor(color)Textהגדרת צבע החזית.
setItalic(italic)Textהגדרת הגופן הנטוי.
setItalic(startOffset, endOffsetInclusive, italic)Textהגדרת הגופן הנטוי לטווח התווים שצוין.
setLinkUrl(startOffset, endOffsetInclusive, url)Textהגדרת כתובת ה-URL של הקישור לטווח התווים שצוין.
setLinkUrl(url)Textהגדרת כתובת ה-URL של הקישור.
setStrikethrough(strikethrough)Textהגדרת ההגדרה של קו המחיקה.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)Textהגדרת ההגדרה של קו חוצה לטווח התווים שצוין.
setText(text)Textהגדרת תוכן הטקסט.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)Textהגדרת היישור של הטקסט בטווח תווים נתון.
setTextAlignment(textAlignment)Textהגדרת יישור הטקסט.
setUnderline(underline)Textהגדרת ההגדרה של קו תחתון.
setUnderline(startOffset, endOffsetInclusive, underline)Textהגדרת ההגדרה של קו תחתון לטווח התווים שצוין.

מסמכים מפורטים

appendText(text)

הוספת הטקסט שצוין לסוף אזור הטקסט הזה.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// 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 the text, 'Sample body text,' to the end of the tab body.
const text = body.editAsText().appendText('Sample body text');

פרמטרים

שםסוגתיאור
textStringהטקסט שרוצים לצרף.

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

copy()

הפונקציה מחזירה עותק מנותק ומעמיק של הרכיב הנוכחי.

כל אלמנטי הצאצא שנמצאים באלמנט יועתקו גם כן. לאלמנט החדש אין הורה.

חזרה

Text – העותק החדש.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

deleteText(startOffset, endOffsetInclusive)

מחיקת טווח טקסט.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Deletes the first 10 characters in the body.
const text = body.editAsText().deleteText(0, 9);

פרמטרים

שםסוגתיאור
startOffsetIntegerהזזת התווים של התו הראשון למחיקה.
endOffsetInclusiveIntegerהזזת התו של התו האחרון למחיקה.

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • 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 — גרסה טקסטואלית של הרכיב הנוכחי


findText(searchPattern)

חיפוש דפוס הטקסט שצוין בתוכן של האלמנט באמצעות ביטויים רגולריים.

אין תמיכה מלאה בקבוצת משנה של תכונות הביטויים הרגולריים של JavaScript, כמו קבוצות תיעוד (capture groups) ומשתני שינוי מצב (mode modifiers).

תבנית הביטוי הרגולרי שצוינה מותאמת בנפרד לכל בלוק טקסט שמכיל את הרכיב הנוכחי.

פרמטרים

שםסוגתיאור
searchPatternStringהדפוס שרוצים לחפש

חזרה

RangeElement – תוצאת חיפוש שמציינת את המיקום של טקסט החיפוש, או null אם אין התאמה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

findText(searchPattern, from)

חיפוש של דפוס הטקסט שצוין בתוכן הרכיב, החל מתוצאת חיפוש נתונה.

אין תמיכה מלאה בקבוצת משנה של תכונות הביטויים הרגולריים של JavaScript, כמו קבוצות תיעוד (capture groups) ומשתני שינוי מצב (mode modifiers).

תבנית הביטוי הרגולרי שצוינה מותאמת בנפרד לכל בלוק טקסט שמכיל את הרכיב הנוכחי.

פרמטרים

שםסוגתיאור
searchPatternStringהדפוס שרוצים לחפש
fromRangeElementתוצאת החיפוש שבה רוצים לבצע חיפוש

חזרה

RangeElement – תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או null אם אין התאמה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • 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

getAttributes(offset)

אחזור המאפיינים במרווח התווים שצוין.

התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין טקסט תקין, כאשר כל שם מאפיין תואם לפריט בספירה DocumentApp.Attribute.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Declares style attributes.
const style = {};
style[DocumentApp.Attribute.BOLD] = true;
style[DocumentApp.Attribute.ITALIC] = true;
style[DocumentApp.Attribute.FONT_SIZE] = 29;

// Sets the style attributes to the tab's body.
const text = body.editAsText();
text.setAttributes(style);

// Gets the style attributes applied to the eleventh character in the
// body and logs them to the console.
const attributes = text.getAttributes(10);
console.log(attributes);

פרמטרים

שםסוגתיאור
offsetIntegerהזזת התווים.

חזרה

Object – המאפיינים של האלמנט.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

getBackgroundColor()

אחזור ההגדרה של צבע הרקע.

חזרה

String – צבע הרקע, בפורמט של סימון CSS (כמו '#ffffff'), או null אם האלמנט מכיל כמה ערכים למאפיין הזה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

getBackgroundColor(offset)

אחזור של צבע הרקע במרווח התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID',
);

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

// Sets the background color of the first 3 characters in the body.
const text = body.editAsText().setBackgroundColor(0, 2, '#FFC0CB');

// Gets the background color of the first character in the body.
const backgroundColor = text.getBackgroundColor(0);

// Logs the background color to the console.
console.log(backgroundColor);

פרמטרים

שםסוגתיאור
offsetIntegerהזזת התווים.

חזרה

String — צבע הרקע, בפורמט של סימון CSS (כמו '#ffffff').

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

getFontFamily()

אחזור ההגדרה של משפחת הגופנים. השם יכול להיות כל גופן מתפריט הגופנים ב-Docs או ב-Google Fonts, והוא תלוי אותיות רישיות. השיטות getFontFamily() ו-setFontFamily(fontFamilyName) משתמשות עכשיו בשמות מחרוזות לגופנים במקום ב-enum‏ FontFamily. למרות שה-enum הזה הוצא משימוש, הוא יישאר זמין לצורך תאימות עם סקריפטים ישנים יותר.

חזרה

String – משפחת הגופן, או null אם הרכיב מכיל כמה ערכים למאפיין הזה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

getFontFamily(offset)

אחזור של משפחת הגופנים במרווח התווים שצוין. השם יכול להיות כל גופן מתפריט הגופנים ב-Docs או ב-Google Fonts, והוא תלוי אותיות רישיות. השיטות getFontFamily() ו-setFontFamily(fontFamilyName) משתמשות עכשיו בשמות מחרוזות לגופנים במקום במערך הערכים FontFamily. למרות שה-enum הזה הוצא משימוש, הוא יישאר זמין לצורך תאימות עם סקריפטים ישנים יותר.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the font of the first 16 characters to Impact.
const text = body.editAsText().setFontFamily(0, 15, 'Impact');

// Gets the font family of the 16th character in the tab body.
const fontFamily = text.getFontFamily(15);

// Logs the font family to the console.
console.log(fontFamily);

פרמטרים

שםסוגתיאור
offsetIntegerהזזת התווים.

חזרה

String — משפחת הגופנים.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

getFontSize()

אחזור ההגדרה של גודל הגופן.

חזרה

Number – גודל הגופן, או null אם הרכיב מכיל כמה ערכים למאפיין הזה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

getFontSize(offset)

אחזור גודל הגופן במרווח התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the font size of the first 13 characters to 15.
const text = body.editAsText().setFontSize(0, 12, 15);

// Gets the font size of the first character.
const fontSize = text.getFontSize(0);

// Logs the font size to the console.
console.log(fontSize);

פרמטרים

שםסוגתיאור
offsetIntegerהזזת התווים.

חזרה

Number — גודל הגופן.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

getForegroundColor()

אחזור ההגדרה של צבע החזית.

חזרה

String – צבע החזית, בפורמט של סימון CSS (כמו '#ffffff'), או null אם האלמנט מכיל כמה ערכים למאפיין הזה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

getForegroundColor(offset)

אחזור של צבע החזית במרווח התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the foreground color of the first 3 characters in the tab body.
const text = body.editAsText().setForegroundColor(0, 2, '#0000FF');

// Gets the foreground color of the first character in the tab body.
const foregroundColor = text.getForegroundColor(0);

// Logs the foreground color to the console.
console.log(foregroundColor);

פרמטרים

שםסוגתיאור
offsetIntegerהזזת התווים.

חזרה

String — צבע החזית, בפורמט של סימון CSS (כמו '#ffffff').

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • 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

getLinkUrl(offset)

הפונקציה מאחזרת את כתובת ה-URL של הקישור במרווח התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Applies a link to the first 10 characters in the body.
const text = body.editAsText().setLinkUrl(0, 9, 'https://www.example.com/');

// Gets the URL of the link from the first character.
const link = text.getLinkUrl(0);

// Logs the link URL to the console.
console.log(link);

פרמטרים

שםסוגתיאור
offsetIntegerהזזת התווים.

חזרה

String – כתובת ה-URL של הקישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • 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

getParent()

אחזור של רכיב ההורה של האלמנט.

רכיב ההורה מכיל את הרכיב הנוכחי.

חזרה

ContainerElement – רכיב ההורה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • 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

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

getTextAlignment(offset)

הפונקציה מקבלת את יישור הטקסט של תו יחיד. סוגי ההתאמה הזמינים הם DocumentApp.TextAlignment.NORMAL,‏ DocumentApp.TextAlignment.SUBSCRIPT ו-DocumentApp.TextAlignment.SUPERSCRIPT.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the text alignment of the tab's body to NORMAL.
const text =
    body.editAsText().setTextAlignment(DocumentApp.TextAlignment.NORMAL);

// Gets the text alignment of the ninth character.
const alignment = text.getTextAlignment(8);

// Logs the text alignment to the console.
console.log(alignment.toString());

פרמטרים

שםסוגתיאור
offsetIntegerהזזת התווים.

חזרה

TextAlignment – סוג היישור של הטקסט, או null אם היישור של הטקסט מעולם לא הוגדר.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

getTextAttributeIndices()

הפונקציה מאחזרת את קבוצת אינדקסי הטקסט שתואמים לתחילת רצפי עיצוב טקסט נפרדים.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// 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 indices at which text formatting changes.
const indices = body.editAsText().getTextAttributeIndices();

// Logs the indices to the console.
console.log(indices.toString());

חזרה

Integer[] — קבוצת אינדקסי הטקסט שבהם עיצוב הטקסט משתנה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • 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

insertText(offset, text)

הוספת הטקסט שצוין בהיסט התווים הנתון.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Inserts the text, 'Sample inserted text', at the start of the body content.
const text = body.editAsText().insertText(0, 'Sample inserted text');

פרמטרים

שםסוגתיאור
offsetIntegerהזזה של התווים שבה צריך להוסיף את הטקסט.
textStringהטקסט שרוצים להוסיף.

חזרה

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

isBold()

אחזור ההגדרה של הגופן המודגש.

חזרה

Boolean – אם הטקסט מודגש, או null אם הרכיב מכיל כמה ערכים למאפיין הזה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

isBold(offset)

אחזור ההגדרה של הגופן מודגש בהיסט התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Bolds the first 4 characters in the tab body.
const text = body.editAsText().setBold(0, 3, true);

// Gets whether or not the text is bold.
const bold = text.editAsText().isBold(0);

// Logs the text's bold setting to the console
console.log(bold);

פרמטרים

שםסוגתיאור
offsetIntegerהזזת התווים.

חזרה

Boolean — ההגדרה של הגופן המודגש.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

isItalic()

אחזור ההגדרה של הגופן הנטוי.

חזרה

Boolean – אם הטקסט נטוי, או null אם הרכיב מכיל כמה ערכים למאפיין הזה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

isItalic(offset)

אחזור ההגדרה של הגופן הנטוי בהיסט התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the first 13 characters of the tab body to italic.
const text = body.editAsText().setItalic(0, 12, true);

// Gets whether the fifth character in the tab body is set to
// italic and logs it to the console.
const italic = text.isItalic(4);
console.log(italic);

פרמטרים

שםסוגתיאור
offsetIntegerהזזת התווים.

חזרה

Boolean — הגדרת הגופן הנטוי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

isStrikethrough()

אחזור ההגדרה של קו המחיקה.

חזרה

Boolean – אם הטקסט מסומן בקו חוצה, או null אם הרכיב מכיל כמה ערכים למאפיין הזה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

isStrikethrough(offset)

אחזור ההגדרה של קו המחיקה בהיסט התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the first 17 characters of the tab body to strikethrough.
const text = body.editAsText().setStrikethrough(0, 16, true);

// Gets whether the first character in the tab body is set to
// strikethrough and logs it to the console.
const strikethrough = text.isStrikethrough(0);
console.log(strikethrough);

פרמטרים

שםסוגתיאור
offsetIntegerהזזת התווים.

חזרה

Boolean — ההגדרה של הקו החוצה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

isUnderline()

אחזור ההגדרה של קו התחתון.

חזרה

Boolean – אם הטקסט מודגש או null אם הרכיב מכיל כמה ערכים למאפיין הזה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

isUnderline(offset)

אחזור ההגדרה של קו תחתון בהיסט התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the first 13 characters of the tab body to underline.
const text = body.editAsText().setUnderline(0, 12, false);

// Gets whether the first character in the tab body is set to
// underline and logs it to the console
const underline = text.editAsText().isUnderline(0);
console.log(underline);

פרמטרים

שםסוגתיאור
offsetIntegerהזזת התווים.

חזרה

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

חזרה

Text – הרכיב הממוזג.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

חזרה

Text – הרכיב שהוסרה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

replaceText(searchPattern, replacement)

מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים.

דפוס החיפוש מועבר כמחרוזת, ולא כאובייקט של ביטוי רגולרי ב-JavaScript. לכן צריך להשתמש בתו בריחה (escape) לפני כל קו נטוי לאחור בתבנית.

השיטות האלה משתמשות בספריית הביטויים הרגולריים של 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

setAttributes(startOffset, endOffsetInclusive, attributes)

מחילה את המאפיינים שצוינו על טווח התווים הנתון.

פרמטר המאפיינים שצוין חייב להיות אובייקט שבו כל שם מאפיין הוא פריט בספירה של DocumentApp.Attribute וכל ערך מאפיין הוא הערך החדש שרוצים להחיל.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Declares style attributes for font size and font family.
const style = {};
style[DocumentApp.Attribute.FONT_SIZE] = 20;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Impact';

// Sets the style attributes to the first 9 characters in the tab's body.
const text = body.setAttributes(0, 8, style);

פרמטרים

שםסוגתיאור
startOffsetIntegerהיסט ההתחלה של טווח הטקסט.
endOffsetInclusiveIntegerההיסט של סוף טווח הטקסט.
attributesObjectהמאפיינים של האלמנט.

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • 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המאפיינים של האלמנט.

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setBackgroundColor(startOffset, endOffsetInclusive, color)

הגדרת צבע הרקע של טווח התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the background color of the first 3 characters in the
// tab body to hex color #0000FF.
const text = body.editAsText().setBackgroundColor(0, 2, '#0000FF');

פרמטרים

שםסוגתיאור
startOffsetIntegerהיסט ההתחלה של טווח הטקסט.
endOffsetInclusiveIntegerההיסט של סוף טווח הטקסט.
colorStringצבע הרקע, בפורמט של סימון CSS (כמו '#ffffff').

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setBackgroundColor(color)

הגדרת צבע הרקע.

פרמטרים

שםסוגתיאור
colorStringצבע הרקע, בפורמט של סימון CSS (כמו '#ffffff')

חזרה

Text – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setBold(bold)

הגדרת העיצוב המודגש.

פרמטרים

שםסוגתיאור
boldBooleanההגדרה של הגופן המודגש

חזרה

Text – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setBold(startOffset, endOffsetInclusive, bold)

הגדרת הגופן מודגש לטווח התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the first 11 characters in the tab's body to bold.
const text = body.editAsText().setBold(0, 10, true);

פרמטרים

שםסוגתיאור
startOffsetIntegerהיסט ההתחלה של טווח הטקסט.
endOffsetInclusiveIntegerההיסט של סוף טווח הטקסט.
boldBooleanההגדרה של הגופן המודגש.

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)

הגדרת משפחת הגופנים לטווח התווים שצוין. השם יכול להיות כל גופן מהתפריט 'גופן' ב-Docs או מ-Google Fonts, והוא תלוי אותיות רישיות. שמות גופנים לא מזוהים יופיעו כ-Arial. השיטות getFontFamily(offset) ו-setFontFamily(fontFamilyName) משתמשות עכשיו בשמות מחרוזות לגופנים במקום במערך הערכים FontFamily. למרות שה-enum הזה הוצא משימוש, הוא יישאר זמין לצורך תאימות עם סקריפטים ישנים יותר.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the font of the first 4 characters in the tab's body to Roboto.
const text = body.editAsText().setFontFamily(0, 3, 'Roboto');

פרמטרים

שםסוגתיאור
startOffsetIntegerהיסט ההתחלה של טווח הטקסט.
endOffsetInclusiveIntegerההיסט של סוף טווח הטקסט.
fontFamilyNameStringהשם של משפחת הגופנים, מתפריט הגופנים ב-Docs או בגופנים של Google.

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setFontFamily(fontFamilyName)

הגדרת משפחת הגופנים. השם יכול להיות כל גופן מתפריט הגופנים ב-Docs או ב-Google Fonts, והוא תלוי אותיות רישיות. שמות גופנים לא מזוהים יופיעו כ-Arial. השיטות getFontFamily() ו-setFontFamily(fontFamilyName) משתמשות עכשיו בשמות מחרוזות לגופנים במקום במערך הערכים הקבועים FontFamily. למרות שה-enum הזה הוצא משימוש, הוא יישאר זמין לצורך תאימות עם סקריפטים ישנים יותר.

פרמטרים

שםסוגתיאור
fontFamilyNameStringשם משפחת הגופנים, מתפריט הגופנים ב-Docs או בגופנים של Google

חזרה

Text – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setFontSize(startOffset, endOffsetInclusive, size)

הגדרת גודל הגופן של טווח התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the size of the first 11 characters in the tab's body to 12.
const text = body.editAsText().setFontSize(0, 10, 12);

פרמטרים

שםסוגתיאור
startOffsetIntegerהיסט ההתחלה של טווח הטקסט.
endOffsetInclusiveIntegerההיסט של סוף טווח הטקסט.
sizeNumberגודל הגופן.

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setFontSize(size)

הגדרת גודל הגופן.

פרמטרים

שםסוגתיאור
sizeNumberגודל הגופן

חזרה

Text – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setForegroundColor(startOffset, endOffsetInclusive, color)

הגדרת צבע החזית של טווח התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the foreground color of the first 2 characters in the
// tab's body to hex color #FF0000.
const text = body.editAsText().setForegroundColor(0, 1, '#FF0000');

// Gets the foreground color for the second character in the tab's body.
const foregroundColor = text.getForegroundColor(1);

//  Logs the foreground color to the console.
console.log(foregroundColor);

פרמטרים

שםסוגתיאור
startOffsetIntegerהיסט ההתחלה של טווח הטקסט.
endOffsetInclusiveIntegerההיסט של סוף טווח הטקסט.
colorStringצבע החזית, בפורמט של סימון CSS (כמו '#ffffff').

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setForegroundColor(color)

הגדרת צבע החזית.

פרמטרים

שםסוגתיאור
colorStringצבע החזית, בפורמט של סימון CSS (כמו '#ffffff')

חזרה

Text – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setItalic(italic)

הגדרת הגופן הנטוי.

פרמטרים

שםסוגתיאור
italicBooleanההגדרה של הטקסט הנטוי

חזרה

Text – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setItalic(startOffset, endOffsetInclusive, italic)

הגדרת הגופן הנטוי לטווח התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the first 11 characters in the tab's body to italic.
const text = body.editAsText().setItalic(0, 10, true);

פרמטרים

שםסוגתיאור
startOffsetIntegerהיסט ההתחלה של טווח הטקסט.
endOffsetInclusiveIntegerההיסט של סוף טווח הטקסט.
italicBooleanההגדרה של הגופן הנטוי.

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setLinkUrl(startOffset, endOffsetInclusive, url)

הגדרת כתובת ה-URL של הקישור לטווח התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Applies a link to the first 11 characters in the body.
const text = body.editAsText().setLinkUrl(0, 10, 'https://example.com');

פרמטרים

שםסוגתיאור
startOffsetIntegerהיסט ההתחלה של טווח הטקסט.
endOffsetInclusiveIntegerההיסט של סוף טווח הטקסט.
urlStringכתובת ה-URL של הקישור.

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setLinkUrl(url)

הגדרת כתובת ה-URL של הקישור.

פרמטרים

שםסוגתיאור
urlStringכתובת ה-URL של הקישור

חזרה

Text – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setStrikethrough(strikethrough)

הגדרת ההגדרה של קו המחיקה.

פרמטרים

שםסוגתיאור
strikethroughBooleanההגדרה של קו חוצה

חזרה

Text – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setStrikethrough(startOffset, endOffsetInclusive, strikethrough)

הגדרת ההגדרה של קו חוצה לטווח התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the first 11 characters in the tab's body to strikethrough.
const text = body.editAsText().setStrikethrough(0, 10, true);

פרמטרים

שםסוגתיאור
startOffsetIntegerהיסט ההתחלה של טווח הטקסט.
endOffsetInclusiveIntegerההיסט של סוף טווח הטקסט.
strikethroughBooleanההגדרה של הקו החוצה.

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setText(text)

הגדרת תוכן הטקסט.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Replaces the contents of the body with the text, 'New body text.'
const text = body.editAsText().setText('New body text.');

פרמטרים

שםסוגתיאור
textStringתוכן הטקסט החדש.

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setTextAlignment(startOffset, endOffsetInclusive, textAlignment)

הגדרת היישור של הטקסט בטווח תווים נתון. סוגי ההתאמה הזמינים הם DocumentApp.TextAlignment.NORMAL,‏ DocumentApp.TextAlignment.SUBSCRIPT ו-DocumentApp.TextAlignment.SUPERSCRIPT.

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

פרמטרים

שםסוגתיאור
startOffsetIntegerהיסט ההתחלה של טווח התווים.
endOffsetInclusiveIntegerהיסט הסיום של טווח התווים (כולל).
textAlignmentTextAlignmentסוג היישור של הטקסט.

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • 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סוג יישור הטקסט שרוצים להחיל

חזרה

Text – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setUnderline(underline)

הגדרת ההגדרה של קו תחתון.

פרמטרים

שםסוגתיאור
underlineBooleanהגדרת הקו התחתון

חזרה

Text – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

setUnderline(startOffset, endOffsetInclusive, underline)

הגדרת ההגדרה של קו תחתון לטווח התווים שצוין.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

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

// Sets the first 11 characters in the tab's body to underline.
const text = body.editAsText().setUnderline(0, 10, true);

פרמטרים

שםסוגתיאור
startOffsetIntegerהיסט ההתחלה של טווח הטקסט.
endOffsetInclusiveIntegerההיסט של סוף טווח הטקסט.
underlineBooleanהגדרת הקו התחתון.

חזרה

Text – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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