Condition Factory

def by_automation_id(
    self,
    automation_id: str,
    condition_flags_property_condition_flags: PropertyConditionFlags = PropertyConditionFlags.None_,
) -> PropertyCondition:
    """Creates a condition to search by an automation id.

    :param automation_id: Automation ID
    :param condition_flags_property_condition_flags: Contains values used in creating property conditions, defaults to PropertyConditionFlags.none
    :return: Property Condition
    """
    return PropertyCondition(
        cs_condition=self.raw_cf.ByAutomationId(automation_id, condition_flags_property_condition_flags.value)
    )

def by_class_name(
    self,
    class_name: Union[str, KnownClassNames],
    condition_flags_property_condition_flags: PropertyConditionFlags = PropertyConditionFlags.None_,
) -> PropertyCondition:
    """Creates a condition to search by a class name.

    :param class_name: Class Name
    :param condition_flags_property_condition_flags: Contains values used in creating property conditions, defaults to PropertyConditionFlags.none
    :return: Property Condition
    """
    return PropertyCondition(
        cs_condition=self.raw_cf.ByClassName(
            class_name if isinstance(class_name, str) else class_name.value,
            condition_flags_property_condition_flags.value,
        )
    )

def by_control_type(self, control_type: ControlType) -> PropertyCondition:
    """Creates a condition to search by a ControlType.

    :param control_type: Types of controls in Microsoft UI Automation.
    :return: Property Condition
    """
    return PropertyCondition(cs_condition=self.raw_cf.ByControlType(control_type.value))

def by_framework_id(
    self,
    framework_id: str,
    condition_flags_property_condition_flags: PropertyConditionFlags = PropertyConditionFlags.None_,
) -> PropertyCondition:
    """Creates a condition to search by a Framework Id.

    :param framework_id: Framework ID
    :param condition_flags_property_condition_flags: Contains values used in creating property conditions, defaults to PropertyConditionFlags.none
    :return: Property Condition
    """
    return PropertyCondition(
        cs_condition=self.raw_cf.ByFrameworkId(framework_id, condition_flags_property_condition_flags.value)
    )

def by_framework_type(self, framework_type: FrameworkType) -> PropertyCondition:
    """Creates a condition to search by a Framework Type.

    :param framework_type: Framework Type
    :return: Property Condition
    """
    return PropertyCondition(cs_condition=self.raw_cf.ByFrameworkType(framework_type.value))

def by_help_text(
    self,
    help_text: str,
    condition_flags_property_condition_flags: PropertyConditionFlags = PropertyConditionFlags.None_,
) -> PropertyCondition:
    """Creates a condition to search by a help text.

    :param help_text: Help text
    :param condition_flags_property_condition_flags: Contains values used in creating property conditions, defaults to PropertyConditionFlags.none
    :return: Property Condition
    """
    return PropertyCondition(
        cs_condition=self.raw_cf.ByHelpText(help_text, condition_flags_property_condition_flags.value)
    )

def by_localized_control_type(
    self,
    localized_control_type: str,
    condition_flags_property_condition_flags: PropertyConditionFlags = PropertyConditionFlags.None_,
) -> PropertyCondition:
    """Creates a condition to search by a localized control type.

    :param localized_control_type: Localized Control Type
    :param condition_flags_property_condition_flags: Contains values used in creating property conditions, defaults to PropertyConditionFlags.none
    :return: Property Condition
    """
    return PropertyCondition(
        cs_condition=self.raw_cf.ByLocalizedControlType(
            localized_control_type, condition_flags_property_condition_flags.value
        )
    )

def by_name(
    self, name: str, condition_flags_property_condition_flags: PropertyConditionFlags = PropertyConditionFlags.None_
) -> PropertyCondition:
    """Creates a condition to search by a name.

    :param name: Name
    :param condition_flags_property_condition_flags: Contains values used in creating property conditions, defaults to PropertyConditionFlags.none
    :return: Property Condition
    """
    return PropertyCondition(cs_condition=self.raw_cf.ByName(name, condition_flags_property_condition_flags.value))

def by_process_id(self, process_id: int) -> PropertyCondition:
    """Creates a condition to search by a process id.

    :param process_id: Process ID
    :return: Property Condition
    """
    return PropertyCondition(cs_condition=self.raw_cf.ByProcessId(process_id))

def by_text(
    self, text: str, condition_flags_property_condition_flags: PropertyConditionFlags = PropertyConditionFlags.None_
) -> PropertyCondition:
    """Creates a condition to search by a text.

    :param text: Text value
    :param condition_flags_property_condition_flags: Contains values used in creating property conditions, defaults to PropertyConditionFlags.none
    :return: Property Condition
    """
    return PropertyCondition(cs_condition=self.raw_cf.ByText(text, condition_flags_property_condition_flags.value))

def by_value(
    self,
    value: str,
    condition_flags_property_condition_flags: PropertyConditionFlags = PropertyConditionFlags.None_,
) -> PropertyCondition:
    """Creates a condition to search by a value.

    :param value: Value
    :param condition_flags_property_condition_flags: Contains values used in creating property conditions, defaults to PropertyConditionFlags.none
    :return: Property Condition
    """
    return PropertyCondition(
        cs_condition=self.raw_cf.ByValue(value, condition_flags_property_condition_flags.value)
    )

def grid(self) -> PropertyCondition:
    """Searches for a DataGrid/List.

    :return: Property Condition
    """
    return PropertyCondition(cs_condition=self.raw_cf.Grid())

def horizontal_scroll_bar(self) -> PropertyCondition:
    """Searches for a horizontal scrollbar.

    :return: Property Condition
    """
    return PropertyCondition(cs_condition=self.raw_cf.HorizontalScrollBar())

def menu(self) -> PropertyCondition:
    """Searches for a Menu/MenuBar.

    :return: Property Condition
    """
    return PropertyCondition(cs_condition=self.raw_cf.ByControlType(ControlType.Menu.value)).Or(
        self.raw_cf.ByControlType(ControlType.MenuBar.value)
    )

def vertical_scroll_bar(self) -> PropertyCondition:
    """Searches for a vertical scrollbar.

    :return: Property Condition
    """
    return PropertyCondition(cs_condition=self.raw_cf.VerticalScrollBar())