Scripting - Revision history

Sm7iun: /* Example scripts */

2026-03-27T04:31:14Z

Example scripts

← Older revision		Revision as of 04:31, 27 March 2026
Line 68:		Line 68:
	Various example scripts are available for download from http://dxlog.net/sw/#files%2Fcustomization%2Fscripts		Various example scripts are available for download from http://dxlog.net/sw/#files%2Fcustomization%2Fscripts

	Two complete Visual Studio file trees are also available as good starting points for own development		Two complete Visual Studio file trees are also available as good starting points for own development<br>
	or modification of example scripts.		or modification of example scripts.

Sm7iun: /* C# script structure */

2026-03-27T04:30:58Z

C# script structure

← Older revision		Revision as of 04:30, 27 March 2026
Line 56:		Line 56:
	in <code>C:\Program Files (x86)\DXLog.net</code> on 64-bit Windows<br>		in <code>C:\Program Files (x86)\DXLog.net</code> on 64-bit Windows<br>
	or <code>C:\Program Files\DXLog.net</code> on 32-bit Windows.		or <code>C:\Program Files\DXLog.net</code> on 32-bit Windows.
			<br>
	<br>		<br>
	<br>		<br>

Sm7iun: /* C# script structure */

2026-03-27T04:30:45Z

C# script structure

← Older revision		Revision as of 04:30, 27 March 2026
Line 58:		Line 58:
	<br>		<br>
	<br>		<br>

	Important: the custom C# code script must be included as source code, DO NOT COMPILE.<br>		Important: the custom C# code script must be included as source code, DO NOT COMPILE.<br>
	Scripts can be located anywhere on your hard drive but must always be added using the<br>		Scripts can be located anywhere on your hard drive but must always be added using the<br>

Sm7iun: /* C# script structure */

2026-03-27T04:30:27Z

C# script structure

← Older revision		Revision as of 04:30, 27 March 2026
Line 56:		Line 56:
	in <code>C:\Program Files (x86)\DXLog.net</code> on 64-bit Windows<br>		in <code>C:\Program Files (x86)\DXLog.net</code> on 64-bit Windows<br>
	or <code>C:\Program Files\DXLog.net</code> on 32-bit Windows.		or <code>C:\Program Files\DXLog.net</code> on 32-bit Windows.

	~~Important: the custom C# code script must be included as source<br>~~
	~~code, DO NOT COMPILE. Scripts can be located anywhere on your<br>~~
	~~hard drive but must always be added using the scripts<br>~~
	~~manager (<code>Tools\|Scripts Manager</code>) in DXLog.net.~~
	<br>		<br>
	<br>		<br>
			Important: the custom C# code script must be included as source code, DO NOT COMPILE.<br>
			Scripts can be located anywhere on your hard drive but must always be added using the<br>
			scripts manager (<code>Tools\|Scripts Manager</code>) in DXLog.net.

	==Example scripts==		==Example scripts==

Sm7iun: /* C# script structure */

2026-03-27T04:29:37Z

C# script structure

← Older revision		Revision as of 04:29, 27 March 2026
Line 41:		Line 41:
	[[File:DXLog_script_references.PNG\|200px\|thumb\|left\|Required references in Visual Studio's Solution Explorer]]		[[File:DXLog_script_references.PNG\|200px\|thumb\|left\|Required references in Visual Studio's Solution Explorer]]

	An extremely useful feature of Visual Studio is the "Intellisense" mechanic which allows~~<br>~~		An extremely useful feature of Visual Studio is the<br>
	not only as-you-type syntax checking but also interactive searching for available objects and methods.~~<br>~~		"Intellisense" mechanic which allows not only as-you-type<br>
	By adding references to the DXLog.net binaries in Visual Studio's Solution Explorer, Intellisense will be<br>		syntax checking but also interactive searching for available<br>
	able to automatically list available options for objects as you type, and you will also be able to search<br>		objects and methods. By adding references to the DXLog.net<br>
	~~for objects and~~ methods by name using the top search bar in Solution Explorer or by using the Object Browser.~~<br>~~		binaries in Visual Studio's Solution Explorer, Intellisense will be<br>
			able to automatically list available options for objects as<br>
			you type, and you will also be able to search for objects and<br>
			methods by name using the top search bar in Solution Explorer<br>
			or by using the Object Browser.

	You add references to the binaries by right-clicking on "References", select "Add Reference" and in the~~<br>~~		You add references to the binaries by right-clicking on "References",<br>
	bottom of the Reference Manager panel use the "Browse" button. The DXLog.net binaries are typically located<br>		select "Add Reference" and in the bottom of the Reference Manager panel<br>
	in <code>C:\Program Files (x86)\DXLog.net</code> on 64-bit Windows or <code>C:\Program Files\DXLog.net</code>~~<br>~~		use the "Browse" button. The DXLog.net binaries are typically located<br>
	on 32-bit Windows.		in <code>C:\Program Files (x86)\DXLog.net</code> on 64-bit Windows<br>
			or <code>C:\Program Files\DXLog.net</code> on 32-bit Windows.

	Important: the custom C# code script must be included as source code, DO NOT COMPILE.~~<br>~~		Important: the custom C# code script must be included as source<br>
	Scripts can be located anywhere on your hard drive but must always be added using the scripts<br>		code, DO NOT COMPILE. Scripts can be located anywhere on your<br>
			hard drive but must always be added using the scripts<br>
	manager (<code>Tools\|Scripts Manager</code>) in DXLog.net.		manager (<code>Tools\|Scripts Manager</code>) in DXLog.net.
	~~<br>~~
	~~<br>~~
	<br>		<br>
	<br>		<br>

