Мельница данных- Справочник по интерфейсам  (раздел целиком)  (27.02.2024)
Справочник по интерфейсам

1. Перечисление TQueryPart
1type
2  TQueryPart = (qpWhat, qpWhere, qpOrder, qpGroup, qpHaving, qpInnerJoin, 
3    qpOuterJoin);

Или

01type
02  TQueryPart = TOleEnum;
03const
04  qpWhat = $00000000;
05  qpWhere = $00000001;
06  qpOrder = $00000002;
07  qpGroup = $00000003;
08  qpHaving = $00000004;
09  qpInnerJoin = $00000005;
10  qpOuterJoin = $00000006;

Элементы перечисления:

Имя Значение Назначение
qpWhat 0

qpWhere 1

qpOrder 2

qpGroup 3

qpHaving 4

qpInnerJoin 5

qpOuterJoin 6


2. Перечисление TQuerySpecial
1type
2  TQuerySpecial = (qsNone, qsObjectID, qsParentID, qsHasChildren, 
3    qsFilterCondition, qsUplink, qsRootOnly, qsDescending, qsCount, qsSum, qsMin, 
4    qsMax, qsAverage, qsMasterLink, qsSelectedOnly, qsDistinct, qsViewCondition, 
5    qsCaseInsensitive, qsAsString, qsListed, qsName, qsDescription, qsFunction, 
6    qsCountDistinct, qsBoolean, qsExact, qsSearchIndex, qsOptimizationParameters);

Или

01type
02  TQuerySpecial = TOleEnum;
03const
04  qsNone = $00000000;
05  qsObjectID = $00000001;
06  qsParentID = $00000002;
07  qsHasChildren = $00000003;
08  qsFilterCondition = $00000004;
09  qsUplink = $00000005;
10  qsRootOnly = $00000006;
11  qsDescending = $00000007;
12  qsCount = $00000008;
13  qsSum = $00000009;
14  qsMin = $0000000A;
15  qsMax = $0000000B;
16  qsAverage = $0000000C;
17  qsMasterLink = $0000000D;
18  qsSelectedOnly = $0000000E;
19  qsDistinct = $0000000F;
20  qsViewCondition = $00000010;
21  qsCaseInsensitive = $00000011;
22  qsAsString = $00000012;
23  qsListed = $00000013;
24  qsName = $00000014;
25  qsDescription = $00000015;
26  qsFunction = $00000016;
27  qsCountDistinct = $00000017;
28  qsBoolean = $00000018;
29  qsExact = $00000019;
30  qsSearchIndex = $0000001A;
31  qsOptimizationParameters = $0000001B;

Элементы перечисления:

Имя Значение Назначение
qsNone 0

qsObjectID 1

qsParentID 2

qsHasChildren 3

qsFilterCondition 4

qsUplink 5

qsRootOnly 6

qsDescending 7

qsCount 8

qsSum 9

qsMin 10

qsMax 11

qsAverage 12

qsMasterLink 13

qsSelectedOnly 14

qsDistinct 15

qsViewCondition 16

qsCaseInsensitive 17

qsAsString 18

qsListed 19

qsName 20

qsDescription 21

qsFunction 22

qsCountDistinct 23

qsBoolean 24

qsExact 25

qsSearchIndex 26

qsOptimizationParameters 27


3. Интерфейс IButton

 Диаграмма

1type
2  IButton = interface(IDispatch)
3    ['{1618406F-B9F1-4C5F-BC35-C2A154837CA9}']
4    function Get_Enabled: WordBool; safecall;
5    procedure Set_Enabled(Value: WordBool); safecall;
6    function Name: WideString; safecall;
7    procedure Click; safecall;
8    property Enabled: WordBool read Get_Enabled write Set_Enabled;
9  end;

3.1. Свойства

Свойства интерфейса IButton :

Имя Тип Доступ Назначение
Enabled WordBool Чтение/Запись


3.2. Метод Click

Метод интерфейса IButton .

procedure IButton.Click;

Метод не имеет параметров.


3.3. Метод Name

Метод интерфейса IButton .

function IButton.Name: WideString;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WideString.


4. Интерфейс IContext

 Диаграмма

