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 هذه من الصورة المحددة كائن ثنائي كبير (blob)
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 هذه من الصورة المحددة كائن ثنائي كبير (blob)

المعلمات

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

الإرجاع

InlineImage: عنصر الصورة الجديد أو null إذا كان العنصر الذي يتضمّن Position تحديد الموقع لا يسمح بإدراج الصور

التفويض

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

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

---

insertText(text)

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

المعلمات

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

الإرجاع

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

التفويض

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

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