Class Position

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
الموضع

إشارة إلى موقع جغرافي في المستند، بالنسبة إلى عنصر معيّن. يتم تقديم مؤشر المستخدم على أنه Position، بالإضافة إلى استخدامات أخرى. لا يمكن للنصوص البرمجية الوصول إلا إلى مؤشر المستخدم الذي يشغِّل النص البرمجي، وذلك فقط إذا كان النص البرمجي مرتبطًا بالمستند.

// Insert some text at the cursor position and make it bold.
var cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
  // containing element doesn't allow insertions, so show the user an error message.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

الطُرق

الطريقةنوع الإرجاعوصف قصير
getElement()Elementتحصل على العنصر الذي يحتوي على Position.
getOffset()Integerيحصل على هذا الموقع النسبي للسمة "Position" في العنصر الذي يحتوي عليه.
getSurroundingText()Textتنشئ عنصر Text اصطناعيًا يمثل نص وتنسيق Paragraph أو ListItem الذي يحتوي على Position، إما بشكل مباشر أو من خلال سلسلة من العناصر الفرعية.
getSurroundingTextOffset()Integerللحصول على الإزاحة لهذه Position ضمن العنصر Text الذي يعرضه getSurroundingText().
insertBookmark()Bookmarkلإنشاء Bookmark جديد وإدراجه في Position هذا.
insertInlineImage(image)InlineImageإنشاء InlineImage جديد وإدراجه في Position هذا من كائن الصورة الثنائي الكبير.
insertText(text)Textإدراج النص المحدّد في Position.

المستندات التفصيلية

getElement()

تحصل على العنصر الذي يحتوي على Position. ويجب أن يكون هذا العنصر إما عنصر Text أو عنصر حاوية، مثل Paragraph. وفي كلتا الحالتين، يمكن تحديد الموضع النسبي داخل العنصر باستخدام getOffset().

تذكرة ذهاب وعودة

Element: الحاوية أو العنصر Text الذي يتوفّر فيه هذا العنصر Position


getOffset()

يحصل على هذا الموقع النسبي للسمة"Position"في العنصر الذي يحتوي عليه. إذا كان العنصر عبارة عن عنصر Text، تكون الإزاحة هي عدد الأحرف قبل Position (أي فهرس الحرف بعد هذا Position)، وبالنسبة إلى أي عنصر آخر، تكون الإزاحة هي عدد العناصر الفرعية قبل هذا Position ضمن عنصر الحاوية نفسه (أي فهرس العنصر الفرعي بعد Position).

تذكرة ذهاب وعودة

Integer: بالنسبة إلى عناصر Text، عدد الأحرف قبل هذا Position، بالنسبة إلى العناصر الأخرى، عدد العناصر الفرعية قبل هذا Position داخل عنصر الحاوية نفسه

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:

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

getSurroundingText()

تنشئ عنصر Text اصطناعيًا يمثل نص وتنسيق Paragraph أو ListItem الذي يحتوي على Position، إما بشكل مباشر أو من خلال سلسلة من العناصر الفرعية. لتحديد إزاحة Position' في العنصر Text المعروض، استخدم getSurroundingTextOffset().

تذكرة ذهاب وعودة

Text: عنصر يعادل نتيجة استدعاء editAsText() على Paragraph أو ListItem الذي يحتوي على Position، إما مباشرةً أو من خلال سلسلة من العناصر الفرعية

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:

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

getSurroundingTextOffset()

للحصول على الإزاحة لهذه Position ضمن العنصر Text الذي يعرضه getSurroundingText(). الإزاحة هي عدد الأحرف قبل Position (أي فهرس الحرف بعد Position).

تذكرة ذهاب وعودة

Integer: عدد الأحرف قبل هذا Position في Paragraph أو ListItem الذي يحتوي على Position، إما بشكل مباشر أو من خلال سلسلة من العناصر الفرعية

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:

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

insertBookmark()

لإنشاء Bookmark جديد وإدراجه في Position هذا.

تذكرة ذهاب وعودة

Bookmark: الإشارة المرجعية الجديدة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:

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

insertInlineImage(image)

إنشاء InlineImage جديد وإدراجه في Position هذا من كائن الصورة الثنائي الكبير.

المعلّمات

الاسمالنوعالوصف
imageBlobSourceبيانات الصورة المطلوب إدراجها عند Position

تذكرة ذهاب وعودة

InlineImage - عنصر الصورة الجديد أو null إذا كان العنصر الذي يقع فيه Position هذا لا يسمح بإدراج الصور

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:

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

insertText(text)

إدراج النص المحدّد في Position. تنشئ هذه الطريقة عنصر Text جديدًا، حتى إذا تم إدراج السلسلة داخل عنصر Text حالي، بحيث يكون من السهل تصميم العنصر الجديد.

المعلّمات

الاسمالنوعالوصف
textStringالسلسلة المطلوب إدراجها عند Position

تذكرة ذهاب وعودة

Text - العنصر النصي الجديد أو null إذا كان العنصر الذي يتضمّن Position فيه لا يسمح بإدراج النص

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:

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