Class: Google::Apis::DocsV1::UpdateParagraphStyleRequest

Inherits:

Object

• Object
• Google::Apis::DocsV1::UpdateParagraphStyleRequest

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/docs_v1/classes.rb,
lib/google/apis/docs_v1/representations.rb,
lib/google/apis/docs_v1/representations.rb

Overview

Update the styling of all paragraphs that overlap with the given range.

Instance Attribute Summary

• #fields ⇒ String

  The fields that should be updated.

• #paragraph_style ⇒ Google::Apis::DocsV1::ParagraphStyle

  Styles that apply to a whole paragraph.

• #range ⇒ Google::Apis::DocsV1::Range

  Specifies a contiguous range of text.

Instance Method Summary

• #initialize(**args) ⇒ UpdateParagraphStyleRequest constructor

  A new instance of UpdateParagraphStyleRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ UpdateParagraphStyleRequest

Returns a new instance of UpdateParagraphStyleRequest.

# File 'lib/google/apis/docs_v1/classes.rb', line 6549

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#fields ⇒ String

The fields that should be updated. At least one field must be specified. The root paragraph_style is implied and should not be specified. A single "*" can be used as short-hand for listing every field. For example, to update the paragraph style's alignment property, set fields to "alignment". To reset a property to its default value, include its field name in the field mask but leave the field itself unset. Corresponds to the JSON property fields

Returns:

• (String)

# File 'lib/google/apis/docs_v1/classes.rb', line 6527

def fields
  @fields
end

#paragraph_style ⇒ Google::Apis::DocsV1::ParagraphStyle

Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. Corresponds to the JSON property paragraphStyle

Returns:

• (Google::Apis::DocsV1::ParagraphStyle)

# File 'lib/google/apis/docs_v1/classes.rb', line 6542

def paragraph_style
  @paragraph_style
end

#range ⇒ Google::Apis::DocsV1::Range

Specifies a contiguous range of text. Corresponds to the JSON property range

Returns:

• (Google::Apis::DocsV1::Range)

# File 'lib/google/apis/docs_v1/classes.rb', line 6547

def range
  @range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/docs_v1/classes.rb', line 6554

def update!(**args)
  @fields = args[:fields] if args.key?(:fields)
  @paragraph_style = args[:paragraph_style] if args.key?(:paragraph_style)
  @range = args[:range] if args.key?(:range)
end