001type
002  IContext = interface(IDispatch)
003    ['{79847D79-A3BE-408F-B59F-662B91BC6350}']
004    function Get_ContextObject: IDispatch; safecall;
005    function Get_UserName: WideString; safecall;
006    function Get_NegotiateAuth: WordBool; safecall;
007    function Get_Language: WideString; safecall;
008    procedure Set_Language(Value: WideString); safecall;
009    function Get_TimeBias: Double; safecall;
010    function getName(ID: OleVariant): WideString; safecall;
011    function getDescription(ID: OleVariant): WideString; safecall;
012    function getPropValue(const ClassName: WideString; const PropName: WideString; 
013      ID: OleVariant): OleVariant; safecall;
014    procedure setPropValue(const ClassName: WideString; const PropName: WideString; 
015      ID: OleVariant; Value: OleVariant); safecall;
016    procedure getPropValues(const ClassName: WideString; 
017      const PropName: WideString; IDS: OleVariant; OnValueEvent: OleVariant; 
018      ThreadCount: Integer; ThreadSafe: WordBool); safecall;
019    procedure setPropValues(const ClassName: WideString; 
020      const PropName: WideString; IDS: OleVariant; OnValueNeededEvent: OleVariant; 
021      ThreadCount: Integer; ThreadSafe: WordBool); safecall;
022    function createDataSet(const TargetClassName: WideString): IContextDataSet; safecall;
023    function select(const ClassName: WideString; QueryItems: OleVariant): IDispatch; safecall;
024    function executeMethod(const ClassName: WideString; 
025      const MethodName: WideString; Params: OleVariant): OleVariant; safecall;
026    function getClass(const ClassName: WideString): WideString; safecall;
027    function enumerationItem(ItemIdentifier: OleVariant): WideString; safecall;
028    function getResource(const Name: WideString): WideString; safecall;
029    procedure bulkInsert(const ClassName: WideString; const Data: IDispatch); safecall;
030    function PreProcessScript(const Script: WideString; Indent: WordBool; 
031      const CommentMark: WideString): WideString; safecall;
032    function executeReport(const ClassName: WideString; 
033      const TemplateName: WideString; Params: OleVariant): IDispatch; safecall;
034    procedure saveReport(const ClassName: WideString; 
035      const TemplateName: WideString; Params: OleVariant; const FileName: WideString); safecall;
036    function Get_Variable(const Name: WideString; Persistent: WordBool): OleVariant; safecall;
037    procedure Set_Variable(const Name: WideString; Persistent: WordBool; 
038      Value: OleVariant); safecall;
039    function DebugString(const Message: WideString): WideString; safecall;
040    procedure raiseManagedException(const ExceptionMessage: WideString); safecall;
041    function createGUID: WideString; safecall;
042    function getTempFileName(const Extension: WideString): WideString; safecall;
043    function HasUI: WordBool; safecall;
044    function Handle: Integer; safecall;
045    procedure processStart(const Description: WideString; ItemCount: Integer; 
046      CanAbort: WordBool); safecall;
047    function processStep: WordBool; safecall;
048    procedure processStop; safecall;
049    procedure Sleep(MSecs: Integer); safecall;
050    function executeConsoleProcess(const CommandLine: WideString; 
051      MaxDuration: Integer; const OutputData: OleVariant): Integer; safecall;
052    function downloadData(const Host: WideString; const Url: WideString; 
053      const UserName: WideString; const Password: WideString; 
054      NegotiateAuth: WordBool; PostData: OleVariant; 
055      const PostContentType: WideString; PostDataIsBinary: WordBool; 
056      CanCache: WordBool; NewSession: WordBool; TimeOut: Integer): OleVariant; safecall;
057    function LineBreak: WideString; safecall;
058    function Transliterate(const Value: WideString): WideString; safecall;
059    procedure CompareLists(var List1: OleVariant; var List2: OleVariant; 
060      const Delimiter: WideString; CaseSensitive: WordBool); safecall;
061    function parseJSON(const JSON: WideString): WideString; safecall;
062    function ConvertExcel(Source: OleVariant; const Format: WideString): IDispatch; safecall;
063    function createBinaryData: IDispatch; safecall;
064    function getCRC(Data: OleVariant): WideString; safecall;
065    function buildNamedFile(const Data: IDispatch; 
066      const StoredFileName: WideString; Propmpt: WordBool; 
067      Compress: WordBool): IDispatch; safecall;
068    procedure parseNamedFile(NamedFile: OleVariant; out FileName: OleVariant; 
069      out Data: OleVariant); safecall;
070    function createRaster: IDispatch; safecall;
071    function BinaryToBitmap(const Data: IDispatch): IDispatch; safecall;
072    function getOleObject(const ClassID: WideString; 
073      const AccessibleFileName: WideString): IDispatch; safecall;
074    function PlaceDataSet(const Range: IDispatch; const DataSet: IContextDataSet; 
075      ShiftRows: WordBool; ShiftColumns: WordBool): Integer; safecall;
076    procedure ExportObject(var Document: OleVariant; const ID: WideString; 
077      const ClassID: WideString); safecall;
078    function createZIPArchive: IDispatch; safecall;
079    function callRoutine(const ClassName: WideString; 
080      const RoutineName: WideString; var RetValue: OleVariant; 
081      const ScriptPart: OleVariant): WordBool; safecall;
082    function selectVaue(const ClassDomain: WideString; 
083      const ExpressionContext: IUnknown; var Value: OleVariant): WordBool; safecall;
084    function editValues(const ValuesList: WideString; const Title: WideString; 
085      UseTabs: WordBool; HideOKButton: WordBool; 
086      const ScriptPart: OleVariant): WordBool; safecall;
087    function MsgBox(const Prompt: WideString; Buttons: LongWord; 
088      const Title: WideString; const HelpFile: WideString; Context: LongWord): Integer; safecall;
089    function ShowMsgBox(const Prompt: WideString; Buttons: LongWord; 
090      const Title: WideString; const HelpFile: WideString; Context: LongWord): Integer; safecall;
091    procedure showView(const ViewName: WideString; Key: OleVariant; 
092      const DetailPropertyName: WideString); safecall;
093    procedure showDataSet(const DataSet: ContextDataSet; const Caption: WideString; 
094      ColumnCaptions: OleVariant; ColumnOnChangeHandlers: OleVariant; 
095      TakeActionsFromView: OleVariant); safecall;
096    procedure SaveExternalDataToFolder(const Resource: WideString; 
097      const Folder: WideString); safecall;
098    function PerformAsyncTask(ID: OleVariant): WordBool; safecall;
099    procedure RebuildTextIndex(ClassID: OleVariant; FieldID: OleVariant; 
100      ThreadCount: Integer); safecall;
101    function MainHandle: Integer; safecall;
102    property ContextObject: IDispatch read Get_ContextObject;
103    property UserName: WideString read Get_UserName;
104    property NegotiateAuth: WordBool read Get_NegotiateAuth;
105    property Language: WideString read Get_Language write Set_Language;
106    property TimeBias: Double read Get_TimeBias;
107    property Variable[const Name: WideString; Persistent: WordBool]: OleVariant 
108      read Get_Variable write Set_Variable;
109  end;

4.1. Свойства

Свойства интерфейса IContext :

Имя Тип Доступ Назначение
ContextObject IDispatch Только для чтения

Language WideString Чтение/Запись

NegotiateAuth WordBool Только для чтения

TimeBias Double Только для чтения

UserName WideString Только для чтения

Variable[const Name: WideString, Persistent: WordBool] OleVariant Чтение/Запись


4.2. Метод BinaryToBitmap

Метод интерфейса IContext .

function IContext.BinaryToBitmap(const Data: IDispatch): IDispatch;

Параметры:

Имя Тип Обязательно Значение
Data IDispatch Да

Замечания:

Возвращает значение типа IDispatch.


4.3. Метод buildNamedFile

Метод интерфейса IContext .

1function IContext.buildNamedFile(const Data: IDispatch; 
2  const StoredFileName: WideString; Propmpt: WordBool; 
3  Compress: WordBool): IDispatch;

Параметры:

Имя Тип Обязательно Значение
Data IDispatch Да

StoredFileName WideString Да

Propmpt WordBool Да

Compress WordBool Да

Замечания:

Возвращает значение типа IDispatch.


4.4. Метод bulkInsert

Метод интерфейса IContext .

