Welcome
WinProgress
1.4.0.0
WinProgress is an action plugin that with this you can create a system progress object.
Zloy_Gelud, tavria2
http://forum.ru-board.com
WinApi Action Plugin Ver: 2.1.0.0
WinProgress.Create
WinProgress.GetWndHandle
WinProgress.GetCurrentPos
WinProgress.SetCurrentPos
WinProgress.GetRange
WinProgress.SetRange
WinProgress.SetStep
WinProgress.StepIt
WinProgress.GetPos
WinProgress.SetPos
WinProgress.IsVisible
WinProgress.GetSize
WinProgress.SetSize
WinProgress.SetVisible
WinProgress.SetColors
WinProgress.Create ( | (string) ObjectName, (boolean) SmoothStyle = true, (number) Orientation = ORIENT_HORIZONTAL ) |
Function creates a system progress object using as the container Input object.
(string) The name of the input object.
(boolean) Use a solid bar to represent the progress.
(number) The orientation of the progress bar.
CONSTANT | VALUE | DESCRIPTION |
ORIENT_HORIZONTAL | 0 | Orient the progress bar horizontally. The progress meter will move from left to right. |
ORIENT_VERTICAL | 1 | Orient the progress bar vertically. The progress meter will move from the bottom to the top. |
This action dose not return any value.
(number) WinProgress.GetWndHandle ( | (string) ObjectName ) |
Returns the numeric window handle of the system progress object.
(string) The name of the input object.
(number) The numeric window handle of the system progress object. If an error occurs -1 is returned.
(number) WinProgress.GetCurrentPos ( | (string) ObjectName ) |
Gets the current position of the progress within the progress bar.
(string) The name of the input object.
(number) The current position of the progress meter within the progress bar. If an error occurs -1 is returned.
WinProgress.SetCurrentPos ( | (string) ObjectName, (number) Pos ) |
Sets the position of the progress within the progress bar.
(string) The name of the input object.
(number) The position to set.
This action dose not return any value.
(table) WinProgress.GetRange ( | (string) ObjectName ) |
Returns the range of the progress bar in a table.
(string) The name of the input object.
(table) A table containing the range of the progress bar, indexed by values "Begin" and "End". These values can be accessed using the form mytable.Begin and mytable.End. If an error occurs, nil is returned.
WinProgress.SetRange ( | (string) ObjectName, (number) Begin, (number) End ) |
Sets the range of the progress bar.
(string) The name of the input object.
(number) The beginning of the range.
(number) The ending of the range.
This action dose not return any value.
WinProgress.SetStep ( | (string) ObjectName, (number) Step ) |
Sets the step value that will be used when WinProgress.StepIt() is called.
(string) The name of the input object.
(number) The step value to use.
This action dose not return any value.
WinProgress.StepIt ( | (string) ObjectName ) |
Increments the current progress by the step amount specified in the WinProgress.SetStep() action.
(string) The name of the input object.
This action dose not return any value.
(table) WinProgress.GetPos ( | (string) ObjectName ) |
Returns the X and Y page coordinates of a system progress object in pixels.
(string) The name of the input object.
(table) A table containing the object's current coordinates, indexed by values X and Y. If the object cannot be found, nil will be returned.
WinProgress.SetPos ( | (string) ObjectName, (number) X, (number) Y ) |
Sets the X and Y pixel coordinates of a system progress object relative to the page.
(string) The name of the input object.
(number) The new X pixel coordinate (horizontal position) to set for the progress object. This is the X coordinate of the upper left hand corner of the object's bounding box relative to the page.
(number) The new Y pixel coordinate (vertical position) to set for the progress object. This is the Y coordinate of the upper left hand corner of the object's bounding box relative to the page.
This action dose not return any value.
(boolean) WinProgress.IsVisible ( | (string) ObjectName ) |
Returns true if a specific system progress object is visible, and false if it isn't.
(string) The name of the input object.
(boolean) True if the system progress object is visible, false if it's invisible. If an error occurs, false will be returned.
(table) WinProgress.GetSize ( | (string) ObjectName ) |
Returns the pixel dimensions of a system progress object.
(string) The name of the input object.
(table) A table containing the object's pixel dimensions, indexed by values "Width" and "Height". If the object cannot be found, nil will be returned.
WinProgress.SetSize ( | (string) ObjectName, (number) Width, (number) Height ) |
Sets the size of a system progress object.
(string) The name of the input object.
(number) The new width of the system progress object.
(number) The new width of the system progress object.
This action dose not return any value.
WinProgress.SetVisible ( | (string) ObjectName, (boolean) Visible = true ) |
Sets the visibility of a system progress object.
(string) The name of the input object.
(boolean) Whether to make the system progress object visible or invisible.
This action dose not return any value.
WinProgress.SetColors ( | (string) ObjectName, (number) BackgroundColor, (number) BarColor ) |
Function sets the color of the background and the color of the progress portion of the progress bar to the specified color value.
Note: Use this action only with a solid bar (i.e. SmoothStyle = true).
(string) The name of the input object.
(number) The color of the background of the progress bar.
(number) The color of the progress portion of the progress bar.
This action dose not return any value.
This File Was Generated With AMS ActionFile Editor