aspose_cells_cloud 23.9 → 23.10

data/lib/aspose_cells_cloud/models/m_html_save_options.rb

@@ -31,29 +31,29 @@ require 'date'
 module AsposeCellsCloud
 
   class MHtmlSaveOptions
-        #            
+        #The directory that the attached files will be saved to.  Only for saving to html stream.            
         attr_accessor :attached_files_directory
-        #            
+        #Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.            
         attr_accessor :attached_files_url_prefix
-        #            
+        #If not set,use Encoding.UTF8 as default enconding type.            
         attr_accessor :encoding
-        #            
+        #Indicates if exporting the whole workbook to html file.            
         attr_accessor :export_active_worksheet_only
-        #            
+        #Get or set the format of chart image before exporting            
         attr_accessor :export_chart_image_format
-        #            
+        #Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.            
         attr_accessor :export_images_as_base64
-        #            
+        #Hidden column(the width of this column is 0) in excel,before save this into                html format, if HtmlHiddenColDisplayType is "Remove",the hidden column would               ont been output, if the value is "Hidden", the column would been output,but was hidden,the default value is "Hidden"            
         attr_accessor :hidden_col_display_type
-        #            
+        #Hidden row(the height of this row is 0) in excel,before save this into html                format, if HtmlHiddenRowDisplayType is "Remove",the hidden row would ont               been output, if the value is "Hidden", the row would been output,but was               hidden,the default value is "Hidden"            
         attr_accessor :hidden_row_display_type
-        #            
+        #Indicates if a cross-cell string will be displayed in the same way as MS               Excel when saving an Excel file in html format.  By default the value is               Default, so, for cross-cell strings, there is little difference between the               html files created by Aspose.Cells and MS Excel. But the performance for               creating large html files,setting the value to Cross would be several times               faster than setting it to Default or Fit2Cell.            
         attr_accessor :html_cross_string_type
-        #            
+        #Indicates if export image files to temp directory.  Only for saving to html  stream.            
         attr_accessor :is_exp_image_to_temp_dir
-        #            
+        #The title of the html page.  Only for saving to html stream.            
         attr_accessor :page_title
-        #            
+        #Parse html tag in cell,like ,as cell value,or as html tag,default is true            
         attr_accessor :parse_html_tag_in_cell
         #            
         attr_accessor :save_format

data/lib/aspose_cells_cloud/models/markdown_save_options.rb

@@ -31,11 +31,11 @@ require 'date'
 module AsposeCellsCloud
 
   class MarkdownSaveOptions
-        #            
+        #Gets and sets the default encoding.            
         attr_accessor :encoding
-        #            
+        #The Data provider to provide cells data for saving workbook in light mode.            
         attr_accessor :format_strategy
-        #            
+        #Gets and sets the line separator.            
         attr_accessor :line_separator
         #            
         attr_accessor :save_format

data/lib/aspose_cells_cloud/models/marker.rb

@@ -31,13 +31,13 @@ require 'date'
 module AsposeCellsCloud
 
   class Marker
-        #            
+        #Gets the border.            
         attr_accessor :border
-        #            
+        #Gets the area.            
         attr_accessor :area
-        #            
+        #Represents the marker size in unit of points. Applies to line chart, scatter chart, or radar chart.            
         attr_accessor :marker_size
-        #            
+        #Represents the marker style. Applies to line chart, scatter chart, or radar chart.            
         attr_accessor :marker_style
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/match_condition_request.rb

@@ -31,9 +31,9 @@ require 'date'
 module AsposeCellsCloud
 
   class MatchConditionRequest
-        #            
+        #Regex Pattern.            
         attr_accessor :regex_pattern
-        #            
+        #Name list.            
         attr_accessor :full_match_conditions
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/name.rb

@@ -31,19 +31,19 @@ require 'date'
 module AsposeCellsCloud
 
   class Name
-        #            
+        #Gets and sets the comment of the name.                        Only applies for Excel 2007.            
         attr_accessor :comment
         #            
         attr_accessor :worksheet_index
-        #            
+        #Indicates whether this name is referred by other formulas.            
         attr_accessor :is_referred
-        #            
+        #Indicates whether the name is visible.            
         attr_accessor :is_visible
-        #            
+        #Gets or sets a R1C1 reference of the .            
         attr_accessor :r1_c1_refers_to
-        #            
+        #Returns or sets the formula that the name is defined to refer to, beginning with an equal sign.            
         attr_accessor :refers_to
-        #            
+        #Gets the name text of the object.            
         attr_accessor :text
         #            
         attr_accessor :link

