Difference between revisions of "OpenDocument"
From Free Pascal wiki
Jump to navigationJump to search (Added See also section; fixed syntax highlighting) |
m (Alextp moved page opendocument to OpenDocument: casing must be Pascal-casing) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{LanguageBar}} | ||
| + | |||
==Definition== | ==Definition== | ||
| + | |||
Unit: Lazarus '''lclintf''' | Unit: Lazarus '''lclintf''' | ||
| Line 6: | Line 9: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | Official documentation: [http://lazarus-ccr.sourceforge.net/docs/lcl/lclintf/opendocument.html] | + | Official documentation: [http://lazarus-ccr.sourceforge.net/docs/lcl/lclintf/opendocument.html OpenDocument] |
==Description== | ==Description== | ||
| − | + | ||
| + | <syntaxhighlight lang=pascal inline>OpenDocument</syntaxhighlight> opens a document/file with the default viewer/editor registered with the operating system for that file/file extension. | ||
| + | |||
| + | * On macOS, the code calls the [[macOS Open Sesame|open]] command line utility for files '''and''' directories. This will open the default application for the file or directory as determined by LaunchServices. | ||
| + | * On Windows, the code will use the registry to look up the file association for the extension. As with macOS, it will also open directories. | ||
| + | |||
| + | On both macOS and Windows, <syntaxhighlight lang=pascal inline>OpenDocument</syntaxhighlight> will also open a URL using the default web browser. | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="pascal"> | <syntaxhighlight lang="pascal"> | ||
uses | uses | ||
| − | + | LCLIntf; | |
| − | + | begin | |
| − | + | OpenDocument('readme.pdf'); | |
| − | OpenDocument('readme.pdf'); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 23: | Line 31: | ||
* [[macOS_Open_Sesame|macOS Open command]] | * [[macOS_Open_Sesame|macOS Open command]] | ||
| − | * [[ | + | * [[OpenURL]] |
[[category:Lazarus]] | [[category:Lazarus]] | ||
[[category:lclintf]] | [[category:lclintf]] | ||
[[Category:Inter-process communication]] | [[Category:Inter-process communication]] | ||
Latest revision as of 20:37, 28 November 2021
│ English (en) │ 中文（中国大陆） (zh_CN) │
Definition
Unit: Lazarus lclintf
function OpenDocument(APath: String): Boolean;
Official documentation: OpenDocument
Description
OpenDocument opens a document/file with the default viewer/editor registered with the operating system for that file/file extension.
- On macOS, the code calls the open command line utility for files and directories. This will open the default application for the file or directory as determined by LaunchServices.
- On Windows, the code will use the registry to look up the file association for the extension. As with macOS, it will also open directories.
On both macOS and Windows, OpenDocument will also open a URL using the default web browser.
Example
uses
LCLIntf;
begin
OpenDocument('readme.pdf');
