Class ParagraphStyle

    • ParagraphStyle applies text styles to entire paragraphs.

    • Reading methods for ParagraphStyle return null if the TextRange spans paragraphs with different styles.

    • To avoid issues with reading styles across multiple paragraphs, query using the TextRange returned by Paragraph.getRange().

    • Editing text fit within a shape deactivates any autofit settings on paragraph styles.

    • ParagraphStyle provides methods to get and set indentation, line spacing, alignment, spacing above and below, spacing mode, and text direction.
    ParagraphStyle

    The styles of text that apply to entire paragraphs.

    Read methods in this class return null if the corresponding TextRange spans multiple paragraphs, and those paragraphs have different values for the read method being called. To avoid this, query for paragraph styles using the TextRange returned by the Paragraph.getRange() method.

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

    Methods

    Method Return type Brief description
    get Indent End()
    		Number|null Returns the text end indentation for paragraphs in the Text Range in points, or null if there are multiple paragraph styles on the given text.
    get Indent First Line()
    		Number|null Returns the indentation for the first line of paragraphs in the Text Range in points, or null if there are multiple paragraph styles on the given text.
    get Indent Start()
    		Number|null Returns the text start indentation for paragraphs in the Text Range in points, or null if there are multiple paragraph styles on the given text.
    get Line Spacing()
    		Number|null Returns the line spacing, or null if there are multiple paragraph styles on the given text.
    get Paragraph Alignment()
    		Paragraph Alignment |null Returns the Paragraph Alignment of paragraphs in the Text Range , or null if there are multiple paragraph styles on the given text.
    get Space Above()
    		Number|null Returns the extra space above paragraphs in the Text Range in points, or null if there are multiple paragraph styles on the given text.
    get Space Below()
    		Number|null Returns the extra space below paragraphs in the Text Range in points, or null if there are multiple paragraph styles on the given text.
    get Spacing Mode()
    		Spacing Mode |null Returns the Spacing Mode for paragraphs in the Text Range , or null if there are multiple paragraph styles on the given text.
    get Text Direction()
    		Text Direction |null Returns the Text Direction for paragraphs in the Text Range , or null if there are multiple paragraph styles on the given text.
    set Indent End(indent)
    		Paragraph Style Sets the text end indentation for paragraphs in the Text Range in points.
    set Indent First Line(indent)
    		Paragraph Style Sets the indentation for the first line of paragraphs in the Text Range in points.
    set Indent Start(indent)
    		Paragraph Style Sets the text start indentation for paragraphs in the Text Range in points.
    set Line Spacing(spacing)
    		Paragraph Style Sets the line spacing.
    set Paragraph Alignment(alignment)
    		Paragraph Style Sets the Paragraph Alignment of paragraphs in the Text Range .
    set Space Above(space)
    		Paragraph Style Sets the extra space above paragraphs in the Text Range in points.
    set Space Below(space)
    		Paragraph Style Sets the extra space below paragraphs in the Text Range in points.
    set Spacing Mode(mode)
    		Paragraph Style Sets the Spacing Mode for paragraphs in the Text Range .
    set Text Direction(direction)
    		Paragraph Style Sets the Text Direction for paragraphs in the Text Range .

    Detailed documentation

    getIndentEnd()

    Returns the text end indentation for paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text.

    The side that corresponds to the end of the text is based on the current text direction.

    Return

    Number|null

    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

    getIndentFirstLine()

    Returns the indentation for the first line of paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text.

    Return

    Number|null

    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

    getIndentStart()

    Returns the text start indentation for paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text.

    The side that corresponds to the start of the text is based on the current text direction.

    Return

    Number|null

    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

    getLineSpacing()

    Returns the line spacing, or null if there are multiple paragraph styles on the given text.

    This is a value that corresponds to the space between lines, as a percentage of normal. Normal is represented as 100.0.

    Return

    Number|null

    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

    getParagraphAlignment()

    Returns the ParagraphAlignment of paragraphs in the TextRange , or null if there are multiple paragraph styles on the given text.

    Return

    ParagraphAlignment |null

    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

    getSpaceAbove()

    Returns the extra space above paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text.

    Return

    Number|null

    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

    getSpaceBelow()

    Returns the extra space below paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text.

    Return

    Number|null

    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

    getSpacingMode()

    Returns the SpacingMode for paragraphs in the TextRange , or null if there are multiple paragraph styles on the given text.

    Return

    SpacingMode |null

    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

    getTextDirection()

    Returns the TextDirection for paragraphs in the TextRange , or null if there are multiple paragraph styles on the given text.

    Return

    TextDirection |null

    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

    setIndentEnd(indent)

    Sets the text end indentation for paragraphs in the TextRange in points.

    Parameters

    Name Type Description
    indent
    		Number The indentation to set.

    Return

    ParagraphStyle — This ParagraphStyle , for chaining.

    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

    setIndentFirstLine(indent)

    Sets the indentation for the first line of paragraphs in the TextRange in points.

    Parameters

    Name Type Description
    indent
    		Number The indentation to set.

    Return

    ParagraphStyle — This ParagraphStyle , for chaining.

    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

    setIndentStart(indent)

    Sets the text start indentation for paragraphs in the TextRange in points.

    Parameters

    Name Type Description
    indent
    		Number The indentation to set.

    Return

    ParagraphStyle — This ParagraphStyle , for chaining.

    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

    setLineSpacing(spacing)

    Sets the line spacing.

    This is a value that corresponds to the space between lines, as a percentage of normal.

    Parameters

    Name Type Description
    spacing
    		Number The spacing to set.

    Return

    ParagraphStyle — This ParagraphStyle , for chaining.

    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

    setParagraphAlignment(alignment)

    Sets the ParagraphAlignment of paragraphs in the TextRange .

    Parameters

    Name Type Description
    alignment
    		Paragraph Alignment The alignment to set.

    Return

    ParagraphStyle — This ParagraphStyle , for chaining.

    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

    setSpaceAbove(space)

    Sets the extra space above paragraphs in the TextRange in points.

    Parameters

    Name Type Description
    space
    		Number The space above to set.

    Return

    ParagraphStyle — This ParagraphStyle , for chaining.

    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

    setSpaceBelow(space)

    Sets the extra space below paragraphs in the TextRange in points.

    Parameters

    Name Type Description
    space
    		Number The space below to set.

    Return

    ParagraphStyle — This ParagraphStyle , for chaining.

    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

    setSpacingMode(mode)

    Sets the SpacingMode for paragraphs in the TextRange .

    Parameters

    Name Type Description
    mode
    		Spacing Mode The spacing mode to set.

    Return

    ParagraphStyle — This ParagraphStyle , for chaining.

    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

    setTextDirection(direction)

    Sets the TextDirection for paragraphs in the TextRange .

    Parameters

    Name Type Description
    direction
    		Text Direction The text direction to set.

    Return

    ParagraphStyle — This ParagraphStyle , for chaining.

    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: