Click or drag to resize

MacroPluginValidatePublishing Method

Called before a multi-user partition(s) are published or unclaimed, can be used to prevent publishing if a non null error is returned. Will be called before the "PartitionPublishing" callback and before the user is asked to save the data. So it is possible to also use this callback to do pre-publishing changes without stopping the process. If the commit is triggered from a non-interactive context, the message box text is thrown as an exception.

Namespace:  Articy.Api.Plugins
Assembly:  ArticyApp (in ArticyApp.dll) Version: 1.0.0
Syntax
C#
Copy
public virtual string ValidatePublishing(
	Dictionary<Guid, ObjectProxy> aPartitions,
	bool aUnclaiming
)

Parameters

aPartitions
Type: System.Collections.GenericDictionaryGuid, ObjectProxy
The dictionary of all to-be-published partitions, key is the GUID of the partition, value is the root object to that partition.
aUnclaiming
Type: SystemBoolean
true if the partitions are unclaimed, false when the partitions are published

Return Value

Type: String
null if no validation error is present and the process can proceed, any other string that contains an error for an error message box.
Remarks
AD3 >= 3.1.31, MDK >= 1.8
See Also