1procedure IContext.bulkInsert(const ClassName: WideString; 
2  const Data: IDispatch);

Параметры:

Имя Тип Обязательно Значение
ClassName WideString Да

Data IDispatch Да


4.5. Метод callRoutine

Метод интерфейса IContext .

1function IContext.callRoutine(const ClassName: WideString; 
2  const RoutineName: WideString; var RetValue: OleVariant; 
3  const ScriptPart: OleVariant): WordBool;

Параметры:

Имя Тип Обязательно Значение
ClassName WideString Да

RoutineName WideString Да

RetValue OleVariant Нет

ScriptPart OleVariant Нет

Замечания:

Возвращает значение типа WordBool.


4.6. Метод CompareLists

Метод интерфейса IContext .

1procedure IContext.CompareLists(var List1: OleVariant; var List2: OleVariant; 
2  const Delimiter: WideString; CaseSensitive: WordBool);

Параметры:

Имя Тип Обязательно Значение
List1 OleVariant Да

List2 OleVariant Да

Delimiter WideString Да

CaseSensitive WordBool Да


4.7. Метод ConvertExcel

Метод интерфейса IContext .

1function IContext.ConvertExcel(Source: OleVariant; 
2  const Format: WideString): IDispatch;

Параметры:

Имя Тип Обязательно Значение
Source OleVariant Да

Format WideString Да

Замечания:

Возвращает значение типа IDispatch.


4.8. Метод createBinaryData

Метод интерфейса IContext .

function IContext.createBinaryData: IDispatch;

Метод не имеет параметров.

Замечания:

Возвращает значение типа IDispatch.


4.9. Метод createDataSet

Метод интерфейса IContext .

function IContext.createDataSet(const TargetClassName: WideString): IContextDataSet;

Параметры:

Имя Тип Обязательно Значение
TargetClassName WideString Да

Замечания:

Возвращает значение типа IContextDataSet.


4.10. Метод createGUID

Метод интерфейса IContext .

function IContext.createGUID: WideString;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WideString.


4.11. Метод createRaster

Метод интерфейса IContext .

function IContext.createRaster: IDispatch;

Метод не имеет параметров.

Замечания:

Возвращает значение типа IDispatch.


4.12. Метод createZIPArchive

Метод интерфейса IContext .

function IContext.createZIPArchive: IDispatch;

Метод не имеет параметров.

Замечания:

Возвращает значение типа IDispatch.


4.13. Метод DebugString

Метод интерфейса IContext .

function IContext.DebugString(const Message: WideString): WideString;

Параметры:

Имя Тип Обязательно Значение
Message WideString Да

Замечания:

Возвращает значение типа WideString.


4.14. Метод downloadData

Метод интерфейса IContext .

1function IContext.downloadData(const Host: WideString; const Url: WideString; 
2  const UserName: WideString; const Password: WideString; 
3  NegotiateAuth: WordBool; PostData: OleVariant; 
4  const PostContentType: WideString; PostDataIsBinary: WordBool; 
5  CanCache: WordBool; NewSession: WordBool; TimeOut: Integer): OleVariant;

Параметры:

Имя Тип Обязательно Значение
Host WideString Да

Url WideString Да

UserName WideString Да

Password WideString Да

NegotiateAuth WordBool Да

PostData OleVariant Да

PostContentType WideString Да

PostDataIsBinary WordBool Да

CanCache WordBool Да

NewSession WordBool Да

TimeOut Integer Да

Замечания:

Возвращает значение типа OleVariant.


4.15. Метод editValues

Метод интерфейса IContext .

1function IContext.editValues(const ValuesList: WideString; 
2  const Title: WideString; UseTabs: WordBool; HideOKButton: WordBool; 
3  const ScriptPart: OleVariant): WordBool;

Параметры:

Имя Тип Обязательно Значение
ValuesList WideString Да

Title WideString Да

UseTabs WordBool Да

HideOKButton WordBool Да

ScriptPart OleVariant Нет

Замечания:

Возвращает значение типа WordBool.


4.16. Метод enumerationItem

Метод интерфейса IContext .

function IContext.enumerationItem(ItemIdentifier: OleVariant): WideString;

Параметры:

Имя Тип Обязательно Значение
ItemIdentifier OleVariant Да

Замечания:

Возвращает значение типа WideString.


4.17. Метод executeConsoleProcess

Метод интерфейса IContext .

1function IContext.executeConsoleProcess(const CommandLine: WideString; 
2  MaxDuration: Integer; const OutputData: OleVariant): Integer;

Параметры:

Имя Тип Обязательно Значение
CommandLine WideString Да

MaxDuration Integer Да

OutputData OleVariant Да

Замечания:

Возвращает значение типа Integer.


4.18. Метод executeMethod

Метод интерфейса IContext .

1function IContext.executeMethod(const ClassName: WideString; 
2  const MethodName: WideString; Params: OleVariant): OleVariant;

Параметры:

Имя Тип Обязательно Значение
ClassName WideString Да

MethodName WideString Да

Params OleVariant Да

Замечания:

Возвращает значение типа OleVariant.


4.19. Метод executeReport

Метод интерфейса IContext .

1function IContext.executeReport(const ClassName: WideString; 
2  const TemplateName: WideString; Params: OleVariant): IDispatch;

Параметры:

Имя Тип Обязательно Значение
ClassName WideString Да

TemplateName WideString Да

Params OleVariant Да

Замечания:

Возвращает значение типа IDispatch.


4.20. Метод ExportObject

Метод интерфейса IContext .

1procedure IContext.ExportObject(var Document: OleVariant; const ID: WideString; 
2  const ClassID: WideString);

Параметры:

Имя Тип Обязательно Значение
Document OleVariant Да

ID WideString Да

ClassID WideString Да


4.21. Метод getClass

Метод интерфейса IContext .

function IContext.getClass(const ClassName: WideString): WideString;

Параметры:

Имя Тип Обязательно Значение
ClassName WideString Да

Замечания:

Возвращает значение типа WideString.


4.22. Метод getCRC

Метод интерфейса IContext .

function IContext.getCRC(Data: OleVariant): WideString;

Параметры:

Имя Тип Обязательно Значение
Data OleVariant Да

Замечания:

Возвращает значение типа WideString.


4.23. Метод getDescription

Метод интерфейса IContext .

function IContext.getDescription(ID: OleVariant): WideString;

Параметры:

Имя Тип Обязательно Значение
ID OleVariant Да

Замечания:

Возвращает значение типа WideString.


4.24. Метод getName

Метод интерфейса IContext .

function IContext.getName(ID: OleVariant): WideString;

Параметры:

Имя Тип Обязательно Значение
ID OleVariant Да

Замечания:

Возвращает значение типа WideString.


4.25. Метод getOleObject

Метод интерфейса IContext .

1function IContext.getOleObject(const ClassID: WideString; 
2  const AccessibleFileName: WideString): IDispatch;

Параметры:

Имя Тип Обязательно Значение
ClassID WideString Да

AccessibleFileName WideString Да

Замечания:

Возвращает значение типа IDispatch.


4.26. Метод getPropValue

Метод интерфейса IContext .

1function IContext.getPropValue(const ClassName: WideString; 
2  const PropName: WideString; ID: OleVariant): OleVariant;

Параметры:

Имя Тип Обязательно Значение
ClassName WideString Да

PropName WideString Да

ID OleVariant Да

Замечания:

Возвращает значение типа OleVariant.


4.27. Метод getPropValues

Метод интерфейса IContext .

1procedure IContext.getPropValues(const ClassName: WideString; 
2  const PropName: WideString; IDS: OleVariant; OnValueEvent: OleVariant; 
3  ThreadCount: Integer; ThreadSafe: WordBool);

Параметры:

Имя Тип Обязательно Значение
ClassName WideString Да

PropName WideString Да

IDS OleVariant Да

OnValueEvent OleVariant Да

ThreadCount Integer Да

ThreadSafe WordBool Да


4.28. Метод getResource

Метод интерфейса IContext .

function IContext.getResource(const Name: WideString): WideString;

Параметры:

Имя Тип Обязательно Значение
Name WideString Да

Замечания:

Возвращает значение типа WideString.


4.29. Метод getTempFileName

Метод интерфейса IContext .

function IContext.getTempFileName(const Extension: WideString): WideString;

Параметры:

Имя Тип Обязательно Значение
Extension WideString Да

Замечания:

Возвращает значение типа WideString.


4.30. Метод Handle

Метод интерфейса IContext .

function IContext.Handle: Integer;

Метод не имеет параметров.

Замечания:

Возвращает значение типа Integer.


4.31. Метод HasUI

Метод интерфейса IContext .

function IContext.HasUI: WordBool;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WordBool.


4.32. Метод LineBreak

Метод интерфейса IContext .

function IContext.LineBreak: WideString;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WideString.


4.33. Метод MainHandle

Метод интерфейса IContext .

function IContext.MainHandle: Integer;

Метод не имеет параметров.

Замечания:

Возвращает значение типа Integer.


4.34. Метод MsgBox

Метод интерфейса IContext .

1function IContext.MsgBox(const Prompt: WideString; Buttons: LongWord; 
2  const Title: WideString; const HelpFile: WideString; Context: LongWord): Integer;

Параметры:

Имя Тип Обязательно Значение
Prompt WideString Да

Buttons LongWord Нет

Title WideString Нет

HelpFile WideString Нет

Context LongWord Нет

Замечания:

Возвращает значение типа Integer.


4.35. Метод parseJSON

Метод интерфейса IContext .

function IContext.parseJSON(const JSON: WideString): WideString;

Параметры:

Имя Тип Обязательно Значение
JSON WideString Да

Замечания:

Возвращает значение типа WideString.


4.36. Метод parseNamedFile

Метод интерфейса IContext .

1procedure IContext.parseNamedFile(NamedFile: OleVariant; 
2  out FileName: OleVariant; out Data: OleVariant);

Параметры:

Имя Тип Обязательно Значение
NamedFile OleVariant Да

FileName OleVariant Да

Data OleVariant Да


4.37. Метод PerformAsyncTask

Метод интерфейса IContext .

function IContext.PerformAsyncTask(ID: OleVariant): WordBool;

Параметры:

Имя Тип Обязательно Значение
ID OleVariant Да

Замечания:

Возвращает значение типа WordBool.


4.38. Метод PlaceDataSet

Метод интерфейса IContext .

1function IContext.PlaceDataSet(const Range: IDispatch; 
2  const DataSet: IContextDataSet; ShiftRows: WordBool; 
3  ShiftColumns: WordBool): Integer;

Параметры:

Имя Тип Обязательно Значение
Range IDispatch Да

DataSet IContextDataSet Да

ShiftRows WordBool Нет

ShiftColumns WordBool Нет

Замечания:

Возвращает значение типа Integer.


4.39. Метод PreProcessScript

Метод интерфейса IContext .

1function IContext.PreProcessScript(const Script: WideString; Indent: WordBool; 
2  const CommentMark: WideString): WideString;

Параметры:

Имя Тип Обязательно Значение
Script WideString Да

Indent WordBool Да

CommentMark WideString Да

Замечания:

Возвращает значение типа WideString.


4.40. Метод processStart

Метод интерфейса IContext .

1procedure IContext.processStart(const Description: WideString; 
2  ItemCount: Integer; CanAbort: WordBool);

Параметры:

Имя Тип Обязательно Значение
Description WideString Да

ItemCount Integer Нет

CanAbort WordBool Нет


4.41. Метод processStep

Метод интерфейса IContext .

function IContext.processStep: WordBool;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WordBool.


4.42. Метод processStop

Метод интерфейса IContext .

procedure IContext.processStop;

Метод не имеет параметров.


4.43. Метод raiseManagedException

Метод интерфейса IContext .

procedure IContext.raiseManagedException(const ExceptionMessage: WideString);

Параметры:

Имя Тип Обязательно Значение
ExceptionMessage WideString Да


4.44. Метод RebuildTextIndex

Метод интерфейса IContext .

1procedure IContext.RebuildTextIndex(ClassID: OleVariant; FieldID: OleVariant; 
2  ThreadCount: Integer);

Параметры:

Имя Тип Обязательно Значение
ClassID OleVariant Да

FieldID OleVariant Да

ThreadCount Integer Да


4.45. Метод SaveExternalDataToFolder

Метод интерфейса IContext .

1procedure IContext.SaveExternalDataToFolder(const Resource: WideString; 
2  const Folder: WideString);

Параметры:

Имя Тип Обязательно Значение
Resource WideString Да

Folder WideString Да


4.46. Метод saveReport

Метод интерфейса IContext .

1procedure IContext.saveReport(const ClassName: WideString; 
2  const TemplateName: WideString; Params: OleVariant; const FileName: WideString);

Параметры:

Имя Тип Обязательно Значение
ClassName WideString Да

TemplateName WideString Да

Params OleVariant Да

FileName WideString Да


4.47. Метод select

Метод интерфейса IContext .

1function IContext.select(const ClassName: WideString; 
2  QueryItems: OleVariant): IDispatch;

Параметры:

Имя Тип Обязательно Значение
ClassName WideString Да

QueryItems OleVariant Да

Замечания:

Возвращает значение типа IDispatch.


4.48. Метод selectVaue

Метод интерфейса IContext .

1function IContext.selectVaue(const ClassDomain: WideString; 
2  const ExpressionContext: IUnknown; var Value: OleVariant): WordBool;

Параметры:

Имя Тип Обязательно Значение
ClassDomain WideString Да

ExpressionContext IUnknown Да

Value OleVariant Да

Замечания:

Возвращает значение типа WordBool.


4.49. Метод setPropValue

Метод интерфейса IContext .

1procedure IContext.setPropValue(const ClassName: WideString; 
2  const PropName: WideString; ID: OleVariant; Value: OleVariant);

Параметры:

Имя Тип Обязательно Значение
ClassName WideString Да

PropName WideString Да

ID OleVariant Да

Value OleVariant Да


4.50. Метод setPropValues

Метод интерфейса IContext .

1procedure IContext.setPropValues(const ClassName: WideString; 
2  const PropName: WideString; IDS: OleVariant; OnValueNeededEvent: OleVariant; 
3  ThreadCount: Integer; ThreadSafe: WordBool);

Параметры:

Имя Тип Обязательно Значение
ClassName WideString Да

PropName WideString Да

IDS OleVariant Да

OnValueNeededEvent OleVariant Да

ThreadCount Integer Да

ThreadSafe WordBool Да


4.51. Метод showDataSet

Метод интерфейса IContext .

1procedure IContext.showDataSet(const DataSet: ContextDataSet; 
2  const Caption: WideString; ColumnCaptions: OleVariant; 
3  ColumnOnChangeHandlers: OleVariant; TakeActionsFromView: OleVariant);

Параметры:

Имя Тип Обязательно Значение
DataSet ContextDataSet Да

Caption WideString Да

ColumnCaptions OleVariant Да

ColumnOnChangeHandlers OleVariant Да

TakeActionsFromView OleVariant Да


4.52. Метод ShowMsgBox

Метод интерфейса IContext .

1function IContext.ShowMsgBox(const Prompt: WideString; Buttons: LongWord; 
2  const Title: WideString; const HelpFile: WideString; Context: LongWord): Integer;

Параметры:

Имя Тип Обязательно Значение
Prompt WideString Да

Buttons LongWord Нет

Title WideString Нет

HelpFile WideString Нет

Context LongWord Нет

Замечания:

Возвращает значение типа Integer.


4.53. Метод showView

Метод интерфейса IContext .

1procedure IContext.showView(const ViewName: WideString; Key: OleVariant; 
2  const DetailPropertyName: WideString);

Параметры:

Имя Тип Обязательно Значение
ViewName WideString Да

Key OleVariant Да

DetailPropertyName WideString Да


4.54. Метод Sleep

Метод интерфейса IContext .

procedure IContext.Sleep(MSecs: Integer);

Параметры:

Имя Тип Обязательно Значение
MSecs Integer Да


4.55. Метод Transliterate

Метод интерфейса IContext .

function IContext.Transliterate(const Value: WideString): WideString;

Параметры:

Имя Тип Обязательно Значение
Value WideString Да

Замечания:

Возвращает значение типа WideString.


5. Интерфейс IContextDataSet

 Диаграмма

01type
02  IContextDataSet = interface(IDispatch)
03    ['{466F3AF7-F899-4BC1-869D-1B17DCB86159}']
04    procedure AddQueryItem(Part: TQueryPart; const Name: WideString; 
05      Value: OleVariant; Special: TQuerySpecial; Context: OleVariant); safecall;
06    function Eof: WordBool; safecall;
07    function Field(const Name: WideString): OleVariant; safecall;
08    function FieldCount: Integer; safecall;
09    function FieldName(Index: Integer): WideString; safecall;
10    procedure Next; safecall;
11    procedure Split(OnRowEvent: OleVariant; ChunkSize: Integer; 
12      ThreadCount: Integer; ThreadSafe: WordBool); safecall;
13    function AsJSON: WideString; safecall;
14    function AsXML: WideString; safecall;
15    function AsBinaryData: IDispatch; safecall;
16  end;

5.1. Метод AddQueryItem

Метод интерфейса IContextDataSet .

1procedure IContextDataSet.AddQueryItem(Part: TQueryPart; 
2  const Name: WideString; Value: OleVariant; Special: TQuerySpecial; 
3  Context: OleVariant);

Параметры:

Имя Тип Обязательно Значение
Part TQueryPart Да

Name WideString Да

Value OleVariant Нет

Special TQuerySpecial Нет

Context OleVariant Нет


5.2. Метод AsBinaryData

Метод интерфейса IContextDataSet .

function IContextDataSet.AsBinaryData: IDispatch;

Метод не имеет параметров.

Замечания:

Возвращает значение типа IDispatch.


5.3. Метод AsJSON

Метод интерфейса IContextDataSet .

function IContextDataSet.AsJSON: WideString;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WideString.


5.4. Метод AsXML

Метод интерфейса IContextDataSet .

function IContextDataSet.AsXML: WideString;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WideString.


5.5. Метод Eof

Метод интерфейса IContextDataSet .

function IContextDataSet.Eof: WordBool;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WordBool.


5.6. Метод Field

Метод интерфейса IContextDataSet .

function IContextDataSet.Field(const Name: WideString): OleVariant;

Параметры:

Имя Тип Обязательно Значение
Name WideString Да

Замечания:

Возвращает значение типа OleVariant.


5.7. Метод FieldCount

Метод интерфейса IContextDataSet .

function IContextDataSet.FieldCount: Integer;

Метод не имеет параметров.

Замечания:

Возвращает значение типа Integer.


5.8. Метод FieldName

Метод интерфейса IContextDataSet .

function IContextDataSet.FieldName(Index: Integer): WideString;

Параметры:

Имя Тип Обязательно Значение
Index Integer Да

Замечания:

Возвращает значение типа WideString.


5.9. Метод Next

Метод интерфейса IContextDataSet .

procedure IContextDataSet.Next;

Метод не имеет параметров.


5.10. Метод Split

Метод интерфейса IContextDataSet .

1procedure IContextDataSet.Split(OnRowEvent: OleVariant; ChunkSize: Integer; 
2  ThreadCount: Integer; ThreadSafe: WordBool);

Параметры:

Имя Тип Обязательно Значение
OnRowEvent OleVariant Да

ChunkSize Integer Да

ThreadCount Integer Да

ThreadSafe WordBool Да


6. Интерфейс IContextExpressionInfo

 Диаграмма

1type
2  IContextExpressionInfo = interface(IUnknown)
3    ['{C7518427-B515-4EB4-B698-88656E6CBF7C}']
4    function LookupExpressionContext(const Identifier: WideString; 
5      out DomainID: WideString; out Value: WideString): WordBool; safecall;
6    procedure SerializeExpressionContext(const RootNode: IDispatch); safecall;
7  end;

6.1. Метод LookupExpressionContext

Метод интерфейса IContextExpressionInfo .

1function IContextExpressionInfo.LookupExpressionContext(const Identifier: WideString; 
2  out DomainID: WideString; out Value: WideString): WordBool;

Параметры:

Имя Тип Обязательно Значение
Identifier WideString Да

DomainID WideString Да

Value WideString Да

Замечания:

Возвращает значение типа WordBool.


6.2. Метод SerializeExpressionContext

Метод интерфейса IContextExpressionInfo .

procedure IContextExpressionInfo.SerializeExpressionContext(const RootNode: IDispatch);

Параметры:

Имя Тип Обязательно Значение
RootNode IDispatch Да


7. Интерфейс IControl

 Диаграмма

01type
02  IControl = interface(IDispatch)
03    ['{0662001F-D3D5-4F28-98AC-9B499F70E856}']
04    function Name: WideString; safecall;
05    function Get_Value: OleVariant; safecall;
06    procedure Set_Value(Value: OleVariant); safecall;
07    function Get_ReadOnly: WordBool; safecall;
08    procedure Set_ReadOnly(Value: WordBool); safecall;
09    function Get_IsValid: WordBool; safecall;
10    procedure Set_IsValid(Value: WordBool); safecall;
11    function Get_IsEmpty: WordBool; safecall;
12    procedure SetHint(const Value: WideString); safecall;
13    procedure RefreshLinkedView; safecall;
14    function Get_Visible: WordBool; safecall;
15    property Value: OleVariant read Get_Value write Set_Value;
16    property ReadOnly: WordBool read Get_ReadOnly write Set_ReadOnly;
17    property IsValid: WordBool read Get_IsValid write Set_IsValid;
18    property IsEmpty: WordBool read Get_IsEmpty;
19    property Visible: WordBool read Get_Visible;
20  end;

7.1. Свойства

Свойства интерфейса IControl :

Имя Тип Доступ Назначение
IsEmpty WordBool Только для чтения

IsValid WordBool Чтение/Запись

ReadOnly WordBool Чтение/Запись

Value OleVariant Чтение/Запись

Visible WordBool Только для чтения


7.2. Метод Name

Метод интерфейса IControl .

function IControl.Name: WideString;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WideString.


7.3. Метод RefreshLinkedView

Метод интерфейса IControl .

procedure IControl.RefreshLinkedView;

Метод не имеет параметров.


7.4. Метод SetHint

Метод интерфейса IControl .

procedure IControl.SetHint(const Value: WideString);

Параметры:

Имя Тип Обязательно Значение
Value WideString Да


8. Интерфейс IExceptionHandler

 Диаграмма

1type
2  IExceptionHandler = interface(IDispatch)
3    ['{3C3C7202-5ED5-4EB4-9CDD-A929C18CA8BD}']
4    procedure HandleException(ContextObject: OleVariant; const Message: WideString; 
5      const ExtentedInfo: WideString; SupportServiceData: OleVariant); safecall;
6  end;

8.1. Метод HandleException

Метод интерфейса IExceptionHandler .

1procedure IExceptionHandler.HandleException(ContextObject: OleVariant; 
2  const Message: WideString; const ExtentedInfo: WideString; 
3  SupportServiceData: OleVariant);

Параметры:

Имя Тип Обязательно Значение
ContextObject OleVariant Да

Message WideString Да

ExtentedInfo WideString Да

SupportServiceData OleVariant Да


9. Интерфейс IExternalContext

 Диаграмма

1type
2  IExternalContext = interface(IDispatch)
3    ['{EA2F1CDA-53F6-40E9-A2B7-0A80AB84D177}']
4    procedure Connect(const Database: WideString); safecall;
5  end;

9.1. Метод Connect

Метод интерфейса IExternalContext .

procedure IExternalContext.Connect(const Database: WideString);

Параметры:

Имя Тип Обязательно Значение
Database WideString Да


10. Интерфейс IFormContext

 Диаграмма

01type
02  IFormContext = interface(IDispatch)
03    ['{1944F1C8-CAEA-4CF9-9A4D-CE3423508FF7}']
04    function ID: WideString; safecall;
05    function RoutineID: WideString; safecall;
06    function ControlCount: Integer; safecall;
07    function Get_Controls(Name: OleVariant): IControl; safecall;
08    function ControlExists(const Name: WideString): WordBool; safecall;
09    function ButtonCount: Integer; safecall;
10    function Get_Buttons(Name: OleVariant): IButton; safecall;
11    function Get_Enabled: WordBool; safecall;
12    procedure Set_Enabled(Value: WordBool); safecall;
13    function ChangedControl: OleVariant; safecall;
14    function ChangedControlName: WideString; safecall;
15    procedure Cancel; safecall;
16    function ParentForm: OleVariant; safecall;
17    procedure PreInitControl(const Name: WideString; Value: OleVariant); safecall;
18    procedure NavigatorNext; safecall;
19    procedure NavigatorPrevious; safecall;
20    function NavigatorCanNext: WordBool; safecall;
21    function NavigatorCanPrevious: WordBool; safecall;
22    procedure RefreshView(RefreshAll: WordBool); safecall;
23    function ExpressionContextValue(const Name: WideString): OleVariant; safecall;
24    property Controls[Name: OleVariant]: IControl read Get_Controls;
25    property Buttons[Name: OleVariant]: IButton read Get_Buttons;
26    property Enabled: WordBool read Get_Enabled write Set_Enabled;
27  end;

