Class: AsposeWordsCloud::SplitDocumentRequest

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

Overview

Request model for split_document operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Initializes a new instance.

Parameters:

  • name —

    Original document name.

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

  • format (defaults to: nil) —

    Format to split.

  • from (defaults to: nil) —

    Start page.

  • to (defaults to: nil) —

    End page.

  • zip_output (defaults to: nil) —

    ZipOutput or not.

  • fonts_location (defaults to: nil) —

    Folder in filestorage with custom fonts.



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/aspose_words_cloud/models/requests/SplitDocumentRequest.rb', line 71

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



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

def dest_file_name
  @dest_file_name
end

#folder ⇒ Object

Original document folder.



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

def folder
  @folder
end

#fonts_location ⇒ Object

Folder in filestorage with custom fonts.



56
57
58
 
# File 'lib/aspose_words_cloud/models/requests/SplitDocumentRequest.rb', line 56

def fonts_location
  @fonts_location
end

#format ⇒ Object

Format to split.



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

def format
  @format
end

#from ⇒ Object

Start page.



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

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.



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

def load_encoding
  @load_encoding
end

#name ⇒ Object

Original document name.



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

def name
  @name
end

#password ⇒ Object

Password for opening an encrypted document.



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

def password
  @password
end

#storage ⇒ Object

Original document storage.



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

def storage
  @storage
end

#to ⇒ Object

End page.



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

def to
  @to
end

#zip_output ⇒ Object

ZipOutput or not.



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

def zip_output
  @zip_output
end