Class PrintLabel

Namespace

Acuit.Pinpoint.Workflows.Workstation.Activities

Assembly

Acuit.Pinpoint.Workflows.Workstation.dll

An activity that prints a label.

public class PrintLabel : Activity, IActivity

Inheritance

object

Activity

PrintLabel

Implements

IActivity

Inherited Members

Activity.DisplayName

Activity.Parameters

Activity.Variables

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

This activity requires the IDeviceRegistry and IUnitAtStationService services (automatically provided by Acuit Pinpoint Workstation).

If there is a unit active at the workstation, then the standard unit placeholders (from UnitPlaceholdersDictionary) will automatically be available to the label. Additional placeholder values can be provided via the Placeholders collection.

Properties

Placeholders

Gets the list of additional custom placeholders to make available to the label. Any placeholders defined here with the same name as those in UnitPlaceholdersDictionary will take precedence.

public Collection<PrintLabelPlaceholder> Placeholders { get; }

Property Value

Collection<PrintLabelPlaceholder>

PrintDefinitionName

Gets or sets the label print definition name. If this is not set or it evaluates to null, then the first label print definition will be used.

public ValueSource<string> PrintDefinitionName { get; set; }

Property Value

ValueSource<string>

Methods

OnExecuteAsync(ActivityContext, CancellationToken)

Derived classes must implement this to perform the activity.

protected override Task OnExecuteAsync(ActivityContext context, CancellationToken cancellationToken)

Parameters

context ActivityContext

The activity context.

cancellationToken CancellationToken

The cancellation token used to request canceling the activity.

Returns

Task

A task that represents the asynchronous operation.

Exceptions

ArgumentNullException

context is null.

InvalidOperationException

A service required by the activity is not available, or a required activity property value is not set. This will only occur asynchronously, wrapped in an AggregateException as the faulted task's Exception.

Exception

An error occurred while performing the activity. This will only occur asynchronously, wrapped in an AggregateException as the faulted task's Exception.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Remarks

This is expected to produce a string suitable for labeling this activity in a workflow diagram. It should be as specific as possible, but while keeping it very short. In general, it should be the short name of the class (as that is how it would typically be defined in the workflow XAML), optionally followed by other property values of interest in a diagram. The default implementation returns the short name of the class.