Class: AsposeWordsCloud::SplitDocumentRequest

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

Overview

Request model for split_document operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, format, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, from = nil, to = nil, zip_output = nil, fonts_location = nil) ⇒ SplitDocumentRequest

Initializes a new instance.

Parameters:

  • name —

    The filename of the input document.

  • format —

    The format to split.

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

  • from (defaults to: nil) —

    The start page.

  • to (defaults to: nil) —

    The end page.

  • zip_output (defaults to: nil) —

    The flag indicating whether to ZIP the output.

  • fonts_location (defaults to: nil) —

    Folder in filestorage with custom fonts.



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/aspose_words_cloud/models/requests/split_document_request.rb', line 79

def initialize(name, format, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, from = nil, to = nil, zip_output = nil, fonts_location = nil)
  self.name = name
  self.format = format
  self.folder = folder
  self.storage = storage
  self.load_encoding = load_encoding
  self.password = password
  self.dest_file_name = dest_file_name
  self.from = from
  self.to = to
  self.zip_output = zip_output
  self.fonts_location = fonts_location
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.



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

def dest_file_name
  @dest_file_name
end

#folder ⇒ Object

Original document folder.



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

def folder
  @folder
end

#fonts_location ⇒ Object

Folder in filestorage with custom fonts.



63
64
65
 
# File 'lib/aspose_words_cloud/models/requests/split_document_request.rb', line 63

def fonts_location
  @fonts_location
end

#format ⇒ Object

The format to split.



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

def format
  @format
end

#from ⇒ Object

The start page.



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

def from
  @from
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/split_document_request.rb', line 45

def load_encoding
  @load_encoding
end

#name ⇒ Object

The filename of the input document.



33
34
35
 
# File 'lib/aspose_words_cloud/models/requests/split_document_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/split_document_request.rb', line 48

def password
  @password
end

#storage ⇒ Object

Original document storage.



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

def storage
  @storage
end

#to ⇒ Object

The end page.



57
58
59
 
# File 'lib/aspose_words_cloud/models/requests/split_document_request.rb', line 57

def to
  @to
end

#zip_output ⇒ Object

The flag indicating whether to ZIP the output.



60
61
62
 
# File 'lib/aspose_words_cloud/models/requests/split_document_request.rb', line 60

def zip_output
  @zip_output
end