Class: Google::Apis::DocsV1::DocumentStyle

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 style of the document.

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

Returns a new instance of DocumentStyle



937
938
939
 
# File 'generated/google/apis/docs_v1/classes.rb', line 937

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

Instance Attribute Details

#background ⇒ Google::Apis::DocsV1::Background

Represents the background of a document. Corresponds to the JSON property background

Returns:



839
840
841
 
# File 'generated/google/apis/docs_v1/classes.rb', line 839

def background
  @background
end

#default_footer_id ⇒ String

The ID of the default footer. If not set, there is no default footer. This property is read-only. Corresponds to the JSON property defaultFooterId

Returns:

  • (String) 


845
846
847
 
# File 'generated/google/apis/docs_v1/classes.rb', line 845

def default_footer_id
  @default_footer_id
end

#default_header_id ⇒ String

The ID of the default header. If not set, there is no default header. This property is read-only. Corresponds to the JSON property defaultHeaderId

Returns:

  • (String) 


851
852
853
 
# File 'generated/google/apis/docs_v1/classes.rb', line 851

def default_header_id
  @default_header_id
end

#even_page_footer_id ⇒ String

The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there is no even page footer. This property is read-only. Corresponds to the JSON property evenPageFooterId

Returns:

  • (String) 


860
861
862
 
# File 'generated/google/apis/docs_v1/classes.rb', line 860

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. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there is no even page header. This property is read-only. Corresponds to the JSON property evenPageHeaderId

Returns:

  • (String) 


869
870
871
 
# File 'generated/google/apis/docs_v1/classes.rb', line 869

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. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there is no first page footer. This property is read-only. Corresponds to the JSON property firstPageFooterId

Returns:

  • (String) 


879
880
881
 
# File 'generated/google/apis/docs_v1/classes.rb', line 879

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. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there is no first page header. This property is read-only. Corresponds to the JSON property firstPageHeaderId

Returns:

  • (String) 


889
890
891
 
# File 'generated/google/apis/docs_v1/classes.rb', line 889

def first_page_header_id
  @first_page_header_id
end

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

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

Returns:



894
895
896
 
# File 'generated/google/apis/docs_v1/classes.rb', line 894

def margin_bottom
  @margin_bottom
end

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

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

Returns:



899
900
901
 
# File 'generated/google/apis/docs_v1/classes.rb', line 899

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

Returns:



904
905
906
 
# File 'generated/google/apis/docs_v1/classes.rb', line 904

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

Returns:



909
910
911
 
# File 'generated/google/apis/docs_v1/classes.rb', line 909

def margin_top
  @margin_top
end

#page_number_start ⇒ Fixnum

The page number from which to start counting the number of pages. Corresponds to the JSON property pageNumberStart

Returns:

  • (Fixnum) 


914
915
916
 
# File 'generated/google/apis/docs_v1/classes.rb', line 914

def page_number_start
  @page_number_start
end

#page_size ⇒ Google::Apis::DocsV1::Size

A width and height. Corresponds to the JSON property pageSize

Returns:



919
920
921
 
# File 'generated/google/apis/docs_v1/classes.rb', line 919

def page_size
  @page_size
end

#use_even_page_header_footer ⇒ Boolean Also known as: use_even_page_header_footer?

Indicates whether to use the even page header / footer IDs for the even pages. This property is read-only. Corresponds to the JSON property useEvenPageHeaderFooter

Returns:

  • (Boolean) 


926
927
928
 
# File 'generated/google/apis/docs_v1/classes.rb', line 926

def use_even_page_header_footer
  @use_even_page_header_footer
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. This property is read-only. Corresponds to the JSON property useFirstPageHeaderFooter

Returns:

  • (Boolean) 


934
935
936
 
# File 'generated/google/apis/docs_v1/classes.rb', line 934

def use_first_page_header_footer
  @use_first_page_header_footer
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'generated/google/apis/docs_v1/classes.rb', line 942

def update!(**args)
  @background = args[:background] if args.key?(:background)
  @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_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)
  @page_size = args[:page_size] if args.key?(:page_size)
  @use_even_page_header_footer = args[:use_even_page_header_footer] if args.key?(:use_even_page_header_footer)
  @use_first_page_header_footer = args[:use_first_page_header_footer] if args.key?(:use_first_page_header_footer)
end