Class: WordsRubySdk::PutHeaderFooterRequest
- Inherits:
-
Object
- Object
- WordsRubySdk::PutHeaderFooterRequest
- Defined in:
- lib/words_ruby_sdk/models/requests/PutHeaderFooterRequest.rb
Overview
Request model for put_header_footer operation.
Instance Attribute Summary collapse
-
#dest_file_name ⇒ Object
Result name of the document after the operation.
-
#folder ⇒ Object
Original document folder.
-
#header_footer_type ⇒ Object
Type of header/footer.
-
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
-
#name ⇒ Object
The document name.
-
#password ⇒ Object
Password for opening an encrypted document.
-
#revision_author ⇒ Object
Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
-
#revision_date_time ⇒ Object
The date and time to use for revisions.
-
#section_path ⇒ Object
Path to parent section.
-
#storage ⇒ Object
File storage, which have to be used.
Instance Method Summary collapse
-
#initialize(name, header_footer_type, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, section_path = nil) ⇒ PutHeaderFooterRequest
constructor
Initializes a new instance.
Constructor Details
#initialize(name, header_footer_type, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, section_path = nil) ⇒ PutHeaderFooterRequest
Initializes a new instance.
68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/words_ruby_sdk/models/requests/PutHeaderFooterRequest.rb', line 68 def initialize(name, , folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, = nil, revision_date_time = nil, section_path = nil) self.name = name self. = self.folder = folder self.storage = storage self.load_encoding = load_encoding self.password = password self.dest_file_name = dest_file_name self. = self.revision_date_time = revision_date_time self.section_path = section_path end |
Instance Attribute Details
#dest_file_name ⇒ Object
Result name of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
48 49 50 |
# File 'lib/words_ruby_sdk/models/requests/PutHeaderFooterRequest.rb', line 48 def dest_file_name @dest_file_name end |
#folder ⇒ Object
Original document folder.
40 41 42 |
# File 'lib/words_ruby_sdk/models/requests/PutHeaderFooterRequest.rb', line 40 def folder @folder end |
#header_footer_type ⇒ Object
Type of header/footer.
38 39 40 |
# File 'lib/words_ruby_sdk/models/requests/PutHeaderFooterRequest.rb', line 38 def @header_footer_type end |
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
44 45 46 |
# File 'lib/words_ruby_sdk/models/requests/PutHeaderFooterRequest.rb', line 44 def load_encoding @load_encoding end |
#name ⇒ Object
The document name.
36 37 38 |
# File 'lib/words_ruby_sdk/models/requests/PutHeaderFooterRequest.rb', line 36 def name @name end |
#password ⇒ Object
Password for opening an encrypted document.
46 47 48 |
# File 'lib/words_ruby_sdk/models/requests/PutHeaderFooterRequest.rb', line 46 def password @password end |
#revision_author ⇒ Object
Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
50 51 52 |
# File 'lib/words_ruby_sdk/models/requests/PutHeaderFooterRequest.rb', line 50 def @revision_author end |
#revision_date_time ⇒ Object
The date and time to use for revisions.
52 53 54 |
# File 'lib/words_ruby_sdk/models/requests/PutHeaderFooterRequest.rb', line 52 def revision_date_time @revision_date_time end |
#section_path ⇒ Object
Path to parent section.
54 55 56 |
# File 'lib/words_ruby_sdk/models/requests/PutHeaderFooterRequest.rb', line 54 def section_path @section_path end |
#storage ⇒ Object
File storage, which have to be used.
42 43 44 |
# File 'lib/words_ruby_sdk/models/requests/PutHeaderFooterRequest.rb', line 42 def storage @storage end |