These functions can be used to create an advanced, scripted macro inside VoiceBot.
Use C# or Visual Basic and create anything you can imagine!
Need help creating a scripted macro? Please contact us, we would be happy to help you out!
Contains functions to deal with Applications and Processes.
Description | Gets a list of filenames of all running processes that DisplayFusion has access to see. |
Compatibility | ![]() ![]() ![]() |
Function | string[] GetAllRunningApplicationFiles(); |
Sample | string[] files = BFS.Application.GetAllRunningApplicationFiles(); |
Description | Gets a list of all running appIDs (processIDs) that DisplayFusion has access to see. |
Compatibility | ![]() ![]() ![]() |
Function | uint[] GetAllRunningApplicationIDs(); |
Sample | uint[] apps = BFS.Application.GetAllRunningApplicationIDs(); |
Description | Gets the appID (processID) of the given file, if that file is running. |
Compatibility | ![]() ![]() ![]() |
Function | uint GetAppIDByFile(string file); |
Sample | uint appID = BFS.Application.GetAppIDByFile("*excel.exe"); |
Description | Gets the appID (processID) of the given window. |
Compatibility | ![]() ![]() ![]() |
Function | uint GetAppIDByWindow(IntPtr windowHandle); |
Sample | uint appID = BFS.Application.GetAppIDByWindow(windowHandle); |
Description | This function returns the main filename from the given App ID. |
Compatibility | ![]() ![]() ![]() |
Function | string GetMainFileByAppID(uint appID); |
Sample | string file = BFS.Application.GetMainFileByAppID(appID); |
Description | Returns the full path for the given wildcard for a running process. |
Compatibility | ![]() ![]() ![]() |
Function | string GetMainFileByWildcard(string file); |
Sample | string mainfile = GetMainFileByWildcard("*\Outlook.exe"); |
Description | This function returns the main filename from the given window handle. |
Compatibility | ![]() ![]() ![]() |
Function | string GetMainFileByWindow(IntPtr windowHandle); |
Sample | string file = BFS.Application.GetMainFileByWindow(windowHandle); |
Description | Returns the main window handle for the given appID (ProcessID). |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr GetMainWindowByAppID(uint appID); |
Sample | IntPtr windowHandle = BFS.Application.GetMainWindowByAppID(appID); |
Description | Returns the main window handle for the given absolute filename or wildcard. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr GetMainWindowByFile(string file); |
Sample | IntPtr windowHandle = BFS.Application.GetMainWindowByFile("*excel.exe"); |
Description | Checks if the given appID (ProcessID) is running. |
Compatibility | ![]() ![]() ![]() |
Function | bool IsAppRunningByAppID(uint appID); |
Sample | bool isRunning = BFS.Application.IsAppRunningByAppID(appID); |
Description | Checks if the given absolute filename or wildcard is running. |
Compatibility | ![]() ![]() ![]() |
Function | bool IsAppRunningByFile(string file); |
Sample | bool isRunning = BFS.Application.IsAppRunningByFile("*excel.exe"); |
Description | Terminates the given appID (ProcessID). |
Compatibility | ![]() ![]() ![]() |
Function | bool Kill(uint appID); |
Sample | bool ok = BFS.Application.Kill(appID); |
Description | Starts the given application using the command line parameters (optional). |
Compatibility | ![]() ![]() ![]() |
Function | uint Start(string filename, string arguments); |
Sample | uint appID = BFS.Application.Start("C:\\Games\\Main.exe", "-Mode=1"); |
Description | Waits for the given appID (ProcessID) to exit, stops waiting after 5000ms (5 seconds). Pass 0 for waitMS to wait forever until it exits. |
Compatibility | ![]() ![]() ![]() |
Function | bool WaitForExitByAppID(uint appID, uint waitMS); |
Sample | bool exited = BFS.Application.WaitForExitByAppID(appID, 5000); |
Description | Waits for the given absolute filename or wildcard to exit, stops waiting after 5000ms (5 seconds). Pass 0 for waitMS to wait forever until it exits. |
Compatibility | ![]() ![]() ![]() |
Function | bool WaitForExitByFile(uint appID, uint waitMS); |
Sample | bool exited = BFS.Application.WaitForExitByFile("*excel.exe", 5000); |
Contains functions to deal with Audio devices and volumes.
Description | Adjusts the master volume down one tick. |
Compatibility | ![]() ![]() ![]() |
Function | bool AdjustVolumeDown(); |
Sample | bool ok = BFS.Audio.AdjustVolumeDown(); |
Description | Adjusts the master volume up one tick. |
Compatibility | ![]() ![]() ![]() |
Function | bool AdjustVolumeUp(); |
Sample | bool ok = BFS.Audio.AdjustVolumeUp(); |
Description | Gets whether or not an application is muted from its process ID. |
Compatibility | ![]() ![]() ![]() |
Function | bool GetApplicationMute(uint appID); |
Sample | bool isMuted = BFS.Audio.GetApplicationMute(appID); |
Description | Gets the volume of an application by its process ID. The returned value will be between 0 and 1. |
Compatibility | ![]() ![]() ![]() |
Function | decimal GetApplicationVolume(uint appID); |
Sample | decimal volume = BFS.Audio.SetApplicationVolume(appID); |
Description | Gets the name of the default playback device for communications. |
Compatibility | ![]() ![]() ![]() |
Function | string GetDefaultPlaybackCommunications(); |
Sample | string defaultName = BFS.Audio.GetDefaultPlaybackCommunications(); |
Description | Gets the name of the default playback device for sounds. |
Compatibility | ![]() ![]() ![]() |
Function | string GetDefaultPlaybackSounds(); |
Sample | string defaultName = BFS.Audio.GetDefaultPlaybackSounds(); |
Description | Gets the name of the default recording device for communications. |
Compatibility | ![]() ![]() ![]() |
Function | string GetDefaultRecordingCommunications(); |
Sample | string defaultName = BFS.Audio.GetDefaultRecordingCommunications(); |
Description | Gets the name of the default recording device for sounds. |
Compatibility | ![]() ![]() ![]() |
Function | string GetDefaultRecordingSounds(); |
Sample | string defaultName = BFS.Audio.GetDefaultRecordingSounds(); |
Description | Returns the current muted status for the system volume. |
Compatibility | ![]() ![]() ![]() |
Function | bool GetMute(); |
Sample | bool muted = BFS.Audio.GetMute(); |
Description | Gets a list of all the enabled playback devices. |
Compatibility | ![]() ![]() ![]() |
Function | string[] GetPlaybackDevices(); |
Sample | string[] devices = GetPlaybackDevices(); |
Description | Gets a list of all the enabled recording devices. |
Compatibility | ![]() ![]() ![]() |
Function | string[] GetRecordingDevices(); |
Sample | string[] devices = GetRecordingDevices(); |
Description | Gets current the master volume level for the system. |
Compatibility | ![]() ![]() ![]() |
Function | decimal GetVolume(); |
Sample | decimal volume = BFS.Audio.GetVolume(); |
Description | This function allows you to play an audio file (wav, mp3... etc). |
Compatibility | ![]() ![]() ![]() |
Function | bool PlayFile(string filename); |
Sample | bool ok = BFS.Audio.PlayFile("C:\myfile.mp3"); |
Description | This function allows you to play a .wav file. |
Compatibility | ![]() ![]() ![]() |
Function | bool PlayWAV(string filename); |
Sample | bool ok = BFS.Audio.PlayWAV("C:\myfile.wav"); |
Description | Sets mute on an application by its process ID. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetApplicationMute(uint appID, bool mute); |
Sample | bool ok = BFS.Audio.SetApplicationMute(appID, true); |
Description | Sets the volume of an application by its process ID. Accepts values between 0 and 1. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetApplicationVolume(uint appID, decimal volume); |
Sample | bool ok = BFS.Audio.SetApplicationVolume(appID, 0.5m); |
Description | Raises the volume of an application to its maximum value by process ID. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetApplicationVolumeMax(uint appID); |
Sample | bool ok = BFS.Audio.SetApplicationVolumeMax(appID); |
Description | Lowers the volume of an application to its minimum value by process ID. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetApplicationVolumeMin(uint appID); |
Sample | bool ok = BFS.Audio.SetApplicationVolumeMin(appID); |
Description | Sets the default playback device for communications (like Skype). |
Compatibility | ![]() ![]() ![]() |
Function | bool SetDefaultPlaybackCommunications(string name); |
Sample | bool ok = BFS.Audio.SetDefaultPlaybackCommunications("Main Speakers"); |
Description | Sets the default playback device for sounds, music and applications. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetDefaultPlaybackSounds(string name); |
Sample | bool ok = BFS.Audio.SetDefaultPlaybackSounds("Main Speakers"); |
Description | Sets the default recording device for communications (like Skype). |
Compatibility | ![]() ![]() ![]() |
Function | bool SetDefaultRecordingCommunications(string name); |
Sample | bool ok = BFS.Audio.SetDefaultRecordingCommunications("Main Microphone"); |
Description | Sets the default recording device for sounds, music and applications. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetDefaultRecordingSounds(string name); |
Sample | bool ok = BFS.Audio.SetDefaultRecordingSounds("Main Microphone"); |
Description | Sets the master system volume to muted or unmuted. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetMute(bool mute); |
Sample | bool ok = BFS.Audio.SetMute(true); |
Description | Sets the master system volume. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetVolume(decimal volume); |
Sample | bool ok = BFS.Audio.SetVolume(0.5m); |
Description | Sets the master volume to maximum. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetVolumeMax(); |
Sample | bool ok = BFS.Audio.SetVolumeMax(); |
Description | Sets the master volume to 0. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetVolumeMin(); |
Sample | bool ok = BFS.Audio.SetVolumeMin(); |
Description | Toggles the master volume mute on/off. |
Compatibility | ![]() ![]() ![]() |
Function | bool ToggleMute(); |
Sample | bool ok = BFS.Audio.ToggleMute(); |
Contains functions to deal with the Clipboard.
Description | Clears the clipboard. |
Compatibility | ![]() ![]() ![]() |
Function | bool Clear(); |
Sample | bool ok = BFS.Clipboard.Clear(); |
Description | Copies from the currently active window. (same as pressing Ctrl+C) |
Compatibility | ![]() ![]() ![]() |
Function | bool Copy(); |
Sample | bool ok = BFS.Clipboard.Copy(); |
Description | Copies from the currently active window and returns the text string that was copied. |
Compatibility | ![]() ![]() ![]() |
Function | string CopyText(); |
Sample | string text = BFS.Clipboard.CopyText(); |
Description | Returns the text value that is currently on the clipboard. |
Compatibility | ![]() ![]() ![]() |
Function | string GetText(); |
Sample | string text = BFS.Clipboard.GetText(); |
Description | Returns true if the clipboard currently contains an image. |
Compatibility | ![]() ![]() ![]() |
Function | bool HasImage(); |
Sample | bool hasImage = BFS.Clipboard.HasImage(); |
Description | Returns true if the clipboard currently contains text. |
Compatibility | ![]() ![]() ![]() |
Function | bool HasText(); |
Sample | bool hasText = BFS.Clipboard.HasText(); |
Description | Pastes to the currently active window. (same as pressing Ctrl+V) |
Compatibility | ![]() ![]() ![]() |
Function | bool Paste(); |
Sample | bool ok = BFS.Clipboard.Paste(); |
Description | Pastes the given text to the current active window. |
Compatibility | ![]() ![]() ![]() |
Function | bool PasteText(string text); |
Sample | bool ok = BFS.Clipboard.PasteText("My text."); |
Description | Sets the given html code to the clipboard. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetHTML(string html); |
Sample | bool ok = BFS.Clipboard.SetHTML("<li>List Item</li>"); |
Description | Sets the given text value to the clipboard. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetText(string text); |
Sample | bool ok = BFS.Clipboard.SetText("My text."); |
Contains functions to show message boxes and get user input.
Description | Shows a Yes/No prompt to the user, and returns True/False depending on what they select. |
Compatibility | ![]() ![]() ![]() |
Function | bool GetUserConfirm(string message); |
Sample | bool isHappy = BFS.Dialog.GetUserConfirm("Are you happy?"); |
Description | Shows an input dialog to the user where they can type anything they want. You can provide a preset value. |
Compatibility | ![]() ![]() ![]() |
Function | string GetUserInput(string title, string value); |
Sample | string input = BFS.Dialog.GetUserInput("How old are you?", "preset value here"); |
Description | Shows a list of given items in a dropdown list and returns the selected string. Returns an empty string if the user clicks "Cancel". |
Compatibility | ![]() ![]() ![]() |
Function | string GetUserInputList(string title, string[] values); |
Sample | string input = BFS.Dialog.GetUserInputList("Test", new string[] { "Item #1", "Item #2", "Item #3" }); |
Description | Shows a list of given items in a listview with a filter box, and returns the selected string. Returns an empty string if the user clicks "Cancel". |
Compatibility | ![]() ![]() ![]() |
Function | string GetUserInputListViewWithFilter(string title, string[] values); |
Sample | string input = BFS.Dialog.GetUserInputListViewWithFilter("Test", new string[] { "Item #1", "Item #2", "Item #3" }); |
Description | Shows an error messagebox to the user with an OK button. |
Compatibility | ![]() ![]() ![]() |
Function | void ShowMessageError(string message); |
Sample | BFS.Dialog.ShowMessageInfo("An error has occurred!"); |
Description | Shows an error messagebox to the user with an OK button in a Monospaced font. |
Compatibility | ![]() ![]() ![]() |
Function | void ShowMessageErrorMonospaced(string message); |
Sample | BFS.Dialog.ShowMessageErrorMonospaced("An error has occurred in monoospaced!"); |
Description | Shows a messagebox to the user with an OK button. |
Compatibility | ![]() ![]() ![]() |
Function | void ShowMessageInfo(string message); |
Sample | BFS.Dialog.ShowMessageInfo("This is a message!"); |
Description | Shows a messagebox to the user with an OK button using a Monospaced font. |
Compatibility | ![]() ![]() ![]() |
Function | void ShowMessageInfoMonospaced(string message); |
Sample | BFS.Dialog.ShowMessageInfoMonospaced("This is a monospaced message!"); |
Description | Shows a tray balloon or toast message. |
Compatibility | ![]() ![]() ![]() |
Function | void ShowTrayMessage(string message); |
Sample | BFS.Dialog.ShowTrayMessage("My tray message!"); |
Contains general purpose functions that don't fit into any other groups.
Description | Gets the current application's executable. |
Compatibility | ![]() ![]() ![]() |
Function | string GetAppExecutable(); |
Sample | string exe = BFS.General.GetAppExecutable(); |
Description | Gets the current application's installation folder. |
Compatibility | ![]() ![]() ![]() |
Function | string GetAppInstallPath(); |
Sample | string path = BFS.General.GetAppInstallPath(); |
Description | Returns true if the application is currently the Pro Licenses version. |
Compatibility | ![]() ![]() ![]() |
Function | bool GetAppIsProVersion(); |
Sample | bool isPro = BFS.General.GetAppIsProVersion(); |
Description | Gets the current application's version. |
Compatibility | ![]() ![]() ![]() |
Function | string GetAppVersion(); |
Sample | string version = BFS.General.GetAppVersion(); |
Description | Returns true if the desktop is currently locked. |
Compatibility | ![]() ![]() ![]() |
Function | bool IsDesktopLocked(); |
Sample | bool isLocked = BFS.General.IsDesktopLocked(); |
Description | Locks the desktop and forces the user to login again. |
Compatibility | ![]() ![]() ![]() |
Function | bool LockDesktop(); |
Sample | bool ok = BFS.General.LockDesktop(); |
Description | Logs a text string in your Debug log (if enabled) for troubleshooting. |
Compatibility | ![]() ![]() ![]() |
Function | void LogText(string text); |
Sample | BFS.General.LogText("This will appear in your application log!"); |
Description | Puts all of the monitors to sleep (power-saving mode). |
Compatibility | ![]() ![]() ![]() |
Function | bool SleepMonitors(); |
Sample | bool ok = BFS.General.SleepMonitors(); |
Description | Waits for 500ms before running the next lines of code. |
Compatibility | ![]() ![]() ![]() |
Function | bool ThreadWait(uint waitMS); |
Sample | bool ok = BFS.General.ThreadWait(500); |
Description | Wakes up any sleeping (power-saving) monitors. |
Compatibility | ![]() ![]() ![]() |
Function | bool WakeMonitors(); |
Sample | bool ok = BFS.General.WakeMonitors(); |
Contains functions to simulate mouse or keyboard input.
Description | Gets the mouse X position on the screen. |
Compatibility | ![]() ![]() ![]() |
Function | int GetMousePositionX(); |
Sample | int mouseX = BFS.Input.GetMousePositionX(); |
Description | Gets the mouse Y position on the screen. |
Compatibility | ![]() ![]() ![]() |
Function | int GetMousePositionY(); |
Sample | int mouseY = BFS.Input.GetMousePositionY(); |
Description | Returns true if the Virtual Key Codes (VK) are down. Separate multiple codes with ; and the function will only return true if all the keys are pressed at once. |
Compatibility | ![]() ![]() ![]() |
Function | bool IsKeyDown(string keys); |
Sample | bool isKeyDown = BFS.Input.IsKeyDown("54;65"); |
Description | Returns true if the Virtual Key Codes (VK) are down. Separate multiple codes with ; and the function will only return true if all the keys and mouse buttons are pressed at once. |
Compatibility | ![]() ![]() ![]() |
Function | bool IsMouseDown(string buttons); |
Sample | bool isMouseDown = BFS.Input.IsMouseDown("1;"); |
Description | Simulates a mouse left-click at the current mouse position. |
Compatibility | ![]() ![]() ![]() |
Function | bool LeftClickMouse(); |
Sample | bool ok = BFS.Input.LeftClickMouse(); |
Description | Simulates a mouse middle-click at the current mouse position. |
Compatibility | ![]() ![]() ![]() |
Function | bool MiddleClickMouse(); |
Sample | bool ok = BFS.Input.MiddleClickMouse() |
Description | Simulates a mouse right-click at the current mouse position. |
Compatibility | ![]() ![]() ![]() |
Function | bool RightClickMouse(); |
Sample | bool ok = BFS.Input.RightClickMouse() |
Description | Presses a key down without releasing it. This is the same as pressing and holding a key. |
Compatibility | ![]() ![]() ![]() |
Function | bool SendKeyDown(string keys); |
Sample | bool ok = BFS.Input.SendKeyDown("X"); //Press X |
Description | Presses a key down without releasing it. This is the same as pressing and holding a key. This doesn't wait for keys to be released before virtually pressing this key. |
Compatibility | ![]() ![]() ![]() |
Function | bool SendKeyDownWithoutWait(string keys); |
Sample | bool ok = BFS.Input.SendKeyDownWithoutWait("X"); //Press X |
Description | Simulates key presses, with or without modifiers (Alt, Ctrl, Shift, Win). |
Compatibility | ![]() ![]() ![]() |
Function | bool SendKeys(string keys); |
Sample | bool ok = BFS.Input.SendKeys("%{X}"); //Sends Alt+X |
Description | The same as SendKeys but uses a lower delay for the keypress duration. This may cause compatibility issues with some applications. |
Compatibility | ![]() ![]() ![]() |
Function | bool SendKeysFast(string keys); |
Sample | bool ok = BFS.Input.SendKeysFast("%{X}"); //Sends Alt+X |
Description | The same as SendKeys but uses a lower delay for the keypress duration. This may cause compatibility issues with some applications. This doesn't wait for keys to be released before virtually pressing these keys. |
Compatibility | ![]() ![]() ![]() |
Function | bool SendKeysFastWithoutWait(string keys); |
Sample | bool ok = BFS.Input.SendKeysFastWithoutWait("%{X}"); //Sends Alt+X |
Description | Simulates key presses, with or without modifiers (Alt, Ctrl, Shift, Win). This doesn't wait for keys to be released before virtually pressing these keys. |
Compatibility | ![]() ![]() ![]() |
Function | bool SendKeysWithoutWait(string keys); |
Sample | bool ok = BFS.Input.SendKeysWithoutWait("%{X}"); //Sends Alt+X |
Description | Releases a key that was previously pressed. |
Compatibility | ![]() ![]() ![]() |
Function | bool SendKeyUp(string keys); |
Sample | bool ok = BFS.Input.SendKeyUp("X"); //Release X |
Description | Releases a key that was previously pressed. This doesn't wait for keys to be released before virtually unpressing this key. |
Compatibility | ![]() ![]() ![]() |
Function | bool SendKeyUpWithoutWait(string keys); |
Sample | bool ok = BFS.Input.SendKeyUpWithoutWait("X"); //Release X |
Description | This function types the given text string, as if it was being typed by a user. |
Compatibility | ![]() ![]() ![]() |
Function | bool SendText(string text); |
Sample | bool ok = BFS.Input.SendText("hello world"); //Types out 'hello world' |
Description | Moves the mouse cursor to a specific location on the screen. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetMousePosition(int x, int y); |
Sample | bool ok = BFS.Input.SetMousePosition(100, 200); //Moves the mouse cursor to 100, 200 |
Description | Moves the mouse cursor relatively from the current position on the screen and generates WM_MouseMove messages. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetMousePositionRelative(int x, int y); |
Sample | bool ok = BFS.Input.SetMousePositionRelative(10, 20); //Moves the mouse cursor right 10, down 20 |
Description | Moves the mouse cursor relatively from the current position on the screen without any DPI acceleration, and doesn't generate WM_MouseMove messages. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetMousePositionRelativeNoAcceleration(int x, int y); |
Sample | bool ok = BFS.Input.SetMousePositionRelativeNoAcceleration(10, 20); //Moves the mouse cursor right 10, down 20 |
Contains functions related to attached desktop monitors.
Description | Allows the user to select a monitor from a dialog and returns the monitorID or returns 0 if they cancel. |
Compatibility | ![]() ![]() ![]() |
Function | uint ShowMonitorSelector(); |
Sample | uint monitorID = BFS.Monitor.ShowMonitorSelector(); |
Contains functions to manage your Screen Savers.
Description | This function returns true if the screen saver requires a password. |
Compatibility | ![]() ![]() ![]() |
Function | bool GetPasswordLocked(); |
Sample | bool isPasswordLocked = BFS.ScreenSaver.GetPasswordLocked(); |
Description | This function gets the number of minutes before a screen saver will start (the screen saver timeout). |
Compatibility | ![]() ![]() ![]() |
Function | int GetTimeoutMinutes(); |
Sample | int timeoutMinutes = BFS.ScreenSaver.GetTimeoutMinutes(); |
Description | This function sets whether you need to enter a screen saver after it runs. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetPasswordLocked(bool isPasswordLocked); |
Sample | bool ok = BFS.ScreenSaver.SetPasswordLocked(true); //sets to need a password |
Description | This function sets the screen saver timeout in minutes. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetTimeoutMinutes(int timeoutMinutes); |
Sample | bool ok = BFS.ScreenSaver.SetTimeoutMinutes(60); //60 minutes |
Contains functions that allow you to read and write setting values that are persisted between running functions and can be shared between functions.
Description | Deletes all saved values. |
Compatibility | ![]() ![]() ![]() |
Function | bool DeleteAllValues(); |
Sample | bool ok = BFS.ScriptSettings.DeleteAllValues(); |
Description | Deletes the value with the given name. |
Compatibility | ![]() ![]() ![]() |
Function | bool DeleteValue(string name); |
Sample | bool ok = BFS.ScriptSettings.DeleteValue("My Encrypted Setting"); |
Description | Gets all the value names for all ScriptSetting values. |
Compatibility | ![]() ![]() ![]() |
Function | string[] GetValueNames(); |
Sample | string[] names = GetValueNames(); |
Description | Reads a setting value as a string from the given name. |
Compatibility | ![]() ![]() ![]() |
Function | string ReadValue(string name); |
Sample | string value = BFS.ScriptSettings.ReadValue("My Setting"); |
Description | Reads a setting value as a bool from the given name. |
Compatibility | ![]() ![]() ![]() |
Function | bool ReadValueBool(string name); |
Sample | bool value = BFS.ScriptSettings.ReadValueBool("My Setting"); |
Description | Reads a setting value from the given name and decrypts it. |
Compatibility | ![]() ![]() ![]() |
Function | string ReadValueEncrypted(string name); |
Sample | string value = BFS.ScriptSettings.ReadValueEncrypted("My Encrypted Setting"); |
Description | Reads a setting value as an int from the given name. |
Compatibility | ![]() ![]() ![]() |
Function | int ReadValueInt(string name); |
Sample | int value = BFS.ScriptSettings.ReadValueInt("My Setting"); |
Description | Writes a setting value as a string to the given name. |
Compatibility | ![]() ![]() ![]() |
Function | bool WriteValue(string name, string value); |
Sample | bool ok = BFS.ScriptSettings.WriteValue("My Setting", "value goes here..."); |
Description | Writes a setting value as a bool to the given name. |
Compatibility | ![]() ![]() ![]() |
Function | bool WriteValueBool(string name, bool value); |
Sample | bool ok = BFS.ScriptSettings.WriteValue("My Setting", true); |
Description | Encrypts and writes a setting a value to the given name. |
Compatibility | ![]() ![]() ![]() |
Function | bool WriteValueEncrypted(string name, string value); |
Sample | bool ok = BFS.ScriptSettings.WriteValueEncrypted("My Encrypted Setting", "value goes here..."); |
Description | Writes a setting value as ant int to the given name. |
Compatibility | ![]() ![]() ![]() |
Function | bool WriteValueInt(string name, int value); |
Sample | bool ok = BFS.ScriptSettings.WriteValue("My Setting", 75); |
Contains functions to deal with speech recognition and text-to-speech.
Description | This function allows you to convert the given text to speech that is spoken by your computer. |
Compatibility | ![]() ![]() ![]() |
Function | bool TextToSpeech(string text); |
Sample | bool ok = BFS.Speech.TextToSpeech("Hello, this is my voice!"); |
Description | This function allows you to convert the given text to speech that is spoken by your computer in the given voice. |
Compatibility | ![]() ![]() ![]() |
Function | bool TextToSpeechWithVoice(string text, string voice); |
Sample | bool ok = BFS.Speech.TextToSpeechWithVoice("Hello, this is my voice!", "Microsoft David Desktop - English (United States)"); |
Containts functions to deal with the Windows taskbar.
Description | This function returns true if the Windows taskbar is currently set to auto-hide. |
Compatibility | ![]() ![]() ![]() |
Function | bool IsWindowsTaskbarAutoHideEnabled(); |
Sample | bool isAutoHidden = BFS.Taskbar.IsWindowsTaskbarAutoHideEnabled(); |
Description | This function allows you to enable or disable the Windows taskbar auto-hide. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetWindowsTaskbarAutoHide(bool isAutoHidden); |
Sample | bool ok = BFS.Taskbar.SetWindowsTaskbarAutoHide(true); //Sets the Windows taskbar to auto-hide |
Contains functions to manipulate text strings.
Description | Allows you to use the powerful TextQuery engine to match the given text to the given query. |
Compatibility | ![]() ![]() ![]() |
Function | bool QueryIsMatch(string query, string text); |
Sample | bool isMatch = BFS.Text.QueryIsMatch("test", "This is my test"); //this will return true because it matches TEST |
Description | This function removes all html tags from a string, with an option to remove empty tags as well. |
Compatibility | ![]() ![]() ![]() |
Function | string ScrubHtml(string text, bool isIgnorningEmptyTags); |
Sample | string text = BFS.Text.ScrubHtml("HTML text", true); |
Description | This function removes all line breaks from a string. |
Compatibility | ![]() ![]() ![]() |
Function | string ScrubLineBreaks(string text); |
Sample | string text = BFS.Text.ScrubLineBreaks("My text"); |
Description | This function removes all line breaks from the end of a string. |
Compatibility | ![]() ![]() ![]() |
Function | string ScrubLineBreaksAfter(string text); |
Sample | string text = BFS.Text.ScrubLineBreaksAfter("My text"); |
Description | This function removes all line breaks at the beginning of a string. |
Compatibility | ![]() ![]() ![]() |
Function | string ScrubLineBreaksBefore(string text); |
Sample | string text = BFS.Text.ScrubLineBreaksBefore("My text"); |
Description | This function removes all tabs from a string. |
Compatibility | ![]() ![]() ![]() |
Function | string ScrubTabs(string text); |
Sample | string text = BFS.Text.ScrubTabs("My text"); |
Description | This function removes all tabs from the end of a string. |
Compatibility | ![]() ![]() ![]() |
Function | string ScrubTabsAfter(string text); |
Sample | string text = BFS.Text.ScrubTabsAfter("My text"); |
Description | This function removes all tabs at the beginning of a string. |
Compatibility | ![]() ![]() ![]() |
Function | string ScrubTabsBefore(string text); |
Sample | string text = BFS.Text.ScrubTabsBefore("My text"); |
Description | This function removes all whitespace from a string. |
Compatibility | ![]() ![]() ![]() |
Function | string ScrubWhitespace(string text); |
Sample | string text = BFS.Text.ScrubWhitespace("My text"); |
Description | This function removes all whitespace from the end of a string. |
Compatibility | ![]() ![]() ![]() |
Function | string ScrubWhitespaceAfter(string text); |
Sample | string text = BFS.Text.ScrubWhitespaceAfter("My text"); |
Description | This function removes all whitespace at the beginning of a string. |
Compatibility | ![]() ![]() ![]() |
Function | string ScrubWhitespaceBefore(string text); |
Sample | string text = BFS.Text.ScrubWhitespaceBefore("My text"); |
Contains functions specific to VoiceBot.
Description | Clears the speech log in the main VoiceBot window. |
Compatibility | ![]() |
Function | void ClearSpeechLog(); |
Sample | bool ok = BFS.VoiceBot.ClearSpeechLog(); |
Description | Gets the name of the active VoiceBot profile. |
Compatibility | ![]() |
Function | string CurrentProfileName(); |
Sample | string profileName = BFS.VoiceBot.CurrentProfileName(); |
Description | Checks for executing macros with the supplied name. |
Compatibility | ![]() |
Function | bool IsMacroRunning(string macroName); |
Sample | BFS.VoiceBot.IsMacroRunning("current time"); |
Description | Starts VoiceBot listening for commands. |
Compatibility | ![]() |
Function | void StartListening(); |
Sample | BFS.VoiceBot.StartListening(); |
Description | Stops VoiceBot from listening to commands. |
Compatibility | ![]() |
Function | void StopListening(); |
Sample | BFS.VoiceBot.StopListening(); |
Description | Stops any currently executing VoiceBot macros. |
Compatibility | ![]() |
Function | void StopMacros(); |
Sample | BFS.VoiceBot.StopMacros(); |
Contains functions to execute VoiceBot Actions.
Description | Change the currently active profile. |
Compatibility | ![]() |
Function | void ChangeProfile(string profileName); |
Sample | BFS.VoiceBotActions.ChangeProfile("Google Chrome"); |
Description | Pause execution of this script for the provided number of milliseconds. |
Compatibility | ![]() |
Function | void Delay(int ms); |
Sample | BFS.VoiceBotActions.Delay(500); |
Description | Press down the selected key combination. |
Compatibility | ![]() |
Function | void KeyDown(string keys); |
Sample | BFS.VoiceBotActions.KeyDown("ctrl;49"); |
Description | Simulates holding down the selected key combination for the specified time in ms. |
Compatibility | ![]() |
Function | void KeyHoldDuration(string keys, int duration); |
Sample | BFS.VoiceBotActions.KeyHoldDuration("ctrl;49", 500); |
Description | Press the selection key combination the provided number of times. |
Compatibility | ![]() |
Function | void KeyHoldRepetition(string keys, int repetitions) |
Sample | BFS.VoiceBotActions.KeyHoldRepetition("ctrl;49", 5); |
Description | Press and release the selected key combination. |
Compatibility | ![]() |
Function | void KeyPress(string keys); |
Sample | BFS.VoiceBotActions.KeyPress("ctrl;49"); |
Description | Toggle the selected key combination between being held down and released. |
Compatibility | ![]() |
Function | void KeyToggle(string keys); |
Sample | BFS.VoiceBotActions.KeyToggle("ctrl;49"); |
Description | Release the selected key combination. |
Compatibility | ![]() |
Function | void KeyUp(string keys); |
Sample | BFS.VoiceBotActions.KeyUp("ctrl;49"); |
Description | Click the selected mouse button. |
Compatibility | ![]() |
Function | void MouseClick(string button); |
Sample | BFS.VoiceBotActions.MouseClick("1"); |
Description | Double click the selected mouse button. |
Compatibility | ![]() |
Function | void MouseDoubleClick(string button); |
Sample | BFS.VoiceBotActions.MouseDoubleClick("1"); |
Description | Press down the selected mouse button. |
Compatibility | ![]() |
Function | void MouseDown(string button); |
Sample | BFS.VoiceBotActions.MouseDown("1"); |
Description | Move the mouse to the specified co-ordinates on the screen. |
Compatibility | ![]() |
Function | void MouseMoveAbsolute(); |
Sample | BFS.VoiceBotActions.MouseMoveAbsolute(50, 100); |
Description | Move the mouse the specified amount from its current position. |
Compatibility | ![]() |
Function | void MouseMoveRelative(); |
Sample | BFS.VoiceBotActions.MouseMoveRelative(50, 100); |
Description | Release the selected held mouse button. |
Compatibility | ![]() |
Function | void MouseUp(string button); |
Sample | BFS.VoiceBotActions.MouseUp("1"); |
Description | Open the selected file in its default program. |
Compatibility | ![]() |
Function | void OpenFile(string filename); |
Sample | BFS.VoiceBotActions.OpenFile(@"C:\files\myfile.txt"); |
Description | Play one of the sounds provided. |
Compatibility | ![]() |
Function | void PlayRandomSound(string[] filenames); |
Sample | BFS.VoiceBotActions.PlayRandomSound(new string[] {"@"C:\sounds\mysound.mp3", @"C:\sounds\mysound1.mp3", @"C:\sounds\mysound2.mp3"}); |
Description | Play the audio file provided. |
Compatibility | ![]() |
Function | void PlaySound(string filename); |
Sample | BFS.VoiceBotActions.PlaySound(@"C:\sounds\mysound.mp3"); |
Description | Execute a macro from the currently active profile. |
Compatibility | ![]() |
Function | void RunMacro(string macroName); |
Sample | BFS.VoiceBotActions.RunMacro("current time"); |
Description | Scroll the mouse wheel down. |
Compatibility | ![]() |
Function | void ScrollMouseWheelDown(); |
Sample | BFS.VoiceBotActions.ScrollMouseWheelDown(); |
Description | Scroll the mouse wheel up. |
Compatibility | ![]() |
Function | void ScrollMouseWheelUp(); |
Sample | BFS.VoiceBotActions.ScrollMouseWheelUp(); |
Description | Open the selected program. |
Compatibility | ![]() |
Function | void StartProgram(string program); |
Sample | BFS.VoiceBotActions.StartProgram(@"C:\Windows\explorer.exe"); |
Description | Open the selected program with specific command line parameters. |
Compatibility | ![]() |
Function | void StartProgramWithParameters(string program, string[] parameters); |
Sample | BFS.VoiceBotActions.StartProgramWithParameters(@"C:\Windows\explorer.exe", new string[] {"/e"}); |
Description | Speak the given text with VoiceBot's default speaking voice, speed, and volume. |
Compatibility | ![]() |
Function | void TextToSpeech(string text); |
Sample | BFS.VoiceBotActions.TextToSpeech("Talk to me"); |
Description | Speak the given text with a specific speed and volume and the requested Text to Speech voice. |
Compatibility | ![]() |
Function | void TextToSpeechCustomstring text, int? volume, int? speed, string voiceName); |
Sample | BFS.VoiceBotActions.TextToSpeechCustom("Talk to me", 100, null, "Microsoft Zira Desktop"); |
Description | Type the provided text. |
Compatibility | ![]() |
Function | void TypeText(string text); |
Sample | BFS.VoiceBotActions.TypeText("My text"); |
Contains functions related to web requests and the internet.
Description | This allows you to download a string or a web page's HTML source. |
Compatibility | ![]() ![]() ![]() |
Function | string DownloadString(string url); |
Sample | string json = BFS.Web.DownloadString("https://www.server.com/file.json"); |
Description | Returns the complete path and filename of the default web browser. |
Compatibility | ![]() ![]() ![]() |
Function | string GetDefaultBrowserExe(); |
Sample | string file = BFS.Web.GetDefaultBrowserExe(); |
Description | Opens the given Url in the default web browser. |
Compatibility | ![]() ![]() ![]() |
Function | bool OpenUrl(string url); |
Sample | bool ok = BFS.Web.OpenUrl("http://www.binaryfortress.com"); |
Description | Opens the given Url in a new default web browser window and returns the new window handle. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr OpenUrlNewWindow(string url); |
Sample | IntPtr windowHandle = BFS.Web.OpenUrlNewWindow("http://www.binaryfortress.com"); |
Contains functions to manipulate desktop windows.
Description | This function adds the given window handle to the Windows taskbar as a taskbar item. |
Compatibility | ![]() ![]() ![]() |
Function | bool AddToWindowsTaskbar(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.AddToWindowsTaskbar(windowHandle); |
Description | Builds a helpful string of debug information aboout the given window handle. |
Compatibility | ![]() ![]() ![]() |
Function | string BuildWindowDebug(IntPtr windowHandle); |
Sample | string debug = BFS.Window.BuildWindowDebug(windowHandle); |
Description | Close the given window handle (kills the window). |
Compatibility | ![]() ![]() ![]() |
Function | bool Close(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.Close(windowHandle); |
Description | Disables the given window, this prevents the window from receiving input. Same as the WS_DISABLED style. |
Compatibility | ![]() ![]() ![]() |
Function | bool DisableWindow(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.DisableWindow(windowHandle); |
Description | Enables the given window handle. |
Compatibility | ![]() ![]() ![]() |
Function | bool EnableWindow(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.EnableWindow(windowHandle); |
Description | Focus the given window handle (make it the top window). |
Compatibility | ![]() ![]() ![]() |
Function | bool Focus(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.Focus(windowHandle); |
Description | Gets an array of all the window handles for all applications. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr[] GetAllWindowHandles(); |
Sample | IntPtr[] handles = BFS.Window.GetAllWindowHandles(); |
Description | Returns true if the given window is always on top. |
Compatibility | ![]() ![]() ![]() |
Function | bool GetAlwaysOnTop(IntPtr windowHandle); |
Sample | bool alwaysOnTop = BFS.Window.GetAlwaysOnTop(windowHandle); |
Description | Returns the window's bounds for the given window handle. |
Compatibility | ![]() ![]() ![]() |
Function | Rectangle GetBounds(IntPtr windowHandle); |
Sample | Rectangle bounds = BFS.Window.GetBounds(windowHandle); |
Description | Gets the direct child window handle for a given parent window, by searching for the given class name. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr GetChildWindowByClass(IntPtr windowHandleParent, string windowClass); |
Sample | IntPtr windowHandle = GetChildWindowByClass(windowHandleParent, "myclass"); |
Description | Gets the given window handle's window class name. |
Compatibility | ![]() ![]() ![]() |
Function | string GetClass(IntPtr windowHandle); |
Sample | string windowClass = BFS.Window.GetClass(windowHandle); |
Description | Returns the client area size (the area inside the window border) for the given window handle. |
Compatibility | ![]() ![]() ![]() |
Function | Rectangle GetClientRect(IntPtr windowHandle); |
Sample | Rectangle client = BFS.Window.GetClientRect(windowHandle); |
Description | Gets the currently focused window (the foreground window). |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr GetFocusedWindow(); |
Sample | IntPtr windowHandle = BFS.Window.GetFocusedWindow(); |
Description | Returns the owner window's handle for the given window handle, if the given window handle has an owner. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr GetOwner(IntPtr windowHandle); |
Sample | IntPtr handleOwner = BFS.Window.GetOwner(windowHandle); |
Description | Returns the parent window's handle for the given window handle. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr GetParent(IntPtr windowHandle); |
Sample | IntPtr handleParent = BFS.Window.GetParent(windowHandle); |
Description | Returns the root parent window's handle for the given window handle. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr GetParentRoot(IntPtr windowHandle); |
Sample | IntPtr handleParentRoot = BFS.Window.GetParentRoot(windowHandle); |
Description | Gets the given window handle's title text. |
Compatibility | ![]() ![]() ![]() |
Function | string GetText(IntPtr windowHandle); |
Sample | string text = BFS.Window.GetText(windowHandle); |
Description | Gets the given windows transparency percent, between 0% and 100%. |
Compatibility | ![]() ![]() ![]() |
Function | decimal GetTransparency(IntPtr windowHandle); |
Sample | decimal percent = BFS.Window.GetTransparency(windowHandle); |
Description | Gets an array of all the visible window handles for all applications including windows that are minimized. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr[] GetVisibleAndMinimizedWindowHandles(); |
Sample | IntPtr[] handles = BFS.Window.GetVisibleAndMinimizedWindowHandles(); |
Description | Gets an array of all the visible window handles for all applications excluding windows that are minimized. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr[] GetVisibleWindowHandles(); |
Sample | IntPtr[] handles = BFS.Window.GetVisibleWindowHandles(); |
Description | Searches through all desktop windows and returns the first one it finds with the given window class. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr GetWindowByClass(string windowClass); |
Sample | IntPtr windowHandle = BFS.Window.GetWindowByClass("mywindowclass"); |
Description | Searches through all desktop windows and returns the first one it finds with the given window text. This method supports wildcards, like "*ends" or "*title*". |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr GetWindowByText(string windowText); |
Sample | IntPtr windowHandle = BFS.Window.GetWindowByText("starts with*"); |
Description | Searches through all desktop windows and returns the first one it finds with the given window text. This method does not support wildcards. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr GetWindowByTextExact(string windowText); |
Sample | IntPtr windowHandle = BFS.Window.GetWindowByTextExact("my title text exactly"); |
Description | Gets the IntPtr value associated with the given window handle and window property name. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr GetWindowProperty(IntPtr windowHandle, string propertyName); |
Sample | IntPtr propertyValue = BFS.Window.GetWindowProperty(windowHandle, "MyProperty"); |
Description | Searches through all desktop windows and returns a list of windows that match the given window text. This method supports wildcards, like "*ends" or "*title*". |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr[] GetWindowsByText(string windowText); |
Sample | IntPtr[] windowHandles = BFS.Window.GetWindowsByText("starts with*"); |
Description | Searches through all desktop windows and returns a list of windows that match the given window text. This method does not support wildcards. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr[] GetWindowsByTextExact(string windowText); |
Sample | IntPtr[] windowHandles = BFS.Window.GetWindowsByTextExact("my window title"); |
Description | Gets the window style for a given window. |
Compatibility | ![]() ![]() ![]() |
Function | BFS.WindowEnum.WindowStyle GetWindowStyle(IntPtr windowHandle); |
Sample | BFS.WindowEnum.WindowStyle windowStyle = BFS.Window.GetWindowStyle(windowHandle); |
Description | Gets the extended window style for a given window. |
Compatibility | ![]() ![]() ![]() |
Function | BFS.WindowEnum.WindowStyleEx GetWindowStyleEx(IntPtr windowHandle); |
Sample | BFS.WindowEnum.WindowStyleEx windowStyle = BFS.Window.GetWindowStyleEx(windowHandle); |
Description | Gets the window handle for the window under the mouse cursor, or the desktop window handle if the cursor is over the desktop. |
Compatibility | ![]() ![]() ![]() |
Function | IntPtr GetWindowUnderMouse(); |
Sample | IntPtr windowHandle = BFS.Window.GetWindowUnderMouse(); |
Description | Checks if the given window has a certain style set. |
Compatibility | ![]() ![]() ![]() |
Function | bool HasWindowStyle(BFS.WindowEnum.WindowStyle windowStyle, IntPtr windowHandle); |
Sample | bool ok = BFS.Window.HasWindowStyle(windowStyle, windowHandle); |
Description | Checks if the given window has a certain extended style set. |
Compatibility | ![]() ![]() ![]() |
Function | bool HasWindowStyleEx(BFS.WindowEnum.WindowStyleEx windowStyleEx, IntPtr windowHandle); |
Sample | bool ok = BFS.Window.HasWindowStyleEx(windowStyle, windowHandle); |
Description | Returns true if the given window handle is hung (not responding). |
Compatibility | ![]() ![]() ![]() |
Function | bool IsHung(IntPtr windowHandle); |
Sample | bool isHung = BFS.Window.IsHung(windowHandle); |
Description | Returns true if the given window handle is maximized. |
Compatibility | ![]() ![]() ![]() |
Function | bool IsMaximized(IntPtr windowHandle); |
Sample | bool isMaximized = BFS.Window.IsMaximized(windowHandle); |
Description | Returns true if the given window handle is minimized. |
Compatibility | ![]() ![]() ![]() |
Function | bool IsMinimized(IntPtr windowHandle); |
Sample | bool isMinimized = BFS.Window.IsMinimized(windowHandle); |
Description | Returns true if the given window handle is restored (not minimized or maximized). |
Compatibility | ![]() ![]() ![]() |
Function | bool IsRestored(IntPtr windowHandle); |
Sample | bool isRestored = BFS.Window.IsRestored(windowHandle); |
Description | Returns true if the given window handle is visible. |
Compatibility | ![]() ![]() ![]() |
Function | bool IsVisible(IntPtr windowHandle); |
Sample | bool isVisible = BFS.Window.IsVisible(windowHandle); |
Description | Maximizes the given window handle. |
Compatibility | ![]() ![]() ![]() |
Function | bool Maximize(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.Maximize(windowHandle); |
Description | Minimizes the given window handle. |
Compatibility | ![]() ![]() ![]() |
Function | bool Minimize(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.Minimize(windowHandle); |
Description | This function removes the given window handle from the Windows taskbar. |
Compatibility | ![]() ![]() ![]() |
Function | bool RemoveFromWindowsTaskbar(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.RemoveFromWindowsTaskbar(windowHandle); |
Description | Removes the given window property name from the given window handle. |
Compatibility | ![]() ![]() ![]() |
Function | bool RemoveWindowProperty(IntPtr windowHandle, string propertyName); |
Sample | bool ok = BFS.Window.RemoveWindowProperty(windowHandle, "MyProperty"); |
Description | Restores the given window handle. |
Compatibility | ![]() ![]() ![]() |
Function | bool Restore(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.Restore(windowHandle); |
Description | Sets the given window to always on top or not on top. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetAlwaysOnTop(IntPtr windowHandle, bool alwaysOnTop); |
Sample | bool ok = BFS.Window.SetAlwaysOnTop(windowHandle, true); |
Description | Moves the given window to 200x300. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetLocation(IntPtr windowHandle, int x, int y); |
Sample | bool ok = BFS.Window.SetLocation(windowHandle, 200, 300); |
Description | Sets the given window handle's owner to WindowHandleOwner. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetOwner(IntPtr windowHandle, IntPtr windowHandleOwner); |
Sample | bool ok = BFS.Window.SetOwner(windowHandle, windowHandleOwner); |
Description | Resizes the given window to 800x600. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetSize(IntPtr windowHandle, int width, int height); |
Sample | bool ok = BFS.Window.SetSize(windowHandle, 800, 600); |
Description | Resizes the given window to 800x600 and moves it to 200x300. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetSizeAndLocation(IntPtr windowHandle, int x, int y, int width, int height); |
Sample | bool ok = BFS.Window.SetSizeAndLocation(windowHandle, 200, 300, 800, 600); |
Description | Sets the given window handle's title text. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetText(IntPtr windowHandle, string text); |
Sample | bool ok = BFS.Window.SetText(windowHandle, text); |
Description | Sets the given windows transparency to 50%. Use values between 0 and 100 for the percent. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetTransparency(IntPtr windowHandle, decimal transparencyPercent); |
Sample | bool ok = BFS.Window.SetTransparency(windowHandle, 50); |
Description | Sets the given window property value. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetWindowProperty(IntPtr windowHandle, string propertyName, IntPtr propertyValue); |
Sample | bool ok = BFS.Window.SetWindowProperty(windowHandle, "MyProperty", new IntPtr(67, "7.0.0+") |
Description | Sets the given window to the given style. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetWindowStyle(BFS.WindowEnum.WindowStyle windowStyle, IntPtr windowHandle); |
Sample | bool ok = BFS.Window.SetWindowStyle(windowStyle, windowHandle); |
Description | Sets the given window to the given extended style. |
Compatibility | ![]() ![]() ![]() |
Function | bool SetWindowStyleEx(BFS.WindowEnum.WindowStyleEx windowStyleEx, IntPtr windowHandle); |
Sample | bool ok = BFS.Window.SetWindowStyleEx(windowStyle, windowHandle); |
Description | Hides all windows and shows the desktop. (same as pressing Win+D) |
Compatibility | ![]() ![]() ![]() |
Function | bool ShowDesktop(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.ShowDesktop(); |
Description | Toggles the given window between always on top and not on top. |
Compatibility | ![]() ![]() ![]() |
Function | bool ToggleAlwaysOnTop(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.ToggleAlwaysOnTop(windowHandle); |