Class DocumentTab

برگه سند

یک برگه سند، حاوی متن غنی و عناصری مانند جداول و لیست ها.

یک برگه سند را با استفاده از Document.getTabs()[tabIndex].asDocumentTab() بازیابی کنید.

// Get a specific document tab based on the tab ID.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

روش ها

روش نوع برگشت شرح مختصر
add Bookmark(position) Bookmark یک Bookmark در Position داده شده اضافه می کند.
add Footer() Footer Section یک بخش پاورقی برگه را اضافه می کند، اگر وجود نداشته باشد.
add Header() Header Section یک بخش سربرگ برگه را اضافه می کند، اگر وجود نداشته باشد.
add Named Range(name, range) Named Range یک Named Range اضافه می‌کند، که Range است که دارای نام و شناسه برای بازیابی بعدی است.
get Body() Body Body برگه را بازیابی می کند.
get Bookmark(id) Bookmark Bookmark را با شناسه داده شده دریافت می کند.
get Bookmarks() Bookmark[] همه اشیاء Bookmark را در برگه دریافت می کند.
get Footer() Footer Section بخش پاورقی برگه را در صورت وجود بازیابی می کند.
get Footnotes() Footnote[] همه عناصر Footnote را در بدنه برگه بازیابی می کند.
get Header() Header Section بخش سربرگ برگه را در صورت وجود بازیابی می کند.
get Named Range By Id(id) Named Range Named Range را با شناسه داده شده دریافت می کند.
get Named Ranges() Named Range[] تمام اشیاء Named Range را در برگه دریافت می کند.
get Named Ranges(name) Named Range[] تمام اشیاء Named Range را در برگه با نام داده شده دریافت می کند.
new Position(element, offset) Position یک Position جدید ایجاد می کند، که اشاره ای به یک مکان در برگه، نسبت به یک عنصر خاص است.
new Range() Range Builder سازنده ای ایجاد می کند که برای ساخت اشیاء Range از عناصر برگه استفاده می شود.

مستندات دقیق

add Bookmark(position)

یک Bookmark در Position داده شده اضافه می کند.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the tab body and adds a paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = documentTab.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = documentTab.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

پارامترها

نام تایپ کنید توضیحات
position Position موقعیت نشانک جدید.

بازگشت

Bookmark - نشانک جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

add Footer()

یک بخش پاورقی برگه را اضافه می کند، اگر وجود نداشته باشد.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Adds a footer to the tab.
const footer = documentTab.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

بازگشت

Footer Section - پاورقی برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

add Header()

یک بخش سربرگ برگه را اضافه می کند، اگر وجود نداشته باشد.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Adds a header to the tab.
const header = documentTab.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

بازگشت

Header Section - سربرگ برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

add Named Range(name, range)

یک Named Range اضافه می‌کند، که Range است که دارای نام و شناسه برای بازیابی بعدی است. نام‌ها لزوماً منحصر به فرد نیستند، حتی در سربرگ‌ها. چندین محدوده مختلف در یک سند می توانند یک نام مشترک داشته باشند، بسیار شبیه یک کلاس در HTML. در مقابل، شناسه‌ها در سند منحصر به فرد هستند، مانند شناسه در HTML. پس از افزودن یک Named Range ، نمی‌توانید آن را تغییر دهید، فقط می‌توانید آن را حذف کنید.

هر اسکریپتی که به برگه دسترسی پیدا کند می‌تواند به یک Named Range دسترسی داشته باشد. برای جلوگیری از درگیری های ناخواسته بین اسکریپت ها، پیشوند نام محدوده را با یک رشته منحصر به فرد در نظر بگیرید.

// Creates a named range that includes every table in a tab by its ID.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('Tab t.0 tables', rangeBuilder.build());

پارامترها

نام تایپ کنید توضیحات
name String نام محدوده، که لازم نیست منحصر به فرد باشد. نام محدوده باید بین 1 تا 256 کاراکتر باشد.
range Range محدوده عناصری که باید با نام مرتبط شوند. محدوده می تواند یک نتیجه جستجو باشد یا به صورت دستی با new Range() ساخته شود.

بازگشت

Named Range - Named Range .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Body()

Body برگه را بازیابی می کند.

برگه ها ممکن است شامل انواع مختلفی از بخش ها باشند (به عنوان مثال، Header Section ، Footer Section ). بخش فعال یک برگه Body است.

روش های عنصر در Document Tab به Body تفویض می شود.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the tab body.
const body = documentTab.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

بازگشت

Body - بخش بدنه زبانه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Bookmark(id)

Bookmark را با شناسه داده شده دریافت می کند. اگر چنین Bookmark در این برگه وجود نداشته باشد، این روش null را برمی‌گرداند.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the bookmark by its ID.
const bookmark = documentTab.getBookmark('id.xyz654321');

