Dave Mitchell's DigitalMicrograph™ Scripting Website

// example code showing how to add bits of information to a taggroup.

// this taggroup can be added directly to the the Global Info, or directly

// saved as a settings file

// version:20080303

// D. R. G. Mitchell, adminnospam@dmscripting.com (remove the nospam to make this email address work).

// v1.0, March 2008

// Create a new taggroup which will hold all the information

taggroup newtags=newtaggroup()

// Get some data to add to the top level of the taggroup

string packagename="My package"

string defaultpath="C:/whatever"

string version="20080203"

number priority=3

number index

// Add a labelled tag and then its value to the respective variable

index=newtags.taggroupcreatenewlabeledtag("Default Path")

newtags.taggroupsetindexedtagasstring(index,defaultpath)

index=newtags.taggroupcreatenewlabeledtag("Package Name")

newtags.taggroupsetindexedtagasstring(index,packagename)

index =newtags.taggroupcreatenewlabeledtag("Package Priority")

newtags.taggroupsetindexedtagaslong(index,priority)

index =newtags.taggroupcreatenewlabeledtag("Package Version")

newtags.taggroupsetindexedtagasstring(index,version)

// The above adds top level entries to the taggroup which appear as

/*

Default Path:C:/whatever

Package Name:My Package

Package Priority:3

Package Version:20080203

*/

// Next a new taggroup is created on each pass of the loop. This

// Adds taggroups called Item 1, Item 2 etc to menu item Items.

// Each of these sub groups contains the fields

/*

Command Name:Hello1

Main Menu Name:Hello1

Script Name:hello1

Sub Menu Name:hello1

Type:1

Version:1

*/

// The value 1 gets incremented on each pass. Obviously in real code, variables from,

// for example dialog fields, would be sourced and added to these taggroups.

number nomenuentries=5

number i

taggroup itemtag=newtaggroup()

for(i=0; i<nomenuentries; i++)

{

taggroup isubgroup=newtaggroup()

index = isubgroup.taggroupcreatenewlabeledtag("Command Name")

isubgroup.taggroupsetindexedtagasstring(index, "hello"+i)

index = isubgroup.taggroupcreatenewlabeledtag("Main Menu Name")

isubgroup.taggroupsetindexedtagasstring(index, "hello"+i)

index = isubgroup.taggroupcreatenewlabeledtag("Script Name")

isubgroup.taggroupsetindexedtagasstring(index, "hello"+i)

index = isubgroup.taggroupcreatenewlabeledtag("Sub Menu Name")

isubgroup.taggroupsetindexedtagasstring(index, "hello"+i)

index = isubgroup.taggroupcreatenewlabeledtag("Type")

isubgroup.taggroupsetindexedtagaslong(index, i)

index = isubgroup.taggroupcreatenewlabeledtag("Version")

isubgroup.taggroupsetindexedtagaslong(index, i)

itemtag.taggroupaddlabeledtaggroup("Item"+i, isubgroup)

}

newtags.taggroupaddlabeledtaggroup("Items",itemtag)

// This displays the contents of the final taggroup.

okdialog("About to display the newly created taggroup.")

newtags.taggroupopenbrowserwindow(0)

/*

// Uncomment the next sections - delete the /* and the */ // to see how the newly created tag group

// gets added to the Global Info - remember to delete the taggroup 'Test of Taggroup Addition' when you are done

// and also how it gets saved as a settings file

// Add this to the persistent tag group (Global Info)

// Get the persistent taggroup

taggroup ptags=getpersistenttaggroup()

// Before adding the taggroup, must check to see if it already exists

// if yes it will generate an error, existing tags can not be overwritten

// they must be delected first

string tagname="Test of Taggroup Addition"

if(ptags.taggroupdoestagexist(tagname))

{

// Yes the tag does exist - so delete it

okdialog("Taggroup ' "+tagname+" ' already exists - deleting it")

taggroupdeletetagwithlabel(ptags, tagname)

}

taggroupaddlabeledtaggroup(ptags, tagname, newtags)

okdialog("The tag group ' '"+tagname+" ' has been added to the Global Info")

ptags=getpersistenttaggroup()

ptags.taggroupopenbrowserwindow(0)

// Save this tagggroup as a setting file by

string settingsname

packagename="I am a label"

if(!saveasdialog("Save the settings", settingsname, settingsname)) exit(0)

taggroupsavetofilewithlabel(newtags, settingsname, packagename)