Class: AsposeWordsCloud::UpdateBorderRequest

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

Overview

Request model for update_border operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, border_properties, node_path, border_type, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil) ⇒ UpdateBorderRequest

Initializes a new instance.

Parameters:

  • name —

    The document name.

  • border_properties —

    Border properties.

  • node_path —

    Path to the node with border(node should be paragraph, cell or row).

  • border_type —

    Border type.

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



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

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

#border_properties ⇒ Object

Border properties.



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

def border_properties
  @border_properties
end

#border_type ⇒ Object

Border type.



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

def border_type
  @border_type
end

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



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

def dest_file_name
  @dest_file_name
end

#folder ⇒ Object

Original document folder.



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

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.



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

def load_encoding
  @load_encoding
end

#name ⇒ Object

The document name.



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

def name
  @name
end

#node_path ⇒ Object

Path to the node with border(node should be paragraph, cell or row).



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

def node_path
  @node_path
end

#password ⇒ Object

Password for opening an encrypted document.



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

def password
  @password
end

#revision_author ⇒ Object

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.



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

def revision_author
  @revision_author
end

#revision_date_time ⇒ Object

The date and time to use for revisions.



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

def revision_date_time
  @revision_date_time
end

#storage ⇒ Object

Original document storage.



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

def storage
  @storage
end