Document management -- ECMAScript for PDF

This document defines a set of ECMAScript object types for automating and interacting with PDF documents and the contents of such documents.

Gestion de documents -- ECMAScript pour PDF

General Information

Status
Published
Publication Date
15-Dec-2020
Current Stage
5060 - Close of voting Proof returned by Secretariat
Start Date
11-Nov-2020
Completion Date
11-Nov-2020
Ref Project

Buy Standard

Standard
ISO 21757-1:2020 - Document management -- ECMAScript for PDF
English language
253 pages
sale 15% off
Preview
sale 15% off
Preview
Draft
ISO/PRF 21757-1:Version 24-okt-2020 - Document management -- ECMAScript for PDF
English language
253 pages
sale 15% off
Preview
sale 15% off
Preview

Standards Content (sample)

INTERNATIONAL ISO
STANDARD 21757-1
First edition
2020-12
Document management — ECMAScript
for PDF —
Part 1:
Use of ISO 32000-2 (PDF 2.0)
Reference number
ISO 21757-1:2020(E)
ISO 2020
---------------------- Page: 1 ----------------------
ISO 21757-1:2020(E)
COPYRIGHT PROTECTED DOCUMENT
© ISO 2020

All rights reserved. Unless otherwise specified, or required in the context of its implementation, no part of this publication may

be reproduced or utilized otherwise in any form or by any means, electronic or mechanical, including photocopying, or posting

on the internet or an intranet, without prior written permission. Permission can be requested from either ISO at the address

below or ISO’s member body in the country of the requester.
ISO copyright office
CP 401 • Ch. de Blandonnet 8
CH-1214 Vernier, Geneva
Phone: +41 22 749 01 11
Email: copyright@iso.org
Website: www.iso.org
Published in Switzerland
ii © ISO 2020 – All rights reserved
---------------------- Page: 2 ----------------------
ISO 21757-1:2020(E)
Contents Page

Foreword ........................................................................................................................................................................................................................................ix

Introduction ..................................................................................................................................................................................................................................x

1 Scope ................................................................................................................................................................................................................................. 1

2 Normative references ...................................................................................................................................................................................... 1

3 Terms and definitions ..................................................................................................................................................................................... 1

4 Notation ......................................................................................................................................................................................................................... 1

5 Syntax ............................................................................................................................................................................................................................... 2

5.1 General ........................................................................................................................................................................................................... 2

5.2 Method arguments............................................................................................................................................................................... 2

6 Paths .................................................................................................................................................................................................................................. 2

7 Safe path ........................................................................................................................................................................................................................ 2

8 Privileged context ................................................................................................................................................................................................ 3

9 Privileged versus non-privileged context ................................................................................................................................... 3

10 ECMAScript API ...................................................................................................................................................................................................... 3

10.1 General ........................................................................................................................................................................................................... 3

10.2 Annotation .................................................................................................................................................................................................. 3

10.2.1 General...................................................................................................................................................................................... 3

10.2.2 Annotation types ............................................................................................................................................................. 4

10.2.3 Annotation properties ........................................................................................................................................... ...... 5

10.2.4 Annotation methods ..................................................................................................................................................13

10.2.5 Annotation examples ................................................................................................................................................15

10.3 AnnotRichMedia .................................................................................................................................................................................17

10.3.1 General...................................................................................................................................................................................17

10.3.2 AnnotRichMedia properties ................................................................................................................................17

10.4 Annot3D .....................................................................................................................................................................................................17

10.4.1 General...................................................................................................................................................................................17

10.4.2 Annot3D properties ...................................................................................................................................................17

10.5 app ..................................................................................................................................................................................................................18

10.5.1 General...................................................................................................................................................................................18

10.5.2 app properties .................................................................................................................................................................18

10.5.3 app methods .....................................................................................................................................................................20

10.6 Bookmark .................................................................................................................................................................................................30

10.6.1 General...................................................................................................................................................................................30

10.6.2 Bookmark properties ................................................................................................................................................30

10.6.3 Bookmark methods ....................................................................................................................................................31

10.6.4 Bookmark Examples ..................................................................................................................................................32

10.7 Certificate .................................................................................................................................................................................................33

10.7.1 General...................................................................................................................................................................................33

10.7.2 Certificate properties ................................................................................................................................................34

10.8 color ...............................................................................................................................................................................................................36

10.8.1 General...................................................................................................................................................................................36

10.8.2 color arrays ........................................................................................................................................................................36

10.8.3 color properties .............................................................................................................................................................36

10.8.4 color methods ..................................................................................................................................................................37

10.9 collection ...................................................................................................................................................................................................38

10.9.1 General...................................................................................................................................................................................38

10.9.2 collection properties .................................................................................................................................................38

10.9.3 collection methods ......................................................................................................................................................38

10.10 collectionField ......................................................................................................................................................................................40

10.10.1 General...................................................................................................................................................................................40

© ISO 2020 – All rights reserved iii
---------------------- Page: 3 ----------------------
ISO 21757-1:2020(E)

10.10.2 collectionField properties .....................................................................................................................................40

10.11 Data ................................................................................................................................................................................................................41

10.11.1 General...................................................................................................................................................................................41

10.11.2 Data properties ..............................................................................................................................................................42

10.11.3 Data methods ...................................................................................................................................................................42

10.12 Dialog ...........................................................................................................................................................................................................43

10.12.1 General...................................................................................................................................................................................43

10.12.2 Dialog methods ..............................................................................................................................................................43

10.13 Doc ..................................................................................................................................................................................................................44

10.13.1 General...................................................................................................................................................................................44

10.13.2 Doc properties ................................................................................................................................................................45

10.13.3 Doc methods .....................................................................................................................................................................49

10.14 Embedded PDF ....................................................................................................................................................................................89

10.14.1 General...................................................................................................................................................................................89

10.14.2 Embedded PDF properties ...................................................................................................................................90

10.14.3 Embedded PDF methods .......................................................................................................................................91

10.15 Error ..............................................................................................................................................................................................................91

10.15.1 General...................................................................................................................................................................................91

10.15.2 Error properties ............................................................................................................................................................92

10.15.3 Error methods .................................................................................................................................................................92

10.16 event ..............................................................................................................................................................................................................93

10.16.1 General...................................................................................................................................................................................93

10.16.2 Event type/name combinations ......................................................................................................................93

10.16.3 Document Event Processing ...............................................................................................................................99

10.16.4 Form event processing ........................................................................................................................................... ..99

10.16.5 event properties .........................................................................................................................................................100

10.17 Field ............................................................................................................................................................................................................105

10.17.1 General................................................................................................................................................................................105

10.17.2 Field versus widget attributes .......................................................................................................................106

10.17.3 Field properties...........................................................................................................................................................106

10.17.4 Field methods ...............................................................................................................................................................118

10.18 FullScreen ..............................................................................................................................................................................................135

10.18.1 General................................................................................................................................................................................135

10.18.2 FullScreen properties ............................................................................................................................................135

10.19 global .........................................................................................................................................................................................................136

10.19.1 General................................................................................................................................................................................136

10.19.2 Creating global properties .................................................................................................................................136

10.19.3 Deleting global properties .................................................................................................................................137

10.19.4 Global object security policy ............................................................................................................................137

10.19.5 global object methods ...........................................................................................................................................137

10.20 HostContainer ....................................................................................................................................................................................138

10.20.1 General................................................................................................................................................................................138

10.20.2 HostContainer properties ..................................................................................................................................139

10.20.3 HostContainer methods .......................................................................................................................................140

10.21 Icon ..............................................................................................................................................................................................................141

10.21.1 General................................................................................................................................................................................141

10.21.2 icon Properties ............................................................................................................................................................141

10.22 Link .............................................................................................................................................................................................................141

10.22.1 General................................................................................................................................................................................141

10.22.2 Link properties ............................................................................................................................................................141

10.22.3 Link methods ................................................................................................................................................................142

10.23 Net ................................................................................................................................................................................................................142

10.23.1 General................................................................................................................................................................................142

10.23.2 Net properties ..............................................................................................................................................................142

10.23.3 Net methods ...................................................................................................................................................................144

10.24 OCG ..............................................................................................................................................................................................................146

10.24.1 General................................................................................................................................................................................146

10.24.2 OCG properties ............................................................................................................................................................146

iv © ISO 2020 – All rights reserved
---------------------- Page: 4 ----------------------
ISO 21757-1:2020(E)

