MediaMonkey Wiki - User contributions [en]

SDBProgress

2008-09-28T19:51:53Z

Mk88: added description and changed main object description

{{AutomationObjectsList}}
== CoClass SDBProgress ==

Object represents one instance of progress bar in main MediaMonkey window. New instance is acquired by calling [[ISDBApplication::Progress|SDB.Progress()]] method.

=== ISDBProgress members ===

{{MethodsList
|[[ISDBProgress::Increase|Increase]] |Method | Increases value of progress bar by one.
|[[ISDBProgress::MaxValue|MaxValue]] |Property Get/Let | Contains maximum value of the progress bar.
|[[ISDBProgress::Terminate|Terminate]] |Property Get | Returns true when script processing should terminate.
|[[ISDBProgress::Text|Text]] |Property Get/Let | Contains text shown on the progress bar.
|[[ISDBProgress::Value|Value]] |Property Get/Let | Contains current value of the progress bar.
}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBProgress|{{PAGENAME}}]]

ISDBProgress::Terminate

2008-09-28T19:50:48Z

Mk88: text formatting ("true")

{{MethodDeclaration|SDBProgress|ISDBProgress|Property Get Terminate As Boolean}}

===Property description===

Returns <tt>TRUE</tt> when script processing should terminate (e.g. the thread of this script was terminated by user). The script code should periodacally check this property (mainly in loops) and terminate its processing as soon as possible in case the property value is <tt>TRUE</tt>.

===Example code===
<source lang="vb">
for i=0 to list.count-1
' ... some code here

if Progress.Terminate then
Exit For
end if
next
</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBProgress|{{PAGENAME}}]]
[[Category:Interface ISDBProgress|{{PAGENAME}}]]

ISDBApplication::Progress

2008-09-28T19:42:31Z

Mk88:

{{MethodDeclaration|SDBApplication|ISDBApplication|Property Get Progress As [[SDBProgress#ISDBProgress objects|ISDBProgress]]}}

===Property description===

Returns [[SDBProgress]] object. It is also initialized and shown this way. In order to further modify the progress bar, see [[SDBProgress]] properties.

===Example code===
<source lang="vb">Dim Progress
Set Progress = SDB.Progress
Progress.Text = SDB.Localize("Exporting...")
Progress.MaxValue = list.count

for i=0 to list.count-1
'... some code here
Progress.Value = i+1
next</source>

===Example: Persistent progress bar===
Progress bar is shown when is instantied by the script, and is removed from window when no reference to its instance remains in memory.
However, we can keep one reference to the bar inside [[ISDBApplication::Objects|SDB.Objects]] storage. This prevents the progress bar from being destroyed by garbage collector and thus it remains visible.
<source lang="javascript">
// Example code in JavaScript:
function create_persistent_bar() {
var bar = SDB.Progress;
bar.Text = 'This progress bar remains visible.';
SDB.Objects('MyProgressBar') = bar; // keep one reference to the progress bar in the global storage
}
</source>

'''Removing persistent progress bar'''<br />
Progress bar is removed after no variables are pointing to the object. So overwriting the reference to the progress bar inside [[ISDBApplication::Objects|SDB.Objects]] with <tt>null</tt>/<tt>Nothing</tt> causes the progress bar dissapear. However, scripting engine does perform garbage collection only from time to time, so we need to call garbage collector explicitly or wait few seconds till progress bar disappears.
<source lang="javascript">
// Example code in JavaScript:
function remove_persistent_bar() {
SDB.Objects('MyProgressBar') = null; // Unset the reference to progress bar instance.
CollectGarbage(); // This undocumented JScript function runs GC instantly and removes the progress bar.
}
</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBApplication|{{PAGENAME}}]]
[[Category:Interface ISDBApplication|{{PAGENAME}}]]

ISDBApplicationEvents::OnTrackProperties

2008-07-05T21:27:54Z

Mk88: event called after data saved to db

{{MethodDeclaration|SDBApplication|ISDBApplicationEvents|Sub OnTrackProperties(TrackList As [[SDBSongList]])}}

===Parameters===

{{MethodParameters
|TrackList |[[SDBSongList]] |A list of tracks that were modified.}}

===Event description===

Is called whenever track(s) metadata were modified. This happens a lot, so use this event wisely. [[ISDBScriptControl::UnRegisterEvents|Unregister]] the event when your script doesn't need to handle it anymore.
<br />Event is called '''after''' data were saved to the database.

'''Note:''' If you modify track(s) metadata within the event handler, the event handler will be called again. Be sure to prevent the event handler from executing, otherwise this would cause an infinite loop. See the example below.

===Example code===
<source lang="vb">Script.RegisterEvent SDB, "OnTrackProperties", "SDB_OnTrackProperties"

Dim InEventHandler : InEventHandler = False ' Control variable (shows if event handler is executing)

Sub SDB_OnTrackProperties(TrackList)
If InEventHandler Then Exit Sub ' Prevent executing event handler from within itself

InEventHandler = True ' Event starts --> set control variable

' make some changes to tracks in TrackList

TrackList.UpdateAll ' By applying the changes, the event handler will we called
InEventHandler = False ' Event finished --> clear control variable
End Sub</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBApplication|{{PAGENAME}}]]
[[Category:Interface ISDBApplicationEvents|{{PAGENAME}}]]