Class TextRange

    Text Range

    A segment of the text contents of a Shape or a Table Cell .

    If you use methods that edit how the text fits within a shape, any autofit settings applied to the shape are deactivated.

    Methods

    Method Return type Brief description
    append Paragraph(text)
    		Paragraph Appends a paragraph at the end of the text range.
    append Range(textRange)
    		Text Range Appends a copy of the provided text range to the end of the current text range.
    append Range(textRange, matchSourceFormatting)
    		Text Range Appends a copy of the provided text range to the end of the current text range.
    append Text(text)
    		Text Range Appends text at the end of the text range.
    as Rendered String()
    		String Returns the rendered text bounded by this range of the associated shape or table cell in a format appropriate to display to end users.
    as String()
    		String Returns the raw text bounded by this range of the associated shape or table cell.
    clear()
    		void Clears the text bounded by this range.
    clear(startOffset, endOffset)
    		void Clears the text bounded by the start and end offsets in the range.
    find(pattern)
    		Text Range[] Returns all the ranges matching the search pattern in the current text range.
    find(pattern, startOffset)
    		Text Range[] Returns all the ranges matching the search pattern in the current text range starting from the start offset.
    get Auto Texts()
    		Auto Text[] Returns the auto texts within the current text range.
    get End Index()
    		Integer Returns the exclusive, 0-based index for the last character in this range.
    get Length()
    		Integer Returns the number of characters in this range.
    get Links()
    		Text Range[] Returns a collection of text ranges that correspond to all Link s within the current text range or overlapping the current text range.
    get List Paragraphs()
    		Paragraph[] Returns the paragraphs in lists that overlap the current text range.
    get List Style()
    		List Style Returns the List Style of the current text range.
    get Paragraph Style()
    		Paragraph Style Returns the Paragraph Style of the current text range.
    get Paragraphs()
    		Paragraph[] Returns the paragraphs that overlap the current text range.
    get Range(startOffset, endOffset)
    		Text Range Returns a new Text Range covering part of the range from which it is derived.
    get Runs()
    		Text Range[] Returns the text runs that overlap the current text range.
    get Start Index()
    		Integer Returns the inclusive, 0-based index for the first character in this range.
    get Text Style()
    		Text Style Returns the text style of the range, or null if the range is empty.
    insert Paragraph(startOffset, text)
    		Paragraph Inserts a paragraph at the start offset.
    insert Range(startOffset, textRange)
    		Text Range Inserts a copy of the provided text range at the start offset.
    insert Range(startOffset, textRange, matchSourceFormatting)
    		Text Range Inserts a copy of the provided text range at the start offset.
    insert Text(startOffset, text)
    		Text Range Inserts text at the start offset.
    is Empty()
    		Boolean Returns true if there are no characters in this range, and returns false otherwise.
    replace All Text(findText, replaceText)
    		Integer Replaces all instances of text matching find text with replace text.
    replace All Text(findText, replaceText, matchCase)
    		Integer Replaces all instances of text matching find text with replace text.
    select()
    		void Selects only the Text Range in the active presentation and removes any previous selection.
    set Text(newText)
    		Text Range Sets the text bounded by this range of the associated shape or table cell.

    Detailed documentation

    append Paragraph(text)

    Appends a paragraph at the end of the text range. The paragraph maintains the styling of the end of the current text range.

    The provided text string is appended as a paragraph by adding at least one surrounding newline character to the string.

    When the provided text string contains newline characters (thus consisting of multiple paragraphs), the final paragraph added is returned.

    Parameters

    Name Type Description
    text
    		String The string to append as a paragraph.

    Return

    Paragraph — The appended Paragraph .

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    append Range(textRange)

    Appends a copy of the provided text range to the end of the current text range.

    The formatting of the inserted text matches that of the source text.

    Parameters

    Name Type Description
    text Range
    		Text Range The text range to append.

    Return

    Text Range — The text range representing the appended text.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    append Range(textRange, matchSourceFormatting)

    Appends a copy of the provided text range to the end of the current text range.

    If set to match the formatting of the destination text, Auto Text within the provided text range are replaced with their rendered values. Furthermore, any non-text elements within the provided text range are not appended.

    Parameters

    Name Type Description
    text Range
    		Text Range The text range to append.
    match Source Formatting
    		Boolean If true , match the formatting of the source text; if false , match the formatting of the destination text.

    Return

    Text Range — The text range representing the appended text.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    append Text(text)

    Appends text at the end of the text range. The text maintains the styling of the end of the existing text.

    Parameters

    Name Type Description
    text
    		String The string to append.

    Return

    Text Range — The text range representing the appended text.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    as Rendered String()

    Returns the rendered text bounded by this range of the associated shape or table cell in a format appropriate to display to end users.

    Auto Text elements, such as generated slide numbers, are replaced with their rendered values. Any non-text elements in the range are omitted.

    Return

    String — The rendered text in the range.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    as String()

    Returns the raw text bounded by this range of the associated shape or table cell.

    Auto Text elements such as generated slide numbers and any non-text elements in the range are replaced with the Unicode character U+E907.

    Return

    String — The raw text in the range.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    clear()

    Clears the text bounded by this range.

    Since the entire text in a Shape or TableCell must end in a newline, the final newline in the text is not removed.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    clear(startOffset, endOffset)

    Clears the text bounded by the start and end offsets in the range.

    Since the text must end in a newline, the final newline in text is not removed even if it's covered by the given offsets.

    Parameters

    Name Type Description
    start Offset
    		Integer The number of characters past the start index of the current text range used to determine the inclusive start index of the range to clear. The start offset must be equal to or greater than 0 and less than or equal to end Offset . start Offset must also be less than the length of the current range.
    end Offset
    		Integer The number of characters past the start index of the current text range used to determine the exclusive end index of the range to clear. The end Offset must be equal to or greater than start Offset . end Offset must also be less than or equal to the length of the current range.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    find(pattern)

    Returns all the ranges matching the search pattern in the current text range. The search is case sensitive.

    Parameters

    Name Type Description
    pattern
    		String The regular expression pattern to search; any backslashes in the pattern should be escaped.

    Return

    Text Range[] — A list of text ranges.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    find(pattern, startOffset)

    Returns all the ranges matching the search pattern in the current text range starting from the start offset. The search is case sensitive.

    Parameters

    Name Type Description
    pattern
    		String The regular expression pattern to search; any backslashes in the pattern should be escaped.
    start Offset
    		Integer The number of characters past the start index of the current text range used to determine the inclusive start index of the range to search. start Offset must also be less than the length of the current range.

    Return

    Text Range[] — A list of text ranges.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Auto Texts()

    Returns the auto texts within the current text range.

    Return

    Auto Text[] — A list of auto texts.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get End Index()

    Returns the exclusive, 0-based index for the last character in this range. If the start and end indices are equal, the range is considered to be empty.

    Return

    Integer — The end index of the range.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Length()

    Returns the number of characters in this range.

    Return

    Integer — The number of characters in this range.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    Returns a collection of text ranges that correspond to all Link s within the current text range or overlapping the current text range.

    Each returned range is guaranteed to span one link when it is created. Text modifications can cause it to no longer represent exactly one link.

    Each Link on the returned ranges can be accessed via Text Style.getLink() .

     // Accesses the first link on a TextRange object. 
 const 
  
 textRange 
  
 = 
  
 SlidesApp 
 . 
 getActivePresentation 
 (). 
 getSlides 
 ()[ 
 0 
 ]. 
 getShapes 
 ()[ 
 0 
 ]. 
 getText 
 (); 
 const 
  
 linkTextRange 
  
 = 
  
 textRange 
 . 
 getLinks 
 ()[ 
 0 
 ]; 
 const 
  
 textStyle 
  
 = 
  
 linkTextRange 
 . 
 getTextStyle 
 (); 
 Logger 
 . 
 log 
 ( 
 textStyle 
 . 
 hasLink 
 ()); 
  
 // logs 'true' 
 const 
  
 link 
  
 = 
  
 textStyle 
 . 
 getLink 
 (); 
  
 // Link object

    Return

    Text Range[] — A list of text ranges.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get List Paragraphs()

    Returns the paragraphs in lists that overlap the current text range.

    Return

    Paragraph[] — A list of paragraphs in lists.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get List Style()

    Returns the List Style of the current text range.

    Return

    List Style — The list style of the current text range.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Paragraph Style()

    Returns the Paragraph Style of the current text range.

    Return

    Paragraph Style — The paragraph style of the current text range.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Paragraphs()

    Returns the paragraphs that overlap the current text range.

    Return

    Paragraph[] — A list of paragraphs.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Range(startOffset, endOffset)

    Returns a new Text Range covering part of the range from which it is derived.

    Parameters

    Name Type Description
    start Offset
    		Integer The number of characters past the start index of the current text range used to determine the inclusive start index of the returned range. The start offset must be equal to or greater than 0 and less than or equal to end Offset . start Offset must also be less than the length of the current range.
    end Offset
    		Integer The number of characters past the start index of the current text range used to determine the exclusive end index of the returned range. The end Offset must be equal to or greater than start Offset . end Offset must also be less than or equal to the length of the current range.

    Return

    Text Range — A new text range.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Runs()

    Returns the text runs that overlap the current text range. A text run is a segment of text where all the characters have the same text style.

    Each returned range is only guaranteed to span one run when it is created. Text or style modifications can cause it to no longer represent exactly one run.

    Return

    Text Range[] — A list of text ranges.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Start Index()

    Returns the inclusive, 0-based index for the first character in this range. If the start and end indices are equal, the range is considered to be empty.

    Return

    Integer — The start index of the range.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Text Style()

    Returns the text style of the range, or null if the range is empty.

    Return

    Text Style — The text style of the range.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    insert Paragraph(startOffset, text)

    Inserts a paragraph at the start offset. The paragraph maintains the styling of the current text range at the start offset.

    The provided text string is inserted as a paragraph by adding at least one surrounding newline character to the string.

    When the provided text string contains newline characters (thus consisting of multiple paragraphs), the final paragraph added is returned.

    Parameters

    Name Type Description
    start Offset
    		Integer The number of characters past the start index of the current text range used to determine the inclusive start index of the text to insert.
    text
    		String The string to insert.

    Return

    Paragraph — The inserted Paragraph .

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    insert Range(startOffset, textRange)

    Inserts a copy of the provided text range at the start offset.

    The formatting of the inserted text matches that of the source text.

    Parameters

    Name Type Description
    start Offset
    		Integer The number of characters past the start index of the current text range used to determine the inclusive start index of the text to insert.
    text Range
    		Text Range The text range to insert.

    Return

    Text Range — The text range representing the inserted text.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    insert Range(startOffset, textRange, matchSourceFormatting)

    Inserts a copy of the provided text range at the start offset.

    If set to match the formatting of the destination text, Auto Text within the provided text range are replaced with their rendered values. Furthermore, any non-text elements within the provided text range are not inserted.

    Parameters

    Name Type Description
    start Offset
    		Integer The number of characters past the start index of the current text range used to determine the inclusive start index of the text to insert.
    text Range
    		Text Range The text range to insert.
    match Source Formatting
    		Boolean If true , match the formatting of the source text; if false , match the formatting of the destination text.

    Return

    Text Range — The text range representing the inserted text.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    insert Text(startOffset, text)

    Inserts text at the start offset. The text maintains the styling of the existing text at the start offset.

    Parameters

    Name Type Description
    start Offset
    		Integer The number of characters past the start index of the current text range used to determine the inclusive start index of the text to insert.
    text
    		String The string to insert.

    Return

    Text Range — The text range representing the inserted text.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    is Empty()

    Returns true if there are no characters in this range, and returns false otherwise.

    Return

    Boolean — true if there are no characters in this range, and returns false otherwise.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    replace All Text(findText, replaceText)

    Replaces all instances of text matching find text with replace text. The search is case insensitive.

    Parameters

    Name Type Description
    find Text
    		String The text to find.
    replace Text
    		String The text to replace the matched text.

    Return

    Integer — the number of occurrences changed

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    replace All Text(findText, replaceText, matchCase)

    Replaces all instances of text matching find text with replace text.

    Parameters

    Name Type Description
    find Text
    		String The text to find.
    replace Text
    		String The text to replace the matched text.
    match Case
    		Boolean If true , the search is case sensitive; if false , the search is case insensitive.

    Return

    Integer — the number of occurrences changed

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    select()

    Selects only the Text Range in the active presentation and removes any previous selection.

    A script can only access the selection of the user who is running the script, and only if the script is bound to the presentation.

    The parent Page of the corresponding Shape or the Table Cell is set as the current page selection . The Shape or the Table Cell is set as the selected page element .

      The Selection can be of two types:
      • 1. Range of text, use select on a non-empty TextRange to select the range of the characters.
      • 2. Cursor position, use an empty TextRange to place the cursor at the desired index. 
         const 
  
 shape 
  
 = 
  
 SlidesApp 
 . 
 getActivePresentation 
 (). 
 getSlides 
 ()[ 
 0 
 ]. 
 getShapes 
 ()[ 
 0 
 ]; 
 shape 
 . 
 getText 
 (). 
 setText 
 ( 
 'Hello' 
 ); 
 // Range selection: Select the text range "He". 
 shape 
 . 
 getText 
 (). 
 getRange 
 ( 
 0 
 , 
  
 2 
 ). 
 select 
 (); 
 // Cursor selection: Place the cursor after "H" like "H|ello". 
 shape 
 . 
 getText 
 (). 
 getRange 
 ( 
 1 
 , 
  
 1 
 ). 
 select 
 ();

        Authorization

        Scripts that use this method require authorization with one or more of the following scopes :

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

      set Text(newText)

      Sets the text bounded by this range of the associated shape or table cell. The text maintains the styling of the start of the existing text.

      Parameters

      Name Type Description
      new Text
      		String The string to set as the new text.

      Return

      Text Range — The text range representing the set text.

      Authorization

      Scripts that use this method require authorization with one or more of the following scopes :

      • https://www.googleapis.com/auth/presentations.currentonly
      • https://www.googleapis.com/auth/presentations
      Create a Mobile Website
      View Site in Mobile | Classic
      Share by: