Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions API-Reference/Flow.Launcher.Plugin.SharedCommands.md

This file was deleted.

26 changes: 26 additions & 0 deletions API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# FilesFolders class

```csharp
public static class FilesFolders
```

## Public Members

| name | description |
| --- | --- |
| static [CopyAll](FilesFolders/CopyAll.md)(…) | Copies the folder and all of its files and folders including subfolders to the target location |
| static [FileExists](FilesFolders/FileExists.md)(…) | |
| static [GetPreviousExistingDirectory](FilesFolders/GetPreviousExistingDirectory.md)(…) | Gets the previous level directory from a path string. Checks that previous level directory exists and returns it as a path string, or empty string if doesn't exist |
| static [IsLocationPathString](FilesFolders/IsLocationPathString.md)(…) | This checks whether a given string is a directory path or network location string. It does not check if location actually exists. |
| static [LocationExists](FilesFolders/LocationExists.md)(…) | |
| static [OpenContainingFolder](FilesFolders/OpenContainingFolder.md)(…) | |
| static [OpenPath](FilesFolders/OpenPath.md)(…) | |
| static [RemoveFolderIfExists](FilesFolders/RemoveFolderIfExists.md)(…) | |
| static [ReturnPreviousDirectoryIfIncompleteString](FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md)(…) | Returns the previous level directory if path incomplete (does not end with '\'). Does not check if previous level directory exists. Returns passed in string if is complete path |
| static [VerifyBothFolderFilesEqual](FilesFolders/VerifyBothFolderFilesEqual.md)(…) | |

## See Also

* namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# FilesFolders.CopyAll method

Copies the folder and all of its files and folders including subfolders to the target location

```csharp
public static void CopyAll(this string sourcePath, string targetPath)
```

| parameter | description |
| --- | --- |
| sourcePath | |
| targetPath | |

## See Also

* class [FilesFolders](../FilesFolders.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# FilesFolders.FileExists method

```csharp
public static bool FileExists(this string filePath)
```

## See Also

* class [FilesFolders](../FilesFolders.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# FilesFolders.GetPreviousExistingDirectory method

Gets the previous level directory from a path string. Checks that previous level directory exists and returns it as a path string, or empty string if doesn't exist

```csharp
public static string GetPreviousExistingDirectory(Func<string, bool> locationExists, string path)
```

## See Also

* class [FilesFolders](../FilesFolders.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# FilesFolders.IsLocationPathString method

This checks whether a given string is a directory path or network location string. It does not check if location actually exists.

```csharp
public static bool IsLocationPathString(this string querySearchString)
```

## See Also

* class [FilesFolders](../FilesFolders.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# FilesFolders.LocationExists method

```csharp
public static bool LocationExists(this string path)
```

## See Also

* class [FilesFolders](../FilesFolders.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# FilesFolders.OpenContainingFolder method

```csharp
public static void OpenContainingFolder(string path)
```

## See Also

* class [FilesFolders](../FilesFolders.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# FilesFolders.OpenPath method

```csharp
public static void OpenPath(string fileOrFolderPath)
```

## See Also

* class [FilesFolders](../FilesFolders.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# FilesFolders.RemoveFolderIfExists method

```csharp
public static void RemoveFolderIfExists(this string path)
```

## See Also

* class [FilesFolders](../FilesFolders.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# FilesFolders.ReturnPreviousDirectoryIfIncompleteString method

Returns the previous level directory if path incomplete (does not end with '\'). Does not check if previous level directory exists. Returns passed in string if is complete path

```csharp
public static string ReturnPreviousDirectoryIfIncompleteString(string path)
```

## See Also

* class [FilesFolders](../FilesFolders.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# FilesFolders.VerifyBothFolderFilesEqual method

```csharp
public static bool VerifyBothFolderFilesEqual(this string fromPath, string toPath)
```

## See Also

* class [FilesFolders](../FilesFolders.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
18 changes: 18 additions & 0 deletions API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# SearchWeb class

```csharp
public static class SearchWeb
```

## Public Members

| name | description |
| --- | --- |
| static [OpenInBrowserTab](SearchWeb/OpenInBrowserTab.md)(…) | Opens search as a tab in the default browser chosen in Windows settings. |
| static [OpenInBrowserWindow](SearchWeb/OpenInBrowserWindow.md)(…) | Opens search in a new browser. If no browser path is passed in then Chrome is used. Leave browser path blank to use Chrome. |

## See Also

* namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# SearchWeb.OpenInBrowserTab method

Opens search as a tab in the default browser chosen in Windows settings.

```csharp
public static void OpenInBrowserTab(this string url, string browserPath = "",
bool inPrivate = false, string privateArg = "")
```

## See Also

* class [SearchWeb](../SearchWeb.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# SearchWeb.OpenInBrowserWindow method

Opens search in a new browser. If no browser path is passed in then Chrome is used. Leave browser path blank to use Chrome.

```csharp
public static void OpenInBrowserWindow(this string url, string browserPath = "",
bool inPrivate = false, string privateArg = "")
```

## See Also

* class [SearchWeb](../SearchWeb.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ShellCommand.EnumThreadDelegate delegate

```csharp
public delegate bool EnumThreadDelegate(IntPtr hwnd, IntPtr lParam);
```

## See Also

* class [ShellCommand](./ShellCommand.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
20 changes: 20 additions & 0 deletions API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# ShellCommand class

```csharp
public static class ShellCommand
```

## Public Members

| name | description |
| --- | --- |
| static [Execute](ShellCommand/Execute.md)(…) | Runs a windows command using the provided ProcessStartInfo (2 methods) |
| static [RunAsDifferentUser](ShellCommand/RunAsDifferentUser.md)(…) | |
| static [SetProcessStartInfo](ShellCommand/SetProcessStartInfo.md)(…) | |
| delegate [EnumThreadDelegate](ShellCommand.EnumThreadDelegate.md) | |

## See Also

* namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# ShellCommand.Execute method (1 of 2)

Runs a windows command using the provided ProcessStartInfo

```csharp
public static void Execute(ProcessStartInfo info)
```

## Exceptions

| exception | condition |
| --- | --- |
| !:FileNotFoundException | Thrown when unable to find the file specified in the command |
| !:Win32Exception | Thrown when error occurs during the execution of the command |

## See Also

* class [ShellCommand](../ShellCommand.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

---

# ShellCommand.Execute method (2 of 2)

Runs a windows command using the provided ProcessStartInfo using a custom execute command function

```csharp
public static void Execute(Func<ProcessStartInfo, Process> startProcess, ProcessStartInfo info)
```

| parameter | description |
| --- | --- |
| Func startProcessstartProcess | allows you to pass in a custom command execution function |

## Exceptions

| exception | condition |
| --- | --- |
| !:FileNotFoundException | Thrown when unable to find the file specified in the command |
| !:Win32Exception | Thrown when error occurs during the execution of the command |

## See Also

* class [ShellCommand](../ShellCommand.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ShellCommand.RunAsDifferentUser method

```csharp
public static Process RunAsDifferentUser(ProcessStartInfo processStartInfo)
```

## See Also

* class [ShellCommand](../ShellCommand.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# ShellCommand.SetProcessStartInfo method

```csharp
public static ProcessStartInfo SetProcessStartInfo(this string fileName,
string workingDirectory = "", string arguments = "", string verb = "",
bool createNoWindow = false)
```

## See Also

* class [ShellCommand](../ShellCommand.md)
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)

<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->
5 changes: 0 additions & 5 deletions API-Reference/Flow.Launcher.Plugin.SharedCommands/_sidebar.md

This file was deleted.

Loading