IWorkflowAttribute Interface

Represents an attrbrite of a Workflow Action. Used to store the action's settings.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308

Syntax

public interface IWorkflowAttribute : IAttribute

Public Interface IWorkflowAttribute
	Inherits IAttribute

public interface class IWorkflowAttribute : IAttribute

type IWorkflowAttribute =  
    interface
        interface IAttribute
    end

The IWorkflowAttribute type exposes the following members.

Properties

	Name	Description
	Hidden	Gets and sets the Element as hidden on the Edit Form. (Inherited from IAttribute.)
	Indexable	Gets/sets the Element as indexable after publish (Inherited from IAttribute.)
	Name	Gets the name of the attribute (Inherited from IAttribute.)
	Readonly	Gets and sets the Element as read-only on the Edit Form. (Inherited from IAttribute.)
	Required	Gets sets the Element's value as required. Pages containing required Elements with empty values cannot be checked in. (Inherited from IAttribute.)
	Value	Gets and sets the value of the attribute (Inherited from IAttribute.)
	Values	Gets the values of the attribute.
	WorkflowActionTypes	Gets the list of Action types on which this attribute can be used.

Methods

	Name	Description
	AddWorkflowActionType	Adds a new Action type to the attribute's allowed action types.
	Serialize	Serializes the Attribute object to an XML Attribute (Inherited from IAttribute.)

Remarks

Depending on the Action type, there are different sets of required attributes.

Examples

Serialization of a workflow attribute is a standard XML attribute of the Action element. For example, "PubTarget="PublishingTargets/2"