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.



1105
1106
1107
# File 'generated/google/apis/docs_v1/classes.rb', line 1105

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

Instance Attribute Details

#backgroundGoogle::Apis::DocsV1::Background

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



996
997
998
# File 'generated/google/apis/docs_v1/classes.rb', line 996

def background
  @background
end

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)


1002
1003
1004
# File 'generated/google/apis/docs_v1/classes.rb', line 1002

def default_footer_id
  @default_footer_id
end

#default_header_idString

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)


1008
1009
1010
# File 'generated/google/apis/docs_v1/classes.rb', line 1008

def default_header_id
  @default_header_id
end

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)


1016
1017
1018
# File 'generated/google/apis/docs_v1/classes.rb', line 1016

def even_page_footer_id
  @even_page_footer_id
end

#even_page_header_idString

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)


1024
1025
1026
# File 'generated/google/apis/docs_v1/classes.rb', line 1024

def even_page_header_id
  @even_page_header_id
end

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)


1033
1034
1035
# File 'generated/google/apis/docs_v1/classes.rb', line 1033

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. 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)


1042
1043
1044
# File 'generated/google/apis/docs_v1/classes.rb', line 1042

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



1047
1048
1049
# File 'generated/google/apis/docs_v1/classes.rb', line 1047

def margin_bottom
  @margin_bottom
end

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



1052
1053
1054
# File 'generated/google/apis/docs_v1/classes.rb', line 1052

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



1057
1058
1059
# File 'generated/google/apis/docs_v1/classes.rb', line 1057

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



1062
1063
1064
# File 'generated/google/apis/docs_v1/classes.rb', line 1062

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



1067
1068
1069
# File 'generated/google/apis/docs_v1/classes.rb', line 1067

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



1072
1073
1074
# File 'generated/google/apis/docs_v1/classes.rb', line 1072

def margin_top
  @margin_top
end

#page_number_startFixnum

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

Returns:

  • (Fixnum)


1077
1078
1079
# File 'generated/google/apis/docs_v1/classes.rb', line 1077

def page_number_start
  @page_number_start
end

#page_sizeGoogle::Apis::DocsV1::Size

A width and height. Corresponds to the JSON property pageSize



1082
1083
1084
# File 'generated/google/apis/docs_v1/classes.rb', line 1082

def page_size
  @page_size
end

Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. Corresponds to the JSON property useCustomHeaderFooterMargins

Returns:

  • (Boolean)


1090
1091
1092
# File 'generated/google/apis/docs_v1/classes.rb', line 1090

def use_custom_header_footer_margins
  @use_custom_header_footer_margins
end

Indicates whether to use the even page header / footer IDs for the even pages. Corresponds to the JSON property useEvenPageHeaderFooter

Returns:

  • (Boolean)


1096
1097
1098
# File 'generated/google/apis/docs_v1/classes.rb', line 1096

def use_even_page_header_footer
  @use_even_page_header_footer
end

Indicates whether to use the first page header / footer IDs for the first page. Corresponds to the JSON property useFirstPageHeaderFooter

Returns:

  • (Boolean)


1102
1103
1104
# File 'generated/google/apis/docs_v1/classes.rb', line 1102

def use_first_page_header_footer
  @use_first_page_header_footer
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
# File 'generated/google/apis/docs_v1/classes.rb', line 1110

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