Sm7iun: /* C# script structure */

2026-03-27T04:27:46Z

C# script structure

← Older revision		Revision as of 04:27, 27 March 2026
Line 55:		Line 55:
	Scripts can be located anywhere on your hard drive but must always be added using the scripts<br>		Scripts can be located anywhere on your hard drive but must always be added using the scripts<br>
	manager (<code>Tools\|Scripts Manager</code>) in DXLog.net.		manager (<code>Tools\|Scripts Manager</code>) in DXLog.net.
			<br>
	<br>		<br>
	<br>		<br>

Sm7iun: /* C# script structure */

2026-03-27T04:27:33Z

C# script structure

← Older revision		Revision as of 04:27, 27 March 2026
Line 38:		Line 38:
	is configured in the "Configure interfaces" window. Via this you can e.g. access the radio(s)<br>		is configured in the "Configure interfaces" window. Via this you can e.g. access the radio(s)<br>
	or any other enabled serial or parallel port object.		or any other enabled serial or parallel port object.


	[[File:DXLog_script_references.PNG\|200px\|thumb\|left\|Required references in Visual Studio's Solution Explorer]]		[[File:DXLog_script_references.PNG\|200px\|thumb\|left\|Required references in Visual Studio's Solution Explorer]]


	An extremely useful feature of Visual Studio is the "Intellisense" mechanic which allows<br>		An extremely useful feature of Visual Studio is the "Intellisense" mechanic which allows<br>

Sm7iun at 04:27, 27 March 2026

2026-03-27T04:27:11Z

← Older revision		Revision as of 04:27, 27 March 2026
Line 12:		Line 12:
	https://youtu.be/UKaZ2S4AJAA<br>		https://youtu.be/UKaZ2S4AJAA<br>

			Microsoft have a free fully functional version of Visual Studio called Community,<br>
	Microsoft have a free fully functional version of Visual Studio called Community, available from https://visualstudio.microsoft.com/vs/community		available from https://visualstudio.microsoft.com/vs/community

	==C# script structure==		==C# script structure==
Line 57:		Line 57:
	Scripts can be located anywhere on your hard drive but must always be added using the scripts<br>		Scripts can be located anywhere on your hard drive but must always be added using the scripts<br>
	manager (<code>Tools\|Scripts Manager</code>) in DXLog.net.		manager (<code>Tools\|Scripts Manager</code>) in DXLog.net.
			<br>
			<br>
			<br>

	==Example scripts==		==Example scripts==

Sm7iun: /* C# script structure */

2026-03-27T04:26:24Z

C# script structure

← Older revision		Revision as of 04:26, 27 March 2026
Line 38:		Line 38:
	is configured in the "Configure interfaces" window. Via this you can e.g. access the radio(s)<br>		is configured in the "Configure interfaces" window. Via this you can e.g. access the radio(s)<br>
	or any other enabled serial or parallel port object.		or any other enabled serial or parallel port object.


	[[File:DXLog_script_references.PNG\|200px\|thumb\|left\|Required references in Visual Studio's Solution Explorer]]		[[File:DXLog_script_references.PNG\|200px\|thumb\|left\|Required references in Visual Studio's Solution Explorer]]


	An extremely useful feature of Visual Studio is the "Intellisense" mechanic which allows<br>		An extremely useful feature of Visual Studio is the "Intellisense" mechanic which allows<br>