data/lib/aspose_cells_cloud/models/negative_bar_format.rb

@@ -31,13 +31,13 @@ require 'date'
 module AsposeCellsCloud
 
   class NegativeBarFormat
-        #Gets or sets a FormatColor object that you can use to specify the border   color for negative data bars.                        
+        #Gets or sets a FormatColor object that you can use to specify the border color for negative data bars.             
         attr_accessor :border_color
-        #Gets whether to use the same border color as positive data bars.                        
+        #Gets whether to use the same border color as positive data bars.             
         attr_accessor :border_color_type
-        #Gets or sets a FormatColor object that you can use to specify the fill color   for negative data bars.                        
+        #Gets or sets a FormatColor object that you can use to specify the fill color for negative data bars.             
         attr_accessor :color
-        #Gets or sets whether to use the same fill color as positive data bars.            
+        #Gets or sets whether to use the same fill color as positive data bars.             
         attr_accessor :color_type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/ole_object.rb

@@ -31,19 +31,19 @@ require 'date'
 module AsposeCellsCloud
 
   class OleObject
-        #            
+        #True if the specified object is displayed as an icon                         and the image will not be auto changed.            
         attr_accessor :display_as_icon
-        #            
+        #Gets and sets the file type of the embedded ole object data            
         attr_accessor :file_format_type
-        #            
+        #Gets or sets the path and name of the source file for the linked image.            
         attr_accessor :image_source_full_name
-        #            
+        #True indicates that the size of the ole object will be auto changed as the size of snapshot of the embedded content                        when the ole object is activated.            
         attr_accessor :is_auto_size
-        #            
+        #Returns true if the OleObject links to the file.            
         attr_accessor :is_link
-        #            
+        #Gets or sets the ProgID of the OLE object.            
         attr_accessor :prog_id
-        #            
+        #Returns the source full name of the source file for the linked OLE object.            
         attr_accessor :source_full_name
         #            
         attr_accessor :name

data/lib/aspose_cells_cloud/models/ooxml_save_options.rb

@@ -31,15 +31,15 @@ require 'date'
 module AsposeCellsCloud
 
   class OoxmlSaveOptions
-        #            
+        #Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file.               If the output file may be accessed by SQL Server DTS, this value must be               true.  Setting the value to false will highly increase the performance and               reduce the file size when creating large file.  Default value is false.            
         attr_accessor :export_cell_name
-        #            
+        #Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.            
         attr_accessor :update_zoom
-        #            
+        #Always use ZIP64 extensions when writing zip archives, even when unnecessary.            
         attr_accessor :enable_zip64
-        #            
+        #Indicates whether embedding Ooxml files of OleObject as ole object.            
         attr_accessor :embed_ooxml_as_ole_object
-        #            
+        #Gets and sets the compression type for ooxml file.            
         attr_accessor :compression_type
         #            
         attr_accessor :save_format

data/lib/aspose_cells_cloud/models/page_setup.rb

@@ -31,73 +31,73 @@ require 'date'
 module AsposeCellsCloud
 
   class PageSetup
-        #            
+        #Represents if elements of the document will be printed in black and white.            
         attr_accessor :black_and_white
-        #            
+        #Represents the size of the bottom margin, in unit of centimeters.            
         attr_accessor :bottom_margin
-        #            
+        #Represent if the sheet is printed centered horizontally.            
         attr_accessor :center_horizontally
-        #            
+        #Represent if the sheet is printed centered vertically.            
         attr_accessor :center_vertically
-        #            
+        #Represents the first page number that will be used when this sheet is printed.            
         attr_accessor :first_page_number
-        #            
+        #Represents  the number of pages tall the worksheet will be scaled to when it's printed.                        The default value is 1.            
         attr_accessor :fit_to_pages_tall
-        #            
+        #Represents the number of pages wide the worksheet will be scaled to when it's printed.                        The default value is 1.            
         attr_accessor :fit_to_pages_wide
-        #            
+        #Represents the distance from the bottom of the page to the footer, in unit of centimeters.            
         attr_accessor :footer_margin
-        #            
+        #Represents the distance from the top of the page to the header, in unit of centimeters.            
         attr_accessor :header_margin
-        #            
+        #Indicates whether the first the page number is automatically assigned.            
         attr_accessor :is_auto_first_page_number
-        #            
+        #Indicates whether header and footer margins are aligned with the page margins.                        If this property is true, the left header and footer will be aligned with the left margin,                        and the right header and footer will be aligned with the right margin.                        This option is enabled by default.            
         attr_accessor :is_hf_align_margins