10.24.3 OCG methods .................................................................................................................................................................147

10.25 PrintParams .........................................................................................................................................................................................148

10.25.1 General................................................................................................................................................................................148

10.25.2 PrintParams properties .......................................................................................................................................148

10.26 RDN .............................................................................................................................................................................................................151

10.26.1 General................................................................................................................................................................................151

10.26.2 RDN properties ...........................................................................................................................................................152

10.27 ReadStream ..........................................................................................................................................................................................152

10.27.1 General................................................................................................................................................................................152

10.27.2 ReadStream methods .............................................................................................................................................152

10.28 security ....................................................................................................................................................................................................153

10.28.1 General................................................................................................................................................................................153

10.28.2 security constants .....................................................................................................................................................153

10.28.3 security Properties ........................................................................................................................................... ........153

10.28.4 security Methods .......................................................................................................................................................154

10.29 SecurityHandler ...............................................................................................................................................................................157

10.29.1 General................................................................................................................................................................................157

10.29.2 SecurityHandler properties ..............................................................................................................................157

10.29.3 SecurityHandler methods ..................................................................................................................................160

10.30 SecurityPolicy ....................................................................................................................................................................................163

10.30.1 General................................................................................................................................................................................163

10.30.2 SecurityPolicy properties ...................................................................................................................................163

10.31 SignatureInfo ......................................................................................................................................................................................163

10.31.1 General................................................................................................................................................................................163

10.31.2 SignatureInfo Base properties .......................................................................................................................163

10.31.3 SignatureInfo object public key security handler properties..............................................165

10.31.4 Modification Detection and Prevention (MDP) Values .............................................................168

10.32 SOAP ...........................................................................................................................................................................................................168

10.32.1 General................................................................................................................................................................................168

10.32.2 SOAP properties .........................................................................................................................................................169

10.32.3 SOAP methods ..............................................................................................................................................................169

10.33 Span ............................................................................................................................................................................................................181

10.33.1 General................................................................................................................................................................................181

10.33.2 Span properties ...........................................................................................................................................................181

10.34 Template .................................................................................................................................................................................................183

10.34.1 General................................................................................................................................................................................183

10.34.2 Template properties ........................................................................................................................................... .....183

10.34.3 Template methods ....................................................................................................................................................183

10.35 Thermometer .....................................................................................................................................................................................184

10.35.1 General................................................................................................................................................................................184

10.35.2 Thermometer properties .....................................
...

INTERNATIONAL ISO
STANDARD 21757-1
First edition
Document management — ECMAScript
for PDF —
Part 1:
Use of ISO 32000-2 (PDF 2.0)
PROOF/ÉPREUVE
Reference number
ISO 21757-1:2020(E)
ISO 2020
---------------------- Page: 1 ----------------------
ISO 21757-1:2020(E)
COPYRIGHT PROTECTED DOCUMENT
© ISO 2020

All rights reserved. Unless otherwise specified, or required in the context of its implementation, no part of this publication may

be reproduced or utilized otherwise in any form or by any means, electronic or mechanical, including photocopying, or posting

on the internet or an intranet, without prior written permission. Permission can be requested from either ISO at the address

below or ISO’s member body in the country of the requester.
ISO copyright office
CP 401 • Ch. de Blandonnet 8
CH-1214 Vernier, Geneva
Phone: +41 22 749 01 11
Email: copyright@iso.org
Website: www.iso.org
Published in Switzerland
ii PROOF/ÉPREUVE © ISO 2020 – All rights reserved
---------------------- Page: 2 ----------------------
ISO 21757-1:2020(E)
Contents Page

Foreword ........................................................................................................................................................................................................................................ix

Introduction ..................................................................................................................................................................................................................................x

1 Scope ................................................................................................................................................................................................................................. 1

2 Normative references ...................................................................................................................................................................................... 1

3 Terms and definitions ..................................................................................................................................................................................... 1

4 Notation ......................................................................................................................................................................................................................... 1

5 Syntax ............................................................................................................................................................................................................................... 2

5.1 General ........................................................................................................................................................................................................... 2

5.2 Method arguments............................................................................................................................................................................... 2

6 Paths .................................................................................................................................................................................................................................. 2

7 Safe path ........................................................................................................................................................................................................................ 2

