From a0c9babf118e92f15ea397da64e0aadc8335ad6b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20R=C3=BCegg?= Date: Mon, 6 Mar 2023 19:44:29 +0100 Subject: [PATCH] Move `properties` section to properties.html --- docs/syntax/dynamic.html | 711 +----------------------------------- docs/syntax/properties.html | 697 +++++++++++++++++++++++++++++++++++ 2 files changed, 706 insertions(+), 702 deletions(-) create mode 100644 docs/syntax/properties.html diff --git a/docs/syntax/dynamic.html b/docs/syntax/dynamic.html index e36e297..6396b27 100644 --- a/docs/syntax/dynamic.html +++ b/docs/syntax/dynamic.html @@ -67,9 +67,10 @@

items create a single menu entry.

Properties
-

Either a title or a image property is - mandatory (set to a non-null value). For further details, please refer to the Either a title or a image + property is mandatory (set to a non-null value). For further details, please refer to the properties section below.

Syntax
@@ -82,9 +83,10 @@ and sub-entries.

-

Either a title or a image property is - mandatory (set to a non-null value). For further details, please refer to the Either a title or a image + property is mandatory (set to a non-null value). For further details, please refer to the properties section below.

@@ -127,704 +129,9 @@
Properties

separators do not have any mandatory properties. Please refer to the properties section below for further + href="properties.html" style="border-bottom: 1px solid currentColor;">properties section below for further details.

Syntax
separator
 separator( property = value [property = value [...] ])
-
- - -

Properties

- -
Index
- - -
Entry types
-

The Applies column shows, whether the property applies to menus, items - and/or separators. - If set in bold, then the property is mandatory for the given type.

- -
Syntax
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyAppliesSummary
WhereMDisplay menuitem if true is returned. Allows the evaluation of arbitrary - expressions, e.g. - if
- Default = true -
TitleMISets the caption of the menuitem.
-

It is mandatory for menu and item entries, unless a image property is defined.

- Default = null -
ModeMISDisplay menuitem by type of selection. The value has one of the following parameters - (of type string): - - - - - - - - - - - - - - - - - - - - - -
noneDisplay menuitem when there is no selection.
singleDisplay menuitem when there is a single object selected.
multi_uniqueDisplay menuitem when multiple objects of the same type are selected. -
multi_singleDisplay menuitem when multiple files with a single file extension are selected.
multipleDisplay any type of selection, unless there is none.
- Default = single -
TypeMISSpecifies the types of objects for which the menuitem will be displayed.
- Possible values are shown below. Separate multiple types with the pipe character (|), in - which case the menuitem is displayed if any of the given types is matched.
- To exclude a given type, prefix its value with the tilde character (~). -

Expressions are not supported with this property.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
*Display menuitem when any type is selected.
FileDisplay menuitem when files are selected.
Directory(Dir)Display menuitem when directories are selected.
DriveDisplay menuitem when drives are selected.
USBDisplay menuitem when USB flash-drives are selected.
DVDDisplay menuitem when DVD-ROM drives are selected.
FixedDisplay menuitem when fixed drives are selected. Such drives have a fixed media; for - example, a hard disk drive or flash drive. -
VHDDisplay menuitem when Virtual Hard Disks are selected.
RemovableDisplay menuitem when the selected drives have removable media; for example, a floppy drive, - thumb drive, or flash card - reader. -
RemoteDisplay menuitem when the selected remote (network) drives are selected.
BackDisplay menuitem when the background of all types are selected (back). Or - specify one of - the following more granular types for the background: -
    -
  • - back.directory -
  • -
  • - back.drive, including -
      -
    • back.fixed
    • -
    • back.usb
    • -
    • back.dvd
    • -
    • back.vhd
    • -
    • back.Removable
    • -
    -
  • -
  • - back.namespace, including -
      -
    • back.computer
    • -
    • back.recyclebin
    • -
    -
  • -
-
DesktopDisplay menuitem when the Desktop is selected.
NamespaceDisplay menuitem when Namespaces are selected. Can be virtual objects such as My Network Places and Recycle Bin. -
ComputerDisplay menuitem when My Computer is selected.
RecyclebinDisplay menuitem when the Recycle bin is selected. -
TaskbarDisplay menuitem when the Taskbar is selected. -
- Default = Accepts all types, except for the Taskbar. -
Visibility (vis)MISSets the visibility of a menuitem. Can have one of the following parameters: - - - - - - - - - - - - - - - - - - - - - -
HiddenThem menuitem will not be displayed.
NormalEnabled the menuitem.
DisableDisabled the menuitem.
StaticDisplay menuitem as label, with or without an image
LabelDisplay menuitem as label without an image
- Default = Normal -
FindMIS -

Display menuitem when the specified path name or path extension matches the current - find property.
- Separate patterns by the pipe delimiter (|).

- Default = null
- Syntax
- find = 'exe' Find any word contains "exe"
- find = '"exe"' Match whole word only
- find = '*exe' Find a word that ends with
- find = 'exe*' Find a word that starts with
-
- find = '!exe' Find any word not contains "exe"
- find = '!"exe"' Search for any word not equal to "exe"
- find = '!*exe' Find a word that not ends with
- find = 'exe*!' Find a word that starts with
-
- find = '.exe' Find an equal extension for ".exe"
- find = '!.exe' Find an not equal extension for ".exe"
-
- find = '.exe|.dll' Find an equal extension for ".exe" or ".dll" -
Separator (sep)MIAdd a separator to the menuitem: - - - - - - - - - - - - - - - - - -
NoneNot adding a separator with the menuitem.
Before, TopAdd a separator before the menuitem.
After, BottomAdd a separator after the menuitem.
BothAdd a separator before and after the menuitem.
- Default = none -
Position (pos)MISThe position at which a menuitem should be inserted into the menu.
- Position can have one of the following parameters: - - - - - - - - - - - - - - - - - - - - - -
AutoInsert the menuitem to the current position.
MiddleInsert the menuitem to the middle of the menu. -
TopInsert the menuitem to the top of the menu. -
BottomInsert the menuitem to the bottom of the menu. -
IntegerInsert the menuitem to a specified position.
- Default = auto -
Image, IconMIThe icon that appears in a menuitem. This property can be assigned as image files, - resource icons, glyph - or color. With one of the following parameters - - - - - - - - - - - - - - - - - - - - - - - - - -
nullShow menuitem without icon.
Inherit@*Inheriting the image from the parent.*@ - Inherits this property from its parent element. -
CmdAssign image from the command property.
GlyphAssign image as Glyph.
ColorAssign image as color.
PathAssign image from location path or resource icon.
- Default = null -
Parent, MenuMIS

Move current menuitem to another menu.

- Default = null
Command (cmd)I

The command associated with the menuitem. Occurs when the menuitem is clicked or - selected using a shortcut key or access key defined for the menuitem.

- Default = null -
Arguments (arg, args)I

The command line parameters to pass to the command - property of a menuitem.

- Default = null -
InvokeISet execution type - - - - - - - - - -
0, singleexecute the command for each selected object -
1, multipleexecute the command in one process -
- Default = 0 -
WindowIControls how the window of the executed command - is to be shown. Can be one of the following parameters: -

Hidden, Show, Visible, - Minimized, Maximized

- Default = show -
Directory (dir)I

Specifies the working directory to execute - the command in.

- Default = null -
AdminI

Execute the command with administrative permissions.

- Default = false -
VerbISpecifies the default operation for the selected file. Value type string - and can have one of the following parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
nullSpecifies that the operation is the default for the selected file type.
OpenOpens a file or an application.
OpenAsOpener dialog when no program is associated to the extension.
RunAsIn Windows 7 and Vista, opens the UAC dialog andin others, open the Run as... Dialog.
EditOpens the default text editor for the file.
ExploreOpens the Windows Explorer in the folder specified in Directory.
PropertiesOpens the properties window of the file.
PrintStart printing the file with the default application.
FindStart a search.
- Default = open -
WaitI -

Wait for the command - to complete.

- Default = false -
CheckedIType of select option: - - - - - - - - - - - - - -
0Not checked
1Display as check mark.
2Display as radio bullet.
- Default = 0 -
DefaultMI -

Specifies that the item is the default. A menu - can contain only one default menuitem, which is displayed in bold.

- Default = false -
ExpandedM -

Move all immediate menuitems to the parent menu.

- Default = false -
Column(col)MI

Create a new column.

- Default = true -
KeysMI

Show keyboard shortcuts.

- Default = null
TipMI -

Show a tooltip for the current menu - or item. -

- Default = null
- Syntax
-

-tip = "Lorem Ipsum is simply dummy text."
-tip = ["Lorem Ipsum is simply dummy text.", tip.info]
-tip = ["Lorem Ipsum is simply dummy text.", tip.info, 1.2]
-
-
-
diff --git a/docs/syntax/properties.html b/docs/syntax/properties.html new file mode 100644 index 0000000..c6b7b4a --- /dev/null +++ b/docs/syntax/properties.html @@ -0,0 +1,697 @@ +

Properties

+ +
Index
+ + +
Entry types
+

The Applies column shows, whether the property applies to menus, items + and/or separators. + If set in bold, then the property is mandatory for the given type.

+ +
Syntax
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyAppliesSummary
WhereMDisplay menuitem if true is returned. Allows the evaluation of arbitrary + expressions, e.g. + if
+ Default = true +
TitleMISets the caption of the menuitem.
+

It is mandatory for menu and item entries, unless a image property is defined.

+ Default = null +
ModeMISDisplay menuitem by type of selection. The value has one of the following parameters + (of type string): + + + + + + + + + + + + + + + + + + + + + +
noneDisplay menuitem when there is no selection.
singleDisplay menuitem when there is a single object selected.
multi_uniqueDisplay menuitem when multiple objects of the same type are selected. +
multi_singleDisplay menuitem when multiple files with a single file extension are selected.
multipleDisplay any type of selection, unless there is none.
+ Default = single +
TypeMISSpecifies the types of objects for which the menuitem will be displayed.
+ Possible values are shown below. Separate multiple types with the pipe character (|), in + which case the menuitem is displayed if any of the given types is matched.
+ To exclude a given type, prefix its value with the tilde character (~). +

Expressions are not supported with this property.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
*Display menuitem when any type is selected.
FileDisplay menuitem when files are selected.
Directory(Dir)Display menuitem when directories are selected.
DriveDisplay menuitem when drives are selected.
USBDisplay menuitem when USB flash-drives are selected.
DVDDisplay menuitem when DVD-ROM drives are selected.
FixedDisplay menuitem when fixed drives are selected. Such drives have a fixed media; for + example, a hard disk drive or flash drive. +
VHDDisplay menuitem when Virtual Hard Disks are selected.
RemovableDisplay menuitem when the selected drives have removable media; for example, a floppy drive, + thumb drive, or flash card + reader. +
RemoteDisplay menuitem when the selected remote (network) drives are selected.
BackDisplay menuitem when the background of all types are selected (back). Or + specify one of + the following more granular types for the background: +
    +
  • + back.directory +
  • +
  • + back.drive, including +
      +
    • back.fixed
    • +
    • back.usb
    • +
    • back.dvd
    • +
    • back.vhd
    • +
    • back.Removable
    • +
    +
  • +
  • + back.namespace, including +
      +
    • back.computer
    • +
    • back.recyclebin
    • +
    +
  • +
+
DesktopDisplay menuitem when the Desktop is selected.
NamespaceDisplay menuitem when Namespaces are selected. Can be virtual objects such as My Network Places and Recycle Bin. +
ComputerDisplay menuitem when My Computer is selected.
RecyclebinDisplay menuitem when the Recycle bin is selected. +
TaskbarDisplay menuitem when the Taskbar is selected. +
+ Default = Accepts all types, except for the Taskbar. +
Visibility (vis)MISSets the visibility of a menuitem. Can have one of the following parameters: + + + + + + + + + + + + + + + + + + + + + +
HiddenThem menuitem will not be displayed.
NormalEnabled the menuitem.
DisableDisabled the menuitem.
StaticDisplay menuitem as label, with or without an image
LabelDisplay menuitem as label without an image
+ Default = Normal +
FindMIS +

Display menuitem when the specified path name or path extension matches the current + find property.
+ Separate patterns by the pipe delimiter (|).

