Class 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.
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const italic = SpreadsheetApp.newTextStyle().setItalic(true).build();
const 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.
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const italic = SpreadsheetApp.newTextStyle().setItalic(true).build();
const value = SpreadsheetApp.newRichTextValue()
                  .setText('HelloWorld')
                  .setTextStyle(0, 5, bold)
                  .setTextStyle(italic)
                  .build();

المعلمات

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

الإرجاع

RichTextValueBuilder: هذا المُنشئ، لتسلسل العناصر.