// If the bookmark exists within the tab, logs the character offset of its
// position to the console. Otherwise, logs 'No bookmark exists with the given
// ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

پارامترها

نام تایپ کنید توضیحات
id String شناسه Bookmark .

بازگشت

Bookmark - Bookmark با شناسه داده شده، یا اگر چنین Bookmark در برگه وجود نداشته باشد null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Bookmarks()

همه اشیاء Bookmark را در برگه دریافت می کند.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets all of the bookmarks in the tab.
const bookmarks = documentTab.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

بازگشت

Bookmark[] - آرایه ای از اشیاء Bookmark در برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Footer()

بخش پاورقی برگه را در صورت وجود بازیابی می کند.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the text of the tab's footer and logs it to the console.
console.log(documentTab.getFooter().getText());

بازگشت

Footer Section - پاورقی برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Footnotes()

همه عناصر Footnote را در بدنه برگه بازیابی می کند.

تماس‌های get Footnotes باعث تکرار در عناصر برگه می‌شوند. برای برگه های بزرگ، از تماس های غیر ضروری به این روش خودداری کنید. 

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the first footnote.
const footnote = documentTab.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

بازگشت

Footnote[] - پاورقی های برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Header()

بخش سربرگ برگه را در صورت وجود بازیابی می کند. 

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the text of the tab's header and logs it to the console.
console.log(documentTab.getHeader().getText());

بازگشت

Header Section - سربرگ برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Named Range By Id(id)

Named Range را با شناسه داده شده دریافت می کند. این متد اگر Named Range در برگه وجود نداشته باشد، null برمی گرداند. نام‌ها لزوماً منحصر به فرد نیستند، حتی در سربرگ‌ها. چندین محدوده مختلف در یک سند ممکن است نام یکسانی داشته باشند، بسیار شبیه یک کلاس در HTML. در مقابل، شناسه‌ها مانند شناسه در HTML منحصربه‌فرد هستند.

پارامترها

نام تایپ کنید توضیحات
id String شناسه محدوده، که در برگه منحصر به فرد است.

بازگشت

Named Range - Named Range با شناسه داده شده، یا اگر چنین محدوده‌ای در برگه وجود نداشته باشد، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Named Ranges()

تمام اشیاء Named Range را در برگه دریافت می کند.

یک Named Range توسط هر اسکریپتی که به برگه دسترسی دارد قابل دسترسی است. برای جلوگیری از درگیری های ناخواسته بین اسکریپت ها، پیشوند نام محدوده را با یک رشته منحصر به فرد در نظر بگیرید.

بازگشت

Named Range[] - آرایه ای از اشیاء Named Range در برگه، احتمالاً شامل چندین محدوده با یک نام است.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Named Ranges(name)

تمام اشیاء Named Range را در برگه با نام داده شده دریافت می کند. نام‌ها لزوماً منحصر به فرد نیستند، حتی در سربرگ‌ها. چندین محدوده مختلف در یک سند ممکن است نام یکسانی داشته باشند، بسیار شبیه یک کلاس در HTML. در مقابل، شناسه‌ها مانند شناسه در HTML منحصربه‌فرد هستند.

یک Named Range توسط هر اسکریپتی که به برگه دسترسی دارد قابل دسترسی است. برای جلوگیری از درگیری های ناخواسته بین اسکریپت ها، پیشوند نام محدوده را با یک رشته منحصر به فرد در نظر بگیرید.

پارامترها

نام تایپ کنید توضیحات
name String نام محدوده، که لزوما منحصر به فرد نیست.

بازگشت

Named Range[] - آرایه ای از اشیاء Named Range در برگه با نام داده شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

new Position(element, offset)

یک Position جدید ایجاد می کند، که اشاره ای به یک مکان در برگه، نسبت به یک عنصر خاص است. مکان‌نمای کاربر در میان سایر کاربردها به‌عنوان یک Position نمایش داده می‌شود. 

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
// TODO(developer): Replace the IDs with your own.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

پارامترها

نام تایپ کنید توضیحات
element Element عنصری که حاوی Position جدید ایجاد شده به; این باید یا یک عنصر Text یا یک عنصر ظرف مانند Paragraph باشد.
offset Integer برای عناصر Text ، تعداد کاراکترهای قبل از Position . برای سایر عناصر، تعداد عناصر فرزند قبل از Position در همان عنصر ظرف.

بازگشت

Position - Position جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

new Range()

سازنده ای ایجاد می کند که برای ساخت اشیاء Range از عناصر برگه استفاده می شود. 

// Change the user's selection to a range that includes every table in the tab.
// TODO(developer): Replace the IDs with your own.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

بازگشت

Range Builder - سازنده جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents