PDFOUTLINENODE_DeleteChildren
IPDFDocument3 :: Outlines

See Also Example
Collapse All

This method deletes the child subtree of the current node from the outline tree.

Syntax

HRESULT PDFOUTLINENODE_DeleteChildren ()
Return value
If successful, this method returns S_OK. If it fails, this method should return one of the error values.

Remarks

Removes a child node (but not the current node) from the tree of the outline items.

Equivalent in new interface: IPDFDocument4::DeleteOutline.

Example

Deleting Child Nodes

Delphi
[copy to clipboard]
{ PDF object is supposed to be created }
PDF.BeginDoc;
lAction := PDF.CreateGoToPageAction(0, 0);
ind1 := PDF.PDFOUTLINES_Add(0, 'Outline 1', lAction, charsetANSI_CHARSET);
ind2 := PDF.PDFOUTLINES_AddChild(ind1, 'Outline 2', lAction, charsetANSI_CHARSET);
ind3 := PDF.PDFOUTLINES_AddChild(ind1, 'Outline 3', lAction, charsetANSI_CHARSET);
PDF.SetCurrentPDFOutlineNode(ind1);
PDF.PDFOUTLINENODE_DeleteChildren;
PDF.EndDoc;
C/C++
[copy to clipboard]
// PDF object is supposed to be created
PDF->BeginDoc();
LONG lAction = PDF->CreateGoToPageAction(0, 0);
LONG ind1 = PDF->PDFOUTLINES_Add(0, "Outline 1", lAction, charsetANSI_CHARSET);
LONG ind2 = PDF->PDFOUTLINES_AddChild(ind1, "Outline 2", lAction, charsetANSI_CHARSET);
LONG ind3 = PDF->PDFOUTLINES_AddChild(ind1, "Outline 3", lAction, charsetANSI_CHARSET);
PDF->SetCurrentPDFOutlineNode(ind1);
PDF->PDFOUTLINENODE_DeleteChildren();
PDF->EndDoc();
C#
[copy to clipboard]
// PDF object is supposed to be created
PDF.BeginDoc();
long lAction = PDF.CreateGoToPageAction(0, 0);
long ind1 = PDF.PDFOUTLINES_Add(0, "Outline 1", lAction, TxFontCharset.charsetANSI_CHARSET);
long ind2 = PDF.PDFOUTLINES_AddChild(ind1, "Outline 2", lAction, TxFontCharset.charsetANSI_CHARSET);
long ind3 = PDF.PDFOUTLINES_AddChild(ind1, "Outline 3", lAction, TxFontCharset.charsetANSI_CHARSET);
PDF.SetCurrentPDFOutlineNode(ind1);
PDF.PDFOUTLINENODE_DeleteChildren();
PDF.EndDoc();
Visual Basic
[copy to clipboard]
' PDF object is supposed to be created
PDF.BeginDoc
lAction = PDF.CreateGoToPageAction(0, 0)
ind1 = PDF.PDFOUTLINES_Add(0, "Outline 1", lAction, 0)
ind2 = PDF.PDFOUTLINES_AddChild(ind1, "Outline 2", lAction, 0)
ind3 = PDF.PDFOUTLINES_AddChild(ind1, "Outline 3", lAction, 0)
PDF.SetCurrentPDFOutlineNode(ind1)
PDF.PDFOUTLINENODE_DeleteChildren
PDF.EndDoc

See Also

Reference