PDFANNOTATION_Flags_afHidden
IPDFDocument3 :: Annotations

See Also Example
Collapse All

This property gets or sets the value indicating if an annotation is hidden.

Syntax

VARIANT_BOOL PDFANNOTATION_Flags_afHidden { get; set; }
Value
VARIANT_TRUE if the control is hidden, VARIANT_FALSE otherwise.

Remarks

If set to VARIANT_TRUE, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available. In cases where screen space is limited, the ability to hide and show annotations selectively can be used to display auxiliary pop-up information similar in function to online help systems.

Equivalent in new interface: IPDFDocument4::AnnotHidden.

Example

Changing an Annotation's Flags

Delphi
[copy to clipboard]
{ PDF object is supposed to be created }
PDF.BeginDoc;
PDF.PDFPAGE_SetAnnotation(100, 200, 110, 210, 'Title',
    'Here goes annotation contents...', 255, false, false, false,
    false, false, false, false, false, charsetANSI_CHARSET);
PDF.PDFANNOTATION_Flags_afHidden := true;
PDF.EndDoc;
C/C++
[copy to clipboard]
// PDF object is supposed to be created
PDF->BeginDoc();
PDF->PDFPAGE_SetAnnotation(100, 200, 110, 210, "Title",
    "Here goes annotation contents...", 255, FALSE, FALSE, FALSE,
    FALSE, FALSE, FALSE, FALSE, FALSE, charsetANSI_CHARSET);
PDF->PDFANNOTATION_Flags_afHidden = TRUE;
PDF->EndDoc();
C#
[copy to clipboard]
// PDF object is supposed to be created
PDF.BeginDoc();
PDF.PDFPAGE_SetAnnotation(100, 200, 110, 210, "Title",
    "Here goes annotation contents...", 255, false, false, false,
    false, false, false, false, false, TxFontCharset.charsetANSI_CHARSET);
PDF.PDFANNOTATION_Flags_afHidden = true;
PDF.EndDoc();
Visual Basic
[copy to clipboard]
' PDF object is supposed to be created
PDF.BeginDoc
PDF.PDFPAGE_SetAnnotation 100, 200, 110, 210, "Title",_
    "Here goes annotation contents...", 255,_
    false, false, false, false, false, false, false, false, 0
PDF.PDFANNOTATION_Flags_afHidden = True
PDF.EndDoc

See Also

Reference