Classes
class	AddFilesToArchiveAction
	Adds one or more files from a folder to an archive. More...

class	BarTenderCommandLineAction
	Prints a BarTender document by using the command-line interface. More...

class	BarTenderProcessAction
	Defines a common class for BarTenderProcessAction and PrintBTXMLScriptAction. More...

class	CaseActions
	Defines the Case action group and runs the group of actions when the case condition is met. For more information, see ActionGroup and SelectCaseAction. More...

class	ConditionActions
	Runs either actions for true or actions for false based on the result of the condition. More...

class	CopyFileAction
	Copies one or more files from one location to another. More...

class	CopyFolderAction
	Copies a folder to another folder location. More...

class	CreateFolderAction
	Creates a folder. More...

class	DecrementVariableAction
	Decrements the variable by a specified value each time the action is run. More...

class	DeleteDatabaseRecordAction
	Deletes one or more records from a connected database. More...

class	DeleteFileAction
	Deletes one or more files. More...

class	DeleteFolderAction
	Deletes a folder. More...

class	ExecuteSQLAction
	Runs an SQL script. More...

class	ExtractFilesFromArchiveAction
	Extracts one or more files from an archive to a specified folder. More...

class	FolderAction
	Defines a common base class for CopyFolderAction, MoveFolderAction and RenameFolderAction. More...

class	ForEachDatabaseRecordActions
	Runs actions for each record in a database query. More...

class	ForEachFileInArchiveActions
	Runs a group of one or more actions for all files in an archive folder that match a specified filter. More...

class	ForEachFileInFolderActions
	Runs a group of one or more actions for all files in a folder that match a specified filter. More...

class	ForLoopActions
	Runs the actions in the group for the specified loop by incrementing or decrementing the variable. More...

class	GoToAction
	Jumps to a specific action to continue processing. More...

class	IncrementVariableAction
	Increments the variable by a specified value. More...

class	InsertDatabaseRecordAction
	Inserts a database record into a connected database. More...

class	MailLinkedResource
	Represents an alternate email body view linked resource. More...

class	MediaHandling
	Specifies the media handling settings for the printer, which vary depending on the printer's capability. More...

class	MoveFileAction
	Moves one or more files from one location to another. More...

class	MoveFolderAction
	Moves a folder from one location to another. More...

class	PowerShellCommandAction
	Runs a Windows PowerShell command (script). More...

class	PrintActionBase
	Defines a common base class for PrintBTWAction, PrintBTXMLScriptAction, and BarTenderCommandLineAction. More...

class	PrintBTWAction
	Prints a BarTender document. More...

class	PrintCommandScriptAction
	Prints a BarTender document by using a combination of command lines and data. More...

class	ReadFileAction
	Reads the content of a file on any supported file system, including FTP, web, and cloud storage. More...

class	ReadFromNetworkSocketAction
	Reads from a TCP or UDP socket for incoming data. More...

class	ReadFromSerialPortAction
	Reads from a serial port for incoming data. More...

class	RenameFileAction
	Renames a file. More...

class	RenameFolderAction
	Renames a folder. More...

class	RunAsUserActions
	Runs a group of actions by using the credentials that are specified. More...

class	SelectCaseAction
	Evaluates which Case subactions to run, according to their specified conditions. More...

class	SendEmailAction
	Sends an email message. More...

class	SendToMessageQueueAction
	Sends a message to the Microsoft Message Queuing (MSMQ) service. More...

class	SendToNetworkSocketAction
	Sends data over a TCP or UDP socket. More...

class	SendWebServiceRequestAction
	Sends an HTTP request to a web service (REST or SOAP). More...

class	SetMultipleVariablesAction
	Sets the value of one or more variables. More...

class	SetVariableAction
	Sets the value of one variable. More...

class	ShellCommandAction
	Runs a shell command that can be used to run operating system commands or third-party utilities. More...

class	StopAction
	Stops all actions in the current execution. More...

class	StringTransformAction
	The following string transform actions are available: More...

class	TransformTextToRecordSetAction
	Transforms text or a text file to a record set. More...

class	UpdateDatabaseRecordsAction
	Updates one or more database records. More...

class	WaitAction
	Specifies a time period that elapses before the action finishes. You can use this action to create a pause in sequential actions. More...

class	WaitForFileAction
	Waits for a file to appear in a specified folder before running subsequent actions. More...

class	WhileLoopActions
	Continues to run the actions in the group as long as the condition is satisfied. More...

class	WorkflowTransitionAction
	Move the librarian file from one state to another in its workflow by the specified transition. More...

class	WriteFileAction
	Writes content to a file. More...

class	WriteMessageToLogAction
	Sends information to the message log. More...

class	SendToSerialPortAction
	Writes information to a serial port. More...

class	XslTransformAction
	Defines a common class of the following: More...

Enumerations
enum class	ConditionType { BasedOnVariable = ActionRunType.UseConditionVariable , BasedOnExpression = ActionRunType.UseConditionExpression , AlwaysTrue = ActionRunType.Always , AlwaysFalse = ActionRunType.Never }
	Specifies the conditions under which the actions run, similar to ActionRunType and specific to ConditionActions. More...

enum class	WhileLoopActionGroupRepeatType { Forever = ActionRunType.Always , WhileVariableMeetsCondition = ActionRunType.UseConditionVariable , WhileExpressionMeetsCondition = ActionRunType.UseConditionExpression }

Enumeration Type Documentation

◆ ConditionType

enum ConditionType

strong

Specifies the conditions under which the actions run, similar to ActionRunType and specific to ConditionActions.

Enumerator
BasedOnVariable	Specifies that RunWhenTrueActions or RunWhenFalseActions runs as long as the variable meets the specified condition, which is a simple condition on the variable's value, such as "%SomeVariable% == 'abc'".
BasedOnExpression	Specifies that RunWhenTrueActions or RunWhenFalseActions runs as long as the variable meets the specified condition, which can contain logical operators and more than one variable, such as "%SomeVariable% == 'abc' And %AnotherVariable" == 'def'".
AlwaysTrue	Specifies that RunWhenTrueActions always runs.
AlwaysFalse	Specifies that RunWhenFalseActions always runs.

◆ WhileLoopActionGroupRepeatType

enum WhileLoopActionGroupRepeatType

strong

Enumerator
Forever	Specifies a group of one or more actions that continue to run sequentially as long as the specified condition continues to be satisfied.
WhileVariableMeetsCondition	Specifies that the action runs as long as the variable meets the specified condition, which is a simple condition on the variable's value, such as "%SomeVariable% == 'abc'".
WhileExpressionMeetsCondition	Specifies that the action runs as long as the variable meets the specified condition, which can contain logical operators and more than one variable, such as "%SomeVariable% == 'abc' And %AnotherVariable" == 'def'".

Classes

Enumerations

Enumeration Type Documentation

◆ ConditionType

◆ WhileLoopActionGroupRepeatType