Rob van der Woude's Scripting Pages

Help text for dialogboxes

(view help text of dialogboxes as plain text)

Help for FontSelectBox class
─────────────────────────────

Present a font dialog, and return the selected font


COM ProgID: RobvanderWoude.FontSelectBox


┌──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│                                                                                                                                              │
│ Properties        (Note that all properties are string or integer, no booleans, objects or arrays)                                           │
│                                                                                                                                              │
╞══════════════════╤════════════════════════════════════════════════════╤═══════════╤═══════════╤══════════════════════════════════════════════╡
│ Property Name    │ Description                                        │ Mandatory │ Read-Only │ Default (Allowed) Values                     │
╞══════════════════╪════════════════════════════════════════════════════╪═══════════╪═══════════╪══════════════════════════════════════════════╡
│ choosecharset    │ Allow alternative character sets (0=false; 1=true) │ no        │ no        │ 1: allow                                     │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ debuginfo        │ A log of actions for debugging                     │ N/A       │ YES       │                                              │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ errors           │ List of errors with current settings               │ N/A       │ YES       │                                              │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ fixedpitchonly   │ Allow only monospaced fonts      (0=false; 1=true) │ no        │ no        │ 0: allow proportional fonts as well          │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ fontcharset      │ Font character set used in dialog                  │ no        │ no        │ ANSI                                         │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ fontcolorB       │ Blue component of font color                       │ no        │ no        │ 0                                            │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ fontcolorG       │ Green component of font color                      │ no        │ no        │ 0                                            │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ fontcolorname    │ Name of font color                                 │ no        │ no        │ Black                                        │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ fontcolorR       │ Red component of font color                        │ no        │ no        │ 0                                            │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ fontcolorRGB     │ RGB values of font color                           │ no        │ no        │ 0,0,0                                        │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ fontfamily       │ Font family used in dialog                         │ no        │ no        │ Microsoft Sans Serif                         │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ fontsize         │ Font size used in dialog                           │ no        │ no        │ 10 (6..64)                                   │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ fontstyle        │ Font stylee used in dialog                         │ no        │ no        │ Regular (Bold, Italic, StrikeOut, UnderLine) │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ maximumfontsize  │ Maximum font size allowed in dialog                │ no        │ no        │ 64                                           │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ minimumfontsize  │ Minimum font size allowed in dialog                │ no        │ no        │ 6                                            │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ modal            │ Modal dialog, i.e. always on top (0=false; 1=true) │ no        │ no        │ 1: always on top                             │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ scriptsonly      │ Disable non-OEM & symbol fonts   (0=false; 1=true) │ no        │ no        │ 0: allow all                                 │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ showcolor        │ Allow color choice in dialog     (0=false; 1=true) │ no        │ no        │ 1: allow                                     │
│                  │ (requires showeffects = 1)                         │           │           │                                              │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ showeffects      │ Allow underline, strikethrough   (0=false; 1=true) │ no        │ no        │ 1: allow                                     │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ vectorfonts      │ Allow vector fonts in the dialog (0=false; 1=true) │ no        │ no        │ 1: allow                                     │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ Version          │ Show this DLL's version                            │ N/A       │ YES       │                                              │
└──────────────────┴────────────────────────────────────────────────────┴───────────┴───────────┴──────────────────────────────────────────────┘


┌──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│                                                                                                                                              │
│ Methods                                                                                                                                      │
│                                                                                                                                              │
╞══════════════════╤════════════════════════════════════════════════════════════════════════════╤══════════════════════════════════════════════╡
│ Method Name      │ Description                                                                │ Requirements                                 │
╞══════════════════╪════════════════════════════════════════════════════════════════════════════╪══════════════════════════════════════════════╡
│ CheckUpdate      │ Check the developer's website for updates                                  │                                              │
├──────────────────┼────────────────────────────────────────────────────────────────────────────┼──────────────────────────────────────────────┤
│ Credits          │ Shows credits                                                              │                                              │
├──────────────────┼────────────────────────────────────────────────────────────────────────────┼──────────────────────────────────────────────┤
│ Help             │ Returns this help text as plain text, or if optional parameter equals 1,   │                                              │
│                  │ as html                                                                    │                                              │
├──────────────────┼────────────────────────────────────────────────────────────────────────────┼──────────────────────────────────────────────┤
│ ListColors       │ Returns a semicolon-separated list of all available color names            │                                              │
├──────────────────┼────────────────────────────────────────────────────────────────────────────┼──────────────────────────────────────────────┤
│ ListFontCharSets │ Returns a semicolon-separated list of available font character sets        │                                              │
├──────────────────┼────────────────────────────────────────────────────────────────────────────┼──────────────────────────────────────────────┤
│ ListProperties   │ Returns a list of this class' properties as key=value pairs (1 per line)   │                                              │
├──────────────────┼────────────────────────────────────────────────────────────────────────────┼──────────────────────────────────────────────┤
│ SampleCode       │ Returns VBScript sample code for this dialog                               │                                              │
├──────────────────┼────────────────────────────────────────────────────────────────────────────┼──────────────────────────────────────────────┤
│ Show             │ Presents a font dialog based on the current property values, and if "OK"   │                                              │
│                  │ is clicked, saves the selected font properties in the "fontfamily",        │                                              │
│                  │ "fontsize", "fontstyle", "fontcharset", "fontcolorname", "fontcolorRGB",   │                                              │
│                  │ "fontcolorR", "fontcolorG" and  "fontcolorB" properties (if "Cancel" is    │                                              │
│                  │ clicked, the default font and properties are selected).                    │                                              │
└──────────────────┴────────────────────────────────────────────────────────────────────────────┴──────────────────────────────────────────────┘


VBScript usage example:
───────────────────────

Set objFontSelectBox = CreateObject( "RobvanderWoude.FontSelectBox" )

With objFontSelectBox
	.Show
	WScript.Echo .ListProperties( )
End With

Set objFontSelectBox = Nothing

page last uploaded: 2019-01-21, 22:48