设计器中如何从自定义TControl检测DFM/项目路径？

背景 #

我开发了一个类似TImageCollection的自定义TControl，用于给整个应用提供共享图像数据库。该控件会读取一份XML元文件，其中列出了需要纳入图像集合的图片列表。设计模式下直接从图像文件加载；运行时则从编译生成的*.res资源文件加载，核心逻辑如下：

if csDesigning in Self.ComponentState then
  loadImagesFromFiles(...)
else
  loadImagesFromResource(...)

目前遇到的问题是：在设计器中首次打开控件编辑器前，图像集合无法读取编译生成的*.res资源，导致依赖这些图像的其他控件全部显示空白。此时本应从文件加载图像，但设计器环境中的TControl无法获取项目路径。虽然控件编辑器能检测到项目目录并填充图像，但打开编辑器前，图像集合没有可用的路径信息。

问题 #

在设计器环境中，自定义TControl如何检测项目目录，或者获取包含它的*.dfm文件路径？

已评估的方案 #

• ToolsAPI可以检测当前活动项目，但无法在自定义TControl的实现代码中直接访问，仅适用于编辑器或设计器插件场景。
• 环境变量：强制开发者设置指向项目根目录的环境变量，虽然可行但弊端明显：多项目管理繁琐、增加配置复杂度、属于不良开发实践，且Delphi不允许为变量/常量设置DEFINE值。
• 项目DEFINE：将项目绝对路径设为项目DEFINE不具备可移植性，而且Delphi似乎不支持这种操作。

可行解决方案 #

1. 通过Owner链追溯Form获取DFM路径

设计模式下，自定义控件的Owner通常是TForm或TDataModule，可以通过遍历Owner链找到根Form，再通过其FileName属性获取DFM文件路径，进而推导项目目录：

function GetProjectDirFromControl(AControl: TControl): string;
var
  LComponent: TComponent;
  LForm: TForm;
begin
  Result := '';
  if not (csDesigning in AControl.ComponentState) then Exit;
  
  LComponent := AControl.Owner;
  while Assigned(LComponent) do
  begin
    if LComponent is TForm then
    begin
      LForm := TForm(LComponent);
      if LForm.FileName <> '' then
        Result := ExtractFilePath(LForm.FileName);
      Break;
    end;
    LComponent := LComponent.Owner;
  end;
  
  // 若DFM在项目子目录，可向上追溯项目根目录（根据实际目录结构调整）
  if Result <> '' then
    Result := ExtractFilePath(Result);
end;

注意：如果控件嵌套在非Form的容器中，需要调整遍历逻辑以确保找到根Form。

2. 利用Designer接口获取上下文信息

自定义控件可以通过GetDesigner函数获取IDesigner接口，直接从设计器上下文获取根组件的文件路径：

uses
  DesignIntf, DesignEditors;

function GetProjectDir(AControl: TControl): string;
var
  LDesigner: IDesigner;
  LRootComponent: TComponent;
  LFormFileName: string;
begin
  Result := '';
  if not (csDesigning in AControl.ComponentState) then Exit;
  
  if GetDesigner(AControl, LDesigner) then
  begin
    LRootComponent := LDesigner.Root;
    if Assigned(LRootComponent) and (LRootComponent is TForm) then
    begin
      LFormFileName := TForm(LRootComponent).FileName;
      if LFormFileName <> '' then
        Result := ExtractFilePath(LFormFileName);
    end;
  end;
end;

这种方法更可靠，因为IDesigner直接提供了设计器的上下文信息，能准确获取根组件（通常是Form）的文件路径。

3. 相对路径约定

如果可以和开发者约定图像文件的存放位置（比如和DFM同目录，或项目根目录下的固定子文件夹），可以先尝试用相对路径加载，失败时再提示用户配置：

procedure LoadImagesFromRelativePath(AControl: TControl);
var
  LDFMDir: string;
  LImageDir: string;
begin
  LDFMDir := GetProjectDirFromControl(AControl);
  if LDFMDir <> '' then
  begin
    LImageDir := LDFMDir + 'Images\'; // 约定的图像存放文件夹
    if DirectoryExists(LImageDir) then
      loadImagesFromFiles(LImageDir)
    else
      ShowMessage('图像目录不存在，请检查路径配置');
  end;
end;

内容的提问来源于stack exchange，提问作者Adrian Maire