UserPromptControl Class

[TemplatePart(Name = "PART_ButtonItemsControl", Type = typeof(UserPromptButtonItemsControl))]
public class UserPromptControl : HeaderedContentControl

public UserPromptControl()

public IEnumerable? ButtonItems { get; set; }

Property Value

IEnumerable:

An enumerable of objects which represent buttons. When null, the value of StandardButtons will define which button items are presented.

See Also

• StandardButtons

public string? ButtonItemsClipboardText { get; set; }

Property Value

string:

A string value. The default value is null. When null, an attempt will be made to resolve the text from the individual items of ButtonItems; e.g., button labels will be used as the clipboard text.

Remarks

Set this value when the appropriate clipboard text cannot be automatically resolved.

public HorizontalAlignment ButtonItemsHorizontalAlignment { get; set; }

Property Value

HorizontalAlignment:

One of the HorizontalAlignment values. The default value is Right.

public Style ButtonStyle { get; set; }

Property Value

Style:

A Style.

public bool CanExpand { get; }

Property Value

bool:

true if expansion is available; otherwise, false.

public object? CheckBoxContent { get; set; }

Property Value

object:

An object that contains the check box content.

Remarks

The default template will only display the check box if this property is populated.

See Also

• IsChecked

public string? CheckBoxContentClipboardText { get; set; }

Property Value

string:

A string value. The default value is null. When null, an attempt will be made to resolve the text from the CheckBoxContent; e.g., string-based content will be used directly as the clipboard text.

Remarks

Set this value when the appropriate clipboard text cannot be automatically resolved.

public string CheckBoxContentStringFormat { get; set; }

Property Value

string:

A string.

public DataTemplate CheckBoxContentTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate used to display the CheckBoxContent.

public DataTemplateSelector CheckBoxContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector to use for CheckBoxContent.

public UserPromptStandardResult? CloseResult { get; set; }

Property Value

UserPromptStandardResult?:

One of the UserPromptStandardResult values, or null if an explicit result has not been defined and could not be inferred from StandardButtons. The default value is null.

public string? ContentClipboardText { get; set; }

Property Value

string:

A string value. The default value is null. When null, an attempt will be made to resolve the text from the Content; e.g., string-based content will be used directly as the clipboard text.

Remarks

Set this value when the appropriate clipboard text cannot be automatically resolved.

[TypeConverter(typeof(LengthConverter))]
public double ContentMaxHeight { get; set; }

Property Value

double:

A double value. The default value is PositiveInfinity.

Remarks

The maximum height of the content, in device-independent units (1/96th inch per unit). The default value is PositiveInfinity. This value can be any value equal to or greater than 0.0. PositiveInfinity is also valid.

[TypeConverter(typeof(LengthConverter))]
public double ContentMaxWidth { get; set; }

Property Value

double:

A double value. The default value is PositiveInfinity.

Remarks

The maximum width of the content, in device-independent units (1/96th inch per unit). The default value is PositiveInfinity. This value can be any value equal to or greater than 0.0. PositiveInfinity is also valid.

public CornerRadius CornerRadius { get; set; }

Property Value

CornerRadius:

A CornerRadius.

public UserPromptStandardResult DefaultResult { get; set; }

Property Value

UserPromptStandardResult:

One of the UserPromptStandardResult values.

public string? ExpandedInformationCollapsedHeaderText { get; set; }

Property Value

string:

A string that will be used as the content for the header.

Remarks

Text supports access keys.

See Also

• ExpandedInformationExpandedHeaderText

public object? ExpandedInformationContent { get; set; }

Property Value

object:

An object that contains the expanded information content.

public string? ExpandedInformationContentClipboardText { get; set; }

Property Value

string:

A string value. The default value is null. When null, an attempt will be made to resolve the text from the ExpandedInformationContent; e.g., string-based content will be used directly as the clipboard text.

Remarks

Set this value when the appropriate clipboard text cannot be automatically resolved.

public string ExpandedInformationContentStringFormat { get; set; }

Property Value

string:

A string.

public DataTemplate ExpandedInformationContentTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate used to display the ExpandedInformationContent.

public DataTemplateSelector ExpandedInformationContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector to use for ExpandedInformationContent.

public string? ExpandedInformationExpandedHeaderText { get; set; }

Property Value

string:

A string that will be used as the content for the header.

Remarks

Text supports access keys.

See Also

• ExpandedInformationCollapsedHeaderText

public object? Footer { get; set; }

Property Value

object:

An object that contains the footer content.

public string? FooterClipboardText { get; set; }

Property Value

string:

A string value. The default value is null. When null, an attempt will be made to resolve the text from the Footer; e.g., string-based content will be used directly as the clipboard text.