-        #            
+        #True means that the header/footer of the first page is different with other pages.            
         attr_accessor :is_hf_diff_first
-        #            
+        #True means that the header/footer of the odd pages is different with odd pages.            
         attr_accessor :is_hf_diff_odd_even
-        #            
+        #Indicates whether header and footer are scaled with document scaling.                        Only applies for Excel 2007.            
         attr_accessor :is_hf_scale_with_doc
-        #            
+        #If this property is False, the FitToPagesWide and FitToPagesTall properties control how the worksheet is scaled.            
         attr_accessor :is_percent_scale
-        #            
+        #Represents the size of the left margin, in unit of centimeters.            
         attr_accessor :left_margin
-        #            
+        #Represents the order that Microsoft Excel uses to number pages when printing a large worksheet.            
         attr_accessor :order
-        #            
+        #Represents page print orientation.            
         attr_accessor :orientation
-        #            
+        #Represents the size of the paper.            
         attr_accessor :paper_size
-        #            
+        #Represents the range to be printed.            
         attr_accessor :print_area
-        #            
+        #Represents the way comments are printed with the sheet.            
         attr_accessor :print_comments
-        #            
+        #Get and sets number of copies to print.            
         attr_accessor :print_copies
-        #            
+        #Represents if the sheet will be printed without graphics.            
         attr_accessor :print_draft
-        #            
+        #Specifies the type of print error displayed.            
         attr_accessor :print_errors
-        #            
+        #Represents if cell gridlines are printed on the page.            
         attr_accessor :print_gridlines
-        #            
+        #Represents if row and column headings are printed with this page.            
         attr_accessor :print_headings
-        #            
+        #Represents the print quality.            
         attr_accessor :print_quality
-        #            
+        #Represents the columns that contain the cells to be repeated on the left side of each page.            
         attr_accessor :print_title_columns
-        #            
+        #Represents the rows that contain the cells to be repeated at the top of each page.            
         attr_accessor :print_title_rows
-        #            
+        #Represents the size of the right margin, in unit of centimeters.            
         attr_accessor :right_margin
-        #            
+        #Represents the size of the top margin, in unit of centimeters.            
         attr_accessor :top_margin
-        #            
+        #Represents the scaling factor in percent. It should be between 10 and 400.            
         attr_accessor :zoom
-        #            
+        #Represents the page header.            
         attr_accessor :header
-        #            
+        #Represents the page footor.            
         attr_accessor :footer
         #            
         attr_accessor :link

data/lib/aspose_cells_cloud/models/password_request.rb

@@ -31,7 +31,7 @@ require 'date'
 module AsposeCellsCloud
 
   class PasswordRequest
-        #            
+        #Password.            
         attr_accessor :password
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/paste_options.rb

@@ -31,13 +31,13 @@ require 'date'
 module AsposeCellsCloud
 
   class PasteOptions
-        #            
+        #True means only copying visible cells.             
         attr_accessor :only_visible_cells
-        #            
+        #The paste special type.             
         attr_accessor :paste_type
-        #            
+        #Indicates whether skips blank cells.             
         attr_accessor :skip_blanks
-        #            
+        #True to transpose rows and columns when the range is pasted. The default value is False.             
         attr_accessor :transpose
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/pattern_fill.rb

@@ -31,19 +31,19 @@ require 'date'
 module AsposeCellsCloud
 
   class PatternFill
-        #            
+        #Gets or sets the fill pattern type             
         attr_accessor :pattern
-        #            
+        #Gets and sets the foreground  object.             
         attr_accessor :background_cells_color
-        #            
+        #Gets and sets the foreground  object.             
         attr_accessor :foreground_cells_color
-        #            
+        #Gets or sets the foreground .             
         attr_accessor :foreground_color
-        #            
+        #Gets or sets the background  of the .             
         attr_accessor :background_color
-        #            
+        #Gets or sets the transparency of background color.             
         attr_accessor :back_transparency
-        #            
+        #Gets or sets the transparency of foreground color.             
         attr_accessor :fore_transparency
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/pdf_save_options.rb

@@ -31,43 +31,43 @@ require 'date'
 module AsposeCellsCloud
 
   class PdfSaveOptions
-        #            
+        #Indicates whether the window's title bar should display the document title.            
         attr_accessor :display_doc_title
-        #            
+        #Indicates whether to export document structure.            
         attr_accessor :export_document_structure
-        #            
+        #Setting for rendering Emf metafile.            
         attr_accessor :emf_render_setting