+ Default = null
+ Syntax
+ find = 'exe' Find any word contains "exe"
+ find = '"exe"' Match whole word only
+ find = '*exe' Find a word that ends with
+ find = 'exe*' Find a word that starts with
+
+ find = '!exe' Find any word not contains "exe"
+ find = '!"exe"' Search for any word not equal to "exe"
+ find = '!*exe' Find a word that not ends with
+ find = 'exe*!' Find a word that starts with
+
+ find = '.exe' Find an equal extension for ".exe"
+ find = '!.exe' Find an not equal extension for ".exe"
+
+ find = '.exe|.dll' Find an equal extension for ".exe" or ".dll" +
Separator (sep)MIAdd a separator to the menuitem: + + + + + + + + + + + + + + + + + +
NoneNot adding a separator with the menuitem.
Before, TopAdd a separator before the menuitem.
After, BottomAdd a separator after the menuitem.
BothAdd a separator before and after the menuitem.
+ Default = none +
Position (pos)MISThe position at which a menuitem should be inserted into the menu.
+ Position can have one of the following parameters: + + + + + + + + + + + + + + + + + + + + + +
AutoInsert the menuitem to the current position.
MiddleInsert the menuitem to the middle of the menu. +
TopInsert the menuitem to the top of the menu. +
BottomInsert the menuitem to the bottom of the menu. +
IntegerInsert the menuitem to a specified position.
+ Default = auto +
Image, IconMIThe icon that appears in a menuitem. This property can be assigned as image files, + resource icons, glyph + or color. With one of the following parameters + + + + + + + + + + + + + + + + + + + + + + + + + +
nullShow menuitem without icon.
Inherit@*Inheriting the image from the parent.*@ + Inherits this property from its parent element. +
CmdAssign image from the command property.
GlyphAssign image as Glyph.
ColorAssign image as color.
PathAssign image from location path or resource icon.
+ Default = null +
Parent, MenuMIS

Move current menuitem to another menu.

+ Default = null
Command (cmd)I

The command associated with the menuitem. Occurs when the menuitem is clicked or + selected using a shortcut key or access key defined for the menuitem.

+ Default = null +
Arguments (arg, args)I

The command line parameters to pass to the command + property of a menuitem.

+ Default = null +
InvokeISet execution type + + + + + + + + + +
0, singleexecute the command for each selected object +
1, multipleexecute the command in one process +
+ Default = 0 +
WindowIControls how the window of the executed command + is to be shown. Can be one of the following parameters: +

Hidden, Show, Visible, + Minimized, Maximized

+ Default = show +
Directory (dir)I

Specifies the working directory to execute + the command in.

+ Default = null +
AdminI

Execute the command with administrative permissions.

+ Default = false +
VerbISpecifies the default operation for the selected file. Value type string + and can have one of the following parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
nullSpecifies that the operation is the default for the selected file type.
OpenOpens a file or an application.
OpenAsOpener dialog when no program is associated to the extension.
RunAsIn Windows 7 and Vista, opens the UAC dialog andin others, open the Run as... Dialog.
EditOpens the default text editor for the file.
ExploreOpens the Windows Explorer in the folder specified in Directory.
PropertiesOpens the properties window of the file.
PrintStart printing the file with the default application.
FindStart a search.
+ Default = open +
WaitI +

Wait for the command + to complete.

+ Default = false +
CheckedIType of select option: + + + + + + + + + + + + + +
0Not checked
1Display as check mark.
2Display as radio bullet.
+ Default = 0 +
DefaultMI +

Specifies that the item is the default. A menu + can contain only one default menuitem, which is displayed in bold.

+ Default = false +
ExpandedM +

Move all immediate menuitems to the parent menu. +

+ Default = false +
Column(col)MI

Create a new column.

+ Default = true +
KeysMI

Show keyboard shortcuts.

+ Default = null
TipMI +

Show a tooltip for the current menuor + item. +

+ Default = null
+ Syntax
+

+tip = "Lorem Ipsum is simply dummy text."
+tip = ["Lorem Ipsum is simply dummy text.", tip.info]
+tip = ["Lorem Ipsum is simply dummy text.", tip.info, 1.2]
+
+
+