Remarks

Set this value when the appropriate clipboard text cannot be automatically resolved.

public ImageSource? FooterImageSource { get; set; }

Property Value

ImageSource:

An ImageSource.

public string FooterStringFormat { get; set; }

Property Value

string:

A string.

public DataTemplate FooterTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate used to display the Footer.

public DataTemplateSelector FooterTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector to use for the Footer.

public bool HasAlignedHeader { get; }

Property Value

bool:

true if status image and header are aligned; otherwise, false. The default value is false.

public bool HasCheckBoxContent { get; }

Property Value

bool:

true if CheckBoxContent has a non-null value; otherwise, false. The default value is false.

public bool HasExpandedInformationContent { get; }

Property Value

bool:

true if ExpandedInformationContent has a non-null value; otherwise, false. The default value is false.

public bool HasFooter { get; }

Property Value

bool:

true if Footer has a non-null value; otherwise, false. The default value is false.

public bool HasFooterImage { get; }

Property Value

bool:

true if FooterImageSource has a non-null value; otherwise, false. The default value is false.

public bool HasStatusImage { get; }

Property Value

bool:

true if StatusImageSource has a non-null value; otherwise, false. The default value is false.

public Brush? HeaderBackground { get; set; }

Property Value

Brush:

A Brush for the header background.

public Brush? HeaderBorderBrush { get; set; }

Property Value

Brush:

A Brush for the header border.

public Thickness HeaderBorderThickness { get; set; }

Property Value

Thickness:

A Thickness for the header border.

public string? HeaderClipboardText { get; set; }

Property Value

string:

A string value. The default value is null. When null, an attempt will be made to resolve the text from the Header; e.g., string-based content will be used directly as the clipboard text.

Remarks

Set this value when the appropriate clipboard text cannot be automatically resolved.

public double HeaderFontSize { get; set; }

Property Value

double:

The size of the font.

public Brush? HeaderForeground { get; set; }

Property Value

Brush:

A Brush for the header.

public ICommand? HelpCommand { get; set; }

Property Value

ICommand:

An ICommand. The default value is Help.

See Also

• HelpCommandParameter

public object? HelpCommandParameter { get; set; }

Property Value

object:

An object. The default value is null.

public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }

Property Value

ScrollBarVisibility:

One of the ScrollBarVisibility values. The default value is Disabled.

See Also

• VerticalScrollBarVisibility

public bool IsAnimationEnabled { get; set; }

Property Value

bool:

true if animations are enabled; otherwise, false. The default value is true.

Remarks

This property is ignored when the current environment does not support animation.

public bool IsChecked { get; set; }

Property Value

bool:

true if CheckBoxContent is checked; otherwise, false.

See Also

• CheckBoxContent

public bool IsExpanded { get; set; }

Property Value

bool:

true if ExpandedInformationContent is expanded; otherwise, false.

public object? Result { get; set; }

Property Value

object:

One of the UserPromptStandardResult values, null, or any object which represents a custom result. When defined for a button that is invoked for the response, the result will be based on the ButtonResultProperty attached property. Otherwise for custom buttons, the result must be manually assigned. The value is null if a result has not been provided.

public UserPromptStandardButtons StandardButtons { get; set; }

Property Value

UserPromptStandardButtons:

One of the UserPromptStandardButtons values. The default value is OK.

Remarks

This property is ignored when ButtonItems is explicitly defined.

See Also

• ButtonItems

public UserPromptStandardImage StandardStatusImage { get; set; }

Property Value

UserPromptStandardImage:

One of the UserPromptStandardImage values. The default value is None.

Remarks

This property is ignored when StatusImageSource is explicitly defined.

See Also

• StatusImageSource

public ImageSource StatusImageSource { get; set; }

Property Value

ImageSource:

An ImageSource.

See Also

• StandardStatusImage

public SystemSound SystemSound { get; set; }

Property Value

SystemSound:

A SystemSound or null if a default sound should be played based on the current value of StandardStatusImage. The default value is null.

public Brush? TrayBackground { get; set; }

Property Value

Brush:

A Brush for the background in the tray elements.

public Brush? TrayForeground { get; set; }

Property Value

Brush:

A Brush for the foreground in the tray elements.

public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }

Property Value

ScrollBarVisibility:

One of the ScrollBarVisibility values. The default value is Auto.

See Also

• HorizontalScrollBarVisibility

[AttachedPropertyBrowsableForChildren(IncludeDescendants = true)]
public static string? GetButtonClipboardText(DependencyObject obj)

Parameter	Type	Description
obj	DependencyObject	The object from which the property value is read.

Returns

string:

The object's value.

See Also

• SetButtonClipboardText(DependencyObject, string?)

[AttachedPropertyBrowsableForChildren(IncludeDescendants = true)]
public static UserPromptStandardResult GetButtonResult(DependencyObject obj)

Parameter	Type	Description
obj	DependencyObject	The object from which the property value is read.

Returns

UserPromptStandardResult:

The object's value.

See Also

• SetButtonResult(DependencyObject, UserPromptStandardResult)

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

A new instance of UserPromptControlAutomationPeer.

public static void SetButtonClipboardText(DependencyObject obj, string? value)

Parameter	Type	Description
obj	DependencyObject	The object to which the attached property is written.
value	string	The value to set.

See Also

• GetButtonClipboardText(DependencyObject)

public static void SetButtonResult(DependencyObject obj, UserPromptStandardResult value)

Parameter	Type	Description
obj	DependencyObject	The object to which the attached property is written.
value	UserPromptStandardResult	The value to set.

See Also

• GetButtonResult(DependencyObject)

public event EventHandler<UserPromptResponseEventArgs>? Responding

Event Type

EventHandler<UserPromptResponseEventArgs>

public static readonly DependencyProperty ButtonClipboardTextProperty

public static readonly DependencyProperty ButtonItemsClipboardTextProperty

public static readonly DependencyProperty ButtonItemsHorizontalAlignmentProperty

public static readonly DependencyProperty ButtonItemsProperty

public static readonly DependencyProperty ButtonResultProperty

public static readonly DependencyProperty ButtonStyleProperty

public static readonly DependencyProperty CanExpandProperty

public static readonly DependencyProperty CheckBoxContentClipboardTextProperty

public static readonly DependencyProperty CheckBoxContentProperty

public static readonly DependencyProperty CheckBoxContentStringFormatProperty

public static readonly DependencyProperty CheckBoxContentTemplateProperty

public static readonly DependencyProperty CheckBoxContentTemplateSelectorProperty

public static readonly DependencyProperty CloseResultProperty

public static readonly DependencyProperty ContentClipboardTextProperty

public static readonly DependencyProperty ContentMaxHeightProperty

public static readonly DependencyProperty ContentMaxWidthProperty

public static readonly DependencyProperty CornerRadiusProperty

public static readonly DependencyProperty DefaultResultProperty

public static readonly DependencyProperty ExpandedInformationCollapsedHeaderTextProperty

public static readonly DependencyProperty ExpandedInformationContentClipboardTextProperty

public static readonly DependencyProperty ExpandedInformationContentProperty

public static readonly DependencyProperty ExpandedInformationContentStringFormatProperty

public static readonly DependencyProperty ExpandedInformationContentTemplateProperty

public static readonly DependencyProperty ExpandedInformationContentTemplateSelectorProperty

public static readonly DependencyProperty ExpandedInformationExpandedHeaderTextProperty

public static readonly DependencyProperty FooterClipboardTextProperty

public static readonly DependencyProperty FooterImageSourceProperty

public static readonly DependencyProperty FooterProperty

public static readonly DependencyProperty FooterStringFormatProperty

public static readonly DependencyProperty FooterTemplateProperty

public static readonly DependencyProperty FooterTemplateSelectorProperty

public static readonly DependencyProperty HasAlignedHeaderProperty

public static readonly DependencyProperty HasCheckBoxContentProperty

public static readonly DependencyProperty HasExpandedInformationContentProperty

public static readonly DependencyProperty HasFooterImageProperty

public static readonly DependencyProperty HasFooterProperty

public static readonly DependencyProperty HasStatusImageProperty

public static readonly DependencyProperty HeaderBackgroundProperty

public static readonly DependencyProperty HeaderBorderBrushProperty

public static readonly DependencyProperty HeaderBorderThicknessProperty

public static readonly DependencyProperty HeaderClipboardTextProperty

public static readonly DependencyProperty HeaderFontSizeProperty

public static readonly DependencyProperty HeaderForegroundProperty

public static readonly DependencyProperty HelpCommandParameterProperty

public static readonly DependencyProperty HelpCommandProperty

public static readonly DependencyProperty HorizontalScrollBarVisibilityProperty

public static readonly DependencyProperty IsAnimationEnabledProperty

public static readonly DependencyProperty IsCheckedProperty

public static readonly DependencyProperty IsExpandedProperty

public static readonly DependencyProperty ResultProperty

public static readonly DependencyProperty StandardButtonsProperty

public static readonly DependencyProperty StandardStatusImageProperty

public static readonly DependencyProperty StatusImageSourceProperty

public static readonly DependencyProperty SystemSoundProperty

public static readonly DependencyProperty TrayBackgroundProperty

public static readonly DependencyProperty TrayForegroundProperty

public static readonly DependencyProperty VerticalScrollBarVisibilityProperty