AddOptionalContentConfigOrderLabel

Optional content, layer panels, document editing

Description

Adds a non-toggleable text label that can contain nested labels and optional-content groups

Syntax

Delphi

Function TPDFlib.AddOptionalContentConfigOrderLabel(OptionalContentConfigID, ParentOrderItemID: Integer; Const LabelText: WideString): Integer;

DLL

int DLAddOptionalContentConfigOrderLabel(int InstanceID, int OptionalContentConfigID, int ParentOrderItemID, const wchar_t *LabelText);

ActiveX

Function PDFlib::AddOptionalContentConfigOrderLabel(OptionalContentConfigID As Long, ParentOrderItemID As Long, LabelText As String) As Long

Parameters

OptionalContentConfigIDOne-based configuration identifier
ParentOrderItemIDZero for a root branch or a branch handle returned by an earlier order insertion
LabelTextNon-empty label displayed in the viewer layer panel

Return values

Returns a reusable branch handle on success or 0 on invalid input

Remarks

Branch handles are document-owned and are accepted only by the configuration that contains them

See also

AddOptionalContentConfigOrderGroup, ClearOptionalContentConfigOrder