Class DocumentApp

برنامه سند

سرویس اسناد Documents قابل ویرایش را ایجاد و باز می کند.

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
let doc = DocumentApp.openById('DOCUMENT_ID');

// Create and open a document.
doc = DocumentApp.create('Document Name');

خواص

اموال تایپ کنید توضیحات
Attribute Attribute شمارش Attribute
Element Type Element Type شمارش Element Type
Font Family Font Family شمارش Font Family .
Glyph Type Glyph Type شمارش Glyph Type .
Horizontal Alignment Horizontal Alignment شمارش Horizontal Alignment .
Paragraph Heading Paragraph Heading شمارش Paragraph Heading .
Positioned Layout Positioned Layout شمارش Positioned Layout .
Text Alignment Text Alignment شمارش Text Alignment .
Vertical Alignment Vertical Alignment شمارش Vertical Alignment .

روش ها

روش نوع برگشت شرح مختصر
create(name) Document یک سند جدید ایجاد و برمی گرداند.
get Active Document() Document سندی را که اسکریپت به آن محدود شده است برمی‌گرداند.
get Ui() Ui نمونه‌ای از محیط رابط کاربری سند را برمی‌گرداند که به اسکریپت اجازه می‌دهد ویژگی‌هایی مانند منوها، گفتگوها و نوارهای جانبی را اضافه کند.
open By Id(id) Document سند را با شناسه مشخص شده برمی گرداند.
open By Url(url) Document سند را با URL مشخص شده باز می کند و برمی گرداند.

مستندات دقیق

create(name)

یک سند جدید ایجاد و برمی گرداند.

// Create and open a new document.
const doc = DocumentApp.create('Document Name');

پارامترها

نام تایپ کنید توضیحات
name String نام سند جدید

بازگشت

Document - نمونه سند جدید.

مجوز

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

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

get Active Document()

سندی را که اسکریپت به آن محدود شده است برمی‌گرداند. برای تعامل با سندی که اسکریپت به آن محدود نشده است، از open By Id(id) یا open By Url(url) استفاده کنید.

// Get the document to which this script is bound.
const doc = DocumentApp.getActiveDocument();

بازگشت

Document - نمونه سند

مجوز

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

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

get Ui()

نمونه‌ای از محیط رابط کاربری سند را برمی‌گرداند که به اسکریپت اجازه می‌دهد ویژگی‌هایی مانند منوها، گفتگوها و نوارهای جانبی را اضافه کند. یک اسکریپت فقط می تواند برای نمونه فعلی یک سند باز با رابط کاربری تعامل داشته باشد و تنها در صورتی که اسکریپت به سند متصل باشد. برای اطلاعات بیشتر، به راهنمای منوها ، گفتگوها و نوارهای جانبی مراجعه کنید.

// Add a custom menu to the active document, including a separator and a
// sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(
          DocumentApp.getUi()
              .createMenu('My sub-menu')
              .addItem('One sub-menu item', 'mySecondFunction')
              .addItem('Another sub-menu item', 'myThirdFunction'),
          )
      .addToUi();
}

بازگشت

Ui - نمونه ای از محیط رابط کاربری این سند

open By Id(id)

سند را با شناسه مشخص شده برمی گرداند. اگر اسکریپت به سند متصل است، به جای آن از get Active Document() استفاده کنید.

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('DOCUMENT_ID');

پارامترها

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

بازگشت

Document - نمونه سند.

مجوز

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

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

open By Url(url)

سند را با URL مشخص شده باز می کند و برمی گرداند. اگر اسکریپت به سند متصل است، به جای آن از get Active Document() استفاده کنید.

// Open a document by URL.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit',
);

پارامترها

نام تایپ کنید توضیحات
url String نشانی اینترنتی سند برای باز کردن

بازگشت

Document - نمونه سند

مجوز

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

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