Difference between revisions of "FileAssociation"

From Lazarus wiki
Jump to navigationJump to search
m (Remove duped platform template)
 
(22 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==FileAssociation==
+
{{FileAssociation}}
  
'''Package Name:''' fileassoc.lpk
+
== TFileAssociation ==
'''Component Name:''' TFileAssociation (fileassociation.pas)
 
  
With this component you can easily register file associations for all Windows versions. This includes Windows Vista/7/8 Default Programs feature.
+
Author: Lainz
  
Install like any package. The component is under the "System" tab.
+
Licence: Modified LGPL
  
==License==
+
Version: 1.0
LGPL (The same as Lazarus).
 
  
==Intended platform==
+
Description: This unit registers file association for Windows.
Win32, Win64.
 
  
==Status==
+
== Download ==
Stable.
 
  
==Where to download it:==
+
GitHub: https://github.com/lainz/FileAssociation
[http://lazarus.freepascal.org/index.php/topic,19941.0.html Download (in Lazarus Forum)]
 
  
==Who wrote it==
+
== Usage ==
Lainz.
 
  
==Is support available==
+
First install the package. You can then drop the component TFileAssociation (FileAssoc unit) that gets installed in the [[System tab]] of the IDE on your [[TForm|form]].
  
Yes, Ask in the lazarus forum, the same page that contains the download.
+
All parameters are mandatory. Especially ActionName which must be 'Open' to work with double click. This is useful as well for default commands like 'Edit' and 'Print'. This must be in English for 'Edit', 'Open' and 'Print' so it can access the right registry entry. You can customize the translation with ActionText.
  
==Test (included in download)==
+
<syntaxhighlight lang="pascal">
 +
...
 +
uses
 +
  ...
 +
  FileAssoc; //<-- add fileassociation unit here
  
This register file association for lazarus.
+
type
  
[[File:fileassoc.png]]
+
...
 +
    { private declarations }
 +
    assoc: TFileAssociation;
 +
...
  
Add a TFileAssociation in the form (assoc), a TButton (btnExec), a TDirectoryEdit (lazDir).
+
procedure TfrmMain.FormCreate(Sender: TObject);
 +
begin
 +
  assoc := TFileAssociation.Create(Self);//<-- create like a regular component
 +
end;
  
Set these properties in the TFileAssociation:
+
procedure TfrmMain.Button1Click(Sender: TObject);
 +
begin
 +
  assoc.ApplicationName := 'Lazarus IDE';
 +
  assoc.ApplicationDescription := 'RAD for Free Pascal';
  
AppDescription = Open Source IDE for Free Pascal.
+
  // you can change Extension and Action part for each extension you have
  
AppName = Lazarus IDE
+
  assoc.Extension := '.lpr';
 +
  assoc.ExtensionName := 'Lazarus Project';
 +
  assoc.ExtensionIcon := '"C:\lazarus\images\lprfile.ico"';
  
AppNameNoSpaces = LazarusIDE
+
  // full path required, you can use ParamStr(0) to get the path with the .exe name included. The path must be inside quotes if it has whitespace.
 +
  assoc.Action := '"C:\lazarus\lazarus.exe" "%1"';
 +
  assoc.ActionName := 'Open';
 +
  assoc.ActionIcon := '"C:\lazarus\images\mainicon.ico"';
  
CmdNameNoSpaces = Open
+
  // notice that using RegisterForAllUsers as True requires Administrator Privileges
 +
  // if you want to run without privileges set it to false, but it will register for current user only
 +
  assoc.RegisterForAllUsers:=False;
 +
  if assoc.Execute then
 +
  begin
 +
    ShowMessage('OK');
 +
    assoc.ClearIconCache; //<<-- rebuild icons
 +
  end;
 +
end;
  
<syntaxhighlight>
+
end.
const
+
</syntaxhighlight>
  lazExe = 'lazarus.exe';
 
  
...
+
== How to open the associated file ==
  
procedure TForm1.btnExecClick(Sender: TObject);
+
<syntaxhighlight lang="pascal">
 +
procedure TForm1.FormCreate(Sender: TObject);
 
var
 
var
   lazExePath: string;
+
   s: String;
  AddedToAll: boolean;
 
 
begin
 
begin
  lazExePath := lazDir.Directory + PathDelim + lazExe;
+
// if there are parameters
   if FileExistsUTF8(lazExePath) then
+
   if ParamCount > 0 then
 
   begin
 
   begin
     assoc.CmdData := '"' + lazExePath + '" "%1"';
+
// load the first parameter
    assoc.CmdIcon := lazExePath;
+
     s := ParamStr(1);
 
+
    // if you leave it empty the system will use localized 'Open' ('Abrir', 'Ouvrir', etc..)
+
// if is a .txt file
     // it works for CmdNameNoSpaces 'Open', 'Edit', 'Print'
+
     if ExtractFileExt(s) = '.txt' then
    // assoc.CmdName := 'Open with Lazarus';
 
 
 
    assoc.ExtData := '.lfm';
 
    assoc.ExtIcon := lazDir.Directory + '\images\LazarusForm.ico';
 
    assoc.ExtName := 'Lazarus Form';
 
    assoc.ExtNameNoSpaces := 'LazarusForm';
 
 
 
    // if can't add to all users try to add to single user
 
    if not assoc.Execute then
 
 
     begin
 
     begin
      AddedToAll := False;
+
// load the .txt file into a memo
      assoc.RegisterForAllUsers := False;
+
       Memo1.Lines.LoadFromFile(s);
      // if doesn't works..
+
    end;
       if not assoc.Execute then
+
  end;
      begin
+
end;
        ShowMessage('Can not write to registry');
+
</syntaxhighlight>
        Exit;
 
      end;
 
    end
 
    else
 
      AddedToAll := True;
 
  
    // it needs to be called only one time
+
== Another way of registering file associations ==
    assoc.AddAppToDefaultPrograms := False;
 
  
    assoc.ExtData := '.lpi';
+
Without using the component is as well possible to register a file association. This however doesn't cover adding the application to Default Programs, but is shorter if you only want to register a file type that's owned by your application.
    assoc.ExtIcon := lazDir.Directory + '\images\LazarusProject.ico';
 
    assoc.ExtName := 'Lazarus Project Information';
 
    assoc.ExtNameNoSpaces := 'LazarusProjectInformation';
 
    assoc.Execute;
 
  
     assoc.ExtData := '.lpk';
+
<syntaxhighlight lang="pascal">
     assoc.ExtIcon := lazDir.Directory + '\images\lazaruspackage.ico';
+
{$IFDEF WINDOWS}
     assoc.ExtName := 'Lazarus Package';
+
uses Registry, ShlObj;
     assoc.ExtNameNoSpaces := 'LazarusPackage';
+
     assoc.Execute;
+
procedure TMainForm.RegisterFileType(ExtName: string; AppName: string);
 +
var
 +
  reg: TRegistry;
 +
begin
 +
  reg := TRegistry.Create;
 +
  try
 +
     reg.RootKey := HKEY_CLASSES_ROOT;
 +
    reg.OpenKey('.' + ExtName, True);
 +
     reg.WriteString('', ExtName + 'file');
 +
    reg.CloseKey;
 +
    reg.CreateKey(ExtName + 'file');
 +
    reg.OpenKey(ExtName + 'file\DefaultIcon', True);
 +
    reg.WriteString('', AppName + ',0');
 +
     reg.CloseKey;
 +
    reg.OpenKey(ExtName + 'file\shell\open\command', True);
 +
     reg.WriteString('', AppName + ' "%1"');
 +
    reg.CloseKey;
 +
  finally
 +
     reg.Free;
 +
  end;
 +
  SHChangeNotify(SHCNE_ASSOCCHANGED, SHCNF_IDLIST, nil, nil);
 +
end;
 +
{$ENDIF}
 +
</syntaxhighlight>
  
    assoc.ExtData := '.lpr';
+
<syntaxhighlight lang="pascal">
    assoc.ExtIcon := lazDir.Directory + '\images\lprfile.ico';
+
var
    assoc.ExtName := 'Lazarus Program';
+
  reg: TRegistry;
    assoc.ExtNameNoSpaces := 'LazarusProgram';
+
     
    assoc.Execute;
+
begin
 
+
  {$IFDEF WINDOWS}
    assoc.ExtData := '.inc';
+
  reg := TRegistry.Create;
     assoc.ExtIcon := lazDir.Directory + '\images\includefile.ico';
+
  try
     assoc.ExtName := 'Include File';
+
     reg.RootKey := HKEY_CLASSES_ROOT;
    assoc.ExtNameNoSpaces := 'IncludeFile';
+
     if not reg.KeyExists('ext' + 'file\shell\open\command') then
    assoc.Execute;
+
      RegisterFileType('ext', ExtractFilePath(Application.ExeName) + 'my_app.exe');
 
+
  finally
    assoc.ExtData := '.pas';
+
     reg.Free;
    assoc.ExtIcon := lazDir.Directory + '\images\lprfile.ico';
+
  end;
     assoc.ExtName := 'Pascal Source Code';
+
    assoc.ExtNameNoSpaces := 'PascalSourceCodePAS';
+
if ParamCount > 0 then
    assoc.Execute;
+
  begin
 
+
     s := ParamStr(1);
     assoc.ExtData := '.pp';
+
     if ExtractFileExt(s) = '.ext' then
     assoc.ExtIcon := lazDir.Directory + '\images\lprfile.ico';
+
      LoadFile(s);
    assoc.ExtName := 'Pascal Source Code';
+
  end;
    assoc.ExtNameNoSpaces := 'PascalSourceCodePP';
+
  {$ENDIF}
    assoc.Execute;
+
</syntaxhighlight>
  
    // refresh icon cache
+
== See also ==
    assoc.ClearIconCache;
 
  
    if AddedToAll then
+
If this component for some reason does not work for you, or you need to run it as administrator for all users without elevating your application privileges, an [[Inno_Setup_Usage#File_Association|Inno Setup Script]] may fit your needs best.
      ShowMessage('File Association Registered for All Users.')
 
    else
 
      ShowMessage('File Association Registered for Current User.' +
 
        LineEnding +
 
        'If you want to register for All Users run this program with Administrative Privileges.');
 
  end
 
  else
 
    ShowMessage(format('The directory %0:s does not contain %1:s.',
 
      ['"' + lazDir.Directory + '"', '"' + lazExe + '"']));
 
end;
 
</syntaxhighlight>
 

Latest revision as of 04:38, 15 February 2020

Windows logo - 2012.svg

This article applies to Windows only.

See also: Multiplatform Programming Guide

English (en) français (fr)

TFileAssociation

Author: Lainz

Licence: Modified LGPL

Version: 1.0

Description: This unit registers file association for Windows.

Download

GitHub: https://github.com/lainz/FileAssociation

Usage

First install the package. You can then drop the component TFileAssociation (FileAssoc unit) that gets installed in the System tab of the IDE on your form.

All parameters are mandatory. Especially ActionName which must be 'Open' to work with double click. This is useful as well for default commands like 'Edit' and 'Print'. This must be in English for 'Edit', 'Open' and 'Print' so it can access the right registry entry. You can customize the translation with ActionText.

...
uses
  ...
  FileAssoc; //<-- add fileassociation unit here

type

...
    { private declarations }
    assoc: TFileAssociation;
...

procedure TfrmMain.FormCreate(Sender: TObject);
begin
  assoc := TFileAssociation.Create(Self);//<-- create like a regular component
end;

procedure TfrmMain.Button1Click(Sender: TObject);
begin
  assoc.ApplicationName := 'Lazarus IDE';
  assoc.ApplicationDescription := 'RAD for Free Pascal';

  // you can change Extension and Action part for each extension you have

  assoc.Extension := '.lpr';
  assoc.ExtensionName := 'Lazarus Project';
  assoc.ExtensionIcon := '"C:\lazarus\images\lprfile.ico"';

  // full path required, you can use ParamStr(0) to get the path with the .exe name included. The path must be inside quotes if it has whitespace.
  assoc.Action := '"C:\lazarus\lazarus.exe" "%1"'; 
  assoc.ActionName := 'Open';
  assoc.ActionIcon := '"C:\lazarus\images\mainicon.ico"';

  // notice that using RegisterForAllUsers as True requires Administrator Privileges
  // if you want to run without privileges set it to false, but it will register for current user only
  assoc.RegisterForAllUsers:=False;
  if assoc.Execute then
  begin
    ShowMessage('OK');
    assoc.ClearIconCache; //<<-- rebuild icons
  end;
end;

end.

How to open the associated file

procedure TForm1.FormCreate(Sender: TObject);
var
  s: String;
begin
// if there are parameters
  if ParamCount > 0 then
  begin
// load the first parameter
    s := ParamStr(1);
 
// if is a .txt file
    if ExtractFileExt(s) = '.txt' then
    begin
// load the .txt file into a memo
      Memo1.Lines.LoadFromFile(s);
    end;
  end;
end;

Another way of registering file associations

Without using the component is as well possible to register a file association. This however doesn't cover adding the application to Default Programs, but is shorter if you only want to register a file type that's owned by your application.

{$IFDEF WINDOWS}
uses Registry, ShlObj;
 
procedure TMainForm.RegisterFileType(ExtName: string; AppName: string);
var
  reg: TRegistry;
begin
  reg := TRegistry.Create;
  try
    reg.RootKey := HKEY_CLASSES_ROOT;
    reg.OpenKey('.' + ExtName, True);
    reg.WriteString('', ExtName + 'file');
    reg.CloseKey;
    reg.CreateKey(ExtName + 'file');
    reg.OpenKey(ExtName + 'file\DefaultIcon', True);
    reg.WriteString('', AppName + ',0');
    reg.CloseKey;
    reg.OpenKey(ExtName + 'file\shell\open\command', True);
    reg.WriteString('', AppName + ' "%1"');
    reg.CloseKey;
  finally
    reg.Free;
  end;
  SHChangeNotify(SHCNE_ASSOCCHANGED, SHCNF_IDLIST, nil, nil);
end;
{$ENDIF}
var
   reg: TRegistry;
       
begin
  {$IFDEF WINDOWS}
  reg := TRegistry.Create;
  try
    reg.RootKey := HKEY_CLASSES_ROOT;
    if not reg.KeyExists('ext' + 'file\shell\open\command') then
      RegisterFileType('ext', ExtractFilePath(Application.ExeName) + 'my_app.exe');
  finally
    reg.Free;
  end;
 
 if ParamCount > 0 then
  begin
    s := ParamStr(1);
    if ExtractFileExt(s) = '.ext' then
      LoadFile(s);
  end;
  {$ENDIF}

See also

If this component for some reason does not work for you, or you need to run it as administrator for all users without elevating your application privileges, an Inno Setup Script may fit your needs best.