This is UltimateRPA Documentation
urpa.Condition Class Reference

This class is used to define conditions for GUI element searches. More...

Inheritance diagram for urpa.Condition:
urpa.ConditionFactory

Additional Inherited Members

- Public Member Functions inherited from urpa.ConditionFactory
def java (self, value=None)
 
def regexp (self, re)
 This method returns a Condition-type object that has the condition of the regular expression redeclared for the internal attributes Name, Value, Automation ID, and Class Name. More...
 
def exact (self, val)
 This method returns a Condition-type object that has validation set to the val parameter for the internal attributes Name, Value, Automation ID, and Class Name. More...
 
def size (self, x, y)
 This method returns a Condition-type object that has validation set to parameters x and y for the internal attribute Size. More...
 
def min_size (self, x, y)
 This method returns a Condition-type object that has validation set to parameters x and y for the internal attribute Size. More...
 
def max_size (self, x, y)
 This method returns a Condition-type object that has validation set to parameters x and y for the internal attribute Size. More...
 
def name (self, val)
 This method returns a Condition-type object that has validation set to the val parameter for the internal attribute Name. More...
 
def value (self, val)
 This method returns a Condition-type object that has validation set to the val parameter for the internal attribute Value. More...
 
def item_type (self, val)
 This method returns a Condition-type object that has validation set to the val parameter for the internal attribute Item Type. More...
 
def access_key (self, val)
 This method returns a Condition-type object that has validation set to the val parameter for the internal attribute Access Key. More...
 
def automation_id (self, val)
 This method returns a Condition-type object that has validation set to the val parameter for the internal attribute Automation ID. More...
 
def class_name (self, val)
 This method returns a Condition-type object that has validation set to the val parameter for the internal attribute Class Name. More...
 
def enabled (self, val)
 This method returns a Condition-type object that has validation set to the val parameter for the internal attribute Enabled. More...
 
def button (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Button" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def calendar (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Control" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def check_box (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "CheckBox" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def combo_box (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "ComboBox" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def edit (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Edit" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def hyperlink (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Hyperlink" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def image (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Image" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def list_item (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "ListItem" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def list (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "List" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def menu (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Menu" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def menu_bar (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "MenBar" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def menu_item (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "MenuItem" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def progress_bar (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "ProgressBar" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def radio_button (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "RadioButton" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def scroll_bar (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "ScrollBar" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def slider (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Slider" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def spinner (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Spinner" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def status_bar (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "StatusBar" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def tab (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Tab" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def tab_item (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "TabItem" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def text (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Text" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def tool_bar (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "ToolBar" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def tool_tip (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "ToolTip" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def tree (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Tree" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def tree_item (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "TreeItem" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def custom (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Custom" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def group (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Group" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def thumb (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Thumb" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def data_grid (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "DataGrid" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def data_item (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "DataItem" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def document (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Document" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def split_button (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "SplitButton" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def window (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Window" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def pane (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Pane" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def header (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Header" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def header_item (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "HeaderItem" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def table (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Table" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def title_bar (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "TitleBar" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def separator (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "Separator" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def semantic_zoom (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "SemanticZoom" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 
def app_bar (self, val=None)
 This method returns a Condition-type object that has the Control Type attribute set to "AppBar" and the Name, Value, Automation ID, and Class Name attributes set to val. More...
 

Detailed Description

This class is used to define conditions for GUI element searches.

An instance of this class is used as a parameter in the App and AppElement methods. An instance of this class is created using the ConditionFactory class - see urpa.condition_factory(). Each instance of this class contains the internal variables Name, Value, Control Type, Item Type, Access Key, Automation ID, Class Name, and Size. For the internal variables Name, Value, Item Type, Access Key, Automation ID, and Class Name, the validation mode may be set to an exact match or to a match with a regular expression using the methods

For the internal variables Size and Control Type, the validation mode may only be set to an exact match. For the internal variable Control Type, the value may only be set "directly" by invoking one of these methods

For the internal variable Size, the value may be set by invoking one of these methods


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