8 Privileged context ................................................................................................................................................................................................ 3

9 Privileged versus non-privileged context ................................................................................................................................... 3

10 ECMAScript API ...................................................................................................................................................................................................... 3

10.1 General ........................................................................................................................................................................................................... 3

10.2 Annotation .................................................................................................................................................................................................. 3

10.2.1 General...................................................................................................................................................................................... 3

10.2.2 Annotation types ............................................................................................................................................................. 4

10.2.3 Annotation properties ........................................................................................................................................... ...... 5

10.2.4 Annotation methods ..................................................................................................................................................13

10.2.5 Annotation examples ................................................................................................................................................15

10.3 AnnotRichMedia .................................................................................................................................................................................17

10.3.1 General...................................................................................................................................................................................17

10.3.2 AnnotRichMedia properties ................................................................................................................................17

10.4 Annot3D .....................................................................................................................................................................................................17

10.4.1 General...................................................................................................................................................................................17

10.4.2 Annot3D properties ...................................................................................................................................................17

10.5 app ..................................................................................................................................................................................................................18

10.5.1 General...................................................................................................................................................................................18

10.5.2 app properties .................................................................................................................................................................18

10.5.3 app methods .....................................................................................................................................................................20

10.6 Bookmark .................................................................................................................................................................................................30

10.6.1 General...................................................................................................................................................................................30

10.6.2 Bookmark properties ................................................................................................................................................30

10.6.3 Bookmark methods ....................................................................................................................................................31

10.6.4 Bookmark Examples ..................................................................................................................................................32

10.7 Certificate .................................................................................................................................................................................................33

10.7.1 General...................................................................................................................................................................................33

10.7.2 Certificate properties ................................................................................................................................................34

10.8 color ...............................................................................................................................................................................................................36

10.8.1 General...................................................................................................................................................................................36

10.8.2 color arrays ........................................................................................................................................................................36

10.8.3 color properties .............................................................................................................................................................36

10.8.4 color methods ..................................................................................................................................................................37

10.9 collection ...................................................................................................................................................................................................38

10.9.1 General...................................................................................................................................................................................38

10.9.2 collection properties .................................................................................................................................................38

10.9.3 collection methods ......................................................................................................................................................38

10.10 collectionField ......................................................................................................................................................................................40

10.10.1 General...................................................................................................................................................................................40

© ISO 2020 – All rights reserved PROOF/ÉPREUVE iii
---------------------- Page: 3 ----------------------
ISO 21757-1:2020(E)

10.10.2 collectionField properties .....................................................................................................................................40

10.11 Data ................................................................................................................................................................................................................41

10.11.1 General...................................................................................................................................................................................41

10.11.2 Data properties ..............................................................................................................................................................42

10.11.3 Data methods ...................................................................................................................................................................42

10.12 Dialog ...........................................................................................................................................................................................................43

10.12.1 General...................................................................................................................................................................................43

10.12.2 Dialog methods ..............................................................................................................................................................43

10.13 Doc ..................................................................................................................................................................................................................44

10.13.1 General...................................................................................................................................................................................44

10.13.2 Doc properties ................................................................................................................................................................45

10.13.3 Doc methods .....................................................................................................................................................................49

10.14 Embedded PDF ....................................................................................................................................................................................89

10.14.1 General...................................................................................................................................................................................89

10.14.2 Embedded PDF properties ...................................................................................................................................90

10.14.3 Embedded PDF methods .......................................................................................................................................91

10.15 Error ..............................................................................................................................................................................................................91

10.15.1 General...................................................................................................................................................................................91

10.15.2 Error properties ............................................................................................................................................................92

10.15.3 Error methods .................................................................................................................................................................92

10.16 event ..............................................................................................................................................................................................................93

10.16.1 General...................................................................................................................................................................................93

10.16.2 Event type/name combinations ......................................................................................................................93

10.16.3 Document Event Processing ...............................................................................................................................99

10.16.4 Form event processing ........................................................................................................................................... ..99

10.16.5 event properties .........................................................................................................................................................100

10.17 Field ............................................................................................................................................................................................................105

10.17.1 General................................................................................................................................................................................105

10.17.2 Field versus widget attributes .......................................................................................................................106