-        #            
+        #Specifies the way CustomDocumentPropertyCollection are exported to PDF file.            
         attr_accessor :custom_properties_export
-        #            
+        #Gets and sets pdf optimization type.            
         attr_accessor :optimization_type
-        #            
+        #Gets and sets producer of generated pdf document.            
         attr_accessor :producer
-        #            
+        #Indicate the compression algorithm.            
         attr_accessor :pdf_compression
-        #            
+        #Gets or sets embedded font encoding in pdf.            
         attr_accessor :font_encoding
-        #            
+        #Gets or sets watermark to output.            
         attr_accessor :watermark
-        #            
+        #Indicates whether calculate formulas before saving pdf file.The default value is false.            
         attr_accessor :calculate_formula
-        #            
+        #Indicates whether check font compatibility for every character in text.                The default value is true.  Disable this property may give better performance.                 But when the default or specified font of text/character cannot be used                to render it, unreadable characters(such as block) maybe occur in the generated                pdf.  For such situation user should keep this property as true so that alternative                font can be searched and used to render the text instead;            
         attr_accessor :check_font_compatibility
-        #            
+        #Workbook converts to pdf will according to PdfCompliance in this property.            
         attr_accessor :compliance
-        #            
+        #When characters in the Excel are unicode and not be set with correct font in cell style,              They may appear as block in pdf,image.  Set the DefaultFont such as MingLiu or MS Gothic to show these characters.               If this property is not set, Aspose.Cells will use system default font to show these unicode characters.            
         attr_accessor :default_font
-        #            
+        #If OnePagePerSheet is true , all content of one sheet will output to only            one page in result. The paper size of pagesetup will be invalid, and the               other settings of pagesetup will still take effect.            
         attr_accessor :one_page_per_sheet
-        #            
+        #Indicates which pages will not be printed.            
         attr_accessor :printing_page_type
-        #            
+        #Set this options, when security is need in xls2pdf result.            
         attr_accessor :security_options
-        #            
+        #Set desired PPI(pixels per inch) of resample images and jpeg quality  All images will be converted to JPEG with the specified quality setting, and images that are greater than the specified PPI (pixels per inch) will be resampled.              Desired pixels per inch. 220 high quality. 150 screen quality. 96 email quality.            
         attr_accessor :desired_ppi
-        #            
+        #Set desired PPI(pixels per inch) of resample images and jpeg quality  All images will be converted to JPEG with the specified quality setting, and images that are greater than the specified PPI (pixels per inch) will be resampled.              0 - 100% JPEG quality.            
         attr_accessor :jpeg_quality
-        #            
+        #Represents the image type when converting the chart and shape .            
         attr_accessor :image_type
         #            
         attr_accessor :save_format

data/lib/aspose_cells_cloud/models/pic_format_option.rb

@@ -31,17 +31,17 @@ require 'date'
 module AsposeCellsCloud
 
   class PicFormatOption
-        #            
+        #Gets or sets the picture fill type.             
         attr_accessor :type
-        #            
+        #Gets or sets how many the picture stack and scale with.             
         attr_accessor :scale
-        #            
+        #Gets or sets the left offset for stretching picture.             
         attr_accessor :left
-        #            
+        #Gets or sets the right offset for stretching picture.             
         attr_accessor :right
-        #            
+        #Gets or sets the top offset for stretching picture.             
         attr_accessor :top
-        #            
+        #Gets or sets the bottom offset for stretching picture.             
         attr_accessor :bottom
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/picture.rb

@@ -31,17 +31,17 @@ require 'date'
 module AsposeCellsCloud
 
   class Picture
-        #            
+        #Represents the  of the border line of a picture.            
         attr_accessor :border_line_color
-        #            
+        #Gets or sets the weight of the border line of a picture in units of pt.            
         attr_accessor :border_weight
-        #            
+        #Gets the original height of the picture.            
         attr_accessor :original_height
-        #            
+        #Gets the original width of the picture.            
         attr_accessor :original_width
         #            
         attr_accessor :image_format
-        #            
+        #Gets or sets the path and name of the source file for the linked image.            
         attr_accessor :source_full_name
         #            
         attr_accessor :name

data/lib/aspose_cells_cloud/models/pivot_table_field_request.rb

@@ -31,7 +31,7 @@ require 'date'
 module AsposeCellsCloud
 
   class PivotTableFieldRequest
-        #            
+        #Intdex array.            
         attr_accessor :data
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/plot_area.rb

@@ -31,13 +31,13 @@ require 'date'
 module AsposeCellsCloud
 
   class PlotArea
