Class: Google::Apis::DocsV1::SectionStyle

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

The styling that applies to a section.

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) ⇒ SectionStyle

Returns a new instance of SectionStyle.



4358
4359
4360
# File 'generated/google/apis/docs_v1/classes.rb', line 4358

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

Instance Attribute Details

#column_propertiesArray<Google::Apis::DocsV1::SectionColumnProperties>

The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than three columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. Corresponds to the JSON property columnProperties



4231
4232
4233
# File 'generated/google/apis/docs_v1/classes.rb', line 4231

def column_properties
  @column_properties
end

#column_separator_styleString

The style of column separators. This style can be set even when there is one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. Corresponds to the JSON property columnSeparatorStyle

Returns:

  • (String)


4238
4239
4240
# File 'generated/google/apis/docs_v1/classes.rb', line 4238

def column_separator_style
  @column_separator_style
end

#content_directionString

The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. Corresponds to the JSON property contentDirection

Returns:

  • (String)


4245
4246
4247
# File 'generated/google/apis/docs_v1/classes.rb', line 4245

def content_direction
  @content_direction
end

The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. Corresponds to the JSON property defaultFooterId

Returns:

  • (String)


4252
4253
4254
# File 'generated/google/apis/docs_v1/classes.rb', line 4252

def default_footer_id
  @default_footer_id
end

#default_header_idString

The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. Corresponds to the JSON property defaultHeaderId

Returns:

  • (String)


4259
4260
4261
# File 'generated/google/apis/docs_v1/classes.rb', line 4259

def default_header_id
  @default_header_id
end

The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages uses the default_footer_id. If unset, the value inherits from the previous SectionBreak' s SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. Corresponds to the JSON property evenPageFooterId

Returns:

  • (String)


4269
4270
4271
# File 'generated/google/apis/docs_v1/classes.rb', line 4269

def even_page_footer_id
  @even_page_footer_id
end

#even_page_header_idString

The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages uses the default_header_id. If unset, the value inherits from the previous SectionBreak' s SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. Corresponds to the JSON property evenPageHeaderId

Returns:

  • (String)


4279
4280
4281
# File 'generated/google/apis/docs_v1/classes.rb', line 4279

def even_page_header_id
  @even_page_header_id
end

The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it is false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. Corresponds to the JSON property firstPageFooterId

Returns:

  • (String)


4290
4291
4292
# File 'generated/google/apis/docs_v1/classes.rb', line 4290

def first_page_footer_id
  @first_page_footer_id
end

#first_page_header_idString

The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it is false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. Corresponds to the JSON property firstPageHeaderId

Returns:

  • (String)


4301
4302
4303
# File 'generated/google/apis/docs_v1/classes.rb', line 4301

def first_page_header_id
  @first_page_header_id
end

#margin_bottomGoogle::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property marginBottom



4306
4307
4308
# File 'generated/google/apis/docs_v1/classes.rb', line 4306

def margin_bottom
  @margin_bottom
end

A magnitude in a single direction in the specified units. Corresponds to the JSON property marginFooter



4311
4312
4313
# File 'generated/google/apis/docs_v1/classes.rb', line 4311

def margin_footer
  @margin_footer
end

#margin_headerGoogle::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property marginHeader



4316
4317
4318
# File 'generated/google/apis/docs_v1/classes.rb', line 4316

def margin_header
  @margin_header
end

#margin_leftGoogle::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property marginLeft



4321
4322
4323
# File 'generated/google/apis/docs_v1/classes.rb', line 4321

def margin_left
  @margin_left
end

#margin_rightGoogle::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property marginRight



4326
4327
4328
# File 'generated/google/apis/docs_v1/classes.rb', line 4326

def margin_right
  @margin_right
end

#margin_topGoogle::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property marginTop



4331
4332
4333
# File 'generated/google/apis/docs_v1/classes.rb', line 4331

def margin_top
  @margin_top
end

#page_number_startFixnum

The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. Corresponds to the JSON property pageNumberStart

Returns:

  • (Fixnum)


4340
4341
4342
# File 'generated/google/apis/docs_v1/classes.rb', line 4340

def page_number_start
  @page_number_start
end

#section_typeString

Output only. The type of section. Corresponds to the JSON property sectionType

Returns:

  • (String)


4345
4346
4347
# File 'generated/google/apis/docs_v1/classes.rb', line 4345

def section_type
  @section_type
end

Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. Corresponds to the JSON property useFirstPageHeaderFooter

Returns:

  • (Boolean)


4355
4356
4357
# File 'generated/google/apis/docs_v1/classes.rb', line 4355

def use_first_page_header_footer
  @use_first_page_header_footer
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
# File 'generated/google/apis/docs_v1/classes.rb', line 4363

def update!(**args)
  @column_properties = args[:column_properties] if args.key?(:column_properties)
  @column_separator_style = args[:column_separator_style] if args.key?(:column_separator_style)
  @content_direction = args[:content_direction] if args.key?(:content_direction)
  @default_footer_id = args[:default_footer_id] if args.key?(:default_footer_id)
  @default_header_id = args[:default_header_id] if args.key?(:default_header_id)
  @even_page_footer_id = args[:even_page_footer_id] if args.key?(:even_page_footer_id)
  @even_page_header_id = args[:even_page_header_id] if args.key?(:even_page_header_id)
  @first_page_footer_id = args[:first_page_footer_id] if args.key?(:first_page_footer_id)
  @first_page_header_id = args[:first_page_header_id] if args.key?(:first_page_header_id)
  @margin_bottom = args[:margin_bottom] if args.key?(:margin_bottom)
  @margin_footer = args[:margin_footer] if args.key?(:margin_footer)
  @margin_header = args[:margin_header] if args.key?(:margin_header)
  @margin_left = args[:margin_left] if args.key?(:margin_left)
  @margin_right = args[:margin_right] if args.key?(:margin_right)
  @margin_top = args[:margin_top] if args.key?(:margin_top)
  @page_number_start = args[:page_number_start] if args.key?(:page_number_start)
  @section_type = args[:section_type] if args.key?(:section_type)
  @use_first_page_header_footer = args[:use_first_page_header_footer] if args.key?(:use_first_page_header_footer)
end