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

getActiveDocument()

سندی را که اسکریپت به آن متصل است برمی‌گرداند. برای تعامل با سندی که اسکریپت به آن متصل نیست، به جای آن openById(id) یا openByUrl(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

getUi()

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

// 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 — نمونه‌ای از محیط رابط کاربری این سند

openById(id)

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

// 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

openByUrl(url)

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

// 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