Inside Macintosh: OpenDoc Class Reference /

Part 1 - Classes and Methods / ODLink

ShowLinkDestinationInfo

Mac OS

The ShowLinkDestinationInfo method displays the Link Destination Info dialog box for this link object.

ODBoolean ShowLinkDestinationInfo (
                        in ODFacet facet,
                        in ODLinkInfo info, 
                        out ODLinkInfoResult infoResult);

facet

A reference to the facet displaying the selected link destination.

info

A structure containing link destination information.

infoResult

A structure reflecting the user's selections in the Link Destination Info dialog box.

return value

kODTrue if the user did not cancel the Link Destination Info dialog box, otherwise kODFalse.

DISCUSSION

You call this method in your part's HandleEvent method when the user selects the Link Info item from the Edit menu and the current selection is the border of a link destination.

The Link Destination Info dialog box displays the part kind of the linked data, together with the dates and times of its creation and last update. The dialog box lets the user set the link update mode to automatic or manual. The user can also break the link, request an immediate update from the link data, or display the link source for editing.

If the user exits the Link Destination Info dialog box by clicking a button other than Cancel, this method returns true and you should examine the action field of the infoResult output parameter to determine what action to take in response to the user's selections.

• If the action field is kODLinkInfoFindSource, you should call this link objects's ShowSourceContent method.
• If the action field is kODLinkInfoBreakLink, you should no longer associate your part's destination content with this link. If the selected link destination gets updates automatically and your part has no other destination of this link object that also gets updates automatically, you should call the UnregisterDependent to unregister your part.
• This operation should be undoable.
• If the action field is kODLinkInfoUpdateNow, you should update its content from this link.
• If the action field is kODLinkInfoOk, you should examine the autoUpdate field of the infoResult output parameter. If the autoUpdate field has changed, you should change your part's automatic notification status as appropriate.
  • If the user selected manual notification and your part has no other destination of this link object that gets updates automatically, you should call the UnregisterDependent method to unregister your part.
  • If the user selected automatic notification and your part isn't already registered to receive automatic notification (because some other destination of this link object gets automatic updates), you should call the RegisterDependent method to register your part.

If the user cancels the dialog box, this method returns false and you do not need to take any further action.

EXCEPTIONS

kODErrBrokenLink

Internal error; the link-source object disconnected from its destinations.

kODErrNullFacetInput

The facet parameter is null.

kODErrNullLinkInfoInput

The info parameter is null.

kODErrNullLinkInfoResultInput

The infoResult parameter is null.

SEE ALSO

The ODLinkInfo type (page 923).
The ODLinkInfoAction type (page 923).
The ODLinkInfoResult type (page 924).
The ODLink::RegisterDependent method (page 355).
The ODLink::ShowSourceContent method (page 359).
The ODLink::UnregisterDependent method (page 361).
The ODLinkSource::ShowLinkSourceInfo method (page 386).
"Selection Info" on page 252 in OpenDoc Programmer's Guide.
"Link Info" on page 377 in OpenDoc Programmer's Guide.