How to use Batch Tasks plugins

Paul Filkin — Thu, 07 May 2020 17:13:34 GMT

Current Revision posted to Studio Developers WIKI by Paul Filkin on 5/7/2020 5:13:34 PM

Before choosing Batch Task as template to build your plugin you should ask yourself if this template is suitable for your needs. Take your time and respond to this questions:

When you create a project using Batch Task template the following files will be generated:

Depending on the name of your solution you'll have a class which has the following annotation [AutomaticTask].This class is the entry point of your plugin. By default it has two methods:

ConfigureConverter() method will be called when user clicks on "Finish" button. From here the logic of your application will begin.
OnInitializeTask() ,is the method from where you can get your Batch Task settings saved on the project.

To get the setting use following method GetSetting<CustomSettings>(). Where CustomSettings is a class which inherits from SettingsGroup class.

If your plugin should process sdlxliff files OnFileComplete() method should be added!. Just paste the following code on your class. This allows your application to override the xliff. If you don't add this your changes on the file will not be saved.

gist.github.com/.../5999a02c92c4079264198c90a4af9f7d

2. An User Control where the UI of the application should be added.

3. An class which inherits SettingsGroup. This class is used to set end get custom settings for your plugin.

4. An SettingsPage which inherits DefaultSettingsPage. Here you add the logic if you want to set some information triggered on the following events: Save, Cancel, ValidateInput and so on.

In the following pages we'll explain how the settings from User Control should be saved in SettingsGroup class and how you can update the user interface based on the information you already have saved in settings.

Please go to How bind a DataGridView to SettingsGroup page to continue the tutorial.

Tags: batch task, Studio Documentation, Studio API

All about Batch Tasks plugins

Paul Filkin — Thu, 07 May 2020 16:48:57 GMT

Revision 10 posted to Studio Developers WIKI by Paul Filkin on 5/7/2020 4:48:57 PM

Before choosing Batch Task as template to build your plugin you should ask yourself if this template is suitable for your needs. Take your time and respond to this questions:

When you create a project using Batch Task template the following files will be generated:

Depending on the name of your solution you'll have a class which has the following annotation [AutomaticTask].This class is the entry point of your plugin. By default it has two methods:

ConfigureConverter() method will be called when user clicks on "Finish" button. From here the logic of your application will begin.
OnInitializeTask() ,is the method from where you can get your Batch Task settings saved on the project.

To get the setting use following method GetSetting<CustomSettings>(). Where CustomSettings is a class which inherits from SettingsGroup class.

If your plugin should process sdlxliff files OnFileComplete() method should be added!. Just paste the following code on your class. This allows your application to override the xliff. If you don't add this your changes on the file will not be saved.

gist.github.com/.../5999a02c92c4079264198c90a4af9f7d

2. An User Control where the UI of the application should be added.

3. An class which inherits SettingsGroup. This class is used to set end get custom settings for your plugin.

4. An SettingsPage which inherits DefaultSettingsPage. Here you add the logic if you want to set some information triggered on the following events: Save, Cancel, ValidateInput and so on.

Please go to How bind a DataGridView to SettingsGroup page to continue the tutorial.

Tags: batch task, Studio Documentation, Studio API

All about Batch Tasks plugins

Andrea-Melinda Ghisa — Wed, 18 Jul 2018 07:54:14 GMT

Revision 9 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 7/18/2018 7:54:14 AM

Before choosing Batch Task as template to build your plugin you should ask yourself if this template is suitable for your needs. Take your time and respond to this questions:

When you create a project using Batch Task template the following files will be generated:

Depending on the name of your solution you'll have a class which has the following annotation [AutomaticTask].This class is the entry point of your plugin. By default it has two methods:

ConfigureConverter() method will be called when user clicks on "Finish" button. From here the logic of your application will begin.
OnInitializeTask() ,is the method from where you can get your Batch Task settings saved on the project.

To get the setting use following method GetSetting<CustomSettings>(). Where CustomSettings is a class which inherits from SettingsGroup class.

If your plugin should process sdlxliff files OnFileComplete() method should be added!. Just paste the following code on your class. This allows your application to override the xliff. If you don't add this your changes on the file will not be saved.

gist.github.com/.../5999a02c92c4079264198c90a4af9f7d

2. An User Control where the UI of the application should be added.

3. An class which inherits SettingsGroup. This class is used to set end get custom settings for your plugin.

4. An SettingsPage which inherits DefaultSettingsPage. Here you add the logic if you want to set some information triggered on the following events: Save, Cancel, ValidateInput and so on.

Please go to How bind a DataGridView to SettingsGroup page to continue the tutorial.

Tags: batch task, Studio Documentation, Studio API

All about Batch Tasks plugins

Andrea-Melinda Ghisa — Fri, 27 Apr 2018 09:53:05 GMT

Revision 8 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/27/2018 9:53:05 AM

Before choosing Batch Task as template to build your plugin you should ask yourself if this template is suitable for your needs. Take your time and respond to this questions:

When you create a project using Batch Task template the following files will be generated:

Depending on the name of your solution you'll have a class which has the following annotation [AutomaticTask].This class is the entry point of your plugin. By default it has two methods:

ConfigureConverter() method will be called when user clicks on "Finish" button. From here the logic of your application will begin.
OnInitializeTask() ,is the method from where you can get your Batch Task settings saved on the project.

To get the setting use following method GetSetting<CustomSettings>(). Where CustomSettings is a class which inherits from SettingsGroup class.

If your plugin should process sdlxliff files OnFileComplete() method should be added!. Just paste the following code on your class. This allows your application to override the xliff. If you don't add this your changes on the file will not be saved.

public override bool OnFileComplete(ProjectFile projectFile, IMultiFileConverter multiFileConverter)
{
return true;
}

2. An User Control where the UI of the application should be added.

3. An class which inherits SettingsGroup. This class is used to set end get custom settings for your plugin.

4. An SettingsPage which inherits DefaultSettingsPage. Here you add the logic if you want to set some information triggered on the following events: Save, Cancel, ValidateInput and so on.

Please go to How bind a DataGridView to SettingsGroup page to continue the tutorial.

Tags: batch task, Studio Documentation, Studio API

All about Batch Tasks plugins

Andrea-Melinda Ghisa — Fri, 27 Apr 2018 09:50:39 GMT

Revision 7 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/27/2018 9:50:39 AM

Before choosing Batch Task as template to build your plugin you should ask yourself if this template is suitable for your needs. Take your time and respond to this questions:

When you create a project using Batch Task template the following files will be generated:

Depending on the name of your solution you'll have a class which has the following annotation [AutomaticTask].This class is the entry point of your plugin. By default it has two methods:

ConfigureConverter() method will be called when user clicks on "Finish" button. From here the logic of your application will begin.
OnInitializeTask() ,is the method from where you can get your Batch Task settings saved on the project.

To get the setting use following method GetSetting<CustomSettings>(). Where CustomSettings is a class which inherits from SettingsGroup class.

If your plugin should process sdlxliff files OnFileComplete() method should be added!. Just paste the following code on your class. This allows your application to override the xliff. If you don't add this your changes on the file will not be saved.

public override bool OnFileComplete(ProjectFile projectFile, IMultiFileConverter multiFileConverter)
{
return true;
}

2. An User Control where the UI of the application should be added.

3. An class which inherits SettingsGroup. This class is used to set end get custom settings for your plugin.

4. An SettingsPage which inherits DefaultSettingsPage. Here you add the logic if you want to set some information triggered on the following events: Save, Cancel, ValidateInput and so on.

Tags: batch task, Studio Documentation, Studio API

All about Batch Tasks plugins

Andrea-Melinda Ghisa — Fri, 27 Apr 2018 09:41:29 GMT

Revision 6 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/27/2018 9:41:29 AM

Before choosing Batch Task as template to build your plugin you should ask yourself if this template is suitable for your needs. Take your time and respond to this questions:

When you create a project using Batch Task template the following files will be generated:

Depending on the name of your solution you'll have a class which has the following annotation [AutomaticTask].This class is the entry point of your plugin. By default it has two methods:

ConfigureConverter() method will be called when user clicks on "Finish" button. From here the logic of your application will begin.
OnInitializeTask() ,is the method from where you can get your Batch Task settings saved on the project.

To get the setting use following method GetSetting<CustomSettings>(). Where CustomSettings is a class which inherits from SettingsGroup class.

If your plugin should process sdlxliff files OnFileComplete() method should be added!. Just paste the following code on your class. This allows your application to override the xliff. If you don't add this your changes on the file will not be saved.

public override bool OnFileComplete(ProjectFile projectFile, IMultiFileConverter multiFileConverter)
{
return true;
}

2. An User Control where the UI of the application should be added.

3. An class which inherits SettingsGroup. This class is used to set end get custom settings for your plugin.

4. An SettingsPage which inherits DefaultSettingsPage. Here you add the logic if you want to set some information triggered on the following events: Save, Cancel, ValidateInput and so on.

Tags: batch task, Studio Documentation, Studio API

All about Batch Tasks plugins

Andrea-Melinda Ghisa — Fri, 27 Apr 2018 09:20:28 GMT

Revision 5 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/27/2018 9:20:28 AM

Before choosing Batch Task as template to build your plugin you should ask yourself if this template is suitable for your needs. Take your time and respond to this questions:

When you create a project using Batch Task template the following files will be generated:

1. Depending on the name of your solution you'll a class which has the following annotation [AutomaticTask].This class is the entry point of your plugin. By default it has two methods:

ConfigureConverter() method will be called when user clicks on "Finish" button. From here the logic of your application will begin.
OnInitializeTask() ,is the method from where you can get your Batch Task settings saved on the project.

To get the setting use following method GetSetting<CustomSettings>(). Where CustomSettings is a class which inherits from SettingsGroup class.

If your batch task plugin should process sdlxliff files OnFileComplete() method should be added!. Just paste the following code on your class. This allows your application to override the xliff. If you don't add this your changes on the file will not be saved.

public override bool OnFileComplete(ProjectFile projectFile, IMultiFileConverter multiFileConverter)
{
return true;
}

Tags: batch task, Studio Documentation, Studio API

All about Batch Tasks plugins

Andrea-Melinda Ghisa — Mon, 23 Apr 2018 12:21:50 GMT

Revision 4 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/23/2018 12:21:50 PM

Before choosing Batch Task as template to build your plugin you should ask yourself if this template is suitable for your needs. Take your time and respond to this questions:

Tags: batch task, Studio Documentation, Studio API

All about Batch Tasks plugins

Andrea-Melinda Ghisa — Mon, 23 Apr 2018 12:20:26 GMT

Revision 3 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/23/2018 12:20:26 PM

Before choosing Batch task as template to build your plugin you should ask yourself if this template is suitable for your needs. Take your time and respond to this questions:

Tags: batch task, Studio Documentation, Studio API

All about Batch Tasks plugins

Andrea-Melinda Ghisa — Mon, 23 Apr 2018 12:18:36 GMT

Revision 2 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/23/2018 12:18:36 PM

Before choosing Batch task as template to build your plugin you should ask yourself if this template is suitable for your needs. Take your time and respond to this questions:

Tags: batch task, Studio Documentation, Studio API

All about Batch Tasks plugins

Andrea-Melinda Ghisa — Mon, 23 Apr 2018 11:39:23 GMT

Revision 1 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/23/2018 11:39:23 AM

Tags: batch task, Studio Documentation, Studio API