This is UltimateRPA Documentation
urpa.AppExcel Class Reference

A class representing MS Excel. More...

Inheritance diagram for urpa.AppExcel:
urpa.App

Public Member Functions

def active_workbook (self)
 This method returns an active workbook in an MS Excel application. More...
 
def active_worksheet (self)
 This method returns an active sheet in an MS Excel application. More...
 
def workbooks (self)
 This method returns a list of all open workbooks in an MS Excel application. More...
 
def add_workbook (self)
 This method adds a new workbook to an MS Excel application. More...
 
def open (self, filename)
 This method opens the MS Excel workbook with the name passed. More...
 
- Public Member Functions inherited from urpa.App
def find_first (self, condition, timeout=default_timeout)
 This method returns the application's first GUI element that meets the conditions defined in the condition parameter. More...
 
def find_all (self, condition, elements=0, timeout=default_timeout)
 This method returns a list of all GUI elements meeting the condition parameter. More...
 
def find_first_right_to (self, condition_reference_element, condition_right_element, timeout=default_timeout, height=50, step=30)
 This method looks for a GUI element matching the condition_right_element parameter and located to the right of the reference GUI element matching the condition_reference_element parameter. More...
 
def find_first_left_to (self, condition_reference_element, condition_left_element, timeout=default_timeout, height=50, step=30)
 This method looks for a GUI element matching the condition_left_element parameter and located to the left of the reference GUI element matching the condition_reference_element parameter. More...
 
def find_first_down_to (self, condition_reference_element, condition_down_element, timeout=default_timeout, width=50, step=30)
 This method looks for a GUI element matching the condition_down_element parameter and located down from the reference GUI element matching the condition_reference_element parameter. More...
 
def find_first_up_to (self, condition_reference_element, condition_up_element, timeout=default_timeout, width=50, step=30)
 This method looks for a GUI element matching the condition_up_element parameter and located above the reference GUI element matching the condition_reference_element parameter. More...
 
def find_from_point (self, condition_reference_element, condition, x, y, timeout=default_timeout)
 This method looks for a GUI element matching the condition parameter and located in the position of the virtual point defined by offsetting (via the parameters x, y) the upper left corner of a GUI element matching the condition_reference_element parameter. More...
 
def close (self, timeout=600)
 This method closes the application tied to the App class process. More...
 
def set_auto_close (self, auto_close)
 This method sets the internal App class flag, according to which the automatic (non-)closure of a process tied to an instance of the App class is controlled at the end of the simulation. More...
 
def resize_tp_window (self, condition, rect, timeout=default_timeout)
 This method changes the position and size of a TP window associated with a GUI element matching the condition parameter. More...
 
def process_id (self)
 This method returns the ID of a process tied to an instance of the App class. More...
 
def process_name (self)
 This method returns the name of a process tied to an instance of the App class. More...
 

Detailed Description

A class representing MS Excel.

This class contains methods that allow you to manage workbooks and their components in an MS Excel application.

Member Function Documentation

◆ active_workbook()

def urpa.AppExcel.active_workbook (   self)

This method returns an active workbook in an MS Excel application.

Returns
Returns an ExcelWorkbook-type object; if no active workbook exists, it returns None.

◆ active_worksheet()

def urpa.AppExcel.active_worksheet (   self)

This method returns an active sheet in an MS Excel application.

Returns
Returns an ExcelWorksheet-type object; if no active sheet exists, it returns None.

◆ add_workbook()

def urpa.AppExcel.add_workbook (   self)

This method adds a new workbook to an MS Excel application.

Returns
Returns an ExcelWorkbook-type object tied to a newly created MS Excel workbook.

◆ open()

def urpa.AppExcel.open (   self,
  filename 
)

This method opens the MS Excel workbook with the name passed.

Parameters
filenameString The path and title for the MS Excel workbook to be opened (need not contain a suffix).
Returns
Returns an ExcelWorkbook-type object tied to a newly opened MS Excel workbook.

◆ workbooks()

def urpa.AppExcel.workbooks (   self)

This method returns a list of all open workbooks in an MS Excel application.

Returns
Returns a list of ExcelWorkbook-type objects.

The documentation for this class was generated from the following file: