In This Article

BarTextBoxViewModel Class

Represents a view model for a textbox control within a bar control.

public class BarTextBoxViewModel : BarKeyedObjectViewModelBase, IHasKey, IHasVariantImages
Inheritance:
object ObservableObjectBase BarKeyedObjectViewModelBase object
Implements:
IHasKey IHasVariantImages

Constructors

BarTextBoxViewModel()

Initializes a new instance of the class.

public BarTextBoxViewModel()

BarTextBoxViewModel(string)

Initializes a new instance of the class with the specified key. The label and key tip text are auto-generated.

public BarTextBoxViewModel(string key)
Parameter Type Description
key string

A string that uniquely identifies the control.

BarTextBoxViewModel(string, string)

Initializes a new instance of the class with the specified key and label. The key tip text is auto-generated.

public BarTextBoxViewModel(string key, string label)
Parameter Type Description
key string

A string that uniquely identifies the control.

label string

The text label to display, which is auto-generated from the key if null.

BarTextBoxViewModel(string, string, string)

Initializes a new instance of the class with the specified key, label, and key tip text.

public BarTextBoxViewModel(string key, string label, string keyTipText)
Parameter Type Description
key string

A string that uniquely identifies the control.

label string

The text label to display, which is auto-generated from the key if null.

keyTipText string

The key tip text, which is auto-generated from the label if null.

BarTextBoxViewModel(string, string, string, ICommand)

Initializes a new instance of the class with the specified key, label, key tip text, and command.

public BarTextBoxViewModel(string key, string label, string keyTipText, ICommand command)
Parameter Type Description
key string

A string that uniquely identifies the control.

label string

The text label to display, which is auto-generated from the command or key if null.

keyTipText string

The key tip text, which is auto-generated from the command or label if null.

command ICommand

The command to attach to the control.

BarTextBoxViewModel(string, string, ICommand)

Initializes a new instance of the class with the specified key, label, and command. The key tip text is auto-generated.

public BarTextBoxViewModel(string key, string label, ICommand command)
Parameter Type Description
key string

A string that uniquely identifies the control.

label string

The text label to display, which is auto-generated from the command or key if null.

command ICommand

The command to attach to the control.

BarTextBoxViewModel(string, ICommand)

Initializes a new instance of the class with the specified key and command. The label and key tip text are auto-generated.

public BarTextBoxViewModel(string key, ICommand command)
Parameter Type Description
key string

A string that uniquely identifies the control.

command ICommand

The command to attach to the control.

BarTextBoxViewModel(RoutedCommand)

Initializes a new instance of the class with the specified RoutedCommand, also used to auto-generate a key, label, and key tip text.

public BarTextBoxViewModel(RoutedCommand routedCommand)
Parameter Type Description
routedCommand RoutedCommand

The command to attach to the control.

Properties

CanCloneToRibbonQuickAccessToolBar

Gets or sets whether the control can be cloned to the ribbon quick-access toolbar.

public bool CanCloneToRibbonQuickAccessToolBar { get; set; }

Property Value

bool:

true if the control can be cloned to the ribbon quick-access toolbar; otherwise, false. The default value is true.

Command

Gets or sets the ICommand to attach to the control.

public ICommand Command { get; set; }

Property Value

ICommand:

The ICommand to attach to the control.

CommandParameter

Gets or sets the parameter to pass to the Command property.

public object CommandParameter { get; set; }

Property Value

object:

The parameter to pass to the Command property.

Description

Gets or sets the text description to display in screen tips.

public string Description { get; set; }

Property Value

string:

The text description to display in screen tips.

IsStarSizingAllowed

Gets or sets whether the control can star-size and fill available space when appropriate.

public bool IsStarSizingAllowed { get; set; }

Property Value

bool:

true if the control can star-size; otherwise, false. The default value is false.

KeyTipText

Gets or sets the key tip text used to access the control.

public string KeyTipText { get; set; }

Property Value

string:

The key tip text used to access the control.

Label

Gets or sets the text label to display.

public string Label { get; set; }

Property Value

string:

The text label to display.

PlaceholderText

Gets or sets the placeholder text to display when the control is empty.

public string PlaceholderText { get; set; }

Property Value

string:

The placeholder text to display when the control is empty.

RequestedWidth

Gets or sets the requested width of the control.

public double RequestedWidth { get; set; }

Property Value

double:

The requested width of the control. The default value is 110.

SmallImageSource

Gets or sets the ImageSource for a small image, generally 16x16 size.

public ImageSource SmallImageSource { get; set; }

Property Value

ImageSource:

The ImageSource for a small image.

Text

Gets or sets the text being edited in the control.

public string Text { get; set; }

Property Value

string:

The text being edited in the control.

Title

Gets or sets the string title, which can override the Label when displayed in screen tips and customization UI.

public string Title { get; set; }

Property Value

string:

The string title.

ToolBarItemCollapseBehavior

Gets or sets the ItemCollapseBehavior for the control when in a ribbon using Simplified layout mode.

public ItemCollapseBehavior ToolBarItemCollapseBehavior { get; set; }

Property Value

ItemCollapseBehavior:

The ItemCollapseBehavior for the control when in a ribbon using Simplified layout mode. The default value is Default.

Inherited Members