These functions can be used to create your own custom Macro inside ClipboardFusion.
Use C# or Visual Basic and create anything you can imagine!
Need help creating a Macro? Please contact us, we would be happy to help you out!
< Return to ClipboardFusion Macros
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | uint[] GetAllRunningApplicationIDs(); |
Sample | uint[] apps = BFS.Application.GetAllRunningApplicationIDs(); |
Description | Gets the appID (processID) of the given file, if that file is running. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | uint GetAppIDByFile(string file); |
Sample | uint appID = BFS.Application.GetAppIDByFile("*excel.exe"); |
Description | Gets the appID (processID) of the given window. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string GetMainFileByWildcard(string file); |
Sample | string mainfile = GetMainFileByWildcard("*\Outlook.exe"); |
Description | This function returns the main filename from the given window handle. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string GetMainFileByWindow(IntPtr windowHandle); |
Sample | string file = BFS.Application.GetMainFileByWindow(windowHandle); |
Description | Returns the main window handle for the given appID (ProcessID). |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | IntPtr GetMainWindowByFile(string file); |
Sample | IntPtr windowHandle = BFS.Application.GetMainWindowByFile("*excel.exe"); |
Description | Checks if the given appID (ProcessID) is running. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool IsAppRunningByAppID(uint appID); |
Sample | bool isRunning = BFS.Application.IsAppRunningByAppID(appID); |
Description | Checks if the given absolute filename or wildcard is running. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool IsAppRunningByFile(string file); |
Sample | bool isRunning = BFS.Application.IsAppRunningByFile("*excel.exe"); |
Description | Terminates the given appID (ProcessID). |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool Kill(uint appID); |
Sample | bool ok = BFS.Application.Kill(appID); |
Description | Starts the given application using the command line parameters (optional). |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool AdjustVolumeDown(); |
Sample | bool ok = BFS.Audio.AdjustVolumeDown(); |
Description | Adjusts the master volume up one tick. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool AdjustVolumeUp(); |
Sample | bool ok = BFS.Audio.AdjustVolumeUp(); |
Description | Gets whether or not an application is muted from its process ID. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | decimal GetApplicationVolume(uint appID); |
Sample | decimal volume = BFS.Audio.SetApplicationVolume(appID); |
Description | Gets the name of the default playback device for communications. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string GetDefaultPlaybackCommunications(); |
Sample | string defaultName = BFS.Audio.GetDefaultPlaybackCommunications(); |
Description | Gets the name of the default playback device for sounds. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string GetDefaultPlaybackSounds(); |
Sample | string defaultName = BFS.Audio.GetDefaultPlaybackSounds(); |
Description | Gets the name of the default recording device for communications. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string GetDefaultRecordingCommunications(); |
Sample | string defaultName = BFS.Audio.GetDefaultRecordingCommunications(); |
Description | Gets the name of the default recording device for sounds. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string GetDefaultRecordingSounds(); |
Sample | string defaultName = BFS.Audio.GetDefaultRecordingSounds(); |
Description | Returns the current muted status for the system volume. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool GetMute(); |
Sample | bool muted = BFS.Audio.GetMute(); |
Description | Gets a list of all the enabled playback devices. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string[] GetPlaybackDevices(); |
Sample | string[] devices = GetPlaybackDevices(); |
Description | Gets a list of all the enabled recording devices. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string[] GetRecordingDevices(); |
Sample | string[] devices = GetRecordingDevices(); |
Description | Gets current the master volume level for the system. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | decimal GetVolume(); |
Sample | decimal volume = BFS.Audio.GetVolume(); |
Description | This function allows you to play an audio file (wav, mp3... etc). |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool SetApplicationVolumeMin(uint appID); |
Sample | bool ok = BFS.Audio.SetApplicationVolumeMin(appID); |
Description | Sets the default playback device for communications (like Skype). |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool SetDefaultPlaybackSounds(string name); |
Sample | bool ok = BFS.Audio.SetDefaultPlaybackSounds("Main Speakers"); |
Description | Sets the default recording device for communications (like Skype). |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool SetDefaultRecordingSounds(string name); |
Sample | bool ok = BFS.Audio.SetDefaultRecordingSounds("Main Microphone"); |
Description | Sets the master system volume to muted or unmuted. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool SetMute(bool mute); |
Sample | bool ok = BFS.Audio.SetMute(true); |
Description | Sets the master system volume. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool SetVolume(decimal volume); |
Sample | bool ok = BFS.Audio.SetVolume(0.5m); |
Description | Sets the master volume to maximum. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool SetVolumeMax(); |
Sample | bool ok = BFS.Audio.SetVolumeMax(); |
Description | Sets the master volume to 0. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool SetVolumeMin(); |
Sample | bool ok = BFS.Audio.SetVolumeMin(); |
Description | Toggles the master volume mute on/off. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool ToggleMute(); |
Sample | bool ok = BFS.Audio.ToggleMute(); |
Contains functions to deal with the Clipboard.
Description | Clears the clipboard. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool Clear(); |
Sample | bool ok = BFS.Clipboard.Clear(); |
Description | Copies from the currently active window. (same as pressing Ctrl+C) |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string CopyText(); |
Sample | string text = BFS.Clipboard.CopyText(); |
Description | Returns the text value that is currently on the clipboard. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string GetText(); |
Sample | string text = BFS.Clipboard.GetText(); |
Description | Returns true if the clipboard currently contains an image. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool HasImage(); |
Sample | bool hasImage = BFS.Clipboard.HasImage(); |
Description | Returns true if the clipboard currently contains text. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool HasText(); |
Sample | bool hasText = BFS.Clipboard.HasText(); |
Description | Pastes to the currently active window. (same as pressing Ctrl+V) |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool Paste(); |
Sample | bool ok = BFS.Clipboard.Paste(); |
Description | Pastes the given text to the current active window. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool PasteText(string text); |
Sample | bool ok = BFS.Clipboard.PasteText("My text."); |
Description | Sets the given html code to the clipboard. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool SetText(string text); |
Sample | bool ok = BFS.Clipboard.SetText("My text."); |
Contains functions specific to ClipboardFusion.
Description | Adds a list of files to the Clipboard History. |
Compatibility | ClipboardFusion: |
Function | void AddHistoryFileList(string[] paths) |
Sample | BFS.ClipboardFusion.AddHistoryFileList(new string[]{"C:\test.txt", "C:\image.jpg"}); |
Description | Adds an image to the Clipboard History. |
Compatibility | ClipboardFusion: |
Function | void AddHistoryImage(Bitmap image) |
Sample | BFS.ClipboardFusion.AddHistoryImage(myImage); |
Description | Adds text to the Clipboard History. |
Compatibility | ClipboardFusion: |
Function | void AddHistoryText(string text) |
Sample | BFS.ClipboardFusion.AddHistoryText("text"); |
Description | This function adds a new Local Pinned Item to the end of the list, with the file list provided. |
Compatibility | ClipboardFusion: |
Function | void AddLocalPinnedFileList(string[] paths); |
Sample | BFS.ClipboardFusion.AddLocalPinnedFileList(files); |
Description | This function adds a new Local Pinned Item to the end of the list, with the image provided. |
Compatibility | ClipboardFusion: |
Function | void AddLocalPinnedImage(Bitmap image); |
Sample | BFS.ClipboardFusion.AddLocalPinnedImage(image); |
Description | This function adds a new Local Pinned Item to the end of the list, with the text provided. |
Compatibility | ClipboardFusion: |
Function | void AddLocalPinnedText(string text); |
Sample | BFS.ClipboardFusion.AddLocalPinnedText("text"); |
Description | Adds a file list to the list that was selected when the Macro was run. Only works with History and Local Pinned Item lists. |
Compatibility | ClipboardFusion: |
Function | AddSelectedListFileList(string[] paths); |
Sample | BFS.ClipboardFusion.AddSelectedListFileList(files); |
Description | Adds an image to the list that was selected when the Macro was run. Only works with History and Local Pinned Item lists. |
Compatibility | ClipboardFusion: |
Function | AddSelectedListImage(Bitmap image); |
Sample | BFS.ClipboardFusion.AddSelectedListImage(image); |
Description | Adds text to the list that was selected when the Macro was run. Does not work with the Macros list. |
Compatibility | ClipboardFusion: |
Function | AddSelectedListText(string text); |
Sample | BFS.ClipboardFusion.AddSelectedListText("text"); |
Description | This function retrieves all of the text from your Online Pinned Items. |
Compatibility | ClipboardFusion: |
Function | string[] CFOGetAllPinnedText(); |
Sample | string[] allPinnedText = BFS.ClipboardFusion.CFOGetAllPinnedText(); |
Description | This function retrieves all of the text from your Online Recent Items. |
Compatibility | ClipboardFusion: |
Function | string[] CFOGetAllSavedText(); |
Sample | string[] allSavedText = BFS.ClipboardFusion.CFOGetAllSavedText(); |
Description | This function retrieves the last synced item. |
Compatibility | ClipboardFusion: |
Function | string CFOGetLastSavedText(); |
Sample | string text = BFS.ClipboardFusion.CFOGetLastSavedText(); |
Description | This function get the text from your Online Pinned Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | string CFOGetPinnedText(int index); |
Sample | string pinnedText = BFS.ClipboardFusion.CFOGetPinnedText(); |
Description | This function retrieves the synced item from the specified index. |
Compatibility | ClipboardFusion: |
Function | string CFOGetSavedText(int index); |
Sample | string text = BFS.ClipboardFusion.CFOGetSavedText(0); //Gets the first item |
Description | Removes the Pinned Online Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | void CFORemovePinnedText(int index) |
Sample | BFS.ClipboardFusion.CFORemovePinnedText(0); |
Description | Removes the Recent Online Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | void CFORemoveSavedText(int index) |
Sample | BFS.ClipboardFusion.CFORemoveSavedText(0); |
Description | Saves a new Pinned Online Item to ClipboardFusion Online. |
Compatibility | ClipboardFusion: |
Function | bool CFOSavePinnedText(string text) |
Sample | BFS.ClipboardFusion.CFOSavePinnedText("text"); |
Description | This function syncs the given text to your Binary Fortress Account. |
Compatibility | ClipboardFusion: |
Function | bool CFOSaveText(string text); |
Sample | bool ok = BFS.ClipboardFusion.CFOSaveText("My text."); |
Description | Sets the text of the Pinned Online Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | void CFOSetPinnedText(int index, string text) |
Sample | BFS.ClipboardFusion.CFOSetPinnedText(0, "text"); |
Description | Sets the text of the Recent Online Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | void CFOSetSavedText(int index, string text) |
Sample | BFS.ClipboardFusion.CFOSetSavedText(0, "text"); |
Description | This function clears the Clipboard History. |
Compatibility | ClipboardFusion: |
Function | bool ClearHistory(); |
Sample | bool ok = BFS.ClipboardFusion.ClearHistory(); |
Description | Converts a device indpendant bitmap into a bitmap object. |
Compatibility | ClipboardFusion: |
Function | Bitmap ConvertDibToBitmap(byte[] dib) |
Sample | Bitmap bitmap = ConvertDibToBitmap(data); |
Description | Converts a bitmap into a device indpendant bitmap. |
Compatibility | ClipboardFusion: |
Function | byte[] ConvertToDib5(Bitmap bitmap) |
Sample | byte[] dib = ConvertToDib5(bitmap); |
Description | This function retrieves all of the text from the Clipboard History. |
Compatibility | ClipboardFusion: |
Function | string[] GetAllHistoryText(); |
Sample | string[] allText = BFS.ClipboardFusion.GetAllHistoryText(); |
Description | This function returns the text of every Local Pinned Item. |
Compatibility | ClipboardFusion: |
Function | string[] GetAllLocalPinnedText(); |
Sample | string[] allText = BFS.ClipboardFusion.GetAllLocalPinnedText(); |
Description | Gets all of the text from the list that was selected when the Macro was first run. |
Compatibility | ClipboardFusion: |
Function | string[] GetAllSelectedListText(); |
Sample | string[] allText = BFS.ClipboardFusion.GetAllSelectedListText(); |
Description | Get the index that was selected when the Macro was first run. |
Compatibility | ClipboardFusion: |
Function | int GetClipboardManagerSelectedIndex(); |
Sample | int selectedIndex = BFS.ClipboardFusion.GetClipboardManagerSelectedIndex(); |
Description | This function retrieves the list of files from the history item at the specified index. |
Compatibility | ClipboardFusion: |
Function | string[] GetHistoryFileList(int index); |
Sample | string[] files = BFS.ClipboardFusion.GetHistoryFileList(0); |
Description | This function returns the image from a specific index in the Clipboard History. |
Compatibility | ClipboardFusion: |
Function | Image GetHistoryImage(int index); |
Sample | Image picture = BFS.ClipboardFusion.GetHistoryImage(0); //Gets the first image |
Description | This function returns true if there is a file list at the specified index. |
Compatibility | ClipboardFusion: |
Function | bool GetHistoryIndexContainsFileList(int index); |
Sample | bool hasFiles = BFS.ClipboardFusion.GetHistoryIndexContainsFileList(0); |
Description | This function returns true if there is an image at the specified index. |
Compatibility | ClipboardFusion: |
Function | bool GetHistoryIndexContainsImage(int index); |
Sample | bool hasImage = BFS.ClipboardFusion.GetHistoryIndexContainsImage(0); |
Description | This function returns true if there is text at the specified index. |
Compatibility | ClipboardFusion: |
Function | bool GetHistoryIndexContainsText(int index); |
Sample | bool hasText = BFS.ClipboardFusion.GetHistoryIndexContainsText(0); |
Description | This function returns the number of items that are currently in the Clipboard History. |
Compatibility | ClipboardFusion: |
Function | int GetHistoryItemCount(); |
Sample | int count = BFS.ClipboardFusion.GetHistoryItemCount(); |
Description | This function retrieves an item from a specific index in the Clipboard History. |
Compatibility | ClipboardFusion: |
Function | string GetHistoryText(int index); |
Sample | string text = BFS.ClipboardFusion.GetHistoryText(0); //Gets the first item |
Description | This function retrieves the last saved item in the Clipboard History. |
Compatibility | ClipboardFusion: |
Function | string GetLastHistoryText(); |
Sample | string text = BFS.ClipboardFusion.GetLastHistoryText(); |
Description | This function returns the file list of the Local Pinned Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | string[] GetLocalPinnedFileList(int index); |
Sample | string[] files = BFS.ClipboardFusion.GetLocalPinnedFileList(0); |
Description | This function returns the image of the Local Pinned Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | Bitmap GetLocalPinnedImage(int index); |
Sample | Bitmap image = BFS.ClipboardFusion.GetLocalPinnedImage(0); |
Description | This function returns true if the Local Pinned Item at the index contains a file list. |
Compatibility | ClipboardFusion: |
Function | bool GetLocalPinnedItemContainsFileList(int index); |
Sample | bool hasData = BFS.ClipboardFusion.GetLocalPinnedItemContainsFileList(0); |
Description | This function returns true if the Local Pinned Item at the index contains an image. |
Compatibility | ClipboardFusion: |
Function | bool GetLocalPinnedItemContainsImage(int index); |
Sample | bool hasData = BFS.ClipboardFusion.GetLocalPinnedItemContainsImage(0); |
Description | This function returns true if the Local Pinned Item at the index contains text. |
Compatibility | ClipboardFusion: |
Function | bool GetLocalPinnedItemContainsText(int index); |
Sample | bool hasData = BFS.ClipboardFusion.GetLocalPinnedItemContainsText(0); |
Description | This function returns the number of Local Pinned Items in the list. |
Compatibility | ClipboardFusion: |
Function | GetLocalPinnedItemCount(); |
Sample | int count = BFS.ClipboardFusion.GetLocalPinnedItemCount(); |
Description | This function returns the text of the Local Pinned Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | string GetLocalPinnedText(int index); |
Sample | string text = BFS.ClipboardFusion.GetLocalPinnedText(0); |
Description | Gets an array of macro names. |
Compatibility | ClipboardFusion: |
Function | string[] GetMacros(); |
Sample | string[] macros = BFS.ClipboardFusion.GetMacros(); |
Description | Gets the list that was selected when the Macro was run. The possible values are: History, LocalPinned, OnlineRecent, OnlinePinned, and Macros. |
Compatibility | ClipboardFusion: |
Function | BFS.ClipboardFusion.ClipboardManagerListEnum GetSelectedClipboardManagerList(); |
Sample | BFS.ClipboardFusion.ClipboardManagerListEnum selectedList = BFS.ClipboardFusion.GetSelectedClipboardManagerList(); |
Description | Gets a list of files from the list that was selected when the Macro was first run at the specified index. Only works with History and Local Pinned Item lists. |
Compatibility | ClipboardFusion: |
Function | string[] GetSelectedListFileList(int index); |
Sample | string files = BFS.ClipboardFusion.GetSelectedListFileList(0); |
Description | Gets the image from the specified index from the list that was selected when the Macro was first run. Only works with History and Local Pinned Item lists. |
Compatibility | ClipboardFusion: |
Function | Bitmap GetSelectedListImage(int index); |
Sample | Bitmap image = BFS.ClipboardFusion.GetSelectedListImage(0); |
Description | This function return true if the specified index contains a file list from the list that was selected when the Macro first run. Only works with History and Local Pinned Item lists. |
Compatibility | ClipboardFusion: |
Function | bool GetSelectedListItemContainsFileList(int index); |
Sample | bool hasData = BFS.ClipboardFusion.GetSelectedListItemContainsFileList(0); |
Description | This function return true if the specified index contains an image from the list that was selected when the Macro first run. Only works with History and Local Pinned Item lists. |
Compatibility | ClipboardFusion: |
Function | bool GetSelectedListItemContainsImage(int index); |
Sample | bool hasData = BFS.ClipboardFusion.GetSelectedListItemContainsImage(0); |
Description | This function return true if the specified index contains text from the list that was selected when the Macro first run. Does not work with the Macros list. |
Compatibility | ClipboardFusion: |
Function | bool GetSelectedListItemContainsText(int index); |
Sample | bool hasData = BFS.ClipboardFusion.GetSelectedListItemContainsText(0); |
Description | Gets the number of items in the list that was selected when the Macro was first run. |
Compatibility | ClipboardFusion: |
Function | int GetSelectedListItemCount(); |
Sample | int count = BFS.ClipboardFusion.GetSelectedListItemCount(); |
Description | Gets the text at the specified index from the list that was selected when the Macro was first run. |
Compatibility | ClipboardFusion: |
Function | string GetSelectedListText(int index); |
Sample | string text = BFS.ClipboardFusion.GetSelectedListText(0); |
Description | Returns whether or not Auto Syncing is enabled. |
Compatibility | ClipboardFusion: |
Function | bool IsAutoSyncEnabled(); |
Sample | bool enabled = BFS.ClipboardFusion.IsAutoSyncEnabled(); |
Description | This function returns true if ClipboardFusoin is currently syncing with ClipboardFusion Online. |
Compatibility | ClipboardFusion: |
Function | bool IsClipboardFusionSyncing() |
Sample | bool isSyncing = BFS.ClipboardFusion.IsClipboardFusionSyncing(); |
Description | This function returns true if ClipboardFusoin is watching the Clipboard. |
Compatibility | ClipboardFusion: |
Function | bool IsClipboardListenerRunning() |
Sample | bool isRunning = BFS.ClipboardFusion.IsClipboardListenerRunning(); |
Description | Returns whether or not Online Syncing is enabled. |
Compatibility | ClipboardFusion: |
Function | bool IsOnlineEnabled(); |
Sample | bool enabled = BFS.ClipboardFusion.IsOnlineEnabled(); |
Description | This function stops ClipboardFusion from watching the Clipboard. |
Compatibility | ClipboardFusion: |
Function | void PauseClipboardListener() |
Sample | BFS.ClipboardFusion.PauseClipboardListener(); |
Description | Removes the Clipboard History Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | void RemoveHistoryItem(int index) |
Sample | BFS.ClipboardFusion.RemoveHistoryItem(0); |
Description | This function removes the Local Pinned Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | void RemoveLocalPinnedItem(int index); |
Sample | BFS.ClipboardFusion.RemoveLocalPinnedItem(0); |
Description | Removes an item from the list that was selected when the Macro was first run. |
Compatibility | ClipboardFusion: |
Function | RemoveSelectedListItem(int index); |
Sample | BFS.ClipboardFusion.RemoveSelectedListItem(0); |
Description | This function gets ClipboardFusion to continue watching the Clipboard. |
Compatibility | ClipboardFusion: |
Function | void ResumeClipboardListener() |
Sample | BFS.ClipboardFusion.ResumeClipboardListener(); |
Description | This function allows you to run other Macros you have created. |
Compatibility | ClipboardFusion: |
Function | bool RunMacro(string macroName, string text, out string textOut); bool BFS.ClipboardFusion.RunMacro(string macroName, string text, out string textOut, out string error); |
Sample | string text; bool ok = BFS.ClipboardFusion.RunMacro("My Macro", "Testing Text.", out text); string text; string error; bool ok = BFS.ClipboardFusion.RunMacro("My Macro", "Testing Text.", out text, out error); |
Description | Runs the Triggers in the Trigger Command section, and returns the result. |
Compatibility | ClipboardFusion: |
Function | string RunTriggers(string text); |
Sample | string text = BFS.ClipboardFusion.RunTriggers("text"); |
Description | Sets the Auto Syncing setting. |
Compatibility | ClipboardFusion: |
Function | void SetAutoSyncEnabled(bool enabled); |
Sample | BFS.ClipboardFusion.SetAutoSyncEnabled(enabled); |
Description | Sets the Clipboard with a Clipboard History Item specified by the index. |
Compatibility | ClipboardFusion: |
Function | void SetClipboardWithHistoryItem(int index) |
Sample | SetClipboardWithHistoryItem(0); |
Description | Sets the Clipboard with a Local Pinned Item specified by the index. |
Compatibility | ClipboardFusion: |
Function | void SetClipboardWithLocalPinnedItem(int index) |
Sample | SetClipboardWithLocalPinnedItem(0); |
Description | Sets the Clipboard with an Online Pinned Item specified by the index. |
Compatibility | ClipboardFusion: |
Function | void SetClipboardWithOnlinePinnedItem(int index) |
Sample | SetClipboardWithOnlinePinnedItem(0); |
Description | Sets the Clipboard with an Online Recent Item specified by the index. |
Compatibility | ClipboardFusion: |
Function | void SetClipboardWithOnlineRecentItem(int index) |
Sample | SetClipboardWithOnlineRecentItem(0); |
Description | Sets the Clipboard with an item from the selected list, specified by the index. |
Compatibility | ClipboardFusion: |
Function | void SetClipboardWithSelectedList(int index) |
Sample | SetClipboardWithSelectedList(0); |
Description | Sets the files of the Clipboard History Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | void SetHistoryFileList(int index, string[] paths) |
Sample | BFS.ClipboardFusion.SetHistoryFileList(0, new string[]{"C:\test.txt", "C:\image.jpg"}); |
Description | Sets the image of the Clipboard History Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | void SetHistoryImage(int index, Bitmap image) |
Sample | BFS.ClipboardFusion.SetHistoryImage(0, myImage); |
Description | Sets the text of the Clipboard History Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | void SetHistoryText(int index, string text) |
Sample | BFS.ClipboardFusion.SetHistoryText(0, "text"); |
Description | This function sets the file list of the Local Pinned Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | void SetLocalPinnedFileList(int index, string[] paths); |
Sample | BFS.ClipboardFusion.SetLocalPinnedFileList(0, paths); |
Description | This function sets the image of the Local Pinned Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | void SetLocalPinnedImage(int index, Bitmap image); |
Sample | BFS.ClipboardFusion.SetLocalPinnedImage(0, image); |
Description | This function sets the text of the Local Pinned Item at the specified index. |
Compatibility | ClipboardFusion: |
Function | void SetLocalPinnedText(int index, string text); |
Sample | BFS.ClipboardFusion.SetLocalPinnedText(0, "text"); |
Description | Sets the index of the list that was selected when the Macro was first run with the specified files. Only works with History and Local Pinned Item lists. |
Compatibility | ClipboardFusion: |
Function | SetSelectedListFileList(int index, string[] paths); |
Sample | BFS.ClipboardFusion.SetSelectedListFileList(0, files); |
Description | Sets the index of the list that was selected when the Macro was first run with the specified image. Only works with History and Local Pinned Item lists. |
Compatibility | ClipboardFusion: |
Function | SetSelectedListImage(int index, Bitmap image); |
Sample | BFS.ClipboardFusion.SetSelectedListImage(0, image); |
Description | Sets the index of the list that was selected when the Macro was first run with the specified text. Does not work with the Macros list. |
Compatibility | ClipboardFusion: |
Function | SetSelectedListText(int index, string text); |
Sample | BFS.ClipboardFusion.SetSelectedListText(0, "text"); |
Description | Shows the Clipboard Manager Pinned tab. |
Compatibility | ClipboardFusion: |
Function | void ShowLocalPinnedItemMenu(isFocusingQuery = false); |
Sample | BFS.ClipboardFusion.ShowLocalPinnedItemMenu(); |
Description | Shows the Clipboard Manager Macro tab. |
Compatibility | ClipboardFusion: |
Function | void ShowMacroMenu(isFocusingQuery = false); |
Sample | BFS.ClipboardFusion.ShowMacroMenu(); |
Description | Shows the Clipboard Manager Online Pinned tab. |
Compatibility | ClipboardFusion: |
Function | void ShowOnlinePinnedItemMenu(isFocusingQuery = false); |
Sample | BFS.ClipboardFusion.ShowOnlinePinnedItemMenu(); |
Description | Shows the Clipboard Manager Online Recent tab. |
Compatibility | ClipboardFusion: |
Function | void ShowOnlineRecentItemMenu(isFocusingQuery = false); |
Sample | BFS.ClipboardFusion.ShowOnlineRecentItemMenu(); |
Description | Shows the Preview Popup window. |
Compatibility | ClipboardFusion: |
Function | void ShowPreviewPopup(); |
Sample | BFS.ClipboardFusion.ShowPreviewPopup(); |
Description | Shows the Clipboard Manager History tab. |
Compatibility | ClipboardFusion: |
Function | void ShowQuickHistoryMenu(isFocusingQuery = false); |
Sample | BFS.ClipboardFusion.ShowQuickHistoryMenu(); |
Description | Shows the Settings window. |
Compatibility | ClipboardFusion: |
Function | void ShowSettingsWindow(); |
Sample | BFS.ClipboardFusion.ShowSettingsWindow(); |
Description | Toggles the Online Syncing setting on and off. |
Compatibility | ClipboardFusion: |
Function | void ToggleOnlineEnabled(); |
Sample | BFS.ClipboardFusion.ToggleOnlineEnabled(); |
Description | Toggles the Trigger Command on and off. |
Compatibility | ClipboardFusion: |
Function | void ToggleTriggerCommandOverride(); |
Sample | BFS.ClipboardFusion.ToggleTriggerCommandOverride(); |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | void ShowMessageInfoMonospaced(string message); |
Sample | BFS.Dialog.ShowMessageInfoMonospaced("This is a monospaced message!"); |
Description | Shows a tray balloon or toast message. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string GetAppExecutable(); |
Sample | string exe = BFS.General.GetAppExecutable(); |
Description | Gets the current application's installation folder. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string GetAppInstallPath(); |
Sample | string path = BFS.General.GetAppInstallPath(); |
Description | Returns true if the application is currently the Pro Licenses version. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool GetAppIsProVersion(); |
Sample | bool isPro = BFS.General.GetAppIsProVersion(); |
Description | Gets the current application's version. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string GetAppVersion(); |
Sample | string version = BFS.General.GetAppVersion(); |
Description | Returns true if the desktop is currently locked. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool IsDesktopLocked(); |
Sample | bool isLocked = BFS.General.IsDesktopLocked(); |
Description | Locks the desktop and forces the user to login again. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool LockDesktop(); |
Sample | bool ok = BFS.General.LockDesktop(); |
Description | Logs a text string in your Debug log (if enabled) for troubleshooting. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool SleepMonitors(); |
Sample | bool ok = BFS.General.SleepMonitors(); |
Description | Waits for 500ms before running the next lines of code. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool ThreadWait(uint waitMS); |
Sample | bool ok = BFS.General.ThreadWait(500); |
Description | Wakes up any sleeping (power-saving) monitors. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | int GetMousePositionX(); |
Sample | int mouseX = BFS.Input.GetMousePositionX(); |
Description | Gets the mouse Y position on the screen. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool IsMouseDown(string buttons); |
Sample | bool isMouseDown = BFS.Input.IsMouseDown("1;"); |
Description | Simulates a mouse left-click at the current mouse position. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool LeftClickMouse(); |
Sample | bool ok = BFS.Input.LeftClickMouse(); |
Description | Simulates a mouse middle-click at the current mouse position. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool MiddleClickMouse(); |
Sample | bool ok = BFS.Input.MiddleClickMouse() |
Description | Simulates a mouse right-click at the current mouse position. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool SendKeysWithoutWait(string keys); |
Sample | bool ok = BFS.Input.SendKeysWithoutWait("%{X}"); //Sends Alt+X |
Description | Releases a key that was previously pressed. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool DeleteAllValues(); |
Sample | bool ok = BFS.ScriptSettings.DeleteAllValues(); |
Description | Deletes the value with the given name. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string[] GetValueNames(); |
Sample | string[] names = GetValueNames(); |
Description | Reads a setting value as a string from the given name. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool IsWindowsTaskbarAutoHideEnabled(); |
Sample | bool isAutoHidden = BFS.Taskbar.IsWindowsTaskbarAutoHideEnabled(); |
Description | This function allows you to enable or disable the Windows taskbar auto-hide. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string ScrubLineBreaksBefore(string text); |
Sample | string text = BFS.Text.ScrubLineBreaksBefore("My text"); |
Description | This function removes all tabs from a string. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string ScrubTabsBefore(string text); |
Sample | string text = BFS.Text.ScrubTabsBefore("My text"); |
Description | This function removes all whitespace from a string. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string ScrubWhitespaceBefore(string text); |
Sample | string text = BFS.Text.ScrubWhitespaceBefore("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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string GetDefaultBrowserExe(); |
Sample | string file = BFS.Web.GetDefaultBrowserExe(); |
Description | Opens the given Url in the default web browser. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string BuildWindowDebug(IntPtr windowHandle); |
Sample | string debug = BFS.Window.BuildWindowDebug(windowHandle); |
Description | Close the given window handle (kills the window). |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool DisableWindow(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.DisableWindow(windowHandle); |
Description | Enables the given window handle. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool EnableWindow(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.EnableWindow(windowHandle); |
Description | Focus the given window handle (make it the top window). |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | IntPtr[] GetAllWindowHandles(); |
Sample | IntPtr[] handles = BFS.Window.GetAllWindowHandles(); |
Description | Returns true if the given window is always on top. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool GetAlwaysOnTop(IntPtr windowHandle); |
Sample | bool alwaysOnTop = BFS.Window.GetAlwaysOnTop(windowHandle); |
Description | Returns the window's bounds for the given window handle. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | IntPtr GetChildWindowByClass(IntPtr windowHandleParent, string windowClass); |
Sample | IntPtr windowHandle = GetChildWindowByClass(windowHandleParent, "myclass"); |
Description | Gets the given window handle's window class name. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | Rectangle GetClientRect(IntPtr windowHandle); |
Sample | Rectangle client = BFS.Window.GetClientRect(windowHandle); |
Description | Gets the currently focused window (the foreground window). |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | IntPtr GetParentRoot(IntPtr windowHandle); |
Sample | IntPtr handleParentRoot = BFS.Window.GetParentRoot(windowHandle); |
Description | Gets the given window handle's title text. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | string GetText(IntPtr windowHandle); |
Sample | string text = BFS.Window.GetText(windowHandle); |
Description | Gets the given windows transparency percent, between 0% and 100%. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | IntPtr[] GetWindowsByTextExact(string windowText); |
Sample | IntPtr[] windowHandles = BFS.Window.GetWindowsByTextExact("my window title"); |
Description | Gets the window style for a given window. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | IntPtr GetWindowUnderMouse(); |
Sample | IntPtr windowHandle = BFS.Window.GetWindowUnderMouse(); |
Description | Checks if the given window has a certain style set. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool IsHung(IntPtr windowHandle); |
Sample | bool isHung = BFS.Window.IsHung(windowHandle); |
Description | Returns true if the given window handle is maximized. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool IsMaximized(IntPtr windowHandle); |
Sample | bool isMaximized = BFS.Window.IsMaximized(windowHandle); |
Description | Returns true if the given window handle is minimized. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool IsRestored(IntPtr windowHandle); |
Sample | bool isRestored = BFS.Window.IsRestored(windowHandle); |
Description | Returns true if the given window handle is visible. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool IsVisible(IntPtr windowHandle); |
Sample | bool isVisible = BFS.Window.IsVisible(windowHandle); |
Description | Maximizes the given window handle. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool Maximize(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.Maximize(windowHandle); |
Description | Minimizes the given window handle. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool RemoveWindowProperty(IntPtr windowHandle, string propertyName); |
Sample | bool ok = BFS.Window.RemoveWindowProperty(windowHandle, "MyProperty"); |
Description | Restores the given window handle. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool SetAlwaysOnTop(IntPtr windowHandle, bool alwaysOnTop); |
Sample | bool ok = BFS.Window.SetAlwaysOnTop(windowHandle, true); |
Description | Moves the given window to 200x300. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool SetOwner(IntPtr windowHandle, IntPtr windowHandleOwner); |
Sample | bool ok = BFS.Window.SetOwner(windowHandle, windowHandleOwner); |
Description | Resizes the given window to 800x600. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool SetTransparency(IntPtr windowHandle, decimal transparencyPercent); |
Sample | bool ok = BFS.Window.SetTransparency(windowHandle, 50); |
Description | Sets the given window property value. |
Compatibility | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
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 | DisplayFusion: ClipboardFusion: VoiceBot: |
Function | bool ToggleAlwaysOnTop(IntPtr windowHandle); |
Sample | bool ok = BFS.Window.ToggleAlwaysOnTop(windowHandle); |