Class Position

Konum

Belge sekmesindeki belirli bir öğeye göre bir konuma referans. Kullanıcının imleci, diğer kullanımların yanı sıra Position olarak gösterilir. Komut dosyaları yalnızca komut dosyasını çalıştıran kullanıcının imlecine erişebilir ve bu da yalnızca komut dosyası dokümana bağlıysa geçerlidir. 

// Insert some text at the cursor position and make it bold.
const 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.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Yöntemler

YöntemDönüş türüKısa açıklama
getElement()ElementBu Position öğesini içeren öğeyi alır.
getOffset()IntegerBu Position'nin, onu içeren öğe içindeki göreli konumunu alır.
getSurroundingText()TextDoğrudan veya bir alt öğe zinciri aracılığıyla Position içeren Paragraph ya da ListItem öğesinin metnini ve biçimlendirmesini temsil eden yapay bir Text öğesi oluşturur.
getSurroundingTextOffset()IntegergetSurroundingText() tarafından döndürülen Text öğesi içindeki bu Position öğesinin ofsetini alır.
insertBookmark()BookmarkBu Position noktasında yeni bir Bookmark oluşturup ekler.
insertInlineImage(image)InlineImageBelirtilen resim blob'undan bu Position noktasına yeni bir InlineImage oluşturup ekler.
insertText(text)TextBelirtilen metni bu Position alanına ekler.

Ayrıntılı dokümanlar

getElement()

Bu Position öğesini içeren öğeyi alır. Bu, bir Text öğesi veya Paragraph gibi bir kapsayıcı öğesidir. Her iki durumda da öğe içindeki göreli konum getOffset() ile belirlenebilir.

Return

Element: Bu Position nesnesinin bulunduğu kapsayıcı veya Text öğesi

getOffset()

Bu Position'nin, onu içeren öğe içindeki göreli konumunu alır. Öğe bir Text öğesiyse ofset, Position işaretinden önceki karakter sayısıdır (yani bu Position işaretinden sonraki karakterin dizini); diğer öğeler için ofset, aynı kapsayıcı öğe içinde bu Position işaretinden önceki alt öğe sayısıdır (yani Position işaretinden sonraki alt öğenin dizini).

Return

Integer: Text öğeleri için bu Position öğesinden önceki karakter sayısı, diğer öğeler için aynı kapsayıcı öğe içinde bu Position öğesinden önceki alt öğe sayısı

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getSurroundingText()

Doğrudan veya bir alt öğe zinciri aracılığıyla Position içeren Paragraph ya da ListItem öğesinin metnini ve biçimlendirmesini temsil eden yapay bir Text öğesi oluşturur. Döndürülen Text öğesinde Position öğesinin ofsetini belirlemek için getSurroundingTextOffset() öğesini kullanın.

Return

Text: Position öğesini doğrudan veya bir alt öğe zinciri aracılığıyla içeren Paragraph veya ListItem üzerinde editAsText() çağrılmasının sonucuna eşdeğer bir öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getSurroundingTextOffset()

getSurroundingText() tarafından döndürülen Text öğesi içindeki bu Position öğesinin ofsetini alır. Ofset, Position karakterinden önceki karakter sayısıdır (yani bu Position karakterinden sonraki karakterin dizini).

Return

Integer: Position'yi içeren Paragraph veya ListItem öğesinde, doğrudan veya alt öğe zinciri aracılığıyla bu Position'den önceki karakter sayısı

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

insertBookmark()

Bu Position noktasında yeni bir Bookmark oluşturup ekler.

Return

Bookmark: Yeni yer işareti

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

insertInlineImage(image)

Belirtilen resim blob'undan bu Position noktasına yeni bir InlineImage oluşturup ekler.

Parametreler

AdTürAçıklama
imageBlobSourceBu Position alanına eklenecek resim verileri

Return

InlineImage: Yeni resim öğesi veya bu Position öğesinin bulunduğu öğe resim eklenmesine izin vermiyorsa null

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

insertText(text)

Belirtilen metni bu Position alanına ekler. Bu yöntem, dize mevcut bir Text öğesine yerleştirilmiş olsa bile yeni bir Text öğesi oluşturur. Böylece yeni öğenin stilini kolayca ayarlayabilirsiniz.

Parametreler

AdTürAçıklama
textStringBu Position alanına eklenecek dize

Return

Text: Yeni metin öğesi veya bu Position öğesinin bulunduğu öğe metin eklenmesine izin vermiyorsa null

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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