Class: AsposeWordsCloud::InsertHeaderFooterRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/requests/InsertHeaderFooterRequest.rb

Overview

Request model for insert_header_footer operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, header_footer_type, section_path, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil) ⇒ InsertHeaderFooterRequest

Initializes a new instance.

Parameters:

  • name —

    The document name.

  • header_footer_type —

    Type of header/footer.

  • section_path —

    Path to parent section.

  • folder (defaults to: nil) —

    Original document folder.

  • storage (defaults to: nil) —

    Original document storage.

  • load_encoding (defaults to: nil) —

    Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

  • password (defaults to: nil) —

    Password for opening an encrypted document.

  • dest_file_name (defaults to: nil) —

    Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.

  • revision_author (defaults to: nil) —

    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 (defaults to: nil) —

    The date and time to use for revisions.



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/aspose_words_cloud/models/requests/InsertHeaderFooterRequest.rb', line 68

def initialize(name, header_footer_type, section_path, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
   self.name = name
   self.header_footer_type = header_footer_type
   self.section_path = section_path
   self.folder = folder
   self.storage = storage
   self.load_encoding = load_encoding
   self.password = password
   self.dest_file_name = dest_file_name
   self.revision_author = revision_author
   self.revision_date_time = revision_date_time
end

Instance Attribute Details

#dest_file_name ⇒ Object

Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.



50
51
52
 
# File 'lib/aspose_words_cloud/models/requests/InsertHeaderFooterRequest.rb', line 50

def dest_file_name
  @dest_file_name
end

#folder ⇒ Object

Original document folder.



42
43
44
 
# File 'lib/aspose_words_cloud/models/requests/InsertHeaderFooterRequest.rb', line 42

def folder
  @folder
end

#header_footer_type ⇒ Object

Type of header/footer.



38
39
40
 
# File 'lib/aspose_words_cloud/models/requests/InsertHeaderFooterRequest.rb', line 38

def header_footer_type
  @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.



46
47
48
 
# File 'lib/aspose_words_cloud/models/requests/InsertHeaderFooterRequest.rb', line 46

def load_encoding
  @load_encoding
end

#name ⇒ Object

The document name.



36
37
38
 
# File 'lib/aspose_words_cloud/models/requests/InsertHeaderFooterRequest.rb', line 36

def name
  @name
end

#password ⇒ Object

Password for opening an encrypted document.



48
49
50
 
# File 'lib/aspose_words_cloud/models/requests/InsertHeaderFooterRequest.rb', line 48

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.



52
53
54
 
# File 'lib/aspose_words_cloud/models/requests/InsertHeaderFooterRequest.rb', line 52

def revision_author
  @revision_author
end

#revision_date_time ⇒ Object

The date and time to use for revisions.



54
55
56
 
# File 'lib/aspose_words_cloud/models/requests/InsertHeaderFooterRequest.rb', line 54

def revision_date_time
  @revision_date_time
end

#section_path ⇒ Object

Path to parent section.



40
41
42
 
# File 'lib/aspose_words_cloud/models/requests/InsertHeaderFooterRequest.rb', line 40

def section_path
  @section_path
end

#storage ⇒ Object

Original document storage.



44
45
46
 
# File 'lib/aspose_words_cloud/models/requests/InsertHeaderFooterRequest.rb', line 44

def storage
  @storage
end