Click or drag to resize

PFItemBatchAction Class

Indicates a PFItem method that can be used for batch actions.

These actions are available in the navigation depending on the visibility setting.

Inheritance Hierarchy
SystemObject
  SystemAttribute
    Packflow.CorePFItemBatchAction

Namespace:  Packflow.Core
Assembly:  MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
Syntax
C#
[AttributeUsageAttribute(AttributeTargets.Method, Inherited = true, AllowMultiple = false)]
public class PFItemBatchAction : Attribute

The PFItemBatchAction type exposes the following members.

Constructors
  NameDescription
Public methodPFItemBatchAction
Top
Properties
  NameDescription
Public propertyDescription
Gets or sets the description. This is used as an explanation for the action, if no translation has been found.
Public propertyDescription_TranslationKey
Gets or sets the translation key of the description.
Public propertyDisplayName
Gets or sets the display name. This is used as a label for the action, if no translation has been found.
Public propertyDisplayName_TranslationKey
Gets or sets the translation key of the display name.
Public propertyIconName
Gets or sets the icon name (name of a Font-Awesome icon).
Public propertyName
Gets or sets the (internal) name of this action, must be unique and contain only letters, digits or underscores.

If not set, the name of the method is used.

Public propertyParameters
Gets the parent method parameters.
Public propertyParentMethod
Gets the method having this attribute.
Public propertyParentType
Gets the parent type of the method having this attribute.
Public propertyRequireConfirmation
Gets or sets a value indicating whether a confirmation is asked before execution.

Default value: true.

If parameters are found on the method, a confirmation dialog will be shown even if this parameter is false.

Public propertyTypeId
When implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute.)
Public propertyValidationMethod
Gets the validation method.
Public propertyValidationMethodName
Gets or sets the validation method name.

The method must have the same signature as the current one.

To report a problem in that method, you must throw a ValidationException.

Public propertyVisibility_Logins
Gets or sets the list of user logins having access to this action.

Applies if the VisibilityScope is set to SpecificLogins.

Logins must include the domain and be separated by ";". @"myDomain\User1;myDomain\User2"

Public propertyVisibilityScope
Gets or sets the visibility scope, specifying to which users this action is available.

Default value: AllUsers.

Top
Methods
  NameDescription
Public methodEquals
Returns a value that indicates whether this instance is equal to a specified object.
(Inherited from Attribute.)
Public methodStatic memberGet(PFContentType)
Gets the list of actions for the specified content type.
Public methodStatic memberGet(PFContentType, String)
Gets a specific action of the specified content type.
Public methodGetHashCode
Returns the hash code for this instance.
(Inherited from Attribute.)
Public methodIsDefaultAttribute
When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from Attribute.)
Public methodMatch
When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from Attribute.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodAsT
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.)
Public Extension MethodEqualsAll
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.)
Public Extension MethodEqualsAny
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.)
Public Extension MethodGetString
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.)
Public Extension MethodIsGenericListOverloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.)
Public Extension MethodIsGenericList(Type)Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.)
Public Extension MethodSerializeOverloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerialize(String)Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerializeJsonOverloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(ListType)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(DataContractJsonSerializerSettings)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Top
See Also