Platforms to show: All Mac Windows Linux Cross-Platform

PDFAnnotationFreeTextMBS class

Super class: PDFAnnotationMBS

dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
dim page as PDFPageMBS = doc.pageAtIndex(0)
dim annotations(-1) as PDFAnnotationMBS = page.annotations

for each a as PDFAnnotationMBS in annotations
  if a isa PDFAnnotationFreeTextMBS then
    dim ft as PDFAnnotationFreeTextMBS = PDFAnnotationFreeTextMBS(a)
    MsgBox ft.contents
  end if
next

• event drawWithBox(box as Integer, g as NSGraphicsMBS) as boolean
• 3 properties
  • property alignment as Integer
  • property font as NSFontMBS
  • property fontColor as NSColorMBS
• 2 methods
  • method Constructor(left as Double, top as Double, width as Double, height as Double)
  • method Constructor(left as Double, top as Double, width as Double, height as Double, annotationType as String, properties as Dictionary = nil)
• 2 shared methods
  • shared method NSCenterTextAlignment as Integer
  • shared method NSRightTextAlignment as Integer
• 3 constants

Constants

Super class PDFAnnotationMBS

• 50 properties
  • property Action as PDFActionMBS
  • property alignment as Integer
  • property allowsToggleToOff as Boolean
  • property annotationKeyValues as Dictionary
  • property backgroundColor as NSColorMBS
  • property border as PDFBorderMBS
  • property bounds as NSRectMBS
  • property buttonWidgetState as Integer
  • property buttonWidgetStateString as String
  • property caption as String
  • property colorValue as NSColorMBS
  • property comb as Boolean
  • property contents as string
  • property destination as PDFDestinationMBS
  • property endLineStyle as Integer
  • property endPoint as NSPointMBS
  • property fieldName as String
  • property font as NSFontMBS
  • property fontColor as NSColorMBS
  • property Handle as Integer
  • property hasAppearanceStream as boolean
  • property iconType as Integer
  • property interiorColor as NSColorMBS
  • property isHighlighted as Boolean
  • property isPasswordField as Boolean
  • property ListChoice as Boolean
  • property markupType as Integer
  • property maximumLength as Integer
  • property modificationDate as date
  • property modificationDateTime as DateTime
  • property mouseUpAction as PDFActionMBS
  • property multiline as Boolean
  • property Open as Boolean
  • property page as PDFPageMBS
  • property popup as Variant
  • property radiosInUnison as Boolean
  • property ReadOnly as Boolean
  • property shouldDisplay as boolean
  • property shouldPrint as boolean
  • property stampName as String
  • property startLineStyle as Integer
  • property startPoint as NSPointMBS
  • property toolTip as string
  • property type as string
  • property URL as String
  • property userName as string
  • property widgetControlType as Integer
  • property widgetDefaultStringValue as String
  • property widgetFieldType as String
  • property widgetStringValue as String
• 22 methods
  • method addBezierPath(path as NSBezierPathMBS)
  • method choices as string()
  • method Constructor   Private
  • method Constructor(Handle as Integer)
  • method Constructor(left as Double, top as Double, width as Double, height as Double)
  • method Constructor(left as Double, top as Double, width as Double, height as Double, annotationType as String, properties as Dictionary = nil)
  • method copy as PDFAnnotationMBS
  • method Destructor
  • method drawWithBox(box as Integer)
  • method paths as NSBezierPathMBS()
  • method quadrilateralPoints as NSPointMBS()
  • method removeAllAppearanceStreams
  • method removeBezierPath(path as NSBezierPathMBS)
  • method removeValueForAnnotationKey(Key as String)
  • method setBooleanValue(Key as String, value as Boolean) as Boolean
  • method setChoices(choices() as string)
  • method setQuadrilateralPoints(points() as NSPointMBS)
  • method setRectValue(Key as String, value as NSRectMBS) as Boolean
  • method setValue(Key as String, value as Variant) as Boolean
  • method setValues(values() as string)
  • method valueForAnnotationKey(Key as String) as Variant
  • method values as string()