10.1. Свойства

Свойства интерфейса IFormContext :

Имя Тип Доступ Назначение
Buttons[Name: OleVariant] IButton Только для чтения

Controls[Name: OleVariant] IControl Только для чтения

Enabled WordBool Чтение/Запись


10.2. Метод ButtonCount

Метод интерфейса IFormContext .

function IFormContext.ButtonCount: Integer;

Метод не имеет параметров.

Замечания:

Возвращает значение типа Integer.


10.3. Метод Cancel

Метод интерфейса IFormContext .

procedure IFormContext.Cancel;

Метод не имеет параметров.


10.4. Метод ChangedControl

Метод интерфейса IFormContext .

function IFormContext.ChangedControl: OleVariant;

Метод не имеет параметров.

Замечания:

Возвращает значение типа OleVariant.


10.5. Метод ChangedControlName

Метод интерфейса IFormContext .

function IFormContext.ChangedControlName: WideString;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WideString.


10.6. Метод ControlCount

Метод интерфейса IFormContext .

function IFormContext.ControlCount: Integer;

Метод не имеет параметров.

Замечания:

Возвращает значение типа Integer.


10.7. Метод ControlExists

Метод интерфейса IFormContext .

function IFormContext.ControlExists(const Name: WideString): WordBool;

Параметры:

Имя Тип Обязательно Значение
Name WideString Да

Замечания:

Возвращает значение типа WordBool.


10.8. Метод ExpressionContextValue

Метод интерфейса IFormContext .

function IFormContext.ExpressionContextValue(const Name: WideString): OleVariant;

Параметры:

Имя Тип Обязательно Значение
Name WideString Да

Замечания:

Возвращает значение типа OleVariant.


10.9. Метод ID

Метод интерфейса IFormContext .

function IFormContext.ID: WideString;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WideString.


10.10. Метод NavigatorCanNext

Метод интерфейса IFormContext .

function IFormContext.NavigatorCanNext: WordBool;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WordBool.


10.11. Метод NavigatorCanPrevious

Метод интерфейса IFormContext .

function IFormContext.NavigatorCanPrevious: WordBool;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WordBool.


10.12. Метод NavigatorNext

Метод интерфейса IFormContext .

procedure IFormContext.NavigatorNext;

Метод не имеет параметров.


10.13. Метод NavigatorPrevious

Метод интерфейса IFormContext .

procedure IFormContext.NavigatorPrevious;

Метод не имеет параметров.


10.14. Метод ParentForm

Метод интерфейса IFormContext .

function IFormContext.ParentForm: OleVariant;

Метод не имеет параметров.

Замечания:

Возвращает значение типа OleVariant.


10.15. Метод PreInitControl

Метод интерфейса IFormContext .

procedure IFormContext.PreInitControl(const Name: WideString; Value: OleVariant);

Параметры:

Имя Тип Обязательно Значение
Name WideString Да

Value OleVariant Да


10.16. Метод RefreshView

Метод интерфейса IFormContext .

procedure IFormContext.RefreshView(RefreshAll: WordBool);

Параметры:

Имя Тип Обязательно Значение
RefreshAll WordBool Да


10.17. Метод RoutineID

Метод интерфейса IFormContext .

function IFormContext.RoutineID: WideString;

Метод не имеет параметров.

Замечания:

Возвращает значение типа WideString.


11. Интерфейс IRaster

 Диаграмма

01type
02  IRaster = interface(IDispatch)
03    ['{4F27D016-03C2-4D48-ABF7-FD547E859F79}']
04    function Get_Width: Integer; safecall;
05    procedure Set_Width(Value: Integer); safecall;
06    function Get_Height: Integer; safecall;
07    procedure Set_Height(Value: Integer); safecall;
08    function Get_DefaultColor: Integer; safecall;
09    procedure Set_DefaultColor(Value: Integer); safecall;
10    procedure Load(Src: OleVariant); safecall;
11    procedure SaveBitmap(Dst: OleVariant); safecall;
12    procedure SavePNG(Dst: OleVariant); safecall;
13    procedure SaveJPG(Dst: OleVariant; Quality: Integer); safecall;
14    procedure FlipVertical; safecall;
15    procedure FlipHorizontal; safecall;
16    procedure Rotate; safecall;
17    procedure Resize(NewWidth: Integer; NewHeight: Integer; Center: WordBool); safecall;
18    procedure Stretch(NewWidth: Integer; NewHeight: Integer); safecall;
19    procedure StretchToSize(MaxWidth: OleVariant; MaxHeight: OleVariant; 
20      MaxSize: OleVariant); safecall;
21    procedure Overlay(Src: OleVariant; X: Integer; Y: Integer; Width: Integer; 
22      Height: Integer); safecall;
23    property Width: Integer read Get_Width write Set_Width;
24    property Height: Integer read Get_Height write Set_Height;
25    property DefaultColor: Integer read Get_DefaultColor write Set_DefaultColor;
26  end;

11.1. Свойства

Свойства интерфейса IRaster :

Имя Тип Доступ Назначение
DefaultColor Integer Чтение/Запись

Height Integer Чтение/Запись

Width Integer Чтение/Запись


11.2. Метод FlipHorizontal

Метод интерфейса IRaster .

procedure IRaster.FlipHorizontal;

Метод не имеет параметров.


11.3. Метод FlipVertical

Метод интерфейса IRaster .

procedure IRaster.FlipVertical;

Метод не имеет параметров.


11.4. Метод Load

Метод интерфейса IRaster .

procedure IRaster.Load(Src: OleVariant);

Параметры:

Имя Тип Обязательно Значение
Src OleVariant Да


11.5. Метод Overlay

