Interface IInstrumentPublisher
Provides an extension point for addins to publish an Instrument to computer-assisted interviewing system.
Namespace: Algenta.Colectica.ViewModel
Assembly: Algenta.Colectica.ViewModel.dll
Syntax
public interface IInstrumentPublisherProperties
DefaultExtension
Gets the default file extension used when prompting for a file name to create.
Declaration
string DefaultExtension { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
IsInteractive
Gets a value indicating whether the publisher provides its own user interface.
If false, the user will be prompted with a File Save dialog.
If true, the outputPath parameter of the Publish
command will be empty.
Declaration
bool IsInteractive { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Name
Gets the name of the instrument publisher.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Weight
Gets the order in which this Addin should be displayed. Lower values are displayed higher or further to the left.
Declaration
int Weight { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
CanPublish(Instrument, List<String>)
Determines whether the provided instrument can be published by this addin.
Declaration
bool CanPublish(Instrument instrument, List<string> messages)Parameters
| Type | Name | Description |
|---|---|---|
| Instrument | instrument | The instrument to be published. |
| List<System.String> | messages | If the instrument cannot be published, a list of messages indicating the reason. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns |
Publish(Node, Instrument, String)
Publishes an instrument to the specified location.
Declaration
void Publish(Node node, Instrument instrument, string outputPath)Parameters
| Type | Name | Description |
|---|---|---|
| Node | node | The node representing the instrument. |
| Instrument | instrument | The instrument to publish. |
| System.String | outputPath | The location to which the instrument should be published.
If the IsInteractive property is |