• 78 shared methods
  • shared method lineStyleFromName(Name as String) as Integer
  • shared method nameForLineStyle(LineStyle as Integer) as String
  • shared method PDFAnnotationHighlightingModeInvert as String
  • shared method PDFAnnotationHighlightingModeNone as String
  • shared method PDFAnnotationHighlightingModeOutline as String
  • shared method PDFAnnotationHighlightingModePush as String
  • shared method PDFAnnotationKeyAction as String
  • shared method PDFAnnotationKeyAdditionalActions as String
  • shared method PDFAnnotationKeyAppearanceDictionary as String
  • shared method PDFAnnotationKeyAppearanceState as String
  • shared method PDFAnnotationKeyBorder as String
  • shared method PDFAnnotationKeyBorderStyle as String
  • shared method PDFAnnotationKeyColor as String
  • shared method PDFAnnotationKeyContents as String
  • shared method PDFAnnotationKeyDate as String
  • shared method PDFAnnotationKeyDefaultAppearance as String
  • shared method PDFAnnotationKeyDestination as String
  • shared method PDFAnnotationKeyFlags as String
  • shared method PDFAnnotationKeyHighlightingMode as String
  • shared method PDFAnnotationKeyIconName as String
  • shared method PDFAnnotationKeyInklist as String
  • shared method PDFAnnotationKeyInteriorColor as String
  • shared method PDFAnnotationKeyLineEndingStyles as String
  • shared method PDFAnnotationKeyLinePoints as String
  • shared method PDFAnnotationKeyName as String
  • shared method PDFAnnotationKeyOpen as String
  • shared method PDFAnnotationKeyPage as String
  • shared method PDFAnnotationKeyParent as String
  • shared method PDFAnnotationKeyPopup as String
  • shared method PDFAnnotationKeyQuadding as String
  • shared method PDFAnnotationKeyQuadPoints as String
  • shared method PDFAnnotationKeyRect as String
  • shared method PDFAnnotationKeySubtype as String
  • shared method PDFAnnotationKeyTextLabel as String
  • shared method PDFAnnotationKeyWidgetAppearanceDictionary as String
  • shared method PDFAnnotationKeyWidgetBackgroundColor as String
  • shared method PDFAnnotationKeyWidgetBorderColor as String
  • shared method PDFAnnotationKeyWidgetCaption as String
  • shared method PDFAnnotationKeyWidgetDefaultValue as String
  • shared method PDFAnnotationKeyWidgetDownCaption as String
  • shared method PDFAnnotationKeyWidgetFieldFlags as String
  • shared method PDFAnnotationKeyWidgetFieldType as String
  • shared method PDFAnnotationKeyWidgetMaxLen as String
  • shared method PDFAnnotationKeyWidgetOptions as String
  • shared method PDFAnnotationKeyWidgetRolloverCaption as String
  • shared method PDFAnnotationKeyWidgetRotation as String
  • shared method PDFAnnotationKeyWidgetTextLabelUI as String
  • shared method PDFAnnotationKeyWidgetValue as String
  • shared method PDFAnnotationLineEndingStyleCircle as String
  • shared method PDFAnnotationLineEndingStyleClosedArrow as String
  • shared method PDFAnnotationLineEndingStyleDiamond as String
  • shared method PDFAnnotationLineEndingStyleNone as String
  • shared method PDFAnnotationLineEndingStyleOpenArrow as String
  • shared method PDFAnnotationLineEndingStyleSquare as String
  • shared method PDFAnnotationSubtypeCircle as String
  • shared method PDFAnnotationSubtypeFreeText as String
  • shared method PDFAnnotationSubtypeHighlight as String
  • shared method PDFAnnotationSubtypeInk as String
  • shared method PDFAnnotationSubtypeLine as String
  • shared method PDFAnnotationSubtypeLink as String
  • shared method PDFAnnotationSubtypePopup as String
  • shared method PDFAnnotationSubtypeSquare as String
  • shared method PDFAnnotationSubtypeStamp as String
  • shared method PDFAnnotationSubtypeStrikeOut as String
  • shared method PDFAnnotationSubtypeText as String
  • shared method PDFAnnotationSubtypeUnderline as String
  • shared method PDFAnnotationSubtypeWidget as String
  • shared method PDFAnnotationTextIconTypeComment as String
  • shared method PDFAnnotationTextIconTypeHelp as String
  • shared method PDFAnnotationTextIconTypeInsert as String
  • shared method PDFAnnotationTextIconTypeKey as String
  • shared method PDFAnnotationTextIconTypeNewParagraph as String
  • shared method PDFAnnotationTextIconTypeNote as String
  • shared method PDFAnnotationTextIconTypeParagraph as String
  • shared method PDFAnnotationWidgetSubtypeButton as String
  • shared method PDFAnnotationWidgetSubtypeChoice as String
  • shared method PDFAnnotationWidgetSubtypeSignature as String
  • shared method PDFAnnotationWidgetSubtypeText as String

This class has no sub classes.

Blog Entries

• MBS Xojo Plugins, version 22.1pr3

Release notes

• Version 22.1
  • Changed NSCenterTextAlignment and NSRightTextAlignment to from constants to shared methods to return correct values for PDFAnnotationTextWidgetMBS, NSParagraphStyleMBS, NSTextMBS and PDFAnnotationFreeTextMBS classes.

The items on this page are in the following plugins: MBS PDFKit Plugin.

PDFAnnotationCircleMBS   -   PDFAnnotationInkMBS