Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

UserPromptServiceExtensions Class

Namespace:
ActiproSoftware.UI.WinForms.Services
Assembly:
ActiproSoftware.Shared.WinForms.dll

Defines extension methods related to IUserPromptService and IDesignerSafeUserPromptService.

public static class UserPromptServiceExtensions
Inheritance:
object object

Remarks

For internal use only.

Methods

WithCheckFileExists<TOptions, TResult>(IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>, bool)

Assigns a value to CheckFileExists.

public static IDesignerSafeSelectFilePromptBuilder<TOptions, TResult> WithCheckFileExists<TOptions, TResult>(this IDesignerSafeSelectFilePromptBuilder<TOptions, TResult> builder, bool value) where TOptions : ISelectFileOptions where TResult : ISelectFileResult<TOptions>
Type Parameters:
TOptions -
TResult -
Parameter Type Description
builder IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>

The file prompt builder.
value bool

The value to assign.

Returns

IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>:

Returns itself for use with method-chaining.

WithCheckFileExists<TOptions, TResult>(ISelectFilePromptBuilder<TOptions, TResult>, bool)

Assigns a value to CheckFileExists.

public static ISelectFilePromptBuilder<TOptions, TResult> WithCheckFileExists<TOptions, TResult>(this ISelectFilePromptBuilder<TOptions, TResult> builder, bool value) where TOptions : ISelectFileOptions where TResult : ISelectFileResult<TOptions>
Type Parameters:
TOptions -
TResult -
Parameter Type Description
builder ISelectFilePromptBuilder<TOptions, TResult>

The file prompt builder.
value bool

The value to assign.

Returns

ISelectFilePromptBuilder<TOptions, TResult>:

Returns itself for use with method-chaining.

WithFileName<TOptions, TResult>(IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>, string)

Assigns a value to FileName.

public static IDesignerSafeSelectFilePromptBuilder<TOptions, TResult> WithFileName<TOptions, TResult>(this IDesignerSafeSelectFilePromptBuilder<TOptions, TResult> builder, string value) where TOptions : ISelectFileOptions where TResult : ISelectFileResult<TOptions>
Type Parameters:
TOptions -
TResult -
Parameter Type Description
builder IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>

The file prompt builder.
value string

The value to assign.

Returns

IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>:

Returns itself for use with method-chaining.

WithFileName<TOptions, TResult>(ISelectFilePromptBuilder<TOptions, TResult>, string)

Assigns a value to FileName.

public static ISelectFilePromptBuilder<TOptions, TResult> WithFileName<TOptions, TResult>(this ISelectFilePromptBuilder<TOptions, TResult> builder, string value) where TOptions : ISelectFileOptions where TResult : ISelectFileResult<TOptions>
Type Parameters:
TOptions -
TResult -
Parameter Type Description
builder ISelectFilePromptBuilder<TOptions, TResult>

The file prompt builder.
value string

The value to assign.

Returns

ISelectFilePromptBuilder<TOptions, TResult>:

Returns itself for use with method-chaining.

WithFilterForAllFiles<TOptions, TResult>(IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>, string, bool)

Appends a new entry to Filter for use with all files (e.g. .).

public static IDesignerSafeSelectFilePromptBuilder<TOptions, TResult> WithFilterForAllFiles<TOptions, TResult>(this IDesignerSafeSelectFilePromptBuilder<TOptions, TResult> builder, string title = null, bool select = false) where TOptions : ISelectFileOptions where TResult : ISelectFileResult<TOptions>
Type Parameters:
TOptions -
TResult -
Parameter Type Description
builder IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>

The file prompt builder.
title string

The title of the filter. When null, a default title will be used.
select bool

When true, the FilterIndex will be updated to pre-select the new filter.

Returns

IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>:

Returns itself for use with method-chaining.

WithFilterForAllFiles<TOptions, TResult>(ISelectFilePromptBuilder<TOptions, TResult>, string, bool)

Appends a new entry to Filter for use with all files (e.g. .).

public static ISelectFilePromptBuilder<TOptions, TResult> WithFilterForAllFiles<TOptions, TResult>(this ISelectFilePromptBuilder<TOptions, TResult> builder, string title = null, bool select = false) where TOptions : ISelectFileOptions where TResult : ISelectFileResult<TOptions>
Type Parameters:
TOptions -
TResult -
Parameter Type Description
builder ISelectFilePromptBuilder<TOptions, TResult>

The file prompt builder.
title string

The title of the filter. When null, a default title will be used.
select bool

When true, the FilterIndex will be updated to pre-select the new filter.

Returns

ISelectFilePromptBuilder<TOptions, TResult>:

Returns itself for use with method-chaining.

WithFilterForImageFiles<TOptions, TResult>(IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>, string, bool, bool, bool)

Appends a new entry to Filter for use with common image files.

