view pdf winform c# : Add links to pdf software SDK dll winforms wpf azure web forms wopi1-part1327

Office Online Integration Documentation, Release 2016.01.27
Office Online identity can be established by using a publicproofkey to decrypt part of the WOPI requests. Also, the
Office Online file cache indexes stored file contents by using a SHA256 hash as the cache key. You can pass Office
Online the hash value using theSHA256property in theCheckFileInforesponse. If not provided, Office Online will
generate a cache key from the file ID and version. To ensure that users can’t force a cache collision and view the
wrong file, nouser-provided information is used to generate the cache key.
1.1.5 Managing Office 365 subscriptions
Business users require an Office 365 subscription to edit files in Office Online. The simplest way to implement this
is to have users sign in with a Microsoft account or other valid identity. This establishes that they have the correct
subscription. To limit the numberof times a userneeds to sign in, Office Online first checks for a cookie.
To provide a better experience forusers with Office 365 subscriptions,hosts canoptionallyimplement thePutUserInfo
WOPI operation. SeeTrackingusers’subscriptionstatusfor more information.
1.1.6 Interested?
If you’re interested in integrating your solution with Office Online, take a moment to register atOffice365Cloud
Storage PartnerProgram.
1.2 What’s New
1.2.1 Version 2016.01.27
January 27,2016
• Office Online co-authoring is now supported across all WOPI hosts. SeeCo-authoringusingOfficeOnlinefor
more information.
• Severalnewendpoints and operations havebeenadded toWOPItosupport Office foriOS.Some documentation
is still in progress. SeeWOPIRESTAPIReferencefor more information.
Commits
• Add dedicated Office for iOS docs. by Tyler Butler at 2015-12-12 01:38:04
• Reorganize CheckFileInfo properties. by Tyler Butler at 2016-01-16 00:28:45
• Document new clientWOPI operations. by Tyler Butler at 2015-07-11 00:42:19
1.2.2 Version 2015.12.18
December 18, 2015
The documentation of the WOPI REST operations has been split from the Office Online integration documentation.
This was done to prepare for the expansion ofthe WOPI REST API that will come in a future commit.
Commits
• Split narrative docs from the REST docs. by Tyler Butler at 2015-11-04 23:35:31
1.2. What’s New
7
Add links to pdf - insert, remove PDF links in C#.net, ASP.NET, MVC, Ajax, WinForms, WPF
Free C# example code is offered for users to edit PDF document hyperlink (url), like inserting and deleting
add email link to pdf; pdf hyperlink
Add links to pdf - VB.NET PDF url edit library: insert, remove PDF links in vb.net, ASP.NET, MVC, Ajax, WinForms, WPF
Help to Insert a Hyperlink to Specified PDF Document Page
pdf reader link; add links pdf document
Office Online Integration Documentation, Release 2016.01.27
1.2.3 Version 2015.08.03
August 3,2015
Office Online now supports a new WOPI operation,PutUserInfo, as well as the following supportingCheckFileInfo
properties:
• SupportsUserInfo
• UserInfo
These operations and properties can be used to improve thesubscriptionverificationexperience for business users.
Commits
• Updatedversion of business editing docs. by Tyler Butler at 2015-06-12 18:47:31
1.3 Shipping your Office Online integration
Once you believe you are ready to ship your integration, you should contact Microsoft and ask to being the ‘go live’
process. This process will prepare you to ship your Office Online integration.
The ‘go live’ process consists of three phases:
1. Validation - Microsoft will validate your WOPI implementation as well as your UI integration. Depending
on what issues are uncovered during validation, this may take some time. You should estimate a two-week
turnaround time assuming there are no major issues uncovered. However, we recommend allowing at least a
monthunless your integration is very simple.
Important: You can avoid delays in validation by ensuring that your implementation is consistent with this
documentationand thattheWOPIValidationapplicationtests are passing beforebeginningthe ‘golive’process.
2. ProductionSmoke Test-Microsoft willenableyoutousetheproductionOffice Online environmentforsmoke-
testing. This should be basic testingperformed by the hostsince the productionenvironment is slightly different
than the test environment, and different issues may be uncovered. This can be as long or as short as the host
deems necessary. Typically a week is enough time,though it can be much shorter.
3. Sign off and roll out - Once Microsoft has signed off on your integration, you can begin to roll out to your
users. Depending onyour traffic estimates,Microsoft mayrequest that you rolloutover aperiodof several days
to ensure you do not overload Office Online oryour WOPIservers.
To manage this process, Microsoft will create a dedicatedTrello board to track issues and provide a common com-
munication channel between your team and Microsoft. You can learn more about how to use this Trello board in the
Using Trello to manage the ‘go live’ processsection.
Before starting the ‘go live’ process,you should readthe belowsections for an overview ofthe types ofquestions and
issues that you may need to address during the process.
1.3.1 Preparing for the ‘go live’ process
WOPI validation
As part of the validation process,Microsoft will test your WOPIimplementation using theWOPIValidationapplica-
tion.Allofthetestsinthefollowingcategoriesmustbepassing.
8
Chapter 1. How to read this documentation
C# PDF Convert to HTML SDK: Convert PDF to html files in C#.net
HTML converter toolkit SDK, preserves all the original anchors, links, bookmarks and to Use C#.NET Demo Code to Convert PDF Document to Add necessary references
adding an email link to a pdf; add links to pdf acrobat
.NET PDF Document Viewing, Annotation, Conversion & Processing
PDF Write. Insert text, text box into PDF. Edit, delete text from PDF. Insert images into PDF. Edit, remove images from PDF. Add, edit, delete links. Form Process
convert excel to pdf with hyperlinks; adding hyperlinks to pdf files
Office Online Integration Documentation, Release 2016.01.27
• HostFrameIntegration
• BaseWopi
• EditFlows
• Locks
• AccessTokens
• PutRelativeFile or PutRelativeFileUnsupported
Note: If you are implementingproofkeyvalidation, you should also check that the tests in the ProofKeys group are
passing.
Manual testing
In addition to checking the WOPI validation results, Microsoft will do some manual validation of scenarios that
cannot currently be tested using the WOPI validator. You should follow the steps in thetestingguide and fully test
these scenarios prior to starting the ‘go live’ process.
Test accounts
In ordertoenableyourWOPIhost touse OfficeOnline’sproductionenvironment,Microsoft willperformsome manual
validation of yourWOPI implementation and Office Online integration. This requires that you provide Microsoft test
accounts that they can use totest your integration.
Important: The provided test accounts must be able to test your Office Online integration. In addition, you must
provide a way for Microsoft to access theWOPIValidationapplicationusing these test accounts.
Once testaccounts are provided,Microsoftwill provide you witha rough time line tocomplete testing. Usually testing
can be completed within two weeks. However, this time line is subject to demand; if other partners are already being
tested it may take additional time for Microsoft to begin testing your implementation. In addition, if implementation
issues are uncovered during testing the process may take longer.
Business user flow test accounts
If you are using thebusinessuserflow, you will need test accounts from Microsoft in order to effectively test the flow
in theTestenvironment. See the Testingthebusinessuserflow section for more information.
WOPI implementation questionnaire
There are some aspects of your WOPI implementation that are particularly critical to the success of your integration.
In orderto verifythese parts of yourimplementation,Microsoft willaskyouto answersome questions regarding your
specific WOPI implementation. These questions are included below.
Note: This list of questions is subject to change. Microsoft will provide you with a specific list of questions as part
ofthe ‘go live’ process that may differ fromthe list below.
1.3. Shipping your Office Online integration
9
VB.NET PDF Convert to HTML SDK: Convert PDF to html files in vb.
Turn PDF images to HTML images in VB.NET. Embed PDF hyperlinks to HTML links in VB.NET. Convert PDF to HTML in VB.NET Demo Code. Add necessary references:
adding links to pdf; pdf link
C# PDF Convert to Word SDK: Convert PDF to Word library in C#.net
the original text style (including font, size, color, links and boldness). C#.NET DLLs and Demo Code: Convert PDF to Word Document in C# Add necessary references
add hyperlink to pdf; pdf link to attached file
Office Online Integration Documentation, Release 2016.01.27
1. Please confirm that your File IDs meet thecriterialistedinthedocumentation. Office Online expects file IDs
to be unique and consistent over time, as well as when accessed by different users or via different UI paths
(e.g. a given file might be available in two different parts of your UI, such as in a typical folder and also in
search results. Ifthe document is meant to be the same, then the file IDs shouldmatch. Otherwise users will see
unexpected behaviorwhen they access the same file via different UI paths).
2. Please confirm you’re providing a user ID using theUserIdfield and that the ID is unique and consistent over
timeasdescribedhere.
3. Please confirm that the value in theOwnerIdfieldrepresents the user who owns the documentand is unique and
consistent over timeasdescribedhere.
4. Are you sending theSHA256value inCheckFileInfo? If not, please confirm that your version numbers change
for each file version.
5. Under what conditions do you create new versions of files? Hosts often do this either when a file is unlocked or
whenever aPutFileis received -either of these options is appropriate.
6. Are you using thebusinessuserflow?
7. WhatWOPIhostcapabilitiespropertiesare you passing inCheckFileInfo?
8. WOPI access tokens are currently provided in both theAuthorizationheader and on the WOPI URL in the
access_token parameter. Which of these are you using?
9. Do you use IPv6 in your datacenters?
Production settings check
Prior to enabling your integration in the productionenvironment, Microsoft will ask you to verify your current
Microsoft-configured settings,includingyourentriesinthe WOPI domain allow listand Redirect domain allow list.
Important: Rememberthat changes to production settings require time to make.
Any changes to Microsoft-configured settings must be communicated to Microsoft by 7PM UTC on Wednesday
in order to take effect in the production environment the following week.
Service management contacts
Office Online is a worldwide cloud service, and is thus monitored at all times. As part of the ‘go live’ process,
Microsoft will provide you with information regarding how to escalate service quality issues with Office Online’s
on-call engineers.
In order to use theproductionenvironment, you must also provide a contact for Microsoft’s on-callengineers to reach
if Office Online detects an issue that we suspect is due to a problem on the host side. For example, Office Online’s
monitoring systems might detect errorrates for sessions spiking, and the on-call engineerwouldcontact the host to see
ifit’s a known issue on the host side. Ideally this emergency contact can be reached 24x7, eitherby phone or email.
Rollout schedule and traffic estimates
Typically Microsoft asks partners to roll out over a period of time - between a few days to two weeks - depending on
the anticipated traffic. For smaller hosts this is not always necessary. If you’re already planning on doing this, you
should communicate the schedule to Microsoft (i.e. 10% day 1, 50% day 2, etc.). If you’re not, you must coordinate
with Microsoft to ensure this is appropriate given your traffic estimates.
10
Chapter 1. How to read this documentation
How to C#: Basic SDK Concept of XDoc.PDF for .NET
You may add PDF document protection functionality into your C# program. to edit hyperlink of PDF document, including editing PDF url links and quick
add link to pdf file; add hyperlinks to pdf
C# Create PDF Library SDK to convert PDF from other file formats
PDF with a blank page, bookmarks, links, signatures, etc. PDF document in C#.NET using this PDF document creating toolkit, if you need to add some text
pdf link to specific page; clickable pdf links
Office Online Integration Documentation, Release 2016.01.27
In order to best plan the rollout, you should be prepared to provide Microsoft with updated traffic estimates. Ideally
these will be broken down by view/edit,file type,and geography, but provide whatever you can.
Production access
Once you and Microsoft have agreed on a rollout plan and Microsoft has signed off on your WOPI implementation,
your WOPI host will be enabled in theproductionenvironment. You should plan to do some basic testing against the
production environment prior to rollout to ensure there are no unique issues using that environment. Once you have
completed that testing, you can roll yourintegration out to users according the agreed-upon rollout schedule.
1.4 Using Trello to manage the ‘go live’ process
To manage the overall ‘go live’ process,including testing and validation, Microsoft uses a service calledTrello. Once
you have started the ‘go live’ process, Microsoft will create a dedicated Trello board to track issues and provide
acommon communication channel between your team and Microsoft. The board will be pre-populated with cards
tracking various questions about your WOPI implementation as well as discussion cards to determine launch dates,
etc.
If you are new to Trello,you can learn more about it athttps://trello.com/guide/.
Important: You should use the Trello board to communicate with Microsoft throughout the ‘go live’ process. This
will ensure that all Office Online team members are aware of the communications, and it provides a straightforward
way to isolate conversations about specific issues.
1.4.1 Adding people to the board
You can invite other relevant people to the board as needed; only people fromthe Office Online teamand people you
explicitly invite will have access to see or edit the content ofthe board.
We recommend that you add relevant engineers from your team to the board as well, since many of the discussions
will be engineering-focused. You might add designers or business people to the board as well; simply add whomever
makes sense for your team.
See also:
Learn how to add more people to your board athttp://help.trello.com/article/717-adding-people-to-a-board.
1.4.2 Board structure
The board structure is fairly basic. There are seven lists, and you can move cards between the lists as needed. The
lists serve two main purposes. First, they keep issues organized at a high level, so it is easy to see what issues are
being investigated and what has been resolved, etc. In addition, the lists provide a simple way to configure Trello’s
notifications such that both you and Microsoft are aware of what requires attention.
1. Reference: This listcontainscards that have reference information,suchas currenttestaccounts forthebusiness
user floworknownissuesthatmayaffectyourtesting.
2. New: Microsoft: This list contains newcards that Microsoftneeds tobe aware of. You should add cards to this
list to ensure itis brought to Microsoft’s attention. Any card on this list represents something that Microsoft has
not yet acknowledged or taken action on. Once Microsoft is aware of the card, it will be moved to another list
like Under Discussion/Investigation for action.
1.4. Using Trello to manage the ‘go live’ process
11
VB.NET PDF: Basic SDK Concept of XDoc.PDF
You may add PDF document protection functionality into your VB.NET program. to edit hyperlink of PDF document, including editing PDF url links and quick
active links in pdf; add links to pdf in preview
C# Image: Tutorial for Document Management Using C#.NET Imaging
more detailed C# tutorials on each part by following the links respectively are dedicated to provide powerful & profession imaging controls, PDF document, image
pdf edit hyperlink; add page number to pdf hyperlink
Office Online Integration Documentation, Release 2016.01.27
Figure 1.3: Example partner‘go live’ board
3. New: Partner: This list contains new cards thatyou, the Office Online partner,need to take action on. Initially,
this list will contain a number of cards tracking various questions about your WOPI implementation or launch
plans. As testing is done,Microsoft willcreate new cards to track implementation issues or additional questions
that arise during testing. Like the New: Microsoft list, cards should be moved from this list once they are
acknowledged.
4. Under Discussion/Investigation: This list contains cards thatare beingdiscussedorinvestigated,either by you
or Microsoft. Once a resolution is reached on the particular card, it should be moved to the Fix In Progress or
Re-verify list.
5. Fix In Progress: This list contains cards that are in the process of being addressed. These cards may represent
abug fix by you orMicrosoft,or a settings change that is in progress, etc. Once the issue is addressed, the card
should be moved to the Re-verify list.
6. Re-verify: This list contains cards that are readytobe verified. For example,you may have answereda question
about your WOPI implementation, at which point you can move the card to the Re-verify list. Once it has been
verified, it can be moved to the Resolved list. If there are follow-up questions or further discussion is needed,
the card might be moved back to the Under Discussion/Investigation list.
7. Resolved: This list contains cards that are resolved, either because the issue has been fixed and verified, or a
question has been answered and verified.
Card flow
With the exception of the left-most Reference list, the lists represent a process flow that issues will go through as they
are discussed and addressed. Cards will typically move from left to right, starting at either the New: Microsoft or
New: Partner lists, then moving right through the other relevant lists. In some cases, a card might be moved back to
aprevious list. For example, if a card in the Re-verify list is found to not be resolved, it may be moved back to the
Under Discussion/Investigation or Fix In Progress lists.
Tip: Youshould always create newcards in either the New: Microsoft orNew: Partner lists. That ensures that people
12
Chapter 1. How to read this documentation
Office Online Integration Documentation, Release 2016.01.27
are notified about the new cards. SeeNotificationsfor more information.
Labels
Figure 1.4: Default labels configured for partner boards
Labels are usedto help flag particularcards for easy filtering. You canfilter the board based onthe label colors, so it’s
easy to focus onitems that needto resolved before you canbe enabledin the production environment, forexample, by
filtering to just the red “Production Blocker” cards.
Four labels are definedinitially:
1. Production Blocker
2. Implementation Question
3. Launch Planning
4. Resources
You shouldfeel empowered to add new labels to your board if you wish.
1.4.3 Notifications
Trello supports a wide variety ofnotificationoptions. You can be notified of activity on your board by subscribing to
individual cards, lists, or even the whole board. You’ll receive notifications when things that you’re subscribed to are
changed. You can configure how these notifications behave in your Trello settings.
Tip: You can subscribe to an individual card yourself, but you can also be ‘added’ to a card by someone else. When
you are added to a card you are automatically subscribed to it. Seehttp://help.trello.com/article/717-adding-people-
to-a-boardformoreinformation.
See also:
Learn how to subscribe to items in Trello athttp://help.trello.com/article/799-subscribing-to-cards-lists-and-boards.
Recommended configuration and best practices
By default, Office Online team members will subscribe to the New: Microsoft list. This ensures that they will be
notified any time a card is added or moved to that list. We recommend that your teammembers similarly subscribe to
the New: Partner list for the same reason.
1.4. Using Trello to manage the ‘go live’ process
13
Office Online Integration Documentation, Release 2016.01.27
In addition, we recommend the following:
• When youcreate a new card,subscribe to it so you are notified when it is updated.
• The board is pre-populated with cards. Consider subscribing to the cards that you’d like to explicitly track.
• Youmight alsochoosetosubscribe to theentireboard,thoughthis canresultin‘notificationoverload,’especially
early on in the validation process. However,it can be useful after the board activity has lessened to ensure you
don’t miss any changes.
1.5 WOPI discovery
WOPI discoveryis the process by which a WOPI host identifies Office Online capabilities andhow toinitialize Office
Online applications within a site. WOPI hosts use the discovery XML to determine how to interact with Office
Online. The WOPI host should cache the data in the discovery XML. Although this XML does not change often,
we recommend that you issue a request for the XML periodically to ensure that you always have the most up-to-date
version. 12-24 hours is a good cadence to refresh although in practice it is updated much less frequently.
Another more dynamic option is to re-rundiscovery whenproofkeyvalidationfails, or when it succeeds using the old
key. That implies that the keys have been rotated, so discovery should definitely be re-run to obtain the new public
key.
Finally, another option is to run discovery whenever one of your machines restarts. All of these approaches, as well
as combinations of them, have been used by hosts in the past; which approach makes the most sense depends on your
infrastructure.
Important: Hosts should not rely on theExpiresHTTPheader on the WOPI discovery URL in order to know when
to re-run WOPI discovery. While this may change in the future, currently the value in theExpiresheader is not
appropriate for this purpose.
Tip: SeeWOPIdiscoveryURLsfor URLs you should use to retrieve discovery XML for the Office Online test and
production environments.
1.5.1 WOPI discovery actions
The actionelementand its attributes in the discoveryXML provides some importantinformation about Office Online.
Element or attribute
Description
action element
Represents:
• Operations thatyou canperformonan Officedoc-
ument.
• The file formats (in the form of file extensions)
that are supported for the action.
requires attribute
The WOPI REST endpoints that are required to use the
actions.
urlsrc attribute
The URI that you navigate to in order to invoke the ac-
tion on a particularfile.
The following example shows an action element in the Office Online discovery XML:
14
Chapter 1. How to read this documentation
Office Online Integration Documentation, Release 2016.01.27
<action name="edit" ext="docx" requires="locks,update"
urlsrc="https://word-edit.officeapps.live.com/we/wordeditorframe.aspx?
<ui=UI_LLCC&><rs=DC_LLCC&><showpagestats=PERFSTATS&>"/>
This example defines an action callededit that is supported for docx files. The edit action requires thelocks and
updatecapabilities.Toinvoketheeditactiononafile,younavigatetotheURIincludedintheurlsrcattribute.Note
that you must parse the urlsrc value andadd some parameters. For a fulldescription of this process, seeActionURLs.
Note that some actions require specific permission from Microsoft to use in the Office Online cloud service; these
actions are marked . Ifyou wish to use these actions youmustcontact Microsoft to have them enabled for yourWOPI
host.
1.5.2 WOPI actions
Note: All WOPI actions require hosts implementCheckFileInfoandGetFile.
view
An action that renders a non-editable view ofa document.
edit
An action that allows users to edit a document.
Requires update,locks
editnew
An action that creates a new document using a blank file template appropriate to the file type, then opens that
file forediting in Office Online.
Requires update,locks
convert
An actionthat converts a document ina binary format, such as doc, into a modern format, like docx,sothat it
can be edited in Office Online. SeeEditingbinarydocumentformatsfor more information about this action.
Requires update,locks
getinfo
An action that returns a set of URLs that can be used to execute automated test cases. This action is only used
by theWOPIValidationapplicationand is meant to be used in anautomatedfashion.
interactivepreview
An action that provides an interactive preview of the file type.
mobileView
An action that renders a non-editable view of a document that is optimized for viewing on mobile devices such
as smartphones.
Tip: Office Online automatically redirectsview tomobileView when needed, so typically hosts do not
need to use this action directly.
embedview
An action that renders a non-editable view ofa document that is optimized for embedding in a web page.
imagepreview
An action that provides a static image previewof the file type.
1.5. WOPI discovery
15
Office Online Integration Documentation, Release 2016.01.27
formsubmit
An action that supports accepting changes to the file type via a form-style interface. For example, a user might
be able to use this action to change the content of a workbook even if they did not have permission to use the
editaction.
formedit
An action that supports editing the file type in a mode better suited to working with files that have been used to
collect form data via theformsubmit action.
rest
An action that supports interacting with the file type via additional URL parameters that are specific to the file
type in question.
present
An action that presents abroadcastofa document.
presentservice
This actionprovides the location ofabroadcastendpointfor broadcast presenters. Interaction withthe endpoint
is described in[MS-OBPRS].
attend
An action that attends abroadcastofa document.
attendservice
This action provides the location of abroadcastendpoint for broadcast attendees. Interaction with the endpoint
is described in[MS-OBPAS].
syndicate
legacywebservice
rtc
preloadedit
An action used topreloadstaticcontentfor Office Online edit applications.
preloadview
An action used topreloadstaticcontentfor Office Online view applications.
1.5.3 Action requirements
The WOPI protocol exposes a number of different REST endpoints and operations that you can perform via those
endpoints. You don’t have to implement all of these for all actions. Actions define their requirements as part of the
discovery XML. The requirements themselves are groups of WOPI operations that must be supported in order for the
action to work.
update
Requires PutFile,PutRelativeFile
locks
Requires Lock,RefreshLock,Unlock,UnlockAndRelock
cobalt
OneNote Online Note
This requirement is only used in OneNote Online. Word, Excel, and PowerPoint Online do not require that any
of the WOPIoperations encompassed by this action requirement be implemented.
16
Chapter 1. How to read this documentation
Documents you may be interested
Documents you may be interested