-        #            
+        #Gets or sets the height of plot area in units of 1/4000 of the chart area.            
         attr_accessor :inner_height
-        #            
+        #Gets or sets the width  of plot area in units of 1/4000 of the chart area.            
         attr_accessor :inner_width
-        #            
+        #Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.            
         attr_accessor :inner_x
-        #            
+        #Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.            
         attr_accessor :inner_y
         #            
         attr_accessor :area

data/lib/aspose_cells_cloud/models/{protect_workbook_requst.rb → protect_workbook_request.rb}

@@ -1,6 +1,6 @@
 =begin
 --------------------------------------------------------------------------------------------------------------------
- <copyright company="Aspose" file="ProtectWorkbookRequstrb.cs">
+ <copyright company="Aspose" file="ProtectWorkbookRequestrb.cs">
    Copyright (c) 2023 Aspose.Cells Cloud
  </copyright>
  <summary>
@@ -30,24 +30,24 @@ require 'date'
 
 module AsposeCellsCloud
 
-  class ProtectWorkbookRequst
-        #            
-        attr_accessor :aways_open_only_ready
-        #            
+  class ProtectWorkbookRequest
+        #Indicates aways open read-only.            
+        attr_accessor :aways_open_read_only
+        #Indicates encrypt with password.            
         attr_accessor :encrypt_with_password
-        #            
+        #Represents the various types of protection options available for a worksheet.                        
         attr_accessor :protect_current_sheet
-        #            
+        #Indicates protect workbook structure. All, Contents, Objects, Scenarios, Structure, Windows, and None.            
         attr_accessor :protect_workbook_structure
-        #            
+        #Indicates signature in file.            
         attr_accessor :digital_signature
-        #            
+        #Indicates mark as final.            
         attr_accessor :mark_as_final
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'aways_open_only_ready' => :'AwaysOpenOnlyReady',
+        :'aways_open_read_only' => :'AwaysOpenReadOnly',
         :'encrypt_with_password' => :'EncryptWithPassword',
         :'protect_current_sheet' => :'ProtectCurrentSheet',
         :'protect_workbook_structure' => :'ProtectWorkbookStructure',
@@ -59,7 +59,7 @@ module AsposeCellsCloud
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'aways_open_only_ready' => :'BOOLEAN',
+        :'aways_open_read_only' => :'BOOLEAN',
         :'encrypt_with_password' => :'String',
         :'protect_current_sheet' => :'Protection',
         :'protect_workbook_structure' => :'String',
@@ -76,8 +76,8 @@ module AsposeCellsCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes.has_key?(:'AwaysOpenOnlyReady')
-          self.aways_open_only_ready = attributes[:'AwaysOpenOnlyReady']
+      if attributes.has_key?(:'AwaysOpenReadOnly')
+          self.aways_open_read_only = attributes[:'AwaysOpenReadOnly']
       end
       if attributes.has_key?(:'EncryptWithPassword')
           self.encrypt_with_password = attributes[:'EncryptWithPassword']
@@ -101,8 +101,8 @@ module AsposeCellsCloud
     # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @aways_open_only_ready.nil?
-          invalid_properties.push("invalid value for 'aways_open_only_ready', aways_open_only_ready cannot be nil.")
+      if @aways_open_read_only.nil?
+          invalid_properties.push("invalid value for 'aways_open_read_only', aways_open_read_only cannot be nil.")
       end
       if @encrypt_with_password.nil?
           invalid_properties.push("invalid value for 'encrypt_with_password', encrypt_with_password cannot be nil.")
@@ -126,7 +126,7 @@ module AsposeCellsCloud
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @aways_open_only_ready.nil?
+      return false if @aways_open_read_only.nil?
       return false if @encrypt_with_password.nil?
       return false if @protect_current_sheet.nil?
       return false if @protect_workbook_structure.nil?
@@ -140,7 +140,7 @@ module AsposeCellsCloud
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          aways_open_only_ready == o.aways_open_only_ready &&
+          aways_open_read_only == o.aways_open_read_only &&
           encrypt_with_password == o.encrypt_with_password &&
           protect_current_sheet == o.protect_current_sheet &&
           protect_workbook_structure == o.protect_workbook_structure &&
@@ -158,7 +158,7 @@ module AsposeCellsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [ aways_open_only_ready , encrypt_with_password , protect_current_sheet , protect_workbook_structure , digital_signature , mark_as_final ].hash
+      [ aways_open_read_only , encrypt_with_password , protect_current_sheet , protect_workbook_structure , digital_signature , mark_as_final ].hash
     end
 
     # Builds the object from hash