כלי לבניית ערכים של טקסט עשיר.
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
build() | RichTextValue | יוצר ערך טקסט עשיר מהבונה הזה. |
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()
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();
פרמטרים
שם | תיאור | התיאור |
---|---|---|
startOffset | Integer | היסט ההתחלה עבור מחרוזת המשנה, כולל. |
endOffset | Integer | קיזוז הסיום של מחרוזת המשנה, בלעדי. |
linkUrl | String | כתובת ה-URL של הקישור בתהליך הגדרה. |
החזרות
RichTextValueBuilder
– הכלי הזה – לשרשורים.
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();
פרמטרים
שם | תיאור | התיאור |
---|---|---|
linkUrl | String | כתובת ה-URL של הקישור בתהליך הגדרה. |
החזרות
RichTextValueBuilder
– הכלי הזה – לשרשורים.
setText(text)
מגדיר את הטקסט עבור הערך הזה ומנקה את כל סגנון הטקסט הקיים. כשיוצרים ערך חדש של טקסט עשיר, צריך להפעיל אותו לפני setTextStyle(startOffset, endOffset, textStyle)
.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
text | String | הטקסט של הערך הזה. |
החזרות
RichTextValueBuilder
– הכלי הזה – לשרשורים.
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();
פרמטרים
שם | תיאור | התיאור |
---|---|---|
startOffset | Integer | היסט ההתחלה עבור מחרוזת המשנה, כולל. |
endOffset | Integer | קיזוז הסיום של מחרוזת המשנה, בלעדי. |
textStyle | TextStyle | סגנון הטקסט שמוגדר. |
החזרות
RichTextValueBuilder
– הכלי הזה – לשרשורים.
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();
פרמטרים
שם | תיאור | התיאור |
---|---|---|
textStyle | TextStyle | סגנון הטקסט שמוגדר. |
החזרות
RichTextValueBuilder
– הכלי הזה – לשרשורים.