Class Position

Konum

Belirli bir öğeye göre, doküman sekmesindeki bir konuma yapılan 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 erişim yalnızca komut dosyası dokümana bağlıysa mümkündür. 

// 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 öğesinin, kendisini içeren öğe içindeki göreli konumunu alır.
getSurroundingText()TextText öğesini doğrudan veya bir alt öğe zinciri aracılığıyla içeren Paragraph ya da ListItem öğesinin metnini ve biçimlendirmesini temsil eden yapay bir Text öğesi oluşturur.Position
getSurroundingTextOffset()IntegerPosition öğesinin, getSurroundingText() tarafından döndürülen Text öğesindeki ofsetini alır.
insertBookmark()BookmarkBu Position konumunda yeni bir Bookmark oluşturup ekler.
insertInlineImage(image)InlineImage|nullBelirtilen görüntü blob'undan bu Position konumunda yeni bir InlineImage oluşturup ekler.
insertText(text)Text|nullBelirtilen metni Position konumuna ekler.

Ayrıntılı belgeler

getElement()

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

Return

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

getOffset()

Bu Position öğesinin, kendisini içeren öğe içindeki göreli konumunu alır. Öğe bir Text öğesiyse ofset, Position öğesinden önceki karakter sayısıdır (yani bu Position öğesinden sonraki karakterin dizini); diğer tüm öğeler için ofset, aynı kapsayıcı öğe içindeki bu Position öğesinden önceki alt öğelerin sayısıdır (yani Position öğesinden 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çindeki bu Position öğesinden önceki alt öğe sayısı

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getSurroundingText()

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

Return

Text: editAsText() işlevinin Paragraph veya ListItem üzerinde çağrılmasıyla elde edilen sonuca eşdeğer bir öğe. Bu öğe, Position öğesini doğrudan veya bir alt öğe zinciri aracılığıyla içerir.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getSurroundingTextOffset()

Position öğesinin, getSurroundingText() tarafından döndürülen Text öğesindeki ofsetini alır. Ofset, Position işaretinden önceki karakter sayısıdır (yani bu Position işaretinden sonraki karakterin dizinidir).

Return

Integer: Position'nin bulunduğu Paragraph veya ListItem içinde, doğrudan ya da bir alt öğe zinciri aracılığıyla bu Position'den önceki karakter sayısı

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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

insertBookmark()

Bu Position konumunda yeni bir Bookmark oluşturup ekler.

Return

Bookmark: Yeni yer işareti

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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

insertInlineImage(image)

Belirtilen görüntü blob'undan bu Position konumunda yeni bir InlineImage oluşturup ekler.

Parametreler

AdTürAçıklama
imageBlobSourcebu Position konumuna eklenecek resim verileri

Return

InlineImage|null (yeni resim öğesi) veya null (bu Position öğesinin bulunduğu öğeye resim eklenmesine izin verilmiyorsa)

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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

insertText(text)

Belirtilen metni Position konumuna ekler. Bu yöntem, dize mevcut bir Text öğesine yerleştirilmiş olsa bile yeni bir Text öğesi oluşturur. Böylece yeni öğeyi kolayca stilize edebilirsiniz.

Parametreler

AdTürAçıklama
textStringbu Position konumuna eklenecek dize

Return

Text|null: Yeni metin öğesi veya bu Position öğesinin bulunduğu öğeye metin eklenmesine izin verilmiyorsa null

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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