AsposeCellsCloud-CellsApi
view release on metacpan or search on metacpan
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
}
#
# @return string
#
sub trim_character{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
#
# UpdateWordCaseRequest
#
# Specify changing the text case in a spreadsheet to switch between uppercase, lowercase, capitalizing the first letter of each word, or capitalizing the first letter of a sentence, and adjust the text according to specific needs.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @wordCaseType string (required) Specify text case: Upper Case, Lower Case, Proper Case, Sentence Case.
# @worksheet string Specify the worksheet of spreadsheet.
# @range string Specify the worksheet range of spreadsheet.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'UpdateWordCaseRequest',
description => 'UpdateWordCase Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'update_word_case' } = {
summary => 'Specify changing the text case in a spreadsheet to switch between uppercase, lowercase, capitalizing the first letter of each word, or capitalizing the first letter of a sentence, and adjust the text according to specific needs.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub update_word_case{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
#
# RemoveCharactersRequest
#
# Deletes user-defined characters, predefined symbol sets, or any substring from every cell in the chosen range while preserving formulas, formatting and data-validation.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @removeTextMethod string Specify the removal of text method type.
# @characterSets string Specify the character sets.
# @removeCustomValue string Specify the remove custom value.
# @caseSensitive boolean
# @worksheet string Specify the worksheet of spreadsheet.
# @range string Specify the worksheet range of spreadsheet.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'RemoveCharactersRequest',
description => 'RemoveCharacters Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'remove_characters' } = {
summary => 'Deletes user-defined characters, predefined symbol sets, or any substring from every cell in the chosen range while preserving formulas, formatting and data-validation.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub remove_characters{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
#
# RemoveCharactersByPositionRequest
#
# Deletes characters from every cell in the target range by position (first/last N, before/after a substring, or between two delimiters) while preserving formulas, formatting and data-validation.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @theFirstNCharacters int Specify removing the first n characters from selected cells.
# @theLastNCharacters int Specify removing the last n characters from selected cells.
# @allCharactersBeforeText string Specify using targeted removal options to delete text that is located before certain characters.
# @allCharactersAfterText string Specify using targeted removal options to delete text that is located after certain characters.
# @caseSensitive boolean
# @worksheet string Specify the worksheet of spreadsheet.
# @range string Specify the worksheet range of spreadsheet.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'RemoveCharactersByPositionRequest',
description => 'RemoveCharactersByPosition Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'remove_characters_by_position' } = {
summary => 'Deletes characters from every cell in the target range by position (first/last N, before/after a substring, or between two delimiters) while preserving formulas, formatting and data-validation.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub remove_characters_by_position{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
#
# RemoveDuplicateSubstringsRequest
#
# Finds and removes repeated substrings inside every cell of the chosen range, using user-defined or preset delimiters, while preserving formulas, formatting and data-validation.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @delimiters string (required) comma, semicolon, space, tab, line-break
# @treatConsecutiveDelimitersAsOne boolean collapse adjacent delimiters into a single separator.
# @caseSensitive boolean
# @worksheet string
# @range string
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'RemoveDuplicateSubstringsRequest',
description => 'RemoveDuplicateSubstrings Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'remove_duplicate_substrings' } = {
summary => 'Finds and removes repeated substrings inside every cell of the chosen range, using user-defined or preset delimiters, while preserving formulas, formatting and data-validation.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub remove_duplicate_substrings{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
#
# AddTextRequest
#
# Specify appending text to multiple cells at once, allowing you to add prefixes, suffixes, labels, or any specific characters. You can choose the exact position of the text—in the beginning, at the end, or before or after certain characters in the...
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @text string (required) Specify the added text content.
# @position string (required) Indicates the specific location for adding text content.None, AtTheBeginning, AtTheEnd, BeforeText, AfterText.
# @selectText string Indicates selecting the specific position to add text based on the content of the text.
# @skipEmptyCells boolean Indicates skip empty cells.
# @worksheet string Specify the worksheet of spreadsheet.
# @range string Specify the worksheet range of spreadsheet.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'AddTextRequest',
description => 'AddText Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'add_text' } = {
summary => 'Specify appending text to multiple cells at once, allowing you to add prefixes, suffixes, labels, or any specific characters. You can choose the exact position of the text—in the beginning, at the end, or before or after certain ch...
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub add_text{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
#
# ConvertTextRequest
#
# Indicates converting the numbers stored as text into the correct number format, replacing unwanted characters and line breaks with the desired characters, and converting accented characters to their equivalent characters without accents.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @convertTextType string (required) Indicates the conversion of text type.
# @sourceCharacters string Indicates the source characters.
# @targetCharacters string Indicates the target characters.
# @worksheet string Specify the worksheet of spreadsheet.
# @range string Specify the worksheet range of spreadsheet.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ConvertTextRequest',
description => 'ConvertText Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'convert_text' } = {
summary => 'Indicates converting the numbers stored as text into the correct number format, replacing unwanted characters and line breaks with the desired characters, and converting accented characters to their equivalent characters without acce...
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub convert_text{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
#
# ExtractTextRequest
#
# Indicates extracting substrings, text characters, and numbers from a spreadsheet cell into another cell without having to use complex FIND, MIN, LEFT, or RIGHT formulas.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @extractTextType string (required) Indicates extract text type.
# @outPositionRange string (required) Indicates the output location for the extracted text.
# @beforeText string Indicates extracting the text before the specified characters or substrings.
# @afterText string Indicates extracting the text after the specified characters or substrings.
# @beforePosition int Indicates retrieving the first character or a specified number of characters from the left side of the selected cell.
# @afterPosition int Indicates retrieving the first character or a specified number of characters from the right side of the selected cell.
# @worksheet string Specify the worksheet of spreadsheet.
# @range string Specify the worksheet range of spreadsheet.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ExtractTextRequest',
description => 'ExtractText Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'extract_text' } = {
summary => 'Indicates extracting substrings, text characters, and numbers from a spreadsheet cell into another cell without having to use complex FIND, MIN, LEFT, or RIGHT formulas.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub extract_text{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
#
# SplitTextRequest
#
# Indicates performing text segmentation on the specified area according to the segmentation method, and outputting to the designated interval.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @delimiters string (required) Indicates the custom delimiter.
# @keepDelimitersInResultingCells boolean Indicates keep delimiters in resulting cells.
# @keepDelimitersPosition string Indicates keep delimiters position.
# @HowToSplit string Indicates
# @outPositionRange string Indicates split delimiters type.
# @worksheet string Specify the worksheet of spreadsheet.
# @range string Specify the worksheet range of spreadsheet.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'SplitTextRequest',
description => 'SplitText Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'split_text' } = {
summary => 'Indicates performing text segmentation on the specified area according to the segmentation method, and outputting to the designated interval.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub split_text{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
}
#
# @return string
#
sub remove_spreadsheet_blank_worksheets{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
#
# RemoveDuplicatesRequest
#
# Removes duplicate values in the worksheet/range/table.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @worksheet string The worksheet name.
# @range string Range name that need deduplication.
# @table string Table name that need deduplication.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'RemoveDuplicatesRequest',
description => 'RemoveDuplicates Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'remove_duplicates' } = {
summary => 'Removes duplicate values in the worksheet/range/table.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub remove_duplicates{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
#
# SwapRangeRequest
#
# The Swap Ranges for Excel API provides a powerful tool to move any two columns, rows, ranges, or individual cells within an Excel file. This API allows users to re-arrange their tables quickly and efficiently, ensuring that the original data format...
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @worksheet1 string (required) Specify the worksheet that is the source of the exchange data area.
# @range1 string (required) Specify exchange data source.
# @worksheet2 string (required) Specify the worksheet that is the target of the exchange data area.
# @range2 string (required) Specify exchange data target.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'SwapRangeRequest',
description => 'SwapRange Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'swap_range' } = {
summary => 'The Swap Ranges for Excel API provides a powerful tool to move any two columns, rows, ranges, or individual cells within an Excel file. This API allows users to re-arrange their tables quickly and efficiently, ensuring that the origi...
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub swap_range{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
#
# FlipDataRequest
#
# Transposes a specified data range (rows become columns, columns become rows).
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @worksheet string (required) The worksheet name.
# @cellArea string (required) A specified data range
# @Horizontal boolean Horizontal/Vertical Flip.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'FlipDataRequest',
description => 'FlipData Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'flip_data' } = {
summary => 'Transposes a specified data range (rows become columns, columns become rows).',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub flip_data{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
sub get_worksheet_cell{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
#
# GetWorksheetCellStyleRequest
#
# Retrieve cell style descriptions in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @cellName string (required) Cell`s name.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'GetWorksheetCellStyleRequest',
description => 'GetWorksheetCellStyle Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'get_worksheet_cell_style' } = {
summary => 'Retrieve cell style descriptions in the worksheet.',
params => $params,
returns => 'StyleResponse',
};
}
#
# @return StyleResponse
#
sub get_worksheet_cell_style{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('StyleResponse', $response);
return $_response_object;
}
#
# PostWorksheetCellSetValueRequest
#
# Set cell value using cell name in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @cellName string (required) The cell name.
# @value string The cell value.
# @type string The value type.
# @formula string Formula for cell
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'PostWorksheetCellSetValueRequest',
description => 'PostWorksheetCellSetValue Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_worksheet_cell_set_value' } = {
summary => 'Set cell value using cell name in the worksheet.',
params => $params,
returns => 'CellResponse',
};
}
#
# @return CellResponse
#
sub post_worksheet_cell_set_value{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('CellResponse', $response);
return $_response_object;
}
#
# PostUpdateWorksheetCellStyleRequest
#
# Set cell style using cell name in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @cellName string (required) The cell name.
# @style Style (required) Style with update style settings.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'PostUpdateWorksheetCellStyleRequest',
description => 'PostUpdateWorksheetCellStyle Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_update_worksheet_cell_style' } = {
summary => 'Set cell style using cell name in the worksheet.',
params => $params,
returns => 'CellsCloudResponse',
};
}
#
# @return CellsCloudResponse
#
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub get_cell_html_string{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('string', $response);
return $_response_object;
}
#
# PostSetCellHtmlStringRequest
#
# Set the HTML string containing data and specific formats in this cell.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @cellName string (required) The cell name.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'PostSetCellHtmlStringRequest',
description => 'PostSetCellHtmlString Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_set_cell_html_string' } = {
summary => 'Set the HTML string containing data and specific formats in this cell.',
params => $params,
returns => 'CellsCloudResponse',
};
}
#
# @return CellsCloudResponse
#
sub post_set_cell_html_string{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('CellsCloudResponse', $response);
return $_response_object;
}
#
# PostCellCalculateRequest
#
# Calculate cell formula in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @cellName string (required) The cell name.
# @options CalculationOptions Calculation Options
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'PostCellCalculateRequest',
description => 'PostCellCalculate Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_cell_calculate' } = {
summary => 'Calculate cell formula in the worksheet.',
params => $params,
returns => 'CellsCloudResponse',
};
}
#
# @return CellsCloudResponse
#
sub post_cell_calculate{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('CellsCloudResponse', $response);
return $_response_object;
}
#
# PostCellCharactersRequest
#
# Set cell characters in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @cellName string (required) The cell name.
# @options ARRAY[FontSetting]
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'PostCellCharactersRequest',
description => 'PostCellCharacters Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_cell_characters' } = {
summary => 'Set cell characters in the worksheet.',
params => $params,
returns => 'CellsCloudResponse',
};
}
#
# @return CellsCloudResponse
#
sub post_cell_characters{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('CellsCloudResponse', $response);
return $_response_object;
}
#
# GetWorksheetColumnsRequest
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('ConditionalFormattingResponse', $response);
return $_response_object;
}
#
# PutWorksheetConditionalFormattingRequest
#
# Add conditional formatting in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @formatcondition FormatCondition (required)
# @cellArea string (required) Adds a conditional formatted cell range.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'PutWorksheetConditionalFormattingRequest',
description => 'PutWorksheetConditionalFormatting Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'put_worksheet_conditional_formatting' } = {
summary => 'Add conditional formatting in the worksheet.',
params => $params,
returns => 'CellsCloudResponse',
};
}
#
# @return CellsCloudResponse
#
sub put_worksheet_conditional_formatting{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('CellsCloudResponse', $response);
return $_response_object;
}
#
# PutWorksheetFormatConditionRequest
#
# Add a format condition in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @index int (required) Gets the Conditional Formatting element at the specified index.
# @cellArea string (required) Adds a conditional formatted cell range.
# @type string (required) Format condition type(CellValue/Expression/ColorScale/DataBar/IconSet/Top10/UniqueValues/DuplicateValues/ContainsText/NotContainsText/BeginsWith/EndsWith/ContainsBlanks/NotContainsBlanks/ContainsErrors/NotContainsErrors/Ti...
# @operatorType string (required) Represents the operator type of conditional format and data validation(Between/Equal/GreaterThan/GreaterOrEqual/LessThan/None/NotBetween/NotEqual).
# @formula1 string (required) The value or expression associated with conditional formatting.
# @formula2 string (required) The value or expression associated with conditional formatting.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'PutWorksheetFormatConditionRequest',
description => 'PutWorksheetFormatCondition Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'put_worksheet_format_condition' } = {
summary => 'Add a format condition in the worksheet.',
params => $params,
returns => 'CellsCloudResponse',
};
}
#
# @return CellsCloudResponse
#
sub put_worksheet_format_condition{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('CellsCloudResponse', $response);
return $_response_object;
}
#
# PutWorksheetFormatConditionAreaRequest
#
# Add a cell area for the format condition in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @index int (required) Gets the Conditional Formatting element at the specified index.
# @cellArea string (required) Adds a conditional formatted cell range.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'PutWorksheetFormatConditionAreaRequest',
description => 'PutWorksheetFormatConditionArea Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'put_worksheet_format_condition_area' } = {
summary => 'Add a cell area for the format condition in the worksheet.',
params => $params,
returns => 'CellsCloudResponse',
};
}
#
# @return CellsCloudResponse
#
sub put_worksheet_format_condition_area{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('CellsCloudResponse', $response);
return $_response_object;
}
#
# PutWorksheetFormatConditionConditionRequest
#
# Add a condition for the format condition in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @index int (required) Gets the Conditional Formatting element at the specified index.
# @type string (required) Format condition type(CellValue/Expression/ColorScale/DataBar/IconSet/Top10/UniqueValues/DuplicateValues/ContainsText/NotContainsText/BeginsWith/EndsWith/ContainsBlanks/NotContainsBlanks/ContainsErrors/NotContainsErrors/Ti...
# @operatorType string (required) Represents the operator type of conditional format and data validation(Between/Equal/GreaterThan/GreaterOrEqual/LessThan/None/NotBetween/NotEqual).
# @formula1 string (required) The value or expression associated with conditional formatting.
# @formula2 string (required) The value or expression associated with conditional formatting.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'PutWorksheetFormatConditionConditionRequest',
description => 'PutWorksheetFormatConditionCondition Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'put_worksheet_format_condition_condition' } = {
summary => 'Add a condition for the format condition in the worksheet.',
params => $params,
returns => 'CellsCloudResponse',
};
}
#
# @return CellsCloudResponse
#
sub put_worksheet_format_condition_condition{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('CellsCloudResponse', $response);
return $_response_object;
}
#
# DeleteWorksheetConditionalFormattingsRequest
#
# Clear all conditional formattings in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'DeleteWorksheetConditionalFormattingsRequest',
description => 'DeleteWorksheetConditionalFormattings Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'delete_worksheet_conditional_formattings' } = {
summary => 'Clear all conditional formattings in the worksheet.',
params => $params,
returns => 'CellsCloudResponse',
};
}
#
# @return CellsCloudResponse
#
sub delete_worksheet_conditional_formattings{
my ($self, %args) = @_;
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
__PACKAGE__->method_documentation->{ 'post_convert_workbook' } = {
summary => '',
params => $params,
returns => 'FileInfo',
};
}
#
# @return FileInfo
#
sub post_convert_workbook{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('FileInfo', $response);
return $_response_object;
}
#
# CheckWrokbookExternalReferenceRequest
#
# Export Excel internal elements or the workbook itself to various format files.
#
# @checkExternalReferenceOptions CheckExternalReferenceOptions (required)
#
{
my $params = {
'request' =>{
data_type => 'CheckWrokbookExternalReferenceRequest',
description => 'CheckWrokbookExternalReference Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'check_wrokbook_external_reference' } = {
summary => 'Export Excel internal elements or the workbook itself to various format files.',
params => $params,
returns => 'CheckedExternalReferenceResponse',
};
}
#
# @return CheckedExternalReferenceResponse
#
sub check_wrokbook_external_reference{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('CheckedExternalReferenceResponse', $response);
return $_response_object;
}
#
# CheckWorkbookFormulaErrorsRequest
#
#
#
# @formulaErrorOptions CheckFormulaErrorOptions (required)
#
{
my $params = {
'request' =>{
data_type => 'CheckWorkbookFormulaErrorsRequest',
description => 'CheckWorkbookFormulaErrors Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'check_workbook_formula_errors' } = {
summary => '',
params => $params,
returns => 'CheckedFormulaErrorsResponse',
};
}
#
# @return CheckedFormulaErrorsResponse
#
sub check_workbook_formula_errors{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('CheckedFormulaErrorsResponse', $response);
return $_response_object;
}
#
# PostExportRequest
#
# Export Excel internal elements or the workbook itself to various format files.
#
# @File string (required) File to upload
# @objectType string Exported object type:workbook/worksheet/chart/comment/picture/shape/listobject/oleobject.
# @format string The conversion format(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers).
# @password string The password needed to open an Excel file.
# @checkExcelRestriction boolean Whether check restriction of excel file when user modify cells related objects.
# @region string The regional settings for workbook.
# @FontsLocation string Use Custom fonts.
#
{
my $params = {
'request' =>{
data_type => 'PostExportRequest',
description => 'PostExport Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_export' } = {
summary => 'Export Excel internal elements or the workbook itself to various format files.',
params => $params,
returns => 'FilesResult',
};
}
#
# @return FilesResult
#
sub post_export{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('FilesResult', $response);
return $_response_object;
}
#
# PostWorkbookExportXMLRequest
#
# Export XML data from an Excel file.When there are XML Maps in an Excel file, export XML data. When there is no XML map in the Excel file, convert the Excel file to an XML file.
#
# @name string (required) The file name.
# @password string The password needed to open an Excel file.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
}
};
__PACKAGE__->method_documentation->{ 'post_convert_text' } = {
summary => 'Enhance Excel data through essential text conversions: convert text to numbers, replace characters and line breaks, and remove accents.',
params => $params,
returns => 'FileInfo',
};
}
#
# @return FileInfo
#
sub post_convert_text{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('FileInfo', $response);
return $_response_object;
}
#
# PostRemoveDuplicatesRequest
#
# Efficiently remove duplicate substrings from Excel cells. Select a range, specify delimiters, and apply options to eliminate repeated text segments.
#
# @removeDuplicatesOptions RemoveDuplicatesOptions (required)
#
{
my $params = {
'request' =>{
data_type => 'PostRemoveDuplicatesRequest',
description => 'PostRemoveDuplicates Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_remove_duplicates' } = {
summary => 'Efficiently remove duplicate substrings from Excel cells. Select a range, specify delimiters, and apply options to eliminate repeated text segments.',
params => $params,
returns => 'FileInfo',
};
}
#
# @return FileInfo
#
sub post_remove_duplicates{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('FileInfo', $response);
return $_response_object;
}
#
# PostExtractTextRequest
#
# Effortlessly extract text and numbers from Excel cells with precise options. This API allows extraction of first/last characters, text between delimiters, and numbers from strings, with output as static values or formulas.
#
# @extractTextOptions ExtractTextOptions (required)
#
{
my $params = {
'request' =>{
data_type => 'PostExtractTextRequest',
description => 'PostExtractText Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_extract_text' } = {
summary => 'Effortlessly extract text and numbers from Excel cells with precise options. This API allows extraction of first/last characters, text between delimiters, and numbers from strings, with output as static values or formulas.',
params => $params,
returns => 'FileInfo',
};
}
#
# @return FileInfo
#
sub post_extract_text{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('FileInfo', $response);
return $_response_object;
}
#
# PostSplitTextRequest
#
# Efficiently divides Excel cell content into columns or rows based on specified delimiters or patterns. Supports Character-based splitting, Custom string splitting, Mask and wildcard splitting for pattern-based division, Line break division, Column ...
#
# @splitTextOptions SplitTextOptions (required)
#
{
my $params = {
'request' =>{
data_type => 'PostSplitTextRequest',
description => 'PostSplitText Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_split_text' } = {
summary => 'Efficiently divides Excel cell content into columns or rows based on specified delimiters or patterns. Supports Character-based splitting, Custom string splitting, Mask and wildcard splitting for pattern-based division, Line break di...
params => $params,
returns => 'FileInfo',
};
}
#
# @return FileInfo
#
sub post_split_text{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('FileInfo', $response);
return $_response_object;
}
#
# GetWorkbookDefaultStyleRequest
#
# Retrieve the description of the default style for the workbook .
#
# @name string (required) The file name.
# @folder string The folder where the file is situated.
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
#
sub put_workbook_create{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('CellsCloudResponse', $response);
return $_response_object;
}
#
# PostWorkbookSplitRequest
#
# Split the workbook with a specific format.
#
# @name string (required) The file name.
# @format string Split format.
# @outFolder string
# @from int Start worksheet index.
# @to int End worksheet index.
# @horizontalResolution int Image horizontal resolution.
# @verticalResolution int Image vertical resolution.
# @splitNameRule string rule name : sheetname newguid
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
# @outStorageName string
#
{
my $params = {
'request' =>{
data_type => 'PostWorkbookSplitRequest',
description => 'PostWorkbookSplit Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_workbook_split' } = {
summary => 'Split the workbook with a specific format.',
params => $params,
returns => 'SplitResultResponse',
};
}
#
# @return SplitResultResponse
#
sub post_workbook_split{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('SplitResultResponse', $response);
return $_response_object;
}
#
# PostWorkbookCalculateFormulaRequest
#
# Calculate all formulas in the workbook.
#
# @name string (required) The file name.
# @options CalculationOptions CalculationOptions Calculation Options.
# @ignoreError boolean ignore Error.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'PostWorkbookCalculateFormulaRequest',
description => 'PostWorkbookCalculateFormula Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_workbook_calculate_formula' } = {
summary => 'Calculate all formulas in the workbook.',
params => $params,
returns => 'CellsCloudResponse',
};
}
#
# @return CellsCloudResponse
#
sub post_workbook_calculate_formula{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('CellsCloudResponse', $response);
return $_response_object;
}
#
# PostAutofitWorkbookRowsRequest
#
# Autofit rows in the workbook.
#
# @name string (required) The file name.
# @startRow int Start row.
# @endRow int End row.
# @onlyAuto boolean Only auto.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
# @firstColumn int First column index.
# @lastColumn int Last column index.
#
{
my $params = {
'request' =>{
data_type => 'PostAutofitWorkbookRowsRequest',
description => 'PostAutofitWorkbookRows Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_autofit_workbook_rows' } = {
summary => 'Autofit rows in the workbook.',
params => $params,
returns => 'CellsCloudResponse',
};
}
#
# @return CellsCloudResponse
#
sub post_autofit_workbook_rows{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('CellsCloudResponse', $response);
return $_response_object;
}
#
# PostAutofitWorkbookColumnsRequest
#
# Autofit columns in the workbook.
#
# @name string (required)
# @startColumn int The start column index.
# @endColumn int The end column index.
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
params => $params,
returns => 'MergedCellsResponse',
};
}
#
# @return MergedCellsResponse
#
sub get_worksheet_merged_cells{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('MergedCellsResponse', $response);
return $_response_object;
}
#
# GetWorksheetMergedCellRequest
#
# Retrieve description of a merged cell by its index in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) Worksheet name.
# @mergedCellIndex int (required) Merged cell index.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'GetWorksheetMergedCellRequest',
description => 'GetWorksheetMergedCell Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'get_worksheet_merged_cell' } = {
summary => 'Retrieve description of a merged cell by its index in the worksheet.',
params => $params,
returns => 'MergedCellResponse',
};
}
#
# @return MergedCellResponse
#
sub get_worksheet_merged_cell{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('MergedCellResponse', $response);
return $_response_object;
}
#
# GetWorksheetCalculateFormulaRequest
#
# Calculate formula in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @formula string (required) The formula.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'GetWorksheetCalculateFormulaRequest',
description => 'GetWorksheetCalculateFormula Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'get_worksheet_calculate_formula' } = {
summary => 'Calculate formula in the worksheet.',
params => $params,
returns => 'SingleValueResponse',
};
}
#
# @return SingleValueResponse
#
sub get_worksheet_calculate_formula{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('SingleValueResponse', $response);
return $_response_object;
}
#
# PostWorksheetCalculateFormulaRequest
#
# Calculate formula in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) Worksheet name.
# @formula string (required) The formula.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'PostWorksheetCalculateFormulaRequest',
description => 'PostWorksheetCalculateFormula Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_worksheet_calculate_formula' } = {
summary => 'Calculate formula in the worksheet.',
params => $params,
returns => 'SingleValueResponse',
};
}
#
# @return SingleValueResponse
#
sub post_worksheet_calculate_formula{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('SingleValueResponse', $response);
return $_response_object;
}
#
# PostWorksheetTextSearchRequest
#
# Search for text in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @text string (required) Text to search.
# @folder string Original workbook folder.
# @storageName string Storage name.
#
{
my $params = {
'request' =>{
data_type => 'PostWorksheetTextSearchRequest',
description => 'PostWorksheetTextSearch Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_worksheet_text_search' } = {
summary => 'Search for text in the worksheet.',
params => $params,
returns => 'TextItemsResponse',
};
}
#
# @return TextItemsResponse
#
sub post_worksheet_text_search{
my ($self, %args) = @_;
my $request = $args{'request'};
my $response = $request->run_http_request('client' => $self->{api_client} );
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('TextItemsResponse', $response);
return $_response_object;
}
#
# PostWorksheetTextReplaceRequest
#
# Replace old text with new text in the worksheet.
#
# @name string (required) The file name.
# @sheetName string (required) Worksheet name.
# @oldValue string (required) The old text to replace.
# @newValue string (required) The new text to replace by.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
( run in 0.841 second using v1.01-cache-2.11-cpan-cd2fffc590a )