Oracle® Outside In Viewer for ActiveX Developer’s Guide Release 8.4.0 E12847-03 September 2012 Oracle Outside In Viewer for ActiveX Developer's Guide, Release 8.4.0 E12847-03 Copyright © 2012, Oracle and/or its affiliates. All rights reserved. Primary Author: Mike Manier This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services. Contents Preface................................................................................................................................................................. xi Audience....................................................................................................................................................... xi Documentation Accessibility..................................................................................................................... xi Related Documents..................................................................................................................................... xi Conventions................................................................................................................................................. xi 1 Introduction 1.1 What’s New in Release 8.4.0...................................................................................................... 1-1 1.2 What Does the Outside In Viewer for ActiveX Do?.............................................................. 1-3 1.3 Definition of Terms..................................................................................................................... 1-4 1.4 Directory Structure..................................................................................................................... 1-4 2 Getting Started 2.1 Installation and System Requirements.................................................................................... 2-1 2.1.1 NSF Support......................................................................................................................... 2-2 2.1.2 Options and Information Storage...................................................................................... 2-2 2.1.3 Getting Started With Visual Basic 6.0............................................................................... 2-2 2.1.4 Getting Started With Visual C++....................................................................................... 2-3 2.1.5 Getting Started with .NET Applications.......................................................................... 2-3 2.2 Installing the ActiveX Control as Part of Your Application................................................. 2-3 2.3 Libraries and Structure............................................................................................................... 2-4 2.4 Samples Overview...................................................................................................................... 2-6 3 Viewing Documents 3.1 Displaying Documents............................................................................................................... 3-1 3.1.1 Special Considerations........................................................................................................ 3-2 3.1.2 Notifications......................................................................................................................... 3-2 3.2 Printing......................................................................................................................................... 3-4 3.3 Clipboard..................................................................................................................................... 3-6 4 User Interface Options 4.1 Text Selection............................................................................................................................... 4-1 4.2 Menus........................................................................................................................................... 4-2 4.3 Dialogs.......................................................................................................................................... 4-4 iii 4.4 Scroll Bars.................................................................................................................................. 4-10 4.5 Miscellaneous........................................................................................................................... 4-12 4.6 Display Engine Options.......................................................................................................... 4-14 5 Searching Documents 5.1 Searching...................................................................................................................................... 5-1 5.2 Positions....................................................................................................................................... 5-2 5.3 Annotations.................................................................................................................................. 5-4 5.4 Raw Text....................................................................................................................................... 5-9 6 Advanced Topics 6.1 Drawing Pages............................................................................................................................ 6-1 6.2 Memory IO................................................................................................................................... 6-3 6.3 Redirected IO............................................................................................................................... 6-4 7 Miscellaneous Topics 7.1 System Read Ahead.................................................................................................................... 7-1 7.2 Errors............................................................................................................................................ 7-1 A SDK Reference A.1 Quick Reference......................................................................................................................... A-1 A.1.1 Viewing Documents........................................................................................................... A-1 A.1.1.1 Selecting Files............................................................................................................... A-1 A.1.1.2 Printing.......................................................................................................................... A-2 A.1.1.3 Clipboard...................................................................................................................... A-2 A.1.2 User Interface Options....................................................................................................... A-2 A.1.2.1 Text Selection............................................................................................................... A-2 A.1.2.2 Menus............................................................................................................................ A-2 A.1.2.3 Dialogs........................................................................................................................... A-3 A.1.2.4 Scroll Bar Interaction................................................................................................... A-3 A.1.2.5 Miscellaneous............................................................................................................... A-3 A.1.3 Display Engine Options..................................................................................................... A-3 A.1.3.1 Formatting.................................................................................................................... A-3 A.1.3.2 Image............................................................................................................................. A-4 A.1.3.3 Word Processing.......................................................................................................... A-4 A.1.3.4 Archive Options........................................................................................................... A-4 A.1.3.5 Database/Spreadsheets.............................................................................................. A-5 A.1.3.6 Searching....................................................................................................................... A-5 A.1.3.7 Positions........................................................................................................................ A-5 A.1.3.8 Annotations.................................................................................................................. A-6 A.1.3.9 Raw Text....................................................................................................................... A-6 A.1.4 Advanced Topics................................................................................................................ A-6 A.1.4.1 Drawing Pages............................................................................................................. A-6 A.1.4.2 Memory I/O................................................................................................................. A-6 A.1.4.3 Redirected I/O............................................................................................................. A-7 A.1.4.4 System........................................................................................................................... A-7 iv A.1.5 Miscellaneous...................................................................................................................... A-7 A.1.5.1 Errors............................................................................................................................. A-7 A.2 Properties.................................................................................................................................... A-7 A.2.1 AnnotationData................................................................................................................... A-7 A.2.2 AnnotationDataType.......................................................................................................... A-8 A.2.3 AnnotationEndPos.............................................................................................................. A-8 A.2.4 AnnotationId....................................................................................................................... A-8 A.2.5 AnnotationStartPos............................................................................................................ A-9 A.2.6 AntiAliasMode.................................................................................................................... A-9 A.2.7 ArchiveSortDescending..................................................................................................... A-9 A.2.8 ArchiveSortOrder............................................................................................................... A-9 A.2.9 BMPDither......................................................................................................................... A-10 A.2.10 BMPDitherAvailable........................................................................................................ A-10 A.2.11 BMPFitMode...................................................................................................................... A-11 A.2.12 BMPPrintAspect................................................................................................................ A-11 A.2.13 BMPPrintBorder................................................................................................................ A-12 A.2.14 BMPRotation..................................................................................................................... A-12 A.2.15 ClipFont.............................................................................................................................. A-12 A.2.16 ClipInfo............................................................................................................................... A-13 A.2.17 CopyBuffer......................................................................................................................... A-13 A.2.18 CopyBufferSize................................................................................................................. A-13 A.2.19 CurrentPageNumber........................................................................................................ A-14 A.2.20 DBClipBoard...................................................................................................................... A-14 A.2.21 DBDraftMode.................................................................................................................... A-14 A.2.22 DBFieldNamesToClip...................................................................................................... A-15 A.2.23 DBPrintFit.......................................................................................................................... A-15 A.2.24 DBPrintGridLines............................................................................................................. A-16 A.2.25 DBPrintHeadings.............................................................................................................. A-16 A.2.26 DBShowGridLines............................................................................................................ A-16 A.2.27 DefaultInputCharSet........................................................................................................ A-17 A.2.28 DialogFlags........................................................................................................................ A-17 A.2.29 DisplayEngineName........................................................................................................ A-18 A.2.30 DisplayEngineType.......................................................................................................... A-18 A.2.31 DisplayFont....................................................................................................................... A-19 A.2.32 DoContextMenu................................................................................................................ A-19 A.2.33 DocumentMemoryMode................................................................................................. A-19 A.2.34 EMailViewDisabled.......................................................................................................... A-20 A.2.35 EnableDragNDrop............................................................................................................ A-20 A.2.36 ErrorCode........................................................................................................................... A-21 A.2.37 ErrorMsg............................................................................................................................ A-21 A.2.38 ErrorShowMsg.................................................................................................................. A-21 A.2.39 FallbackFormat.................................................................................................................. A-21 A.2.40 FIFlags................................................................................................................................ A-22 A.2.41 FileInfoDisplayName....................................................................................................... A-23 A.2.42 FileInfoFileId..................................................................................................................... A-23 A.2.43 FileInfoFileIdName........................................................................................................... A-23 A.2.44 FileInfoName..................................................................................................................... A-23 v A.2.45 FilterOptions...................................................................................................................... A-24 A.2.46 FontScalingFactor............................................................................................................. A-25 A.2.47 FormatFlags....................................................................................................................... A-25 A.2.48 HScrollbar.......................................................................................................................... A-25 A.2.49 HTMLCondCommentMode............................................................................................ A-26 A.2.50 ImgXZoomPercent............................................................................................................ A-26 A.2.51 ImgYZoomPercent............................................................................................................ A-26 A.2.52 IntlFlags.............................................................................................................................. A-27 A.2.53 PageFormatHeight............................................................................................................ A-27 A.2.54 PageFormatWidth............................................................................................................. A-27 A.2.55 PagePaletteHandle............................................................................................................ A-28 A.2.56 PagePicture........................................................................................................................ A-28 A.2.57 PageResultBottom............................................................................................................. A-28 A.2.58 PageResultLeft................................................................................................................... A-29 A.2.59 PageResultRight................................................................................................................ A-29 A.2.60 PageResultTop................................................................................................................... A-29 A.2.61 PageUnitsPerInch............................................................................................................. A-29 A.2.62 ParseXMPMetadata.......................................................................................................... A-30 A.2.63 PrintCollate........................................................................................................................ A-30 A.2.64 PrintCopies........................................................................................................................ A-30 A.2.65 PrintEndPage..................................................................................................................... A-31 A.2.66 PrinterDC........................................................................................................................... A-31 A.2.67 PrinterDriver..................................................................................................................... A-31 A.2.68 PrinterName...................................................................................................................... A-32 A.2.69 PrinterPort......................................................................................................................... A-32 A.2.70 PrintFont............................................................................................................................ A-32 A.2.71 PrintJobName.................................................................................................................... A-32 A.2.72 PrintMarginLeft, Right, Top, and Bottom..................................................................... A-33 A.2.73 PrintStartPage.................................................................................................................... A-33 A.2.74 RawTextCharSet............................................................................................................... A-33 A.2.75 RawTextLength................................................................................................................. A-34 A.2.76 RawTextOffset................................................................................................................... A-34 A.2.77 RawTextString................................................................................................................... A-34 A.2.78 ReorderMethod................................................................................................................. A-34 A.2.79 ResourceLibraryID........................................................................................................... A-35 A.2.80 SelectionAnchor................................................................................................................ A-35 A.2.81 SelectionEnd...................................................................................................................... A-36 A.2.82 SSClipBoard....................................................................................................................... A-36 A.2.83 SSDraftMode..................................................................................................................... A-36 A.2.84 SSPrintDirection................................................................................................................ A-37 A.2.85 SSPrintFit............................................................................................................................ A-37 A.2.86 SSPrintGridLines.............................................................................................................. A-38 A.2.87 SSPrintHeadings............................................................................................................... A-38 A.2.88 SSPrintScalePercent.......................................................................................................... A-38 A.2.89 SSPrintScaleXHigh............................................................................................................ A-39 A.2.90 SSPrintScaleXWide........................................................................................................... A-39 A.2.91 SSRowColNamesToClip.................................................................................................. A-39 vi A.2.92 SSShowGridLines............................................................................................................. A-39 A.2.93 SSShowHiddenCells......................................................................................................... A-40 A.2.94 StatusEvents...................................................................................................................... A-40 A.2.95 SysLotusNotesPath........................................................................................................... A-41 A.2.96 SystemRawText................................................................................................................. A-41 A.2.97 SystemReadAhead............................................................................................................ A-41 A.2.98 SystemTimer...................................................................................................................... A-42 A.2.99 SystemUnicode.................................................................................................................. A-42 A.2.100 TimeZoneOffset................................................................................................................ A-43 A.2.101 ToClipboard....................................................................................................................... A-43 A.2.102 UnmappableChar............................................................................................................. A-44 A.2.103 UseDocPageSettings......................................................................................................... A-44 A.2.104 VecFitMode........................................................................................................................ A-44 A.2.105 VecPrintAspect.................................................................................................................. A-45 A.2.106 VecPrintBackground........................................................................................................ A-45 A.2.107 VecPrintBorder.................................................................................................................. A-46 A.2.108 VecShowBackground....................................................................................................... A-46 A.2.109 VScrollbar........................................................................................................................... A-46 A.2.110 WhatToPrint...................................................................................................................... A-47 A.2.111 WPDisplayMode............................................................................................................... A-47 A.2.112 WPEmailHeaderOutputMode........................................................................................ A-48 A.2.113 WPFitMode........................................................................................................................ A-49 A.2.114 WPWrapToWindow......................................................................................................... A-49 A.3 Methods..................................................................................................................................... A-49 A.3.1 AddAnnotationHideText................................................................................................ A-49 A.3.2 AddAnnotationHilite....................................................................................................... A-50 A.3.3 AddAnnotationInsertText............................................................................................... A-52 A.3.4 AddAnnotationPicture.................................................................................................... A-52 A.3.5 AnnotationSetPos............................................................................................................. A-53 A.3.6 ArchiveSave....................................................................................................................... A-54 A.3.7 Clear.................................................................................................................................... A-54 A.3.8 ClearAnnotations.............................................................................................................. A-54 A.3.9 ClipboardOptions............................................................................................................. A-55 A.3.10 ComparePositions............................................................................................................. A-55 A.3.11 Copy.................................................................................................................................... A-56 A.3.12 CopyPosition..................................................................................................................... A-56 A.3.13 CopyToClip....................................................................................................................... A-57 A.3.14 DeinitDrawPage................................................................................................................ A-57 A.3.15 DisplayOptions................................................................................................................. A-57 A.3.16 DisplayPosition................................................................................................................. A-58 A.3.17 DrawPage........................................................................................................................... A-58 A.3.18 DrawPageEx...................................................................................................................... A-59 A.3.19 ExtDrawPage..................................................................................................................... A-60 A.3.20 FindAnnotation................................................................................................................. A-61 A.3.21 FindPosition....................................................................................................................... A-62 A.3.22 GetActualCount................................................................................................................ A-64 A.3.23 GetAnnotationData.......................................................................................................... A-64 vii A.3.24 GetCustomEMailHeader................................................................................................. A-64 A.3.25 GetDrawPageInfo............................................................................................................. A-65 A.3.26 GetProperty....................................................................................................................... A-66 A.3.27 GetRawText....................................................................................................................... A-67 A.3.28 GoToAnnotation............................................................................................................... A-67 A.3.29 HiliteStyle........................................................................................................................... A-68 A.3.30 HScroll................................................................................................................................ A-69 A.3.31 IdleBitmap.......................................................................................................................... A-69 A.3.32 ImgShowFullScreen.......................................................................................................... A-70 A.3.33 ImgZoom............................................................................................................................ A-70 A.3.34 InitDrawPage..................................................................................................................... A-71 A.3.35 PrintOI................................................................................................................................ A-71 A.3.36 PrintOptions...................................................................................................................... A-72 A.3.37 PrintSetup.......................................................................................................................... A-73 A.3.38 Search.................................................................................................................................. A-73 A.3.39 SearchNext......................................................................................................................... A-74 A.3.40 SelectAll.............................................................................................................................. A-75 A.3.41 SetActualCount................................................................................................................. A-75 A.3.42 SetCustomEmailHeader.................................................................................................. A-76 A.3.43 SetPositionToCurrent....................................................................................................... A-77 A.3.44 SetPositionToSelection..................................................................................................... A-77 A.3.45 SystemIdle.......................................................................................................................... A-77 A.3.46 ViewFile............................................................................................................................. A-78 A.3.47 VScroll................................................................................................................................ A-79 A.4 Events......................................................................................................................................... A-80 A.4.1 AnnotationEvent............................................................................................................... A-80 A.4.2 Close................................................................................................................................... A-80 A.4.3 ContextMenu..................................................................................................................... A-81 A.4.4 DisplayEngineChange..................................................................................................... A-81 A.4.5 DoHelp............................................................................................................................... A-81 A.4.6 EnableApp......................................................................................................................... A-82 A.4.7 Error.................................................................................................................................... A-82 A.4.8 FileChange......................................................................................................................... A-82 A.4.9 GenSecond......................................................................................................................... A-83 A.4.10 GetCredentials................................................................................................................... A-83 A.4.11 GetInfo................................................................................................................................ A-84 A.4.12 GetTechPath...................................................................................................................... A-85 A.4.13 HScrollPageSize................................................................................................................ A-85 A.4.14 HScrollPosition.................................................................................................................. A-85 A.4.15 HScrollRange..................................................................................................................... A-86 A.4.16 HScrollState....................................................................................................................... A-86 A.4.17 Keydown............................................................................................................................ A-86 A.4.18 Open................................................................................................................................... A-87 A.4.19 OptionChange................................................................................................................... A-87 A.4.20 PrinterAbort....................................................................................................................... A-87 A.4.21 RawTextEvent................................................................................................................... A-88 A.4.22 Read.................................................................................................................................... A-88 viii A.4.23 ReadAheadDone............................................................................................................... A-89 A.4.24 Seek..................................................................................................................................... A-89 A.4.25 SelChange.......................................................................................................................... A-89 A.4.26 Stat....................................................................................................................................... A-90 A.4.27 Tell....................................................................................................................................... A-90 A.4.28 ViewThisFile...................................................................................................................... A-90 A.4.29 VScrollPageSize................................................................................................................. A-91 A.4.30 VScrollPosition.................................................................................................................. A-91 A.4.31 VScrollRange..................................................................................................................... A-91 A.4.32 VScrollRangeMin.............................................................................................................. A-91 A.4.33 VScrollRangeMax............................................................................................................. A-92 A.4.34 VScrollState........................................................................................................................ A-92 B Copyrights and Licensing B.1 Outside In Viewer for ActiveX Licensing............................................................................... B-1 Index ix x
Description: