You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documentation/topics/bars/application-modes.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ order: 10
7
7
8
8
Application modes are a special feature found in the bar controls. An application mode is a mode that your application enters in which certain functionality should be switched on or off.
9
9
10
-
This is extremely useful in an IDE type of application. In an IDE like Visual Studio, there are modes like `Text Editor`, `Image Editor`, `WebBrowser`, etc. In each mode certain keyboard shortcuts and dockable toolbars are used that are not used in other modes.
10
+
This is extremely useful in an IDE type of application. In an IDE like Visual Studio, there are modes like `"Text Editor"`, `"Image Editor"`, `"WebBrowser"`, etc. In each mode certain keyboard shortcuts and dockable toolbars are used that are not used in other modes.
11
11
12
12
The [BarManager](xref:@ActiproUIRoot.Controls.Bars.BarManager) provides functionality for automatically displaying and hiding certain dockable toolbars based on what the current application mode is. The [BarManager](xref:@ActiproUIRoot.Controls.Bars.BarManager) can also be set up to only recognize certain keyboard shortcuts while in specific modes.
13
13
@@ -39,6 +39,6 @@ To enable this functionality, add the applicable modes to the [Modes](xref:@Acti
39
39
40
40
Each [BarKeyboardShortcut](xref:@ActiproUIRoot.Controls.Bars.BarKeyboardShortcut) has a [Mode](xref:@ActiproUIRoot.Controls.Bars.BarKeyboardShortcut.Mode) property. If that value is `null`, then the shortcut applies to the global mode. If that value is populated, then the shortcut only applies to that specific mode.
41
41
42
-
For example, if a `Text Editor` mode is currently set, any keyboard shortcuts defined for the `Text Editor` mode will be recognized. If there is no keyboard shortcut defined in the mode for a key sequence that is pressed, a keyboard shortcut in the global mode is searched for. If one is found, then that keyboard shortcut is used.
42
+
For example, if a `"Text Editor"` mode is currently set, any keyboard shortcuts defined for the `"Text Editor"` mode will be recognized. If there is no keyboard shortcut defined in the mode for a key sequence that is pressed, a keyboard shortcut in the global mode is searched for. If one is found, then that keyboard shortcut is used.
43
43
44
44
Read the [Keyboard Shortcuts](keyboard-shortcuts.md) topic for more information on keyboard shortcuts.
Copy file name to clipboardExpand all lines: Documentation/topics/bars/checkable-buttons.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ This table indicates the members of the [IBarCheckableCommand](xref:@ActiproUIRo
18
18
|[Checkable](xref:@ActiproUIRoot.Controls.Bars.IBarCheckableCommand.Checkable) Property | Gets or sets whether the button is checkable. |
19
19
|[Checked](xref:@ActiproUIRoot.Controls.Bars.IBarCheckableCommand.Checked) Property | Gets or sets whether the button is checked. |
20
20
|[CheckGroupName](xref:@ActiproUIRoot.Controls.Bars.IBarCheckableCommand.CheckGroupName) Property | Gets or sets the name of the check group. |
21
-
|[FullName](xref:@ActiproUIRoot.Controls.Bars.IBarCheckableCommand.FullName) Property | Gets the full name of the command, which is `Category.Name`. |
21
+
|[FullName](xref:@ActiproUIRoot.Controls.Bars.IBarCheckableCommand.FullName) Property | Gets the full name of the command, which is formatted like `"Category.Name"`. |
22
22
23
23
## Working with Checkable Buttons
24
24
@@ -36,7 +36,7 @@ If the [AutoUpdateChecks](xref:@ActiproUIRoot.Controls.Bars.BarManager.AutoUpdat
36
36
37
37
Check groups are a powerful feature found in Bars. When working with checkable buttons, there are two scenarios. The first is where the checkable button provides an on/off toggle for a specific feature. This sort of checkable button stands alone. The second is where the checkable button is a toggle for a specific feature within a feature group. For instance, in a text editing application, there would be a check group for text alignment (left, center, right, and justify).
38
38
39
-
By specifying a [CheckGroupName](xref:@ActiproUIRoot.Controls.Bars.IBarCheckableCommand.CheckGroupName) for all the checkable buttons in a check group, Bars adds numerous features for easily working with check groups. In our above scenario, all the checkable buttons for the text alignment check group could have a [CheckGroupName](xref:@ActiproUIRoot.Controls.Bars.IBarCheckableCommand.CheckGroupName) value of `TextAlignment`.
39
+
By specifying a [CheckGroupName](xref:@ActiproUIRoot.Controls.Bars.IBarCheckableCommand.CheckGroupName) for all the checkable buttons in a check group, Bars adds numerous features for easily working with check groups. In our above scenario, all the checkable buttons for the text alignment check group could have a [CheckGroupName](xref:@ActiproUIRoot.Controls.Bars.IBarCheckableCommand.CheckGroupName) value of `"TextAlignment"`.
40
40
41
41
If the [AutoUpdateCheckGroups](xref:@ActiproUIRoot.Controls.Bars.BarManager.AutoUpdateCheckGroups) property is set to `true`, any checkable buttons in a check group that are clicked by the end user will be automatically checked and all other checkable buttons in the check group will be unchecked. If that property is `false`, the checkable buttons can only have their [Checked](xref:@ActiproUIRoot.Controls.Bars.IBarCheckableCommand.Checked) state toggled programmatically.
Copy file name to clipboardExpand all lines: Documentation/topics/bars/clipboard-change-notification.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ order: 12
7
7
8
8
The [BarManager](xref:@ActiproUIRoot.Controls.Bars.BarManager) optionally can raise an event whenever Windows indicates that the contents of the Windows clipboard have changed.
9
9
10
-
This is useful for any application that uses an `Edit.Paste` command since you can enable or disable it based on the contents of the clipboard.
10
+
This is useful for any application that uses an `"Edit.Paste"` command since you can enable or disable it based on the contents of the clipboard.
Copy file name to clipboardExpand all lines: Documentation/topics/bars/commands/buttons.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ See the [Commands and Command Links](index.md) topic for more information on com
13
13
14
14

15
15
16
-
Regular buttons appear like a button when on a toolbar and appear like a normal menu item when on a menu. They can be clicked and an action can be taken in response to the click.
16
+
Regular buttons appear like a button when on a toolbar and appear like a normal menu item when on a menu. They can be clicked, and an action can be taken in response to the click.
17
17
18
18
## Checkable Buttons
19
19
@@ -27,7 +27,7 @@ Each command link instance can override all of these properties as well with com
27
27
28
28
## Enabling / Disabling
29
29
30
-
Command links can be enabled or disabled based on a resolved value of enabled properties, one on the command and one on the command link that can override it. The command link's [Enabled](xref:@ActiproUIRoot.Controls.Bars.BarCommandLink.Enabled) accepts a `DefaultableBoolean`, which can override the command's [Enabled](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Enabled) property.
30
+
Command links can be enabled or disabled based on a resolved value of enabled properties, one on the command and one on the command link that can override it. The command link's [Enabled](xref:@ActiproUIRoot.Controls.Bars.BarCommandLink.Enabled)property accepts a `DefaultableBoolean`, which can override the command's [Enabled](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Enabled) property.
31
31
32
32
## Keyboard Shortcuts
33
33
@@ -53,4 +53,4 @@ Tooltips will be displayed for the command if the [ToolTipEnabled](xref:@Actipro
53
53
54
54
## Changing the Text Displayed in the Run-Time Customize Dialog for the Command
55
55
56
-
By default, the [Text](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Text) property value of the command will be displayed in the run-time customize dialog's command listbox. However if this is not appropriate or needs to be customized for the command listbox, the [CustomizeListText](xref:@ActiproUIRoot.Controls.Bars.BarCommand.CustomizeListText) property can be set to override what is displayed.
56
+
By default, the [Text](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Text) property value of the command will be displayed in the run-time customize dialog's command listbox. However, if this is not appropriate or needs to be customized for the command listbox, the [CustomizeListText](xref:@ActiproUIRoot.Controls.Bars.BarCommand.CustomizeListText) property can be set to override what is displayed.
Copy file name to clipboardExpand all lines: Documentation/topics/bars/commands/comboboxes.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ See the [Commands and Command Links](index.md) topic for more information on com
15
15
16
16
Comboboxes have two modes of input, normal and drop-down list. The style is specified by the [Style](xref:@ActiproUIRoot.Controls.Bars.BarComboBoxCommand.Style) property on the command and takes an enumeration value of type [BarComboBoxCommandStyle](xref:@ActiproUIRoot.Controls.Bars.BarComboBoxCommandStyle).
17
17
18
-
When using the normal style, a drop-down of items can be displayed and typing can occur in the combobox. The selecting of a drop-down item, pressing of <kbd>Enter</kbd> or the changing of a value and tabbing off the combobox will raise the command click event.
18
+
When using the normal style, a drop-down of items can be displayed and typing can occur in the combobox. The selecting of a drop-down item, pressing of <kbd>Enter</kbd>, or the changing of a value and tabbing off the combobox will raise the command click event.
19
19
20
20
When using the drop-down list style, a drop-down of items can be displayed and but the text in the combobox is read-only. The selecting of a drop-down item will raise the command click event.
21
21
@@ -37,7 +37,7 @@ The selected index of the combobox can be set using the command's [SelectedIndex
37
37
38
38
## Enabling / Disabling
39
39
40
-
Command links can be enabled or disabled based on a resolved value of enabled properties, one on the command and one on the command link that can override it. The command link's [Enabled](xref:@ActiproUIRoot.Controls.Bars.BarCommandLink.Enabled) accepts a `DefaultableBoolean`, which can override the command's [Enabled](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Enabled) property.
40
+
Command links can be enabled or disabled based on a resolved value of enabled properties, one on the command and one on the command link that can override it. The command link's [Enabled](xref:@ActiproUIRoot.Controls.Bars.BarCommandLink.Enabled)property accepts a `DefaultableBoolean`, which can override the command's [Enabled](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Enabled) property.
41
41
42
42
## Keyboard Shortcuts
43
43
@@ -59,4 +59,4 @@ Tooltips will be displayed for the command if the [ToolTipEnabled](xref:@Actipro
59
59
60
60
## Changing the Text Displayed in the Run-Time Customize Dialog for the Command
61
61
62
-
By default, the [Text](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Text) property value of the command will be displayed in the run-time customize dialog's command listbox. However if this is not appropriate or needs to be customized for the command listbox, the [CustomizeListText](xref:@ActiproUIRoot.Controls.Bars.BarCommand.CustomizeListText) property can be set to override what is displayed.
62
+
By default, the [Text](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Text) property value of the command will be displayed in the run-time customize dialog's command listbox. However, if this is not appropriate or needs to be customized for the command listbox, the [CustomizeListText](xref:@ActiproUIRoot.Controls.Bars.BarCommand.CustomizeListText) property can be set to override what is displayed.
Copy file name to clipboardExpand all lines: Documentation/topics/bars/commands/expander-buttons.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ Each command link instance can override all of these properties as well with com
29
29
30
30
## Enabling / Disabling
31
31
32
-
Command links can be enabled or disabled based on a resolved value of enabled properties, one on the command and one on the command link that can override it. The command link's [Enabled](xref:@ActiproUIRoot.Controls.Bars.BarCommandLink.Enabled) accepts a `DefaultableBoolean`, which can override the command's [Enabled](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Enabled) property.
32
+
Command links can be enabled or disabled based on a resolved value of enabled properties, one on the command and one on the command link that can override it. The command link's [Enabled](xref:@ActiproUIRoot.Controls.Bars.BarCommandLink.Enabled)property accepts a `DefaultableBoolean`, which can override the command's [Enabled](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Enabled) property.
33
33
34
34
## Begin a Group
35
35
@@ -49,4 +49,4 @@ Tooltips will be displayed for the command if the [ToolTipEnabled](xref:@Actipro
49
49
50
50
## Changing the Text Displayed in the Run-Time Customize Dialog for the Command
51
51
52
-
By default, the [Text](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Text) property value of the command will be displayed in the run-time customize dialog's command listbox. However if this is not appropriate or needs to be customized for the command listbox, the [CustomizeListText](xref:@ActiproUIRoot.Controls.Bars.BarCommand.CustomizeListText) property can be set to override what is displayed.
52
+
By default, the [Text](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Text) property value of the command will be displayed in the run-time customize dialog's command listbox. However, if this is not appropriate or needs to be customized for the command listbox, the [CustomizeListText](xref:@ActiproUIRoot.Controls.Bars.BarCommand.CustomizeListText) property can be set to override what is displayed.
Copy file name to clipboardExpand all lines: Documentation/topics/bars/commands/index.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,21 +5,22 @@ order: 1
5
5
---
6
6
# Overview
7
7
8
-
The most important concept to understand with the bar controls is the concept of commands and command links. Since the bar controls are fairly advanced, understanding this concept is key before using them. Be sure to thoroughly read this topic before moving onto using the bar controls.
8
+
The most important concept to understand with the bar controls is the concept of *commands* and *command links*. Since the bar controls are fairly advanced, understanding this concept is key before using them. Be sure to thoroughly read this topic before moving on to using the bar controls.
9
9
10
10
A command is any object that inherits from [BarCommand](xref:@ActiproUIRoot.Controls.Bars.BarCommand). Commands represent a specific functionality of your application, such as creating a new document. A command *does not* have a user interface. Changes made to a command affect all the command links that reference it.
11
11
12
12
A command link is any object that inherits from [BarCommandLink](xref:@ActiproUIRoot.Controls.Bars.BarCommandLink). A command link provides the user interface for a command. So, each command link references a specific command. One or more command links can be created for each command. Changes made to command link properties only affect that particular command link instance.
13
13
14
14
## Command Categories and Names
15
15
16
-
Each command has a unique key, known in the bar controls as a "full name". The full name can be returned via the [FullName](xref:@ActiproUIRoot.Controls.Bars.BarCommand.FullName) property on [BarCommand](xref:@ActiproUIRoot.Controls.Bars.BarCommand).
16
+
Each command has a unique key, known in the bar controls as a *full name*. The full name can be returned via the [BarCommand](xref:@ActiproUIRoot.Controls.Bars.BarCommand).[FullName](xref:@ActiproUIRoot.Controls.Bars.BarCommand.FullName) property.
17
17
18
-
The full name is a concatenation of a category and a command name, with a period (`.`) in between. This allows commands to easily be categorized and also for some names to be used more than once, in different categories.
18
+
The full name is a concatenation of a category and a command name, with a period (`.`) in between. This allows commands to easily be categorized and for some names to be used more than once, in different categories.
19
19
20
-
For instance, typical commands on a `File` menu are `New`, `Open`, etc. In Bars, the full name of these commands would be `File.New` and `File.Open`, where the category of the command is `File` and the names of the commands are `New` and `Open` respectively.
20
+
For instance, typical commands on a **File** menu are **New**, **Open**, etc. In Bars, the full name of these commands would be `"File.New"` and `"File.Open"`, where the category of the command is `"File"` and the names of the commands are `"New"` and `"Open"` respectively.
21
21
22
-
The full name is the primary method of accessing and identifying commands.
22
+
> [!NOTE]
23
+
> The full name is the primary method of accessing and identifying commands.
23
24
24
25
## Command / Command Link Types
25
26
@@ -168,6 +169,6 @@ The easiest way to create a command link for a command is to call the [CreateCom
168
169
169
170
Command links can be cloned by using the [Clone](xref:@ActiproUIRoot.Controls.Bars.BarCommandLink.Clone*) method.
170
171
171
-
## Preventing Menus from Closing When a Link Is clicked
172
+
## Preventing Menus from Closing When a Link Is Clicked
172
173
173
-
When used on a menu, command links normally close the menu when they are clicked. However in some cases it is useful to keep the menu open so that the link may be immediately clicked again. For these scenarios, you can set the [StaysOpenOnClick](xref:@ActiproUIRoot.Controls.Bars.BarCommand.StaysOpenOnClick) property to `true` to keep a menu open when a link for the command is clicked.
174
+
When used on a menu, command links normally close the menu when they are clicked. However, in some cases it is useful to keep the menu open so that the link may be immediately clicked again. For these scenarios, you can set the [StaysOpenOnClick](xref:@ActiproUIRoot.Controls.Bars.BarCommand.StaysOpenOnClick) property to `true` to keep a menu open when a link for the command is clicked.
Copy file name to clipboardExpand all lines: Documentation/topics/bars/commands/labels.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,4 +39,4 @@ Tooltips will be displayed for the command if the [ToolTipEnabled](xref:@Actipro
39
39
40
40
## Changing the Text Displayed in the Run-Time Customize Dialog for the Command
41
41
42
-
By default, the [Text](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Text) property value of the command will be displayed in the run-time customize dialog's command listbox. However if this is not appropriate or needs to be customized for the command listbox, the [CustomizeListText](xref:@ActiproUIRoot.Controls.Bars.BarCommand.CustomizeListText) property can be set to override what is displayed.
42
+
By default, the [Text](xref:@ActiproUIRoot.Controls.Bars.BarCommand.Text) property value of the command will be displayed in the run-time customize dialog's command listbox. However, if this is not appropriate or needs to be customized for the command listbox, the [CustomizeListText](xref:@ActiproUIRoot.Controls.Bars.BarCommand.CustomizeListText) property can be set to override what is displayed.
0 commit comments