MediaMonkey Wiki - User contributions [en]

User:Michal.kocarek

2014-11-25T23:21:25Z

Michal.kocarek: Created page with "Find me at [http://brainbox.cz/?utm_source=mediamonkey&utm_medium=web&utm_campaign=mediamonkey-wiki brainbox.cz] or here at [http://www.mediamonkey.com/forum/memberlist.php?mode=..."

Find me at [http://brainbox.cz/?utm_source=mediamonkey&utm_medium=web&utm_campaign=mediamonkey-wiki brainbox.cz] or here at [http://www.mediamonkey.com/forum/memberlist.php?mode=viewprofile&u=63584 forum].

I developed few MediaMonkey plugins in JScript, because I don't like VBScript. Had overcome biggest issues so if you need help, feel free to ask me.

Introduction to scripting

2014-11-25T23:16:00Z

Michal.kocarek: /* Considerations */ x-link

MediaMonkey can be customized through the use of custom scripts. Scripts are relatively simple computer programs written in a scripting language, such as VBScript. Unlike most computer programs, these scripts do not have to be compiled, which allows them to be tested and modified more easily than with more advanced languages. Still, writing MediaMonkey scripts can be a challenging experience so potential script writers should consider alternatives, particularly if they have little previous experience writing scripts.

== Considerations ==

Before writing their own scripts, users of MediaMonkey may wish to consider the following issues:
*In addition to supporting scripting, MediaMonkey has a [[Plug-ins|plug-in]] interface that allows a large number of Winamp and MediaMonkey plug-ins to be used. There may be no need to write a script if the desired features are already provided by a plug-in.
*Some users of MediaMonkey are willing to share the scripts that they have written with other users. An existing script may already provide the desired features or be relatively easily modified so that it does. The best place to find such scripts or to get support for them is the [http://www.mediamonkey.com/forum/viewforum.php?f=2 Scripts and Components forum].
*Although, in theory, MediaMonkey supports both of the [http://en.wikipedia.org/wiki/VBScript VBScript] (*.vbs) and [http://en.wikipedia.org/wiki/JScript JScript] (*.js) scripting languages, the implementation for JScript is only partial (see [[Scripting Tips & Tricks#JScript|Scripting Tips & Tricks]] for some issues), so for some applications VBScript is required. Programmers not wishing to deal with VBScript may wish to create an [[#About external scripts and applications |external]] script or application using their preferred language and use a script written in VBScript (or JScript) to launch it.
*Other than tags embedded in media files, virtually all of MediaMonkey’s data is stored in a [http://www.sqlite.org SQLite] database from MediaMonkey version 3.0. It is possible to manipulate MediaMonkey’s data, while minimizing the use of MediaMonkey’s API, by using [http://en.wikipedia.org/wiki/SQL SQL]. MediaMonkey's API can be (almost, except string [[MediaMonkey_Database_structure#Additions_to_SQLite|collations]]) completely bypassed by using an interface provided by the underlying engine to access the database. (MediaMonkey 2.x used [http://en.wikipedia.org/wiki/Microsoft_Jet_Database_Engine Microsoft Jet] relational database. It could accessed through Jet or ODBC, or even opened directly by Microsoft Access, for example.)

== Types of scripts ==

There are three major types of scripts that can be launched internally by MediaMonkey:
*'''Normal scripts''' are located in the ''Scripts'' folder and are executed according to the script's entry in the [[#Format of the Scripts.ini file|''Scripts\Scripts.ini'' file]].
*'''Auto-scripts''' are located in the ''Scripts\Auto'' folder and its OnStartup method is executed when MediaMonkey starts. If more than one script exists in the Auto folder the scripts are run in alphabetical order.
*'''Other scripts''', such as [[Search scripts]] and [[Auto-DJ scripts]] are intended for specific types of customization, but are also defined in the [[#Format of the Scripts.ini file|''Scripts\Scripts.ini'' file]].

In addition to the scripts that are launched by MediaMonkey (internal scripts), you can also work with MediaMonkey by using [[#About external scripts and applications|''external'' scripts and applications]].

== How to create a normal script ==

<ol>
<li>Create a plain text file in the ''Scripts'' folder, e.g. ''MyNormalScript.vbs''.</li>
<li>Write your VBScript script and make sure you have a procedure that can be called, e.g.
<source lang="vb">Sub CallMe

' This script will pop up a simple message box when the procedure CallMe is called.
MsgBox "CallMe was called by the action defined in the Scripts.ini file."

End Sub</source></li>
<li>Create a new entry for your script's ''CallMe'' procedure in the [[#Format of the Scripts.ini file|''Scripts.ini'' file]].</li>
</ol>

From within a MediaMonkey script, a reference to the SDB object (an instance of the [[SDBApplication]] class) is always present. By accessing its properties and methods, you can interact with many aspects of MediaMonkey. Check out the [[MediaMonkey Automation objects]] page for other MediaMonkey objects that can be created starting from the SDB object.
Another available object reference is the Script object (an instance of the [[SDBScriptControl]] class), that contains methods to control the running script's environment, usually to [[ISDBScriptControl::RegisterEvent|attach]] to events of MediaMonkey and its player and controls (see examples [[Sample Event Handlers script|1]] and [[Sample Events for User Interface script|2]]).

The script ''Scripts\MediaMonkey init.vbs'' is always executed just before any other script. It contains some constants that can be used in your own script.

A good and quite complex example is ''Scripts\Export.vbs'' (distributed with MediaMonkey) which contains code that takes care of all export features of MediaMonkey. For more examples, check out the [[Sample scripts|sample scripts page]] or, if you are already up to it, take a look at the code of some actively developed [http://www.mediamonkey.com/forum/viewforum.php?f=2 scripts on the forum] (most of them are distributed in [[Installation_Packages#Installation_Packages_structure|MM installation packages]]).

More information about scripting in general can be found at [http://msdn2.microsoft.com/en-us/library/ms950396.aspx Microsoft Scripting] (with official VBScript and JScript documentation).

== How to create an auto-script ==

<ol>
<li>Create a plain text file in the ''Scripts\Auto'' folder, e.g. ''MyAutoScript.vbs''.</li>
<li>Write your VBScript script and use the procedure ''OnStartup'' as start point for execution, e.g.
<source lang="vb">
Sub OnStartup

' This script will pop up a simple "Hello World!" message box when you start MediaMonkey.
MsgBox "Hello World!"

End Sub
</source></li>
</ol>

All VBScript, but not JScript, scripts in the ''Scripts\Auto'' folder are automatically checked during MM start-up, and the '''OnStartup''' procedure (if present) is called. Auto-scripts make it possible to add user interface enhancements such as new menu or toolbar items, new option sheets, etc.

Except that these scripts are automatically executed when MediaMonkey starts, they behave identical as the normal scripts. They also get a reference to the SDB object, and the constants defined in ''Scripts\MediaMonkey init.vbs'' are always usable.

You can choose to dynamically add an entry to the Scripts.ini from your code, so your script can be accessed from the Tools > Scripts submenu just like normal scripts. However, most auto-scripts add UI items (e.g. menu items) directly to the MediaMonkey user interface to be more tightly integrated.

== Format of the ''Scripts.ini'' file ==

<div style="float: right; margin-left: 1em; margin-bottom: 0.5em; clear: right; background-color:#F9F9F9; border:1px solid #CCCCCC; font-size:95%; padding:5px;">
<source lang="ini">
[AutoIncTrackN]
FileName=AutoIncTrackN.vbs
ProcName=AutoIncTrackNumbers
Order=1
DisplayName=Auto-&increment Track #s...
Description=Sequentially numbers Tracks
Language=VBScript
ScriptType=0
</source>
<div style="position: relative; top: -6px; left: 5px">Sample ''Scripts.ini'' entry</div>
</div>

This ''Scripts\Scripts.ini'' file is a standard .ini file where each section defines a procedure in a script. The section starts with a section identifier [SectionName], where ‘SectionName’ is a unique name of the script entry.
These are the entry's properties:
; Filename
: Path of a script file where the procedure is located, relative to the ''Scripts'' folder, e.g. ‘MyScripts.vbs’.
; ProcName
: Name of an existing procedure to be called when the script (specifiedby ‘Filename’) is executed in MM.
; ScriptType
: Defines type of the script:
:* 0 = A ''standard script'' that appears in the <code>Tools > Scripts</code> submenu.
:* 1 = An ''export script'' that can be found in the <code>File > Create Reports</code> submenu.
:* 2 = A ''track-start script'' that is activated whenever a new track is started. This script doesn’t appear in any menu, it’s simply called in the background. When this procedure is executed, a variable 'CurrentTrack' (object of the [[SDBSongData]] class) is defined, and you can use it to get information about the started track. This script type is obsolete, rather register OnPlay event. Also note, that this is the only case, when multiple instances of one script can be executed by MediaMonkey, otherwise only one instance is always executed.
:* 3 = A ''search script'' that allows custom searches to be programmed in the "Auto-tag from Web" dialog. See [[Search scripts]] for more information about this more complex script type.
:* 4 = An ''Auto-DJ script'' that can handle content added by Auto-DJ. See [[Auto-DJ scripts]] for more details.
; Order
: Defines the order of the script in its section. These numbers are sorted and scripts are listed according to the order.
; DisplayName
: The script is listed as menu item with this name.
; Description
: Message shown as tooltip when the mouse is moved over the menu item.
; Language
: The script language of the referenced script. Usually <tt>VBScript</tt>, but can be <tt>JScript</tt> too (although this is not recommended).
; Shortcut
: Specifies a shortcut that invokes the script in MM. You can use any of the strings ‘Shift+’, ‘Ctrl+’ or ‘Alt+’, singly or combined, followed a single letter or number, or the name of a special key - BkSp, Tab, Enter, Esc, Space, PgUp, PgDn, End, Home, Left, Up, Right, Down, Ins, Del.

== About external scripts and applications ==

(see also [[Scripting_Tips_&_Tricks#Interaction_with_MediaMonkey_from_outside|Interaction with MediaMonkey from outside]])

Besides supporting al large part of the Winamp [http://wiki.winamp.com/wiki/Plug-in_Developer plug-in model] and messages ([http://wiki.winamp.com/wiki/SendMessage_API 1],[http://forums.winamp.com/showthread.php?threadid=180297 2]), MediaMonkey exposes an API via the Microsoft COM model. This allows external applications to access and control MediaMonkey directly. These applications can be written in any language that can access COM objects. VBScript can be used to produce external scripts, but regular Visual Basic (or any COM-aware language) can be used as well, producing a full-fledged application.

In order to work with MediaMonkey’s objects from an external script or application, you need to create a reference to the SDB object (an instance of the [[SDBApplication]] class) yourself. For .NET-based applications, you must also add a reference to MediaMonkey's COM object "MediaMonkey Library" to your Visual Studio project, so that the compiler can find MediaMonkey and the SongsDB namespace.

If MediaMonkey is already running, creating a SDBApplication object instance will return a reference to the running instance. If MediaMonkey is not running yet, it will be started and a reference will be returned. In addition, if MediaMonkey was was not running before, it will normally shut down automatically when the external script/application exits. This can be prevented (so MediaMonkey will remain running) by setting SDB's [[ISDBApplication::ShutdownAfterDisconnect|ShutdownAfterDisconnect]] property to False.

'''Visual Basic / VBScript sample:'''
<source lang="vb">
Dim SDB : Set SDB = CreateObject("SongsDB.SDBApplication")

SDB.ShutdownAfterDisconnect = False ' in case you want to keep an opened instance open after disconnecting the SDB object
</source>
'''C# sample:'''
<source lang="csharp">
SongsDB.SDBApplication SDB = new SongsDB.SDBApplication();

SDB.ShutdownAfterDisconnect = false; // in case you want to keep an opened instance open after disconnecting the SDB object
</source>

'''C++/CLI sample:'''
<source lang="cpp">
SongsDB::SDBApplication^ SDB = gcnew SongsDB::SDBApplication();

SDB->ShutdownAfterDisconnect = false; // in case you want to keep an opened instance open after disconnecting the SDB object
</source>

'''Delphi sample:'''
<source lang="delphi">
var
SDB : Variant;
begin
SDB := CreateObject('SongsDB.SDBApplication');
SDB.ShutdownAfterDisconnect := false; // in case you want to keep an opened instance open after disconnecting the SDB object
</source>

'''PHP sample:''' (shows initialization only)
<source lang="php">
$objSDB = new COM('SongsDB.SDBApplication') or die('Cannot create MediaMonkey SDB Object');
</source>

'''Python (with PyWin32) sample:'''
<source lang="python">
try:
import win32com.client
except:
print "Install PyWin32"
# Open connection to COM object
try:
SDB = win32com.client.Dispatch("SongsDB.SDBApplication")
except:
print "Is MediaMonkey up and running?"

SDB.ShutdownAfterDisconnect = False
</source>

'''Perl sample:''' (shows initialization only)
<source lang="perl">
use Win32::OLE;
my $SDB = Win32::OLE->GetActiveObject('SongsDB.SDBApplication') || Win32::OLE->new('SongsDB.SDBApplication', '');
$SDB->ShutdownAfterDisconnect(true);
</source>

Developers that require MediaMonkey type library information (e.g. for C++/Delphi, as newer languages usually don't need this) can extract this from the MediaMonkey.exe file ([http://msdn.microsoft.com/en-us/library/ms680581(v=vs.85).aspx more information]), or can use #import on the Exe file as explained in [http://msdn.microsoft.com/en-us/library/8etzzkb6(v=vs.71).aspx this MSDN page].

== Further reading ==
* [[Scripting|Scripting main page]]
* [[.NET|.NET Tips page]]
* [http://www.mediamonkey.com/sw/MediaMonkey.idl MediaMonkey Interface Definition Language (IDL) file]

Scripting Tips & Tricks (MM4)

2014-11-25T23:15:47Z

Michal.kocarek: /* Passing arrays to MediaMonkey */

==(MediaMonkey) Scripting in general==

=== 'Correctly' update song properties ===
Using the SongData object, you can either update the database/library (UpdateDB) and/or update the file's tags (WriteTags). So there's no way to let the song changes be saved like the user selected in the Options panel (menu Tools > Options > Library > Tags & Playlists > "Update tags when editing properties").
However, the UpdateAll method for the SongList object ''does'' take into account this user-specified option. So you can create a new SongList object using SDB.NewSongList and add your SDBSongData object(s) to it. Then call the UpdateAll method on the songlist, and your song(s) will be saved in user-specified way.

=== See MM debug log via DebugView ===
You can download [http://technet.microsoft.com/en-us/sysinternals/bb896647.aspx DebugView] directly from Microsoft. If used with the debug version of MM, lots of useful messages will be displayed in DebugView. Also, any message set via [[ISDBTools::OutputDebugStringMM]] (e.g. using '''SDB.Tools.OutputDebugString("Test1")''') will also be added to that debug log.

=== See MM Scripting interface using OLEView ===
MS Visual Studio contains a tool called [http://www.microsoft.com/downloads/details.aspx?familyid=5233B70D-D9B2-4CB5-AEB6-45664BE858B6&displaylang=en OLEView] ("OLE Viewer" or "OLE/COM Object Viewer") ([http://download.microsoft.com/download/win2000platform/oleview/1.00.0.1/nt5/en-us/oleview_setup.exe direct link]), which can show the type library of the SongsDB object "MediaMonkey Library". It requires the Iviewers.dll, which is not included, but can be downloaded from [http://www.dlldll.com/downdll/2757.html here] or other 3rd-party locations. There, you can see all supported properties and methods of the MediaMonkey scripting interface. This can be handy to find out new scripting methods in case that the scripting reference isn't up-to-date yet.
<br>The way to get there: ''OleView'' > Type Libraries > MediaMonkey Library > (double click)
<br>and then in the ''ITypeLib Viewer'' > SongsDB (MediaMonkey Library) > Interfaces.

=== Detecting docking of a panel ===
When you un(dock) a dockable panel, the OnResize event is triggered twice:
*Once while the panel is being (un)docked with DockedTo = 0
*Once after the panel has been (undocked): with DockedTo = -1 (panel undocked) or DockedTo = X (panel docked, X is the number that represents the docking position)

=== Keep reference to Form/Panel ===
When you create a form or panel, always add a reference to the SDB.Objects dictionary. If you don't add it, the form/panel will be gone immediately after you created it, with or without error message. Instead of using the SDB.Objects dictionary you can also store a reference as a global script variable, in most cases.

=== Event mechanisms ===
There are still 2 event mechanisms available:
*Using the (mostly deprecated) ''old event mechanism'' (using ''Control''.OnClickFunc and ''Control''.UseScript), your global variables aren't remembered in the event handlers (e.g. kind of like the script is reopened). For those scripts, you had to use ''ParentControl''.ChildControl("control name") or save object references to SDB's ''Objects'' dictionary.
*Using the ''new event mechanism'', your global variables ''are'' remembered so you can use their values in the event handlers. The Objects dictionary is now only necessary to communicate/store object references between different scripts.
So always use the new event mechanism where you can. Only for option panels (sheets) this is not yet possible. There you'll need to store values between the main program and the event handlers in SDB.Objects, in the INI or in the Registry.

=== Internal mechanism of script loading ===

Normally, you don't need to know much about internal handling of scripts by MediaMonkey, but sometimes it might be useful to know, when exactly scripts are loaded.

When some function of a script is about to be executed (e.g. OnStartup function of auto-scripts), the script is loaded to memory and executed as necessary. When the execution finishes, the script is again unloaded from memory. However, there is on exception - if you register some event (by calling RegisterEvent function), the script remains still loaded in memory, until all registered events are unregistered, then it's unloaded.

This is good to know when you plan some sharing of variables. While the script is loaded in memory, you can use its global variables, but if you need to persist some values or objects between script sessions, you have to use some other mechanism (ini files, Objects collection, ...).

Note that starting from MediaMonkey 3.1.0.1205, there is always at most one instance of script loaded in memory. In older versions, if a script registered some events and then e.g. Option sheet functions were called back by MediaMonkey, they were processed in another instance of the script. Now they are processed in the already loaded instance, which helps avoid some memory leaks, is easier to handle and is also faster to process.

=== Changing the current tree node ===
Changing the selected node from a script (using SDB.MainTree.CurrentNode = ...........) takes some time to happen, and it happens asynchronicly (the code execution doesn't wait until the node is really selected). For that reason, you can't use (get value of) SDB.MainTree.CurrentNode directly after you have assigned a new node to it (set value to), because changes won't have happened yet.

=== Interaction with MediaMonkey from outside ===
There are at least three ways to interact with MediaMonkey from an external program:
*Open the MediaMonkey.exe program with command line options (arguments).
*Using the same Windows Messages (SendMessage/PostMessage) as in Winamp (WM_USER and WM_COMMAND). MM partially emulates how WinAmp works (not 100%, but very close) and so it can use WinAmp plug-ins. The class name to communicate with is "Winamp v1.x".
*Using OLE Automation, which can be very easily used e.g. from VB Script.
*:<source lang="vb">Dim SDB : Set SDB = CreateObject("SongsDB.SDBApplication")</source>
*:<source lang="csharp">SongsDB.SDBApplicationClass SDB = new SongsDB.SDBApplicationClass();</source>
*:Be sure to set ''SDB.ShutdownAfterDisconnect'' to ''False'' if you opened the MediaMonkey program by calling the SDB object, and you don't want it to be closed when your external program exits (or if you disconnect the SDB object = COM link).

=== Making scripts ready for per-user installations ===
Starting from MediaMonkey 4.0, scripts can be (and are suggested to be) installed per-user, and so they don't have to be installed in Program Files folder, but are installed in local Windows folders. The mechanism in MM is internally made as transparent as possible, so that scripts don't have to care much about their installed location. That said, some pre-4.0 scripts might need tweaking. For example, a popular script Lyricator has >1000 lines, but there's only one change needed in order to get it working under local installation, namely:
<source lang="vb">Dim sAppPath: sAppPath = sdb.ApplicationPath & "Scripts\Lyricator\"</source>
needs to be changed to
<source lang="vb">Dim sAppPath: sAppPath = sdb.ScriptsPath & "Lyricator\"</source>

==Visual Basic Script==

=== Index in VBScript ===

Usually indexes start from '''0''' (e.g. for normal arrays). However, sometimes (e.g. for string positions or for [[ISDBCommonDialog::FilterIndex]]) they start from '''1'''.

=== Code readability ===

To maintain good readability of your scripting code, make sure to add comments where necessary, split large methods in smaller ones, use appropriate indentation (tabs or 2/3/4 spaces), and if necessary split long lines of code over several lines. To split a line of VBScript code (not text or numbers), add a ''space'' and an ''underscore'', and continue on the next line. Don't forget the space before the underscore or it won't work.
<source lang="vb">
MsgBox "This is quite a long text to display on one single line and for readability we better split it on multiple lines"

MsgBox "This is quite a long text to display on one single line" & " and for readability we better split it on multiple lines"

MsgBox "This is quite a long text to display on one single line" _
& " and for readability we better split it on multiple lines"
</source>
In the third example the code is more readable, but the result is still the same: a message box with one long line of text. To split this over multiple lines, we preferably use the constant vbNewLine. If necessary, you can also use ''vbCr'' (Unix-style) or ''vbCrLf''(Windows-style). Using these constants is more clear than using respectively ''Chr(13)'' (Unix-style) or ''Chr(13) & Chr(10)'' (Windows-style).
<source lang="vb">
MsgBox "This is quite a long text to display on one single line" & vbNewLine _
& " and for readability we better split it on multiple lines"
</source>

=== Using Flags in VBScript ===

The concept of [[Flags]] can be a difficult for novice programmers. Click the link for an explanation of how to use them in VBScript (or Visual Basic).

=== Links ===

'''Helpful sites:'''
* [http://msdn2.microsoft.com/en-us/library/ms950396.aspx Reference for scripting resources]
* [http://www.microsoft.com/technet/scriptcenter/default.mspx Microsoft Script Center]
* [http://msdn2.microsoft.com/en-us/library/t0aew7h6.aspx VBScript User's Guide and Language Reference]
* [http://www.microsoft.com/technet/scriptcenter/scripts/default.mspx?mfr=true VBScript Script Repository]
* [http://www.w3schools.com/vbscript/default.asp W3Schools VBScript learning]
* [http://technet.microsoft.com/en-us/library/cc498722.aspx Microsoft TechNet scripting products and technologies]

'''VBScript editors:'''
* [http://www.vbsedit.com/ VBSEdit] (debugging, object and COM lookup, integrated help)
* [http://notepad-plus.sourceforge.net/ NotePad++]
* [http://www.pspad.com/ PSPad]
* [http://www.sapien.com/ Sapien PrimalScript]
* [http://www.microsoft.com/downloads/details.aspx?familyid=2f465be0-94fd-4569-b3c4-dffdf19ccd99&displaylang=en Microsoft Script Debugger for Windows NT 4.0 and Later ] (debugging)
* [http://www.editpadpro.com/ EditPad (Pro)]
* [http://www.e-texteditor.com/ E-TextEditor]

== JScript ==

=== Passing arrays to MediaMonkey methods ===

To the MediaMonkey COM methods accepting array as their argument you cannot simply pass native JScript array. You have to convert it to VBScript-compatible array (specifically <tt>VBSafeArray</tt>) first. (This applies yet in MM 4.1.) One example is the [[ISDBApplication::MessageBox]] method which accepts button constants as array in an argument.

You can use function from snippet below to JScript native array to the VBScript-compatible array.

<source lang="javascript">
/**
* Return VBSafeArray containing items from JScript array.
*/
function array_to_vbarray(array) {
var dict = new ActiveXObject('Scripting.Dictionary');
for (var i = 0, len = array.length; i < len; i++) {
dict.add(i, array[i]);
}
return dict.Items();
}
</source>

Then, when calling MediaMonkey methods, simply wrap the array argument with <tt>array_to_vbarray(…)</tt> call:

<source lang="javascript">
// Display message box
SDB.MessageBox("Simple message box from JScript with mtWarning icon and one mbOk button.", 0, array_to_vbarray([4]));
</source>

=== Adding object to SDB.Objects ===

Object stored in [[ISDBApplication::Objects|SDB.Objects]] can be retrieved by simple method call: <tt>SDB.Objects('MyObject')</tt>. But how to set the object at first?

JScript has special notation for this: <tt>SDB.Objects('MyObject') = my_object</tt>. This is not syntax error. You simply assign value to the reference returned by the method call. It works same way as in VBScript.

=== Working with dates ===

There are MediaMonkey COM properties of type Date (such as [[ISDBSongData::Date|Date]], [[ISDBSongData::DateAdded|DateAdded]], [[ISDBSongData::LastPlayed|LastPlayed]] in [[SDBSongData]]). When used in JScript, they require special treatment. (This applies yet in MM 4.1.)

'''Reading''': Properties are not converted to native JScript <tt>Date</tt> instance. You have to do it manually – cast them to string and then manually create the <tt>Date</tt> instance.

'''Setting''': You cannot set native JScript <tt>Date</tt> instance to the property. But you can set there a string in the ISO format <tt>YYYY-MM-DD HH:II:SS</tt> (eg. <tt>2012-12-31 01:02:03</tt>).

== Database & SQL ==

=== Database transactions ===

Starting from MM 3.0 transactions are often used when working with database. It can cause some problems to script authors in case they don't know some details. One example where you can face a problem is when you use [[ISDBSongData::UpdateDB]] method while you have some SQL query open. What happens in this case is, that MM wants to start a transaction, but there's still an SQL query open. This results either in an error message (in debug build) or possibly an apparent freeze of MM in the release build.

In order to prevent this problem, you can either:
* Put all these DB operations in an transaction, i.e. use [[ISDBDatabase::BeginTransaction]] and [[ISDBDatabase::Commit]].
* Close already running SQL queries before you call things like [[ISDBSongData::UpdateDB]].

=== Creating complex SQL queries ===
To easily create complex SQL queries, you can use the Query graphical user interface in Access interface, and show the SQL code when you are done. In any case, make sure that your SQL code is organized is such a way that it can be understood easily, e.g. by putting SELECT, INSERT, FROM, ORDER BY, ... on separate lines with appropriate indentation.

=== Avoid SQL date problems ===
One of the problems with SQL is that dates are often confused, which sometimes give programming bugs. The best way to circumvent this problem is by using the format #yyyy-mm-dd# for all dates in SQL (e.g. #2006-10-31# for 31th October 2006).

=== Links ===
'''Helpful sites:'''
*[http://www.w3schools.com/sql/default.asp W3Schools SQL learning]
*[http://www.1keydata.com/sql/sql.html 1Keydata SQL Tutorial]

Introduction to scripting

2014-11-25T23:11:52Z

Michal.kocarek: /* Format of the Scripts.ini file */ formatting

MediaMonkey can be customized through the use of custom scripts. Scripts are relatively simple computer programs written in a scripting language, such as VBScript. Unlike most computer programs, these scripts do not have to be compiled, which allows them to be tested and modified more easily than with more advanced languages. Still, writing MediaMonkey scripts can be a challenging experience so potential script writers should consider alternatives, particularly if they have little previous experience writing scripts.

== Considerations ==

Before writing their own scripts, users of MediaMonkey may wish to consider the following issues:
*In addition to supporting scripting, MediaMonkey has a [[Plug-ins|plug-in]] interface that allows a large number of Winamp and MediaMonkey plug-ins to be used. There may be no need to write a script if the desired features are already provided by a plug-in.
*Some users of MediaMonkey are willing to share the scripts that they have written with other users. An existing script may already provide the desired features or be relatively easily modified so that it does. The best place to find such scripts or to get support for them is the [http://www.mediamonkey.com/forum/viewforum.php?f=2 Scripts and Components forum].
*Although, in theory, MediaMonkey supports both of the [http://en.wikipedia.org/wiki/VBScript VBScript] (*.vbs) and [http://en.wikipedia.org/wiki/JScript JScript] (*.js) scripting languages, the implementation for JScript is only partial, so for some applications VBScript is required. Programmers not wishing to deal with VBScript may wish to create an [[#About external scripts and applications |external]] script or application using their preferred language and use a script written in VBScript (or JScript) to launch it.
*Other than tags embedded in media files, virtually all of MediaMonkey’s data is stored in a [http://www.sqlite.org SQLite] database from MediaMonkey version 3.0. It is possible to manipulate MediaMonkey’s data, while minimizing the use of MediaMonkey’s API, by using [http://en.wikipedia.org/wiki/SQL SQL]. MediaMonkey's API can be (almost, except string [[MediaMonkey_Database_structure#Additions_to_SQLite|collations]]) completely bypassed by using an interface provided by the underlying engine to access the database. (MediaMonkey 2.x used [http://en.wikipedia.org/wiki/Microsoft_Jet_Database_Engine Microsoft Jet] relational database. It could accessed through Jet or ODBC, or even opened directly by Microsoft Access, for example.)

== Types of scripts ==

There are three major types of scripts that can be launched internally by MediaMonkey:
*'''Normal scripts''' are located in the ''Scripts'' folder and are executed according to the script's entry in the [[#Format of the Scripts.ini file|''Scripts\Scripts.ini'' file]].
*'''Auto-scripts''' are located in the ''Scripts\Auto'' folder and its OnStartup method is executed when MediaMonkey starts. If more than one script exists in the Auto folder the scripts are run in alphabetical order.
*'''Other scripts''', such as [[Search scripts]] and [[Auto-DJ scripts]] are intended for specific types of customization, but are also defined in the [[#Format of the Scripts.ini file|''Scripts\Scripts.ini'' file]].

In addition to the scripts that are launched by MediaMonkey (internal scripts), you can also work with MediaMonkey by using [[#About external scripts and applications|''external'' scripts and applications]].

== How to create a normal script ==

<ol>
<li>Create a plain text file in the ''Scripts'' folder, e.g. ''MyNormalScript.vbs''.</li>
<li>Write your VBScript script and make sure you have a procedure that can be called, e.g.
<source lang="vb">Sub CallMe

' This script will pop up a simple message box when the procedure CallMe is called.
MsgBox "CallMe was called by the action defined in the Scripts.ini file."

End Sub</source></li>
<li>Create a new entry for your script's ''CallMe'' procedure in the [[#Format of the Scripts.ini file|''Scripts.ini'' file]].</li>
</ol>

From within a MediaMonkey script, a reference to the SDB object (an instance of the [[SDBApplication]] class) is always present. By accessing its properties and methods, you can interact with many aspects of MediaMonkey. Check out the [[MediaMonkey Automation objects]] page for other MediaMonkey objects that can be created starting from the SDB object.
Another available object reference is the Script object (an instance of the [[SDBScriptControl]] class), that contains methods to control the running script's environment, usually to [[ISDBScriptControl::RegisterEvent|attach]] to events of MediaMonkey and its player and controls (see examples [[Sample Event Handlers script|1]] and [[Sample Events for User Interface script|2]]).

The script ''Scripts\MediaMonkey init.vbs'' is always executed just before any other script. It contains some constants that can be used in your own script.

A good and quite complex example is ''Scripts\Export.vbs'' (distributed with MediaMonkey) which contains code that takes care of all export features of MediaMonkey. For more examples, check out the [[Sample scripts|sample scripts page]] or, if you are already up to it, take a look at the code of some actively developed [http://www.mediamonkey.com/forum/viewforum.php?f=2 scripts on the forum] (most of them are distributed in [[Installation_Packages#Installation_Packages_structure|MM installation packages]]).

More information about scripting in general can be found at [http://msdn2.microsoft.com/en-us/library/ms950396.aspx Microsoft Scripting] (with official VBScript and JScript documentation).

== How to create an auto-script ==

<ol>
<li>Create a plain text file in the ''Scripts\Auto'' folder, e.g. ''MyAutoScript.vbs''.</li>
<li>Write your VBScript script and use the procedure ''OnStartup'' as start point for execution, e.g.
<source lang="vb">
Sub OnStartup

' This script will pop up a simple "Hello World!" message box when you start MediaMonkey.
MsgBox "Hello World!"

End Sub
</source></li>
</ol>

All VBScript, but not JScript, scripts in the ''Scripts\Auto'' folder are automatically checked during MM start-up, and the '''OnStartup''' procedure (if present) is called. Auto-scripts make it possible to add user interface enhancements such as new menu or toolbar items, new option sheets, etc.

Except that these scripts are automatically executed when MediaMonkey starts, they behave identical as the normal scripts. They also get a reference to the SDB object, and the constants defined in ''Scripts\MediaMonkey init.vbs'' are always usable.

You can choose to dynamically add an entry to the Scripts.ini from your code, so your script can be accessed from the Tools > Scripts submenu just like normal scripts. However, most auto-scripts add UI items (e.g. menu items) directly to the MediaMonkey user interface to be more tightly integrated.

== Format of the ''Scripts.ini'' file ==

<div style="float: right; margin-left: 1em; margin-bottom: 0.5em; clear: right; background-color:#F9F9F9; border:1px solid #CCCCCC; font-size:95%; padding:5px;">
<source lang="ini">
[AutoIncTrackN]
FileName=AutoIncTrackN.vbs
ProcName=AutoIncTrackNumbers
Order=1
DisplayName=Auto-&increment Track #s...
Description=Sequentially numbers Tracks
Language=VBScript
ScriptType=0
</source>
<div style="position: relative; top: -6px; left: 5px">Sample ''Scripts.ini'' entry</div>
</div>

This ''Scripts\Scripts.ini'' file is a standard .ini file where each section defines a procedure in a script. The section starts with a section identifier [SectionName], where ‘SectionName’ is a unique name of the script entry.
These are the entry's properties:
; Filename
: Path of a script file where the procedure is located, relative to the ''Scripts'' folder, e.g. ‘MyScripts.vbs’.
; ProcName
: Name of an existing procedure to be called when the script (specifiedby ‘Filename’) is executed in MM.
; ScriptType
: Defines type of the script:
:* 0 = A ''standard script'' that appears in the <code>Tools > Scripts</code> submenu.
:* 1 = An ''export script'' that can be found in the <code>File > Create Reports</code> submenu.
:* 2 = A ''track-start script'' that is activated whenever a new track is started. This script doesn’t appear in any menu, it’s simply called in the background. When this procedure is executed, a variable 'CurrentTrack' (object of the [[SDBSongData]] class) is defined, and you can use it to get information about the started track. This script type is obsolete, rather register OnPlay event. Also note, that this is the only case, when multiple instances of one script can be executed by MediaMonkey, otherwise only one instance is always executed.
:* 3 = A ''search script'' that allows custom searches to be programmed in the "Auto-tag from Web" dialog. See [[Search scripts]] for more information about this more complex script type.
:* 4 = An ''Auto-DJ script'' that can handle content added by Auto-DJ. See [[Auto-DJ scripts]] for more details.
; Order
: Defines the order of the script in its section. These numbers are sorted and scripts are listed according to the order.
; DisplayName
: The script is listed as menu item with this name.
; Description
: Message shown as tooltip when the mouse is moved over the menu item.
; Language
: The script language of the referenced script. Usually <tt>VBScript</tt>, but can be <tt>JScript</tt> too (although this is not recommended).
; Shortcut
: Specifies a shortcut that invokes the script in MM. You can use any of the strings ‘Shift+’, ‘Ctrl+’ or ‘Alt+’, singly or combined, followed a single letter or number, or the name of a special key - BkSp, Tab, Enter, Esc, Space, PgUp, PgDn, End, Home, Left, Up, Right, Down, Ins, Del.

== About external scripts and applications ==

(see also [[Scripting_Tips_&_Tricks#Interaction_with_MediaMonkey_from_outside|Interaction with MediaMonkey from outside]])

Besides supporting al large part of the Winamp [http://wiki.winamp.com/wiki/Plug-in_Developer plug-in model] and messages ([http://wiki.winamp.com/wiki/SendMessage_API 1],[http://forums.winamp.com/showthread.php?threadid=180297 2]), MediaMonkey exposes an API via the Microsoft COM model. This allows external applications to access and control MediaMonkey directly. These applications can be written in any language that can access COM objects. VBScript can be used to produce external scripts, but regular Visual Basic (or any COM-aware language) can be used as well, producing a full-fledged application.

In order to work with MediaMonkey’s objects from an external script or application, you need to create a reference to the SDB object (an instance of the [[SDBApplication]] class) yourself. For .NET-based applications, you must also add a reference to MediaMonkey's COM object "MediaMonkey Library" to your Visual Studio project, so that the compiler can find MediaMonkey and the SongsDB namespace.

If MediaMonkey is already running, creating a SDBApplication object instance will return a reference to the running instance. If MediaMonkey is not running yet, it will be started and a reference will be returned. In addition, if MediaMonkey was was not running before, it will normally shut down automatically when the external script/application exits. This can be prevented (so MediaMonkey will remain running) by setting SDB's [[ISDBApplication::ShutdownAfterDisconnect|ShutdownAfterDisconnect]] property to False.

'''Visual Basic / VBScript sample:'''
<source lang="vb">
Dim SDB : Set SDB = CreateObject("SongsDB.SDBApplication")

SDB.ShutdownAfterDisconnect = False ' in case you want to keep an opened instance open after disconnecting the SDB object
</source>
'''C# sample:'''
<source lang="csharp">
SongsDB.SDBApplication SDB = new SongsDB.SDBApplication();

SDB.ShutdownAfterDisconnect = false; // in case you want to keep an opened instance open after disconnecting the SDB object
</source>

'''C++/CLI sample:'''
<source lang="cpp">
SongsDB::SDBApplication^ SDB = gcnew SongsDB::SDBApplication();

SDB->ShutdownAfterDisconnect = false; // in case you want to keep an opened instance open after disconnecting the SDB object
</source>

'''Delphi sample:'''
<source lang="delphi">
var
SDB : Variant;
begin
SDB := CreateObject('SongsDB.SDBApplication');
SDB.ShutdownAfterDisconnect := false; // in case you want to keep an opened instance open after disconnecting the SDB object
</source>

'''PHP sample:''' (shows initialization only)
<source lang="php">
$objSDB = new COM('SongsDB.SDBApplication') or die('Cannot create MediaMonkey SDB Object');
</source>

'''Python (with PyWin32) sample:'''
<source lang="python">
try:
import win32com.client
except:
print "Install PyWin32"
# Open connection to COM object
try:
SDB = win32com.client.Dispatch("SongsDB.SDBApplication")
except:
print "Is MediaMonkey up and running?"

SDB.ShutdownAfterDisconnect = False
</source>

'''Perl sample:''' (shows initialization only)
<source lang="perl">
use Win32::OLE;
my $SDB = Win32::OLE->GetActiveObject('SongsDB.SDBApplication') || Win32::OLE->new('SongsDB.SDBApplication', '');
$SDB->ShutdownAfterDisconnect(true);
</source>

Developers that require MediaMonkey type library information (e.g. for C++/Delphi, as newer languages usually don't need this) can extract this from the MediaMonkey.exe file ([http://msdn.microsoft.com/en-us/library/ms680581(v=vs.85).aspx more information]), or can use #import on the Exe file as explained in [http://msdn.microsoft.com/en-us/library/8etzzkb6(v=vs.71).aspx this MSDN page].

== Further reading ==
* [[Scripting|Scripting main page]]
* [[.NET|.NET Tips page]]
* [http://www.mediamonkey.com/sw/MediaMonkey.idl MediaMonkey Interface Definition Language (IDL) file]

Scripting Tips & Tricks (MM4)

2014-11-25T23:10:24Z

Michal.kocarek: /* Working with dates */

==(MediaMonkey) Scripting in general==

=== 'Correctly' update song properties ===
Using the SongData object, you can either update the database/library (UpdateDB) and/or update the file's tags (WriteTags). So there's no way to let the song changes be saved like the user selected in the Options panel (menu Tools > Options > Library > Tags & Playlists > "Update tags when editing properties").
However, the UpdateAll method for the SongList object ''does'' take into account this user-specified option. So you can create a new SongList object using SDB.NewSongList and add your SDBSongData object(s) to it. Then call the UpdateAll method on the songlist, and your song(s) will be saved in user-specified way.

=== See MM debug log via DebugView ===
You can download [http://technet.microsoft.com/en-us/sysinternals/bb896647.aspx DebugView] directly from Microsoft. If used with the debug version of MM, lots of useful messages will be displayed in DebugView. Also, any message set via [[ISDBTools::OutputDebugStringMM]] (e.g. using '''SDB.Tools.OutputDebugString("Test1")''') will also be added to that debug log.

=== See MM Scripting interface using OLEView ===
MS Visual Studio contains a tool called [http://www.microsoft.com/downloads/details.aspx?familyid=5233B70D-D9B2-4CB5-AEB6-45664BE858B6&displaylang=en OLEView] ("OLE Viewer" or "OLE/COM Object Viewer") ([http://download.microsoft.com/download/win2000platform/oleview/1.00.0.1/nt5/en-us/oleview_setup.exe direct link]), which can show the type library of the SongsDB object "MediaMonkey Library". It requires the Iviewers.dll, which is not included, but can be downloaded from [http://www.dlldll.com/downdll/2757.html here] or other 3rd-party locations. There, you can see all supported properties and methods of the MediaMonkey scripting interface. This can be handy to find out new scripting methods in case that the scripting reference isn't up-to-date yet.
<br>The way to get there: ''OleView'' > Type Libraries > MediaMonkey Library > (double click)
<br>and then in the ''ITypeLib Viewer'' > SongsDB (MediaMonkey Library) > Interfaces.

=== Detecting docking of a panel ===
When you un(dock) a dockable panel, the OnResize event is triggered twice:
*Once while the panel is being (un)docked with DockedTo = 0
*Once after the panel has been (undocked): with DockedTo = -1 (panel undocked) or DockedTo = X (panel docked, X is the number that represents the docking position)

=== Keep reference to Form/Panel ===
When you create a form or panel, always add a reference to the SDB.Objects dictionary. If you don't add it, the form/panel will be gone immediately after you created it, with or without error message. Instead of using the SDB.Objects dictionary you can also store a reference as a global script variable, in most cases.

=== Event mechanisms ===
There are still 2 event mechanisms available:
*Using the (mostly deprecated) ''old event mechanism'' (using ''Control''.OnClickFunc and ''Control''.UseScript), your global variables aren't remembered in the event handlers (e.g. kind of like the script is reopened). For those scripts, you had to use ''ParentControl''.ChildControl("control name") or save object references to SDB's ''Objects'' dictionary.
*Using the ''new event mechanism'', your global variables ''are'' remembered so you can use their values in the event handlers. The Objects dictionary is now only necessary to communicate/store object references between different scripts.
So always use the new event mechanism where you can. Only for option panels (sheets) this is not yet possible. There you'll need to store values between the main program and the event handlers in SDB.Objects, in the INI or in the Registry.

=== Internal mechanism of script loading ===

Normally, you don't need to know much about internal handling of scripts by MediaMonkey, but sometimes it might be useful to know, when exactly scripts are loaded.

When some function of a script is about to be executed (e.g. OnStartup function of auto-scripts), the script is loaded to memory and executed as necessary. When the execution finishes, the script is again unloaded from memory. However, there is on exception - if you register some event (by calling RegisterEvent function), the script remains still loaded in memory, until all registered events are unregistered, then it's unloaded.

This is good to know when you plan some sharing of variables. While the script is loaded in memory, you can use its global variables, but if you need to persist some values or objects between script sessions, you have to use some other mechanism (ini files, Objects collection, ...).

Note that starting from MediaMonkey 3.1.0.1205, there is always at most one instance of script loaded in memory. In older versions, if a script registered some events and then e.g. Option sheet functions were called back by MediaMonkey, they were processed in another instance of the script. Now they are processed in the already loaded instance, which helps avoid some memory leaks, is easier to handle and is also faster to process.

=== Changing the current tree node ===
Changing the selected node from a script (using SDB.MainTree.CurrentNode = ...........) takes some time to happen, and it happens asynchronicly (the code execution doesn't wait until the node is really selected). For that reason, you can't use (get value of) SDB.MainTree.CurrentNode directly after you have assigned a new node to it (set value to), because changes won't have happened yet.

=== Interaction with MediaMonkey from outside ===
There are at least three ways to interact with MediaMonkey from an external program:
*Open the MediaMonkey.exe program with command line options (arguments).
*Using the same Windows Messages (SendMessage/PostMessage) as in Winamp (WM_USER and WM_COMMAND). MM partially emulates how WinAmp works (not 100%, but very close) and so it can use WinAmp plug-ins. The class name to communicate with is "Winamp v1.x".
*Using OLE Automation, which can be very easily used e.g. from VB Script.
*:<source lang="vb">Dim SDB : Set SDB = CreateObject("SongsDB.SDBApplication")</source>
*:<source lang="csharp">SongsDB.SDBApplicationClass SDB = new SongsDB.SDBApplicationClass();</source>
*:Be sure to set ''SDB.ShutdownAfterDisconnect'' to ''False'' if you opened the MediaMonkey program by calling the SDB object, and you don't want it to be closed when your external program exits (or if you disconnect the SDB object = COM link).

=== Making scripts ready for per-user installations ===
Starting from MediaMonkey 4.0, scripts can be (and are suggested to be) installed per-user, and so they don't have to be installed in Program Files folder, but are installed in local Windows folders. The mechanism in MM is internally made as transparent as possible, so that scripts don't have to care much about their installed location. That said, some pre-4.0 scripts might need tweaking. For example, a popular script Lyricator has >1000 lines, but there's only one change needed in order to get it working under local installation, namely:
<source lang="vb">Dim sAppPath: sAppPath = sdb.ApplicationPath & "Scripts\Lyricator\"</source>
needs to be changed to
<source lang="vb">Dim sAppPath: sAppPath = sdb.ScriptsPath & "Lyricator\"</source>

==Visual Basic Script==

=== Index in VBScript ===

Usually indexes start from '''0''' (e.g. for normal arrays). However, sometimes (e.g. for string positions or for [[ISDBCommonDialog::FilterIndex]]) they start from '''1'''.

=== Code readability ===

To maintain good readability of your scripting code, make sure to add comments where necessary, split large methods in smaller ones, use appropriate indentation (tabs or 2/3/4 spaces), and if necessary split long lines of code over several lines. To split a line of VBScript code (not text or numbers), add a ''space'' and an ''underscore'', and continue on the next line. Don't forget the space before the underscore or it won't work.
<source lang="vb">
MsgBox "This is quite a long text to display on one single line and for readability we better split it on multiple lines"

MsgBox "This is quite a long text to display on one single line" & " and for readability we better split it on multiple lines"

MsgBox "This is quite a long text to display on one single line" _
& " and for readability we better split it on multiple lines"
</source>
In the third example the code is more readable, but the result is still the same: a message box with one long line of text. To split this over multiple lines, we preferably use the constant vbNewLine. If necessary, you can also use ''vbCr'' (Unix-style) or ''vbCrLf''(Windows-style). Using these constants is more clear than using respectively ''Chr(13)'' (Unix-style) or ''Chr(13) & Chr(10)'' (Windows-style).
<source lang="vb">
MsgBox "This is quite a long text to display on one single line" & vbNewLine _
& " and for readability we better split it on multiple lines"
</source>

=== Using Flags in VBScript ===

The concept of [[Flags]] can be a difficult for novice programmers. Click the link for an explanation of how to use them in VBScript (or Visual Basic).

=== Links ===

'''Helpful sites:'''
* [http://msdn2.microsoft.com/en-us/library/ms950396.aspx Reference for scripting resources]
* [http://www.microsoft.com/technet/scriptcenter/default.mspx Microsoft Script Center]
* [http://msdn2.microsoft.com/en-us/library/t0aew7h6.aspx VBScript User's Guide and Language Reference]
* [http://www.microsoft.com/technet/scriptcenter/scripts/default.mspx?mfr=true VBScript Script Repository]
* [http://www.w3schools.com/vbscript/default.asp W3Schools VBScript learning]
* [http://technet.microsoft.com/en-us/library/cc498722.aspx Microsoft TechNet scripting products and technologies]

'''VBScript editors:'''
* [http://www.vbsedit.com/ VBSEdit] (debugging, object and COM lookup, integrated help)
* [http://notepad-plus.sourceforge.net/ NotePad++]
* [http://www.pspad.com/ PSPad]
* [http://www.sapien.com/ Sapien PrimalScript]
* [http://www.microsoft.com/downloads/details.aspx?familyid=2f465be0-94fd-4569-b3c4-dffdf19ccd99&displaylang=en Microsoft Script Debugger for Windows NT 4.0 and Later ] (debugging)
* [http://www.editpadpro.com/ EditPad (Pro)]
* [http://www.e-texteditor.com/ E-TextEditor]

== JScript ==

=== Passing arrays to MediaMonkey ===

When calling MediaMonkey COM methods which accept array as their argument, you cannot simply pass native JScript array to them. You have to convert them to VBScript-compatible array (specifically <tt>VBSafeArray</tt>). (This applies yet in MM 4.1.) One of these methods is [[ISDBApplication::MessageBox]] which takes array of button constants to display.

You can use function from snippet below to JScript native array to the VBScript-compatible array.

<source lang="javascript">
/**
* Return VBSafeArray containing items from JScript array.
*/
function array_to_vbarray(array) {
var dict = new ActiveXObject('Scripting.Dictionary');
for (var i = 0, len = array.length; i < len; i++) {
dict.add(i, array[i]);
}
return dict.Items();
}
</source>

Then, when calling MediaMonkey methods, simply wrap the array argument with <tt>array_to_vbarray(…)</tt> call:

<source lang="javascript">
// Display message box
SDB.MessageBox("Simple message box from JScript with mtWarning icon and one mbOk button.", 0, array_to_vbarray([4]));
</source>

=== Adding object to SDB.Objects ===

Object stored in [[ISDBApplication::Objects|SDB.Objects]] can be retrieved by simple method call: <tt>SDB.Objects('MyObject')</tt>. But how to set the object at first?

JScript has special notation for this: <tt>SDB.Objects('MyObject') = my_object</tt>. This is not syntax error. You simply assign value to the reference returned by the method call. It works same way as in VBScript.

=== Working with dates ===

There are MediaMonkey COM properties of type Date (such as [[ISDBSongData::Date|Date]], [[ISDBSongData::DateAdded|DateAdded]], [[ISDBSongData::LastPlayed|LastPlayed]] in [[SDBSongData]]). When used in JScript, they require special treatment. (This applies yet in MM 4.1.)

'''Reading''': Properties are not converted to native JScript <tt>Date</tt> instance. You have to do it manually – cast them to string and then manually create the <tt>Date</tt> instance.

'''Setting''': You cannot set native JScript <tt>Date</tt> instance to the property. But you can set there a string in the ISO format <tt>YYYY-MM-DD HH:II:SS</tt> (eg. <tt>2012-12-31 01:02:03</tt>).

== Database & SQL ==

=== Database transactions ===

Starting from MM 3.0 transactions are often used when working with database. It can cause some problems to script authors in case they don't know some details. One example where you can face a problem is when you use [[ISDBSongData::UpdateDB]] method while you have some SQL query open. What happens in this case is, that MM wants to start a transaction, but there's still an SQL query open. This results either in an error message (in debug build) or possibly an apparent freeze of MM in the release build.

In order to prevent this problem, you can either:
* Put all these DB operations in an transaction, i.e. use [[ISDBDatabase::BeginTransaction]] and [[ISDBDatabase::Commit]].
* Close already running SQL queries before you call things like [[ISDBSongData::UpdateDB]].

=== Creating complex SQL queries ===
To easily create complex SQL queries, you can use the Query graphical user interface in Access interface, and show the SQL code when you are done. In any case, make sure that your SQL code is organized is such a way that it can be understood easily, e.g. by putting SELECT, INSERT, FROM, ORDER BY, ... on separate lines with appropriate indentation.

=== Avoid SQL date problems ===
One of the problems with SQL is that dates are often confused, which sometimes give programming bugs. The best way to circumvent this problem is by using the format #yyyy-mm-dd# for all dates in SQL (e.g. #2006-10-31# for 31th October 2006).

=== Links ===
'''Helpful sites:'''
*[http://www.w3schools.com/sql/default.asp W3Schools SQL learning]
*[http://www.1keydata.com/sql/sql.html 1Keydata SQL Tutorial]

Scripting Tips & Tricks (MM4)

2014-11-25T23:07:12Z

Michal.kocarek: /* Passing arrays to MediaMonkey */

==(MediaMonkey) Scripting in general==

=== 'Correctly' update song properties ===
Using the SongData object, you can either update the database/library (UpdateDB) and/or update the file's tags (WriteTags). So there's no way to let the song changes be saved like the user selected in the Options panel (menu Tools > Options > Library > Tags & Playlists > "Update tags when editing properties").
However, the UpdateAll method for the SongList object ''does'' take into account this user-specified option. So you can create a new SongList object using SDB.NewSongList and add your SDBSongData object(s) to it. Then call the UpdateAll method on the songlist, and your song(s) will be saved in user-specified way.

=== See MM debug log via DebugView ===
You can download [http://technet.microsoft.com/en-us/sysinternals/bb896647.aspx DebugView] directly from Microsoft. If used with the debug version of MM, lots of useful messages will be displayed in DebugView. Also, any message set via [[ISDBTools::OutputDebugStringMM]] (e.g. using '''SDB.Tools.OutputDebugString("Test1")''') will also be added to that debug log.

=== See MM Scripting interface using OLEView ===
MS Visual Studio contains a tool called [http://www.microsoft.com/downloads/details.aspx?familyid=5233B70D-D9B2-4CB5-AEB6-45664BE858B6&displaylang=en OLEView] ("OLE Viewer" or "OLE/COM Object Viewer") ([http://download.microsoft.com/download/win2000platform/oleview/1.00.0.1/nt5/en-us/oleview_setup.exe direct link]), which can show the type library of the SongsDB object "MediaMonkey Library". It requires the Iviewers.dll, which is not included, but can be downloaded from [http://www.dlldll.com/downdll/2757.html here] or other 3rd-party locations. There, you can see all supported properties and methods of the MediaMonkey scripting interface. This can be handy to find out new scripting methods in case that the scripting reference isn't up-to-date yet.
<br>The way to get there: ''OleView'' > Type Libraries > MediaMonkey Library > (double click)
<br>and then in the ''ITypeLib Viewer'' > SongsDB (MediaMonkey Library) > Interfaces.

=== Detecting docking of a panel ===
When you un(dock) a dockable panel, the OnResize event is triggered twice:
*Once while the panel is being (un)docked with DockedTo = 0
*Once after the panel has been (undocked): with DockedTo = -1 (panel undocked) or DockedTo = X (panel docked, X is the number that represents the docking position)

=== Keep reference to Form/Panel ===
When you create a form or panel, always add a reference to the SDB.Objects dictionary. If you don't add it, the form/panel will be gone immediately after you created it, with or without error message. Instead of using the SDB.Objects dictionary you can also store a reference as a global script variable, in most cases.

=== Event mechanisms ===
There are still 2 event mechanisms available:
*Using the (mostly deprecated) ''old event mechanism'' (using ''Control''.OnClickFunc and ''Control''.UseScript), your global variables aren't remembered in the event handlers (e.g. kind of like the script is reopened). For those scripts, you had to use ''ParentControl''.ChildControl("control name") or save object references to SDB's ''Objects'' dictionary.
*Using the ''new event mechanism'', your global variables ''are'' remembered so you can use their values in the event handlers. The Objects dictionary is now only necessary to communicate/store object references between different scripts.
So always use the new event mechanism where you can. Only for option panels (sheets) this is not yet possible. There you'll need to store values between the main program and the event handlers in SDB.Objects, in the INI or in the Registry.

=== Internal mechanism of script loading ===

Normally, you don't need to know much about internal handling of scripts by MediaMonkey, but sometimes it might be useful to know, when exactly scripts are loaded.

When some function of a script is about to be executed (e.g. OnStartup function of auto-scripts), the script is loaded to memory and executed as necessary. When the execution finishes, the script is again unloaded from memory. However, there is on exception - if you register some event (by calling RegisterEvent function), the script remains still loaded in memory, until all registered events are unregistered, then it's unloaded.

This is good to know when you plan some sharing of variables. While the script is loaded in memory, you can use its global variables, but if you need to persist some values or objects between script sessions, you have to use some other mechanism (ini files, Objects collection, ...).

Note that starting from MediaMonkey 3.1.0.1205, there is always at most one instance of script loaded in memory. In older versions, if a script registered some events and then e.g. Option sheet functions were called back by MediaMonkey, they were processed in another instance of the script. Now they are processed in the already loaded instance, which helps avoid some memory leaks, is easier to handle and is also faster to process.

=== Changing the current tree node ===
Changing the selected node from a script (using SDB.MainTree.CurrentNode = ...........) takes some time to happen, and it happens asynchronicly (the code execution doesn't wait until the node is really selected). For that reason, you can't use (get value of) SDB.MainTree.CurrentNode directly after you have assigned a new node to it (set value to), because changes won't have happened yet.

=== Interaction with MediaMonkey from outside ===
There are at least three ways to interact with MediaMonkey from an external program:
*Open the MediaMonkey.exe program with command line options (arguments).
*Using the same Windows Messages (SendMessage/PostMessage) as in Winamp (WM_USER and WM_COMMAND). MM partially emulates how WinAmp works (not 100%, but very close) and so it can use WinAmp plug-ins. The class name to communicate with is "Winamp v1.x".
*Using OLE Automation, which can be very easily used e.g. from VB Script.
*:<source lang="vb">Dim SDB : Set SDB = CreateObject("SongsDB.SDBApplication")</source>
*:<source lang="csharp">SongsDB.SDBApplicationClass SDB = new SongsDB.SDBApplicationClass();</source>
*:Be sure to set ''SDB.ShutdownAfterDisconnect'' to ''False'' if you opened the MediaMonkey program by calling the SDB object, and you don't want it to be closed when your external program exits (or if you disconnect the SDB object = COM link).

=== Making scripts ready for per-user installations ===
Starting from MediaMonkey 4.0, scripts can be (and are suggested to be) installed per-user, and so they don't have to be installed in Program Files folder, but are installed in local Windows folders. The mechanism in MM is internally made as transparent as possible, so that scripts don't have to care much about their installed location. That said, some pre-4.0 scripts might need tweaking. For example, a popular script Lyricator has >1000 lines, but there's only one change needed in order to get it working under local installation, namely:
<source lang="vb">Dim sAppPath: sAppPath = sdb.ApplicationPath & "Scripts\Lyricator\"</source>
needs to be changed to
<source lang="vb">Dim sAppPath: sAppPath = sdb.ScriptsPath & "Lyricator\"</source>

==Visual Basic Script==

=== Index in VBScript ===

Usually indexes start from '''0''' (e.g. for normal arrays). However, sometimes (e.g. for string positions or for [[ISDBCommonDialog::FilterIndex]]) they start from '''1'''.

=== Code readability ===

To maintain good readability of your scripting code, make sure to add comments where necessary, split large methods in smaller ones, use appropriate indentation (tabs or 2/3/4 spaces), and if necessary split long lines of code over several lines. To split a line of VBScript code (not text or numbers), add a ''space'' and an ''underscore'', and continue on the next line. Don't forget the space before the underscore or it won't work.
<source lang="vb">
MsgBox "This is quite a long text to display on one single line and for readability we better split it on multiple lines"

MsgBox "This is quite a long text to display on one single line" & " and for readability we better split it on multiple lines"

MsgBox "This is quite a long text to display on one single line" _
& " and for readability we better split it on multiple lines"
</source>
In the third example the code is more readable, but the result is still the same: a message box with one long line of text. To split this over multiple lines, we preferably use the constant vbNewLine. If necessary, you can also use ''vbCr'' (Unix-style) or ''vbCrLf''(Windows-style). Using these constants is more clear than using respectively ''Chr(13)'' (Unix-style) or ''Chr(13) & Chr(10)'' (Windows-style).
<source lang="vb">
MsgBox "This is quite a long text to display on one single line" & vbNewLine _
& " and for readability we better split it on multiple lines"
</source>

=== Using Flags in VBScript ===

The concept of [[Flags]] can be a difficult for novice programmers. Click the link for an explanation of how to use them in VBScript (or Visual Basic).

=== Links ===

'''Helpful sites:'''
* [http://msdn2.microsoft.com/en-us/library/ms950396.aspx Reference for scripting resources]
* [http://www.microsoft.com/technet/scriptcenter/default.mspx Microsoft Script Center]
* [http://msdn2.microsoft.com/en-us/library/t0aew7h6.aspx VBScript User's Guide and Language Reference]
* [http://www.microsoft.com/technet/scriptcenter/scripts/default.mspx?mfr=true VBScript Script Repository]
* [http://www.w3schools.com/vbscript/default.asp W3Schools VBScript learning]
* [http://technet.microsoft.com/en-us/library/cc498722.aspx Microsoft TechNet scripting products and technologies]

'''VBScript editors:'''
* [http://www.vbsedit.com/ VBSEdit] (debugging, object and COM lookup, integrated help)
* [http://notepad-plus.sourceforge.net/ NotePad++]
* [http://www.pspad.com/ PSPad]
* [http://www.sapien.com/ Sapien PrimalScript]
* [http://www.microsoft.com/downloads/details.aspx?familyid=2f465be0-94fd-4569-b3c4-dffdf19ccd99&displaylang=en Microsoft Script Debugger for Windows NT 4.0 and Later ] (debugging)
* [http://www.editpadpro.com/ EditPad (Pro)]
* [http://www.e-texteditor.com/ E-TextEditor]

== JScript ==

=== Passing arrays to MediaMonkey ===

When calling MediaMonkey COM methods which accept array as their argument, you cannot simply pass native JScript array to them. You have to convert them to VBScript-compatible array (specifically <tt>VBSafeArray</tt>). (This applies yet in MM 4.1.) One of these methods is [[ISDBApplication::MessageBox]] which takes array of button constants to display.

You can use function from snippet below to JScript native array to the VBScript-compatible array.

<source lang="javascript">
/**
* Return VBSafeArray containing items from JScript array.
*/
function array_to_vbarray(array) {
var dict = new ActiveXObject('Scripting.Dictionary');
for (var i = 0, len = array.length; i < len; i++) {
dict.add(i, array[i]);
}
return dict.Items();
}
</source>

Then, when calling MediaMonkey methods, simply wrap the array argument with <tt>array_to_vbarray(…)</tt> call:

<source lang="javascript">
// Display message box
SDB.MessageBox("Simple message box from JScript with mtWarning icon and one mbOk button.", 0, array_to_vbarray([4]));
</source>

=== Working with dates ===

There are MediaMonkey COM properties of type Date (such as [[ISDBSongData::Date|Date]], [[ISDBSongData::DateAdded|DateAdded]], [[ISDBSongData::LastPlayed|LastPlayed]] in [[SDBSongData]]). When used in JScript, they require special treatment. (This applies yet in MM 4.1.)

'''Reading''': Properties are not converted to native JScript <tt>Date</tt> instance. You have to do it manually – cast them to string and then manually create the <tt>Date</tt> instance.

'''Setting''': You cannot set native JScript <tt>Date</tt> instance to the property. But you can set there a string in the ISO format <tt>YYYY-MM-DD HH:II:SS</tt> (eg. <tt>2012-12-31 01:02:03</tt>).

== Database & SQL ==

=== Database transactions ===

Starting from MM 3.0 transactions are often used when working with database. It can cause some problems to script authors in case they don't know some details. One example where you can face a problem is when you use [[ISDBSongData::UpdateDB]] method while you have some SQL query open. What happens in this case is, that MM wants to start a transaction, but there's still an SQL query open. This results either in an error message (in debug build) or possibly an apparent freeze of MM in the release build.

In order to prevent this problem, you can either:
* Put all these DB operations in an transaction, i.e. use [[ISDBDatabase::BeginTransaction]] and [[ISDBDatabase::Commit]].
* Close already running SQL queries before you call things like [[ISDBSongData::UpdateDB]].

=== Creating complex SQL queries ===
To easily create complex SQL queries, you can use the Query graphical user interface in Access interface, and show the SQL code when you are done. In any case, make sure that your SQL code is organized is such a way that it can be understood easily, e.g. by putting SELECT, INSERT, FROM, ORDER BY, ... on separate lines with appropriate indentation.

=== Avoid SQL date problems ===
One of the problems with SQL is that dates are often confused, which sometimes give programming bugs. The best way to circumvent this problem is by using the format #yyyy-mm-dd# for all dates in SQL (e.g. #2006-10-31# for 31th October 2006).

=== Links ===
'''Helpful sites:'''
*[http://www.w3schools.com/sql/default.asp W3Schools SQL learning]
*[http://www.1keydata.com/sql/sql.html 1Keydata SQL Tutorial]

ISDBApplication::MessageBox

2014-11-25T23:06:46Z

Michal.kocarek: /* See Also */ Added note re JScript arrays.

{{MethodDeclaration|SDBApplication|ISDBApplication|Function MessageBox(MessageText As String, MsgType As EnumMsgBox, Buttons) As Long}}

===Parameters===

{{MethodParameters
|MessageText |String |Text to be shown in the message box.
|MsgType |EnumMsgBox |Type of the box. Can be one of constants described below.
|Buttons |Variant |Array of buttons to be shown, can be any constants described below.}}

===Method description===

Shows a customized message box and returns information about button that was pressed, which can be one of the following values:
mrNone(0), mrOk(1), mrCancel(2), mrAbort(3), mrRetry(4), mrIgnore(5), mrYes(6), mrNo(7), mrAll(8), mrNoToAll(9), mrYesToAll(10), mrOkToAll(110) or mrIgnoreToAll(111).

'''MsgType constants:'''
* '''0''': mtWarning – Icon with yellow exclamation. Use to present a condition that might cause a problem in the future.
* '''1''': mtError – Icon with red cross. Use to present an error or problem that has occurred.
* '''2''': mtInformation – Icon with small letter „i“. Use to present an useful information.
* '''3''': mtConfirmation – Question mark icon. Use to ask user for input.
* '''4''': mtCustom – No icon is shown.

'''Button constants:'''
* '''0''': mbYes
* '''1''': mbYesToAll
* '''2''': mbNo
* '''3''': mbNoToAll
* '''4''': mbOk
* '''5''': mbOkToAll
* '''6''': mbEdit
* '''7''': mbEditToAll
* '''8''': mbCancel
* '''9''': mbAbort
* '''10''': mbRetry
* '''11''': mbIgnore
* '''12''': mbIgnoreToAll
* '''13''': mbAll
* '''14''': mbHelp

===Example code===
<source lang="vb">res = SDB.MessageBox( SDB.Localize("Select tracks to be exported, please."), mtError, Array(mbOk))</source>

===JScript note===

Passed array of buttons must be of special <tt>VBSafeArray</tt>. Read more about in [[Scripting Tips & Tricks#JScript|Tips & Tricks – JScript section]].
===See Also===
*[http://msdn.microsoft.com/en-us/library/windows/desktop/aa511277.aspx MSDN – Windows UX Guidelines for Message Boxes]

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

ISDBApplication::Objects

2014-11-25T23:03:20Z

Michal.kocarek: /* Example JScript code */

{{MethodDeclaration|SDBApplication|ISDBApplication|Property Get/Let Objects(Name As String) As Object}}

===Parameters===

{{MethodParameters
|Name |String |An identifier for object storage.}}

===Property description===

A collection for temporary storage of any type of object during MediaMonkey running time. For example if a window is created by script that should remain visible while the script isn't running, the window object can be put into this collection in order to keep a reference to it. The keys of this collection are strings, the values can be only objects.

Some MediaMonkey objects are destroyed when last reference to them is deleted (such as [[SDBUIForm|form]] or [[SDBProgress|progress bar]]). In JScript there may be a delay between last reference removal and object disposal. In this case you might want to consider calling [http://msdn.microsoft.com/en-us/library/ff955348%28v=vs.85%29.aspx CollectGarbage()] method to tell the interpret to dispose objects right now.

===Example VBScript code===
<source lang="vb">If SDB.Objects("MyWindowRef") Is Nothing Then ' If the object isn't in collection yet...
Set SDB.Objects("MyWindowRef") = MyWindow ' ... add it to the collection (using Set for objects)...
End If

' Some code here

SDB.Objects("MyWindowRef") = Nothing ' ... and now remove it from the collection.</source>

=== Example JScript code ===

<source lang="javascript">
if (!SDB.Objects('MyWindowRef')) { // If the object isn't in collection yet...
SDB.Objects('MyWindowRef') = my_window; // add it to the collection.
}
</source>

To release the object from global storage, you cannot call <tt>delete SDB.Objects('MyWindowRef')</tt>, but you have to reassing the value. For example with <tt>null</tt>. However note that the object '''may''' be destroyed when there are '''no''' references left (thus SDB.Objects was the last one holding the object). If you want to destroy the object right now, consider calling <tt>CollectGarbage()</tt> method.

<source lang="javascript">
SDB.Objects('MyWindowRef') = null; // Release instance from the collection.
CollectGarbage(); // Consider calling garbage collector when needing object disposal right now.
</source>

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

ISDBApplication::Objects

2014-11-25T23:03:00Z

Michal.kocarek: /* Example JScript code */

{{MethodDeclaration|SDBApplication|ISDBApplication|Property Get/Let Objects(Name As String) As Object}}

===Parameters===

{{MethodParameters
|Name |String |An identifier for object storage.}}

===Property description===

A collection for temporary storage of any type of object during MediaMonkey running time. For example if a window is created by script that should remain visible while the script isn't running, the window object can be put into this collection in order to keep a reference to it. The keys of this collection are strings, the values can be only objects.

Some MediaMonkey objects are destroyed when last reference to them is deleted (such as [[SDBUIForm|form]] or [[SDBProgress|progress bar]]). In JScript there may be a delay between last reference removal and object disposal. In this case you might want to consider calling [http://msdn.microsoft.com/en-us/library/ff955348%28v=vs.85%29.aspx CollectGarbage()] method to tell the interpret to dispose objects right now.

===Example VBScript code===
<source lang="vb">If SDB.Objects("MyWindowRef") Is Nothing Then ' If the object isn't in collection yet...
Set SDB.Objects("MyWindowRef") = MyWindow ' ... add it to the collection (using Set for objects)...
End If

' Some code here

SDB.Objects("MyWindowRef") = Nothing ' ... and now remove it from the collection.</source>

=== Example JScript code ===

<source lang="javascript">
if (!SDB.Objects('MyWindowRef')) { // If the object isn't in collection yet...
SDB.Objects('MyWindowRef') = my_window; // add it to the collection.
}
</source>

To release the object from global storage, you cannot call <tt>delete SDB.Objects('MyWindowRef')</tt>, but you have to reassing the value. For example with <tt>null</tt>. However note that the object *may* be destroyed when *there are no references left* (thus SDB.Objects was the last one holding the object). If you want to destroy the object right now, consider calling <tt>CollectGarbage()</tt> method.

<source lang="javascript">
SDB.Objects('MyWindowRef') = null; // Release instance from the collection.
CollectGarbage(); // Consider calling garbage collector when needing object disposal right now.
</source>

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

Scripting Resources

2013-04-24T13:56:00Z

Michal.kocarek: note about equalizer file formats

'''Note: This page contains information for scripting on MM2. For MM3, you have take into account that the database has changed. Therefore, database drivers (MDAC and MS Jet) aren't needed anymore, and the database structure has changed ([[MediaMonkey Database structure]]). Also keep in mind that MM3 uses newer icons.'''

==Icons==

{|
|-
!colspan="8" | Menu & Toolbar Icons
!colspan="6" | Tree Icons
|-
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/MenuToolbar1.gif
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/MenuToolbar2.gif
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/MenuToolbar3.gif
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/MenuToolbar4.gif
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/MenuToolbar5.gif
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/MenuToolbar6.gif
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/MenuToolbar7.gif
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/MenuToolbar8.gif
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/Tree1.gif
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/Tree2.gif
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/Tree3.gif
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/Tree4.gif
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/Tree5.gif
|http://home.scarlet.be/ruben.castelein/MM/ScriptingResources/Icons/Tree6.gif
|}

''Yarin'' also made another [http://img216.imageshack.us/img216/7738/iconchart5sp.png chart of available icons].

Descriptions for the icon codes, and scripts to view all icons in Mediamonkey: [http://www.mediamonkey.com/forum/viewtopic.php?t=4239 Forum Thread]

The icons can be downloaded here: [http://www.mediamonkey.com/contrib/artwork/icons.zip Download Icons]

Normally MediaMonkey uses its own internal icons. However, if you create an "''Icons''" subdirectory in MediaMonkey's program folder (usually "''C:/Program Files/MediaMonkey''", and place all MediaMonkey icons in it, it will use those. Those icons can then be modified like you wish. They can be up to 32 bit and support simple transparency. The first (top-left) pixel is taken as the transparent color. A restart of MediaMonkey is required for the icon changes to take effect.
<br>An example of using custom icons can be found [http://www.mediamonkey.com/forum/viewtopic.php?t=20187 here].

In the same way as with the icons: if you place a file called "''NoAArt.png''" in the Icons subdirectory (which you may have to create first), it will replace MediaMonkey's default image in the Album Art panel when there's no album art found.

You can put a modified splash screen image in subdirectory "''Brand''" (which may have to be created first, in MediaMonkey's program folder). This image has to be named "''Splash.png''" (png image) or "''Splash.jpg''" (jpg image).

==Tree and database structure==

'''[[MediaMonkey Tree structure|NodeType values for the Main Tree]]:''' can be used to recognise built-in tree nodes

'''[[MediaMonkey Database structure|Location of song properties in the database]]:''' information on MM's database structure

==Cover Types==

*Known as CoverType field in the Covers database table.
*Known as [[ISDBAlbumArtItem::ItemType|ItemType]] property of the [[SDBAlbumArtItem|ISDBAlbumArtItem]] interface.

These are the cover type values used by MediaMonkey, as defined by the [http://www.id3.org/id3v2.4.0-frames ID3v2.4 specification]:

{| border="1"
|-
!ID !! Official ID3 Description !! MediaMonkey Description
|-
|0||Other||Not specified
|-
|1||32x32 pixels 'file icon' (PNG only)||Not specified
|-
|2||Other file icon||Not specified
|-
|3||Cover (front)||Cover (front)
|-
|4||Cover (back)||Cover (back)
|-
|5||Leaflet page||Leaflet Page
|-
|6||Media (e.g. label side of CD)||Media Label
|-
|7||Lead artist/lead performer/soloist||Lead Artist
|-
|8||Artist/performer||Artist
|-
|9||Conductor||Conductor
|-
|10||Band/Orchestra||Band
|-
|11||Composer||Composer
|-
|12||Lyricist/text writer||Lyricist
|-
|13||Recording Location||Recording Location
|-
|14||During recording||During Recording
|-
|15||During performance||During Performance
|-
|16||Movie/video screen capture||Video Screen Capture
|-
|17||A bright coloured fish||Not specified
|-
|18||Illustration||Illustration
|-
|19||Band/artist logotype||Band Logotype
|-
|20||Publisher/Studio logotype||Publisher Logotype
|}

==Internal Mask Fields==

{| border="1"
! Internal !! User Friendly
|-
| %A || <Artist>
|-
| %B || <Bitrate>
|-
| %C || <Composer>
|-
| %D || <Auto Number>
|-
| %E || <Extension>
|-
| %F || <Filename>
|-
| %G || <Genre>
|-
| %J || <Custom 4>
|-
| %K || <Custom 5>
|-
| %L || <Album>
|-
| %M || <BPM>
|-
| %N || <Random>
|-
| %O || <Path>
|-
| %P || <Folder>
|-
| %Q || <Playlist>
|-
| %R || <Album Artist>
|-
| %S || <Title>
|-
| %T || <Track#>
|-
| %U || <Custom 1>
|-
| %V || <Custom 2>
|-
| %W || <Custom 3>
|-
| %X || <Skip>
|-
| %Y || <Year>
|-
| %ZA || <Mood>
|-
| %ZB || <Occasion>
|-
| %ZC || <Tempo>
|-
| %ZD || <Comment>
|-
| %ZE || <Encoder>
|-
| %ZF || <ISRC>
|-
| %ZG || <Lyricist>
|-
| %ZH || <Original Artist>
|-
| %ZI || <Original Lyricist>
|-
| %ZJ || <Original Title>
|-
| %ZK || <Publisher>
|-
| %ZL || <Quality>
|-
| %ZM || <Disc#>
|-
| %ZN || <Music Composer>
|-
| %ZO || <Grouping>
|-
| %ZP || <Date>
|}

=== Special examples ===
* %2S represents <Title:2>
* %-2S represents <Title:-2>
* %@2S represents <Title@2>

==Masks sections in MediaMonkey.ini==
* '''[SongMasks]''' is used to [[Infer Track Properties]] when songs are added to the library
* '''[AutoTagMasks]''' is used for [[Auto-Tag from Filename]]
* '''[RenameMasks]''' is used for [[Auto-Organize Files]]
* '''[FileMasks]''' is a copy of [RenameMasks], made when MediaMonkey exits

==File Formats==
* [[Equalizer Preset File Format]] (<tt>*.sde</tt> files)

==Time savers==

'''Trixmoto's Form Creator:''' [http://trixmoto.net/mmvbs/ Visit]

'''Useful methods: ''' [[Useful Methods]]

==Engines and runtimes==

What to do if scripting doesn't work (anymore): [http://www.macropool.com/en/download/scripting.html Macropool Scripting Troubleshooting]

'''Windows Script 5.6'''
*for [http://www.microsoft.com/downloads/details.aspx?FamilyID=c717d943-7e4b-4622-86eb-95a22b832caa&DisplayLang=en Windows XP and Windows 2000]
*for [http://www.microsoft.com/downloads/details.aspx?FamilyID=0a8a18f6-249c-4a72-bfcf-fc6af26dc390&DisplayLang=en Windows 98, Windows Millennium Edition, and Windows NT 4.0]

'''Microsoft Data Access Components (MDAC)'''
*[http://www.microsoft.com/downloads/details.aspx?FamilyID=78cac895-efc2-4f8e-a9e0-3a1afbd5922e&DisplayLang=en download v2.8 SP1]
*[http://www.macropool.com/en/download/mdac.html download or repair MDAC and the MS Jet Database Engine]

'''Microsoft .NET Framework'''
*[http://www.microsoft.com/downloads/details.aspx?familyid=10CC340B-F857-4A14-83F5-25634C3BF043&displaylang=en Version 3.0 Redistributable Package]
*[http://www.microsoft.com/downloads/details.aspx?FamilyID=0856eacb-4362-4b0d-8edd-aab15c5e04f5&DisplayLang=en Version 2.0 Redistributable Package (x86)]
*[http://www.microsoft.com/downloads/details.aspx?FamilyID=b44a0000-acf8-4fa1-affb-40e78d788b00&DisplayLang=en Version 2.0 Redistributable Package (x64)]
*[http://www.microsoft.com/downloads/details.aspx?FamilyID=a8f5654f-088e-40b2-bbdb-a83353618b38&DisplayLang=en Version 1.1 Service Pack 1]

==ActiveX controls==

ActiveX Warnings: [http://www.mediamonkey.com/forum/viewtopic.php?p=42107#42107 how to disable] (or more recent [http://www.mediamonkey.com/forum/viewtopic.php?p=49692#49692 here])

Handy ActiveX Controls: [http://www.d2dsources.com D2DSources]

===Microsoft Controls===

*Microsoft ADO Data Control 6.0 (OLEDB): [http://activex.microsoft.com/controls/vb6/MSADODC.CAB download]
*Microsoft Chart Control 6.0 (OLEDB): [http://activex.microsoft.com/controls/vb6/MSCHRT20.CAB download]
*Microsoft Comm Control 6.0: [http://activex.microsoft.com/controls/vb6/MSCOMM32.CAB download]
*Microsoft Common Dialog Control 6.0: [http://activex.microsoft.com/controls/vb6/COMDLG32.CAB download]
*Microsoft Data Bound Grid Control 5.0 (SP3): [http://activex.microsoft.com/controls/vb6/DBGRID32.CAB download]
*Microsoft Data Bound List Controls 6.0: [http://activex.microsoft.com/controls/vb6/DBLIST32.CAB download]
*Microsoft DataGrid Control 6.0 (OLEDB): [http://activex.microsoft.com/controls/vb6/MSDATGRD.CAB download]
*Microsoft DataList Controls 6.0 (OLEDB): [http://activex.microsoft.com/controls/vb6/MSDATLST.CAB download]
*Microsoft DataRepeater Control 6.0 (OLEDB): [http://activex.microsoft.com/controls/vb6/MSDATREP.CAB download]
*Microsoft FlexGrid Control 6.0: [http://activex.microsoft.com/controls/vb6/MSFLXGRD.CAB download]
*Microsoft Hierarchical FlexGrid Control 6.0 (OLEDB): [http://activex.microsoft.com/controls/vb6/MSHFLXGD.CAB download]
*Microsoft Internet Transfer Control 6.0: [http://activex.microsoft.com/controls/vb6/MSINET.CAB download]
*Microsoft MAPI Controls 6.0: [http://activex.microsoft.com/controls/vb6/MSMAPI32.CAB download]
*Microsoft Masked Edit Control 6.0: [http://activex.microsoft.com/controls/vb6/MSMASK32.CAB download]
*Microsoft Multimedia Control 6.0: [http://activex.microsoft.com/controls/vb6/MCI32.CAB download]
*Microsoft PictureClip Control 6.0: [http://activex.microsoft.com/controls/vb6/PICCLP32.CAB download]
*Microsoft RemoteData Control 6.0: [http://activex.microsoft.com/controls/vb6/MSRDC20.CAB download]
*Microsoft Rich Textbox Control 6.0: [http://activex.microsoft.com/controls/vb6/RICHTX32.CAB download]
*Microsoft SysInfo Control 6.0: [http://activex.microsoft.com/controls/vb6/SYSINFO.CAB download]
*Microsoft Tabbed Dialog Control 6.0: [http://activex.microsoft.com/controls/vb6/TABCTL32.CAB download]
*Microsoft Windows Common Controls 5.0 (SP2): [http://activex.microsoft.com/controls/vb6/COMCTL32.CAB download]
*Microsoft Windows Common Controls-2 5.0 (SP2): [http://activex.microsoft.com/controls/vb6/COMCT232.CAB download]
*Microsoft Windows Common Controls-2 5.0 (SP2): [http://activex.microsoft.com/controls/vb6/COMCT332.CAB download]
*Microsoft Windows Common Controls 6.0 (SP6): [http://activex.microsoft.com/controls/vb6/MSCOMCTL.CAB download]
*Microsoft Windows Common Controls-2 6.0 (SP6): [http://activex.microsoft.com/controls/vb6/MSCOMCT2.CAB download]
*Microsoft Winsock Control 6.0: [http://activex.microsoft.com/controls/vb6/MSWINSCK.CAB download]

===Microsoft Objects and Libraries===

*Microsoft Data Access Components: [http://activex.microsoft.com/controls/vb6/MDAC20.CAB download]
*Microsoft Data Access Components: [http://activex.microsoft.com/controls/vb6/MDAC_TYP.CAB download]
*Microsoft Data Binding Collection Object: [http://activex.microsoft.com/controls/vb6/MSBIND.CAB download]
*Microsoft Data Formatting Object Library: [http://activex.microsoft.com/controls/vb6/MSSTDFMT.CAB download]
*Microsoft Data Report Designer v6.0: [http://activex.microsoft.com/controls/vb6/MSDBRPTR.CAB download]
*Microsoft DHTML Page Run-time Library 1.0: [http://activex.microsoft.com/controls/vb6/MSHTMPGR.CAB download]
*Microsoft OLE Automation Library: [http://activex.microsoft.com/controls/vb6/OLEAUT.CAB download]
*Microsoft Remote Data Object 2.0: [http://activex.microsoft.com/controls/vb6/MSRDO20.CAB download]
*Microsoft Remote Automation Library: [http://activex.microsoft.com/controls/vb6/msracli.cab download]
*Microsoft Stock Property Page Object: [http://activex.microsoft.com/controls/vb6/msstkprp.CAB download]
*Microsoft WebClass Library 1.0: [http://activex.microsoft.com/controls/vb6/MSWCRUN.CAB download]
*Microsoft Visual Basic 6.0 Run-time Components: [http://activex.microsoft.com/controls/vb6/VBRUN60.CAB download]
*Microsoft Visual Basic 6.0 Virtual Machine: [http://activex.microsoft.com/controls/vb6/MSVBVM60.CAB download]
*Microsoft XML Parser (MSXML) 3.0 Service Pack 7 (SP7): [http://www.microsoft.com/downloads/details.aspx?FamilyID=28494391-052b-42ff-9674-f752bdca9582&DisplayLang=en download]

'''FM20.DLL''' must ''not'' be redistributed ([http://support.microsoft.com/default.aspx?scid=kb;en-us;224305 more information]).
People who don't have the file can install [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnaxctrl/html/cpad.asp Microsoft ActiveX Control Pad] (or [http://download.microsoft.com/download/activexcontrolpad/Install/4.0.0.950/WIN98MeXP/EN-US/setuppad.exe direct link])

ISDBApplication::EqualizerPath

2013-04-24T13:54:30Z

Michal.kocarek: link to file format

{{MethodDeclaration|SDBApplication|ISDBApplication|Property Get EqualizerPath As String}}

===Property description===

Returns the path where MediaMonkey stores equalizer settings, e.g. <tt>C:\Program Files\MediaMonkey\Equalizer\</tt>.

{{Introduced|3.1.2.1266 (3.1 beta 1)}}

=== Related Topics ===

*[[ISDBApplication::ApplicationPath]]
*[[ISDBPlayer::LoadEqualizerPreset]]
*[[Equalizer Preset File Format]]

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

ISDBPlayer::LoadEqualizerPreset

2013-04-24T13:53:55Z

Michal.kocarek: added link to eq preset file format

{{MethodDeclaration|SDBPlayer|ISDBPlayer|Sub LoadEqualizerPreset(FileName As String)}}

===Method description===

Loads specified [[Equalizer Preset File Format|equalizer preset]] and enables the equalizer. Filename can be either full path or a filename only (e.g. <tt>Rock.sde</tt>). When only filename is supplied, it is searched in the [[ISDBApplication::EqualizerPath|SDB.EqualizerPath]] directory.

{{Introduced|3.1.0.1220}}

===Related Topics===
*[[ISDBApplication::EqualizerPath]]
*[[Equalizer Preset File Format]]

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBPlayer|{{PAGENAME}}]]
[[Category:Interface ISDBPlayer|{{PAGENAME}}]]

Equalizer Preset File Format

2013-04-24T13:52:40Z

Michal.kocarek: Created page with "MediaMonkey saves equalizer presets in text files with <tt>.sde</tt> extension. Files are stored under SDB.EqualizerPath folder. These presets..."

MediaMonkey saves equalizer presets in text files with <tt>.sde</tt> extension. Files are stored under [[ISDBApplication::EqualizerPath|SDB.EqualizerPath]] folder.

These presets can be loaded and saved in the Equalizer dialog. Through scripting, presets can be loaded using the [[ISDBPlayer::LoadEqualizerPreset]] method.

[[File:EqualizerDialog.png]]

===File structure description===

File has same structure as <tt>.ini</tt> files. There is one section <tt>[Equalizer]</tt> with following keys:

* '''Bands'''
* '''LeftPreamp'''
* '''RightPreamp'''
* '''Left1''' and '''Right1''' to '''Left10''' and '''Right10'''

MediaMonkey equalizer dialog is not able to set different values for left and right channels. Therefore .sde files saved from the dialog always have same <tt>Left*</tt> and <tt>Right*</tt> values.

{| class="wikitable"
|-
! Key
! Description
! Allowed values
|-
! Bands
| Amount of equalizer bands
| Always <tt>10</tt>
|-
! LeftPreamp
| Left channel preamp
| <tt>-20</tt> … <tt>20</tt> (default <tt>0</tt>) (dB)
|-
! RightPreamp
| Right channel preamp
| <tt>-20</tt> … <tt>20</tt> (default <tt>0</tt>) (dB)
|-
! Left1 … Left10
| Left channel equalizer at 31Hz, 63Hz, 125Hz, 250Hz, 500Hz, 1kHz, 2kHz, 4kHz, 8kHz, 16kHz
| <tt>-20</tt> … <tt>20</tt> (default <tt>0</tt>) (dB)
|-
! Right1 … Right10
| Right channel equalizer at 31Hz, 63Hz, 125Hz, 250Hz, 500Hz, 1kHz, 2kHz, 4kHz, 8kHz, 16kHz
| <tt>-20</tt> … <tt>20</tt> (default <tt>0</tt>) (dB)
|}

===Sample .sde file===

This is example of .sde file with default settings, e.g. sound is not modified).

<source lang="ini">
[Equalizer]
Bands=10
LeftPreamp=0
RightPreamp=0
Left1=0
Right1=0
Left2=0
Right2=0
Left3=0
Right3=0
Left4=0
Right4=0
Left5=0
Right5=0
Left6=0
Right6=0
Left7=0
Right7=0
Left8=0
Right8=0
Left9=0
Right9=0
Left10=0
Right10=0
</source>

===Related Topics===
*[[ISDBPlayer::LoadEqualizerPreset]]
*[[ISDBApplication::EqualizerPath]]

File:EqualizerDialog.png

2013-04-24T13:32:29Z

Michal.kocarek: Screenshot of the Equalizer dialog in MediaMonkey.

Screenshot of the Equalizer dialog in MediaMonkey.

SDBPlayer

2013-04-24T13:24:53Z

Michal.kocarek: versions, description

{{AutomationObjectsList}}
== CoClass SDBPlayer ==

Object for controlling of player and Now Playing list. Can be accessed through [[ISDBApplication::Player|SDB.Player]] property.

=== ISDBPlayer members ===

{{MethodsList
|[[ISDBPlayer::CurrentPlaylist|CurrentPlaylist]] |Property Get | Alias to CurrentSongList
|[[ISDBPlayer::CurrentSong|CurrentSong]] |Property Get |
|[[ISDBPlayer::CurrentSongIndex|CurrentSongIndex]] |Property Get/Let |
|[[ISDBPlayer::CurrentSongLength|CurrentSongLength]] |Property Get |
|[[ISDBPlayer::CurrentSongList|CurrentSongList]] |Property Get |
|[[ISDBPlayer::isAutoDJ|isAutoDJ]] |Property Get/Let |
|[[ISDBPlayer::isCrossfade|isCrossfade]] |Property Get/Let |
|[[ISDBPlayer::isEqualizer|isEqualizer]] |Property Get/Let | From 3.1.0
|[[ISDBPlayer::isPaused|isPaused]] |Property Get |
|[[ISDBPlayer::isPlaying|isPlaying]] |Property Get |
|[[ISDBPlayer::isRepeat|isRepeat]] |Property Get/Let |
|[[ISDBPlayer::isShuffle|isShuffle]] |Property Get/Let |
|[[ISDBPlayer::isStartingPlayback|isStartingPlayback]] |Property Get |
|[[ISDBPlayer::LoadEqualizerPreset|LoadEqualizerPreset]] |Method | From 3.1.0
|[[ISDBPlayer::Next|Next]] |Method |
|[[ISDBPlayer::Panning|Panning]] |Property Get/Let |
|[[ISDBPlayer::Pause|Pause]] |Method |
|[[ISDBPlayer::Play|Play]] |Method |
|[[ISDBPlayer::PlaybackTime|PlaybackTime]] |Property Get/Let |
|[[ISDBPlayer::PlaylistAddTrack|PlaylistAddTrack]] |Method |
|[[ISDBPlayer::PlaylistAddTracks|PlaylistAddTracks]] |Method |
|[[ISDBPlayer::PlaylistInsertTrack|PlaylistInsertTrack]] |Method | From 4.0
|[[ISDBPlayer::PlaylistInsertTracks|PlaylistInsertTracks]] |Method | From 4.0
|[[ISDBPlayer::PlaylistClear|PlaylistClear]] |Method |
|[[ISDBPlayer::PlaylistCount|PlaylistCount]] |Property Get |
|[[ISDBPlayer::PlaylistDelete|PlaylistDelete]] |Method |
|[[ISDBPlayer::PlaylistFocused|PlaylistFocused]] |Property Get/Let | From 3.1.0
|[[ISDBPlayer::PlaylistItems|PlaylistItems]] |Property Get |
|[[ISDBPlayer::PlaylistMoveTrack|PlaylistMoveTrack]] |Method |
|[[ISDBPlayer::PlaylistSelected|PlaylistSelected]] |Property Get/Let | From 3.1.0
|[[ISDBPlayer::Previous|Previous]] |Method |
|[[ISDBPlayer::Stop|Stop]] |Method |
|[[ISDBPlayer::StopAfterCurrent|StopAfterCurrent]] |Property Get/Let | From 3.1.2
|[[ISDBPlayer::Volume|Volume]] |Property Get/Let |
}}

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

ISDBPlayer::StopAfterCurrent

2013-04-24T13:22:27Z

Michal.kocarek:

{{MethodDeclaration|SDBPlayer|ISDBPlayer|Property Get/Let StopAfterCurrent As Boolean}}
===Method description===

Stops playback after currently playing track.

{{Introduced|3.1.2}}

===Example===

<source lang="vb">
'This example will show how to correctly implement
'Correct = As Track is playing we set stop after current
SDB.Player.Play
SDB.Player.StopAfterCurrent = True
MsgBox( "Enabled")

'Incorrect = As Track is not playing setting stop after current doesn't have effect (got reset when player starts playing)
SDB.Player.Stop
SDB.Player.StopAfterCurrent = True
SDB.Player.Play
MsgBox( "Disabled")
</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBPlayer|{{PAGENAME}}]]
[[Category:Interface ISDBPlayer|{{PAGENAME}}]]

ISDBPlayer::PlaylistInsertTrack

2013-04-24T13:21:49Z

Michal.kocarek:

{{MethodDeclaration|SDBPlayer|ISDBPlayer|Sub PlaylistInsertTrack( Index as Long, Song As SDBSongData)}}

===Parameters===

{{MethodParameters
|Index |Long |Index (0..n) - position where the track should be inserted
|Song |[[SDBSongData]] |Track to be inserted.}}

===Method description===

Inserts new track to Now Playing list.

{{Introduced|4.0}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBPlayer|{{PAGENAME}}]]
[[Category:Interface ISDBPlayer|{{PAGENAME}}]]

ISDBPlayer::PlaylistInsertTracks

2013-04-24T13:21:38Z

Michal.kocarek:

{{MethodDeclaration|SDBPlayer|ISDBPlayer|Sub PlaylistInsertTracks( Index as Long, Songs As SDBSongList)}}

===Parameters===

{{MethodParameters
|Index |Long |Index (0..n) - position where the tracks should be inserted
|Songs |[[SDBSongList]] |List of tracks to be inserted.}}

===Method description===

Inserts a list of tracks to Now Playing list.

{{Introduced|4.0}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBPlayer|{{PAGENAME}}]]
[[Category:Interface ISDBPlayer|{{PAGENAME}}]]

ISDBPlayer::LoadEqualizerPreset

2013-04-24T13:21:20Z

Michal.kocarek: relation to ISDBApplication::EqualizerPath

{{MethodDeclaration|SDBPlayer|ISDBPlayer|Sub LoadEqualizerPreset(FileName As String)}}

===Method description===

Loads specified equalizer preset and enables the equalizer. Filename can be either full path or a filename only (e.g. <tt>Rock.sde</tt>). When only filename is supplied, it is searched in the [[ISDBApplication::EqualizerPath|SDB.EqualizerPath]] directory.

{{Introduced|3.1.0.1220}}

===Related Topics===
*[[ISDBApplication::EqualizerPath]]

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBPlayer|{{PAGENAME}}]]
[[Category:Interface ISDBPlayer|{{PAGENAME}}]]

ISDBApplication::EqualizerPath

2013-04-24T13:17:24Z

Michal.kocarek: relation to ISDBPlayer::LoadEqualizerPreset

{{MethodDeclaration|SDBApplication|ISDBApplication|Property Get EqualizerPath As String}}

===Property description===

Returns the path where MediaMonkey stores equalizer settings, e.g. <tt>C:\Program Files\MediaMonkey\Equalizer\</tt>.

{{Introduced|3.1.2.1266 (3.1 beta 1)}}

=== Related Topics ===

*[[ISDBApplication::ApplicationPath]]
*[[ISDBPlayer::LoadEqualizerPreset]]

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

ISDBPlayer::LoadEqualizerPreset

2013-04-24T13:15:49Z

Michal.kocarek:

{{MethodDeclaration|SDBPlayer|ISDBPlayer|Sub LoadEqualizerPreset(FileName As String)}}

===Method description===

Loads specified equalizer preset and starts equalizer. Filename can be either full path or a filename only (like 'Rock.sde').

{{Introduced|3.1.0.1220}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBPlayer|{{PAGENAME}}]]
[[Category:Interface ISDBPlayer|{{PAGENAME}}]]

ISDBPlayer::PlaylistSelected

2013-04-24T13:15:16Z

Michal.kocarek:

{{MethodDeclaration|SDBPlayer|ISDBPlayer|Property Get/Let PlaylistSelected (Index As Long) As Bool}}

===Property description===

Retuns or sets whether given track in Now Playing list is selected.

{{Introduced|3.1.0.1214}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBPlayer|{{PAGENAME}}]]
[[Category:Interface ISDBPlayer|{{PAGENAME}}]]

ISDBPlayer::PlaylistFocused

2013-04-24T13:15:01Z

Michal.kocarek:

{{MethodDeclaration|SDBPlayer|ISDBPlayer|Property Get/Let PlaylistFocused (Index As Long) As Bool}}

===Property description===

Retuns or sets which track in Now Playing list is focused.

{{Introduced|3.1.0.1214}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBPlayer|{{PAGENAME}}]]
[[Category:Interface ISDBPlayer|{{PAGENAME}}]]

ISDBPlayer::isEqualizer

2013-04-24T13:14:48Z

Michal.kocarek:

{{MethodDeclaration|SDBPlayer|ISDBPlayer|Property Get/Let isEqualizer As Boolean}}

===Property description===

Sets whether equalizer is applied to track playback.

{{Introduced|3.1.0.1220}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBPlayer|{{PAGENAME}}]]
[[Category:Interface ISDBPlayer|{{PAGENAME}}]]

SDBUIForm

2013-04-23T16:00:59Z

Michal.kocarek: added note about default and cancel button

{{AutomationObjectsList}}
== CoClass SDBUIForm ==

Object represents a single window.

When user presses <tt>Enter</tt> in the window, [[ISDBUIButton::Default|default button]] handler is called. When user presses <tt>Esc</tt>, the [[ISDBUIButton::Cancel|cancel button]] handler is called. Both of these are optional.

=== ISDBUIForm members ===

{{MethodsList
|[[ISDBUIForm::BorderStyle|BorderStyle]] |Property Get/Let |
|[[ISDBUIForm::Caption|Caption]] |Property Get/Let |
|[[ISDBUIForm::Common|Common]] |Property Get |
|[[ISDBUIForm::FormPosition|FormPosition]] |Property Get/Let |
|[[ISDBUIForm::SavePositionName|SavePositionName]] |Property Get/Let |
|[[ISDBUIForm::ShowModal|ShowModal]] |Method |
|[[ISDBUIForm::StayOnTop|StayOnTop]] |Property Get/Let |
|[[ISDBUIForm::ActiveControl|ActiveControl]] |Property Get/Let | From 3.1.2.
}}

=== ISDBUIFormEvents members ===

{{MethodsList
|[[ISDBUIFormEvents::OnClose|OnClose]] |Event |
}}

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

ISDBUIButton::OnClickFunc

2013-04-23T15:53:05Z

Michal.kocarek: deprecated by OnClick event

{{MethodDeclaration|SDBUIButton|ISDBUIButton|Property Get/Let OnClickFunc As String}}

===Property description===

Name of the function that is called when the button is clicked. The function is expected to be in [[ISDBUIButton::UseScript|UseScript]] file. There is one parameter passed to the function - this button ([[SDBMenuItem]] object).

'''Deprecated''': Use the [[ISDBUIButtonEvents::OnClick|OnClick]] event registration instead.

===Example code===
<source lang="vb">
'The function to be called can look like:

Sub OnButtonClick(Button)
' Some code here
End Sub
</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBUIButton|{{PAGENAME}}]]
[[Category:Interface ISDBUIButton|{{PAGENAME}}]]

SDBUIButton

2013-04-23T15:50:22Z

Michal.kocarek: deprecation of OnClickFunc

{{AutomationObjectsList}}
== CoClass SDBUIButton ==

Button (UI element).

=== ISDBUIButton members ===

{{MethodsList
|[[ISDBUIButton::Cancel|Cancel]] |Property Get/Let |
|[[ISDBUIButton::Caption|Caption]] |Property Get/Let |
|[[ISDBUIButton::Common|Common]] |Property Get |
|[[ISDBUIButton::Default|Default]] |Property Get/Let |
|[[ISDBUIButton::ModalResult|ModalResult]] |Property Get/Let |
|[[ISDBUIButton::OnClickFunc|OnClickFunc]] |Property Get/Let | Deprecated
|[[ISDBUIButton::UseScript|UseScript]] |Property Get/Let | Deprecated
}}

=== ISDBUIButtonEvents members ===

{{MethodsList
|[[ISDBUIButtonEvents::OnClick|OnClick]] |Event |
}}

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

SDBUI

2013-04-23T15:47:57Z

Michal.kocarek: introduced for DeleteOptionSheet, better object description

{{AutomationObjectsList}}
== CoClass SDBUI ==

Object for manipulation of User Interface elements. Access the object using [[ISDBApplication::UI|SDB.UI]] property.

=== ISDBUI members ===

{{MethodsList
|[[ISDBUI::AddMenuItem|AddMenuItem]] |Method |
|[[ISDBUI::AddMenuItemSep|AddMenuItemSep]] |Method |
|[[ISDBUI::AddMenuItemSub|AddMenuItemSub]] |Method |
|[[ISDBUI::AddOptionSheet|AddOptionSheet]] |Method |
|[[ISDBUI::AddOptionSheetEx|AddOptionSheetEx]] |Method | From 3.1.0
|[[ISDBUI::AddPropertiesSheet|AddPropertiesSheet]] |Method | From 4.0
|[[ISDBUI::AddToolbar|AddToolbar]] |Method | From 4.0
|[[ISDBUI::GetToolbar|GetToolbar]] |Method | From 4.0
|[[ISDBUI::DeleteOptionSheet|DeleteOptionSheet]] |Method | From 3.0.3
|[[ISDBUI::DeletePropertiesSheet|DeletePropertiesSheet]] |Method | From 4.0
|[[ISDBUI::HidePropertiesSheet|HidePropertiesSheet]] |Method | From 4.0
|[[ISDBUI::MainWindowFocus|MainWindowFocus]] |Property Get/Let | From 3.1.0
|[[ISDBUI::Menu_Edit|Menu_Edit]] |Property Get |
|[[ISDBUI::Menu_Export|Menu_Export]] |Property Get |
|[[ISDBUI::Menu_File|Menu_File]] |Property Get |
|[[ISDBUI::Menu_Help|Menu_Help]] |Property Get |
|[[ISDBUI::Menu_Play|Menu_Play]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_MainWindow|Menu_Pop_NP_MainWindow]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_MainWindow_MoreFrom|Menu_Pop_NP_MainWindow_MoreFrom]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_MainWindow_SendTo|Menu_Pop_NP_MainWindow_SendTo]] |Property Get |
|[[ISDBUI::Menu_Pop_NP|Menu_Pop_NP]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_MoreFrom|Menu_Pop_NP_MoreFrom]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_SendTo|Menu_Pop_NP_SendTo]] |Property Get |
|[[ISDBUI::Menu_Pop_TrackList|Menu_Pop_TrackList]] |Property Get |
|[[ISDBUI::Menu_Pop_TrackList_MoreFrom|Menu_Pop_TrackList_MoreFrom]] |Property Get |
|[[ISDBUI::Menu_Pop_TrackList_SendTo|Menu_Pop_TrackList_SendTo]] |Property Get |
|[[ISDBUI::Menu_Pop_Tree|Menu_Pop_Tree]] |Property Get |
|[[ISDBUI::Menu_Pop_Tree_SendTo|Menu_Pop_Tree_SendTo]] |Property Get |
|[[ISDBUI::Menu_Scripts|Menu_Scripts]] |Property Get |
|[[ISDBUI::Menu_TbAdvanced|Menu_TbAdvanced]] |Property Get |
|[[ISDBUI::Menu_TbCategorize|Menu_TbCategorize]] |Property Get |
|[[ISDBUI::Menu_TbEdit|Menu_TbEdit]] |Property Get |
|[[ISDBUI::Menu_TbNavigation|Menu_TbNavigation]] |Property Get |
|[[ISDBUI::Menu_TbNPEdit|Menu_TbNPEdit]] |Property Get |
|[[ISDBUI::Menu_TbNPList|Menu_TbNPList]] |Property Get |
|[[ISDBUI::Menu_TbNPMain|Menu_TbNPMain]] |Property Get |
|[[ISDBUI::Menu_TbSearch|Menu_TbSearch]] |Property Get |
|[[ISDBUI::Menu_TbStandard|Menu_TbStandard]] |Property Get |
|[[ISDBUI::Menu_Tools|Menu_Tools]] |Property Get |
|[[ISDBUI::Menu_TrayIcon|Menu_TrayIcon]] |Property Get |
|[[ISDBUI::Menu_View|Menu_View]] |Property Get |
|[[ISDBUI::NewActiveX|NewActiveX]] |Property Get |
|[[ISDBUI::NewButton|NewButton]] |Property Get |
|[[ISDBUI::NewCheckBox|NewCheckBox]] |Property Get |
|[[ISDBUI::NewDockablePanel|NewDockablePanel]] |Property Get |
|[[ISDBUI::NewDockablePersistentPanel|NewDockablePersistentPanel]] |Property Get |
|[[ISDBUI::NewDropDown|NewDropDown]] |Property Get |
|[[ISDBUI::NewEdit|NewEdit]] |Property Get |
|[[ISDBUI::NewForm|NewForm]] |Property Get |
|[[ISDBUI::NewGroupBox|NewGroupBox]] |Property Get |
|[[ISDBUI::NewLabel|NewLabel]] |Property Get |
|[[ISDBUI::NewListBox|NewListBox]] |Property Get |
|[[ISDBUI::NewMultiLineEdit|NewMultiLineEdit]] |Property Get |
|[[ISDBUI::NewPanel|NewPanel]] |Property Get |
|[[ISDBUI::NewRadioButton|NewRadioButton]] |Property Get |
|[[ISDBUI::NewSpinEdit|NewSpinEdit]] |Property Get |
|[[ISDBUI::NewTrackBar|NewTrackBar]] |Property Get |
|[[ISDBUI::NewTranspPanel|NewTranspPanel]] |Property Get |
|[[ISDBUI::NewTreeList|NewTreeList]] |Property Get |
|[[ISDBUI::NewMaskEdit|NewMaskEdit]] |Property Get |
|[[ISDBUI::ShowOptions|ShowOptions]] |Method |
|[[ISDBUI::ShowPropertiesSheet|ShowPropertiesSheet]] |Method | From 4.0
}}

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

ISDBUI::DeleteOptionSheet

2013-04-23T15:45:00Z

Michal.kocarek: introduced

{{MethodDeclaration|SDBUI|ISDBUI|Proc DeleteOptionSheet(Id As Long)}}

===Parameters===

{{MethodParameters
|ID |Long |Id of sheet to be removed (previously returned by a call to AddOptionSheet).}}

===Method description===

Removes previously created custom sheet in Options dialog.

{{Introduced|3.0.3.1138}}

===Example code===
<source lang="vb">
' Create our own option sheet
ind = SDB.UI.AddOptionSheet( "Test", Script.ScriptPath, "InitSheet", "SaveSheet", 0)
' Delete this sheet
SDB.UI.DeleteOptionSheet ind
</source>

===Related Topics===

*[[Sample Option Sheets script]]

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBUI|{{PAGENAME}}]]
[[Category:Interface ISDBUI|{{PAGENAME}}]]

SDBUI

2013-04-23T15:44:32Z

Michal.kocarek: AddOptionSheetEx introduced

{{AutomationObjectsList}}
== CoClass SDBUI ==

Object for manipulation of User Interface elements.

=== ISDBUI members ===

{{MethodsList
|[[ISDBUI::AddMenuItem|AddMenuItem]] |Method |
|[[ISDBUI::AddMenuItemSep|AddMenuItemSep]] |Method |
|[[ISDBUI::AddMenuItemSub|AddMenuItemSub]] |Method |
|[[ISDBUI::AddOptionSheet|AddOptionSheet]] |Method |
|[[ISDBUI::AddOptionSheetEx|AddOptionSheetEx]] |Method | From 3.1.0
|[[ISDBUI::AddPropertiesSheet|AddPropertiesSheet]] |Method | From 4.0
|[[ISDBUI::AddToolbar|AddToolbar]] |Method | From 4.0
|[[ISDBUI::GetToolbar|GetToolbar]] |Method | From 4.0
|[[ISDBUI::DeleteOptionSheet|DeleteOptionSheet]] |Method |
|[[ISDBUI::DeletePropertiesSheet|DeletePropertiesSheet]] |Method | From 4.0
|[[ISDBUI::HidePropertiesSheet|HidePropertiesSheet]] |Method | From 4.0
|[[ISDBUI::MainWindowFocus|MainWindowFocus]] |Property Get/Let | From 3.1.0
|[[ISDBUI::Menu_Edit|Menu_Edit]] |Property Get |
|[[ISDBUI::Menu_Export|Menu_Export]] |Property Get |
|[[ISDBUI::Menu_File|Menu_File]] |Property Get |
|[[ISDBUI::Menu_Help|Menu_Help]] |Property Get |
|[[ISDBUI::Menu_Play|Menu_Play]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_MainWindow|Menu_Pop_NP_MainWindow]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_MainWindow_MoreFrom|Menu_Pop_NP_MainWindow_MoreFrom]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_MainWindow_SendTo|Menu_Pop_NP_MainWindow_SendTo]] |Property Get |
|[[ISDBUI::Menu_Pop_NP|Menu_Pop_NP]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_MoreFrom|Menu_Pop_NP_MoreFrom]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_SendTo|Menu_Pop_NP_SendTo]] |Property Get |
|[[ISDBUI::Menu_Pop_TrackList|Menu_Pop_TrackList]] |Property Get |
|[[ISDBUI::Menu_Pop_TrackList_MoreFrom|Menu_Pop_TrackList_MoreFrom]] |Property Get |
|[[ISDBUI::Menu_Pop_TrackList_SendTo|Menu_Pop_TrackList_SendTo]] |Property Get |
|[[ISDBUI::Menu_Pop_Tree|Menu_Pop_Tree]] |Property Get |
|[[ISDBUI::Menu_Pop_Tree_SendTo|Menu_Pop_Tree_SendTo]] |Property Get |
|[[ISDBUI::Menu_Scripts|Menu_Scripts]] |Property Get |
|[[ISDBUI::Menu_TbAdvanced|Menu_TbAdvanced]] |Property Get |
|[[ISDBUI::Menu_TbCategorize|Menu_TbCategorize]] |Property Get |
|[[ISDBUI::Menu_TbEdit|Menu_TbEdit]] |Property Get |
|[[ISDBUI::Menu_TbNavigation|Menu_TbNavigation]] |Property Get |
|[[ISDBUI::Menu_TbNPEdit|Menu_TbNPEdit]] |Property Get |
|[[ISDBUI::Menu_TbNPList|Menu_TbNPList]] |Property Get |
|[[ISDBUI::Menu_TbNPMain|Menu_TbNPMain]] |Property Get |
|[[ISDBUI::Menu_TbSearch|Menu_TbSearch]] |Property Get |
|[[ISDBUI::Menu_TbStandard|Menu_TbStandard]] |Property Get |
|[[ISDBUI::Menu_Tools|Menu_Tools]] |Property Get |
|[[ISDBUI::Menu_TrayIcon|Menu_TrayIcon]] |Property Get |
|[[ISDBUI::Menu_View|Menu_View]] |Property Get |
|[[ISDBUI::NewActiveX|NewActiveX]] |Property Get |
|[[ISDBUI::NewButton|NewButton]] |Property Get |
|[[ISDBUI::NewCheckBox|NewCheckBox]] |Property Get |
|[[ISDBUI::NewDockablePanel|NewDockablePanel]] |Property Get |
|[[ISDBUI::NewDockablePersistentPanel|NewDockablePersistentPanel]] |Property Get |
|[[ISDBUI::NewDropDown|NewDropDown]] |Property Get |
|[[ISDBUI::NewEdit|NewEdit]] |Property Get |
|[[ISDBUI::NewForm|NewForm]] |Property Get |
|[[ISDBUI::NewGroupBox|NewGroupBox]] |Property Get |
|[[ISDBUI::NewLabel|NewLabel]] |Property Get |
|[[ISDBUI::NewListBox|NewListBox]] |Property Get |
|[[ISDBUI::NewMultiLineEdit|NewMultiLineEdit]] |Property Get |
|[[ISDBUI::NewPanel|NewPanel]] |Property Get |
|[[ISDBUI::NewRadioButton|NewRadioButton]] |Property Get |
|[[ISDBUI::NewSpinEdit|NewSpinEdit]] |Property Get |
|[[ISDBUI::NewTrackBar|NewTrackBar]] |Property Get |
|[[ISDBUI::NewTranspPanel|NewTranspPanel]] |Property Get |
|[[ISDBUI::NewTreeList|NewTreeList]] |Property Get |
|[[ISDBUI::NewMaskEdit|NewMaskEdit]] |Property Get |
|[[ISDBUI::ShowOptions|ShowOptions]] |Method |
|[[ISDBUI::ShowPropertiesSheet|ShowPropertiesSheet]] |Method | From 4.0
}}

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

ISDBUI::AddOptionSheetEx

2013-04-23T15:43:59Z

Michal.kocarek: introduced

{{MethodDeclaration|SDBUI|ISDBUI|Function AddOptionSheetEx(SheetLabel As String, ScriptFile As String, InitProcedure As String, SaveProcedure As String, CancelProcedure As String, ParentId As Long) As Long}}

===Parameters===

{{MethodParameters
|SheetLabel |String |A label that appears in the tree of option sheet.
|ScriptFile |String |A script file that contains event functions (InitProcedure and SaveProcedure).
|InitProcedure |String |A function from ScriptFile that is called when Options dialog is created. There is one parameter present - a reference to the sheet (a [[SDBUITranspPanel]] object)
|SaveProcedure |String |A function from ScriptFile that is called when Options is closed by Ok button. There is one parameter present - a reference to the sheet (a [[SDBUITranspPanel]] object)
|CancelProcedure |String |A function from ScriptFile that is called when Options is closed, but not by Ok button. There is one parameter present - a reference to the sheet (a [[SDBUITranspPanel]] object)
|ParentId |Long |Either an ID returned from a previous call to AddOptionSheet or 0 for the last sheet. See other [[possible option sheet values]].}}

===Method description===

Creates a new sheet that appears in Options dialog.

{{Introduced|3.1.0.1205}}

===Related Topics===

*[[Sample Option Sheets script]]

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBUI|{{PAGENAME}}]]
[[Category:Interface ISDBUI|{{PAGENAME}}]]

ISDBUI::AddMenuItem

2013-04-23T15:42:24Z

Michal.kocarek: updated event handler code example

{{MethodDeclaration|SDBUI|ISDBUI|Function AddMenuItem(ParentItem As [[SDBMenuItem#ISDBMenuItem_members|ISDBMenuItem]], InSection As Long, ItemOrder As Long) As [[SDBMenuItem]]}}

===Parameters===

{{MethodParameters
|ParentItem |[[SDBMenuItem#ISDBMenuItem_members|ISDBMenuItem]] |Specifies where to add the new item, it can either be any of Menu_xxx properties or a value returned from a previous call to [[ISDBUI::AddMenuItemSub]]
|InSection |Long |To which section of the ParentItem to add the new item (section is a part separated by two separator items). Last section(0), The first(1), The second(2), ..., The first from bottom, i.e.the last(-1), The second from bottom(-2), ...
|ItemOrder |Long |Where will the item appear within the section: The last(0), The first(1), The second(2), ..., The first from bottom i.e.the last(-1), The second from bottom (-2), ...}}

===Method description===

AddMenuItem creates a new menu item or a toolbar item (these two are internally handled as the same).

===Example code===
<source lang="vb">
Sub ShowStatistics(MenuItem)
' This is called when user clicks the "Statistics" menu item.
End Sub

' Add a submenu to the View menu...
Set Mnu = UI.AddMenuItemSub(UI.Menu_View, -1, 1) ' The first item in the last section of View menu
Mnu.Caption = "Custom items"

' ... and add Statistics item there
Set SubMnu = UI.AddMenuItem(Mnu, 0, 0) ' Add an item to the previously created menu
SubMnu.Caption = "&Statistics"

SubMnu.Shortcut = "Ctrl+1"
SubMnu.IconIndex = 35
Script.RegisterEvent SubMnu, "OnClick", "ShowStatistics"
</source>

=== Related Topics ===

*[[ISDBUI::Menu Compendium]]
*[[ISDBUI::AddMenuItemSub]]
*[[ISDBUI::AddMenuItemSep]]

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBUI|{{PAGENAME}}]]
[[Category:Interface ISDBUI|{{PAGENAME}}]]

ISDBMenuItem::Caption

2013-04-23T15:39:48Z

Michal.kocarek: note about access keys, note about ellipsis

{{MethodDeclaration|SDBMenuItem|ISDBMenuItem|Property Get/Let Caption As String}}

===Property description===

A string that is shown as the description of the menu item.

'''Access Keys''': Use <tt>&</tt> character in the caption to mark the access key for the item. When navigating with keyboard, user can the press <tt>Alt+<access key></tt> to jump directly to the item.

'''Ellipsis''': While menu commands are used for immediate actions, more information might be needed to perform the action. This should be indicated by adding an ellipsis (<tt>…</tt>) at the end of the label. This usually happens when dialog is displayed or confirmation box is shown before real action occurs.

===Example code===

<source lang="vb">
MenuItem.Caption = "Choose &tracks..."
</source>

===Related Topics===
*[http://msdn.microsoft.com/en-us/library/windows/desktop/aa511502.aspx#accessKeys MSDN: Windows UX Interaction Guidelines – Access Keys]
*[http://msdn.microsoft.com/en-us/library/windows/desktop/aa511502.aspx#ellipses MSDN: Windows UX Interaction Guidelines – Using Ellipses]

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBMenuItem|{{PAGENAME}}]]
[[Category:Interface ISDBMenuItem|{{PAGENAME}}]]

ISDBMenuItem::ShortCut

2013-04-23T15:26:00Z

Michal.kocarek: better formatting, added description

{{MethodDeclaration|SDBMenuItem|ISDBMenuItem|Property Get/Let ShortCut As String}}

===Property description===

String specifies a shortcut assigned to the item, for example <tt>F9</tt> or <tt>Ctrl+Alt+2</tt>. Empty string means no shortcut is assigned.

Shortcut can be assigned to any standard key from ranges <tt>A–Z</tt>, <tt>0–9</tt> or to an additional key <tt>BkSp</tt>, <tt>Tab</tt>, <tt>Esc</tt>, <tt>Enter</tt>, <tt>Space</tt>, <tt>PgUp</tt>, <tt>PgDn</tt>, <tt>End</tt>, <tt>Home</tt>, <tt>Left</tt>, <tt>Up</tt>, <tt>Right</tt>, <tt>Down</tt>, <tt>Ins</tt>, <tt>Del</tt> or <tt>F1–F12</tt>. The key can be prefixed by any combination of <tt>Ctrl+</tt>, <tt>Alt+</tt> and <tt>Shift+</tt> modifiers.

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBMenuItem|{{PAGENAME}}]]
[[Category:Interface ISDBMenuItem|{{PAGENAME}}]]

ISDBMenuItem::IconIndex

2013-04-23T15:16:52Z

Michal.kocarek: minor correction

{{MethodDeclaration|SDBMenuItem|ISDBMenuItem|Property Get/Let IconIndex As Long}}

===Property description===

Specifies which icon is used for this node (see [[Scripting_Resources#Icons|Icons documentation]] for their list). You can use [[ISDBApplication::RegisterIcon|SDB.RegisterIcon]] method to add you own icons.

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBMenuItem|{{PAGENAME}}]]
[[Category:Interface ISDBMenuItem|{{PAGENAME}}]]

ISDBMenuItem::Hint

2013-04-23T15:15:57Z

Michal.kocarek: added note about toolbar buttons

{{MethodDeclaration|SDBMenuItem|ISDBMenuItem|Property Get/Let Hint As String}}

===Property description===

A tooltip to be shown when mouse is over the item. This is useful for toolbar buttons.

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBMenuItem|{{PAGENAME}}]]
[[Category:Interface ISDBMenuItem|{{PAGENAME}}]]

ISDBMenuItem::Caption

2013-04-23T15:15:13Z

Michal.kocarek: better description

{{MethodDeclaration|SDBMenuItem|ISDBMenuItem|Property Get/Let Caption As String}}

===Property description===

A string that is shown as the description of the menu item.

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBMenuItem|{{PAGENAME}}]]
[[Category:Interface ISDBMenuItem|{{PAGENAME}}]]

ISDBMenuItemEvents::OnClick

2013-04-23T15:12:16Z

Michal.kocarek: added example

{{MethodDeclaration|SDBMenuItem|ISDBMenuItemEvents|Sub OnClick(MenuItem As [[SDBMenuItem]])}}

===Parameters===

{{MethodParameters
|MenuItem|[[SDBMenuItem]]|Clicked menu item.}}

===Event description===

Event is called when user clicks on given toolbar/menu item. Event handler receives clicked menu item as the argument.

===Example code===
<source lang="vb">
Sub OnClickHandler(MenuItem)
' Event code goes here...
End Sub

' Assume we have already initialized the MenuItem variable
Script.RegisterEvent MenuItem, "OnClick", "OnClickHandler"
</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBMenuItem|{{PAGENAME}}]]
[[Category:Interface ISDBMenuItemEvents|{{PAGENAME}}]]

ISDBMenuItem::OnClickFunc

2013-04-23T15:06:15Z

Michal.kocarek: added deprecation note + info about OnClick event.

{{MethodDeclaration|SDBMenuItem|ISDBMenuItem|Property Get/Let OnClickFunc As String}}

===Property description===

Name of the function that is called when the item is clicked. The function is expected to be in [[ISDBMenuItem::UseScript|UseScript]] file. There is one parameter passed to the function - this menu item ([[SDBMenuItem]] object).

'''Deprecated''': Use the [[ISDBMenuItemEvents::OnClick|OnClick]] event registration instead.

===Example code===
<source lang="vb">
'The function to be called can look like:

Sub OnMenuItemClick(Item)
' Some code here
End Sub
</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBMenuItem|{{PAGENAME}}]]
[[Category:Interface ISDBMenuItem|{{PAGENAME}}]]

SDBMenuItem

2013-04-23T15:03:10Z

Michal.kocarek: deprecated OnClickFunc, UseScript.

{{AutomationObjectsList}}
== CoClass SDBMenuItem ==

MediaMonkey menus and toolbars are represented by same structure. Both menu items and toolbar buttons are represented by SDBMenuItem objects. [[SDBUI|SDB.UI]] object provides references to existing toolbars and menus and also contains toolbar/menu manipulation methods.

=== ISDBMenuItem members ===

{{MethodsList
|[[ISDBMenuItem::Caption|Caption]] |Property Get/Let |
|[[ISDBMenuItem::Enabled|Enabled]] |Property Get/Let |
|[[ISDBMenuItem::Hint|Hint]] |Property Get/Let |
|[[ISDBMenuItem::Checked|Checked]] |Property Get/Let |
|[[ISDBMenuItem::IconIndex|IconIndex]] |Property Get/Let |
|[[ISDBMenuItem::OnClickFunc|OnClickFunc]] |Property Get/Let | Deprecated
|[[ISDBMenuItem::ShortCut|ShortCut]] |Property Get/Let |
|[[ISDBMenuItem::UseScript|UseScript]] |Property Get/Let | Deprecated
|[[ISDBMenuItem::Visible|Visible]] |Property Get/Let |
}}

=== ISDBMenuItemEvents members ===

{{MethodsList
|[[ISDBMenuItemEvents::OnClick|OnClick]] |Event |
}}

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

=== Related Topics ===
*[[ISDBUI::Menu Compendium]]

ISDBUI::AddMenuItemSub

2013-04-23T15:01:52Z

Michal.kocarek: related topics

{{MethodDeclaration|SDBUI|ISDBUI|Function AddMenuItemSub(ParentItem As [[SDBMenuItem#ISDBMenuItem_members|ISDBMenuItem]], InSection As Long, ItemOrder As Long) As [[SDBMenuItem]]}}

===Parameters===

{{MethodParameters
|ParentItem |[[SDBMenuItem#ISDBMenuItem_members|ISDBMenuItem]] |Specifies where to add the new item, it can either be any of Menu_xxx properties or a value returned from a previous call to [[ISDBUI::AddMenuItemSub]]
|InSection |Long |To which section of the ParentItem to add the new item (section is a part separated by two separator items). Last section(0), The first(1), The second(2), ..., The first from bottom, i.e.the last(-1), The second from bottom(-2), ...
|ItemOrder |Long |Where will the item appear within the section: The last(0), The first(1), The second(2), ..., The first from bottom i.e.the last(-1), The second from bottom (-2), ...}}

===Method description===

Works as [[ISDBUI::AddMenuItem]], only the created item contains sub-menu.

=== Related Topics ===

*[[ISDBUI::Menu Compendium]]
*[[ISDBUI::AddMenuItem]]
*[[ISDBUI::AddMenuItemSep]]

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBUI|{{PAGENAME}}]]
[[Category:Interface ISDBUI|{{PAGENAME}}]]

ISDBUI::AddMenuItemSep

2013-04-23T15:01:48Z

Michal.kocarek: related topics

{{MethodDeclaration|SDBUI|ISDBUI|Function AddMenuItemSep(ParentItem As [[SDBMenuItem#ISDBMenuItem_members|ISDBMenuItem]], InSection As Long, ItemOrder As Long) As [[SDBMenuItem]]}}

===Parameters===

{{MethodParameters
|ParentItem |[[SDBMenuItem#ISDBMenuItem_members|ISDBMenuItem]] |Specifies where to add the new item, it can either be any of Menu_xxx properties or a value returned from a previous call to [[ISDBUI::AddMenuItemSub]]
|InSection |Long |To which section of the ParentItem to add the new item (section is a part separated by two separator items). Last section(0), The first(1), The second(2), ..., The first from bottom, i.e.the last(-1), The second from bottom(-2), ...
|ItemOrder |Long |Where will the item appear within the section: The last(0), The first(1), The second(2), ..., The first from bottom i.e.the last(-1), The second from bottom (-2), ...}}

===Method description===

Works as [[ISDBUI::AddMenuItem]], only the created item is a separator (=a horizontal line).

=== Related Topics ===

*[[ISDBUI::Menu Compendium]]
*[[ISDBUI::AddMenuItem]]
*[[ISDBUI::AddMenuItemSub]]

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBUI|{{PAGENAME}}]]
[[Category:Interface ISDBUI|{{PAGENAME}}]]

ISDBUI::Menu Compendium

2013-04-23T14:55:25Z

Michal.kocarek: added related topics, better description

Menu items can be added by [[ISDBUI::AddMenuItem|SDB.UI.AddMenuItem]] method, sub items are added through [[ISDBUI::AddMenuItemSub|SDB.UI.AddMenuItemSub]] and menu separator is added by [[ISDBUI::AddMenuItemSep|SDB.UI.AddMenuItemSep]].

Pop-up menus (right-click):
(NP = now playing, Tracklist = list browser, tree = tree on the left with artist, album, podcast, etc...)
*[[ISDBUI::Menu Pop NP]]
*[[ISDBUI::Menu Pop NP MoreFrom]]
*[[ISDBUI::Menu Pop NP SendTo]]
*[[ISDBUI::Menu Pop TrackList]]
*[[ISDBUI::Menu Pop TrackList MoreFrom]]
*[[ISDBUI::Menu Pop TrackList SendTo]]
*[[ISDBUI::Menu Pop Tree]]
*[[ISDBUI::Menu Pop Tree SendTo]]

Tray icon right-click menu:
*[[ISDBUI::Menu TrayIcon]]

Menus:
*[[ISDBUI::Menu Edit]]
*[[ISDBUI::Menu Export]]
*[[ISDBUI::Menu Help]]
*[[ISDBUI::Menu Play]]
*[[ISDBUI::Menu Scripts]]
*[[ISDBUI::Menu Tools]]
*[[ISDBUI::Menu View]]

Toolbars:
*[[ISDBUI::Menu TbStandard]]
*[[ISDBUI::Menu TbAdvanced]]
*[[ISDBUI::Menu TbCategorize]]
*[[ISDBUI::Menu TbEdit]]
*[[ISDBUI::Menu TbNavigation]]
*[[ISDBUI::Menu TbNPEdit]]

===Related Topics===
*[[ISDBUI::AddMenuItem]]
*[[ISDBUI::AddMenuItemSep]]
*[[ISDBUI::AddMenuItemSub]]

ISDBUI::MainWindowFocus

2013-04-23T14:52:01Z

Michal.kocarek: formatting

{{MethodDeclaration|SDBUI|ISDBUI|Property Get/Let MainWindowFocus As Int}}

===Property description===

Returns or sets the currently focused control of the main window. Possible values are:

* '''0''': Undefined
* '''1''': Tree
* '''2''': Tracklist
* '''3''': Search
* '''4''': Now Playing

{{Introduced|3.1.0.1210}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBUI|{{PAGENAME}}]]
[[Category:Interface ISDBUI|{{PAGENAME}}]]

ISDBApplication::MainTree

2013-04-23T14:47:35Z

Michal.kocarek: link to SDBTree object

{{MethodDeclaration|SDBApplication|ISDBApplication|Property Get MainTree As [[SDBTree]]}}

===Property description===

Returns [[SDBTree]] object for operations on the main tree.

===Example code===
This example shows how to hide some main tree nodes
<source lang="vb">
Dim Tree
Set Tree = SDB.MainTree

Tree.Node_MyComputer.Visible = False
Tree.Node_Web.Visible = False
Tree.Node_Radio.Visible = False
Tree.Node_Library.Visible = False
</source>

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

SDBUI

2013-04-23T14:45:22Z

Michal.kocarek: MainWindowFocus introduced in…

{{AutomationObjectsList}}
== CoClass SDBUI ==

Object for manipulation of User Interface elements.

=== ISDBUI members ===

{{MethodsList
|[[ISDBUI::AddMenuItem|AddMenuItem]] |Method |
|[[ISDBUI::AddMenuItemSep|AddMenuItemSep]] |Method |
|[[ISDBUI::AddMenuItemSub|AddMenuItemSub]] |Method |
|[[ISDBUI::AddOptionSheet|AddOptionSheet]] |Method |
|[[ISDBUI::AddOptionSheetEx|AddOptionSheetEx]] |Method |
|[[ISDBUI::AddPropertiesSheet|AddPropertiesSheet]] |Method | From 4.0
|[[ISDBUI::AddToolbar|AddToolbar]] |Method | From 4.0
|[[ISDBUI::GetToolbar|GetToolbar]] |Method | From 4.0
|[[ISDBUI::DeleteOptionSheet|DeleteOptionSheet]] |Method |
|[[ISDBUI::DeletePropertiesSheet|DeletePropertiesSheet]] |Method | From 4.0
|[[ISDBUI::HidePropertiesSheet|HidePropertiesSheet]] |Method | From 4.0
|[[ISDBUI::MainWindowFocus|MainWindowFocus]] |Property Get/Let | From 3.1.0
|[[ISDBUI::Menu_Edit|Menu_Edit]] |Property Get |
|[[ISDBUI::Menu_Export|Menu_Export]] |Property Get |
|[[ISDBUI::Menu_File|Menu_File]] |Property Get |
|[[ISDBUI::Menu_Help|Menu_Help]] |Property Get |
|[[ISDBUI::Menu_Play|Menu_Play]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_MainWindow|Menu_Pop_NP_MainWindow]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_MainWindow_MoreFrom|Menu_Pop_NP_MainWindow_MoreFrom]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_MainWindow_SendTo|Menu_Pop_NP_MainWindow_SendTo]] |Property Get |
|[[ISDBUI::Menu_Pop_NP|Menu_Pop_NP]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_MoreFrom|Menu_Pop_NP_MoreFrom]] |Property Get |
|[[ISDBUI::Menu_Pop_NP_SendTo|Menu_Pop_NP_SendTo]] |Property Get |
|[[ISDBUI::Menu_Pop_TrackList|Menu_Pop_TrackList]] |Property Get |
|[[ISDBUI::Menu_Pop_TrackList_MoreFrom|Menu_Pop_TrackList_MoreFrom]] |Property Get |
|[[ISDBUI::Menu_Pop_TrackList_SendTo|Menu_Pop_TrackList_SendTo]] |Property Get |
|[[ISDBUI::Menu_Pop_Tree|Menu_Pop_Tree]] |Property Get |
|[[ISDBUI::Menu_Pop_Tree_SendTo|Menu_Pop_Tree_SendTo]] |Property Get |
|[[ISDBUI::Menu_Scripts|Menu_Scripts]] |Property Get |
|[[ISDBUI::Menu_TbAdvanced|Menu_TbAdvanced]] |Property Get |
|[[ISDBUI::Menu_TbCategorize|Menu_TbCategorize]] |Property Get |
|[[ISDBUI::Menu_TbEdit|Menu_TbEdit]] |Property Get |
|[[ISDBUI::Menu_TbNavigation|Menu_TbNavigation]] |Property Get |
|[[ISDBUI::Menu_TbNPEdit|Menu_TbNPEdit]] |Property Get |
|[[ISDBUI::Menu_TbNPList|Menu_TbNPList]] |Property Get |
|[[ISDBUI::Menu_TbNPMain|Menu_TbNPMain]] |Property Get |
|[[ISDBUI::Menu_TbSearch|Menu_TbSearch]] |Property Get |
|[[ISDBUI::Menu_TbStandard|Menu_TbStandard]] |Property Get |
|[[ISDBUI::Menu_Tools|Menu_Tools]] |Property Get |
|[[ISDBUI::Menu_TrayIcon|Menu_TrayIcon]] |Property Get |
|[[ISDBUI::Menu_View|Menu_View]] |Property Get |
|[[ISDBUI::NewActiveX|NewActiveX]] |Property Get |
|[[ISDBUI::NewButton|NewButton]] |Property Get |
|[[ISDBUI::NewCheckBox|NewCheckBox]] |Property Get |
|[[ISDBUI::NewDockablePanel|NewDockablePanel]] |Property Get |
|[[ISDBUI::NewDockablePersistentPanel|NewDockablePersistentPanel]] |Property Get |
|[[ISDBUI::NewDropDown|NewDropDown]] |Property Get |
|[[ISDBUI::NewEdit|NewEdit]] |Property Get |
|[[ISDBUI::NewForm|NewForm]] |Property Get |
|[[ISDBUI::NewGroupBox|NewGroupBox]] |Property Get |
|[[ISDBUI::NewLabel|NewLabel]] |Property Get |
|[[ISDBUI::NewListBox|NewListBox]] |Property Get |
|[[ISDBUI::NewMultiLineEdit|NewMultiLineEdit]] |Property Get |
|[[ISDBUI::NewPanel|NewPanel]] |Property Get |
|[[ISDBUI::NewRadioButton|NewRadioButton]] |Property Get |
|[[ISDBUI::NewSpinEdit|NewSpinEdit]] |Property Get |
|[[ISDBUI::NewTrackBar|NewTrackBar]] |Property Get |
|[[ISDBUI::NewTranspPanel|NewTranspPanel]] |Property Get |
|[[ISDBUI::NewTreeList|NewTreeList]] |Property Get |
|[[ISDBUI::NewMaskEdit|NewMaskEdit]] |Property Get |
|[[ISDBUI::ShowOptions|ShowOptions]] |Method |
|[[ISDBUI::ShowPropertiesSheet|ShowPropertiesSheet]] |Method | From 4.0
}}

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

SDBMenuItem

2013-04-23T14:42:58Z

Michal.kocarek: clarified description, hints for manipulation

{{AutomationObjectsList}}
== CoClass SDBMenuItem ==

MediaMonkey menus and toolbars are represented by same structure. Both menu items and toolbar buttons are represented by SDBMenuItem objects. [[SDBUI|SDB.UI]] object provides references to existing toolbars and menus and also contains toolbar/menu manipulation methods.

=== ISDBMenuItem members ===

{{MethodsList
|[[ISDBMenuItem::Caption|Caption]] |Property Get/Let |
|[[ISDBMenuItem::Enabled|Enabled]] |Property Get/Let |
|[[ISDBMenuItem::Hint|Hint]] |Property Get/Let |
|[[ISDBMenuItem::Checked|Checked]] |Property Get/Let |
|[[ISDBMenuItem::IconIndex|IconIndex]] |Property Get/Let |
|[[ISDBMenuItem::OnClickFunc|OnClickFunc]] |Property Get/Let |
|[[ISDBMenuItem::ShortCut|ShortCut]] |Property Get/Let |
|[[ISDBMenuItem::UseScript|UseScript]] |Property Get/Let |
|[[ISDBMenuItem::Visible|Visible]] |Property Get/Let |
}}

=== ISDBMenuItemEvents members ===

{{MethodsList
|[[ISDBMenuItemEvents::OnClick|OnClick]] |Event |
}}

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

=== Related Topics ===
*[[ISDBUI::Menu Compendium]]

SDBUIListBox

2013-04-20T23:35:52Z

Michal.kocarek:

{{AutomationObjectsList}}
== CoClass SDBUIListBox ==

Listbox (UI element).

{{Introduced|3.1.0.1208}}

=== ISDBUIListBox members ===

{{MethodsList
|[[ISDBUIListBox::Common|Common]] |Property Get |
|[[ISDBUIListBox::ItemIndex|ItemIndex]] |Property Get/Let |
|[[ISDBUIListBox::Items|Items]] |Property Get/Let |
}}

=== ISDBUIListBoxEvents members ===

{{MethodsList
|[[ISDBUIListBoxEvents::OnChange|OnChange]] |Event |
}}

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

SDBUIEdit

2013-04-20T23:33:01Z

Michal.kocarek: introduced

{{AutomationObjectsList}}
== CoClass SDBUIEdit ==

Edit Box (UI element).

=== ISDBUIEdit members ===

{{MethodsList
|[[ISDBUIEdit::Common|Common]] |Property Get |
|[[ISDBUIEdit::Text|Text]] |Property Get/Let |
|[[ISDBUIEdit::MaxLength|MaxLength]] |Property Get/Let |
|[[ISDBUIEdit::PasswordChar|PasswordChar]] |Property Get/Let |
|[[ISDBUIEdit::SelLength|SelLength]] |Property Get/Let | From 3.1.0.
|[[ISDBUIEdit::SelStart|SelStart]] |Property Get/Let | From 3.1.0.
|[[ISDBUIEdit::SelText|SelText]] |Property Get/Let | From 3.1.0.
}}

=== ISDBUIEditEvents members ===

{{MethodsList
|[[ISDBUIEditEvents::OnChange|OnChange]] |Event |
}}

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

ISDBUIEdit::SelText

2013-04-20T23:32:27Z

Michal.kocarek: introduced

{{MethodDeclaration|SDBUIEdit|ISDBUIEdit|Property Get/Let SelText As String}}

===Property description===

Selected text (can't be edited using this property).

{{Introduced|3.1.0.1207}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBUIEdit|{{PAGENAME}}]]
[[Category:Interface ISDBUIEdit|{{PAGENAME}}]]