Class InkToolbar
Defines the ballpoint pen flyout components of the InkToolbar.
Implements
Inherited Members
Namespace: Legerity.Windows.Elements.Core
Assembly: Legerity.Windows.dll
Syntax
public class InkToolbar : WindowsElementWrapper, IElementWrapper<WindowsElement>
Constructors
| Improve this Doc View SourceInkToolbar(WindowsElement)
Initializes a new instance of the InkToolbar class.
Declaration
public InkToolbar(WindowsElement element)
Parameters
| Type | Name | Description |
|---|---|---|
| WindowsElement | element | The |
Properties
| Improve this Doc View SourceBallpointPenButton
Gets the element associated with the ballpoint pen button.
Declaration
public virtual RadioButton BallpointPenButton { get; }
Property Value
| Type | Description |
|---|---|
| RadioButton |
BallpointPenFlyout
Gets the element associated with the ballpoint pen flyout.
Declaration
public virtual InkToolbar.InkToolbarBallpointPenFlyout BallpointPenFlyout { get; }
Property Value
| Type | Description |
|---|---|
| InkToolbar.InkToolbarBallpointPenFlyout |
Remarks
This is only available when the ballpoint pen button is selected.
HighlighterButton
Gets the element associated with the highlighter button.
Declaration
public virtual RadioButton HighlighterButton { get; }
Property Value
| Type | Description |
|---|---|
| RadioButton |
HighlighterFlyout
Gets the element associated with the highlighter flyout.
Declaration
public virtual InkToolbar.InkToolbarHighlighterFlyout HighlighterFlyout { get; }
Property Value
| Type | Description |
|---|---|
| InkToolbar.InkToolbarHighlighterFlyout |
Remarks
This is only available when the highlighter button is selected.
PencilButton
Gets the element associated with the pencil button.
Declaration
public virtual RadioButton PencilButton { get; }
Property Value
| Type | Description |
|---|---|
| RadioButton |
PencilFlyout
Gets the element associated with the pencil flyout.
Declaration
public virtual InkToolbar.InkToolbarPencilFlyout PencilFlyout { get; }
Property Value
| Type | Description |
|---|---|
| InkToolbar.InkToolbarPencilFlyout |
Remarks
This is only available when the pencil button is selected.
RulerButton
Gets the element associated with the ruler button.
Declaration
public virtual ToggleButton RulerButton { get; }
Property Value
| Type | Description |
|---|---|
| ToggleButton |
SelectedBallpointPenColor
Gets the currently selected ballpoint pen color.
Declaration
public virtual string SelectedBallpointPenColor { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
SelectedHighlighterColor
Gets the currently selected highlighter color.
Declaration
public virtual string SelectedHighlighterColor { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
SelectedPencilColor
Gets the currently selected pencil color.
Declaration
public virtual string SelectedPencilColor { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Methods
| Improve this Doc View SourceOpenBallpointPenFlyout()
Opens the ballpoint pen flyout.
Declaration
public virtual void OpenBallpointPenFlyout()
Exceptions
| Type | Condition |
|---|---|
| ElementNotShownException | Thrown when an element is not shown for the expected locator. |
OpenHighlighterFlyout()
Opens the pencil flyout.
Declaration
public virtual void OpenHighlighterFlyout()
Exceptions
| Type | Condition |
|---|---|
| ElementNotShownException | Thrown when an element is not shown for the expected locator. |
OpenPencilFlyout()
Opens the pencil flyout.
Declaration
public virtual void OpenPencilFlyout()
Exceptions
| Type | Condition |
|---|---|
| ElementNotShownException | Thrown when an element is not shown for the expected locator. |
SelectBallpointPen()
Selects the ballpoint pen option.
Declaration
public virtual void SelectBallpointPen()
SelectHighlighter()
Selects the highlighter option.
Declaration
public virtual void SelectHighlighter()
SelectPencil()
Selects the pencil option.
Declaration
public virtual void SelectPencil()
SetBallpointPenColor(String)
Sets the toolbar to the ballpoint pen with the given color.
Declaration
public virtual void SetBallpointPenColor(string color)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | color | The color to set. |
Exceptions
| Type | Condition |
|---|---|
| ElementNotShownException | Thrown when an element is not shown for the expected locator. |
| ElementsNotShownException | Thrown when no elements are shown for the expected locator. |
SetBallpointPenColorByPartialName(String)
Sets the toolbar to the ballpoint pen with the given partial color name.
Declaration
public virtual void SetBallpointPenColorByPartialName(string color)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | color | The partial color name to set. |
Exceptions
| Type | Condition |
|---|---|
| ElementNotShownException | Thrown when an element is not shown for the expected locator. |
| ElementsNotShownException | Thrown when no elements are shown for the expected locator. |
SetHighlighterColor(String)
Sets the toolbar to the highlighter with the given color.
Declaration
public virtual void SetHighlighterColor(string color)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | color | The color to set. |
Exceptions
| Type | Condition |
|---|---|
| ElementNotShownException | Thrown when an element is not shown for the expected locator. |
| ElementsNotShownException | Thrown when no elements are shown for the expected locator. |
SetHighlighterColorByPartialName(String)
Sets the toolbar to the highlighter with the given color.
Declaration
public virtual void SetHighlighterColorByPartialName(string color)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | color | The color to set. |
Exceptions
| Type | Condition |
|---|---|
| ElementNotShownException | Thrown when an element is not shown for the expected locator. |
| ElementsNotShownException | Thrown when no elements are shown for the expected locator. |
SetPencilColor(String)
Sets the toolbar to the pencil with the given color.
Declaration
public virtual void SetPencilColor(string color)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | color | The color to set. |
Exceptions
| Type | Condition |
|---|---|
| ElementNotShownException | Thrown when an element is not shown for the expected locator. |
| ElementsNotShownException | Thrown when no elements are shown for the expected locator. |
SetPencilColorByPartialName(String)
Sets the toolbar to the pencil with the given partial color name.
Declaration
public virtual void SetPencilColorByPartialName(string color)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | color | The partial color name to set. |
Exceptions
| Type | Condition |
|---|---|
| ElementNotShownException | Thrown when an element is not shown for the expected locator. |
| ElementsNotShownException | Thrown when no elements are shown for the expected locator. |
Operators
| Improve this Doc View SourceImplicit(AppiumWebElement to InkToolbar)
Allows conversion of a
Declaration
public static implicit operator InkToolbar(AppiumWebElement element)
Parameters
| Type | Name | Description |
|---|---|---|
| AppiumWebElement | element | The |
Returns
| Type | Description |
|---|---|
| InkToolbar | The InkToolbar. |
Implicit(RemoteWebElement to InkToolbar)
Allows conversion of a
Declaration
public static implicit operator InkToolbar(RemoteWebElement element)
Parameters
| Type | Name | Description |
|---|---|---|
| RemoteWebElement | element | The |
Returns
| Type | Description |
|---|---|
| InkToolbar | The InkToolbar. |
Implicit(WindowsElement to InkToolbar)
Allows conversion of a
Declaration
public static implicit operator InkToolbar(WindowsElement element)
Parameters
| Type | Name | Description |
|---|---|---|
| WindowsElement | element | The |
Returns
| Type | Description |
|---|---|
| InkToolbar | The InkToolbar. |