public static IDesignerSafeSelectFilePromptBuilder<TOptions, TResult> WithFilterForImageFiles<TOptions, TResult>(this IDesignerSafeSelectFilePromptBuilder<TOptions, TResult> builder, string title = null, bool includeBitmapFiles = true, bool includeMetafiles = false, bool select = false) where TOptions : ISelectFileOptions where TResult : ISelectFileResult<TOptions>
Type Parameters:
TOptions -
TResult -
Parameter Type Description
builder IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>

The file prompt builder.
title string

The title of the filter. When null, a default title will be used.
includeBitmapFiles bool

When true, a filter will be included for bitmap file extensions.
includeMetafiles bool

When true
select bool

When true, the FilterIndex will be updated to pre-select the new filter.

Returns

IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>:

Returns itself for use with method-chaining.

WithFilterForImageFiles<TOptions, TResult>(ISelectFilePromptBuilder<TOptions, TResult>, string, bool, bool, bool)

Appends a new entry to Filter for use with common image files.

public static ISelectFilePromptBuilder<TOptions, TResult> WithFilterForImageFiles<TOptions, TResult>(this ISelectFilePromptBuilder<TOptions, TResult> builder, string title = null, bool includeBitmapFiles = true, bool includeMetafiles = false, bool select = false) where TOptions : ISelectFileOptions where TResult : ISelectFileResult<TOptions>
Type Parameters:
TOptions -
TResult -
Parameter Type Description
builder ISelectFilePromptBuilder<TOptions, TResult>

The file prompt builder.
title string

The title of the filter. When null, a default title will be used.
includeBitmapFiles bool

When true, a filter will be included for bitmap file extensions.
includeMetafiles bool

When true
select bool

When true, the FilterIndex will be updated to pre-select the new filter.

Returns

ISelectFilePromptBuilder<TOptions, TResult>:

Returns itself for use with method-chaining.

WithFilter<TOptions, TResult>(IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>, string, string, bool)

Appends a new entry to Filter.

public static IDesignerSafeSelectFilePromptBuilder<TOptions, TResult> WithFilter<TOptions, TResult>(this IDesignerSafeSelectFilePromptBuilder<TOptions, TResult> builder, string title, string pattern, bool select = false) where TOptions : ISelectFileOptions where TResult : ISelectFileResult<TOptions>
Type Parameters:
TOptions -
TResult -
Parameter Type Description
builder IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>

The file prompt builder.
title string

The title of the filter.
pattern string

The semi-colon delimited list of file wildcard patterns to be matched by the filter.
select bool

When true, the FilterIndex will be updated to pre-select the new filter.

Returns

IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>:

Returns itself for use with method-chaining.

WithFilter<TOptions, TResult>(ISelectFilePromptBuilder<TOptions, TResult>, string, string, bool)

Appends a new entry to Filter.

public static ISelectFilePromptBuilder<TOptions, TResult> WithFilter<TOptions, TResult>(this ISelectFilePromptBuilder<TOptions, TResult> builder, string title, string pattern, bool select = false) where TOptions : ISelectFileOptions where TResult : ISelectFileResult<TOptions>
Type Parameters:
TOptions -
TResult -
Parameter Type Description
builder ISelectFilePromptBuilder<TOptions, TResult>

The file prompt builder.
title string

The title of the filter.
pattern string

The semi-colon delimited list of file wildcard patterns to be matched by the filter.
select bool

When true, the FilterIndex will be updated to pre-select the new filter.

Returns

ISelectFilePromptBuilder<TOptions, TResult>:

Returns itself for use with method-chaining.

WithTitle<TOptions, TResult>(IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>, string)

Assigns a value to Title.

public static IDesignerSafeSelectFilePromptBuilder<TOptions, TResult> WithTitle<TOptions, TResult>(this IDesignerSafeSelectFilePromptBuilder<TOptions, TResult> builder, string value) where TOptions : ISelectFileOptions where TResult : ISelectFileResult<TOptions>
Type Parameters:
TOptions -
TResult -
Parameter Type Description
builder IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>

The file prompt builder.
value string

The value to assign.

Returns

IDesignerSafeSelectFilePromptBuilder<TOptions, TResult>:

Returns itself for use with method-chaining.

WithTitle<TOptions, TResult>(ISelectFilePromptBuilder<TOptions, TResult>, string)

Assigns a value to Title.

public static ISelectFilePromptBuilder<TOptions, TResult> WithTitle<TOptions, TResult>(this ISelectFilePromptBuilder<TOptions, TResult> builder, string value) where TOptions : ISelectFileOptions where TResult : ISelectFileResult<TOptions>
Type Parameters:
TOptions -
TResult -
Parameter Type Description
builder ISelectFilePromptBuilder<TOptions, TResult>

The file prompt builder.
value string

The value to assign.

Returns

ISelectFilePromptBuilder<TOptions, TResult>:

Returns itself for use with method-chaining.

Inherited Members