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

Inherits:
Object
  • Object
show all
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

The styling that applies to a section.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SectionStyle 



5339
5340
5341
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5339

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

Instance Attribute Details

#column_properties ⇒ Array<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 3 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



5193
5194
5195
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5193

def column_properties
  @column_properties
end

#column_separator_style ⇒ String

The style of column separators. This style can be set even when there's 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



5200
5201
5202
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5200

def column_separator_style
  @column_separator_style
end

#content_direction ⇒ String

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



5207
5208
5209
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5207

def content_direction
  @content_direction
end

#default_footer_id ⇒ String

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. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. Corresponds to the JSON property defaultFooterId



5215
5216
5217
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5215

def default_footer_id
  @default_footer_id
end

#default_header_id ⇒ String

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. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. Corresponds to the JSON property defaultHeaderId



5223
5224
5225
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5223

def default_header_id
  @default_header_id
end

#even_page_footer_id ⇒ String

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 use 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. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. Corresponds to the JSON property evenPageFooterId



5234
5235
5236
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5234

def even_page_footer_id
  @even_page_footer_id
end

#even_page_header_id ⇒ String

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 use 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. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. Corresponds to the JSON property evenPageHeaderId



5245
5246
5247
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5245

def even_page_header_id
  @even_page_header_id
end

#first_page_footer_id ⇒ String

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's 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. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. Corresponds to the JSON property firstPageFooterId



5257
5258
5259
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5257

def first_page_footer_id
  @first_page_footer_id
end

#first_page_header_id ⇒ String

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's 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. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. Corresponds to the JSON property firstPageHeaderId



5269
5270
5271
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5269

def first_page_header_id
  @first_page_header_id
end

#flip_page_orientation ⇒ Boolean Also known as: flip_page_orientation?

Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. 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 flipPageOrientation



5279
5280
5281
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5279

def flip_page_orientation
  @flip_page_orientation
end

#margin_bottom ⇒ Google::Apis::DocsV1::Dimension

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



5285
5286
5287
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5285

def margin_bottom
  @margin_bottom
end

#margin_footer ⇒ Google::Apis::DocsV1::Dimension

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



5290
5291
5292
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5290

def margin_footer
  @margin_footer
end

#margin_header ⇒ Google::Apis::DocsV1::Dimension

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



5295
5296
5297
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5295

def margin_header
  @margin_header
end

#margin_left ⇒ Google::Apis::DocsV1::Dimension

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



5300
5301
5302
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5300

def margin_left
  @margin_left
end

#margin_right ⇒ Google::Apis::DocsV1::Dimension

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



5305
5306
5307
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5305

def margin_right
  @margin_right
end

#margin_top ⇒ Google::Apis::DocsV1::Dimension

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



5310
5311
5312
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5310

def margin_top
  @margin_top
end

#page_number_start ⇒ Fixnum

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. If DocumentMode is PAGELESS, this property will not be rendered. 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



5320
5321
5322
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5320

def page_number_start
  @page_number_start
end

#section_type ⇒ String

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



5325
5326
5327
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5325

def section_type
  @section_type
end

#use_first_page_header_footer ⇒ Boolean Also known as: use_first_page_header_footer?

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. If DocumentMode is PAGELESS, this property will not be rendered. 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



5336
5337
5338
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5336

def use_first_page_header_footer
  @use_first_page_header_footer
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5344

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)
  @flip_page_orientation = args[:flip_page_orientation] if args.key?(:flip_page_orientation)
  @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