Метод интерфейса IRaster .

1procedure IRaster.Overlay(Src: OleVariant; X: Integer; Y: Integer; 
2  Width: Integer; Height: Integer);

Параметры:

Имя Тип Обязательно Значение
Src OleVariant Да

X Integer Да

Y Integer Да

Width Integer Да

Height Integer Да


11.6. Метод Resize

Метод интерфейса IRaster .

1procedure IRaster.Resize(NewWidth: Integer; NewHeight: Integer; 
2  Center: WordBool);

Параметры:

Имя Тип Обязательно Значение
NewWidth Integer Да

NewHeight Integer Да

Center WordBool Да


11.7. Метод Rotate

Метод интерфейса IRaster .

procedure IRaster.Rotate;

Метод не имеет параметров.


11.8. Метод SaveBitmap

Метод интерфейса IRaster .

procedure IRaster.SaveBitmap(Dst: OleVariant);

Параметры:

Имя Тип Обязательно Значение
Dst OleVariant Да


11.9. Метод SaveJPG

Метод интерфейса IRaster .

procedure IRaster.SaveJPG(Dst: OleVariant; Quality: Integer);

Параметры:

Имя Тип Обязательно Значение
Dst OleVariant Да

Quality Integer Да


11.10. Метод SavePNG

Метод интерфейса IRaster .

procedure IRaster.SavePNG(Dst: OleVariant);

Параметры:

Имя Тип Обязательно Значение
Dst OleVariant Да


11.11. Метод Stretch

Метод интерфейса IRaster .

procedure IRaster.Stretch(NewWidth: Integer; NewHeight: Integer);

Параметры:

Имя Тип Обязательно Значение
NewWidth Integer Да

NewHeight Integer Да


11.12. Метод StretchToSize

Метод интерфейса IRaster .

1procedure IRaster.StretchToSize(MaxWidth: OleVariant; MaxHeight: OleVariant; 
2  MaxSize: OleVariant);

Параметры:

Имя Тип Обязательно Значение
MaxWidth OleVariant Да

MaxHeight OleVariant Да

MaxSize OleVariant Да


12. Интерфейс IScannerTools

 Диаграмма

1type
2  IScannerTools = interface(IDispatch)
3    ['{FC1B3C9F-7DE9-4909-B57D-6D33E3B0A87A}']
4    function AcquireImage(Silent: WordBool): IDispatch; safecall;
5    function AcquirePDF: IDispatch; safecall;
6  end;

12.1. Метод AcquireImage

Метод интерфейса IScannerTools .

function IScannerTools.AcquireImage(Silent: WordBool): IDispatch;

Параметры:

Имя Тип Обязательно Значение
Silent WordBool Да

Замечания:

Возвращает значение типа IDispatch.


12.2. Метод AcquirePDF

Метод интерфейса IScannerTools .

function IScannerTools.AcquirePDF: IDispatch;

Метод не имеет параметров.

Замечания:

Возвращает значение типа IDispatch.


13. Интерфейс ISetOfObjectsEditor

 Диаграмма

1type
2  ISetOfObjectsEditor = interface(IDispatch)
3    ['{6D3662A7-D9FF-4BD6-8D92-A4EA2058C74E}']
4    function Get_DomainName: WideString; safecall;
5    procedure Set_DomainName(Value: WideString); safecall;
6    function Get_SelectedCount: Integer; safecall;
7    property DomainName: WideString read Get_DomainName write Set_DomainName;
8    property SelectedCount: Integer read Get_SelectedCount;
9  end;

13.1. Свойства

Свойства интерфейса ISetOfObjectsEditor :

Имя Тип Доступ Назначение
DomainName WideString Чтение/Запись

SelectedCount Integer Только для чтения


14. Интерфейс IZIPArchive

 Диаграмма

01type
02  IZIPArchive = interface(IDispatch)
03    ['{11C9400F-F262-4F72-882F-5AA5A4531591}']
04    procedure Load(Src: OleVariant); safecall;
05    procedure Save(Src: OleVariant); safecall;
06    function Get_FileCount: Integer; safecall;
07    function Get_FileName(Index: Integer): WideString; safecall;
08    function Get_FileData(Index: Integer): OleVariant; safecall;
09    procedure AddFile(const FileName: WideString; Data: OleVariant); safecall;
10    function Get_FileSize(Index: Integer): Int64; safecall;
11    function Get_FileDateTime(Index: Integer): TDateTime; safecall;
12    function Get_FileCRC(Index: Integer): WideString; safecall;
13    function Get_UTF8Support: WordBool; safecall;
14    procedure Set_UTF8Support(Value: WordBool); safecall;
15    property FileCount: Integer read Get_FileCount;
16    property FileName[Index: Integer]: WideString read Get_FileName;
17    property FileData[Index: Integer]: OleVariant read Get_FileData;
18    property FileSize[Index: Integer]: Int64 read Get_FileSize;
19    property FileDateTime[Index: Integer]: TDateTime read Get_FileDateTime;
20    property FileCRC[Index: Integer]: WideString read Get_FileCRC;
21    property UTF8Support: WordBool read Get_UTF8Support write Set_UTF8Support;
22  end;

14.1. Свойства

Свойства интерфейса IZIPArchive :

Имя Тип Доступ Назначение
FileCRC[Index: Integer] WideString Только для чтения

FileCount Integer Только для чтения

FileData[Index: Integer] OleVariant Только для чтения

FileDateTime[Index: Integer] TDateTime Только для чтения

FileName[Index: Integer] WideString Только для чтения

FileSize[Index: Integer] Int64 Только для чтения

UTF8Support WordBool Чтение/Запись


14.2. Метод AddFile

Метод интерфейса IZIPArchive .

procedure IZIPArchive.AddFile(const FileName: WideString; Data: OleVariant);

Параметры:

Имя Тип Обязательно Значение
FileName WideString Да

Data OleVariant Да


14.3. Метод Load

Метод интерфейса IZIPArchive .

procedure IZIPArchive.Load(Src: OleVariant);

Параметры:

Имя Тип Обязательно Значение
Src OleVariant Да


14.4. Метод Save

Метод интерфейса IZIPArchive .

procedure IZIPArchive.Save(Src: OleVariant);

Параметры:

Имя Тип Обязательно Значение
Src OleVariant Да