Namespace Au.Types

AnyWnd

A window handle. Used for function parameters where the function needs a window handle as wnd but also allows to pass a variable of any of these types: System.Windows.DependencyObject (WPF window or control), System.Windows.Forms.Control (Form or control), IntPtr (window handle).

AuException

The base exception class used in this library. Thrown when something fails and there is no better exception type for that failure.

AuWndException

Exception thrown mostly by wnd functions.

BIEvents

Used with inputBlocker class to specify what user input types to block (keys, mouse).

BRFilter

Used with ExtMisc.Resize

BSFlags

Flags for FastBuffer<T>.GetString.

CIFlags

Used with CaptureScreen functions.

CIUFlags

Flags for CaptureScreen.ImageColorRectUI.

CIUResult

Results of CaptureScreen.ImageColorRectUI.

ClipFormats

Some clipboard format ids. These and other standard and registered format ids can be used with clipboardData class functions.

ColorInt

Color, as int in 0xAARRGGBB format. Can convert from/to System.Drawing.Color, System.Windows.Media.Color, int (0xAARRGGBB), Windows COLORREF (0xBBGGRR), string.

Coord

Contains x or y coordinate in screen or some other rectangle that can be specified in various ways: normal, reverse, fraction, center, max. Used for parameters of functions like mouse.move, wnd.Move.

CoordType

Coord variable value type.

DControls

Used with dialog.show and similar functions to add more controls and get their final values.

DEdit

Text edit field type for dialog.showInput, dialog.SetEditControl, etc.

DEventArgs

Arguments for dialog event handlers.

DFlags

Flags for dialog.show and similar functions.

DIcon

Standard icons for dialog.show and similar functions.

DNative

Rarely used constants for Windows API used by dialog.

DNative.TDE

Constants for DNative.TDM.SET_ELEMENT_TEXT and DNative.TDM.UPDATE_ELEMENT_TEXT messages used with dialog.

DNative.TDIE

Constants for DNative.TDM.UPDATE_ICON message used with dialog.

DNative.TDM

Messages that your dialog event handler can send to the dialog.

DNative.TDN

Notification messages that your dialog event handler receives.

DpiOf

Used for dpiOf parameter of functions. Has implicit conversions from int (DPI), wnd (DPI of window), IntPtr (DPI of screen handle), POINT (DPI of screen containing point), RECT (DPI of screen containing rectangle), forms Control, WPF DependencyObject. The conversion operators set the DpiOf.Dpi property and the function can use it.

DSend

Can be used through dialog.Send, to interact with dialog while it is open.

ECommandState

ScriptEditor.GetCommandState.

EEvent

Event constants for WinEventHook.

EFFlags

Flags for "find UI element" functions (elmFinder).

EFileInfo

See ScriptEditor.GetFileInfo.

EFileKind

See EFileInfo.

EFocusedFlags

Flags for elm.focused.

EGetIcon

For ScriptEditor.GetIcon.

EHookFlags

Flags for WinEventHook.

EMiscFlags

Flags returned by elm.MiscFlags.

EObjid

Object ids of window parts and some special UI elements. Used with elm.fromWindow

EProperties

Used with elm.GetProperties.

ERole

Standard roles of UI elements. Used with elm.RoleInt

ESelect

UI element selection flags. Used by elm.Select.

EState

UI element state flags. Used by elm.State.

EWFlags

Flags for elm.fromWindow.

ExtInternet

Extension methods for .NET Internet functions.

ExtMisc

Adds extension methods for some .NET types.

ExtString

Adds extension methods for System.String.

ExtWpf

Adds extension methods for some WPF classes.

ExtXml

Adds extension methods for System.Xml.Linq.XElement and System.Xml.Linq.XDocument.

EXYFlags

Flags for elm.fromXY.

FAFlags

Flags for filesystem.getAttributes and some other functions.

FAttr

Contains file or directory attributes. Tells whether it exists, is directory, readonly, hidden, system, NTFS link. See filesystem.exists.

FCFlags

flags for filesystem.copy and some other similar functions. Used only when copying directory.

FDFlags

flags for filesystem.delete.

FEFile

Contains name and other main properties of a file or subdirectory retrieved by filesystem.enumerate. The values are not changed after creating the variable.

FEFlags

flags for filesystem.enumerate.

FIfExists

What to do if the destination directory contains a file or directory with the same name as the source file or directory when copying, moving or renaming. Used with filesystem.copy, filesystem.move and similar functions. When renaming or moving, if the destination is the same as the source, these options are ignored and the destination is simply renamed. For example when renaming "file.txt" to "FILE.TXT".

FileId

See filesystem.more.getFileId.

FileProperties

File or directory properties. Used with filesystem.getProperties.

FolderPath

Most functions of folders class return a value of this type. Contains folder path (string) and has operator + to append a string with backslash if need. Has implicit conversions from/to string.

FontNSS

Font name, size and style. If Name not set, will be used standard GUI font; then Size can be 0 to use size of standard GUI font. On high-DPI screen the font size will be scaled.

FOSFlags

FileOpenSaveDialog.CommonFlags.

FPFormat

Used with filesystem.more.getFinalPath

GCL

Window class long constants. Used with WndUtil.GetClassLong. See API WNDCLASSEX, GetClassLong.

GTIFlags

GUITHREADINFO flags.

GUITHREADINFO

API GUITHREADINFO

GWL

Window long constants. Used with wnd.GetWindowLong and wnd.SetWindowLong. See API GetWindowLong. See also API SetWindowSubclass.

GWL.DWL

HookData

Contains types of hook data for hook procedures set by WindowsHook and WinEventHook.

HookData.CbtEvent

CBT hook event types. Used with HookData.ThreadCbt. More info: API CBTProc.

HookData.CWPRETSTRUCT

API CWPRETSTRUCT

HookData.CWPSTRUCT

API CWPSTRUCT

HookData.Keyboard

Event data for the hook procedure set by WindowsHook.Keyboard. More info: API LowLevelKeyboardProc.

HookData.Mouse

Hook data for the hook procedure set by WindowsHook.Mouse. More info: API LowLevelMouseProc.

HookData.MouseEvent

Mouse hook event types. See HookData.Mouse.Event.

HookData.MOUSEHOOKSTRUCT

API MOUSEHOOKSTRUCT

HookData.ThreadCallWndProc

Hook data for the hook procedure set by WindowsHook.ThreadCallWndProc. More info: API CallWndProc.

HookData.ThreadCallWndProcRet

Hook data for the hook procedure set by WindowsHook.ThreadCallWndProcRet. More info: API CallWndRetProc.

HookData.ThreadCbt

Hook data for the hook procedure set by WindowsHook.ThreadCbt. More info: API CBTProc.

HookData.ThreadCbt.CBT_CREATEWND

API CBT_CREATEWND.

HookData.ThreadCbt.CBTACTIVATESTRUCT

API CBTACTIVATESTRUCT.

HookData.ThreadGetMessage

Hook data for the hook procedure set by WindowsHook.ThreadGetMessage. More info: API GetMsgProc.

HookData.ThreadKeyboard

Hook data for the hook procedure set by WindowsHook.ThreadKeyboard. More info: API KeyboardProc.

HookData.ThreadMouse

Hook data for the hook procedure set by WindowsHook.ThreadMouse. More info: API MouseProc.

HookData.WinEvent

Hook data for the hook procedure set by WinEventHook. More info: API WinEventProc.

HSContentPart

Contains a single part of a multipart POST data.

HSContentType

Contains properties of HTTP Content-Type header. See HSMessage.ContentType.

HSMessage

See HttpServerSession.MessageReceived.

HSResponse

See HttpServerSession.MessageReceived.

IconGetFlags

Flags for icon.of and similar functions.

IFAlso

Used with uiimage.find and uiimage.wait. Its callback function (parameter also) can return one of these values.

IFArea

Defines the search area for uiimage.find and similar functions.

IFFlags

Flags for uiimage.find and similar functions.

IFImage

Image(s) or color(s) for uiimage.find and similar functions.

InputDesktopException

This exception is thrown when current thread is not on the input desktop and therefore cannot use mouse, keyboard, clipboard and window functions. For example when PC locked (Win+L), screen saver, UAC consent, Ctrl+Alt+Delete.

IOcrEngine

Used by ocr and ocrFinder.

ITBOwnerObject

Used with toolbar.Show.

JSettings

Base of record classes that contain various settings as public fields. Loads and lazily auto-saves from/to a JSON file.

KHotkey

Defines a hotkey as KMod and KKey. Has implicit conversion operators from string like "Ctrl+Shift+K", tuple (KMod, KKey), enum KKey, enum Keys.

KKey

Virtual-key codes.

KKeyScan

Virtual-key code, scan code and extended-key flag for keys.send and similar functions.

KKeysEtc

Parameter type of keys.send and similar functions. Has implicit conversions from string, clipboardData, KKey, KKeyScan, char, int (sleep time) and Action.

KMod

Modifier keys as flags.

MButton

button parameter type for mouse.clickEx and similar functions.

MButtons

Flags for mouse buttons. Used with functions that check mouse button states (pressed or not).

MCursor

Standard cursor ids. Used with mouse.waitForCursor.

MObject

This type is used for parameters of mouse functions that accept multiple types of UI objects (window, UI element, screen, etc). Has implicit conversions from wnd, elm, uiimage, screen, RECT and bool (relative coordinates). Also has static functions to specify more parameters.

MRelease

At the end of using(...) { ... } block releases mouse buttons pressed by the function that returned this variable. See example.

MSG

API MSG

MTBase

Base class of popupMenu and toolbar.

MTImage

Used for menu/toolbar function parameters to specify an image in different ways (file path, Image object, etc).

MTItem

Base of PMItem etc.

NativeApi

If a class is derived from this class, editor adds undeclared Windows API to its completion list.

NativeApi.BOOL

Windows API BOOL, with implicit conversions to/from C# bool.

NativeApi.FlexibleArray<T>

Can be used in structures as flexible array member (the last field, defined like Type[1] name; in C).

NativePathsAttribute

The default compiler adds this attribute to the main assembly if using NuGet packages with native dlls. Allows to find the dlls at run time. Only if role miniProgram (default) or editorExtension.

NotFoundException

Functions that search for an object can throw this exception when not found.

OcrFlags

Flags for ocr and ocrFinder.

OcrWord

Stores text and rectangle of a word in OCR results. See ocr.Words.

OKey

Options for functions of class keys. Some options also are used with clipboard functions that send keys (Ctrl+V etc).

OKeyHookData

Parameter type of the OKey.Hook callback function.

OKeyText

How functions send text. See OKey.TextHow.

OMouse

Options for functions of class mouse.

ORLabelOptions

Used by osdRect.SetRects.

OsdMode

Whether osdText.Show waits or shows the OSD window in this or new thread.

OsdWindow

Transparent window that can be used for on-screen display. Derived classes on it can draw non-transparent text, rectangle, image, anything.

OWarnings

Options for run-time warnings (print.warning).

ParamStringAttribute

A function parameter with this attribute is a string of the specified format, for example regular expression. Code editors should help to create correct string arguments: provide tools or reference, show errors.

PastingEventArgs

keys.Pasting event data.

PathInWorkspaceAttribute

The default compiler adds this attribute to the assembly.

Pidl

Manages an ITEMIDLIST structure that is used to identify files and other shell objects instead of a file-system path.

PMFlags

Flags for popupMenuShowX methods.

PMItem

Represents a menu item in popupMenu.

PMKHook

Used with popupMenu.KeyboardHook.

PMMetrics

Used with popupMenu.Metrics and popupMenu.defaultMetrics.

PNFlags

Flags for pathname.normalize.

POINT

Point coordinates x y.

PopupXY

Can be used to specify coordinates for various popup windows, like new PopupXY(x, y), (x, y), PopupXY.In(rectangle), PopupXY.Mouse.

PrintMsgOptions

Options for WndUtil.PrintMsg.

PrintServerMessage

Contains message text and/or related info. More info: PrintServer, PrintServer.GetMessage.

PrintServerMessageType

See PrintServerMessage.Type.

ProcessInfo

Contains process name (like "notepad.exe"), id and user session id.

ProcessTriggerInfo

Contains process trigger info retrieved by process.triggers.

ProgressArgs

Arguments for a progress callback function.

PSFormat

Used with ParamStringAttribute to specify string parameter format.

RECT

Rectangle coordinates left top right bottom.

RefPathsAttribute

The default compiler adds this attribute to the main assembly if using non-default references (meta r or nuget). Allows to find them at run time. Only if role miniProgram (default) or editorExtension.

RFlags

Flags for run.it.

ROptions

More parameters for run.it.

RResult

Results of run.it.

RXCalloutData