Sm7iun: /* C# script structure */

2026-03-27T04:25:59Z

C# script structure

← Older revision		Revision as of 04:25, 27 March 2026
Line 17:		Line 17:
	==C# script structure==		==C# script structure==

	Each script needs to implement three methods, as shown in the examples below:~~<br>~~		Each script needs to implement three methods, as shown in the examples below:
	~~<br>~~
	<code>Initialize</code> - is called when the script is compiled and the object created. This is used to hook on events or initialize additional properties etc.~~<br>~~		<code>Initialize</code> - is called when the script is compiled and the object created.<br>
	~~<br>~~		This is used to hook on events or initialize additional properties etc.
	<code>Deinitialize</code> - is called when the object is going to be closed, for example when we exit DXLog.net.~~<br>~~
	~~<br>~~		<code>Deinitialize</code> - is called when the object is going to be closed,<br>
	<code>Main</code> - is called each time the script is called with a defined shortcut or from a macro message.~~<br>~~		for example when we exit DXLog.net.
	~~<br>~~
	To access DXLog.net internal objects and methods from the script, three main objects are available:~~<br>~~		<code>Main</code> - is called each time the script is called with a defined shortcut<br>
	~~<br>~~		or from a macro message. To access DXLog.net internal objects and methods from the<br>
	<code>FrmMain</code> - Refers to the main Window ~~- from~~ this you can access any other public object in main code and you can access public properties, methods, hook on events etc.<br>		script, three main objects are available:
	This object has access to everything within in the main DXLog.net code.~~<br>~~
	~~<br>~~		<code>FrmMain</code> - Refers to the main Window. From this you can access any other<br>
	<code>ContestData</code> - Contains all the properties and methods related to the currently open log.~~<br>~~		public object in main code and you can access public properties, methods, hook on events etc.<br>
	~~<br>~~		This object has access to everything within in the main DXLog.net code.
	<code>COMMain</code> - The main communications object which is used to access everything that is configured in the "Configure interfaces" window. ~~<br>~~
	Via this you can e.g. access the radio(s) or any other enabled serial or parallel port object.~~<br>~~		<code>ContestData</code> - Contains all the properties and methods related to the currently open log.
	~~<br>~~
			<code>COMMain</code> - The main communications object which is used to access everything that<br>
			is configured in the "Configure interfaces" window. Via this you can e.g. access the radio(s)<br>
			or any other enabled serial or parallel port object.

	[[File:DXLog_script_references.PNG\|200px\|thumb\|left\|Required references in Visual Studio's Solution Explorer]]		[[File:DXLog_script_references.PNG\|200px\|thumb\|left\|Required references in Visual Studio's Solution Explorer]]
Line 43:		Line 46:
	able to automatically list available options for objects as you type, and you will also be able to search<br>		able to automatically list available options for objects as you type, and you will also be able to search<br>
	for objects and methods by name using the top search bar in Solution Explorer or by using the Object Browser.<br>		for objects and methods by name using the top search bar in Solution Explorer or by using the Object Browser.<br>
	~~<br>~~
	You add references to the binaries by right-clicking on "References", select "Add Reference" and in the<br>		You add references to the binaries by right-clicking on "References", select "Add Reference" and in the<br>
	bottom of the Reference Manager panel use the "Browse" button. The DXLog.net binaries are typically located<br>		bottom of the Reference Manager panel use the "Browse" button. The DXLog.net binaries are typically located<br>
	in <code>C:\Program Files (x86)\DXLog.net</code> on 64-bit Windows or <code>C:\Program Files\DXLog.net</code><br>		in <code>C:\Program Files (x86)\DXLog.net</code> on 64-bit Windows or <code>C:\Program Files\DXLog.net</code><br>
	on 32-bit Windows.		on 32-bit Windows.
	~~<br>~~
	Important: the custom C# code script must be included as source code, DO NOT COMPILE.<br>		Important: the custom C# code script must be included as source code, DO NOT COMPILE.<br>
	Scripts can be located anywhere on your hard drive but must always be added using the scripts<br>		Scripts can be located anywhere on your hard drive but must always be added using the scripts<br>
	manager (<code>Tools\|Scripts Manager</code>) in DXLog.net.		manager (<code>Tools\|Scripts Manager</code>) in DXLog.net.
	~~<br>~~
	~~<br>~~
	~~<br>~~
	~~<br>~~

	==Example scripts==		==Example scripts==