Class RichTextValueBuilder

RichTextValueBuilder

כלי ליצירת ערכים של טקסט עשיר.

שיטות

שיטהסוג הערך המוחזרתיאור קצר
build()RichTextValueיצירת ערך של טקסט עשיר מה-builder הזה.
setLinkUrl(startOffset, endOffset, linkUrl)RichTextValueBuilderמגדיר את כתובת ה-URL של הקישור למחרוזת המשנה הנתונה של הערך הזה, או מנקה את הכתובת אם linkUrl הוא null.
setLinkUrl(linkUrl)RichTextValueBuilderהגדרת כתובת ה-URL של הקישור לכל הערך או ניקוי שלה אם הערך של linkUrl הוא null.
setText(text)RichTextValueBuilderמגדיר את הטקסט של הערך הזה ומנקה את כל סגנון הטקסט הקיים.
setTextStyle(startOffset, endOffset, textStyle)RichTextValueBuilderהפונקציה מחילה סגנון טקסט על מחרוזת המשנה הנתונה של הערך הזה.
setTextStyle(textStyle)RichTextValueBuilderהחלת סגנון טקסט על הערך כולו.

מסמכי תיעוד מפורטים

build()

יצירת ערך של טקסט עשיר מה-builder הזה.

חזרה

RichTextValue – ערך של טקסט עשיר שנוצר מה-builder הזה.


setLinkUrl(startOffset, endOffset, linkUrl)

מגדיר את כתובת ה-URL של הקישור למחרוזת המשנה הנתונה של הערך הזה, או מנקה את הכתובת אם linkUrl הוא null.

// Creates a Rich Text value for the text "foo no baz" with "foo" pointing to
// "https://bar.foo" and "baz" to "https://abc.xyz".
// "foo" is underlined with the default link color, whereas "baz" has its text style
// overridden by a call to `setTextStyle`, and is therefore black and bold with no underlining.
const boldStyle = SpreadsheetApp.newTextStyle()
    .setUnderline(false)
    .setBold(true)
    .setForegroundColor("#000000")
    .build();
const value = SpreadsheetApp.newRichTextValue()
    .setText("foo no baz")
    .setLinkUrl(0, 3, "https://bar.foo")
    .setLinkUrl(7, 10, "https://abc.xyz")
    .setTextStyle(7, 10, boldStyle)
    .build();

פרמטרים

שםסוגתיאור
startOffsetIntegerהיסט ההתחלה של מחרוזת המשנה, כולל.
endOffsetIntegerהיסט הסיום של מחרוזת המשנה, לא כולל.
linkUrlStringכתובת ה-URL של הקישור שמוגדרת.

חזרה

RichTextValueBuilder – ה-builder הזה, לשרשורים.


setLinkUrl(linkUrl)

הגדרת כתובת ה-URL של הקישור לכל הערך או ניקוי שלה אם הערך של linkUrl הוא null.

// Creates a Rich Text value for the text "Foo" which points to "https://bar.foo".
const value = SpreadsheetApp.newRichTextValue()
    .setText("Foo")
    .setLinkUrl("https://bar.foo")
    .build();

פרמטרים

שםסוגתיאור
linkUrlStringכתובת ה-URL של הקישור שמוגדרת.

חזרה

RichTextValueBuilder – ה-builder הזה, לשרשורים.


setText(text)

מגדיר את הטקסט של הערך הזה ומנקה את כל סגנון הטקסט הקיים. כשיוצרים טקסט עשיר חדש יש לקרוא לערך הזה לפני setTextStyle(startOffset, endOffset, textStyle).

פרמטרים

שםסוגתיאור
textStringהטקסט של הערך הזה.

חזרה

RichTextValueBuilder – ה-builder הזה, לשרשורים.


setTextStyle(startOffset, endOffset, textStyle)

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

// Creates a Rich Text value for the text "HelloWorld", with "Hello" bolded, and "World"
// italicized.
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var italic = SpreadsheetApp.newTextStyle().setItalic(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("HelloWorld")
    .setTextStyle(0, 5, bold)
    .setTextStyle(5, 10, italic)
    .build();

פרמטרים

שםסוגתיאור
startOffsetIntegerהיסט ההתחלה של מחרוזת המשנה, כולל.
endOffsetIntegerהיסט הסיום של מחרוזת המשנה, לא כולל.
textStyleTextStyleסגנון הטקסט שהוגדר.

חזרה

RichTextValueBuilder – ה-builder הזה, לשרשורים.


setTextStyle(textStyle)

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

// Creates a Rich Text value for the text "HelloWorld" with "Hello" bolded and italicized,
// and "World" only italicized.
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var italic = SpreadsheetApp.newTextStyle().setItalic(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("HelloWorld")
    .setTextStyle(0, 5, bold)
    .setTextStyle(italic)
    .build();

פרמטרים

שםסוגתיאור
textStyleTextStyleסגנון הטקסט שהוגדר.

חזרה

RichTextValueBuilder – ה-builder הזה, לשרשורים.