Class: AsposeWordsCloud::GetHeaderFootersRequest

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

Overview

Request model for get_header_footers operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, section_path, folder = nil, storage = nil, load_encoding = nil, password = nil, filter_by_type = nil) ⇒ GetHeaderFootersRequest

Initializes a new instance.

Parameters:

  • name —

    The document name.

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

  • filter_by_type (defaults to: nil) —

    List of types of headers and footers.



63
64
65
66
67
68
69
70
71
 
# File 'lib/aspose_words_cloud/models/requests/get_header_footers_request.rb', line 63

def initialize(name, section_path, folder = nil, storage = nil, load_encoding = nil, password = nil, filter_by_type = nil)
  self.name = name
  self.section_path = section_path
  self.folder = folder
  self.storage = storage
  self.load_encoding = load_encoding
  self.password = password
  self.filter_by_type = filter_by_type
end

Instance Attribute Details

#filter_by_type ⇒ Object

List of types of headers and footers.



51
52
53
 
# File 'lib/aspose_words_cloud/models/requests/get_header_footers_request.rb', line 51

def filter_by_type
  @filter_by_type
end

#folder ⇒ Object

Original document folder.



39
40
41
 
# File 'lib/aspose_words_cloud/models/requests/get_header_footers_request.rb', line 39

def folder
  @folder
end

#load_encoding ⇒ Object

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



45
46
47
 
# File 'lib/aspose_words_cloud/models/requests/get_header_footers_request.rb', line 45

def load_encoding
  @load_encoding
end

#name ⇒ Object

The document name.



33
34
35
 
# File 'lib/aspose_words_cloud/models/requests/get_header_footers_request.rb', line 33

def name
  @name
end

#password ⇒ Object

Password for opening an encrypted document.



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

def password
  @password
end

#section_path ⇒ Object

Path to parent section.



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

def section_path
  @section_path
end

#storage ⇒ Object

Original document storage.



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

def storage
  @storage
end