Class: AsposeWordsCloud::GetHeaderFooterOfSectionRequest

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

Overview

Request model for get_header_footer_of_section operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, header_footer_index, section_index, folder = nil, storage = nil, load_encoding = nil, password = nil, filter_by_type = nil) ⇒ GetHeaderFooterOfSectionRequest

Initializes a new instance.

Parameters:

  • name

    The document name.

  • header_footer_index

    Header/footer index.

  • section_index

    Section index.

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



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

def initialize(name, header_footer_index, section_index, folder = nil, storage = nil, load_encoding = nil, password = nil, filter_by_type = nil)
   self.name = name
   self.header_footer_index = header_footer_index
   self.section_index = section_index
   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_typeObject

List of types of headers and footers.



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

def filter_by_type
  @filter_by_type
end

#folderObject

Original document folder.



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

def folder
  @folder
end

Header/footer index.



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

def header_footer_index
  @header_footer_index
end

#load_encodingObject

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/GetHeaderFooterOfSectionRequest.rb', line 46

def load_encoding
  @load_encoding
end

#nameObject

The document name.



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

def name
  @name
end

#passwordObject

Password for opening an encrypted document.



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

def password
  @password
end

#section_indexObject

Section index.



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

def section_index
  @section_index
end

#storageObject

Original document storage.



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

def storage
  @storage
end