Class RichTextValueBuilder

RichTextValueBuilder

أداة إنشاء قيم النصوص المنسّقة

الطُرق

الطريقةنوع الإرجاعوصف قصير
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()

تنشئ قيمة نص منسق من أداة الإنشاء هذه.

الإرجاع

RichTextValue — قيمة نص منسَّق تم إنشاؤها من أداة الإنشاء هذه.


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 — أداة الإنشاء هذه، للسلاسل


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 — أداة الإنشاء هذه، للسلاسل


setText(text)

لضبط النص لهذه القيمة ومحو أي نمط نص حالي. عند إنشاء نص منسق جديد ، يجب طلب ذلك قبل setTextStyle(startOffset, endOffset, textStyle).

المعلمات

الاسمالنوعالوصف
textStringتمثّل هذه السمة النص لهذه القيمة.

الإرجاع

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

المعلمات

الاسمالنوعالوصف
startOffsetIntegerتمثّل هذه السمة إزاحة البداية للسلسلة الفرعية "شاملة".
endOffsetIntegerتمثّل هذه السمة معادلة نهاية السلسلة الفرعية الحصرية.
textStyleTextStyleنمط النص الذي يتم تعيينه.

الإرجاع

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

المعلمات

الاسمالنوعالوصف
textStyleTextStyleنمط النص الذي يتم تعيينه.

الإرجاع

RichTextValueBuilder — أداة الإنشاء هذه، للسلاسل