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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/docs_v1/classes.rb,
generated/google/apis/docs_v1/representations.rb,
generated/google/apis/docs_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ UpdateParagraphStyleRequest

Returns a new instance of UpdateParagraphStyleRequest.



6124
6125
6126
# File 'generated/google/apis/docs_v1/classes.rb', line 6124

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

Instance Attribute Details

#fieldsString

The fields that should be updated. At least one field must be specified. The root paragraph_style is implied and should not be specified. 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)


6099
6100
6101
# File 'generated/google/apis/docs_v1/classes.rb', line 6099

def fields
  @fields
end

#paragraph_styleGoogle::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 is 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


6117
6118
6119
# File 'generated/google/apis/docs_v1/classes.rb', line 6117

def paragraph_style
  @paragraph_style
end

#rangeGoogle::Apis::DocsV1::Range

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



6122
6123
6124
# File 'generated/google/apis/docs_v1/classes.rb', line 6122

def range
  @range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6129
6130
6131
6132
6133
# File 'generated/google/apis/docs_v1/classes.rb', line 6129

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