Class RichTextValueBuilder

سازنده‌ی مقادیر متن غنی

سازنده‌ای برای مقادیر Rich Text.

روش‌ها

روش	نوع بازگشتی	شرح مختصر
build()	Rich Text Value	یک مقدار Rich Text از این سازنده ایجاد می‌کند.
set Link Url(startOffset, endOffset, linkUrl)	Rich Text Value Builder	آدرس لینک را برای زیررشته‌ی داده شده از این مقدار تنظیم می‌کند، یا اگر link Url null باشد، آن را پاک می‌کند.
set Link Url(linkUrl)	Rich Text Value Builder	آدرس لینک را برای کل مقدار تنظیم می‌کند، یا اگر link Url null باشد، آن را پاک می‌کند.
set Text(text)	Rich Text Value Builder	متن را برای این مقدار تنظیم می‌کند و هر سبک متن موجود را پاک می‌کند.
set Text Style(startOffset, endOffset, textStyle)	Rich Text Value Builder	یک سبک متن را به زیررشته‌ی داده شده از این مقدار اعمال می‌کند.
set Text Style(textStyle)	Rich Text Value Builder	یک سبک متن را به کل مقدار اعمال می‌کند.

مستندات دقیق

build()

یک مقدار Rich Text از این سازنده ایجاد می‌کند.

بازگشت

RichTextValue - یک مقدار Rich Text که از این سازنده ایجاد شده است.

---

setLinkUrl(startOffset, endOffset, linkUrl)

آدرس لینک را برای زیررشته‌ی داده شده از این مقدار تنظیم می‌کند، یا اگر 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();

پارامترها

نام	نوع	توضیحات
start Offset	Integer	آفست شروع برای زیررشته، شامل.
end Offset	Integer	آفست پایانی برای زیررشته، منحصر به فرد.
link Url	String	آدرس لینک تنظیم می‌شود.

بازگشت

RichTextValueBuilder — این سازنده، برای زنجیره‌سازی.

---

setLinkUrl(linkUrl)

آدرس لینک را برای کل مقدار تنظیم می‌کند، یا اگر 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();

پارامترها

نام	نوع	توضیحات
link Url	String	آدرس لینک تنظیم می‌شود.

بازگشت

RichTextValueBuilder — این سازنده، برای زنجیره‌سازی.

---

setText(text)

متن را برای این مقدار تنظیم می‌کند و هر سبک متن موجود را پاک می‌کند. هنگام ایجاد یک مقدار Rich Text جدید، این باید قبل از setTextStyle(startOffset, endOffset, textStyle) فراخوانی شود.

پارامترها

نام	نوع	توضیحات
text	String	متن مربوط به این مقدار.

بازگشت

RichTextValueBuilder — این سازنده، برای زنجیره‌سازی.

---

setTextStyle(startOffset, endOffset, textStyle)

یک سبک متن را به زیررشته‌ی داده شده از این مقدار اعمال می‌کند. آفست‌ها بر اساس ۰ هستند و نسبت به مقدار متن سلول محاسبه می‌شوند. اگر 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();

پارامترها

نام	نوع	توضیحات
start Offset	Integer	آفست شروع برای زیررشته، شامل.
end Offset	Integer	آفست پایانی برای زیررشته، منحصر به فرد.
text Style	Text Style	سبک متن تنظیم می‌شود.

بازگشت

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

پارامترها

نام	نوع	توضیحات
text Style	Text Style	سبک متن تنظیم می‌شود.

بازگشت

RichTextValueBuilder — این سازنده، برای زنجیره‌سازی.