mirror of
https://github.com/moudey/Shell.git
synced 2026-11-17 15:05:41 +08:00
Delete docs directory
This commit is contained in:
1 parent
c6c1d73d23
commit
22e05ab1ad
33 files changed
-3185
No files matched your search
@@ -1,59 +0,0 @@
|
||||
@page
|
||||
@{
|
||||
ViewData["title"] = "APP - Functions";
|
||||
ViewData["page-support"] = "Functions \\ APP";
|
||||
}
|
||||
<h5>APP</h5>
|
||||
<br>
|
||||
<p>The namespace of the application contains file paths, version and some details.</p>
|
||||
<br>
|
||||
<p>
|
||||
<h5>app.directory (app.dir)</h5>
|
||||
Returns the path of <b>Shell</b> directory.
|
||||
</p>
|
||||
<br>
|
||||
<p>
|
||||
<h5>app.cfg</h5>
|
||||
Returns the path of the configuration file "shell.shl".
|
||||
</p>
|
||||
<br>
|
||||
<p>
|
||||
<h5>app.dll</h5>
|
||||
Returns the path of "shell.dll".
|
||||
</p>
|
||||
<br>
|
||||
<p>
|
||||
<h5>app.exe</h5>
|
||||
Returns the path of "shell.exe".
|
||||
</p>
|
||||
<br>
|
||||
<p>
|
||||
<h5>app.name</h5>
|
||||
Returns application name.
|
||||
</p>
|
||||
<br>
|
||||
<p>
|
||||
<h5>app.version (app.ver)</h5>
|
||||
Revert <b>Shell</b> version.
|
||||
</p>
|
||||
<br>
|
||||
<p>
|
||||
<h5>app.is64</h5>
|
||||
Returns the architecture of the application.
|
||||
</p>
|
||||
<br>
|
||||
<p>
|
||||
<h5>app.about</h5>
|
||||
Returns <b>Shell</b> information.
|
||||
</p>
|
||||
<br>
|
||||
<p>
|
||||
<h5>app.reload</h5>
|
||||
Reload the configuration file.
|
||||
</p>
|
||||
<br>
|
||||
<p>
|
||||
<h5>app.unload</h5>
|
||||
Unload the configuration file.
|
||||
</p>
|
||||
<br>
|
||||
@@ -1,154 +0,0 @@
|
||||
@page
|
||||
@{
|
||||
ViewData["title"] = "COLOR - Functions";
|
||||
ViewData["page-support"] = "Functions \\ COLOR";
|
||||
}
|
||||
<h5>COLOR</h5>
|
||||
<br>
|
||||
<p>Color namespace contains predefined colors</p>
|
||||
<br>
|
||||
<pre>
|
||||
color.default
|
||||
color.accent
|
||||
color.aliceblue
|
||||
color.antiquewhite
|
||||
color.aqua
|
||||
color.aquamarine
|
||||
color.azure
|
||||
color.beige
|
||||
color.bisque
|
||||
color.black
|
||||
color.blanchedalmond
|
||||
color.blue
|
||||
color.blueviolet
|
||||
color.brown
|
||||
color.burlywood
|
||||
color.cadetblue
|
||||
color.chartreuse
|
||||
color.chocolate
|
||||
color.coral
|
||||
color.cornflowerblue
|
||||
color.cornsilk
|
||||
color.crimson
|
||||
color.cyan
|
||||
color.darkblue
|
||||
color.darkcyan
|
||||
color.darkgoldenrod
|
||||
color.darkgray
|
||||
color.darkgreen
|
||||
color.darkkhaki
|
||||
color.darkmagenta
|
||||
color.darkolivegreen
|
||||
color.darkorange
|
||||
color.darkorchid
|
||||
color.darkred
|
||||
color.darksalmon
|
||||
color.darkseagreen
|
||||
color.darkslateblue
|
||||
color.darkslategray
|
||||
color.darkturquoise
|
||||
color.darkviolet
|
||||
color.deeppink
|
||||
color.deepskyblue
|
||||
color.dimgray
|
||||
color.dodgerblue
|
||||
color.firebrick
|
||||
color.floralwhite
|
||||
color.forestgreen
|
||||
color.fuchsia
|
||||
color.gainsboro
|
||||
color.ghostwhite
|
||||
color.gold
|
||||
color.goldenrod
|
||||
color.gray
|
||||
color.green
|
||||
color.greenyellow
|
||||
color.honeydew
|
||||
color.hotpink
|
||||
color.indianred
|
||||
color.indigo
|
||||
color.ivory
|
||||
color.khaki
|
||||
color.lavender
|
||||
color.lavenderblush
|
||||
color.lawngreen
|
||||
color.lemonchiffon
|
||||
color.lightblue
|
||||
color.lightcoral
|
||||
color.lightcyan
|
||||
color.lightgoldenrodyellow
|
||||
color.lightgray
|
||||
color.lightgreen
|
||||
color.lightpink
|
||||
color.lightsalmon
|
||||
color.lightseagreen
|
||||
color.lightskyblue
|
||||
color.lightslategray
|
||||
color.lightsteelblue
|
||||
color.lightyellow
|
||||
color.lime
|
||||
color.limegreen
|
||||
color.linen
|
||||
color.magenta
|
||||
color.maroon
|
||||
color.mediumaquamarine
|
||||
color.mediumblue
|
||||
color.mediumorchid
|
||||
color.mediumpurple
|
||||
color.mediumseagreen
|
||||
color.mediumslateblue
|
||||
color.mediumspringgreen
|
||||
color.mediumturquoise
|
||||
color.mediumvioletred
|
||||
color.midnightblue
|
||||
color.mintcream
|
||||
color.mistyrose
|
||||
color.moccasin
|
||||
color.navajowhite
|
||||
color.navy
|
||||
color.oldlace
|
||||
color.olive
|
||||
color.olivedrab
|
||||
color.orange
|
||||
color.orangered
|
||||
color.orchid
|
||||
color.palegoldenrod
|
||||
color.palegreen
|
||||
color.paleturquoise
|
||||
color.palevioletred
|
||||
color.papayawhip
|
||||
color.peachpuff
|
||||
color.peru
|
||||
color.pink
|
||||
color.plum
|
||||
color.powderblue
|
||||
color.purple
|
||||
color.red
|
||||
color.rosybrown
|
||||
color.royalblue
|
||||
color.saddlebrown
|
||||
color.salmon
|
||||
color.sandybrown
|
||||
color.seagreen
|
||||
color.seashell
|
||||
color.sienna
|
||||
color.silver
|
||||
color.skyblue
|
||||
color.slateblue
|
||||
color.slategray
|
||||
color.snow
|
||||
color.springgreen
|
||||
color.steelblue
|
||||
color.tan
|
||||
color.teal
|
||||
color.thistle
|
||||
color.tomato
|
||||
color.transparent
|
||||
color.turquoise
|
||||
color.violet
|
||||
color.wheat
|
||||
color.white
|
||||
color.whitesmoke
|
||||
color.yellow
|
||||
color.yellowgreen
|
||||
</pre>
|
||||
@@ -1,49 +0,0 @@
|
||||
@page
|
||||
@{
|
||||
ViewData["title"] = "Functions";
|
||||
ViewData["page-support"] = "Functions \\ Image";
|
||||
}
|
||||
<h5>IMAGE (DRAW)</h5>
|
||||
<p>The image namespace contains functions that return an icon and are only assigned to the <code>image</code> property</p>
|
||||
<section class="my-5">
|
||||
<h5>image.glyph</h5>
|
||||
<p>Return font icon with color and size option.</p>
|
||||
<p>Syntax</p>
|
||||
<code>image.glyph(0xE00B)</code><br>
|
||||
<code>image.glyph("\uE00B")</code><br>
|
||||
<code>image.glyph("\xE00B")</code><br>
|
||||
<br>
|
||||
<code>image.glyph(0xE00B, #0000ff)</code><br>
|
||||
<code>image.glyph(0xE00B, #0000ff, 10)</code><br>
|
||||
<code>image.glyph(0xE00B, #0000ff, 12, "Segoe MDL2 Assets")</code><br>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>image.icon</h5>
|
||||
<p>Returns an icon through a path or through resources.</p>
|
||||
<p>Syntax</p>
|
||||
<code>image.icon(path)</code><br>
|
||||
<code>image.icon(path, index)</code><br>
|
||||
<code>image.icon(path, -id)</code><br>
|
||||
<br>
|
||||
<code>image(path)</code><br>
|
||||
<code>image(path, index)</code><br>
|
||||
<code>image(path, -id)</code><br>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>image.rect</h5>
|
||||
<p>Returns a colored rectangle icon of an optional size.</p>
|
||||
<p>Syntax</p>
|
||||
<code>image.rect(#0000ff)</code><br>
|
||||
<code>image.rect(#0000ff, 10)</code><br>
|
||||
</section>
|
||||
|
||||
@*
|
||||
<pre>
|
||||
image.res
|
||||
image.str
|
||||
image.symbol
|
||||
draw.str
|
||||
draw.symbol
|
||||
draw.circle
|
||||
</pre>
|
||||
*@
|
||||
@@ -1,162 +0,0 @@
|
||||
@page
|
||||
@{
|
||||
ViewData["title"] = "Functions";
|
||||
ViewData["page-support"] = "Functions";
|
||||
}
|
||||
<h4>Functions</h4>
|
||||
<p>The functions and variables have unique titles described by fully qualified names that indicate a logical hierarchy.</p>
|
||||
<p><b>Shell</b> has a number of functions and variables built into it that are always available. They are listed here in alphabetical order.</p>
|
||||
<section class="my-5">
|
||||
<h5>if</h5>
|
||||
<p>Conditionally executes another statement.</p>
|
||||
<p>Syntax</p>
|
||||
<code>if(condition-expression)</code><br><br>
|
||||
<code>if(condition-expression, true-expression)</code><br><br>
|
||||
<code>if(condition-expression, true-expression, false-expression)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>null</h5>
|
||||
<p>Returns a null value.</p>
|
||||
<p>Syntax</p>
|
||||
<code>null(expression)</code><br><br>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>quote</h5>
|
||||
<p>Returns text with a double quotation mark.</p>
|
||||
<p>Syntax</p>
|
||||
<code>quote(expression)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>char</h5>
|
||||
<p>Returns the value of the numeric parameter to a character.</p>
|
||||
<p>Syntax</p>
|
||||
<code>char(numeric-expression)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>var</h5>
|
||||
<p>Returns the value of the passed variable</p>
|
||||
<p>Syntax</p>
|
||||
<code>var(expression)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>tohex</h5>
|
||||
<p>Converting the value of the passed numeric expression to hexadecimal string.</p>
|
||||
<p>Syntax</p>
|
||||
<code>tohex(numeric-expression)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>equal</h5>
|
||||
<p>Returns <code>true</code> if the parameters passed are equal.</p>
|
||||
<p>Syntax</p>
|
||||
<code>equal(expression-1, expression-2)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>not</h5>
|
||||
<p>Returns <code>true</code> if the parameters passed are not equal.</p>
|
||||
<p>Syntax</p>
|
||||
<code>not(expression-1, expression-2)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>greater</h5>
|
||||
<p>Returns <code>true</code> if the first parameter is greater than the second parameter.</p>
|
||||
<p>Syntax</p>
|
||||
<code>greater(expression-1, expression-2)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>less</h5>
|
||||
<p>Returns <code>true</code> if the first parameter is less than the second parameter.</p>
|
||||
<p>Syntax</p>
|
||||
<code>less(expression-1, expression-2)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>shl</h5>
|
||||
<p>bitwise left shift.</p>
|
||||
<p>Syntax</p>
|
||||
<code>shl(shift-expression, additive-expression)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>shr</h5>
|
||||
<p>bitwise right shift.</p>
|
||||
<p>Syntax</p>
|
||||
<code>shr(shift-expression, additive-expression)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>cmd visibility enumerations</h5>
|
||||
<p>The flags that specify how an application is to be displayed when it is opened.</p>
|
||||
<pre><code>cmd.hidden
|
||||
cmd.show
|
||||
cmd.visible
|
||||
cmd.normal
|
||||
cmd.maximized
|
||||
cmd.minimized</code></pre>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>Selection mode enumerations</h5>
|
||||
<p>Syntax</p>
|
||||
<pre><code>mode.none
|
||||
mode.single
|
||||
mode.multiple
|
||||
mode.multiunique
|
||||
mode.multisingle
|
||||
mode.multi</code></pre>
|
||||
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>Selection type enumerations</h5>
|
||||
<p>Syntax</p>
|
||||
<pre><code>type.desktop
|
||||
type.directory(dir)
|
||||
type.drive
|
||||
type.dvd
|
||||
type.file
|
||||
type.fixed
|
||||
type.namespace
|
||||
type.remote
|
||||
type.unknown
|
||||
type.usb
|
||||
type.vhd</code></pre>
|
||||
</section>
|
||||
|
||||
<h5>Keywords</h5>
|
||||
<pre><code>null
|
||||
bool
|
||||
true
|
||||
false
|
||||
auto
|
||||
none
|
||||
default</code>
|
||||
</pre>
|
||||
@*
|
||||
<pre>
|
||||
for
|
||||
foreach
|
||||
</pre>
|
||||
<h5>Keywords</h5>
|
||||
<pre>
|
||||
break
|
||||
continue
|
||||
null
|
||||
bool
|
||||
true
|
||||
false
|
||||
auto
|
||||
none
|
||||
inherit
|
||||
parent
|
||||
before
|
||||
after
|
||||
both
|
||||
top
|
||||
bottom
|
||||
hidden
|
||||
normal
|
||||
show
|
||||
visible
|
||||
minimized
|
||||
maximized
|
||||
</pre>
|
||||
*@
|
||||
|
||||
<div class="is-unstyled mt-5"><a href="~/docs/functions/app">app</a> | <a href="~/docs/functions/color">color</a> | <a href="~/docs/functions/image">image</a> | <a href="~/docs/functions/io">io</a> | <a href="~/docs/functions/key">key</a> | <a href="~/docs/functions/msg">msg</a> | <a href="~/docs/functions/path">path</a> | <a href="~/docs/functions/reg">reg</a> | <a href="~/docs/functions/sel">sel</a> | <a href="~/docs/functions/str">str</a> | <a href="~/docs/functions/sys">sys</a> | <a href="~/docs/functions/user">user</a>
|
||||
</div>
|
||||
|
||||
@@ -1,134 +0,0 @@
|
||||
@page
|
||||
@{
|
||||
ViewData["page-support"] = "Functions \\ IO";
|
||||
}
|
||||
<h5>IO</h5>
|
||||
<br>
|
||||
<section class="my-5">
|
||||
<h5>io.attribute enumerations.</h5>
|
||||
<p>Syntax</p>
|
||||
<pre><code>io.attribute.archive
|
||||
io.attribute.compressed
|
||||
io.attribute.device
|
||||
io.attribute.directory
|
||||
io.attribute.encrypted
|
||||
io.attribute.hidden
|
||||
io.attribute.invalid
|
||||
io.attribute.normal
|
||||
io.attribute.offline
|
||||
io.attribute.readonly
|
||||
io.attribute.sparsefile
|
||||
io.attribute.system
|
||||
io.attribute.temporary
|
||||
io.attribute.virtual</code></pre>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>io.attributes</h5>
|
||||
<p>Retrieves file system attributes for a specified path.</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.attributes(path)</code><br><br>
|
||||
<p>attribute verification</p>
|
||||
<pre><code>// check if path is hidden
|
||||
io.attribute.hidden(path)
|
||||
|
||||
// check if path is directory
|
||||
io.attribute.directory(path)
|
||||
|
||||
var { atrr = io.attributes(path) }
|
||||
|
||||
// check if attr is hidden
|
||||
io.attribute.hidden(atrr)
|
||||
|
||||
// check if attr is directory
|
||||
io.attribute.directory(atrr)</code></pre>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>io.copy</h5>
|
||||
<p>Copies an existing file to a new file.</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.copy(pathFrom, pathTo)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>io.move</h5>
|
||||
<p>Moves an existing file or a directory, including its children..</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.move(oldPath, newPath)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>io.rename</h5>
|
||||
<p>Rename a file or directory.</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.rename(oldName, newName)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>io.delete</h5>
|
||||
<p>Deletes an existing path.</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.delete(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>io.directory.create (io.dir.create)</h5>
|
||||
<p>Create new directory.</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.directory.create(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>io.directory.exists (io.dir.exists)</h5>
|
||||
<p>Check if one or more directories exists.</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.directory.exists(path)</code>
|
||||
<br>
|
||||
<code>io.directory.exists(path1, path2, path3, ...)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>io.directory.empty (io.dir.empty)</h5>
|
||||
<p>Check if one or more directory is empty.</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.directory.empty(path)</code>
|
||||
<br>
|
||||
<code>io.directory.empty(path1, path2, path3, ...)</code>
|
||||
</section>
|
||||
<h5 class="my-5">File functions.</h5>
|
||||
<section class="my-5">
|
||||
<h5>io.file.size</h5>
|
||||
<p>Retrieves the size of the specified file, in bytes.</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.file.size(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>io.file.exists</h5>
|
||||
<p>Check if one or more files exists.</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.file.exists(path)</code>
|
||||
<br>
|
||||
<code>io.file.exists(path1, path2, path3, ...)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>io.file.read</h5>
|
||||
<p>Read file contents as text with character count option.</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.file.read(path)</code><br>
|
||||
<code>io.file.read(path, 12)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>io.file.create</h5>
|
||||
<p>Create new file with content option.</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.file.create(path)</code><br>
|
||||
<code>io.file.create(path, "Hello World!")</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>io.file.write</h5>
|
||||
<p>Writing to a file with new content.</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.file.write(path, "Hello World!")</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>io.file.append</h5>
|
||||
<p>Appends text to an existing file, or to a new file if the specified file does not exist.</p>
|
||||
<p>Syntax</p>
|
||||
<code>io.file.append(path, "Hello ")</code>
|
||||
<br>
|
||||
<code>io.file.append(path, "World!")</code>
|
||||
</section>
|
||||
|
||||
@@ -1,86 +0,0 @@
|
||||
@page
|
||||
@{
|
||||
ViewData["page-support"] = "Functions \\ KEY";
|
||||
}
|
||||
<h5>KEY</h5>
|
||||
<p>Keyboard functions</p>
|
||||
<section class="my-5">
|
||||
<h5>keys enumerations</h5>
|
||||
<pre><code>key.alt
|
||||
key.apps
|
||||
key.back
|
||||
key.cancel
|
||||
key.capital
|
||||
key.capslock
|
||||
key.control
|
||||
key.delete
|
||||
key.down
|
||||
key.end
|
||||
key.enter
|
||||
key.escape
|
||||
key.execute
|
||||
key.f1
|
||||
key.f10
|
||||
key.f11
|
||||
key.f12
|
||||
key.f2
|
||||
key.f3
|
||||
key.f4
|
||||
key.f5
|
||||
key.f6
|
||||
key.f7
|
||||
key.f8
|
||||
key.f9
|
||||
key.help
|
||||
key.home
|
||||
key.insert
|
||||
key.lalt
|
||||
key.lcontrol
|
||||
key.left
|
||||
key.lshift
|
||||
key.lwin
|
||||
key.next
|
||||
key.none
|
||||
key.pagedown
|
||||
key.pageup
|
||||
key.pause
|
||||
key.play
|
||||
key.print
|
||||
key.printscreen
|
||||
key.prior
|
||||
key.ralt
|
||||
key.rcontrol
|
||||
key.return
|
||||
key.right
|
||||
key.rshift
|
||||
key.rwin
|
||||
key.shift
|
||||
key.snapshot
|
||||
key.space
|
||||
key.tab
|
||||
key.up
|
||||
key.win</code></pre>
|
||||
</section>
|
||||
|
||||
<section class="my-5">
|
||||
<h5>key</h5>
|
||||
<p>Syntax</p>
|
||||
<pre>
|
||||
<code>// check if SHIFT key is pressed
|
||||
key(key.shift)
|
||||
|
||||
// or
|
||||
key == key.shift
|
||||
|
||||
// or
|
||||
key.shift()
|
||||
|
||||
// check if tow keys (SHIFT+CTRL+X) is pressed
|
||||
key(key.shift, key.control)
|
||||
|
||||
// check if keys (SHIFT+CTRL+X) is pressed
|
||||
key(key.shift, key.control, 87)</code>
|
||||
</pre>
|
||||
</section>
|
||||
|
||||
|
||||
@@ -1,126 +0,0 @@
|
||||
@page
|
||||
@{
|
||||
ViewData["title"] = "MSG - Functions";
|
||||
ViewData["page-support"] = "Functions \\ MSG";
|
||||
}
|
||||
<h4>MSG</h4>
|
||||
<p>Displays a modal dialog box that contains a system icon, a set of buttons, and a brief application-specific message, such as status or error information. The message box returns an integer value that indicates which button the user clicked.</p>
|
||||
|
||||
<h5>Syntax</h5>
|
||||
<pre>
|
||||
msg(text)
|
||||
msg(text, title)
|
||||
msg(text, title, flags)
|
||||
</pre>
|
||||
<br>
|
||||
<h5>Parameters</h5>
|
||||
<table class="table table-borderless">
|
||||
<tr>
|
||||
<td class="kw">text</td>
|
||||
<td>The message to be displayed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="kw">title</td>
|
||||
<td>The dialog box title. If this parameter is NULL, the default title is <b>Nilesoft Shell</b>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="kw">flags</td>
|
||||
<td>The contents and behavior of the dialog box. This parameter can be a combination of flags from the following groups of flags.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h5>Flags</h5>
|
||||
<br>
|
||||
<h5>To display an icon in the message box, specify one of the following values.</h5>
|
||||
<dl>
|
||||
<dt>msg.error</dt>
|
||||
<dd>A stop-sign icon appears in the message box.</dd>
|
||||
|
||||
<dt>msg.question</dt>
|
||||
<dd>A question-mark icon appears in the message box.</dd>
|
||||
|
||||
<dt>msg.warning</dt>
|
||||
<dd>An exclamation-point icon appears in the message box.</dd>
|
||||
|
||||
<dt>msg.info</dt>
|
||||
<dd>An icon consisting of a lowercase letter i in a circle appears in the message box.</dd>
|
||||
</dl
|
||||
<br>
|
||||
<h5>To indicate the buttons displayed in the message box, specify one of the following values.</h5>
|
||||
<dl class="keyword">
|
||||
<dt>msg.ok</dt>
|
||||
<dd>The message box contains one push button: OK. This is the default.</dd>
|
||||
|
||||
<dt>msg.okcancel</dt>
|
||||
<dd>The message box contains two push buttons: OK and Cancel.</dd>
|
||||
|
||||
<dt>msg.yesnocancel</dt>
|
||||
<dd>The message box contains three push buttons: Yes, No, and Cancel.</dd>
|
||||
|
||||
<dt>msg.yesno</dt>
|
||||
<dd>The message box contains two push buttons: Yes and No.</dd>
|
||||
</dl>
|
||||
<br>
|
||||
<h5>To indicate the default button, specify one of the following values.</h5>
|
||||
<dl>
|
||||
<dt>msg.defbutton1</dt>
|
||||
<dd>The first button is the default button.</dd>
|
||||
|
||||
<dt>msg.defbutton2</dt>
|
||||
<dd>The second button is the default button.</dd>
|
||||
|
||||
<dt>msg.defbutton3</dt>
|
||||
<dd>The third button is the default button.</dd>
|
||||
</dl>
|
||||
<br>
|
||||
<h5>To indicate the modality of the dialog box, specify one of the following values.</h5>
|
||||
<dl>
|
||||
<dt>msg.applmodal</dt>
|
||||
<dd>The user must respond to the message box before continuing work in the current window. However, the user can move to the windows of other threads and work in those windows.</dd>
|
||||
<dt>msg.taskmodal</dt>
|
||||
<dd></dd>Same as msg.applmodal except that all the top-level windows belonging to the current thread are disabled. </dd>
|
||||
</dl>
|
||||
<br>
|
||||
<h5>To specify other options, use one or more of the following values.</h5>
|
||||
<dl>
|
||||
<dt>msg.right</dt>
|
||||
<dd>The text is right-justified.</dd>
|
||||
<dt>msg.rtlreading</dt>
|
||||
<dd>Displays message and caption text using right-to-left reading order on Hebrew and Arabic systems.</dd>
|
||||
<dt>msg.setforeground</dt>
|
||||
<dd>The message box becomes the foreground window.</dd>
|
||||
<dt>msg.topmost</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<br>
|
||||
<h5>Return value</h5>
|
||||
<p>If a message box has a Cancel button, the function returns the <code>msg.idcancel</code> value if either the <kbd>ESC</kbd> key is pressed or the Cancel button is selected. If the message box has no Cancel button, pressing <kbd>ESC</kbd> will no effect - unless an <code>msg.ok</code> button is present. If an <code>msg.ok</code> button is displayed and the user presses <kbd>ESC</kbd>, the return value will be <code>msg.idok</code>.</p>
|
||||
<p>If the function fails, the return value is zero.<br>
|
||||
If the function succeeds, the return value is one of the following values:
|
||||
<dl>
|
||||
<dt>msg.idok or 1</dt>
|
||||
<dd>The OK button was selected.</dd>
|
||||
|
||||
<dt>msg.idcancel or 2</dt>
|
||||
<dd>The Cancel button was selected.</dd>
|
||||
|
||||
<dt>msg.idyes or 6</dt>
|
||||
<dd>The Yes button was selected.</dd>
|
||||
|
||||
<dt>msg.idno or 7</dt>
|
||||
<dd>The No button was selected.</dd>
|
||||
</dl>
|
||||
</p>
|
||||
<h5>Examples</h5>
|
||||
<pre class="syntax"><code>msg("Hello, Warld!","NileSoft Shell", msg.info | msg.ok)<br>
|
||||
msg("Hello, Warld!","NileSoft Shell")<br>
|
||||
msg("Hello, Warld!")</code></pre>
|
||||
<br><br>
|
||||
<section class="my-5">
|
||||
<h5>msg.beep(type)</h5>
|
||||
<p>Plays a waveform sound. The waveform sound for each sound type is identified by an entry in the registry.</p>
|
||||
<p>Syntax</p>
|
||||
<code>sys.beep</code><br>
|
||||
<code>sys.beep(msg.error)</code><br>
|
||||
<code>sys.beep(msg.warning)</code>
|
||||
</section>
|
||||
@@ -1,190 +0,0 @@
|
||||
@page
|
||||
@{
|
||||
ViewData["page-support"] = "Functions \\ PATH";
|
||||
}
|
||||
<h5>PATH</h5>
|
||||
<br>
|
||||
<section class="my-5">
|
||||
<h5>path.combine (path.join)</h5>
|
||||
<p>Combines an array of strings into a path.</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.combine(path1, path2)</code><br>
|
||||
<code>path.combine("C:", "Windows", "Explorer.exe")</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.currentdirectory (path.curdir)</h5>
|
||||
<p>Retrieves the current directory for the current process.</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.currentdirectory</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.directory.name (path.dir.name)</h5>
|
||||
<p>Return the directory name from the path.</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.directory.name('c:\windows\system32') // returns: system32</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.directory.box (path.dir.box)</h5>
|
||||
<p>Shows the directory selection box and returns the path of the specified directory.</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.directory.box</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.empty</h5>
|
||||
<p>Check if one or more path is empty.</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.empty(path)</code><br>
|
||||
<code>path.empty(path1, path2, ...)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.exists</h5>
|
||||
<p>Check if one or more path exists..</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.exists(path)</code><br>
|
||||
<code>path.exists(path1, path2, ...)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.full</h5>
|
||||
<p>Returns the absolute path for the specified path string.</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.full(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.short</h5>
|
||||
<p>Retrieves the short path form of the specified path.</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.short(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.name</h5>
|
||||
<p>Return the name from the path.</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.name(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.location (path.parent)</h5>
|
||||
<p>Return the path of the parent</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.location(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.location.name</h5>
|
||||
<p>Return the name from the parent</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.location.name(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.root</h5>
|
||||
<p>Return the drive path</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.root(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.title</h5>
|
||||
<p>Return the title from the path</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.title(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.type</h5>
|
||||
<p>Return the type of path</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.type(path) == type.file</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.file.name</h5>
|
||||
<p>Return the name of path</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.file.name(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.file.title</h5>
|
||||
<p>Return the name of path without extension</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.file.title(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.file.ext</h5>
|
||||
<p>Return the extension of path</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.file.ext(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.file.box</h5>
|
||||
<p>Shows the file selection box and returns the path of the specified file.</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.file.box</code><br>
|
||||
<code>path.file.box('All|*.*|Text|*.txt')</code><br>
|
||||
<code>path.file.box('exe|*.exe', 'c:\windows')</code><br>
|
||||
<code>path.file.box('exe|*.exe', 'c:\windows', 'explorer.exe')</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.isabsolute</h5>
|
||||
<p></p>
|
||||
<p>Syntax</p>
|
||||
<code>path.isabsolute(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.isrelative</h5>
|
||||
<p></p>
|
||||
<p>Syntax</p>
|
||||
<code>path.isrelative(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.isfile</h5>
|
||||
<p></p>
|
||||
<p>Syntax</p>
|
||||
<code>path.isfile(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.isdirectory</h5>
|
||||
<p></p>
|
||||
<p>Syntax</p>
|
||||
<code>path.isdirectory(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.isroot (path.isdrive)</h5>
|
||||
<p></p>
|
||||
<p>Syntax</p>
|
||||
<code>path.isdrive(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.isclsid (path.isnamespace)</h5>
|
||||
<p></p>
|
||||
<p>Syntax</p>
|
||||
<code>path.isclsid(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.isexe</h5>
|
||||
<p></p>
|
||||
<p>Syntax</p>
|
||||
<code>path.isexe(path)</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.removeextension</h5>
|
||||
<p>Remove the extension from the passed parameter.</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.removeextension</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.lnktarget (path.lnk)</h5>
|
||||
<p>Return a path from the shortcut</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.lnktarget</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>path.getknownfolder</h5>
|
||||
<p>Retrieves the full path of a known folder identified.</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.getknownfolder('{905e63b6-c1bf-494e-b29c-65b732d3d21a}')</code>
|
||||
</section>
|
||||
|
||||
<section class="my-5">
|
||||
<h5>path.separator(path.sep)</h5>
|
||||
<p>Replacing the back slash with a forward slash or defining a spacer.</p>
|
||||
<p>Syntax</p>
|
||||
<code>path.separator('c:\windows\system32')</code> <em>return "c:/windows/system32"</em><br>
|
||||
<code>path.separator('c:\windows\system32', '#')</code> <em>return "c:#windows#system32"</em>
|
||||
</section>
|
||||
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
@page
|
||||
@{
|
||||
ViewData["page-support"] = "Functions \\ REG";
|
||||
}
|
||||
<h5>REG</h5>
|
||||
@*<div class="notification is-danger is-light">
|
||||
Documentation under construction.
|
||||
</div>*@
|
||||
<p>Registary functions</p>
|
||||
<br>
|
||||
<section class="my-5">
|
||||
<h5>Registry hive enum</h5>
|
||||
<p>Syntax</p>
|
||||
<pre><code>reg.cr // HKEY_CLASSES_ROOT
|
||||
reg.cu // HKEY_CURRENT_USER
|
||||
reg.lm // HKEY_LOCAL_MACHINE
|
||||
reg.u // HKEY_USERS
|
||||
reg.cc // HKEY_CURRENT_CONFIG</code></pre>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>Registry value kind Enum</h5>
|
||||
<p>Syntax</p>
|
||||
<pre><code>reg.none // No data type
|
||||
reg.sz // REG_SZ
|
||||
reg.expand // REG_EXPAND_SZ
|
||||
reg.binary // REG_BINARY
|
||||
reg.multi // REG_MULTI_SZ
|
||||
reg.dword // REG_DWORD
|
||||
reg.qword // REG_QWORD</code></pre>
|
||||
</section>
|
||||
|
||||
<section class="my-5">
|
||||
<h5>The function of reading from the Registry.</h5>
|
||||
<p>Syntax</p>
|
||||
<code>reg(reg.lm, 'SOFTWARE\Microsoft\Windows NT\CurrentVersion','ProductName')</code><br><br>
|
||||
<code>reg(reg.cr, 'txtfile\DefaultIcon')</code>
|
||||
</section>
|
||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -1,113 +0,0 @@
|
||||
@page
|
||||
@{
|
||||
ViewData["page-support"] = "Functions \\ SYS";
|
||||
}
|
||||
<h5>SYS (SYSTEM)</h5>
|
||||
<section class="my-5">
|
||||
<h5>sys.name</h5>
|
||||
<p>Returns Windows name.</p>
|
||||
<p>Syntax</p>
|
||||
<code>sys.name</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>sys.name</h5>
|
||||
<p>Returns Windows name.</p>
|
||||
<p>Syntax</p>
|
||||
<code>sys.name</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>sys.type</h5>
|
||||
<p>Returns system architecture.</p>
|
||||
<p>Syntax</p>
|
||||
<code>sys.type</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>sys.type</h5>
|
||||
<p>Returns system architecture.</p>
|
||||
<p>Syntax</p>
|
||||
<code>sys.type == 64</code><br>
|
||||
<code>sys.type == 32</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>sys.is64</h5>
|
||||
<p>Returns if system architecture is x64.</p>
|
||||
<p>Syntax</p>
|
||||
<code>sys.is64</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>sys.dark</h5>
|
||||
<p>Check if dark mode is enabled.</p>
|
||||
<p>Syntax</p>
|
||||
<code>sys.dark</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>sys.var</h5>
|
||||
<p>Retrieves the value of an environment variable.</p>
|
||||
<p>Syntax</p>
|
||||
<code>sys.var('WINDIR')</code>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>sys.version (sys.ver)</h5>
|
||||
<p>Windows version.</p>
|
||||
<p>Syntax</p>
|
||||
<pre><code>sys.version
|
||||
sys.version.build
|
||||
sys.version.major
|
||||
sys.version.minor
|
||||
sys.version.name
|
||||
sys.version.type</code></pre>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>sys.datetime</h5>
|
||||
<p>Date and time format</p>
|
||||
<p>Syntax</p>
|
||||
<pre><code>sys.datetime
|
||||
sys.datetime.date
|
||||
sys.datetime.date_day
|
||||
sys.datetime.date_dayofweek
|
||||
sys.datetime.date_month
|
||||
sys.datetime.date_y
|
||||
sys.datetime.date_year
|
||||
sys.datetime.date_yy
|
||||
sys.datetime.short
|
||||
sys.datetime.time
|
||||
sys.datetime.time_hour
|
||||
sys.datetime.time_milliseconds
|
||||
sys.datetime.time_min
|
||||
sys.datetime.time_minute
|
||||
sys.datetime.time_ms
|
||||
sys.datetime.time_pm
|
||||
sys.datetime.time_second</code></pre>
|
||||
</section>
|
||||
<section class="my-5">
|
||||
<h5>Windows paths</h5>
|
||||
<pre><code>sys.appdata
|
||||
sys.bin
|
||||
sys.bin32
|
||||
sys.bin64
|
||||
sys.directory (sys.dir)
|
||||
sys.path
|
||||
sys.prog
|
||||
sys.prog32
|
||||
sys.programdata
|
||||
sys.random
|
||||
sys.refresh
|
||||
sys.root
|
||||
sys.temp
|
||||
sys.templates
|
||||
sys.users
|
||||
sys.wow</code></pre>
|
||||
</section>
|
||||
|
||||
<section class="my-5">
|
||||
<h5>sys.beep(milliseconds)</h5>
|
||||
<p>Suspends the execution of the current thread until the time-out interval elapses.</p>
|
||||
<p>Syntax</p>
|
||||
<code>sys.sleep(1000)</code>
|
||||
</section>
|
||||
|
||||
<pre><code>@*sys.copy
|
||||
sys.extended*@
|
||||
sys.toggleext
|
||||
sys.togglehidden
|
||||
</code></pre>
|
||||
@@ -1,40 +0,0 @@
|
||||
@page
|
||||
@{
|
||||
ViewData["page-support"] = "Functions \\ USER";
|
||||
}
|
||||
<h5>USER</h5>
|
||||
<br>
|
||||
<section class="my-5">
|
||||
<h5>user.name</h5>
|
||||
<p>Returns the current username.</p>
|
||||
<p>Syntax</p>
|
||||
<code>user.name</code>
|
||||
</section>
|
||||
|
||||
<section class="my-5">
|
||||
<h5>Functions to return the path of user directories</h5>
|
||||
<p>Syntax</p>
|
||||
<pre><code>user.home
|
||||
user.appdata
|
||||
user.contacts
|
||||
user.desktop
|
||||
user.directory (user.dir)
|
||||
user.documents
|
||||
user.documentslibrary
|
||||
user.downloads
|
||||
user.favorites
|
||||
user.libraries
|
||||
user.localappdata
|
||||
user.music
|
||||
user.personal
|
||||
user.pictures
|
||||
user.profile
|
||||
user.quicklaunch
|
||||
user.sendto
|
||||
user.startmenu
|
||||
user.temp
|
||||
user.templates
|
||||
user.videos</code>
|
||||
</pre>
|
||||
</section>
|
||||
|
||||
Reference in new issue
Block a user