10.17.3 Field properties...........................................................................................................................................................106

10.17.4 Field methods ...............................................................................................................................................................118

10.18 FullScreen ..............................................................................................................................................................................................135

10.18.1 General................................................................................................................................................................................135

10.18.2 FullScreen properties ............................................................................................................................................135

10.19 global .........................................................................................................................................................................................................136

10.19.1 General................................................................................................................................................................................136

10.19.2 Creating global properties .................................................................................................................................136

10.19.3 Deleting global properties .................................................................................................................................137

10.19.4 Global object security policy ............................................................................................................................137

10.19.5 global object methods ...........................................................................................................................................137

10.20 HostContainer ....................................................................................................................................................................................138

10.20.1 General................................................................................................................................................................................138

10.20.2 HostContainer properties ..................................................................................................................................139

10.20.3 HostContainer methods .......................................................................................................................................140

10.21 Icon ..............................................................................................................................................................................................................141

10.21.1 General................................................................................................................................................................................141

10.21.2 icon Properties ............................................................................................................................................................141

10.22 Link .............................................................................................................................................................................................................141

10.22.1 General................................................................................................................................................................................141

10.22.2 Link properties ............................................................................................................................................................141

10.22.3 Link methods ................................................................................................................................................................142

10.23 Net ................................................................................................................................................................................................................142

10.23.1 General................................................................................................................................................................................142

10.23.2 Net properties ..............................................................................................................................................................142

10.23.3 Net methods ...................................................................................................................................................................144

10.24 OCG ..............................................................................................................................................................................................................146

10.24.1 General................................................................................................................................................................................146

10.24.2 OCG properties ............................................................................................................................................................146

iv PROOF/ÉPREUVE © ISO 2020 – All rights reserved
---------------------- Page: 4 ----------------------
ISO 21757-1:2020(E)

10.24.3 OCG methods .................................................................................................................................................................147

10.25 PrintParams .........................................................................................................................................................................................148

10.25.1 General................................................................................................................................................................................148

10.25.2 PrintParams properties .......................................................................................................................................148

10.26 RDN .............................................................................................................................................................................................................151

10.26.1 General................................................................................................................................................................................151

10.26.2 RDN properties ...........................................................................................................................................................152

10.27 ReadStream ..........................................................................................................................................................................................152

10.27.1 General................................................................................................................................................................................152

10.27.2 ReadStream methods .............................................................................................................................................152

10.28 security ....................................................................................................................................................................................................153

10.28.1 General................................................................................................................................................................................153

10.28.2 security constants .....................................................................................................................................................153

10.28.3 security Properties ........................................................................................................................................... ........153

10.28.4 security Methods .......................................................................................................................................................154

10.29 SecurityHandler ...............................................................................................................................................................................157

10.29.1 General................................................................................................................................................................................157

10.29.2 SecurityHandler properties ..............................................................................................................................157

10.29.3 SecurityHandler methods ..................................................................................................................................160

10.30 SecurityPolicy ....................................................................................................................................................................................163

10.30.1 General................................................................................................................................................................................163

10.30.2 SecurityPolicy properties ...................................................................................................................................163

10.31 SignatureInfo ......................................................................................................................................................................................163

10.31.1 General................................................................................................................................................................................163

10.31.2 SignatureInfo Base properties .......................................................................................................................163

10.31.3 SignatureInfo object public key security handler properties..............................................165

10.31.4 Modification Detection and Prevention (MDP) Values .............................................................168

10.32 SOAP ...........................................................................................................................................................................................................168

10.32.1 General................................................................................................................................................................................168

10.32.2 SOAP properties .........................................................................................................................................................169

10.32.3 SOAP methods ..............................................................................................................................................................169

10.33 Span ............................................................................................................................................................................................................181

10.33.1 General................................................................................................................................................................................181

10.33.2 Span properties ...........................................................................................................................................................181

10.34 Template .................................................................................................................................................................................................183

10.34.1 General................................................................................................................................................................................183

10.34.2 Template properties ........................................................................................................................................... .....183

10.34.3 Template methods ....................................................................................................................................................183

10.35 Thermometer .....................................................................................................................................................................................184

10.35.1 General................................................................................................................................................................................184

10.35.2 Thermometer pro
...

Questions, Comments and Discussion

Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.