Class: AsposeWordsCloud::UpdateDrawingObjectRequest

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

Overview

Request model for update_drawing_object operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, drawing_object, image_file, node_path, index, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil) ⇒ UpdateDrawingObjectRequest

Initializes a new instance.

Parameters:

  • name

    The document name.

  • drawing_object

    Drawing object parameters.

  • image_file

    File with image.

  • node_path

    Path to the node, which contains collection of drawing objects.

  • index

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

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/aspose_words_cloud/models/requests/update_drawing_object_request.rb', line 83

def initialize(name, drawing_object, image_file, node_path, index, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
  self.name = name
  self.drawing_object = drawing_object
  self.image_file = image_file
  self.node_path = node_path
  self.index = index
  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_nameObject

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.



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

def dest_file_name
  @dest_file_name
end

#drawing_objectObject

Drawing object parameters.



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

def drawing_object
  @drawing_object
end

#folderObject

Original document folder.



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

def folder
  @folder
end

#image_fileObject

File with image.



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

def image_file
  @image_file
end

#indexObject

Object index.



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

def index
  @index
end

#load_encodingObject

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



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

def load_encoding
  @load_encoding
end

#nameObject

The document name.



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

def name
  @name
end

#node_pathObject

Path to the node, which contains collection of drawing objects.



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

def node_path
  @node_path
end

#passwordObject

Password for opening an encrypted document.



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

def password
  @password
end

#revision_authorObject

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.



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

def revision_author
  @revision_author
end

#revision_date_timeObject

The date and time to use for revisions.



66
67
68
# File 'lib/aspose_words_cloud/models/requests/update_drawing_object_request.rb', line 66

def revision_date_time
  @revision_date_time
end

#storageObject

Original document storage.



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

def storage
  @storage
end