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

المعلمات

الاسم	النوع	الوصف
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)

تضبط هذه السمة النص لهذه القيمة وتمحو أي نمط نص حالي. عند إنشاء قيمة Rich 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.
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();

المعلمات

الاسم	النوع	الوصف
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.
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();

المعلمات

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

الإرجاع

‫RichTextValueBuilder: أداة إنشاء السلاسل