Managed version of PCRE API struct pcre2_callout_block. When you set regexp.Callout, your callout function's parameter is of this type. More info in PCRE help topic pcre2callout. Most properties are pcre2_callout_block fields as documented in PCRE help. Other properties and methods are easier/safer versions of unsafe fields like offset_vector.

RXFlags

Flags for regexp constructor. Documented in PCRE help topic pcre2api.

RXGroup

Regular expression group match info. Used with RXMatch, regexp and some String extension methods.

RXMatch

Regular expression match info. Used with regexp class functions and String extension methods like ExtString.RxMatch.

RXMatchFlags

Flags for regexp class functions. Documented in PCRE help topic pcre2api.

Seconds

Used with wait functions. Contains a wait timeout in seconds, and possibly wait options.

SIGDN

API SIGDN

SIZE

Width and height.

SLError

SQLite API error codes. Also two success codes - Row and Done.

SLException

Exception thrown by sqlite, sqliteStatement and related types.

SLFlags

Flags for sqlite constructor.

SLIndexOrName

Used for parameter types of some sqliteStatement functions. Has implicit conversions from int and string. If int, the value is interpreted as index. If string - as name.

SLTransaction

A SQLite transaction or savepoint. The main purpose is to automatically rollback if not explicitly committed. Usage: using(var trans = new SLTransaction(db)) { ... trans.Commit(); }

SMTFlags

API SendMessageTimeout flags. Used with wnd.SendTimeout.

SODefault

Used with screen.of to specify what screen to return if the window/point/etc is not in a screen or if the window handle is invalid etc.

SpecHWND

Special window handle values. Can be used with wnd.SetWindowPos. See API SetWindowPos.

SRole

script.role.

StartEnd

Struct with fields int start and int end.

STIFlags

Flags for ExtString.ToInt and similar functions.

StockIcon

See icon.stock, SHSTOCKICONID.

Strings

Used for function parameters to specify multiple strings. Contains a string like "One|Two|Three" or string[] or List<string>. Has implicit conversions from these types. Can be assigned collection initializer like ["a", "b"].

SUpper

Used with ExtString.Upper

SVFlags

Flags for sound.speak. See SPEAKFLAGS.

SWPFlags

API SetWindowPos flags. Can be used with wnd.SetWindowPos.

TBAnchor

Used with toolbar.Anchor.

TBBorder

Used with toolbar.Border.

TBCtor

Flags for toolbar constructor.

TBFlags

Used with toolbar.MiscFlags.

TBHide

Reasons to hide a toolbar. Used with toolbar.Hide.

TBItem

Represents a button or separator in toolbar.

TBItemType

Used with TBItem.ItemType.

TBLayout

Used with toolbar.Layout.

TBMetrics

Used with toolbar.Metrics and toolbar.defaultMetrics.

TBNoMenu

Used with toolbar.NoContextMenu.

TBOffsets

Used with toolbar.Offsets.

TBScaling

Used with toolbar.DpiScaling.

TFFlags

API DrawTextEx format flags.

TIEventArgs

TINFlags

Flags for trayIcon.ShowNotification. See NIIF_ flags of API NOTIFYICONDATAW.

TreeBase<T>

Base class for tree classes. The tree can be loaded/saved as XML.

TreeBase<T>.XmlNodeReader

Used with TreeBase<T>.XmlLoad

TreeBase<T>.XmlNodeWriter

Used with TreeBase<T>.XmlSave

UacElevation

uacInfo.Elevation.

UacIL

UAC integrity level. See uacInfo.IntegrityLevel.

UExcept

Flags for script.setup parameter exception. Defines what to do on unhandled exception. Default is Print, even if script.setup not called (with default compiler only).

UsingEndAction

Invokes specified action (calls callback function) at the end of using(...) { ... }. Usually returned by functions. Example: opt.scope.mouse.

WBAdd

Flags for wpfBuilder.Add.

WBAlsoAllArgs

Arguments for wpfBuilder.AlsoAll callback function.

WBBFlags

Flags for wpfBuilder.AddButton.

WBButtonClickArgs

Arguments for wpfBuilder.AddButton callback function.

WBGridLength

Used with wpfBuilder functions to specify width/height of columns and rows. Allows to specify minimal and/or maximal values too. Like WBLength, but has functions to create System.Windows.Controls.ColumnDefinition and System.Windows.Controls.RowDefinition. Also has implicit conversion from these types.