Copyright: Delphi v.3.0 Copyright (c) 1982-1997 Borland International, Inc.


オブジェクトとコンポーネントのヘルプについて
オブジェクトとコンポーネントのヘルプについて3429001

参照

オブジェクトとコンポーネントのヘルプは，Delphi のオブジェクト，コンポーネント，グローバルルーチン，および変数に関するヘルプです。ヘルプには，ドラッグ & ドロップや OLE オートメーションなどの一般的なトピックについての情報も含まれています。オブジェクト，コンポーネント，ルーチン，型，および変数に関する個別の項目には，それぞれが宣言されるユニットが記載されています。これらのユニットは Delphi Source ディレクトリの RTL，VCL，および Internet サブディレクトリに配置されています。

オブジェクト

多くの場合，Delphi のオブジェクトはメソッド，プロパティ，およびイベントで構成されます。プロパティはオブジェクトに格納されているデータを表します。メソッドはオブジェクトが実行できる動作を表します。イベントはオブジェクトが対応することが可能な条件を表します。すべてのオブジェクトは上位オブジェクトの TObject から派生します。

コンポーネント

コンポーネントは設計時に操作できる視覚的なオブジェクトです。すべてのコンポーネントは TComponent から派生します。

ルーチン

グローバルルーチンは，ランタイムライブラリおよび Visual Component Library (VCL) の手続きや関数です。これらのルーチンはクラスの一部ではありませんが，直接呼び出したりクラスのメソッドから呼び出すことができます。

型

ヘルプに記載されている型は，オブジェクトに対する戻りの型として扱われます。型は，たいていの場合それらが使用されるメソッド，プロパティ，イベント，またはグローバルルーチンの各エントリに記述されます。

変数

ヘルプに記載されている変数は，ランタイムライブラリや VCL で宣言されています。これらの変数のいくつかはオブジェクトをインスタンス化したものです。 たとえば Application 変数や ComServer 変数などです。

これらのすべてのトピックに関するヘルプは，IDE から〔F1〕キーを使って参照したり，ヘルプの［目次］，［索引］，および［検索］を選んでアクセスできます。


〔F1〕によるヘルプの検索
〔F1〕によるヘルプの検索3429002

参照

プロパティやイベントに関するヘルプを表示するには，オブジェクトインスペクタ のセル内にプロパティやイベントが表示されているときにそれらにカーソルを合わせて〔F1〕を押します。

プロパティやイベントと同様に，オブジェクト，コンポーネント，メソッド，グローバルルーチン，変数，型，または一般的なトピックに関するヘルプを表示するには，ソースコード内に用語を入力し，その用語にカーソルを合わせて〔F1〕を押します。


［目次］によるヘルプの検索
［目次］によるヘルプの検索3429003

参照

ヘルプの［目次］タブでは，情報を 4 つに区分して提供しています。

オブジェクトとコンポーネントのアルファベット順リスト

オブジェクトとコンポーネントの階層別リスト

グローバルルーチンのアルファベット順リスト

型と変数のアルファベット順リスト

階層別リストはオブジェクトを以下の 6 つの主要なカテゴリに分類したものです。

TObject - TPersistent の派生オブジェクトではない TObject から派生したオブジェクト

TPersistent - コンポーネントではない持続的オブジェクト

TComponent - コントロールではないコンポーネント

TControl - TControl

TGraphicControl - Window ハンドルを持たないコントロール

TWinControl - ウィンドウコントロール

これらの 6 つのカテゴリは Delphi のオブジェクト階層に対応しています。それぞれは階層構造内でさらにオブジェクトの機能グループごとに分類されています。たとえば，コンポーネントには Dialogs のサブグループがあり，ウィンドウコントロールには Edit コントロールのサブグループがあります。このため，使いたい特定のオブジェクトに関する情報を検索して機能をすばやく比較したいときは，階層リストを使ってオブジェクトに関するヘルプを操作するとよいでしょう。


［索引］または［検索］によるヘルプの検索
［索引］または［検索］によるヘルプの検索3429004

参照

オブジェクト，コンポーネント，メソッド，プロパティ，イベント，グローバルルーチン，型，変数，およびトピックに関するヘルプを検索するには，編集ウィンドウに用語を入力して〔Enter〕を押すか，または見つかったトピックをクリックします。

ヘルプの［検索］を使う場合は，編集ウィンドウに用語を入力して，一致した用語を選んで検索条件を絞り込み，表示したいトピックをクリックします。


ヘルプでの例の使い方
ヘルプでの例の使い方3429005

参照

オブジェクトとコンポーネントのヘルプには，ヘルプからコンパイルしたり実行したりできるオブジェクトの例や，メソッド，プロパティ，およびイベントに関するコードの一部がいくつか記載されています。

オブジェクトの例では，ソースコードや .dfm ファイルを表示したり，IDE でプロジェクトを読み込んで実行したりできます。プロジェクト，.dfm，およびソースコードファイルを含む例にはすべてパス名が付いているため， IDE で実行することができます。

メソッド，プロパティ，およびイベントのコードの断片は，例へのリンクをクリックしてアクセスすることができます。

例は Delphi 3\Help\Examples ディレクトリに格納されています。


コンポーネントを利用したプログラミング
コンポーネントを利用したプログラミング3429006

参照

1.	Delphi のコンポーネントパレットからコンポーネントを選んでフォームに追加します。

2.	Object Inspector を使ってコンポーネントのプロパティ値を設定します。

3.	実行時にコンポーネントで発生する可能性のあるイベントに応答します。イベントに応答するには，イベントハンドラ内でコードを作成します。作成したコードによってプロパティ値が変更され，メソッドが呼び出されます。


トピックが見つかりません
トピックが見つかりません3319001

捜しているトピックは見つかりませんでした。現在の検索方法では見つからない可能性があります。トピックがないのかどうかを判断するには，以下に示す検索方法を試してください。別の検索方法を使ってもトピックが見つからない場合，そのトピックはヘルプファイルに入っていない可能性があります。

以下にトピックの検索方法を示します。

1.	オブジェクトインスペクタのプロパティ名かイベント名の上で〔F1〕キーを押す

2.	プロパティ，イベント，メソッド，関数，または手続きの上で〔F1〕キーを押すか，コードエディタで入力する

3.	目次タブをクリックして分類ごとにトピックをブラウズする

4.	インデックスタブをクリックしてインデックス項目のリストを確認する

5.	検索タブをクリックして単語や句を検索する


Abort procedure
�Abort procedure

Use Abort to escape from an execution path without reporting an error.

Unit

SysUtils

procedure Abort;

Description

Abort ends the process without reporting an error.

Abort raises a special "silent exception" which operates like any other exception, but does not display an error message to the end user. Abort aborts the entire program.


Abs function

Abs returns an absolute value.

Unit

System

function Abs(X);

Description

The Abs function returns the absolute value of the argument.

X is an integer-type or real-type expression.

Example

var

  r: Real;

  i: Integer;

begin

  r := Abs(-2.3);	{ 2.3 }

  i := Abs(-157);	{ 157 }

end;


AddExitProc procedure

AddExitProc is provided for backward compatibility only.

Unit

SysUtils

procedure AddExitProc(Proc: TProcedure);

Description

AddExitProc should not be used in current veresions of Delphi. Instead use the finalization section of a unit. AddExitProc is not compatible with packages.

Note

In previous versions of Delphi, AddExitProc was used to add the given procedure, Proc, to the run-time library's exit procedure list. When an application terminated, the last procedure passed to AddExitProc became the first one to get executed upon termination.


Addr function

Addr returns a pointer to a specified object.

Unit

System

function Addr(X): Pointer;

Description

The Addr function returns the address of a specified object.

X is any variable, procedure or function identifier. The result is a pointer to X.

The result of Addr is of the predefined type Pointer, which means that it is assignment-compatible with all pointer types but can't be dereferenced directly without a typecast.

Example

var

  P: Pointer;

begin

  P := Addr(P);	{ Now points to itself }

end;


AddTerminateProc procedure

See also

AddTerminateProc adds a terminate procedure to the system list of termination procedures.

Unit

SysUtils

procedure AddTerminateProc(TermProc: TTerminateProc);

Description

Call AddTerminateProc to add a procedure that should be called when the application is about to terminate. Delphi calls all of the termination procedures before the application can terminate.  The supplied termination procedure (TermProc) should return True if the application can safely terminate or False if the application cannot safely terminate. If any of the functions in the termination procedure list returns False, the application will not terminate.


AdjustLineBreaks function

See also

AdjustLineBreaks standardizes line break characters to LF/CF.

Unit

SysUtils

function AdjustLinesBreaks(const S: string): string;

Description

The AdjustLineBreaks function adjusts all line breaks in the given string S to be true CR/LF sequences. The function changes any CR characters not followed by a LF and any LF characters not preceded by a CR into CR/LF pairs. It also converts LF/CR pairs to CR/LF pairs. The LF/CR pair is common in Unix text files.


AllocMem function

See also

AllocMem allocates a memory block and initializes each byte to zero.

Unit

SysUtils

function AllocMem(Size: Cardinal): Pointer;

Description

AllocMem allocates a block of the given size on the heap. Each byte in the allocated buffer is set to zero. To dispose the buffer, use the FreeMem procedure.


AnsiCompareFileName function

See also

AnsiCompareFileName compares file names based on the current locale.

Unit

SysUtils

function AnsiCompareFileName(const S1, S2: string): Integer;

Description

AnsiCompareFileName compares S1 to S2, without case sensitivity. The compare operation is controlled by the currently installed language driver. The return value is:

Condition	Return Value
S1 > S2	> 0
S1 < S2	< 0
S1 = S2	= 0
AnsiCompareFileName supports DOS file name comparison idiosyncracies in Far East locales (Zenkaku).  When working with locales that do not use a double byte character system (DBCS), AnsiCompareFileName is identical to AnsiCompareText.  For general purpose file name comparisions, use this function instead of AnsiCompareText.


AnsiCompareStr function

See also

AnsiCompareStr compares strings based on the current Windows locale and is case sensitive.

Unit

SysUtils

function AnsiCompareStr(const S1, S2: string): Integer;

Description

AnsiCompareStr compares S1 to S2, with case sensitivity. The compare operation is controlled by the current Windows locale. The return value is:

Condition	Return Value
S1 > S2	> 0
S1 < S2	< 0
S1 = S2	= 0


AnsiCompareText function

See also

AnsiCompareText compares strings based on the current Windows locale and is not case sensitive.

Unit

SysUtils

function AnsiCompareText(const S1, S2: string): Integer;

Description

AnsiCompareText compares S1 to S2, without case sensitivity. The compare operation is controlled by the current Windows locale. CompareStr returns a value less than 0 if S1 < S2, a value greater than 0 if S1 > S2, and returns 0 if S1 = S2.


AnsiExtractQuotedStr function

See also

AnsiExtractQuotedStr converts a quoted string into an unquoted string.

Unit

SysUtils

function AnsiExtractQuotedStr(var Src: PChar; Quote: Char): string;

Description

AnsiExtractQuotedStr removes the quote characters from the beginning and end of a quoted string, and reduces pairs of quote characters within the string to a single quote character. The Quote parameter defines what character to use as a quote character. If the first character in Src is not the value of the Quote parameter, AnsiExtractQuotedStr returns an empty string.

The function copies characters from Src to the result string until the second solitary quote character or the first null character in Src. The Src parameter is updated to point to the first character following the quoted string.  If Src does not contain a matching end quote character, the Src parameter is updated to point to the terminating null character.

Note

This function supports double-byte character sets (DBCS).


AnsiLastChar_function
K AnsiLastChar function

See also

AnsiLastChar returns a pointer to the last character in a string.

Unit

SysUtils

function AnsiLastChar(const S: string): PChar;

Description

Call AnsiLastChar to obtain locate the last character in a string. This function supports double-byte character sets (DBCS).


AnsiLowerCase function

See also

AnsiLowerCase converts the given string to lower case.

Unit

SysUtils

function AnsiLowerCase(const S: string): string;

Description

AnsiLowerCase converts all characters in the given string to lower case. The conversion uses the current Windows locale. This function supports double-byte character sets (DBCS).


AnsiLowerCaseFileName function

See also

AnsiLowerCaseFileName converts a file name to lower case.

Unit

SysUtils

function AnsiLowerCaseFileName(const S: string): string;

Description

AnsiLowerCaseFileName converts all characters in the given string to lower case. The conversion uses the currently installed language driver.

AnsiLowerCaseFileName supports lowercase conversion idiosyncracies of DOS file names in Far East locales (Zenkaku).  In locales that do not use double byte character systems (DBCS), AnsiLowerCaseFileName is identical to AnsiLowerCase.


AnsiPos function

See also

AnsiPos locates the position of a substring within a string.

Unit

SysUtils

function AnsiPos(const Substr, S: string): Integer;

Description

Call AnsiPos to obtain the byte offset of the Substr parameter, as it appears in the string S. For example, if Substr is the string 'AB', and S is the string 'ABCDE', AnsiPos returns 1. If Substr does not appear in the string S, AnsiPos returns 0.

Note

This function supports double-byte character sets (DBCS).


AnsiQuotedStr function

See also

AnsiQuotedStr returns the quoted version of a string.

Unit

SysUtils

function AnsiQuotedStr(const S: string; Quote: Char): string;

Description

Use AnsiQuotedStr to convert the string S to a quoted string, using the provided Quote character.  A Quote character is inserted at the beginning and end of S, and each Quote character in the string is doubled.

Note

This function supports double-byte character sets (DBCS).


AnsiStrComp function

See also

AnsiStrComp compares null-terminated character strings case sensitively.

Unit

SysUtils

function AnsiStrComp(S1, S2: PChar): Integer;

Description

AnsiStrComp compares S1 to S2, with case sensitivity. The compare operation is controlled by the current Windows locale. The return value is:

Condition	Return Value
S1 > S2	> 0
S1 < S2	< 0
S1 = S2	= 0
Note

This function supports double-byte character sets (DBCS).


AnsiStrIComp function

See also

AnsiStrIComp compares null terminated character strings case insensitively.

Unit

SysUtils

function AnsiStrIComp(S1, S2: PChar): Integer;

Description

AnsiStrIComp compares S1 to S2, without case sensitivity. The compare operation is controlled by the current Windows locale. The return value is the same as for CompareStr.

Note

This function supports double-byte character sets (DBCS).


AnsiStrLastChar function

See also

AnsiStrLastChar returns a pointer to the last character in a null-terminated sequence of characters.

Unit

SysUtils

function AnsiStrLastChar(P: PChar): PChar;

Description

Call AnsiStrLastChar to obtain a pointer to the last full character in a null-terminated sequence. When working with double-byte character sets (DBCS), the last character will not be the same as the last Char if the last two bytes (Chars) represent a single double byte character.


AnsiStrLComp function

See also

AnsiStrLComp compares the first MaxLen bytes of two character sequences, case-sensitively.

Unit

SysUtils

function AnsiStrLComp(S1, S2: PChar; MaxLen: Cardinal): Integer;

Description

AnsiStrLComp compares S1 to S2, with case sensitivity. If S1 or S2 is longer than MaxLen bytes, AnsiStrLComp only compares the first MaxLen bytes. The compare operation is controlled by the current Windows locale. The return value is:

Condition	Return Value
S1 > S2	> 0
S1 < S2	< 0
S1 = S2 (up to MaxLen characters)	= 0
Note

This function supports double-byte character sets (DBCS).

Note

AnsiStrLComp can continue the comparison beyond a null terminating character if S1 and S2 are equal up to a null character and the null character occurs before MaxLen bytes.


AnsiStrLIComp function

See also

AnsiStrLIComp compares two strings, case-insensitively, up to the first MaxLen bytes.

Unit

SysUtils

function AnsiStrLIComp(S1, S2: PChar; MaxLen: Cardinal): Integer;

Description

AnsiStrLIComp compares S1 to S2, without case sensitivity. If S1 or S2 is longer than MaxLen characters, AnsiStrLIComp only compares up to the first MaxLen characters. The compare operation is controlled by the current Windows locale. The return value is:

Condition	Return Value
S1 > S2	> 0
S1 < S2	< 0
S1 = S2 (up to MaxLen characters)	= 0
Note

This function supports double-byte character sets (DBCS).

Note

AnsiStrLIComp can continue the comparison beyond a null terminating character if S1 and S2 are equal up to a null character and the null character occurs before MaxLen bytes.


AnsiStrLower function

See also

AnsiStrLower converts all characters in a null-terminated character sequence to lower case.

Unit

SysUtils

function AnsiStrLower(Str: PChar): PChar;

Description

AnsiStrLower returns a null-terminated character sequence where all characters are lower case. The conversion uses the current Windows locale.

Note

This function supports double-byte character sets (DBCS).


AnsiStrPos function

See also

AnsiStrPos returns a pointer to the first occurance of STR2 in STR1.

Unit

SysUtils

function StrPos(Str1, Str2: PChar): PChar;

Description

Call AnsiStrPos to locate the first occurrence of Str2 in Str1. If Str2 does not occur in Str1, AnsiStrPos returns nil.

Unlike the StrPos function, AnsiStrPos works with double-byte characters sets (DBCS).


AnsiStrRScan function

See also

AnsiStrRScan returns a pointer to the last occurance of Chr in STR.

Unit

SysUtils

function AnsiStrRScan(Str: PChar; Chr: Char): PChar;

Description

Call AnsiStrRScan to obtain a pointer to the last occurrence of Chr in Str. If Chr does not occur in Str, AnsiStrRScan returns nil. The null terminator is considered to be part of the string.

Unlike the StrRScan function, AnsiStrRScan works with double-byte character systems (DBCS).


AnsiStrScan function

See also

AnsiStrScan returns a pointer to first occurrence of a character in a string.

Unit

SysUtils

function AnsiStrScan(Str: PChar; Chr: Char): PChar;

Description

Call AnsiStrScan to obtain a pointer to the first occurrence of Chr in Str. If Chr does not occur in Str, AnsiStrScan returns nil. The null terminator is considered to be part of the string.

Unlike the StrScan function, AnsiStrScan works with double-byte character systems (DBCS).


AnsiStrUpper function

See also

AnsiStrUpper converts all characters in a null-terminated character sequence to upper case.

Unit

SysUtils

function AnsiStrUpper(Str: PChar): PChar;

Description

AnsiStrUpper returns a null-terminated character sequence where all characters are upper case. The conversion uses the current Windows locale.

Note

This function supports double-byte character sets (DBCS).


AnsiToNative function

See also

AnsiToNative converts a string from the ANSI character set to the character set associated with a given locale.

Unit

DBTables

function AnsiToNative(Locale: TLocale; const AnsiStr: string; NativeStr: PChar;

   MaxLen: Integer): PChar;

Description

Call AnsiToNative to convert a string represented in the ANSI character set (used internally by Delphi) to the character set associated with the locale specified by the Locale parameter. The resulting string is copied into the buffer pointed to by the NativeStr parameter. Use the MaxLen parameter to specify the size of this buffer. If the buffer is too small to contain all characters in the converted version of AnsiStr, the returned value is truncated. AnsiToNative returns a pointer to NativeStr.

Use AnsiToNative to convert strings typed by the user into the character set used by a database table.


AnsiToNativeBuf procedure

See also

AnsiToNativeBuf converts a string from the ANSI character set to the character set associated with a given locale.

Unit

DBTables

procedure AnsiToNativeBuf(Locale: TLocale; Source, Dest: PChar; Len: Integer);

Description

Call AnsiToNativeBuf to convert a character sequence in the ANSI character set (used internally by Delphi) to the character set associated with the locale specified by the Locale parameter. The resulting string is copied into the buffer pointed to by the Dest parameter. Use the Len parameter to specify the size of this buffer.

Use AnsiToNativeBuf to convert strings typed by the user into the character set used by a database table.


AnsiUpperCase function

See also

AnsiUpperCase converts a string to upper case.

Unit

SysUtils

function AnsiUpperCase(const S: string): string;

Description

AnsiUpperCase converts all characters in the given string to upper case. The conversion uses the current Windows locale.

Note

This function supports double-byte character sets (DBCS).


AnsiUpperCaseFileName function

See also

AnsiUpperCaseFileName converts a file name to upper case.

Unit

SysUtils

function AnsiUpperCaseFileName(const S: string): string;

Description

AnsiLowerCaseFileName converts all characters in the given string to upper case. The conversion uses the currently installed language driver.

AnsiUpperCaseFileName supports uppercase conversion idiosyncracies of DOS file names in Far East locales (Zenkaku).  In locales that do not use double byte character systems (DBCS), AnsiUpperCaseFileName is identical to AnsiUpperCase.


Append procedure

See also

Append prepares an existing file for adding text to the end.

Unit

System

procedure Append(var F: Text);

Description

Call Append to ensure that a file is opened with write-only access with the file pointer positioned at the end of the file. F is a text file variable and must be associated with an external file using AssignFile. If no external file of the given name exists, an error occurs. If F is already open, it is closed, then reopened. The current file position is set to the end of the file.

If a Ctrl+Z (ASCII 26) is present in the last 128-byte block of the file, the current file position is set so that the next character added to the file overwrites the first Ctrl+Z in the block. In this way, text can be appended to a file that terminates with a Ctrl+Z.

If F was not assigned a name, then, after the call to Append, F refers to the standard output file.

Example

var F: TextFile;

begin

  if OpenDialog1.Execute then	{ Bring up open file dialog }

  begin

    AssignFile(F, OpenDialog1.FileName);	{ Open file selected in dialog }

    Append(F);	{ Add more text onto end }

    Writeln(F, 'appended text');

    CloseFile(F);	{ Close file, save changes }

  end;

end;


AppendStr procedure

See also

AppendStr appends a dynamically allocated string to an existing string.

Unit

SysUtils

procedure AppendStr(var Dest: string; const S: string);

Description

AppendStr appends S to the end of Dest. It is provided for backwards compatibility only. Use

Dest := Dest + S;

instead.


ArcCos function

ArcCos calculates the inverse cosine of the given number.

Unit

Math

function ArcCos(X: Extended): Extended;

Description

The ArcCos function returns the inverse cosine of X. X must be between -1 and 1. The return value will be in the range [0..PI], in radians.

{ IN: |X| <= 1 OUT: [0..PI] radians }


ArcCosh function

ArcCosh calculates the inverse hyperbolic cosine of the given number.

Unit

Math

function ArcCosh(X: Extended): Extended;

Description

The ArcCosh function calculates the inverse hyperbolic cosine of X.

{ IN: X >= 1 }


ArcSin function

ArcSin calculates the inverse sine of the given number.

Unit

Math

function ArcSin(X: Extended): Extended;

Description

The ArcSin function returns the inverse sine of X. X must be between -1 and 1. The return value will be in the range [-PI/2..PI/2], in radians.

{ IN: |X| <=1 OUT: [-PI/2..PI/2] radians }


ArcSinh function

ArcSinh calculates the inverse hyperbolic sine of the given number.

Unit

Math

function ArcSinh(X: Extended): Extended;

Description

The ArcSinh function calculates the inverse hyperbolic sine of X.


ArcTan function

See also

ArcTan calculates the arctangent of the given number.

Unit

System

function ArcTan(X: Extended): Extended;

Description

Calculate other trigonometric functions using Sin, Cos, and ArcTan in the following expressions:

Tan(x) = Sin(x) / Cos(x)

ArcSin(x) = ArcTan (x/sqrt (1-sqr (x)))

ArcCos(x) = ArcTan (sqrt (1-sqr (x)) /x)

Example

var
  R: Extended;

begin

  R := ArcTan(Pi);

end;


ArcTanh function

ArcTanh calculates the inverse hyperbolic tangent of the given number.

Unit

Math

function ArcTanh(X: Extended): Extended;

Description

The ArcTanh function calculates the inverse hyperbolic tangent of X.

{ IN: |X| <= 1 }


ArcTan2 function

ArcTan2 calculates the arctangent angle and quadrant of the given number.

Unit

Math

function ArcTan2(Y, X: Extended): Extended;

Description

The ArcTan2 function calculates ArcTan(Y/X), and returns an angle in the correct quadrant.

{   IN: |Y| < 2^64, |X| < 2^64, X <> 0   OUT: [-PI..PI] radians }


Assert procedure

See also

Assert tests whether a boolean expression is successful.

Unit

System

procedure Assert(expr : Boolean [; const msg: string]);

Description

Use Assert as a debugging tool to test that conditions assumed to be true are never violated. Assert provides an opportunity to intercept an unexpected condition and halt a program rather than allow execution to continue under unanticipated conditions.

Assert takes a boolean expression and an optional message string as parameters. If the boolean test fails, Assert raises an EAssertionFailed exception. If a message string was passed to Assert, the exception object is created with that string. Otherwise it is created with a default string indicating that the assertion failed. The message is displayed along with the complete path filename and the line number on which Assert failed.

The component library catches all exceptions. If, however, an EAssertionFailed exception occurs where no user code catches it, such as in a console application, then the RTL will issue runtime error 227 and halt the program.

Because assertions are not usually used at run-time in shipping versions of a product, compiler directives are provided to disable the generation of assertion code. They are as follows:

$ASSERTIONS ON/OFF	(long form)

$C +/-	(short form)

These are global switches that take effect for the whole source file which contains the switches, regardless of their position in the file.  It is not possible to enable and disable assertions for something smaller than a source file. Assertions are off by default.

Example

{$APPTYPE CONSOLE}

{ Defining OLDSTYLE for the compilation allows old-style runtime error handling to occur rather than the new exception-based method. If the old style is used, then the user-supplied string is not displayed. }

program Plop;

{$IFNDEF OLDSTYLE}

uses SysUtils;

{$ENDIF}

type

  TList = ^TListDesc;

  TListDesc = record

    name : string;

    next : TList;

  end;

var

  Head, Tail : TList;

procedure Add(name : string);

  var

  Item : TList;

begin

NEW(Item);

Item.name := name;

Item.next := Head;

Head := Item;

end;

procedure PrintList(nofItems : Integer; list : TList);

begin

while (nofItems > 0) and (list <> NIL) do

begin

WriteLn(list.name);

list := list.next;

dec(nofItems);

end;

assert(list = NIL, 'Supplied list length does not match actual length');

end;

begin

Head := NIL;

Add('Dawg');

Tail := Head;

Add('Fifi');

Add('Phideaux');

Tail.next := Head;

PrintList(3, Head);

end.


Assigned function

See also

Assigned tests for a nil (unassigned) pointer or procedural variable.

Unit

System

function Assigned(var P): Boolean;

Description

P must be a variable reference of a pointer or procedural type. Assigned(P) corresponds to the test P<> nil for a pointer variable, and @P <> nil for a procedural variable.

Assigned returns False if P is nil, True otherwise.

Note

Assigned can't detect a dangling pointer--that is, one that isn't nil but no longer points to valid data. For example, in the code example for Assigned, Assigned won't detect the fact that P isn't valid.

Example

var P: Pointer;

begin

  P := nil;

  if Assigned (P) then Writeln ('You won''t see this');

  GetMem(P, 1024);	{P valid}

  FreeMem(P, 1024);	{P no longer valid and still not nil}

  if Assigned (P) then Writeln ('You''ll see this');

end;


AssignFile procedure

See also

AssignFile associates the name of an external file with a file variable.

Unit

System

procedure AssignFile(var F; FileName: string);

Description

To avoid scope conflicts, AssignFile replaces Assign in Delphi. However, for backward compatibility Assign is still available.

F is a file variable of any file type, and FileName is a string-type expression or an expression of type PChar if extended syntax is enabled. All further operations on F operate on the external file name.

After calling AssignFile, F is associated with the external file until F is closed.

When the FileName parameter is empty, F associates with the standard input or standard output file.

If assigned an empty name, after a call to Reset (F), F refers to the standard input file, and after a call to Rewrite (F), F refers to the standard output file.

Do not use AssignFile on a file variable that is already open.

Example

var

  F: TextFile;

  S: string;

begin

  if OpenDialog1.Execute then          { Display Open dialog box }

  begin

    AssignFile(F, OpenDialog1.FileName);   { File selected in dialog box }

    Reset(F);

    Readln(F, S);                          { Read the first line out of the file }

    Edit1.Text := S;                       { Put string in a TEdit control }

    CloseFile(F);

  end;

end;


AssignPrn procedure

See also

AssignPrn assigns a text-file variable to the printer.

Unit

Printers

procedure AssignPrn(var F: Text);

Description

Call AssignPrn to cause all information written to F, the text-file variable, to be sent to the printer. After the variable is assigned, the application must call the Rewrite procedure.

Example

This code prints a line of text on the printer when the user clicks the button on the form:

procedure TForm1.Button1Click(Sender: TObject);

var

  MyFile: TextFile;

begin

  AssignPrn(MyFile);

  Rewrite(MyFile);

  Writeln(MyFile, 'Print this text');

  System.CloseFile(MyFile);

end;


AssignStr procedure

See also

AssignStr assigns a new dynamically allocated string to a specified pointer.

Unit

SysUtils

procedure AssignStr(var P: PString; const S: string);

Description

AssignStr is provided for backward compatibility only.


Beep procedure

Beep generates a standard beep using the computer speaker.

Unit

SysUtils

procedure Beep;

Description

The Beep procedure calls the Windows API MessageBeep.


BeginThread function

See also

BeginThread spawns a separate thread of execution.

Unit

SysUtils

function BeginThread(SecurityAttributes: Pointer; StackSize: Integer; ThreadFunc: TThreadFunc;

  Parameter: Pointer; CreationFlags: Integer; var ThreadId: Integer): Integer;

Description

Delphi applications should use this routine or a TThread object to spawn separate threads of execution instead of calling the CreateThread Win32API directly.

BeginThread encapsulates the Win32 CreateThread API call. It functions similarly to CreateThread with the exception that BeginThread takes a normal Pascal function as the thread function. Thread functions should handle all of its own exceptions. BeginThread sets up an exception frame that allows the system's default exception handler to catch any of the thread's exceptions that have not been handled. The application is terminated if there are any unhandled exceptions in the thread function.


BlockRead procedure

See also

BlockRead reads one or more records from an open file into a variable.

Unit

System

procedure BlockRead(var F: File; var Buf; Count: Integer [; var AmtTransferred: Integer]);

Description

F is an untyped file variable, Buf is any variable, Count is an expression of type Integer, and AmtTransferred is an optional variable of type Integer.

BlockRead reads Count or fewer records from the file F into memory, starting at the first byte occupied by Buf. The actual number of complete records read (less than or equal to Count) is returned in AmtTransferred.

The entire transferred block occupies at most Count * RecSize bytes. RecSize is the record size specified when the file was opened (or 128 if the record size was not specified).

If the entire block was transferred, AmtTransferred is equal to Count.

If AmtTransferred is less than Count, ReadBlock reached the end of the file before the transfer was complete. If the file's record size is greater than 1, AmtTransferred returns the number of complete records read.

If AmtTransferred isn't specified, an I/O error occurs if the number of records read isn't equal to Count. Use the EInOutError exception to handle this error.

Example

var

  FromF, ToF: file;

  NumRead, NumWritten: Integer;

  Buf: array[1..2048] of Char;

begin

  if OpenDialog1.Execute then                               { Display Open dialog box }

  begin

    AssignFile(FromF, OpenDialog1.FileName);

    Reset(FromF, 1);	{ Record size = 1 }

    if SaveDialog1.Execute then                              { Display Save dialog box}

    begin

      AssignFile(ToF, SaveDialog1.FileName);	{ Open output file }

      Rewrite(ToF, 1);	{ Record size = 1 }

      Canvas.TextOut(10, 10, 'Copying ' + IntToStr(FileSize(FromF))

        + ' bytes...');

      repeat

        BlockRead(FromF, Buf, SizeOf(Buf), NumRead);

        BlockWrite(ToF, Buf, NumRead, NumWritten);

      until (NumRead = 0) or (NumWritten <> NumRead);

        CloseFile(FromF);

        CloseFile(ToF);

    end;

  end;

end;


BlockWrite procedure

See also

BlockWrite writes one or more records from a variable to an open file.

Unit

System

procedure BlockWrite(var f: File; var Buf; Count: Integer [; var AmtTransferred: Integer]);

Description

F is an untyped file variable, Buf is any variable, Count is an expression of type Integer, and AmtTransferred is an optional variable of type Integer.

BlockWrite writes Count or fewer records to the file F from memory, starting at the first byte occupied by Buf. The actual number of complete records written (less than or equal to Count) is returned in AmtTransferred.

The entire block transferred occupies at most Count * RecSize bytes. RecSize is the record size specified when the file was opened (or 128 if the record size was unspecified).

If the entire block is transferred, AmtTransferred is equal to Count on return.

If AmtTransferred is less than Count, the disk became full before the transfer was complete. In this case, if the file's record size is greater than 1, AmtTransferred returns the number of complete records written.

The current file position is advanced by AmtTransferred records as an effect of the BlockWrite.

If AmtTransferred isn't specified, an I/O error occurs if the number written isn't equal to Count. Use exception handler EInOutError to deal this error.

Example

var

  FromF, ToF: file;

  NumRead, NumWritten: Integer;

  Buf: array[1..2048] of Char;

begin

  if OpenDialog1.Execute then                               { Display Open dialog box }

  begin

    AssignFile(FromF, OpenDialog1.FileName);

    Reset(FromF, 1);	{ Record size = 1 }

    if SaveDialog1.Execute then                            { Display Save dialog box }

    begin

      AssignFile(ToF, SaveDialog1.FileName);	{ Open output file }

      Rewrite(ToF, 1);	{ Record size = 1 }

      Canvas.TextOut(10, 10, 'Copying ' + IntToStr(FileSize(FromF))

        + ' bytes...');

      repeat

        BlockRead(FromF, Buf, SizeOf(Buf), NumRead);

        BlockWrite(ToF, Buf, NumRead, NumWritten);

      until (NumRead = 0) or (NumWritten <> NumRead);

        CloseFile(FromF);

        CloseFile(ToF);

    end;

  end;

end;


Bounds function

See also

Bounds returns the TRect for a rectangle of a given position, width, and height.

Unit

Classes

function Bounds(ALeft, ATop, AWidth, AHeight: Integer): TRect;

Description

Call Bounds to obtain a TRect for a rectangle with upper left corner at the point (ALeft, ATop) with width AWidth and height AHeight.


Break procedure

See also

Unit

System

Break causes the flow of control to exit a for, while, or repeat statement.

procedure Break;

Description

The Break procedure causes the flow of control to exit a for, while, or repeat statement and continue at the next statement following the loop statement.

A call to Break must be contained in a for, while, or repeat statement, or the compiler reports an error.

Note

Break will not violate the flow of control dictated by a try-finally construct. If a break occurs inside a try-finally, the finally clause will be entered.

Example

var

  S: string;

begin

  while True do

  begin

    ReadLn(S);

    try

      if S = '' then Break;

      WriteLn(S);

    finally

    { do something for all cases }

    end;

  end;

end;


ByteToCharIndex function

See also

Unit

SysUtils

ByteToCharIndex returns the position of the character that contains a specified byte in a string.

function ByteToCharIndex(const S: string; Index: Integer): Integer;

Description

Call ByteToCharIndex to determine which character contains a particular byte in a string, where 1 specifies the first byte, 2 specifies the second byte, and so on. If the Index parameter specifies a byte that is not in the string (Index < 0 or Index > Length(S)), ByteToCharIndex returns 0.

If the system does not use a double byte character system (DBCS), ByteToCharIndex simply returns the value of Index, because there is a 1:1 correspondance between bytes and characters. Othersize, ByteToCharIndex returns the position of the character, where 1 specifies the first character, 2 specifies the second character, and so on.

For example, if a string contains two characters, a single-byte character followed by a double byte character, then ByteToCharIndex returns 1 when Index is 1, it returns 2 when Index is 2 or 3, and it returns 0 for any other value of Index.


ByteToCharLen function

See also

Unit

SysUtils

ByteToCharLen returns the number of characters fully contained in the first MaxLen bytes of a string.

function ByteToCharLen(const S: string; MaxLen: Integer): Integer;

Description

Call ByteToCharLen to determine the number of characters represented by a portion of a string. ByteToCharLen counts characters until it reaches MaxLen bytes or the end of the string, whichever comes first.

When working with double byte character systems (DBCS), the value returned by ByteToCharLen may be less than MaxLen or the length of the string.

Note

ByteToCharLen will count a partial character if it appears as the last of the first MaxLen bytes.


ByteType function

See also

Unit

SysUtils

ByteType indicates whether a byte in a string is a single byte character, the first byte of a double byte character, or the second byte of a double byte character.

function ByteType(const S: string; Index: Integer): TMbcsByteType;

Description

Call ByteType to determine the type of the byte specified by the Index parameter, where 0 specifies the first byte in the string S, 1 specifies the second byte, and so on.

If the system is not using a double byte character system (DBCS), ByteType always returns mbSingleByte. Otherwise, ByteType returns mbSingleByte if the indicated byte represents a complete character in S, mbLeadByte if it represents the first byte of a double byte character, and mbTrailByte if it represents the second byte of a double byte character.

Note

No checking is done to ensure that Index is less than the length of S. It is the caller's responsibility to ensure that Index is not out of bounds.


CallTerminateProcs

See also

Unit

SysUtils

CallTerminateProcs calls all of the functions in the termination procedure list.

function CallTerminateProcs: Boolean;

Description

CallTerminateProcs is called internally when an application is about to terminate.  It returns True only if all of the functions in the application's terminate procedure list return True.  This function is intended only to be called by Delphi. Do not call it directly.


CancelDrag procedure

Unit

Controls

CancelDrag cancels a drag-and-drop operation that is in progress.

procedure CancelDrag;

Description

Call CancelDrag to terminate the current drag-and-drop operation without dropping the dragged object.


Ceil function

Unit

Math

Ceil rounds variables up.

function Ceil(X: Extended):Integer;

Description

The Ceil function rounds toward positive infinity. For example:

Ceil(-2.8) = -2

Ceil(2.8) = 3

Ceil(-1.0) = -1

{ Ceil: Smallest integer >= X, |X| < MaxInt }


ChangeFileExt function

See also

Unit

SysUtils

ChangeFileExt changes the file extension.

function ChangeFileExt(const FileName, Extension: string): string;

Description

The ChangeFileExt function takes the file name passed in FileName and changes the extension of the file name to the extension passed in Extension.

Example

The following code generates the name of an .INI file based on the name of the program:

function INIFileName: string;

begin

  IniFileMade := ChangeFileExt(ParamStr(0), '.INI');

end;

Note

This function works with double-byte character sets (DBCS).


CharsetToIdent function

See also

Unit

Graphics

CharSetToIdent obtains the name of a character set.

function CharsetToIdent(Charset: Longint; var Ident: string): Boolean;

Description

Call CharsetToIdent to obtain the symbolic name for the character set of a font. CharsetToIdent returns True if the Ident parameter is successfully given an identifying name for the character set.

Note

The return value of CharsetToIdent does not indicate whether the Charset parameter is valid for a given font. Many fonts support only a limited number of character sets. Some fonts may support less common character sets that can't be mapped to identifiers by CharsetToIdent.


CharToByteIndex function

See also

Unit

SysUtils

CharToByteIndex returns the 1-based index of the first byte of a specified character in a string.

function CharToByteIndex(const S: string; Index: Integer): Integer;

Description

Call CharToByteIndex to obtain the byte offset for the character at a specified position in the string S, where 1 specifies the first character, 2 specifies the second character, and so on. CharToByteIndex returns zero if Index is out of range (Index <= 0 or S contains fewer than Index characters). If the character indicated by the Index parameter is a double-byte character, CharToByteIndex returns the offset of the first byte.

If the system is not using a double-byte character system (DBCS), CharToByteIndex returns the value of Index, because there is a 1:1 correspondance between bytes and characters.


CharToByteLen function

See also

Unit

SysUtils

CharToByteLen returns the length, in bytes, of the first MaxLen characters of a string.

function CharToByteLen(const S: string; MaxLen: Integer): Integer;

Description

Call CharToByteLen to convert the length of a string in characters to the corresponding length in bytes. CharToByteLen returns the number of bytes required by the first MaxLen characters of S. If S contains fewer than MaxLen characters, CharToByteLen returns the byte length of the string S.

If the system is not using a double-byte character system (DBCS), CharToByteLen returns the length of S or MaxLen, whichever is smaller.


ChDir procedure

See also

Unit

System

ChDir changes the current directory.

procedure ChDir(S: string);

Description

The ChDir procedure changes the current directory to the path specified by S.
If S specifies a drive letter, the current drive is also changed.

Example

begin

  {$I-}

  { Change to directory specified in Edit1 }

  ChDir(Edit1.Text);

  if IOResult <> 0 then

    MessageDlg('Cannot find directory', mtWarning, [mbOk], 0);

end;


Check procedure

See also

Unit

DB

Check determines whether a value returned from the Borland Database Engine (BDE) represents an error condition.

procedure Check(Status: Integer);

Description

Pass the return code from a direct BDE API call as the Status parameter when calling the Check procedure. Check determines whether Status indicates an error condition, and if so, calls DbiError to raise an exception.


Chr function

See also

Unit

System

Chr returns the character for a specified ASCII value.

function Chr(X: Byte): Char;

Description

The Chr function returns the character with the ordinal value (ASCII value) of the byte-type expression, X.

Example

begin

  Canvas.TextOut(10, 10, Chr(65));  { The letter 'A'}

end;


ClassIDToProgID function

See also

Unit

ComObj

ClassIDToProgID returns the programmatic ID for a specified class given its class ID (CLSID).

function ClassIDToProgID(const ClassID: TGUID): string;

Description

ClassIDToProgID retrieves the programmatic ID for a given CLSID. The ClassID parameter specifies the CLSID for which the programmatic ID is requested.

If ClassIDToProgID succeeds ClassIDToProgID returns a string to the requested ProgID. If ClassIDToProgID fails an EOleSysError exception is raised with an error code indicating the cause of the error. The error code possibilites are as follows:

Error code	Meaning
REGDB_E_CLASSNOTREG	Class not registered in the registry.
REGDB_E_READREGDB	Error reading registry.


Clipboard function

See also

Unit

Clipbrd

Clipboard returns an instance of TClipboard.

function Clipboard: TClipboard;

Description

Delphi maintains a single instance of TClipboard for use whenever the application needs to directly access the clipboard object. If the application has never used the Windows clipboard, calling Clipboard creates a new instance of TClipboard. If the clipboard has already been used, Clipboard returns the previously created TClipboard object.

To use Clipboard and the TClipboard object, add Clipbrd to the uses clause .


Close procedure

See also

Unit

System

Close terminates the association between a file variable and an external file (Pascal).

procedure Close(var F);

Description

The Close procedure provides compatibility with existing Borland Pascal code. When writing applications for Delphi, use CloseFile.

F is a file variable of any file type opened using Reset, Rewrite, or Append. The external file associated with F is completely updated and then closed, freeing the file handle for reuse.

{$I+} handles run-time errors using exceptions. For more information on handling run-time library exceptions, see Handling RTL Exceptions

When using {$I-}, use IOResult to check for I/O errors.


CloseFile procedure

Unit

System

CloseFile terminates the association between file variable and an external disk file (Delphi).

procedure CloseFile(var F);

Description

Due to naming conflicts, the CloseFile procedure replaces the Borland Pascal Close procedure. Use the CloseFile procedure instead of Close to terminate the association between the file variable and an external disk file.

F is a file variable of any file type opened using Reset, Rewrite, or Append. The external file associated with F is completely updated and then closed, freeing the file handle for reuse.

{$I+} handles run-time errors using exceptions. For more information on handling run-time library exceptions, see Handling RTL Exceptions

When using {$I-}, use IOResult to check for I/O errors.

Example

var

  F: TextFile;

begin

  if OpenDialog1.Execute then  { Bring up open file dialog }

  begin

    AssignFile(F, OpenDialog1.FileName);

            { File selected in dialog }

    Reset(F);

    Edit1.Text := IntToStr(FileSize(F);

        { Put file size string in a TEdit control }

    CloseFile(F);   { Close file }

  end;

end;


CollectionsEqual function

See also

Unit

Classes

CollectionsEqual compares the contents of two collections.

function CollectionsEqual(C1, C2: TCollection): Boolean;

Description

Call CollectionsEqual to determine whether two collections contain identical information. CollectionsEqual returns True if all the items in each collection have the same settings, and the items appear in the same order. CollectionsEqual returns False if the collections differ in number or order of items, or if any of the items in the collections differ.


ColorToIdent function

See also

Unit

Graphics

ColorToIdent provides the symbolic name of a TColor value.

function ColorToIdent(Color: Longint; var Ident: string): Boolean;

Description

Call ColorToIdent to obtain the name of the symbolic constant that represents a TColor value, such as clBlack or clWindow. The Ident parameter is set to the symbolic name. If there is no symbolic constant defined for the color, ColorToIdent returns False.


ColorToRGB function

See also

Unit

Graphics

ColorToRGB converts a TColor value into an RGB representation of the color.

function ColorToRGB(Color: TColor): Longint;

Description

Call ColorToRGB to obtain an RGB representation of a color for using with Windows API function calls. ColorToRGB strips away the information about which palette to use for colors that are not always available that is stored in the highest order bits.

Example

The following code converts the color of the current form, Form1, to a Windows RGB value:

var

  L : Longint;

begin

  L := ColorToRGB(Form1.Color);

end;


ColorToString function

See also

Unit

Graphics

ColorToString returns a string that represents the name of a TColor value.

function ColorToString(Color: TColor): string;

Description

Call ColorToString to obtain a string that represents a TColor value. If there is a symbolic constant defined for the color (such as clBlack or clWindow), ColorToString returns the name of the constant. Otherwise, ColorToString returns the hex value of the color, formatted as a string.


CompareMem function

See also

Unit

SysUtils

CompareMem performs a binary comparison of two memory images.

function CompareMem(P1, P2: Pointer; Length: Integer): Boolean; assembler;

Description

CompareMem performs a binary compare of Length bytes of memory referenced by P1 to that of P2.  CompareMem returns True if the memory referenced by P1 is identical to that of P2.


CompareStr function

See also

Unit

SysUtils

CompareStr compares strings case sensitively.

function CompareStr(const S1, S2: string): Integer;

Description

CompareStr compares S1 to S2, with case-sensitivity. The return value is less than 0 if S1 is less than S2, 0 if S1 equals S2, or greater than 0 if S1 is greater than S2. The compare operation is based on the 8-bit ordinal value of each character and is not affected by the current Windows locale.

Example

The following code compares String1, 'STEVE', to String2, 'STEVe'. Note that CompareStr returns a number less than 0 because the value of 'e' is greater than the value of 'E'.

var

  String1, String2 : string;

  I : integer;

begin

  String1 := 'STEVE';

  String2 := 'STEVe';

  I := CompareStr(String1, String2);  { the value of I is < 0 }

  if I < 0 then

    MessageDlg('The strings are not equal', mtWarning, [mbOK], 0)

end;


CompareText function

See also

Unit

SysUtils

CompareText compares strings by ordinal value and is not case sensitive.

function CompareText(const S1, S2: string): Integer;

Description

CompareText compares the strings S1 and S2 and returns 0 if they are equal. If S1 is greater than S2, CompareText returns an integer greater than 0. If S1 is less than S2, CompareText returns an integer less than 0. The CompareText function is not case sensitive. For example, CompareText finds 'object pascal' and 'Object Pascal' to be equal.

Example

The following code compares String1, 'ABC, to String2, 'aaa'. Because CompareText is case insensitive, String2 is larger.

var

  String1, String2 : string;

  I : integer;

begin

  String1 := 'ABC';

  String2 := 'aaa';

  I := CompareStr(String1, String2);  { the value of I is < 0 }

  if I < 0 then

    MessageDlg('The strings are not equal', mtWarning, [mbOK], 0)

end;


Concat function

See also

Unit

System

Concat concatenates two or more strings into one.

function Concat(s1 [, s2,..., sn]: string): string;

Description

Each parameter is a string-type expression. The result is the concatenation of all the string parameters.

Using the plus (+) operator has the same effect on two strings as using the Concat function:

S := 'ABC' + 'DEF';

Example

 var

  S: string;

begin

  S := Concat('ABC', 'DEF');     { 'ABCDE' }

end;


Continue procedure

See also

Unit

System

Continue allows the flow of control to proceed to the next iteration of for, while, or repeat statements.

procedure Continue;

Description

The Continue procedure has the flow of control proceed to the next iteration of the enclosing for, while, or repeat statement.

The compiler reports an error if a call to Continue isn't enclosed by a for, while, or repeat statement.

Note

See the Break procedure for information about exiting loops and finally blocks.

Example

var

  F: File;

  i: integer;

begin

  for i := 0 to (FileListBox1.Items.Count - 1) do begin

  try

    if FileListBox1.Selected[i] then begin

      if not FileExists(FileListBox1.Items.Strings[i]) then begin

        MessageDlg('File: ' + FileListBox1.Items.Strings[i] +

                   ' not found', mtError, [mbOk], 0);

        Continue;

      end;

      AssignFile(F, FileListBox1.Items.Strings[i]);

      Reset(F, 1);

      ListBox1.Items.Add(IntToStr(FileSize(F)));

      CloseFile(F);

    end;

   finally

   { do something here }

   end;

  end;

end;


Copy function

See also

Unit

System

Copy returns a substring of a string.

function Copy(S: string; Index, Count: Integer): string;

Description

The Copy function returns a substring of a string.

S is a string-type expression. Index and Count are integer-type expressions. Copy returns a string containing Count characters starting at S[Index].

If Index is larger than the length of S, Copy returns an empty string.

If Count specifies more characters than are available, the only the characters from S[Index] to the end of S are returned.

Example

 var S: string;

begin

  S := 'ABCDEF';

  S := Copy(S, 2, 3);	{ 'BCD' }

end;


CopyPalette function

Unit

Graphics

CopyPalette creates a new palette object that matches an existing palette.

function CopyPalette(Category: HPALETTE): HPALETTE;

Description

Call CopyPalette to create a new Windows palette object that exactly matches an existing palette. If the Palette parameter does not refer to a valid Windows palette, or if a problem occurs while copying the palette, CopyPalette returns 0.


Cos function

See also

Unit

System

Cos calculates the cosine of an angle.

function Cos(X: Extended): Extended;

Description

The Cos function returns the cosine of the angle X, in radians.

Example

 var R: Extended;

begin

  R := Cos(Pi);

end;


Cosh function

Unit

Math

Cosh calculates the hyperbolic cosine of an angle.

function Cosh(X: Extended): Extended;

Description

The Cosh function calculates the hyperbolic cosine of X.


Cotan function

Unit

Math

Cotan calculates the cotangent of an angle.

function Cotan(X: Extended): Extended;

Description

Call Cotan to obtain the cotangent of X. The cotangent is calculated using the formula

1 / Tan(X)

Note

Do not call Cotan with X = 0.


CreateComObject function

See also

Unit

ComObj

CreateComObject instantiates a single instance of a COM object.

function CreateComObject(const ClassID: TGUID): IUnknown;

Description

CreateComObject creates a single uninitialized object of the class associated with the CLSID specified by the ClassID parameter. CreateComObject is used to create an object of a specified type when the CLSID is known, and when the object is on a local or in-proc server.

CreateComObject is called once to create each new single instance of a class. To create multiple instance of the same class it is recommended to use a class factory.

CreateComObject returns a reference to the identifier of the interface to be used to communicate with the object. For CreateComObject this interface is of type IUnknown. To create OLE objects that return references to the IDispatch interface, use CreateOleObject.


CreateDir function

See also

Unit

SysUtils

CreateDir creates a new directory.

function CreateDir(const Dir: string): Boolean;

Description

The CreateDir function creates a new directory. The return value is True if a new directory was successfully created, or False if an error occurred.


CreateOleObject function

See also

Unit

ComObj

CreateOleObject instantiates a single instance of an OLE automation object.

function CreateOleObject(const ClassName: string): IDispatch;

Description

CreateOleObject creates a single uninitialized object of the class associated with the CLSID specified by the ClassID parameter. CreateOleObject is used to create an object of a specified type when the CLSID is known, and when the object is on a local or in-proc server. Only objects that is not part of an aggregate are created using CreateOleObject.

CreateOleObject is called once to create each new single instance of a class. To create multiple instance of the same class it is recommended to use a class factory.

CreateOleObject returns a reference to the identifier of the interface to be used to communicate with the object. For CreateOleObject this interface is of type IDispatch. To create a COM object that is not an IDispatch interface, use CreateComObject.


CreateRegKey procedure

See also

Unit

ComObj

CreateRegKey creates a registry key that is a subkey of HKEY_CLASSES_ROOT.

procedure CreateRegKey(const Key, ValueName, Value: string);

Description

CreateRegKey creates or opens the key specified by the Key parameter. If the key does not already exist in the registry, CreateRegKey creates it, otherwise CreateRegKey opens it. This is useful for implementing the UpdateRegistry method of a class factory.

Key points to a null-terminated string, which cannot be NULL and cannot begin with the backslash character ('\'). This subkey must be a subkey of HKEY_CLASSES_ROOT.

When the key is created, additional value and type information for the specified key can be set from the parameters passed to CreateRegKey.

ValueName points to a null-terminated string containing the name of the subkey with which a value is associated. This parameter can be null or a pointer to an empty string.

Value points to a buffer containing the data to be stored with the specified value name.

If CreateRegKey is not successful, an EOleError exception is raised.


CreateRemoteComObject function

See also

Unit

ComObj

CreateRemoteComObject creates a Com object on another machine and returns an IUnknown interface for it.

function CreateRemoteComObject(const MachineName: WideString; const ClassID: TGUID):

    IUnknown;

Description

Use CreateRemoteComObject to create an object on a remote server. CreateRemoteComObject creates a single uninitialized object of the class associated with the CLSID specified by the ClassID parameter. The MachineName parameter specifies the machine that lists the ClassID in its type library.

Usually, MachineName is the UNC name of the machine, which can be obtained by looking up the Machine Name of the machine under the Network settings in the Windows control panel. However, under some configurations of COM, MachineName is the IP address or Host name of the remote system.

CreateRemoteComObject returns a reference to the IUnknown interface for the object. Use this interface to obtain information about other interfaces supported by the object.


CurrToFMTBCD function

See also

Unit

DBCommon

CurrToFMTBCD converts a Currency value to the corresponding binary coded decimal (BCD) value.

function CurrToFMTBCD(Curr: Currency; var BCD: FMTBcd; Precision, Decimals: Integer):

   Boolean;

Description

Use CurrToFMTBCD to convert a Currency value, such as is used by Delphi TBCDField objects into a binary coded decimal value, such as is stored in a physical BCD database field. CurrToFMTBCD returns True if the Currency value passed as the Curr parameter is successfully converted into a BCD value which is passed out as the BCD parameter. The Precision parameter specifies the number of digits represented in the BCD value, and the Decimals parameter specifies the number of those digits that are after the decimal point.


CurrToStr function

See also

Unit

SysUtils

CurrToStr converts a currency variable to a string.

function CurrToStr(Value: Currency): string;

Description

The CurrToStr function converts the currency value given by Value to its string representation. The conversion using the ffGeneral floating point conversion rules. For further details, see the description of the CurrToStrF function.


CurrToStrF function

See also

Unit

SysUtils

CurrToStrF converts a currency variable to a string of a specified format.

function CurrToStrF(Value: Currency; Format: TFloatFormat; Digits: Integer): string;

Description

The CurrToStrF function converts the currency value given by Value to its string representation using the indicated float format convention. A call to CurrToStrF corresponds to a call to FloatToStrF with an implied precision of 19 digits.


CycleToRad function

Unit

Math

CycleToRad converts an angle measurement from cycles to radians.

function CycleToRad(Cycles: Extended): Extended;

Description

The CycleToRad function converts angles measured in cycles into radians.


DatabaseError procedure

See also

Unit

DB

DatabaseError creates and raises an EDatabaseError exception.

procedure DatabaseError(const Message: string);

Description

Call DatabaseError to raise an EDatabaseError exception, using Message as the text for the exception. Calling DatabaseError rather than creating and raising the exception directly in code reduces the overall code size of the application.


Date function

See also

Unit

SysUtils

Date gets the current date.

function Date: TDateTime;

Description

The Date function returns the current date.

Example

This example uses a label and a button on a form. When the user clicks the button, the current date is displayed in the caption of the label:

procedure TForm1.Button1Click(Sender: TObject);

begin

  Label1.Caption := 'Today is  ' + DateToStr(Date);

end;


DateTimeToFileDate function

See also

Unit

SysUtils

DateTimeToFileDate converts a TDateTime value to a DOS date-and-time value.

function DateTimeToFileDate(DateTime: TDateTime): Integer;

Description

The FileAge, FileGetDate, and FileSetDate routines operate on DOS date-and-time values, and the Time field of a TSearchRec used by the FindFirst and FindNext functions contains a DOS date-and-time value.


DateTimeToStr function

See also

Unit

SysUtils

DateTimeToStr converts a variable of type TDateTime to a string.

function DateTimeToStr(DateTime: TDateTime): string;

Description

If DateTime parameter does not contain a date value, the date displays as 00/00/00. If the DateTime parameter does not contain a time value, the time displays as 00:00:00 AM.To change how the string is formatting, change some of the date and time typed constants.

Example

This example uses a label and a button on a form. When the user clicks the button, the current date and time is converted to a string and displayed as the caption of the label:

procedure TForm1.Button1Click(Sender: TObject);

begin

  Label1.Caption := DateTimeToStr(Now);

end;


DateTimeToString procedure

See also

Unit

SysUtils

DateTimeToString converts a variable to a string using the specified Format.

procedure DateTimeToString(var NewString: string; const Format:

  string; DateTime: TDateTime);

Description

DateTimeToString converts the date and time value given by DateTime using the format string given by Format into the string variable given by NewString. For Formats supported, refer to the description of the FormatDateTime function.


DateTimeToSystemTime procedure

See also

Unit

SysUtils

DateTimeToSystemTime converts a date and time from Delphi's TDateTime format into the Win32 API's TSystemTime format.

procedure DateTimeToSystemTime(DateTime: TDateTime; var SystemTime: TSystemTime);

Description

Use DateTimeToSystemTime to convert a Delph TDateTime value into a TSystemTime value to use with a Windows 32 API function call.


DateTimeToTimeStamp function

See also

Unit

SysUtils

DateTimeToTimeStamp converts a TDateTime value into the corresponding TTimeStamp value.

function DateTimeToTimeStamp(DateTime: TDateTime): TTimeStamp;

Description

Call DateTimeToTimeStamp to convert a TDateTime value into a TTimeStamp value. TDateTime values represent time as the number of days (including fractional days) that have elapsed since 12:00 am on December 30, 1899. TTimeStamp values represent time as separate date and time values, where the date is the number of calandar days since the start of the current calandar (that is, January 1, 0001 would have a value of 1), and time is the number of milliseconds since midnight.


DateToStr function

See also

Unit

SysUtils

DateToStr converts a variable of type TDateTime to a formatted string.

function DateToStr(Date: TDateTime): string;

Description

The conversion uses the format specified by the ShortDateFormat global variable.

Example

This example uses a label and a button on a form. When the user clicks the button, the current date is converted to a string and displayed as the caption of the label:

procedure TForm1.Button1Click(Sender: TObject);

begin

  Label1.Caption := DateToStr(Date);

end;


DayOfWeek function

See also

Unit

SysUtils

DayOfWeek returns the day of the week for a specified date.

function DayOfWeek(Date: TDateTime): Integer;

Description

The DayOfWeek function returns the day of the week of the specified date as an integer between 1 and 7. Sunday is the first day of the week and Saturday is the seventh.

Example

This example uses a button, an edit box, and a label on a form. When the user enters a date in the edit box using the Month/Day/Year format, the caption of the label reports the day of the week for the specified date.

procedure TForm1.Button1Click(Sender: TObject);

var

  ADate: TDateTime;

begin

  ADate := StrToDate(Edit1.Text);

  Label1.Caption := 'Day ' + IntToStr(DayOfWeek(ADate)) + ' of the week';

end;


DBIError procedure

See also

Unit

DBTables

DBIError creates and raises an EDBEngineError exception for an error code returned by the Borland Database Engine (BDE).

procedure DBIError(ErrorCode: DBIResult);

Description

Call DBIError procedure to raise an EDBEngineError for the error code passed as the ErrorCode parameter. DBIError obtains the error string from the BDE for the error and raises an EDBEngineError exception.


Dec procedure

See also

Unit

System

Dec decrements a variable by 1 or N.

procedure Dec(var X[ ; N: Longint]);

Description

The Dec procedure subtracts one or N from a variable.

Dec(X) corresponds to X := X - 1, and Dec(X, N) corresponds to X := X - N.

X is an ordinal-type variable or a variable of type PChar if the extended syntax is enabled, and N is an integer-type expression. Dec can be used on enumerated types or on pointer variables. Do not use Dec on ordinal-type properties if the property uses a write procedure.

Dec generates optimized code and is especially useful in a tight loop.

Example

 var

  IntVar: Integer;

  LongintVar: Longint;

begin

  Intvar := 10;

  LongintVar := 10;

  Dec(IntVar);	{ IntVar := IntVar - 1 }

  Dec(LongintVar, 5);	{ LongintVar := LongintVar - 5 }

end;


DecodeDate procedure

See also

Unit

SysUtils

DecodeDate breaks TDateTime into Year, Month, and Day values.

procedure DecodeDate(Date: TDateTime; var Year, Month, Day: Word);

Description

The DecodeDate procedure breaks the value specified as the Date parameter into Year, Month, and Day values. If the given TDateTime value is less than or equal to zero, the year, month, and day return parameters are all set to zero.

Example

This example uses a button and two labels on a form. When the user clicks the button, the current date and time are reported in the captions of the two labels.

procedure TForm1.Button1Click(Sender: TObject);

var

  Present: TDateTime;

  Year, Month, Day, Hour, Min, Sec, MSec: Word;

 begin

  Present:= Now;

  DecodeDate(Present, Year, Month, Day);

  Label1.Caption := 'Today is Day ' + IntToStr(Day) + ' of Month '

    + IntToStr(Month) + ' of Year ' + IntToStr(Year);

  DecodeTime(Present, Hour, Min, Sec, MSec);

  Label2.Caption := 'The time is Minute ' + IntToStr(Min) + ' of Hour '

    + IntToStr(Hour);

end;


DecodeTime procedure

See also

Unit

SysUtils

DecodeTime breaks TDateTime into hours, minutes, seconds, and milliseconds.

procedure DecodeTime(Time: TDateTime; var Hour, Min, Sec, MSec: Word);

Description

The DecodeTime procedure breaks the value specified as the Time parameter into hours, minutes, seconds, and milliseconds.

Example

This example uses a button and two labels on a form. When the user clicks the button, the current date and time are reported in the captions of the two labels.

procedure TForm1.Button1Click(Sender: TObject);

var

  Present: TDateTime;

  Year, Month, Day, Hour, Min, Sec, MSec: Word;

 begin

  Present:= Now;

  DecodeDate(Present, Year, Month, Day);

  Label1.Caption := 'Today is Day ' + IntToStr(Day) + ' of Month '

    + IntToStr(Month) + ' of Year ' + IntToStr(Year);

  DecodeTime(Present, Hour, Min, Sec, MSec);

  Label2.Caption := 'The time is Minute ' + IntToStr(Min) + ' of Hour '

    + IntToStr(Hour);

end;


DegToRad function

Unit

Math

DegToRad returns the value of a degree measurement expressed in radians.

function DegToRad(Degrees: Extended): Extended;

Description

The DegToRad function converts degree angles to radians.

{ Radians := Degrees * PI / 180}


Delete procedure

See also

Unit

System

Delete removes a substring from a s string.

procedure Delete(var S: string; Index, Count:Integer);

Description

Removes a substring of Count characters from string S starting with S[Index].

S is a string-type variable. Index and Count are integer-type expressions.

If Index is larger than the length of S, no characters are deleted. If Count specifies more characters than remain starting at the S[Index], Delete removes the rest of the string.

Example

 var

   s: string;

 begin

   s := 'Honest Abe Lincoln';

   Delete(s,8,4);

   Canvas.TextOut(10, 10, s);	{ 'Honest Lincoln' }

 end;


DeleteFile function

See also

Unit

SysUtils

DeleteFile deletes a file from disk, and returns False if the delete fails.

function DeleteFile(const FileName: string): Boolean;

Description

The DeleteFile function erases the file named by FileName from the disk. If the file cannot be deleted or does not exist, the function returns False.

Example

The following code erases the file DELETE.ME in the current directory:

DeleteFile('DELETE.ME');


DeleteRegKey procedure

See also

Unit

ComObj

DeleteRegKey deletes, from the system registry, a single key that is a subkey of HKEY_CLASSES_ROOT.

procedure DeleteRegKey(const Key: string);

Description

Use DeleteRegKey to update the system registry. This is useful for implementing the UpdateRegistry method of a class factory.

DeleteRegKey deletes the subkey of HKEY_CLASSES_ROOT that is passed in as the Key parameter. Key must point to a a null-terminated string, which specifies the name of the key to delete, and cannot be NULL. The Key to delete must not have subkeys.

If DeleteRegKey succeeds it removes the entire specified key from the registry, including all of its values. An exception is raised if it fails.


DirectoryExists function

See also

Unit

FileCtrl

DirectoryExists determines whether a specified directory exists.

function DirectoryExists(Name: string): Boolean;

Description

Call DirectoryExists to determine whether the directory specified by the Name parameter exists. If the directory exists, the function returns True. If the directory does not exist, the function returns False.

If a full path name is entered, DirectoryExists searches for the directory along the designated path. Otherwise, the Name parameter is interpreted as a relative path name within the current directory.


DiskFree function

See also

Unit

SysUtils

DiskFree returns the number of free bytes on a specified drive.

function DiskFree(Drive: Byte): Integer;

Description

DiskFree returns the number of free bytes on the specified drive number, where 0 = Current, 1 = A, 2 = B, and so on.

DiskFree returns -1 if the drive number is invalid.

Example

var

  S: string;

begin

  S := IntToStr(DiskFree(0) div 1024) + ' Kbytes free.';

  Canvas.TextOut(10, 10, S);

end;


DiskSize function

See also

Unit

SysUtils

DiskSize returns the size, in bytes, of the specified drive.

function DiskSize(Drive: Byte): Integer;

Description

DiskSize returns the size in bytes of the specified drive number, where 0 = Current, 1 = A, 2 = B, etc. DiskSize returns -1 if the drive number is invalid.

Example

var

  S: string;

begin

  S := IntToStr(DiskSize(0) div 1024) + ' Kbytes capacity.';

  Canvas.TextOut(10, 10, S);

end;


Dispose procedure

See also

Unit

System

Dispose releases memory allocated for a dynamic variable.

procedure Dispose(var P: Pointer);

Description

After a call to Dispose, the value of P is undefined and it is an error to reference P. If {$I+}, use exceptions to handle this error. When an invalid pointer is passed to Dispose it will raise an EInvalidPointer exception. For more information on handling run-time library exceptions, see Handling RTL Exceptions

Example

type

  Str18 = string[18];

 var

  P: ^Str18;

begin

  New(P);

  P^ := 'Now you see it...';

  Dispose(P);	{ Now you don't... }

end;


DisposeStr procedure

See also

Unit

SysUtils

DisposeStr disposes of a string pointer that was allocated using NewStr.

procedure DisposeStr(P: PString);

Description

DisposeStr is only provided for backwards compatibility with existing code that allocated a string using NewStr. Both DisposeStr and NewStr are obsolete.


DLLCanUnloadNow function

See also

Unit

Comserv

DllCanUnloadNow tells Windows whether it can unload the in-process server exporting this function.

function DllCanUnloadNow: HResult; stdcall;

Description

Do not call DllCanUnloadNow directly. DllCanUnloadNow is exported by ActiveX servers (DLLs) and is called by the Ole engine to indicate whether the server can be unloaded from memory because it is no longer in use. A DLL is no longer in use when it is not managing any existing objects (the reference count on all of its objects is 0).

The return values for DllCanUnloadNow are as follows:

Value	Meaning
S_OK	The DLL can be unloaded.
S_FALSE	The DLL cannot be unloaded now.
Note

DllCanUnloadNow is one of four functions in the ComServ unit that every in-process ActiveX server must export so that Windows can manage the server resources properly. The others are DllGetClassObject, DllRegisterServer, and DllUnregisterServer.


DllGetClassObject function

See also

Unit

Comserv

DllGetClassObject is used to obtain a class factory for an ActiveX object when the ActiveX object resides in an in-process ActiveX server (DLL).

function DllGetClassObject(const CLSID, IID: TGUID; var Obj): HResult; stdcall;

Description

Do not call DllGetClassObject directly.  DllGetClassObject is exported by all ActiveX server DLLs, and it is called internally by the OLE engine. When a user calls CoGetClassObject (or CoCreateInstance, which internally calls CoGetClassObject) to obtain a class factory for an ActiveX object, the OLE engine loads the ActiveX server DLL into memory and calls its DllGetClassObject function.

The parameters to DllGetClassObject are:

CLSID is the class identifier for the ActiveX object to be created by the class factory.

IID is the interface indentifier for the interface through which the caller will communicate with the class factory object to create instances of the object referenced by CLSID. This parameter is nearly always IID_IClassFactory or IID_IClassFactory2.

Obj will hold a pointer to the resulting class factory interface upon successful completion of the function.  If an error occurrs, Obj will be set to nil.

The return values for DLLGetClassObject are as follows:

Value	Meaning
S_OK	The object was retrieved successfully.
E_NOINTERFACE	The object referenced by Obj doesn't support the interface passed in the IID parameter.
CLASS_E_CLASSNOTAVAILABLE	The DLL does not support the class type referenced by the CLSID parameter.
Note

DllGetClassObject is one of four functions in the ComServ unit that every in-process server must export so that Windows can manage the server resources properly. The others are DllCanUnloadNow, DllRegisterServer, and DllUnregisterServer.


DllRegisterServer function

See also

Unit

Comserv

DllRegisterServer registers an in-process ActiveX server in the current module within the system registry.

function DllRegisterServer: HResult; stdcall;

Description

Do not call DllRegisterServer directly. DllRegisterServer is exported by in-process ActiveX servers (DLLs) and instructs the DLL to create its registry entries for the type library and all classes supported in that server module. DLLRegisterServer is usually called when the ActiveX server is installed on a user's system.

If this function fails, the state of the registry for its type library and its classes is indeterminate.

The return values for DllRegisterServer are as follows:

Value	Meaning
S_OK	The registry entries were created successfully.
E_FAIL	The registry entries were not completed.
Note

DllRegisterServer is one of four functions in the ComServ unit that every in-process server must export so that Windows can manage the server resources properly. The others are DllCanUnloadNow, DllGetClassObject, and DllUnregisterServer.


DllUnregisterServer function

See also

Unit

Comserv

DllUnregisterServer unregisters an OLE automation server in the current module with the system registry.

function DllUnregisterServer: HResult; stdcall;

Description

Do not call DllUnregisterServer directly. DllUnregisterServer is exported by in-process automation servers (DLLs) and instructs the DLL to remove entries created through DllRegisterServer. DLLRegisterServer is called when a server is uninstalled.

The return values for DllUnregisterServer are as follows:

Value	Meaning
S_OK	The registry entries were successfully removed.
S_FALSE	Some or all registry entries were not removed.
Note

DllUnregisterServer is one of four functions in the ComServ unit that every in-process server must export so that Windows can manage the server resources properly. The others are DllCanUnloadNow, DllGetClassObject, and DllRegisterServer. It should never be necessary for users to direclty call or alter any of these functions.


DosPathToUnixPath function

See also

Unit

HTTPApp

DosPathToUnixPath converts a DOS-compatible path specification to a Unix-compatible path specification.

function DosPathToUnixPath(const Path: string): string;

Description

Use DosPathToUnixPath to convert a path name on the local machine to a path name that can be sent in an HTTP message, or that will be used by a Unix-based application. DosPathToUnixPath converts all backslash characters (\) to forward slashes (/).

The Path parameter is the Dos-compatible path. The return value is the corresponding Unix-compatibl path.


DoubleDecliningBalance function

Unit

Math

DoubleDecliningBalance calculates the depreciation of an asset using the double-declining balance method.

function DoubleDecliningBalance(Cost, Salvage: Extended; Life, Period: Integer): Extended;

Description

The DoubleDecliningBalance function determines accelerated depreciation values for an asset, given the initial cost, life expectancy, end value, and depreciation period.


EncodeDate function

See also

Unit

SysUtils

EncodeDate returns a TDateTime type for a specified Year, Month, and Day.

function EncodeDate(Year, Month, Day: Word): TDateTime;

Description

The EncodeDate function returns a TDateTime type from the values specified as the Year, Month, and Day parameters.

The year must be between 1 and 9999.

Valid Month values are 1 through 12.

Valid Day values are 1 through 28, 29, 30, or 31, depending on the Month value. For example, the possible Day values for month 2 (February) are 1 through 28 or 1 through 29, depending on whether or not the Year value specifies a leap year.

If the specified values are not within range, an EConvertError exception is raised. The resulting value is one plus the number of days between 12/30/1899 and the given date.

Example

This example uses a button and a label on a form. When the user clicks the button, a specified date is encoded as a MyDate variable of type TDateTime. MyDate is then displayed as a string in the caption of the label.

procedure TForm1.Button1Click(Sender: TObject);

var

  MyDate: TDateTime;

begin

  MyDate := EncodeDate(83, 12, 31);

  Label1.Caption := DateToStr(MyDate);

end;


EncodeTime function

See also

Unit

SysUtils

EncodeTime returns a TDateTime type for a specified Hour, Min, Sec, and MSec.

function EncodeTime(Hour, Min, Sec, MSec: Word): TDateTime;

Description

If the value of the Time24Hour typed constant is False, valid Hour values are 0 through 12. If the value of Time24Hour is True, valid Hour values are 0 through 23.

Valid Min and Sec values are 0 through 59. Valid MSec values are 0 through 999.

If the specified values are not within range, an EConvertError exception is raised. The resulting value is a number between 0 (inclusive) and 1 (not inclusive) that indicates the fractional part of a day given by the specified time. The value 0 corresponds to midnight, 0.5 corresponds to noon, 0.75 corresponds to 6:00 pm, etc.

Example

procedure TForm1.Button1Click(Sender: TObject);

var

  MyTime: TDateTime;

begin

  MyTime := EncodeTime(0, 45, 45, 7);

  Label1.Caption := TimeToStr(MyTime);

end;


EndThread function

See also

Unit

SysUtils

EndThread ends a thread.

function EndThread(ExitCode: Integer);

Description

EndThread calls the ExitThread WinAPI with the ExitCode specified.


Eof function

See also

Unit

System

Eof tests whether the file position is at the end of a file.

Typed or untyped files:

function Eof(var F): Boolean;

Text files:

function Eof [ (var F: Text) ]: Boolean;

Description

The Eof function tests whether or not the current file position is the end-of-file. F is a text file variable. If F is omitted, the standard file variable Input is assumed.

Eof(F) returns True if the current file position is beyond the last character of the file or if the file contains no components; otherwise, Eof(F) returns False.

Example

var

  F1, F2: TextFile;

  Ch: Char;

begin

  if OpenDialog1.Execute then begin

    AssignFile(F1, OpenDialog1.Filename);

    Reset(F1);

    if SaveDialog1.Execute then begin

      AssignFile(F2, OpenDialog1.Filename);

      Rewrite(F2);

      while not Eof(F1) do

      begin

        Read(F1, Ch);

        Write(F2, Ch);

      end;

      CloseFile(F2);

    end;

    CloseFile(F1);

  end;

end;


Eoln function

See also

Unit

System

Eoln tests whethre the file pointer is at the end of a line.

function Eoln [(var F: Text) ]: Boolean;

Description

The Eoln function tests whether the current file position is the end-of-line of a text file. F, if specified, is a text file variable. If F is omitted, the standard file variable Input is assumed.

Eoln(F) returns True if the current file position is at an end-of-line or if Eof(F) is True; otherwise, Eoln(F) returns False.

Example

begin

 { Tells program to wait for keyboard input }

   WriteLn(Eoln);

 end;


Erase procedure

See also

Unit

System

Erase deletes an external file.

procedure Erase(var F);

Description

The Erase procedure deletes the external file associated with F. F is a file variable of any file type.

Always close a file before erasing it.

Example

procedure TForm1.Button1Click(Sender: TObject);

var

  F: Textfile;

begin

  OpenDialog1.Title := 'Delete File';

  if OpenDialog1.Execute then begin

    AssignFile(F, OpenDialog1.FileName);

    try

      Reset(F);

      if MessageDlg('Erase ' + OpenDialog1.FileName + '?',

        mtConfirmation, [mbYes, mbNo], 0) = mrYes then

      begin

        CloseFile(F);

        Erase(F);

      end;

    except

      on EInOutError do

        MessageDlg('File I/O error.', mtError, [mbOk], 0);

    end;

  end;

end;


ExceptAddr function

See also

Unit

SysUtils

ExceptAddr returns the address at which the current exception was raised.

function ExceptAddr: Pointer;

Description

The ExceptAddr function returns the address at which the current exception was raised. If there is no current exception, ExceptAddr returns nil.


ExceptionErrorMessage function

See also

Unit

SysUtils

ExceptionErrorMessage formats a standard error message.

function ExceptionErrorMessage(ExceptObject: TObject; ExceptAddr: Pointer;

  Buffer: PChar; Size: Integer): Integer;

Description

Call ExceptionErrorMessage to assemble an error message that indicates the object associated with the current exception and the location at which the exception was raised. The assembled message is written into the buffer provided by the Buffer parameter. Specify the size of this buffer using the Size parameter.

ExceptionErrorMessage returns the number of bytes in the assembled error message.


ExceptObject function

See also

Unit

SysUtils

ExceptObject returns a reference to the object associated with the current exception.

function ExceptObject: TObject;

Description

The ExceptObject function returns a reference to the current exception object -- that is, the object associated with the currently raised exception. If there is no current exception, ExceptObject returns nil. In most cases, do not call ExceptObject explicitly; instead, use the language construct

on E: ExceptionType do

This constructs maps the identifier E onto the object instance of the current exception statement that follows if the current exception is of ExceptionType. However, when a default exception handler is created using an else in the exception block, the only way to access the current exception object is by calling ExceptObject.


Exclude procedure

See also

Unit

System

Exclude removes an element from a set.

procedure Exclude(var S: set of T;I:T);

Description

The Exclude procedure removes element I from set S.

S is a set type variable, and I is an expression of a type compatible with the base type of S.

The construct Exclude (S, I) corresponds to S := S - (I) but the Exclude procedure generates more efficient code.


Exit procedure

See also

Unit

System

Exit exits from the current procedure.

procedure Exit;

Description

The Exit procedure immediately passes control away from the current procedure.

If the current procedure is the main program, Exit causes the program to terminate.

Exit will cause the calling procedure to continue with the statement after the point at which the procedure was called.

Note

Exit is not constrained by blocks but by procedures.


Exp function

See also

Unit

System

Exp returns the exponential of X.

function Exp(X: Real): Real;

Description

Exp returns the value of e raised to the power of X, where e is the base of the natural logarithms.

Example

 var

  S: string;

begin

  S := 'e = ' + FloatToStr(Exp(1.0));

  Canvas.TextOut(10, 10, S);

end;


ExpandFileName function

See also

Unit

SysUtils

ExpandFileName returns the full path of Filename.

function ExpandFileName(const FileName: string): string;

Description

The ExpandFileName function converts the relative file name into a fully qualified path name by merging in the current drive and directory. A fully qualified path name includes the drive letter and any directory and subdirectories in addition to the file name and extension. ExpandFileName does not verify that the resulting fully qualified path name refers to an existing file, or even that the resulting path exists.

Example

The following code converts a file name into a fully-expanded file name:

MyFileName := ExpandFileName(MyFileName);


ExpandUNCFileName function

See also

Unit

SysUtils

ExpandUNCFileName returns the full path of FileName with the network drive portion in UNC format.

function ExpandUNCFileName(const FileName: string): string;

Description

The ExpandUNCFileName function returns a string containing a fully qualified path name for the file passed in the FileName. A fully qualified path name includes the drive portion of the filename in the UNC format '\\<servername>\<sharename>' if the drive letter is mapped to a network resource instead of a local drive and any directory and subdirectories in addition to the file name and extension.

Delphi programs can use this function to store filenames that are independent of a particular user's drive letter mappings.


ExtractFileDir function

See also

Unit

SysUtils

ExtractFileDir extracts the drive and directory parts from FileName.

function ExtractFileDir(const FileName: string): string;

Description

The resulting string is a directory name suitable for passing to the CreateDir, GetCurrentDir, RemoveDir, and SetCurrentDir functions. The resulting string is empty if FileName contains no drive and directory parts.

Note

This function works for double byte character systems (DBCS).


ExtractFileDrive function

See also

Unit

SysUtils

ExtractFileDrive returns the drive portion from FileName.

function ExtractFileDrive(const FileName: string): string;

Description

The ExtractFileDrive function returns a string containing the 'drive' portion of a fully qualified path name for the file passed in the FileName. For file names with drive letters, the resulting string is in the form '<drive>:'. For file names with a UNC path the resulting string is in the form '\\<servername>\<sharename>'. If the given path contains neither style of path prefix, the result is an empty string.

Delphi programs can use this function to store filenames that are independent of a particular user's drive letter mappings.


ExtractFileExt function

See also

Unit

SysUtils

ExtractFileExt returns the extension portions of FileName.

function ExtractFileExt(const FileName: string): string;

Description

The resulting string includes the period character that separates the name and extension parts. The resulting string is empty if the given filename has no extension. For example, the following code returns the extension from a file name:

MyFilesExtension := ExtractFileExt(MyFileName);

Note

This function works for double byte character systems (DBCS).


ExtractFileName function

See also

Unit

SysUtils

ExtractFileName extracts the name and extension parts of FileName.

function ExtractFileName(const FileName: string): string;

Description

The resulting string is the leftmost characters of FileName, starting with the first character after the colon or backslash that separates the path information from the name and extension. The resulting string is equal to FileName if FileName contains no drive and directory parts.

Example

The following code changes the caption of Form1 to read "Editing <FileName>".

Form1.Caption := 'Editing '+ ExtractFileName(FileName);

Note

This function works for double byte character systems (DBCS).


ExtractFilePath function

See also

Unit

SysUtils

ExtractFilePath returns the drive and directory portions of FileName.

function ExtractFilePath(const FileName: string): string;

Description

The resulting string is the rightmost characters of FileName, up to and including the colon or backslash that separates the path information from the name and extension. The resulting string is empty if FileName contains no drive and directory parts.

Example

The following code changes the current directory to the location of FileName.

ChDir(ExtractFilePath(FileName));

Note

This function works for double byte character systems (DBCS).


ExtractHTTPFields
ExtractHTTPFields procedure

See also

Unit

HTTPApp

ExtractHTTPFields parses a multi-valued string into its constituent fields.

procedure ExtractHTTPFields(Separators, WhiteSpace: TCharSet; Content: PChar; Strings: TStrings);

Description

ExtractHTTPFields is a general utility to parse multi-valued HTTP header strings into separate substrings.

Separators is a set of characters that are used to separate individual values within the multi-valued string. WhiteSpace is a set of characters that are to be ignored when parsing the string. Content is the multi-valued string to be parsed. Strings is the TStrings object that receives the individual values that are parsed from Content.

Characters contained in Separators or WhiteSpace will be treated as part of a value substring if the substring is surrounded by single or double quote marks. HTTP escape characters are converted using the HTTPDecode function.


ExtractRelativePath function

See also

Unit

SysUtils

ExtractRelativePath returns a relative path name, relative to a specific base directory.

function ExtractRelativePath(const BaseName, DestName: string): string;

Description

Call ExtractRelativePath to convert a fully qualified path name into a relative path name.  The DestName parameter specifies the path and file name to be converted.  BaseName is the fully qualified name of the base directory to which the returned path name should be relative.

ExtractRelativePath strips out common path directories and inserts '..\' for each level up from the BaseName.


FileAge function

Unit

SysUtils

Category

File management routines

FileAge returns the date-and-time stamp of the specified file.

function FileAge(const FileName: string): Integer;

Description

The return value can be converted to a TDateTime value using the FileDateToDateTime function. The return value is -1 if the file does not exist.


FileClose procedure

See also

Unit

SysUtils

Category

File management routines

FileClose closes a specified file.

procedure FileClose(Handle: Integer);

Description

The FileClose procedure closes the specified file. Use of the non-native Pascal file variable handlers such as FileClose is discouraged. For more information on which file handling routines to use see FileOpen.

Example

The following code closes a file opened with FileOpen:

FileClose(MyFileHandle);


FileCreate function

See also

Unit

SysUtils

Category

File management routines

FileCreate creates a new file.

function FileCreate(const FileName: string): Integer;

Description

The FileCreate function creates a new file of the specified name. If the return value is positive, the function was successful and the value is the file handle of the new file. A return value of -1 indicates that an error occurred.

Use of the non-native Pascal file variable handlers such as FileCreate is discouraged. For more information on which file handling routines to use see FileOpen.

Example

The following example creates a new file and assigns it to the identifier MyFileHandle.

MyFileHandle := FileCreate('NEWFILE.TXT');


FileDateToDateTime function

See also

Unit

SysUtils

Category

File management routines

FileDateToDateTime converts a DOS date-time value to TDateTime format.

function FileDateToDateTime(FileDate: Integer): TDateTime;

Description

The FileAge, FileGetDate, and FileSetDate routines operate on DOS date-time values, and the Time field of a TSearchRec used by the FindFirst and FindNext functions contains a DOS date-time value.


FileExists function

See also

Unit

SysUtils

Category

File management routines

FileExists tests if FileName exists.

function FileExists(const FileName: string): Boolean;

Description

The FileExists function returns True if the file specified by FileName exists. If the file does not exist, FileExists returns False.

Example

The following code prompts for confirmation before deleting a file:

if FileExists(FileName) then

  if MsgBox('Do you really want to delete ' + ExtractFileName(FileName)

    + '?'), []) = IDYes then DeleteFile(FileName);


FileGetAttr function

See also

Unit

SysUtils

Category

File management routines

FileGetAttr returns the file attributes of FileName.

function FileGetAttr(const FileName: string): Integer;

Description

The attributes can be examined by AND-ing the attributes with the constants defined in TSearchRec. A return value of -1 indicates that an error occurred.


FileGetDate function

See also

Unit

SysUtils

Category

File management routines

FileGetDate returns a DOS date-time stamp for the specified file.

function FileGetDate(Handle: Integer): Integer;

Description

The return value is -1 if the handle is invalid. The FileDateToDateTime function can be used to convert the returned value to a TDateTime value.


FileOpen function

See also

Unit

SysUtils

Category

File Management Routines

FileOpen opens a specified file using the specified access mode.

function FileOpen(const FileName: string; Mode: Integer): Integer;

Description

The access mode value is constructed by OR-ing one of the fmOpen constants with one of the fmShare constants defined by the File open mode constants. If the return value is positive, the function was successful and the value is the file handle of the opened file. A return value of -1 indicates that an error occurred.

Example

procedure OpenForShare(const FileName: String);

var

  FileHandle : Integer;

begin

  FileHandle := FileOpen(FileName, fmOpenWrite or fmShareDenyNone);

  if FileHandle > 0 then

    [valid file handle}

  else

    [Open error: FileHandle = negative DOS error code]

end;

Note

Use of the non-native Pascal file variable handlers such as FileOpen is discouraged. These routines map to the Windows API functions and return file handles, not normal Pascal file variables. These are low-level file access routines. For normal file operations use the normal AssignFile, Rewrite, Reset operations instead of FileOpen.


FilePos function

See also

Unit

System

Category

I/O routines

FilePos returns the current file position.

function FilePos(var F): Longint;

Description

To use FilePos the file must be open and it can't be used on a text file.

F is a file variable.

Position	Result
Beginning of file	FilePos(F) = 0
Middle of file	FilePos(F) = current file position
End of file	Eof(F) = True
{$I+} handles run-time errors using exceptions. For more information on handling run-time library exceptions, see Handling RTL Exceptions

When using {$I-}, use IOResult to check for I/O errors.

Example

var

   f: file of Byte;

   size : Longint;

   S: string;

   y: integer;

 begin

   if OpenDialog1.Execute then begin

     AssignFile(f, OpenDialog1.FileName);

     Reset(f);

     size := FileSize(f);

     S := 'File size in bytes: ' + IntToStr(size);

     y := 10;

     Canvas.TextOut(5, y, S);

     y := y + Canvas.TextHeight(S) + 5;

     S := 'Seeking halfway into file...';

     Canvas.TextOut(5, y, S);

     y := y + Canvas.TextHeight(S) + 5;

     Seek(f,size div 2);

     S := 'Position is now ' + IntToStr(FilePos(f));

     Canvas.TextOut(5, y, S);

     CloseFile(f);

   end;

 end;


FileRead function

See also

Unit

SysUtils

Category

I/O routines

FileRead reads a specified number of bytes from a file.

function FileRead(Handle: Integer; var Buffer; Count: Integer): Integer;

Description

The FileRead function reads Count bytes from the Handle into the buffer. The function result is the actual number of bytes read, which may be less than Count. The Handle that is passed to FileRead must be opened with FileOpen or FileCreate. Do not mix routines that take or return file handles with those that use Pascal file variables (typically seen as var F).

Example

The following code fills a buffer from a file.

ActualRead := FileRead(MyFileHandle, Buffer, SizeOf(Buffer));

Note

Use of the non-native Pascal file variable handlers such as FileRead is discouraged. For more information on which file handling routines to use see FileOpen.


ileSearch function
FileSearch function

See also

Unit

SysUtils

Category

File management routines

FileSearch searchs a specified DOS path for a file.

function FileSearch(const Name, DirList: string): string;

Description

The FileSearch function searches through the directories passed in DirList for a file named Name. DirList should be in the same format as a DOS path: directory names separated by semicolons. If FileSearch locates a file matching Name, it returns a string containing a fully-qualified path name for that file. If no matching file exists, FileSearch returns an empty string.

Example

The following code searches for FINDME.DLL in a series of directories:

FoundIt := FileSearch('FINDME.DLL', MyAppDir+'\';'+WinDir+';'+WinDir+'\SYSTEM');


FileSeek function

See also

Unit

SysUtils

Category

File management routines

FileSeek positions the current file pointer within a previously opened file.

function FileSeek(Handle, Offset, Origin: Integer): Integer;

Description

Handle contains the file handle. The Handle that is passed to FileSeek must have been opened with FileOpen or FileCreate. Do not mix routines that take or return file handles with those that use Pascal file variables (typically seen as var F).

Offset specifies the number of bytes from Origin where the file pointer should be positioned. Origin is a code with three possible values, denoting the beginning of the file, the end of the file, and the current position of the file pointer.

Origin	Action
0	The file pointer is positioned Offset bytes from the beginning of the file.
1	The file pointer is positioned Offset bytes from its current position.
2	The file pointer is positioned Offset bytes from the end of the file.
If FileSeek is successful, it returns the new position of the file pointer; otherwise, it returns -1.

Example

The following code positions the file pointer at the end of a file:

if FileSeek(MyFileHandle,0,2) = HFILE_ERROR then

  HandleFileError

else

  AppendStuff;

Note

Use of the non-native Pascal file variable handlers such as FileRead is discouraged. For more information on which file handling routines to use see FileOpen.


FileSetAttr function

See also

Unit

SysUtils

Category

File management routines

FileSetAttr sets the file attributes of a specified file.

function FileSetAttr(const FileName: string; Attr: Integer): Integer;

Description

The FileSetAttr function sets the file attributes of the file given by FileName to the value given by Attr. The attribute value is formed by OR-ing the appropriate TSearchRec type constants. The return value is zero if the function was successful. Otherwise the return value is a Windows error code.


FileSetDate function

See also

Unit

SysUtils

Category

File management routines

FileSetDate sets the DOS time stamp for a specified file.

function FileSetDate(Handle: Integer; Age: Integer): Integer;

Description

The FileSetDate function sets the DOS date-time stamp of the file given by Handle to the value given by Age. The DateTimeToFileDate function can be used to convert a TDateTime value to a DOS date-time stamp. The return value is zero if the function was successful. Otherwise the return value is a Windows error code.


FileSize function

See also

Unit

System

Category

I/O routines

FileSize returns the size of a file in bytes or the number of records in a record file.

function FileSize(var F): Integer;

Description

Call FileSize to determine the size of a file. To use FileSize, the file must be open. If the file is empty, FileSize(F) returns 0. F is a file variable.

Note

FileSize can't be used on a text file.

Example

var

   f: file of Byte;

   size : Longint;

   S: string;

   y: integer;

 begin

   if OpenDialog1.Execute then begin

     AssignFile(f, OpenDialog1.FileName);

     Reset(f);

     size := FileSize(f);

     S := 'File size in bytes: ' + IntToStr(size);

     y := 10;

     Canvas.TextOut(5, y, S);

     y := y + Canvas.TextHeight(S) + 5;

     S := 'Seeking halfway into file...';

     Canvas.TextOut(5, y, S);

     y := y + Canvas.TextHeight(S) + 5;

     Seek(f,size div 2);

     S := 'Position is now ' + IntToStr(FilePos(f));

     Canvas.TextOut(5, y, S);

     CloseFile(f);

   end;

 end;


FileWrite function

See also

Unit

SysUtils

Category

File management routines

FileWrite is an internal routine for writing to files.

function FileWrite(Handle: Integer; const Buffer; Count: Integer): Integer;

Description

The FileWrite function writes Count bytes to the file given by Handle from the buffer specified by Buffer. The return value is the number of bytes actually written, or -1 if an error occurred.

Use of non-native Pascal file variable handlers such as FileWrite is discouraged. For more information on which file handling routines to use, see FileOpen.


FillChar procedure

See also

Unit

System

Category

Miscellaneous routines

FillChar fills contiguous bytes with a specified value.

procedure FillChar(var X; Count: Integer; value: Byte);

Description

The FillChar procedure fills Count number of contiguous bytes with a specified value (can be type Byte or Char).

This function does not perform any range checking.

Example

 var

  S: array[0..79] of char;

begin

  { Set to all spaces }

  FillChar(S, SizeOf(S), ' ');

end;


Finalize procedure

See also

Unit

System

Finalize uninitializes a dynamically allocated variable.

procedure Finalize( var V [; Count: Integer] );

Description

Finalize should be used only in situations where a dynamically allocated variable is deallocated by other means than the Dispose standard procedure.

For global variables, local variables, objects, and dynamic variables deallocated using the Dispose standard procedure, the compiler generates code that finalizes all long strings and variants contained by a variable upon destruction of the variable. If a dynamic variable is deallocated by other means than the Dispose standard procedure (for example using FreeMem), if the variable contains long strings or variants, and if all long strings and variants are not empty or Unassigned, a call to Finalize is required to finalize the variable before it can be deallocated. Finalize simply sets all long strings to empty and all variants to Unassigned, thus properly releasing any memory that was referenced by the long strings and variants.

In cases where several variables are deallocated in a contiguous memory block such as a dynamically allocated array of strings, the additional Count parameter can be specified to finalize all variables in one operation.

If the variable specified in a call to Finalize contains no long strings and variants, the compiler eliminates the call and generates no code for it.


FinalizePackage procedure

See also

Unit

SysUtils

FinalizePackage finalizes the specified package DLL.

procedure FinalizePackage(Module: HMODULE);

Description

FinalizePackage calls the finalization blocks of all units in the specified package.

Note

The UnloadPackage procedure calls FinalizePackage internally.


FindClose procedure

See also

Unit

SysUtils

Category:

File management routines

FindClose releases memory allocated by FindFirst.

procedure FindClose(var F: TSearchRec);

Description

FindClose terminates a FindFirst/FindNext sequence. FindClose does nothing in the 16-bit version of Windows, but is required in the 32-bit version, so for maximum portability every FindFirst/FindNext sequence should end with a call to FindClose.


FindControl function

See also

Unit

Controls

FindControl returns the windowed control whose window is identified by the specified window handle.

function FindControl(Handle: HWnd): TWinControl;

Description

Call FindControl to access the windowed control whose window is identified by the Handle parameter. If Handle is not the handle of the window of a windowed control, FindControl returns nil.


FindDragTarget function

See also

Unit

Controls

FindDragTarget returns the control at a specified screen coordinate.

function FindDragTarget(const Pos: TPoint; AllowDisabled: Boolean): TControl;

Description

Call FindDragTarget to determine the potential drag-and-drop target currently under the mouse. FindDragTarget returns the control at the position specified by the Pos parameter. If there is not control at the specified position, FindDragTarget returns nil. The AllowDisabled parameter determines whether the search includes disabled controls.

If FindDragTarget returns a control, this does not mean that the control will necessarily accept the dragged object. The control will only accept the dragged object if it has an OnDragOver event handler that accepts the object.


FindFirst function

See also

Unit

SysUtils

Category

File management routines

FindFirst searches for the first instance of a file name with a given set of attributes in a specified directory.

function FindFirst(const Path: string; Attr: Integer; var F: TSearchRec): Integer;

Description

FindFirst searches the directory specified by Path for the first file that matches the file name implied by Path and the attributes specified by the Attr parameter. The result is returned in the F parameter. Use the fields of this search record to extract the information needed. FileFirst returns 0 if a file was successfully located, otherwise, it returns a Windows error code.

The Path constant parameter is the directory and file name mask, including wildcard characters. For example, 'c:\test\*.*' specifies all files in the C:\TEST directory).

The Attr parameter specifies the special files to include in addition to all normal files. Choose from these file attribute constants when specifying the Attr parameter:

Constant	Value	Description
faReadOnly	$00000001	Read-only files
faHidden	$00000002	Hidden files
faSysFile	$00000004	System files
faVolumeID	$00000008	Volume ID files
faDirectory	$00000010	Directory files
faArchive	$00000020	Archive files
faAnyFile	$0000003F	Any file
Attributes can be combined by adding their constants or values. For example, to search for read-only and hidden files in addition to normal files, pass (faReadOnly + faHidden) the Attr parameter.

Note

The FindFirst function allocates resources (memory) which must be released by calling FindClose.

Example

FindFirst is typically used in conjunction with FindNext and FindClose as follows, where ProcessSearchRec represents user-defined code that processes the information in a search record:

begin

    Found := FindFirst(Path, Attr, SearchRec);

    while Found = 0 do

    begin

      ProcessSearchRec(SearchRec);

      Found := FindNext(SearchRec);

    end;

    FindClose(SearchRec);

end;


FindNext function

See also

Unit

SysUtils

Category

File management routines

FindNext returns the next entry matching the name and attributes specified in a previous call to FindFirst.

function FindNext(var F: TSearchRec): Integer;

Description

FindNext returns the next entry that matches the name and attributes specified in a previous call to FindFirst. The search record must be one that was passed to FindFirst. The return value is zero if the function was successful. Otherwise the return value is a Windows error code.

Example

This example uses a label, a button named Search, and a button named Again on a form. When the user clicks the Search button, the first file in the specified path is found, and the name and the number of bytes in the file appear in the label's caption. Each time the user clicks the Again button, the next matching file name and size is displayed in the label:

var

  SearchRec: TSearchRec;

procedure TForm1.SearchClick(Sender: TObject);

begin

  FindFirst('c:\delphi\bin\*.*', faAnyFile, SearchRec);

  Label1.Caption := SearchRec.Name + ' is ' + IntToStr(SearchRec.Size) +

    ' bytes in size';

end;

procedure TForm1.AgainClick(Sender: TObject);

begin

  FindNext(SearchRec);

  Label1.Caption := SearchRec.Name + ' is ' + IntToStr(SearchRec.Size) +

    ' bytes in size';

end;


FloatToDecimal procedure

Unit

SysUtils

Category

Floating point conversion routines

FloatToDecimal converts a floating-point value to a decimal representation.

procedure FloatToDecimal(var DecVal: TFloatRec; const Value; ValueType: TFloatValue; Precision, Decimals: Integer);

Description

FloatToDecimal converts a floating-point value to a decimal representation that is suited for further formatting.

The Value parameter must be a variable of type Extended or Currency, as indicated by the ValueType parameter.

For values of type Extended, the Precision parameter specifies the requested number of significant digits in the result--the allowed range is 1..18. For values of type Currency, the Precision parameter is ignored, and the implied precision of the conversion is 19 digits.

The Decimals parameter specifies the requested maximum number of digits to the left of the decimal point in the result. Precision and Decimals together control how the result is rounded. To produce a result that always has a given number of significant digits regardless of the magnitude of the number, specify 9999 for the Decimals parameter.

The result of the conversion is stored in the specified TFloatRec record as follows:

Field	Value
Exponent	Contains the magnitude of the number, i.e. the number of significant digits to the right of the decimal point. The Exponent field is negative if the absolute value of the number is less than one. If the number is a NAN (not-a-number), Exponent is set to -32768. If the number is INF or -INF (positive or negative infinity), Exponent is set to 32767.
Negative	True if the number is negative, False if the number is zero or positive.
Digits	Contains up to 18 (for type Extended) or 19 (for type Currency) significant digits followed by a null terminator. The implied decimal point (if any) is not stored in Digits. Trailing zeros are removed, and if the resulting number is zero, NAN, or INF, Digits contains nothing but the null terminator.


FloatToStr function

Unit

SysUtils

Category

Floating point conversion routines

FloatToStr converts a floating point value to a string.

function FloatToStr(Value: Extended): string;

Description

FloatToStr converts the floating-point value given by Value to its string representation. The conversion uses general number format with 15 significant digits.

For further details, see the description of the FloatToStrF function.


FloatToStrF function

Unit

SysUtils

Category

Floating point conversion routines

FloatToStrF converts a floating point value to a string, using a specified Format, Precision, and Digits.

function FloatToStrF(Value: Extended; Format: TFloatFormat; Precision,
  Digits: Integer): string;

Description

FloatToStrF converts the floating-point value given by Value to its string representation.

The Format parameter controls the format of the resulting string.

The Precision parameter specifies the precision of the given value. It should be 7 or less for values of type Single, 15 or less for values of type Double, and 18 or less for values of type Extended.

The meaning of the Digits parameter depends on the particular format selected.

The possible values of the Format parameter, and the meaning of each, are described below.

Value	Meaning
ffGeneral	General number format. The value is converted to the shortest possible decimal string using fixed or scientific format. Trailing zeros are removed from the resulting string, and a decimal point appears only if necessary. The resulting string uses fixed point format if the number of digits to the left of the decimal point in the value is less than or equal to the specified precision, and if the value is greater than or equal to 0.00001. Otherwise the resulting string uses scientific format, and the Digits parameter specifies the minimum number of digits in the exponent (between 0 and 4).
ffExponent	Scientific format. The value is converted to a string of the form "-d.ddd...E+dddd". The resulting string starts with a minus sign if the number is negative, and one digit always precedes the decimal point. The total number of digits in the resulting string (including the one before the decimal point) is given by the Precision parameter. The "E" exponent character in the resulting string is always followed by a plus or minus sign and up to four digits. The Digits parameter specifies the minimum number of digits in the exponent (between 0 and 4).
ffFixed	Fixed point format. The value is converted to a string of the form "-ddd.ddd...". The resulting string starts with a minus sign if the number is negative, and at least one digit always precedes the decimal point. The number of digits after the decimal point is given by the Digits parameter--it must be between 0 and 18. If the number of digits to the left of the decimal point is greater than the specified precision, the resulting value will use scientific format.
ffNumber	Number format. The value is converted to a string of the form "-d,ddd,ddd.ddd...". The ffNumber format corresponds to the ffFixed format, except that the resulting string contains thousand separators.
ffCurrency	Currency format. The value is converted to a string that represents a currency amount. The conversion is controlled by the CurrencyString, CurrencyFormat, NegCurrFormat, ThousandSeparator, and DecimalSeparator global variables, all of which are initialized from the Currency Format in the International section of the Windows Control Panels. The number of digits after the decimal point is given by the Digits parameter--it must be between 0 and 18.
For all formats, the actual characters used as decimal and thousand separators are obtained from the DecimalSeparator and ThousandSeparator global variables.

If the given value is a NAN (not-a-number), the resulting string is 'NAN'. If the given value is positive infinity, the resulting string is 'INF'. If the given value is negative infinity, the resulting string is '-INF'.


FloatToText function

See also

Unit

SysUtils

Category

Floating point conversion routines

FloatToText converts a floating-point value to an unterminated character string, using a specified Format, Precision and Digits.

function FloatToText(Buffer: PChar; const Value; ValueType: TFloatValue; Format: TFloatFormat; Precision, Digits: Integer): Integer;

Description

The FloatToText function converts the given floating-point value to its decimal representation using the specified format, precision, and digits. The Value parameter must be a variable of type Extended or Currency, as indicated by the ValueType parameter. The resulting string of characters is stored in the given buffer, and the returned value is the number of characters stored. The resulting string is not null-terminated.


FloatToTextFmt function

See also

Unit

SysUtils

Category

Floating point conversion routines

FloatToTextFmt converts a floating-point value to to an unterminated character string, using a specified format.

function FloatToTextFmt(Buffer: PChar; const Value; ValueType: TFloatValue; Format: PChar): Integer;

Description

The Value parameter must be a variable of type Extended or Currency, as indicated by the ValueType parameter. The resulting string of characters is stored in the given buffer, and the returned value is the number of characters stored. The resulting string is not null-terminated.

Formats supported are described as part of the FormatFloat function.


Floor function

Unit

Math

Floor rounds variables down.

function Floor(X: Extended): Integer;

Description

The Floor function rounds toward negative infinity. For example:

Floor(-2.8) = -3

Floor(2.8) = 2

Floor(-1.0) = -1

{ Floor: Largest integer <= X,  |X| < MaxInt }


Flush procedure

See also

Unit

System

Category

Text file routines

Flush empties the buffer of a text file opened for output.

procedure Flush(var F: Text);

Description

F is a text file variable.

When a text file is opened for output using Rewrite or Append, Flush empties the file's buffer. This guarantees that all characters written to the file at that time have actually been written to the external file. Flush has no effect on files opened for input.

{$I+} handles run-time errors using exceptions. For more information on handling run-time library exceptions, see Handling RTL Exceptions

When using {$I-}, use IOResult to check for I/O errors.

Example

var

  f: TextFile;

begin

  if OpenDialog1.Execute then

  begin                                                            { open a text file }

    AssignFile(f, OpenDialog1.FileName);

    Append(f);

    Writeln(f, 'I am appending some stuff to the end of the file.');

    Flush(f);  { ensures that the text was actually written to file }

    { insert code here that would require a Flush before closing the file }

    CloseFile(f);

  end;

end;


FMTBCDToCurr

See also

Unit

DBCommon

FMTBCDToCurr converts a binary coded decimal value (BCD) to the corresponding Currency value.

function FMTBCDToCurr(const BCD: FMTBcd; var Curr: Currency): Boolean;

Description

Use FMTBCDToCurr to convert a binary coded decimal value, such as is stored in a physical BCD database field, into a Currency value, which is the representation used by Delphi TBCDField objects. FMTBCDToCurr returns True if the BCD value passed as the BCD parameter is successfully converted into a Currency value which is passed out as the Curr parameter.


FmtLoadStr function

See also

Unit

SysUtils

Category

String formatting routines

FmtLoadStr returns formatted output using a resourced format string.

function FmtLoadStr(Ident: Integer; const Args: array of const): string;

Description

FmtLoadStr loads a string from a program's resource string table and uses that string, plus the Args array, as a parameter to Format. Ident is the string resource ID of the desired format string. Result is the output of Format.

For information on the format strings, see Format Strings.


FmtStr procedure

See also

Unit

SysUtils

Category

String formatting routines

FmtStr assembles a formatted string using a format string and a series of array arguments.

procedure FmtStr(var StrResult: string; const Format: string; const Args: array of const);

Description

This function formats the series of arguments in the open array Args. Formatting is controlled by the Pascal format string Format; the results are returned in the parameter StrResult.

For information on the format strings, see Format Strings.


ForceDirectories procedure

See also

Unit

FileCtrl

ForceDirectories creates all the directories along a directory path if they do not already exist.

procedure ForceDirectories(Dir: string);

Description

DOS and Windows only allow directories to be created one at a time. For example, to create the C:\APPS\SALES\LOCAL directory, the APPS and SALES directories must exist before the LOCAL directory can be created. Use ForceDirectories to create a directory and all parent directories that do not already exist.

Example

This example uses a label and a button on a form. When the user clicks the button, all the directories along the specified path that don't exist are created. The results are reported in the caption of the label:

procedure TForm1.Button1Click(Sender: TObject);

var

  Dir: string;

begin

  Dir := 'C:\APPS\SALES\LOCAL';

  ForceDirectories(Dir);

  if DirectoryExists(Dir) then

    Label1.Caption := Dir + ' was created'

end;


Format function

Unit

SysUtils

Category

String formatting routines

Format returns a formatted string assembled from a Pascal format string and a series of array arguments.

function Format(const Format: string; const Args: array of const): string;

Description

This function formats the series of arguments in the open array Args. Formatting is controlled by the Object Pascal format string Format; the results are returned in the function result as a Pascal string.

For information on the format strings, see Format Strings.


FormatBuf function

Unit

SysUtils

Category

String formatting routines

FormatBuf formats the arguments from an array, placing the result in Buffer.

function FormatBuf(var Buffer; BufLen: Cardinal; const Format; FmtLen: Cardinal; const Args: array of const): Cardinal;

Description

This function formats the series of arguments in the open array Args. Formatting is controlled by the format string Format (whose length is given by FmtLen); the results are returned in Buffer (whose length is given by BufLen). The function returns the length, in bytes, of the resulting string.

For information on the format strings, see Format Strings.


FormatCurr function

See also

Unit

SysUtils

FormatCurr formats a currency value.

function FormatCurr(const Format: string; Value: Currency): string;

Description

FormatCurr formats the currency value given by Value using the format string given by Format. For further details, see the description of the FormatFloat function.


FormatDateTime function

Unit

SysUtils

Category

Date/Time routines

FormatDateTime formats a date-and-time value.

function FormatDateTime(const Format: string; DateTime: TDateTime): string;

Description

FormatDateTime formats the date-and-time value given by DateTime using the format given by Format. The following format specifiers are supported:

Specifier	Displays
c	Displays the date using the format given by the ShortDateFormat global variable, followed by the time using the format given by the LongTimeFormat global variable. The time is not displayed if the fractional part of the DateTime value is zero.
d	Displays the day as a number without a leading zero (1-31).
dd	Displays the day as a number with a leading zero (01-31).
ddd	Displays the day as an abbreviation (Sun-Sat) using the strings given by the ShortDayNames global variable.
dddd	Displays the day as a full name (Sunday-Saturday) using the strings given by the LongDayNames global variable.
ddddd	Displays the date using the format given by the ShortDateFormat global variable.
dddddd	Displays the date using the format given by the LongDateFormat global variable.
m	Displays the month as a number without a leading zero (1-12). If the m specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
mm	Displays the month as a number with a leading zero (01-12). If the mm specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
mmm	Displays the month as an abbreviation (Jan-Dec) using the strings given by the ShortMonthNames global variable.
mmmm	Displays the month as a full name (January-December) using the strings given by the LongMonthNames global variable.
yy	Displays the year as a two-digit number (00-99).
yyyy	Displays the year as a four-digit number (0000-9999).
h	Displays the hour without a leading zero (0-23).
hh	Displays the hour with a leading zero (00-23).
n	Displays the minute without a leading zero (0-59).
nn	Displays the minute with a leading zero (00-59).
s	Displays the second without a leading zero (0-59).
ss	Displays the second with a leading zero (00-59).
t	Displays the time using the format given by the ShortTimeFormat global variable.
tt	Displays the time using the format given by the LongTimeFormat global variable.
am/pm	Uses the 12-hour clock for the preceding h or hh specifier, and displays 'am' for any hour before noon, and 'pm' for any hour after noon. The am/pm specifier can use lower, upper, or mixed case, and the result is displayed accordingly.
a/p	Uses the 12-hour clock for the preceding h or hh specifier, and displays 'a' for any hour before noon, and 'p' for any hour after noon. The a/p specifier can use lower, upper, or mixed case, and the result is displayed accordingly.
ampm	Uses the 12-hour clock for the preceding h or hh specifier, and displays the contents of the TimeAMString global variable for any hour before noon, and the contents of the TimePMString global variable for any hour after noon.
/	Displays the date separator character given by the DateSeparator global variable.
:	Displays the time separator character given by the TimeSeparator global variable.
'xx'/"xx"	Characters enclosed in single or double quotes are displayed as-is, and do not affect formatting.
Format specifiers may be written in upper case as well as in lower case letters--both produce the same result.

If the string given by the Format parameter is empty, the date and time value is formatted as if a 'c' format specifier had been given.

Example

The following example assigns 'The meeting is on Wednesday, February 15, 1995 at 10:30 AM' to the string variable S.

S := FormatDateTime('"The meeting is on" dddd, mmmm d, yyyy, ' +

  '"at" hh:mm AM/PM', StrToDateTime('2/15/95 10:30am'));


FormatFloat function

Unit

SysUtils

Category

Floating point conversion routines

FormatFloat formats a floating point value.

function FormatFloat(const Format: string; Value: Extended): string;

Description

FormatFloat formats the floating-point value given by Value using the format string given by Format. The following format specifiers are supported in the format string:

Specifier	Represents
0	Digit place holder. If the value being formatted has a digit in the position where the '0' appears in the format string, then that digit is copied to the output string. Otherwise, a '0' is stored in that position in the output string.
#	Digit placeholder. If the value being formatted has a digit in the position where the '#' appears in the format string, then that digit is copied to the output string. Otherwise, nothing is stored in that position in the output string.
.	Decimal point. The first '.' character in the format string determines the location of the decimal separator in the formatted value; any additional '.' characters are ignored. The actual character used as a the decimal separator in the output string is determined by the DecimalSeparator global variable. The default value of DecimalSeparator is specified in the Number Format of the International section in the Windows Control Panel.
,	Thousand separator. If the format string contains one or more ',' characters, the output will have thousand separators inserted between each group of three digits to the left of the decimal point. The placement and number of ',' characters in the format string does not affect the output, except to indicate that thousand separators are wanted. The actual character used as a the thousand separator in the output is determined by the ThousandSeparator global variable. The default value of ThousandSeparator is specified in the Number Format of the International section in the Windows Control Panel.
E+	Scientific notation. If any of the strings 'E+', 'E-', 'e+', or 'e-' are contained in the format string, the number is formatted using scientific notation. A group of up to four '0' characters can immediately follow the 'E+', 'E-', 'e+', or 'e-' to determine the minimum number of digits in the exponent. The 'E+' and 'e+' formats cause a plus sign to be output for positive exponents and a minus sign to be output for negative exponents. The 'E-' and 'e-' formats output a sign character only for negative exponents.
'xx'/"xx"	Characters enclosed in single or double quotes are output as-is, and do not affect formatting.
;	Separates sections for positive, negative, and zero numbers in the format string.
The locations of the leftmost '0' before the decimal point in the format string and the rightmost '0' after the decimal point in the format string determine the range of digits that are always present in the output string.

The number being formatted is always rounded to as many decimal places as there are digit placeholders ('0' or '#') to the right of the decimal point. If the format string contains no decimal point, the value being formatted is rounded to the nearest whole number.

If the number being formatted has more digits to the left of the decimal separator than there are digit placeholders to the left of the '.' character in the format string, the extra digits are output before the first digit placeholder.

To allow different formats for positive, negative, and zero values, the format string can contain between one and three sections separated by semicolons.

One section: The format string applies to all values.

Two sections: The first section applies to positive values and zeros, and the second section applies to negative values.

Three sections: The first section applies to positive values, the second applies to negative values, and the third applies to zeros.

If the section for negative values or the section for zero values is empty, that is if there is nothing between the semicolons that delimit the section, the section for positive values is used instead.

If the section for positive values is empty, or if the entire format string is empty, the value is formatted using general floating-point formatting with 15 significant digits, corresponding to a call to FloatToStrF with the ffGeneral format. General floating-point formatting is also used if the value has more than 18 digits to the left of the decimal point and the format string does not specify scientific notation.

Example

The following table shows some sample formats and the results produced when the formats are applied to different values:

Format string-	1234	-1234	0.5	0
	1234	-1234	0.5	0
0	1234	-1234	1	0
0.00	1234.00	-1234.00	0.50	0.00
#.##	1234	-1234	.5
#,##0.00	1,234.00	-1,234.00	0.50	0.00
#,##0.00;(#,##0.00)	1,234.00	(1,234.00)	0.50	0.00
#,##0.00;;Zero	1,234.00	-1,234.00	0.50	Zero
0.000E+00	1.234E+03	-1.234E+03	5.000E-01	0.000E+00
#.###E-0	1.234E3	-1.234E3	5E-1	0E0


FormatMaskText

See also

Unit

Mask

FormatMaskText returns a string formatted using an edit mask.

function FormatMaskText(const EditMask: string; const Value: string): string;

Description

Call FormatMaskText to apply the mask specifed by the EditMask parameter to the text string specified by the Value parameter. The edit mask string consists of three fields with semicolons separating them. The first part of the mask is the mask itself. The second part is the character that determines whether the literal characters of the mask are matched to characters in the Value parameter or are inserted into the Value string. The third part of the mask is the character used to represent missing characters in the mask.

These are the special characters used in the first field of the mask:

Character	Meaning in mask
!	If a ! character appears in the mask, optional characters are represented in the returned string as leading blanks. If a ! character is not present, optional characters are represented in the returned string as trailing blanks.
>	If a > character appears in the mask, all characters that follow are in uppercase until the end of the mask or until a < character is encountered.
<	If a < character appears in the mask, all characters that follow are in lowercase until the end of the mask or until a > character is encountered.
<>	If these two characters appear together in a mask, no case checking is done and the data is formatted with the case present in the Value parameter.
\	The character that follows a \ character is a literal character. Use this character to use any of the mask special characters as a literal.
L	The L character requires an alphabetic character only in this position. For the US, this is A-Z, a-z.
l	The l character permits only an alphabetic character in this position, but doesn't require it.
A	The A character requires an alphanumeric character only in this position. For the US, this is A-Z, a-z, 0-9.
a	The a character permits an alphanumeric character in this position, but doesn't require it.
C	The C character requires an arbitrary character in this position.
c	The c character permits an arbitrary character in this position, but doesn't require it.
0	The 0 character requires a numeric character only in this position.
9	The 9 character permits a numeric character in this position, but doesn't require it.
#	The # character permits a numeric character or a plus or minus sign in this position, but doesn't require it.
:	The : character is used to separate hours, minutes, and seconds in times. If the character that separates hours, minutes, and seconds is different in the regional settings of the Control Panel, that character is substituted in the returned string.
/	The / character is used to separate months, days, and years in dates. If the character that separates months, days, and years is different in the regional settings of the Control Panel, that character is substituted in the returned string.
;	The ; character is used to separate the three fields of the mask.
_	The _ character automatically inserts spaces into the returned string.
Any character that does not appear in the preceding table can appear in the first part of the mask as a literal character. Literal characters are inserted automatically if the second field of the mask is 0, or matched to characters in the Value parameter if the second field is any other value. The special mask characters can also appear as literal characters if preceded by a backslash character (\).

The second field of the mask is a single character that indicates whether literal characters from the mask are included in the Value parameter. For example, the mask for a telephone number with area code could be the following string:

(000)_000-0000;0;*

The 0 in the second field indicates that the Value parameter should consist of the 10 digits of the phone number, rather than the 14 characters that make up the final formatted string.

A 0 in the second field indicates that literals are inserted into the Value string, any other character indicates that they should be included. The character to indicate whether literals should be included can be changed by changing the MaskNoSave typed constant that is declared in the Mask unit.

The third field of the mask is the character that appears in the returned string for blanks (characters that do not appear in Value). By default, this is the same as the character that stands for literal spaces. The two characters appear the same in the returned string.

Note

When working with multibyte character sets, such as Japanese shift-JIS, each special mask character represents a single byte. To specify double-byte characters using the L,l,A,a,C, or c specifiers, the mask characters must be doubled as well. For example, LL would represent two single-byte alphabetic characters or a one double-byte character. Only single-byte literal characters are supported.


FPower10 function

Unit

System

FPower10 multiplies a value by a specified power of 10.

function FPower10(Val: Extended; Pow: Integer ) : Extended;

Description

FPower10 returns Val * 10**Pow. It is more efficient to call FPower10 than to perform the same computation explicitly.


Frac function

See also

Frac returns the fractional part of a real number.

Unit

System

Category

Arithmetic routines

function Frac(X: Extended): Extended;

Description

The Frac function returns the fractional part of the argument X.

X is a real-type expression. The result is the fractional part of X; that is,
Frac(X) = X - Int(X).

Example

 var

  R: Real;

begin

  R := Frac(123.456);    { 0.456 }

  R := Frac(-123.456);   { -0.456 }

end;


FreeMem procedure

See also

Unit

System

Category

Dynamic allocation routines

FreeMem disposes of a dynamic variable of a given size.

procedure FreeMem(var P: Pointer[; Size: Integer]);

Description

P is a variable of any pointer type previously assigned by the GetMem procedure.

Size specifies the size in bytes of the dynamic variable to dispose of; if specified, it must be exactly the number of bytes previously allocated to that variable by GetMem.

FreeMem destroys the variable referenced by P and returns its memory to the heap. If P does not point to memory in the heap, a run-time error occurs.

After calling FreeMem, the value of P is undefined, an error occurs if P^ is subsequently referenced.

Example

The following example opens a file named 'test.txt' and reads the entire file into a dynamically allocated buffer. The buffer and the size of the file are then passed to a routine that processes the text, and finally the dynamically allocated buffer is freed and the file is closed.

var

  F: file;

  Size: Integer;

  Buffer: PChar;

begin

  AssignFile(F, 'test.txt');

  Reset(F, 1);

  try

    Size := FileSize(F);

    GetMem(Buffer, Size);

    try

      BlockRead(F, Buffer^, Size);

      ProcessFile(Buffer, Size);

    finally

      FreeMem(Buffer);

    end;

  finally

    CloseFile(F);

  end;

end;


Frexp procedure

Unit

Math

Frexp separates the Mantissa and Exponent of X

procedure Frexp(X: Extended; var Mantissa: Extended; var Exponent: Integer) register;

Description

The Frexp procedure separates the Mantissa and Exponent of X.


FutureValue function

Unit

Math

FutureValue calculates the future value of an investment.

function FutureValue(Rate: Extended; NPeriods: Integer; Payment, PresentValue:

  Extended; PaymentTime: TPaymentTime): Extended;

Description

The FutureValue function returns the future value of an investment of PresentValue where Payment is invested for NPeriods at the rate of Rate per period. The PaymentTime parameter indicates whether the investment is an ordinary annuity or an annuity due (enter 0 if payments are at the end of each period, 1 if they are at the beginning).


GetActiveOleObject function

See also

Unit

ComObj

GetActiveOleObject retrieves a reference to an IDispatch interface to a currently running, registered OLE object.

function GetActiveOleObject(const ClassName: string): IDispatch;

Description

GetActiveOleObject returns a reference to a the IDispatch interface of the active object for the given class indicated by ClassName. ClassName is the programmatic ID for the class of the active object from the OLE running object table. GetActiveOleObject is used to access the OLE running object table. To add an object to this table, use the RegisterActiveObject API function.

If either the the class object or the IDispatch interface are not successfully returned, an EOleSysError exception is raised.


GetClass function

See also

Unit

Classes

GetClass returns a registered persistent class given its class name.

function GetClass(const ClassName: string): TPersistentClass;

Description

Call GetClass to obtain a class from a class name. This class can be used as a parameter to functions or methods that require a class.

Example

The following example allows users to type the name of a graphics class into an edit control and when a button is pressed, the name default extension for that class is displayed in another edit control.

procedure TForm1.BitBtn1Click(Sender: TObject);

begin

   { make sure the classes are registered so that GetClass will work -- }

   { Usually, this would go somewhere else where it is only executed once }

  RegisterClasses([TIcon, TBitmap, TJPEGImage, TMetafile]);

  Edit1.Text := GraphicExtension(TGraphicClass(GetClass(Edit2.Text)));

 end;


GetCurrentDir function

See also

Unit

SysUtils

GetCurrentDir returns the name of the current directory.

function GetCurrentDir: string;

Description

The GetCurrentDir function returns a string containing the name of the current directory.


GetDir procedure

See also

Unit

System

Category

I/O routines

GetDir returns the current directory for a specified drive.

procedure GetDir(D: Byte; var S: string);

Description

D can be set to any of the following values:

Value	Drive
0	Default
1	A
2	B
3	C
Performs no error checking. If the drive specified by D is invalid, S returns X:\ as if it were the root directory of the invalid drive.

Example

var

   s : string;

 begin

   GetDir(0,s); { 0 = Current drive }

   MessageDlg('Current drive and directory: ' + s, mtInformation, [mbOk] , 0);

 end;


GetExtensionVersion

See also

Unit

ISAPIApp

GetExtensionVersion returns the name and version number of an ISAPI or NSAPI application.

function GetExtensionVersion(var Ver: THSE_VERSION_INFO): BOOL;

Description

Do not call GetExtensionVersion. GetExtension is exported by ISAPI and NSAPI DLLs. It provides an entry point that is called by ISAPI or NSAPI web servers to obtain version information about the web server application.


GetFormatSettings procedure

Unit

SysUtils

GetFormatSettings resets the date and number format parameters to default values.

procedure GetFormatSettings;

Description

GetFormatSettings resets all date and number format variables to their default values. GetFormatSettings is called in non-console Delphi applications in response to WM_WININICHANGE messages.


GetHeapStatus function

See also

Unit

System or ShareMem

GetHeapStatus returns the current status of the memory manager.

function GetHeapStatus: THeapStatus;

Description

The GetHeapStatus function returns the current status of the memory manager in a THeapStatus record. Include the System unit to obtain information about the global heap. Include the ShareMem unit instead if the memory is shared between different processes.


GetIStrings function

See also

Unit

AX

GetIStrings implements a TStrings object as an IStrings interface for use by OLE objects.

function  GetIStrings(Strings: TStrings): IStrings;

Description

When the GetIStrings function is called, the Strings parameter is implemented as an IStrings and assigned to the TStrings.StringsAdapter property.


GetLongHint function

See also

Unit

Controls

GetLongHint returns the second part of a two-part hint string.

function GetLongHint(const Hint: string): string;

Description

Call GetLongHint to obtain the long version of the hint specified as the value of a Hint property. The second part of the hint is the text following the | character. If the Hint string value is not separated into two parts, GetLongHint returns the entire string.

Example

This code assigns a two-part string as to the Hint property of an edit box and then displays the "long" or second part of the string as the text of the edit box:

procedure TForm1.BitBtn1Click(Sender: TObject);

begin

  Edit1.Hint := 'Name|Enter full name';

  Edit1.Text := GetLongHint(Edit1.Hint);

end;


GetMem procedure

See also

Unit

System

Category

Dynamic allocation routines

GetMem creates a dynamic variable and a pointer to the address of the block.

procedure GetMem(var P: Pointer; Size: Integer);

Description

P is a variable of any pointer type. Size is an expression specifying the size in bytes of the dynamic variable to allocate. Reference the newly created variable as P^.

If there isn't enough memory available to allocate the dynamic variable, an EOutOfMemory exception is raised. For more information on handling run-time library exceptions, see Handling RTL Exceptions.

Example

The following example opens a file named 'test.txt' and reads the entire file into a dynamically allocated buffer. The buffer and the size of the file are then passed to a routine that processes the text, and finally the dynamically allocated buffer is freed and the file is closed.

var

  F: file;

  Size: Integer;

  Buffer: PChar;

begin

  AssignFile(F, 'test.txt');

  Reset(F, 1);

  try

    Size := FileSize(F);

    GetMem(Buffer, Size);

    try

      BlockRead(F, Buffer^, Size);

      ProcessFile(Buffer, Size);

    finally

      FreeMem(Buffer);

    end;

  finally

    CloseFile(F);

  end;

end;


GetMemoryManager procedure

See also

Unit

System

GetMemoryManager returns the entry points of the currently installed memory manager.

procedure GetMemoryManager(var MemMgr: TMemoryManager);

Description

The GetMemoryManager procedure returns the entry points of the currently installed memory manager in a TMemoryManager record.


GetOleFont procedure

See also

Unit

AX

Creates an OLE font object that is directly mapped to a native Delphi TFont.

procedure GetOleFont(Font: TFont; var OleFont: IFontDisp);

Description

OLE conventions implement fonts as automation objects that contain the properties of the font.  This procedure creates an adapter object that maps the properties of a native Delphi TFont into an OLE font object, thereby allowing an OLE client to access the font properties of a VCL control. Call this function when you implement a method that retrieves a TFont value from a VCL object and returns it as an OLE font.

The Font parameter is a pointer to the native TFont. This can be the Font property of a VCL control.  The OLE font is returned in the OleFont parameter. The resulting OLE font object is a direct connection to the native Delphi font, so changing the OLE font's properties will change the TFont's properties, and vice-versa.


GetOlePicture procedure

See also

Unit

AX

 Creates an OLE picture object that is directly mapped to a native Delphi TPicture.

procedure GetOlePicture(Picture: TPicture; var OlePicture: IPicture);

Description

OLE conventions implement fonts as automation objects that contain the properties of the picture.  This procedure creates an adapter object that maps the properties of a native Delphi TPicture into an OLE picture object, thereby allowing an OLE client to access the picture properties of a VCL control. Call this function when you implement a method that retrieves a TPicture value from a VCL object and returns it as an OLE picture.

The Picture parameter is a pointer to the native TPicture. This can be the Font property of a VCL control.  The OLE picture is returned in the OlePicture parameter. The resulting OLE picture object is a direct connection to the native Delphi picture, so changing the OLE picture's properties will change the TPicture's properties, and vice-versa.


GetPackageDescription function

See also

Unit

SysUtils

GetPackageDescription returns the description resource from a package.

function GetPackageDescription(ModuleName: PChar): string;

Description

Call GetPackageDescription to obtain the description stored with the named package. If the package does not have a description resource, GetPackageDescription returns an empty string.


GetPackageInfo procedure

See also

Unit

SysUtils

GetPackageInfo enumerates all the units and required packages for a package.

procedure GetPackageInfo(Module: HMODULE; Param: Pointer; var Flags: Integer;

  InfoProc: TPackageInfoProc);

Description

Call GetPackageInfo to process the information in a package's information table. The InfoProc callback is called for every unit included in the package and for every package required by the package. Module is the module handle for the package. GetPackageInfo passes any application-supplied information passed in the Param parameter to the InfoProc callback. The package's information flags are passed to the InfoProc and returned in the Flags parameter.


GetParentForm function

See also

Unit

Forms

GetParentForm returns the form or property page that contains a specified control.

function GetParentForm(Control: TControl): TCustomForm;

Description

Call GetParentForm to obtain the descendant of TCustomForm that contains the control specified by the Control parameter. If the control is not contained in a Delphi form (for example, an ActiveX control embedded in another type of window), GetParentFrom returns nil.


GetShortHint function

See also

Unit

Controls

GetShortHint returns the first part of a two-part hint string.

function GetShortHint(const Hint: string): string;

Description

Call GetShortHint to obtain the short version of the hint specified as the value of a Hint property. The first part of the hint is the text preceding the | character. If the Hint string value is not separated into two parts, GetShortHint returns the entire string.

Example

This code assigns a two-part string as to the Hint property of an edit box and then displays the "short" or first part of the string as the text of the edit box:

procedure TForm1.BitBtn1Click(Sender: TObject);

begin

  Edit1.Hint := 'Name|Enter full name';

  Edit1.Text := GetShortHint(Edit1.Hint);

end;


GradToRad function

Unit

Math

GradToRad converts grad measurements to radians.

function GradToRad(Grads: Extended): Extended;

Description

The GradToRad function converts angles of grad measure into radians. 400 grads sweep a complete circle.

{ Radians := Grads * PI / 200 }


GraphicExtension function

See also

Unit

Graphics

GraphicExtension returns the default file-name extension of a graphics object.

function GraphicExtension(GraphicClass: TGraphicClass): string;

Description

Call GraphicExtension to obtain a default extension value for the DefaultExt property of a Save Picture dialog. GraphicExtension returns the default extension for the type of graphics object specified by the GraphicClass parameter. The TGraphicClass type is the class type for descendants TGraphic.

These are the file extensions returned for each built-in graphics class:

Graphic class	File extension returned
TBitmap	bmp
TIcon	ico
TMetafile	emf
TJPEGImage	jpg
If custom graphics classes register a file extension, GraphicExtension will return that extension when passed the custom graphics class as an argument.

Example

This code displays a Save Picture dialog box with the TBitmap default extension that is added automatically to files that are given no extension:

SavePictureDialog1.DefaultExt := GraphicExtension(TBitmap);

SavePictureDialog1.Filter := GraphicFilter(TBitmap);

if SavePictureDialog1.Execute then

  ...


raphicFileMask function
GraphicFileMask function

See also

Unit

Graphics

GraphicFileMask returns a mask string that specifies the valid extensions for a graphic class.

function GraphicFileMask(GraphicClass: TGraphicClass): string;

Description

Call GraphicFileMask to obtain a mask to determine the file extensions associated with a graphic class. The GraphicClass parameter can be one of these values: TBitmap, TGraphic, TIcon, TMetafile, TJPEGImage, or a user-defined descendant of TGraphic. These are the strings that are returned for each built-in graphics class:

Graphic class	Filter string returned
TBitmap	*.bmp
TIcon	*.ico
TMetafile	*.emf;*.wmf
TJPEGImage	*.jpeg;*.jpg
TGraphic	*.jpeg;*.jpg;*.bmp;*.ico;*.emf;*.wmf
Note

The extensions for the JPEG graphic are only available if the JPEG unit is included in the project.


GraphicFilter function

See also

Unit

Graphics

GraphicFilter returns a filter string compatible with the Filter property of an Open or Save dialog.

function GraphicFilter(GraphicClass: TGraphicClass): string;

Description

Call GraphicFilter to obtain a value for the Filter property of an Open Picture or Save Picture dialog box. The GraphicClass parameter can be one of these values: TBitmap, TGraphic, TIcon, TMetafile, TJPEGImage, or a user-defined descendant of TGraphic. These are the strings that are returned for each built-in graphics class:

Graphic class	Filter string returned
TBitmap	Bitmaps (*.bmp)|*.bmp
TIcon	Icons (*.ico)|*.ico
TMetafile	All(*.emf;*.wmf)|*.emf;*.wmf|Enhanced Metafiles (*.emf)|*.emf|Metafiles(*.wmf)|*.wmf
TJPEGImage	All(*.jpeg;*.jpg)|*.jpeg;*.jpg|JPEG Image File (*.jpeg)|*.jpeg|JPEG Image File (*.jpg)|*.jpg
TGraphic	All (*.jpeg;*.jpg;*.bmp;*.ico;*.emf;*.wmf)|*.jpeg;*.jpg; *.bmp;*.ico;*.emf; *.wmf|JPEG Image File (*.jpeg)|*.jpeg|JPEG Image File (*.jpg)|*.jpg|Bitmaps (*.bmp)|*.bmp|Icons (*.ico)|*.ico|Enhanced Metafiles (*.emf)|*.emf|Metafiles(*.wmf)|*.wmf
Note

The extensions for the JPEG graphic are only available if the JPEG unit is included in the project.

Example

This code displays an Open Picture dialog box with the TBitmap filter string in the List Files of Type combo box:

OpenPictureDialog1.DefaultExt := GraphicExtension(TBitmap);

OpenPictureDialog1.Filter := GraphicFilter(TBitmap);

if OpenPictureDialog1.Execute then

  ...


GUIDToString function

See also

Unit

ComObj

GUIDToString converts a class identifier GUID to a string.

function GUIDToString(const ClassID: TGUID): string;

Description

GUIDToString converts a GUID into a string of printable characters. Each GUID will always convert to a unique string.

If GUIDToString succeeds it returns a string to the requested GUID. If GUIDToString fails an EOleSysError exception is raised with an error code indicating the cause of the error.


Halt procedure

See also

Unit

System

Category

Flow control routines

Halt initiates abnormal termination of a program.

procedure Halt [ ( Exitcode: Integer) ];

Description

The Halt procedure performs an abnormal termination of a program and returns to the operating system. To perform a normal termination of Delphi VCL non-console application, call Application.Terminate. Exitcode is an optional expression that specifies an exit code for the program.

Example

begin

   if 1 = 1 then

     begin

       if 2 = 2 then

         begin

           if 3 = 3 then

             begin

               Halt(1); { Halt right here! }

             end;

         end;

     end;

   Canvas.TextOut(10, 10, 'This will not be executed');

 end;


Hi function

See also

Unit

System

Category

Miscellaneous routines

Hi returns the high-order byte of X as an unsigned value.

function Hi(X): Byte;

Description

X is an expression of type Word or Integer.

Note

Hi treats Integer as a 16-bit value, even if it is 32-bit.

Example

var B: Byte;

begin

  B := Hi($1234);   { $12 }

end;


High function

See also

Unit

System

Category

Transfer routines

High returns the highest value in the range of an argument.

function High(X);

Description

The result type is X, or the index type of X.

X is either a type identifier or a variable reference. The type denoted by X, or the type of the variable denoted by X, must be one of the following types.

For this type	High returns
Ordinal type	The highest value in the range of the type
Array type	The highest value within the range of the index type of the array
String type	The declared size of the string
Open array	The value, of type Integer, giving the number of elements in the actual parameter minus one
String parameter	The value, of type Inteeger, giving the number of elements in the actual parameter minus one
Example

function Sum( var X: array of Double): Double;

var

  I: Word;

  S: Double;

begin

  S := 0;  { Note that open array index range is always zero-based. }

  for I := 0 to High(X) do S := S + X[I];

  Sum := S;

end;

procedure TForm1.Button1Click(Sender: TObject);

var

  List1: array[0..3] of Double;

  List2: array[5..17] of Double;

  X: Word;

  S, TempStr: string;

begin

  for X := Low(List1) to High(List1) do

    List1[X] := X * 3.4;

    for X := Low(List2) to High(List2) do

    List2[X] := X * 0.0123;

  Str(Sum(List1):4:2, S);

  S := 'Sum of List1: ' + S + #13#10;

  S := S + 'Sum of List2: ';

  Str(Sum(List2):4:2, TempStr);

  S := S + TempStr;

  MessageDlg(S, mtInformation, [mbOk], 0);

end;


HtmlTable function

See also

Unit

DBWeb

HtmlTable generates the HTML image of a dataset, using the properties and events of a table producer object.

function HtmlTable(DataSet: TDataSet; DataSetHandler: TDSTableProducer;

  MaxRows: Integer): string;

Description

Call HtmlTable to obtain a sequence of HTML commands that describe a dataset in tabular format. The DataSet parameter indicates the dataset whose records are converted into an HTML image. The DataSetHandler parameter is the table producer whose properties describe the attributes of the resulting image, and whose event handlers respond to events that occur during the generation of the image. The MaxRows parameter is the maximum number of records from the dataset that will appear in the image.

Calling HtmlTable is equivalent to calling the Content method of the DataSetHandler parameter after setting its DataSet and MaxRows properties to the values given for the parameters of the same names.


HTTPDecode
HTTPDecode function

See also

Unit

HTTPApp

HTTPDecode decodes a string that includes HTTP escape characters.

function HTTPDecode(const AStr: String): string;

Description

HTTPDecode decodes the escape characers (+ and %) in a string that comes from an HTTP message header. Plus characters (+) are converted into spaces. Percent signs (%) indicate that the next two characters are the hex representation of a character. If a percent sign is followed by another percent sign (%%), it is converted into a single percent sign.

For example, the string

%%+%3f

would be converted into

% ?

The AStr parameter is the undecoded string. The return value is the converted version of the string.


HTTPEncode
HTTPEncode function

See also

Unit

HTTPApp

HTTPEncode converts a string into a form that contains no values that are illegal in an HTTP message header.

function HTTPEncode(const AStr: String): string;

Description

HTTPEncode converts all characters in the AStr parameter except for the letters A through Z (and a through z), the asterisk (*), at sign (@), period (.), underscord (_), and hyphen (-). Spaces are converted to plus characters (+), and all other characters are converted into hex values preceded by the percent sign (%).

For example, the string

% ?

would be converted into

%%+%3f

HTTPEncode returns the converted string.


HTTPExtensionProc function

See also

Unit

ISAPIApp

HTTPExtensionProc receives an HTTP request message for an ISAPI or NSAPI application.

function HttpExtensionProc(var ECB: TEXTENSION_CONTROL_BLOCK): DWORD;

Description

Do not call HttpExtensionProc. HttpExtensionProc is exported by ISAPI and NSAPI DLLs. It provides an entry point that is called by ISAPI or NSAPI web servers when they receive HTTP request messages.


Hypot function

Unit

Math

Hypot calculates the length of the hypotenuse.

function Hypot(X, Y: Extended): Extended;

Description

The Hypot function returns the length of the hypotenuse of a triangle. Specify the lengths of the sides adjacent to the right angle in X and Y.

{ Sqrt(X**2 + Y**2) }


Inc procedure

See also

Unit

System

Category

Ordinal routines

Inc increments X by one or N.

procedure Inc(var X [ ; N: Longint ] );

Description

The Inc procedure adds one or N to the variable X.

X is an ordinal-type variable or a variable of type PChar if the extended syntax is enabled and N is an integer-type expression. Inc can be used on enumerated types or on pointer variables. Do not use Inc on ordinal-type properties if the property uses a write procedure.

X increments by 1, or by N if N is specified; that is, Inc(X) corresponds to the statement
X := X + 1, and Inc(X, N) corresponds to the statement X := X + N.

Inc generates optimized code and is especially useful in tight loops.

Note

Inc(S, I) where S is a ShortInt and I is a number greater than 127 will cause an EIntOverFlow exception to be raised if range and overflow checking are on. Under Delphi 1.0 this did not raise an exception.

Example

var

  IntVar: Integer;

  LongintVar: Longint;

begin

  Inc(IntVar);	{ IntVar := IntVar + 1 }

  Inc(LongintVar, 5);	{ LongintVar := LongintVar + 5 }

end;


Include procedure

See also

Unit

System

Category

Miscellaneous routines

Include adds an element to a set.

procedure Include(var S: set of T; I:T);

Description

The Include procedure adds the element I to the set S.

S is a set type variable, and I is an expression of a type compatible with the base
type of S.

The construct Include(S,I) corresponds to S := S + [I] but the Include procedure generates more efficient code.


IncMonth function

See also

Unit

SysUtils

IncMonth returns a date shifted by a specified number of months.

function IncMonth(const Date: TDateTime; NumberOfMonths: Integer): TDateTime;

Description

IncMonth returns the value of the Date parameter, incremented by  NumberOfMonths months.  NumberOfMonths  can be negative, to return a date N months previous.

If the input day of month is greater than the last day of the resulting  month, the day is set to the last day of the resulting month.  The time of day specified by the Date parameter is copied to the  result.


Initialize procedure

See also

Unit

System

Initialize initializes a dynamically allocated variable.

procedure Initialize(var V [ ; Count: Integer ] );

Description

Initialize should be used only in situations where a variable is dynamically allocated by other means than the New standard procedure.

For global variables, local variables, objects, and dynamic variables allocated using the New standard procedure, the compiler generates code that initializes all long strings and variants contained by a variable upon creation of the variable. If a dynamic variable is created by other means than the New standard function (for example using GetMem or ReallocMem), if the variable contains long strings or variants, and if the memory allocated for the variable is not initialized to zeros, a call to Initialize is required to initialize the variable before it can be used. Initialize simply zeros out the memory occupied by long strings and variants, thus causing long strings to be empty and variants to be Unassigned.

In cases where several variables are allocated in a contiguous memory block, the additional Count parameter can be specified to initialize all variables in one operation.

If the variable specified in a call to Initialize contains no long strings and variants, the compiler eliminates the call and generates no code for it.


InitializePackage

See also

Unit

SysUtils

InitializePackage validates and initializes a given package.

procedure InitializePackage(Module: HMODULE);

Description

InitializePackage checks for duplicate units in a package and calls the initialization blocks of the contained units.

Note

InitializePackage is called internally by the LoadPackage function.


InputBox function

See also

Unit

Dialogs

InputBox displays an input dialog box that enables the user to enter a string.

function InputBox(const ACaption, APrompt, ADefault: string): string;

Description

Call InputBox to bring up an input dialog box ready for the user to enter a string in its edit box. The ACaption parameter is the caption of the dialog box, the APrompt parameter is the text that prompts the user to enter input in the edit box, and the ADefault parameter is the string that appears in the edit box when the dialog box first appears.

If the user chooses the Cancel button, InputBox returns the default string. If the user chooses the OK button, InputBox returns the string in the edit box.

Use the InputBox function when there is a default value that should be used when the user chooses the Cancel button (or presses Esc) to exit the dialog. If the application needs to know whether the user chooses OK or Cancel , use the InputQuery function.

Example

This example displays an input dialog box when the user clicks a button on the form. The input dialog box includes a prompt string and a default string. The string the user enters in the dialog box is stored in the InputString variable.

uses Dialogs;

procedure TForm1.Button1Click(Sender: TObject);

var

  InputString: string;

begin

  InputString:= InputBox('Input Box', 'Prompt', 'Default string');

end;


InputQuery function

See also

Unit

Dialogs

InputQuery displays an input dialog that enables the user to enter a string.

function InputQuery(const ACaption, APrompt: string; var Value: string): Boolean;

Description

Call InputQuery to bring up an input dialog box ready for the user to enter a string in its edit box. The ACaption parameter is the caption of the dialog box, the APrompt parameter is the text that prompts the user to enter input in the edit box, and the Value parameter is the string that appears in the edit box when the dialog box first appears.

If the user enters a string in the edit box and chooses OK, the Value parameter changes to the new value.

The InputQuery function returns True if the user chooses OK, and False if the user chooses Cancel or presses the Esc key.

If the default value should be used when the user cancels out of the dialog, use the InputBox function.

Example

This example uses a button and a label on the form. When the user clicks the button, the input box displays. If the user chooses OK, the string that appears in the edit box of the dialog box displays as the caption of the label on the form. If the user chooses Cancel, the dialog box closes and the caption of the label remains unchanged.

procedure TForm1.Button1Click(Sender: TObject);

var

  NewString: string;

  ClickedOK: Boolean;

begin

  NewString := 'Default String';

  Label1.Caption := NewString;

  ClickedOK := InputQuery('Input Box', 'Prompt', NewString);

  if ClickedOK then                 { NewString contains new input string }

    Label1.Caption := 'The new string is ''' + NewString + '''';

end;


Insert procedure

See also

Unit

System

Category

String handling routines (Pascal style)

Insert inserts a substring into a string beginning at a specified point.

procedure Insert(Source: string; var S: string; Index: Integer);

Description

Source is a string-type expression. S is a string-type variable of any length. Index is an integer-type expression. It is a character index and not a byte index.

Insert merges Source into S at the position S[index].

Example

 var

  S: string;

begin

  S := 'Honest Lincoln';

  Insert('Abe ', S, 8);                    { 'Honest Abe Lincoln' }

end;


Int function

See also

Unit

System

Category

Arithmetic routines

Int returns the integer part of a real number.

function Int(X: Real): Real;

Description

X is a real-type expression. The result is the integer part of X; that is, X rounded toward zero.

Example

var

  R: Real;

begin

  R := Int(123.456);    { 123.0 }

  R := Int(-123.456);   { -123.0 }

end;


InterestPayment function

Unit

Math

InterestPayment calculates the interest portion of a loan payment.

function InterestPayment(Rate: Extended; Period, NPeriods: Integer; PresentValue,

  FutureValue: Extended; PaymentTime: TPaymentTime): Extended;

Description

Rate represents the fixed periodic interest rate, Period identifies the payment period, NPeriods is the number of periods of the loan, PresentValue represents the amount borrowed (the principal), FutureValue is the future value of the investment, and PaymentTime indicates whether the cash flows occur at the beginning or end of the period (by entering a value of 1 or 0, respectively).


InterestRate function

Unit

Math

InterestRate returns the interest rate required to increase PresentValue to FutureValue.

function InterestRate(NPeriods: Integer;

  Payment, PresentValue, FutureValue: Extended; PaymentTime: TPaymentTime): Extended;

Description

The InterestRate function calculates the interest rate required in order for an investment of PresentValue, with periodic payments of Payment, to be worth FutureValue within NPeriods compounding periods. If NPeriods represents years, an annual interest rate results; if NPeriods represents months, a monthly interest rate results, and so on. The PaymentTime parameter indicates whether the cash flows occur at the beginning or end of the period (by entering a value of 1or 0, respectively).


InternalRateOfReturn function

Unit

Math

InternalRateOfReturn calculates the internal rate of return for an investment.

function InternalRateOfReturn(Guess: Extended; const CashFlows: array of Double): Extended;

Description

The InternalRateOfReturn function determines the internal rate of return on an investment. It references an array that contains cash flow information and uses the supplied internal rate of return estimate to calculate results.

Before using this function, define an array containing expected cash flow amounts over a period of time. It is assumed that the amounts are received at regular intervals. Negative amounts are interpreted as cash outflows, and positive amounts as inflows. The first amount must be a negative number, to reflect the initial investment. The following amounts can all be the same for each time period, or they can be different (including a mixture of negatives, positives, or zeros).


IntPower function

Unit

Math

IntPower calculates Base to the power of Exponent.

function IntPower(Base: Extended; Exponent: Integer): Extended register;

Description

The IntPower function raises Base to an integral power. For example, BaseExponent.


IntToHex function

See also

Unit

SysUtils

Category

String handling routines (Pascal style)

IntToHex returns the hex representation of an integer.

function IntToHex(Value: Integer; Digits: Integer): string;

Description

The IntToHex function converts a number into a string containing the number's hexadecimal (base 16) representation. Value is the number to convert. Digits indicates the minimum number of hexadecimal digits to return.

Example

When the user clicks the button on the form, this code converts the number entered in Edit1 to a hexadecimal string. The string displays in Edit2.

procedure TForm1.Button1Click(Sender: TObject);

begin

  Edit2.Text := IntToHex(StrToInt(Edit1.Text), 6);

end;


IntToStr function

See also

Unit

SysUtils

Category

String handling routines (Pascal style)

IntToStr converts an integer to a string.

function IntToStr(Value: Integer): string;

Description

The IntToStr function converts an integer into a string containing the decimal representation of that number.

Example

This example uses a button and an edit box on a form. The code assigns a value to the Value variable and displays the string representation of the Value variable in the edit box.

procedure TForm1.Button1Click(Sender: TObject);

var

  Value: Integer;

begin

  Value := 1234;

  Edit1.Text := IntToStr(Value);

end;


IOResult function

Unit

System

Category

I/O routines

IOResult returns the status of the last I/O operation performed.

function IOResult: Integer;

Description

I/O-checking must be off--{$I-}--to trap I/O errors using IOResult.

If an I/O error occurs and I/O-checking is off, all subsequent I/O operations are ignored until a call is made to IOResult. Calling IOResult clears the internal error flag.

An alternative way to handle I/O errors is to use exception handling. For more information on handling run-time library exceptions, see Handling RTL Exceptions.

Example

var

  F: file of Byte;

begin

  if OpenDialog1.Execute then begin

    AssignFile(F, OpenDialog1.FileName);

    {$I-}

    Reset(F);

    {$I+}

    if IOResult = 0 then

      MessageDlg('File size in bytes: ' + IntToStr(FileSize(F)),

        mtInformation, [mbOk], 0);

    else

      MessageDlg('File access error', mtWarning, [mbOk], 0);

  end;

end;


IsDelimiter function

See also

Unit

SysUtils

IsDelimiter indicates whether a specified character in a string matches one of a set of delimiters.

function IsDelimiter(const Delimiters, S: string; Index: Integer): Boolean;

Description

Call IsDelimiter to determine whether the character at byte offset Index in the string S is one of the delimiters in the string Delimiters. Index is the 0-based index of the byte in question, where 0 is the first byte of the string, 1 is the second byte, and so on.

When working with a double byte character system (DBCS), IsDelimiter checks to make sure the indicated byte is not part of a double byte character. The delimiters in the Delimeters parameter must all be single byte characters.


IsLeapYear function

See also

Unit

SysUtils

IsLeapYear indicates whether a specified year is a leap year.

function IsLeapYear(Year: Word): Boolean;

Description

Call IsLeapYear to determine whether the year specified by the Year parameter is a leap year.  Year specifies the calandar year.

Use the DecodeDate procedure to obtain the value of  Year for IsLeapYear from a TDateTime value.

Example

The following code defines a function that indicates whether the current year is a leap year.

function IsThisLeapYear: Boolean;

var

Yr, Mnth, Day: Word;

begin

   DecodeDate(Date, Yr, Mnth, Day);

   Result := IsLeapYear(Yr);

end;


IsPathDelimiter function

See also

Unit

SysUtils

IsPathDelimiter indicates whether the byte at position Index of a string is the backslash character.

function IsPathDelimiter(const S: string; Index: Integer): Boolean;

Description

Call IsPathDelimiter to determine whether a position in the string S contains the backslash path delimiter (\). The Index parameter specifies the postion of the character in question, where 0 is the first byte, 1 is the second byte, and so on.

When working with a double byte character system (DBCS), IsPathDelimiter distinguishes between a true backslash character, and the byte of the same value that can appear as the second byte of a double byte character.

To test for more characters than just the backslash character, use the IsDelimiter function.


IsValidIdent function

Unit

SysUtils

Category

String formatting routines

IsValidIdent tests for a valid Pascal identifier.

function IsValidIdent(const Ident: string): Boolean;

Description

IsValidIdent returns True if the given string is a valid Pascal identifier. An identifier is defined as a character from the set ['A'..'Z', 'a'..'z', '_'] followed by zero or more characters from the set ['A'..'Z', 'a'..'z', '0..'9', '_'].

Note

All component names must be valid Object Pascal identifiers.


LastDelimiter function

See also

Unit

SysUtils

LastDelimiter returns the byte index in S of the last character that matches any character in the Delimiters string.

function LastDelimiter(const Delimiters, S: string): Integer;

Description

Call LastDelimiter to locate the last delimiter in the string S. When working with double byte character sets (DBCS), the string S may contain double byte characters, but the delimiters listed in the Delimeters paramter must all be single byte non-null characters.

For example, the line

MyIndex := LastDelimiter('\.:','c:\filename.ext');

sets MyIndex to 12.


Ldexp function

Unit

Math

Ldexp calculates X * (2P)

function Ldexp(X: Extended; P: Integer): Extended register;

Description

The Ldexp function returns X times (2 to the power of P).


Length function

See also

Unit

System

Category

String Handling Routines (Pascal style)

Length returns the number of characters used in a string.

function Length(S: string): Integer;

Description

The Length function returns the number of characters actually used in the string S.

Note

The number of characters is not necessarily the number of bytes.

Example

var

  S: string;

begin

  S := 'The Black Knight';

  Canvas.TextOut(10, 10, 'String Length = ' + IntToStr(Length(S)));

end;


Ln function

See also

Unit

System

Category

Arithmetic Routines

Ln returns the natural log of a real expression.

function Ln(X: Real): Real;

Description

The Ln function returns the natural logarithm (Ln(e) = 1) of the real-type expression X.

Example

var

   e : real;

   S : string;

begin

   e := Exp(1.0);

   Str(ln(e):3:2, S);

   S := 'ln(e) = ' + S;

   Canvas.TextOut(10, 10, S);

end;


LnXP1 function

Unit

Math

LnXP1 returns the natural log of (X+1)

function LnXP1(X: Extended): Extended;

Description

The LnXP1 function returns the natural logarithm of (X+1).

{ Ln(X + 1), accurate for X near zero }


Lo function

See also

Unit

System

Category

Miscellaneous Routines

Lo returns the low order Byte of argument X.

function Lo(X): Byte;

Description

The Lo function returns the low-order Byte of the argument X as an unsigned value. X is an expression of type Integer.

Example

var B: Byte;

begin

  B := Lo($1234);   { $34 }

end;


LoadPackage function

See also

Unit

SysUtils

LoadPackage loads a specified package.

function LoadPackage(const Name: string): HMODULE;

Description

LoadPackage loads the package specified by the Name parameter, checks for duplicate units, and calls the initialization blocks of all units contained in the package.


LoadStr function

Unit

SysUtils

Category

String formatting routines

LoadStr loads a string from the application's executable file.

function LoadStr(Ident: Integer): string;

Description

LoadStr loads the string resource given by Ident from the application's executable file. If the string resource does not exist, an empty string is returned.

Moving display strings into string resources makes an application easier to localize without rewriting the program.


Log2 function

See also

Unit

Math

Log2 calculates log base 2.

function Log2(X: Extended): Extended;

Description

The Log2 function returns the log base 2 of X.


Log10 function

See also

Unit

Math

Log10 calculates log base 10.

function Log10(X: Extended): Extended;

Description

The Log10 function returns the log base 10 of X.


LoginDialog function

See also

Unit

DBLogDlg

LoginDialog brings up the database Login dialog to allow the user to connect to a database server.

function LoginDialog(const ADatabaseName: string; var AUserName, APassword: string):

   Boolean;

Description

Call LoginDialog to breing up the standard Login dialog box to prompt the user for a valid user name and password. The ADatabaseName parameter specifies the database for which access is being requested. It corresponds to the DatabaseName property of the TDatabase object. The dialog returns the user name and password as the AUserName and APassword parameters.

LoginDialog returns False if the user cancels out of the dialog. If LoginDialog returns True, the application can attempt to connect to the database server using the supplied user name and password.


LogN function

Unit

Math

LogN calculates log base N.

function LogN(Base, X: Extended): Extended;

Description

The LogN function returns the log base N of X.


Low function

See also

Unit

System

Category

Transfer Routines

Low returns the lowest value in a range.

function Low(X);

Result type is X, or the index type of X where X is either a type identifier or a variable reference.

Type	Low returns
Ordinal type	The lowest value in the range of the type
Array type	The lowest value within the range of the index type of the array
String type	Returns 0 only on shortstrings
Open array	Returns 0
String parameter	Returns 0
Example

function Sum( var X: array of Double): Double;

var

  I: Word;

  S: Real;

begin

  S := 0;               { Note that open array index range is always zero-based. }

  for I := 0 to High(X) do S := S + X[I];

  Sum := S;

end;

procedure TForm1.Button1Click(Sender: TObject);

var

  List1: array[0..3] of Double;

  List2: array[5..17] of Double;

  X: Word;

  S, TempStr: string;

begin

  for X := Low(List1) to High(List1) do

      List1[X] := X * 3.4;

  for X := Low(List2) to High(List2) do

      List2[X] := X * 0.0123;

  Str(Sum(List1):4:2, S);

  S := 'Sum of List1: ' + S + #13#10;

  S := S + 'Sum of List2: ';

  Str(Sum(List2):4:2, TempStr);

  S := S + TempStr;

  MessageDlg(S, mtInformation, [mbOk], 0);

end;


LowerCase function

See also

Unit

SysUtils

Category

String handling routines (Pascal style)

LowerCase converts an ASCII string to lowercase.

function LowerCase(const S: string): string;

Description

LowerCase returns a string with the same text as the string passed in S, but with all letters converted to lowercase. The conversion affects only 7-bit ASCII characters between 'A' and 'Z'. To convert 8-bit international characters, use AnsiLowerCase.

Example

This example uses two edit boxes and a button on a form. When the user clicks the button, the text in the Edit1 edit box displays in the Edit2 edit box in lowercase letters.

procedure TForm1.Button1Click(Sender: TObject);

begin

  Edit2.Text := LowerCase(Edit1.Text);

end;


MatchesMask function

See also

Unit

Masks

MatchesMask indicates whether a file name or other source string conforms to the format specified by a filter string.

function MatchesMask(const Filename, Mask: string): Boolean;

Description

Call MatchesMask to check the Filename parameter using the Mask parameter to describe valid values. A valid mask consists of literal characters, sets, and wildcards.

Each literal character must match a single character in the string. The comparison to literal characters is case-insensitive.

Each set begins with an opening bracket ([) and ends with a closing bracket (]). Between the brackets are the elements of the set. Each element is a literal character or a range. Ranges are specified by an initial value, a dash (-), and a final value. Do not use spaces or commas to separate the elements of the set. A set must match a single character in the string. The character matches the set if it is the same as one of the literal characters in the set, or if it is in one of the ranges in the set. A character is in a range if it matches the initial value, the final value, or falls between the two values. All comparisons are case-insensitve. If the first character after the opening bracket of a set is an exclamation point (!), then the set matches any character that is not in the set.

Wildcards are asterisks (*) or question marks (?). An asterisk matches any number of characters. A question mark matches a single arbitrary character.

MatchesMask returns True if the string matches the mask. MatchesMask returns False if the string does not match the mask. MatchesMask raises an exception if the mask is syntactically invalid.

Note

The Filename parameter does not need to be a file name. MatchesMask can be used to check strings against any syntactically correct mask.


MaxIntValue function

See also

Unit

Math

MaxIntValue returns the largest signed value in an integer array.

function MaxIntValue(const Data: array of Integer): Integer;

Description

Call MaxIntValue to obtain the largest integer from the Data array.


MaxValue function

See also

Unit

Math

MaxValue returns the largest signed value in an array.

function MaxValue(const Data: array of Double): Double;

Description

The MaxValue function returns the largest signed value in the Data array (MAX).


Mean function

Unit

Math

Mean returns the average of all values in an array.

function Mean(const Data: array of Double): Extended;

Description

The Mean function calculates the arithmetic average of all the values in the Data array parameter.

{ (AVG):  SUM / N }


MeanAndStdDev procedure

Unit

Math

MeanAndStdDev calculates the mean and standard deviation of array elements.

procedure MeanAndStdDev(const Data: array of Double; var Mean, StdDev: Extended);

Description

The MeanAndStdDev procedure calculates Mean and StdDev in one pass, which is twice as fast as calculating them separately. Precision may be lost when the Mean is very large (> 10e7) or the variance is very small.


MessageDlg function

See also

Unit

Dialogs

MessageDlg displays a message dialog box in the center of the screen.

function MessageDlg(const Msg: string; AType: TMsgDlgType;

    AButtons: TMsgDlgButtons; HelpCtx: Longint): Word;

Description

Call MessageDlg to bring up a message box and obtain the user's response. The message box displays the value of the Msg parameter.

The AType parameter determines the type of message box that appears. These are the possible values:

Value	Meaning
mtWarning	A message box containing a yellow exclamation point symbol.
mtError	A message box containing a red stop sign.
mtInformation	A message box containing a blue "i".
mtConfirmation	A message box containing a green question mark.
mtCustom	A message box with no bitmap. The caption of the message box is the name of the application's executable file.
The AButtons parameter determines which buttons appear in the message box. AButtons is of type TMsgDlgBtns, which is a set, so it can include multiple buttons. These are the values that can be included:

Value	Meaning
mbYes	A button with the text 'Yes' on its face
mbNo	A button with the text 'No' on its face
mbOK	A button with the text 'OK' on its face
mbCancel	A button with the text 'Cancel' on its face
mbHelp	A button with the text 'Help' on its face
mbAbort	A button with the text 'Abort' on its face
mbRetry	A button with the text 'Retry' on its face
mbIgnore	A button with the text 'Ignore' on its face
mbAll	A button with the text 'All' on its face
In addition to the individual set values, Delphi defines three constants that are predefined sets that include common button combinations:

Value	Meaning
mbYesNoCancel	Puts Yes, No, and Cancel buttons in the message box
mbOkCancel	Puts t OK and Cancel buttons in the message box
mbAbortRetryIgnore	Puts Abort, Retry, and Ignore buttons in the message box
When using these constants, remember not to add the brackets [ ] to define the set. These constants are already predefined sets.

The HelpCtx parameter determines which Help screen is available for the message box. For more information about Help context values, see the TControl.HelpContext property.

MessageDlg returns the value of the button the user selected. These are the possible return values:

Return values
mrNone	mrAbort	mrYes
mrOk	mrRetry	mrNo
mrCancel	mrIgnore	mrAll
Example

This example uses a button on a form. When the user clicks the button, a message box appears, asking if the user wants to exit the application. If the user chooses Yes, another dialog box appears informing the user the application is about to end. When user chooses OK, the application ends.

procedure TForm1.Button1Click(Sender: TObject);

begin

  if MessageDlg('Welcome to my Object Pascal application.  Exit now?',

    mtConfirmation, [mbYes, mbNo], 0) = mrYes then

  begin

    MessageDlg('Exiting the Object Pascal application.', mtInformation,

      [mbOk], 0);

    Close;

  end;

end;


MessageDlgPos function

See also

Unit

Dialogs

MessageDlg displays a message dialog box at the specified screen coordinates.

function MessageDlgPos(const Msg: string; AType: TMsgDlgType;
  AButtons: TMsgDlgButtons; HelpCtx: Longint; X, Y: Integer): Word;

Description

The MessageDlgPos functions as MessageDlg except that it displays the message at the position specified by X and Y. Refer to the entry for MessageDlg for additional information.

Example

This example uses a button on a form. When the user clicks the button, a message box appears with a Yes, No, and Cancel button on it:

procedure TForm1.Button1Click(Sender: TObject);

begin

  MessageDlgPos('Are you there?',mtConfirmation, mbYesNoCancel, 0, 200, 200);

end;


MinIntValue function

See also

Unit

Math

MinIntValue returns the smallest signed value in an integer array.

function MinIntValue(const Data: array of Integer): Integer;

Description

Call MinIntValue to obtain the smallest integer in the Data array.


MinValue function

See also

Unit

Math

MinValue returns smallest signed value in an array.

function MinValue(const Data: array of Double): Double;

Description

The MinValue function returns the smallest signed value in the Data array.


MkDir procedure

See also

Unit

System

Category

I/O Routines

MkDir creates a new subdirectory.

procedure MkDir(S: string);

Description

The MkDir procedure creates a new subdirectory with the path specified by string S. The last item in the path cannot be an existing file name.

{$I+} handles run-time errors using exceptions. For more information on handling run-time library exceptions, see Handling RTL Exceptions.

When using {$I-}, use IOResult to check for an I/O error.

Example

uses Dialogs;

begin

  {$I-}

  { Get directory name from TEdit control }

  MkDir(Edit1.Text);

  if IOResult <> 0 then

    MessageDlg('Cannot create directory', mtWarning, [mbOk], 0)

  else

    MessageDlg('New directory created', mtInformation, [mbOk], 0);

end;


MomentSkewKurtosis procedure

Unit

Math

MomentSkewKurtosis calculates the mean, variance, skew, and kurtosis.

procedure MomentSkewKurtosis(const Data: array of Double;

  var M1, M2, M3, M4, Skew, Kurtosis: Extended);

Description

The MomentSkewKurtosis procedure calculates the core factors of statistical analysis: the first four moments plus the coefficients of skewness and kurtosis. M1 is the mean. M2 is the variance. Skew reflects symmetry of distribution. Kurtosis reflects flatness of distribution.


Move procedure

See also

Unit

System

Category

Miscellaneous Routines

Move copies bytes from a source to a destination.

procedure Move(var Source, Dest; Count: Integer);

Description

The Move procedure copies Count bytes from Source to Dest. No range-checking is performed.

Move compensates for overlaps between the source and destination blocks. Whenever possible, use SizeOf to determine the count.

Example

var

  A: array[1..4] of Char;

  B: Integer;

begin

  Move(A, B, SizeOf(B));            { SizeOf = safety! }

end;


MSecsToTimeStamp

See also

Unit

SysUtils

MSecsToTimeStamp converts the number of milliseconds into a TTimeStamp value.

function MSecsToTimeStamp(MSecs: Comp): TTimeStamp;

Description

Call MSecsToTimeStamp to convert MSecs, a number of milliseconds, into the number of days represented, plus the number of milliseconds remaining. The days and milliseconds are expressed as a TTimeStamp value, where the Date field is the number of days and the Time field is the remainder in milliseconds.


NativeToAnsi function

See also

Unit

DBTables

NativeToAnsi converts a string from the character set of the given locale to the ANSI character set.

procedure NativeToAnsi(Locale: TLocale; NativeStr: PChar; var AnsiStr: string);

Description

Call NativeToAnsi to convert a string represented in the character set of the Locale parameter to the ANSI character set (used internally by Delphi). The resulting string is returned as the AnsiStr parameter.

Use NativeToAnsi to convert strings retrieved from a database table into ANSI strings that can be displayed in the user interface.


NativeToAnsiBuf procedure

See also

Unit

DBTables

NativeToAnsiBuf converts a string from the character set of a specified locale into the ANSI character set.

procedure NativeToAnsiBuf(Locale: TLocale; Source, Dest: PChar; Len: Integer);

Description

Call NativeToAnsiBuf to convert a character sequence in the character set of the Locale parameter to the ANSI character set (used internally by Delphi). The resulting string is copied into the buffer pointed to by the Dest parameter. Use the Len parameter to specify the size of this buffer.

Use NativeToAnsiBuf to convert strings from a database table into the ANSI character set so that they can be displayed in the user interface.


NetPresentValue function

Unit

Math

NetPresentValue calculates the current value from an array of estimated cash flow values.

function NetPresentValue(Rate: Extended; const CashFlows: array of Double;

  PaymentTime: TPaymentTime): Extended;

Description

The NetPresentValue function calculates the current value of an array of estimated cash flow values, discounted at the given interest rate of Rate. PaymentTime indicates whether the cash flows occur at the beginning or end of the period (by entering a value of 1or 0, respectively). NetPresentValue helps determine how much an investment is currently worth, based on expected earnings, although its accuracy depends on the accuracy of the cash flows in the array.


New procedure

See also

Unit

System

Category

Dynamic Allocation Routines

New creates a new dynamic variable and sets P to point to it.

procedure New(var P: Pointer);

Description

The New procedure creates a new dynamic variable and sets a pointer variable to point to it. P is a variable of any pointer type. The size of the allocated memory block corresponds to the size of the type that P points to. The newly created variable can be referenced as P^. If there isn't enough memory available to allocate the dynamic variable, an EOutOfMemory exception is raised. For more information on handling run-time library exceptions, see Handling RTL Exceptions

When an application is finished using a dynamic variable created with New, it should dispose of the memory allocated for the variable using the Dispose standard procedure.

Example

type

  PListEntry = ^TListEntry;

  TListEntry = record

    Next: PListEntry;

    Text: string;

    Count: Integer;

  end;

var

  List, P: PListEntry;

begin

  ...

  New(P);

  P^.Next := List;

  P^.Text := 'Hello world';

  P^.Count := 1;

  List := P;

  ...

end;


NewMenu function

See also

Unit

Menus

NewMenu creates and initializes a main menu.

function NewMenu(Owner: TComponent; const AName: string; Items: array of TMenuItem):

   TMainMenu;

Description

Call NewMenu to create and initialize a main menu containing the top level menu items passed in the Items parameter. Use the AName parameter to specify the name of the menu object, and the Owner parameter to specify the form which contains the menu.


NewPopupMenu function

See also

Unit

Menus

NewPopupMenu creates and initializes a popup menu.

function NewPopupMenu(Owner: TComponent; const AName: string;

  Alignment: TPopupAlignment; AutoPopup: Boolean; Items: array of TMenuitem): TPopupMenu;

Description

Call NewPopupMenu to create and initialize a popup menu containing the menu items passed as the Items parameter. Use the AName parameter to specify the name of the popup menu and the Owner parameter to specify its Owner. The Alignment parameter determines where the menu appears relative to the mouse when the user right clicks on the control that uses the menu, and the AutoPopup paramter specifies whether the menu should appear automatically when the user right clicks the associated control. NewPopupMenu does not associate the popup menu with any control.


NewStr function

Unit

SysUtils

Category

String Handling Routines (Pascal style)

NewStr allocates a string on the heap.

function NewStr(const S: string): PString;

Description

The NewStr function is provided for backward compatibility only.


Norm function

See also

Unit

Math

Norm return the Euclidean 'L-2' norm.

function Norm(const Data: array of Double): Extended;

Description

The Norm function returns the Euclidean 'L-2' norm for the values in the Data array. The 'L-2' norm is the square root of the sum of squares.


Now function

See also

Unit

SysUtils

Category

Date/Time Routines

Now returns the current date and time.

function Now: TDateTime;

Description

Returns the current date and time, corresponding to Date + Time.

Example

This example uses a label and a button on a form. When the user clicks the button, the current date and time appear as the caption of the label.

procedure TForm1.Button1Click(Sender: TObject);

begin

  Label1.Caption := 'The date and time is  ' + Str(Now);

end;


NumberOfPeriods function

Unit

Math

NumberOfPeriods returns the number of payment periods for an investment.

function NumberOfPeriods(Rate, Payment, PresentValue, FutureValue: Extended;

  PaymentTime: TPaymentTime): Extended;

Description

The NumberOfPeriods function computes the number of payment periods required for an investment of PresentValue to reach a value of FutureValue, while making regular payments of Payment and accruing interest at the rate of Rate per compounding period. PaymentTime indicates whether the cash flows occur at the beginning or end of the period (by entering a value of 1or 0, respectively).


ObjectBinaryToText procedure

See also

Unit

Classes

ObjectBinaryToText converts the binary representation of an object into more readily understandable text.

procedure ObjectBinaryToText(Input, Output: TStream);

Description

Call ObjectBinaryToText to convert the representation of an object as it is saved in files and memory streams into a text version that can be understood by human readers. ObjectBinaryToText creates a TReader object for the Input stream, and uses this to read the binary representation of the object. A symbolic text representation is then written to the Output stream.

Use the WriteComponent method of the Input stream to write the binary representation before calling ObjectBinaryToText.


ObjectResourceToText procedure

See also

Unit

Classes

ObjectResourceToText converts the binary representation of an object resource into more readily understandable text.

procedure ObjectBinaryToText(Input, Output: TStream);

Description

Call ObjectResourceToText to convert the representation of an object as it is saved in module resource files into a text version that can be understood by human readers. ObjectResourceToText is the same as ObjectBinaryToText, except that it reads from a stream that includes a resource header.

ObjectResourceToText converts the binary version of a form, as stored in a .dfm file, into the text version that can be seen by right clicking the form and choosing View As Text.

Use the WriteComponentRes method of the Input stream to write the binary representation before calling ObjectResourceToText.


ObjectTextToBinary procedure

See also

Unit

Classes

ObjectTextToBinary converts a symbolic text representation of an object into the binary version that is used by Delphi to save the object to files or memory streams.

procedure ObjectTextToBinary(Input, Output: TStream);

Description

Call ObjectTextToBinary to create the internal representation of a Delphi object from a symbolic text representation. ObjectTextToBinary creates a TWriter object for the Output stream, and uses this to write the binary representation of the object from the symbolic representation that is read from the Input stream. Use the ReadComponent method of the output stream to obtain the actual object.


ObjectTextToResource procedure

See also

Unit

Classes

ObjectTextToResource converts a symbolic text representation of an object into the binary representation into Delphi's internal binary representation.

procedure ObjectTextToResource(Input, Output: TStream);

Description

Call ObjectTextToResource to create a Delphi object from the representation of an object as it is saved in module resource files. ObjectTextToResource is the same as ObjectTextToBinary, except that it skips over any object headers and includes a resource header instead. Use the ReadComponentRes method of the output stream to obtain the actual object.

ObjectTextToResource converts the text version of a form that can be seen by right clicking the form and choosing View As Text into the binary version which is stored in a .dfm file.


Odd function

Unit

System

Category

Ordinal Routines

Odd returns True if argument is an odd number.

function Odd(X: Longint): Boolean;

Description

The Odd function tests if the argument is an odd number. Odd returns True if X is an odd number, False if it is even.

Example

begin

   if Odd(5) then

     Canvas.TextOut(10, 10, '5 is odd.')

   else

     Canvas.TextOut(10, 10, 'Something is odd!');

 end;


OleCheck procedure

See also

Unit

ComObj

OleCheck raises an EOleSysError exception if the result code indicates an error.

procedure OleCheck(ECode: HResult);

Description

OleCheck is used to wrap many COM routines, so that if that routine fails, users will have an opportunity to handle it in the resulting exception that is raised.

If ECode is a value less than zero, OleCheck raises an EOleSysError exception specifying the error code.


OleError procedure

See also

Unit

ComObj

OleError raises an EOleSysError exception.

procedure OleError(ErrorCode: HResult);

Description

OleError raises an EOleSysError exception from an error code passed in as the ErrorCode parameter.

OleError is used internally by Delphi to catch failed function calls by raising an EOleSysError exception that indicates the cause of the failure as an error code.


OleStrToString function

See also

Unit

System

OleStrToString copies data received from OLE to a Delphi string.

function OleStrToString(Source: PWideChar): string;

Description

The OleStrToString function copies data received from an OLE function or method into a newly allocated native Delphi string.


OleStrToStrVar procedure

See also

Unit

System

OleStrToStrVar copies an OLE string to an existing Delphi string.

procedure OleStrToStrVar(Source: PWideChar; var Dest: string);

Description

The OleStrToStrVar converts OLE string data into an existing Delphi string variable.


Ord function

See also

Unit

System

Category

Transfer Routines

Ord returns the ordinal value of an ordinal-type expression.

function Ord(X): Longint;

Description

X is an ordinal-type or character-type expression. The result is of type Longint, and its value is the ordinal position of X.

Example

uses Dialogs;

type

   Colors = (RED,BLUE,GREEN);

var

  S: string;

 begin

   S := 'BLUE has an ordinal value of ' + IntToStr(Ord(BLUE)) + #13#10;

   S := 'The ASCII code for "c" is ' + IntToStr(Ord('c')) +  ' decimal';

   MessageDlg(S, mtInformation, [mbOk], 0);

 end;


OutOfMemoryError procedure

See also

Unit

SysUtils

Category

Exception handling routines

OutOfMemoryError raises an EOutOfMemory exception.

procedure OutOfMemoryError;

Description

Call OutOfMemoryError to raise the EOutOfMemory exception. Calling OutOfMemoryError results in smaller code size than creating the exception directly in code.


ParamCount function

See also

Unit

System

Category

Miscellaneous Routines

ParamCount returns the number of parameters passed on the command line.

function ParamCount: Integer;

Description

The ParamCount function returns the number of parameters passed to the program on the command line. Separate parameters with spaces or tabs. Use double quotes to wrap multiple words as one parameter (such as long file names containing spaces).

Example

begin

  if ParamCount = 0 then

    Canvas.TextOut(10, 10, 'No parameters on command line')

  else

    Canvas.TextOut(10, 10, IntToStr(ParamCount) + ' parameter(s)');

end;


ParamStr function

See also

Unit

System

Category

Miscellaneous Routines

ParamStr returns a specified parameter from the command-line.

function ParamStr(Index: Integer): string;

Description

Index is an expression of type Integer. ParamStr returns the parameter from the command line that corresponds to Index, or an empty string if Index is greater than ParamCount. For example, an Index value of 2 returns the second command-line parameter.

ParamStr(0) returns the path and file name of the executing program (for example, C:\TEST\MYPROG.EXE).

Example

var

  I: Word;

  Y: Integer;

begin

  Y := 10;

  for I := 1 to ParamCount do begin

    Canvas.TextOut(5, Y, ParamStr(I));

    Y := Y + Canvas.TextHeight(ParamStr(I)) + 5;

  end;

end;


ParseDate function

See also

Unit

HTTPApp

ParseDate converts a date value from an HTTP message header into a TDateTime value.

function ParseDate(const DateStr: string): TDateTime;

Description

HTTP message headers permit several formats for the representation of date and time values. ParseDate will convert from any of these formats into a TDateTime value. ParseDate allows server applications to work with date values taken from HTTP request messages, without worrying about the details of how they are formatted.

Use ParseDate when interpreting temporal header values in HTTP request messages when they are not already parsed as a property of TWebRequest. TWebRequest parses the Date header and Expires header automatically.


Payment function

Unit

Math

Payment calculates a fully amortized payment.

function Payment(Rate: Extended; NPeriods: Integer;

  PresentValue, FutureValue: Extended; PaymentTime: TPaymentTime): Extended;

Description

The Payment function calculates the fully amortized payment of borrowing PresentValue dollars at Rate percent per period over NPeriods. It assumes that interest is paid at the end of each period.

FutureValue is the value that the investment will reach at some point. PaymentTime indicates whether the cash flows occur at the beginning or end of the period (enter a value of 1 for the beginning or 0 for the end).


PeriodPayment function

Unit

Math

PeriodPayment returns the principal amount from a full payment.

function PeriodPayment(Rate: Extended; Period, NPeriods: Integer;

  PresentValue, FutureValue: Extended; PaymentTime: TPaymentTime): Extended;

Description

The PeriodPayment function gives the part of the payment that is principal. The InterestPayment function gives the part of the payment that is interest.

The Rate parameter is the interest rate. Period is the number of periods into the loan for which the principal is desired, and NPeriods is the number of periods of the loan. FutureValue is the value the investment will reach at some point. PaymentTime indicates whether the cash flows occur at the beginning or end of the period (enter a value of 1 for the beginning or 0 for the end).


Pi function

Unit

System

Category

Arithmetic Routines

Pi returns 3.1415926535897932385.

function Pi: Extended;

Description

Use Pi in mathematical calculations that require pi, the ratio of a circle's circumference to its diameter. Pi is approximated as 3.1415926535897932385.


Point function

See also

Unit

Classes

Point creates a TPoint structure from a pair of coordinates.

function Point(AX, AY: Integer): TPoint;

Description

Call Point to create a TPoint that represents the specified coordinates. Use Point to construct parameters for functions that require TPoint, rather than setting up local variables for each parameter.


Poly function

Unit

Math

Poly evaluates a uniform polynomial of one variable at the value X.

function Poly(X: Extended; const Coefficients: array of Double): Extended;

Description

Call Poly to evaluate the polynomial represented by the Coefficients parameter at the point where the variable equals the value of the X parameter. The coefficients are ordered in increasing powers of X:

    Coefficients[0] + Coefficients[1]*X + ... + Coefficients[N]*(X**N)


PopnStdDev function

Unit

Math

PopnStdDev calculates the population standard deviation.

function PopnStdDev(const Data: array of Double): Extended;

Description

The PopnStdDev function calculates the population standard deviation (the square root of the population variance) of all values in the Data array parameter. This function is used in some business and financial calculations.


PopnVariance function

Unit

Math

PopnVariance calculates the population variance.

function PopnVariance(const Data: array of Double): Extended;

Description

The PopnVariance function calculates the population variance of all values in the Data array parameter, using the n method (biased): TotalVariance / n.


Pos function

See also

Unit

System

Category

String Handling Routines (Pascal style)

Pos returns the index value of the first character in a specified substring that occurs in a given string.

function Pos(Substr: string; S: string): Integer;

Description

Pos searches for a substring, Substr, in a string, S. Substr and S are string-type expressions.

Pos searches for Substr within S and returns an integer value that is the index of the first character of Substr within S. Pos ignores case-insensitive matches. If Substr is not found, Pos returns zero.

Example

var S: string;

begin

  S := '   123.5';

  { Convert spaces to zeroes }

  while Pos(' ', S) > 0 do

    S[Pos(' ', S)] := '0';

end;


Power function

See also

Unit

Math

Power raises Base to any power.

function Power(Base, Exponent: Extended): Extended;

Description

The Power function raises Base to any power. For example, BaseExponent. For fractional exponents or exponents greater than MaxInt, Base must be greater than 0.


Pred function

See also

Unit

System

Category

Ordinal Routines

Pred returns the predecessor of the argument.

function Pred(X);

Description

X is an ordinal-type expression. The result, of the same type as X, is the predecessor of X. Do not use Pred on ordinal-type properties if the property uses a write procedure.

Example

uses Dialogs;

type

   Colors = (RED,BLUE,GREEN);

 var

   S: string;

 begin

   S := 'The predecessor of 5 is ' + IntToStr(Pred(5)) + #13#10;

   S := S + 'The successor of 10 is ' + IntToStr(Succ(10)) + #13#10;

   if Succ(RED) = BLUE then

     S := S + 'In the type Colors, RED is the predecessor of BLUE.';

   MessageDlg(S, mtInformation, [mbOk], 0);

 end;


PresentValue function

Unit

Math

PresentValue calculates the present value of an investment.

function PresentValue(Rate: Extended; NPeriods: Integer;

  Payment, FutureValue: Extended; PaymentTime: TPaymentTime): Extended;

Description

The PresentValue function calculates the present value of an investment where Payment is received for NPeriods and is discounted at the rate of Rate per period. FutureValue is the value the investment may reach at some point. PaymentTime indicates whether the cash flows occur at the beginning or end of the period (enter a value of 1 for the beginning or 0 for the end).


ProgIDToClassID function

See also

Unit

ComObj

ProgIDToClassID returns the class ID (CLSID) TGUID that corresponds to the string specified as the ProgID parameter.

function ProgIDToClassID(const ProgID: string): TGUID;

Description

ProgIDToClassID retrieves, from the registry, the CLSID for a given programmatic ID. The ProgID parameter specifies the programmatic ID for which the CLSID is requested. A programmatic ID is a string that is associated with the CLSID in the registry.

If ProgIDToClassID succeeds it returns a the requested CLSID. If ProgIDToClassID fails an EOleSysError exception is raised with an error code indicating the cause of the error. The error code possibilites are as follows:

Error code	Meaning
CO_E_CLASSSTRING	The registered CLSID for the ProgID is invalid.
REGDB_E_WRITEREGDB	An error occurred writing the CLSID to the registry.
Note

If the ProgID cannot be found in the registry, ProgIDToClassID creates an OLE 1 CLSID for the ProgID and a CLSID entry in the registry.


Ptr function

See also

Unit

System

Category

Pointer and Address Routines

Ptr converts a specified address to a pointer.

function Ptr(Address: Integer): Pointer;

The Ptr function converts the given address to a pointer. A call to this function generates no code, but simply treats the 32-bit value given by Address as a pointer. Like nil, the result of Ptr is assignment compatible with all pointer types.


QuotedStr function

See also

Unit

SysUtils

QuotedStr returns the quoted version of a string.

function QuotedStr(const S: string): string;

Description

Use QuotedStr to convert the string S to a quoted string. A quote character (') is inserted at the beginning and end of S, and each single quote character in the string is repeated.

Note

When working with double byte character systems (DBCS), use AnsiQuotedStr instead.


RadToCycle function

Unit

Math

RadToCycle converts radians to cycles.

function RadToCycle(Radians: Extended): Extended;

Description

The RadToCycle function converts angles measured in radians into cycles.

{ Cycles := Radians / 2PI }


RadToDeg function

Unit

Math

RadToDeg converts radians to degrees.

function RadToDeg(Radians: Extended): Extended;

Description

The RadToDeg function converts angles of radian measure into degrees.

{ Degrees := Radians * 180 / PI }


RadToGrad function

Unit

Math

RadToGrad converts radians to grads.

function RadToGrad(Radians: Extended): Extended;

Description

The RadToGrad function converts angles of radian measure into grads.

{ Grads := Radians * 200 / PI }

{ Radians := Cycles * 2PI }


RaiseLastWin32Error procedure

See also

Unit

SysUtils

RaiseLastWin32Error raises an exception for the last occurring Win32 error.

procedure RaiseLastWin32Error;

Description

Call RaisLastWin32Error to raise an EWin32Error exception for the last Windows API function call that failed. RaiseLastWin32Error retrieves the code for the last occuring Win32 error, if any. If Windows returns a previously occurring error code, RaiseLastWin32Error raises an EWin32Error exception with the error code and message associated with that error.


RandG function

Unit

Math

RandG generates random numbers with Gaussian distribution.

function RandG(Mean, StdDev: Extended): Extended;

Description

The RandG function produces random numbers with Gaussian distribution about the Mean. This is useful for simulating data with sampling errors and expected deviations from the Mean.


Random function

See also

Unit

System

Category

Miscellaneous Routines

Random generates random numbers within a specified range.

function Random [ ( Range: Integer) ];

Description

The Random function returns a random number within the range 0 <= X < Range.

If Range is not specified, the result is a real-type random number within the range
0 <= X < 1.

To initialize the random number generator, call Randomize, or assign a value to the RandSeed variable.

Example

var

   I: Integer;

 begin

   Randomize;

   for I := 1 to 50 do begin

     { Write to window at random locations }

     Canvas.TextOut(Random(Width), Random(Height), 'Boo!');

   end;

 end;

Note

Because the implementation of the Random function may change between compiler versions, we do not recommend using Random for encryption or other purposes that require reproducible sequences of pseudo-random numbers.


Randomize procedure

See also

Unit

System

Category

Miscellaneous Routines

Randomize initializes the random number generator with a random value.

procedure Randomize;

Description

The Randomize procedure initializes the built-in random number generator with a random value (obtained from the system clock).

The random number generator should be initialized by making a call to Randomize, or by assigning a value to RandSeed.

Example

var

   I: Integer;

 begin

   Randomize;

   for I := 1 to 50 do begin

     { Write to window at random locations }

     Canvas.TextOut(Random(Width), Random(Height), 'Boo!');

   end;

 end;


Read procedure

See also

Unit

System

Category

Text File Routines

Read reads data from a file.

Typed files:

procedure Read(F , V1 [, V2,...,Vn ] );

Text files:

procedure Read( [ var F: Text; ] V1 [, V2,...,Vn ] );

Description

The Read procedure can be used in the following ways.

For typed files, it reads a file component into a variable.

For text files, it reads one or more values into one or more variables.

With a type string variable:

Read reads all characters up to, but not including, the next end-of-line marker or until Eof(F) becomes True; it does not skip to the next line after reading. If the resulting string is longer than the maximum length of the string variable, it is truncated.

After the first Read, each subsequent Read sees the end-of-line marker and returns a zero-length string.

Use multiple Readln calls to read successive string values.

When the extended syntax is enabled, Read can read null-terminated strings into zero-based character arrays.

With a type character variable:

Read reads one character from the file and assigns it to the variable. If Eof(F) was True before Read was executed, the value Chr(26) (a Ctrl-Z character) is assigned to the variable.

With type integer or type real variables:

Read skips any blanks, tabs, or end-of-line markers preceding the numeric string.

If the numeric string does not conform to the expected format, an I/O error occurs; otherwise, the value is assigned to the variable.

The next Read starts with the blank, tab, or end-of-line marker that terminated the numeric string.

Example

uses Dialogs;

 var

  F1, F2: TextFile;

  Ch: Char;

begin

  if OpenDialog1.Execute then begin

    AssignFile(F1, OpenDialog1.Filename);

    Reset(F1);

    if SaveDialog1.Execute then begin

      AssignFile(F2, OpenDialog1.Filename);

      Rewrite(F2);

      while not Eof(F1) do

      begin

        Read(F1, Ch);

        Write(F2, Ch);

      end;

      CloseFile(F2);

    end;

    CloseFile(F1);

  end;

end.


ReadComponentRes function

See also

Unit

Classes

ReadComponentRes reads components and their properties from a specified Windows resource.

function ReadComponentRes(const ResName: string; Instance: TComponent): TComponent;

Description

Call ReadComponentRes to create a component from its representation in a Windows resource header. The ResName parameter is the name assigned to the resource for the component. The Instance parameter is an instance of the type of component that should be read. Create an instance of the appropriate type of object, and then call ReadComponentRes to read in its property settings. If Instance is nil, the object class is read from the resource.

ReadComponentRes returns an instance of the component that was read from the resource.


ReadComponentResFile function

See also

Unit

Classes

ReadComponentResFile reads components and their properties from a specified Windows resource file.

function ReadComponentResFile(const FileName: string; Instance: TComponent): TComponent;

Description

Call ReadComponentResFile to create a component and its children from their representation in a Windows resource file. The FileName parameter is the name of the compiled resource file that contains the component resource. The Instance parameter is an instance of the type of component that should be read. Create an instance of the appropriate type of object, and then call ReadComponentResFile to read in its property settings. If Instance is nil, the object class is read from the resource.

ReadComponentResFile returns an instance of the component that was read from the resource file.


Readln procedure

See also

Unit

System

Category

Text File Routines

Readln reads a line of text from a file.

procedure Readln([ var F: Text; ] V1 [, V2, ...,Vn ]);

Description

The Readln procedure reads a line of text and then skips to the next line of the file.

Readln(F) with no parameters causes the current file position to advance to the beginning of the next line if there is one; otherwise, it goes to the end of the file.

{$I+} handles run-time errors using exceptions. For more information on handling run-time library exceptions, see Handling RTL Exceptions.

When using {$I-}, use IOResult to check for I/O errors.

When an application is compiled as a console application (using the Generate console application checkbox on the Linker page of the Project|Options dialog, or a -cc command line switch with the command-line compiler), Delphi automatically associates the Input and Output files with the application's console window. For non-console applications, any attempt to read from Input or write to Output will generate an I/O error.

Example

var

   s : string;

 begin

   Write('Enter a line of text: ');

   Readln(s);

   Writeln('You typed: ',s);

   Writeln('Hit <Enter> to exit');

   Readln;

 end;


ReallocMem procedure

See also

Unit

System

Category

Memory Management Routines

ReallocMem reallocates a dynamic variable.

procedure ReallocMem(var P: Pointer; Size: Integer);

Description

On entry, P must be nil or point to a dynamic variable that was previously allocated with GetMem or ReallocMem.

If P is nil and Size is zero, ReallocMem does nothing.

If P is nil and Size is not zero, ReallocMem allocates a new block of the given size and sets P to point to the block. This corresponds to a call to GetMem.

If P is not nil and Size is zero, ReallocMem disposes the block referenced by P and sets P to nil. This corresponds to a call to FreeMem, except that FreeMem doesn't clear the pointer.

If P is not nil and Size is not zero, ReallocMem reallocates the block referenced by P to the size given by Size. Existing data in the block is not affected by the reallocation, but if the block is made larger, the contents of the newly allocated portion of the block is undefined. If the block cannot be reallocated in place, it is moved to a new location in the heap, and P is updated accordingly.


ect
Rect

See also

Unit

Classes

Rect creates a TRect structure from a set of coordinates.

function Rect(ALeft, ATop, ARight, ABottom: Integer): TRect;

Description

Call Rect to create a TRect that represents the rectangle with the specified coordinates. Use Rect to construct parameters for functions that require TRect, rather than setting up local variables for each parameter.


RegisterClass procedure

See also

Unit

Classes

RegisterClass registers a class of persistent object so that it can use the Object Inspector.

procedure RegisterClass(AClass: TPersistentClass);

Description

Component writers call RegisterClass to register custom classes so that the class type can be obtained from the class name by calling the GetClass function. If a class is not registered, GetClass returns nil when passed the class name.

The AClass parameter is the custom class that is descended from TPersistent. Put the call to RegisterClass in a Register procedure or in the initialization section of the unit in which the class is defined.

If the class is already registered, RegisterClass does nothing. If a different class with the same name is already registered, RegisterClass raises an EFilerError exception.

Note

Registering a component using the RegisterNoIcon or RegisterComponents method does not automatically register the class so that can work with the GetClass function. It is still necessary to call RegisterClass for components.


RegisterClassAlias procedure

See also

Unit

Classes

RegisterClassAlias registers a class that is identical to another class except for the name.

procedure RegisterClassAlias(AClass: TPersistentClass; const Alias: string);

Description

Component writers call RegisterClassAlias to register custom classes that are identical to another persistent class except for the name.


RegisterClasses procedure

See also

Unit

Classes

RegisterClasses registers a set of classes.

procedure RegisterClasses(AClasses: array of TPersistentClass);

Description

Call RegisterClasses to register a set of custom classes in a single line. Each class in the list is registered by calling the RegisterClass procedure. References to registered classes can be obtained from the class name by calling the GetClass function.


RegisterComponentEditor procedure

See also

Unit

DsgnIntf

RegisterComponentEditor registers an editor so that it is available at design time.

procedure RegisterComponentEditor(ComponentClass: TComponentClass;

  ComponentEditor: TComponentEditorClass);

Description

Call RegisterComponentEditor to allow objects instantiated from the specified ComponentClass or one of its descendants use the editor at design time. A registered component editor is created for each component of ComponentClass that is selected in the form designer.  When the component is double-clicked the Edit method of the component editor is called.  When the user right-clicks the component, the GetVerbCount and GetVerb methods of the editor are called to build context menu.

If no component editor is registered, the component uses the default component editor. The default component editor (TDefaultEditor) implements Edit to search the properties of the component and generate the OnCreate, OnChanged, or OnClick event (whichever it finds first).


RegisterComponents procedure

See also

Unit

Classes

RegisterComponents registers a set of components so that they all appear on the same page of the component palette.

procedure RegisterComponents(const Page: string; ComponentClasses: array of

  TComponentClass);

Description

Call RegisterComponents to install a set of components in the IDE. Once a component is registered, it appears on the component palette, where it can be selected and placed on forms. Registered components can communicate with the Object Inspector to allow the user to get and set properties and events.

Set the Page parameterUnRegister

to the name of the page on the component palette where the components should appear. If the named page already exists, the components are added to that page. If the named page does not exist, Delphi creates a new palette page with that name.

Call RegisterComponents from the implementation of the Register procedure in one of the units that defines the custom components. The units that define the components must then be compiled into a package and the package must be installed before the custom components are added to the component palette.

Example

The following code registers several components, some on the System palette page that already exists, and some on a new palette page that Delphi creates when the components are installed.

procedure Register;

begin

   RegisterComponents('System', [TSystem1, TSystem2]); {add to system page}

   RegisterComponents('MyCustomPage',[TCustom1, TCustom2]); { new page}

end;


egisterLibraryExpert procedure
RegisterLibraryExpert procedure

Unit

ExptIntf

RegisterLibraryExpert registers an Expert so that it is installed when the package is installed.

procedure RegisterLibraryExpert(Expert: TIExpert);

Description

Call RegisterLibrary to register an Expert for a package so that it appears in the New Items dialog. If the package already has a registered expert, RegisterLibraryExpert does nothing.


RegisterNoIcon procedure

See also

Unit

Classes

RegisterNoIcon registers a set of components but does not add them to the component palette.

procedure RegisterNoIcon(ComponentClasses: array of TComponentClass);

Description

Call RegisterNoIcon to register a set of custom components so that objects from that class can use the Object Inspector. Because the components are not added to the component palette, instances of components registered using RegisterNoIcon must be explicitly created by calling the Create method, ususally from another component.

The ComponentClasses parameter is an array of custom classes that are descended from TComponent. Put the call to RegisterNoIcon in the Register procedure.

To add the components to the component palette, use the RegisterComponents procedure instead.


RegisterNonActiveX procedure

See also

Unit

Classes

RegisterNonActiveX prevents a set of components from being made available to the ActiveX wizard.

type

  TActiveXRegType = (axrComponentOnly, axrIncludeDescendants);

procedure RegisterNonActiveX(ComponentClasses: array of TComponentClass; AxRegType: TActiveXRegType);

Description

Call RegisterNonActiveX to prevent a registered set of custom components from being converted into ActiveX controls using the ActiveX wizard. The components must still be registered using the RegisterComponents or RegisterNoIcon procedure if they are to work with the Object Inspector.

The ComponentClasses parameter is an array of custom classes that are descended from TComponent. The AxRegType parameter indicates whether only the components in the ComponentClasses array should be blocked from the ActiveX wizard (AxRegType = axrComponentOnly), or whether their descendants should be prohibited from becoming ActiveX controls as well (AxRegType = axrIncludeDescendants).

Put the call to RegisterNonActiveX in the Register procedure.

The TActiveXRegType type is the type of the AxRegType parameter. The following table lists the possible values:

Value	Meaning
axrComponentOnly	Only the component classes explicitly listed in the ComponentClasses parameter will be blocked from appearing in the ActiveX Wizard.
axrIncludeDescendants	All of the component classes listed in the ComponentClasses and any descendant of any of those component classes will be blocked from the Wizard.


RegisterPropertyEditor procedure

See also

Unit

DsgnIntf

RegisterPropertyEditor allows a component to bring up a custom property editor from the Object Inspector.

procedure RegisterPropertyEditor(PropertyType: PTypeInfo; ComponentClass: TClass;

  const PropertyName: string; EditorClass: TPropertyEditorClass);

Description

Call RegisterPropertyEditor to associate the property editor class specified by the EditorClass parameter with the property type specified by the PropertyType parameter.

When a component is selected, the Object Inspector creates a property editor for each of the component's properties, based on the type of the property.  For example, if the property type is an Integer, the property editor for Integer will be created (by default that would be TIntegerProperty). Most properties do not need specialized property editors.  For example, if the property is an ordinal type the default property editor will restrict the range to the subtype range.

When a property type can not be properly edited using the default property editor or one of the existing property editors, use RegisterPropertyEditor to associate a custom property editor with the property type. This is typically because the property is an object.

When registering a property editor, set PropertyType to the type information pointer returned by the TypeInfo function. For example, TypeInfo(TPropertyObject). Set the ComponentClass parameter to restrict the property editor to a component class and its descendants. Setting ComponentClass to nil associates the property editor with the property type for any component. Set the PropertyName parameter to restrict the property editor to properties with a specific name as well as the specified property type. Setting PropertyName to an empty string associates the property editor with any property of the specified type. Set the EditorClass parameter to the class of the property editor that should be displayed when the property is selected in the Object Inspector.


RemoveDir function

See also

Unit

SysUtils

RemoveDir deletes an existing empty directory.

function RemoveDir(const Dir: string): Boolean;

Description

The return value is True if a new directory was successfully deleted, or False if an error occurred.


Rename procedure

See also

Unit

System

Category

I/O Routines

Rename changes the name of an external file.

procedure Rename(var F; Newname);

Description

F is a variable of any file type. Newname is a string-type expression or an expression of type PChar if the extended syntax is enabled.

The external file associated with F is renamed Newname. Further operations on F operate on the external file with the new name.

{$I+} handles run-time errors using exceptions. For more information on handling run-time library exceptions, see Handling RTL Exceptions.

When using {$I-}, use IOResult to check for I/O errors.

Example

uses Dialogs;

var

   f : file;

 begin

   OpenDialog1.Title := 'Choose a file... ';

   if OpenDialog1.Execute then begin

     SaveDialog1.Title := 'Rename to...';

     if SaveDialog1.Execute then begin

       AssignFile(f, OpenDialog1.FileName);

       Canvas.TextOut(5, 10, 'Renaming ' + OpenDialog1.FileName + ' to ' +

         SaveDialog1.FileName);

       Rename(f, SaveDialog1.FileName);

     end;

   end;

 end;


RenameFile function

See also

Unit

SysUtils

Category

File Management Routines

RenameFile changes a file name identified by OldName.

function RenameFile(const OldName, NewName: string): Boolean;

Description

The RenameFile function attempts to change the name of the file specified by OldFile to NewFile. If the operation succeeds, RenameFile returns True. If it cannot rename the file (for example, if a file called NewName already exists), it returns False.

Example

The following code renames a file:

if not RenameFile('OLDNAME.TXT','NEWNAME.TXT') then

  ErrorMsg('Error renaming file!');


Reset procedure

See also

Unit

System

Category

I/O Routines

Reset opens an existing file.

procedure Reset(var F [: File; RecSize: Word ] );

Description

The Reset procedure opens an existing file.

F is a variable of any file type associated with an external file using AssignFile. RecSize is an optional expression, which can be specified only if F is an untyped file. If F is an untyped file, RecSize specifies the record size to be used in data transfers. If RecSize is omitted, a default record size of 128 bytes is assumed.

Reset opens the existing external file with the name assigned to F. An error results if no existing external file of the given name exists. If F is already open, it is first closed and then reopened. The current file position is set to the beginning of the file.

If F is assigned an empty name, such as AssignFile(F, ''), then after the call to Reset, F refers to the standard input file.

If F is a text file, F becomes read-only.

After a call to Reset, Eof(F) is True if the file is empty; otherwise, Eof(F) is False.

{$I+} handles run-time errors using exceptions. For more information on handling run-time library exceptions, see Handling RTL Exceptions.

When using {$I-}, use IOResult to check for I/O errors.

Example

function FileExists(FileName: string): Boolean;

{ Boolean function that returns True if the file exists; otherwise,

  it returns False. Closes the file if it exists. }

 var

  F: file;

begin

  {$I-}

  AssignFile(F, FileName);

  FileMode := 0;  ( Set file access to read only }

  Reset(F);

  CloseFile(F);

  {$I+}

  FileExists := (IOResult = 0) and (FileName <> '');

end;  { FileExists }

begin

  if FileExists(ParamStr(1)) then {Get file name from command line}

    Canvas.TextOut(10, 10, 'File exists')

  else

    Canvas.TextOut(10, 10, 'File not found');

end;


Rewrite procedure

See also

Unit

System

Category

I/O Routines

Rewrite creates a new file and opens it.

procedure Rewrite(var F: File [; Recsize: Word ] );

Description

F is a variable of any file type associated with an external file using AssignFile. RecSize is an optional expression, which can be specified only if F is an untyped file. If F is an untyped file, RecSize specifies the record size to be used in data transfers. If RecSize is omitted, a default record size of 128 bytes is assumed.

Rewrite creates a new external file with the name assigned to F.

If an external file with the same name already exists, it is deleted and a new empty file is created in its place.

If F is already open, it is first closed and then re-created. The current file position is set to the beginning of the empty file.

If F was assigned an empty name, such as AssignFile(F,''), then after the call to Rewrite, F refers to the standard output file.

If F is a text file, F becomes write-only.

After calling Rewrite, Eof(F) is always True.

{$I+} handles run-time errors using exceptions. For more information on handling run-time library exceptions, see Handling RTL Exceptions.

When using {$I-}, use IOResult to check for I/O errors.

Example

var F: TextFile;

begin

  AssignFile(F, 'NEWFILE.$$$');

  Rewrite(F);

  Writeln(F, 'Just created file with this text in it...');

  CloseFile(F);

end;


RmDir procedure

See also

Unit

System

Category

I/O Routines

RmDir deletes an empty subdirectory.

procedure RmDir(S: string);

Description

RmDir removes the subdirectory with the path specified by S. If the path does not exist, is non-empty, or is the currently logged directory, an I/O error occurs.

{$I+} handles run-time errors using exceptions. For more information on handling run-time library exceptions, see Handling RTL Exceptions.

When using {$I-}, use IOResult to check for I/O errors.

Example

uses Dialogs;

begin

   {$I-}

   { Get directory name from TEdit control }

   RmDir(Edit1.Text);

   if IOResult <> 0 then

     MessageDlg('Cannot remove directory', mtWarning, [mbOk], 0)

   else

     MessageDlg('Directory removed', mtInformation, [mbOk], 0);

 end;


Round function

See also

Unit

System

Category

Transfer Routines

Round returns the value of X rounded to the nearest whole number.

function Round(X: Extended): Longint;

Description

The Round function rounds a real-type value to an integer-type value.

X is a real-type expression. Round returns a Longint value that is the value of X rounded to the nearest whole number. If X is exactly halfway between two whole numbers, the result is the number with the greatest absolute magnitude.

If the rounded value of X is not within the Longint range, a run-time error will be generated, which can be handled using the EInvalidOp exception.

Example

var

   S, T: string;

begin

   Str(1.4:2:1, T);

   S := T + ' rounds to ' + IntToStr(Round(1.4)) + #13#10;

   Str(1.5:2:1, T);

   S := S + T + ' rounds to ' + IntToStr(Round(1.5)) + #13#10;

   Str(-1.4:2:1, T);

   S := S + T + ' rounds to ' + IntToStr(Round(-1.4)) + #13#10;

   Str(-1.5:2:1, T);

   S := S + T + ' rounds to ' + IntToStr(Round(-1.5));

   MessageDlg(S, mtInformation, [mbOk], 0);

end;


RunError procedure

See also

Unit

System

Category

Flow Control Routines

RunError stops execution and generates a run-time error.

procedure RunError [ ( Errorcode: Byte ) ];

Description

The RunError procedure stops program execution by generating a run-time error with the given number at the current statement. Errorcode is the run-time error number (0 if omitted).

Example

begin

{$IFDEF Debug}

  if P = nil then

    RunError(204);

{$ENDIF}

end;


Seek procedure

See also

Unit

System

Category

I/O Routines

Seek moves the current position of a file to a specified component.

procedure Seek(var F; N: Longint);

Description

Use Seek only on open typed or untyped files.

In the above syntax, F is a typed or untyped file variable, and N is an expression of type Longint.

The current file position of F moves to component number N. The number of the first component of a file is 0.

To expand a file, seek one component beyond the last component; that is, the statement Seek(F, FileSize(F)) moves the current file position to the end of the file.

{$I+} handles run-time errors using exceptions. For more information on handling run-time library exceptions, see Handling RTL Exceptions.

When using {$I-}, use IOResult to check for I/O errors.

Example

uses Dialogs;

var

   f: file of Byte;

   size : Longint;

   S: string;

   y: integer;

 begin

   if OpenDialog1.Execute then begin

     AssignFile(f, OpenDialog1.FileName);

     Reset(f);

     size := FileSize(f);

     S := 'File size in bytes: ' + IntToStr(size);

     y := 10;

     Canvas.TextOut(5, y, S);

     y := y + Canvas.TextHeight(S) + 5;

     S := 'Seeking halfway into file...';

     Canvas.TextOut(5, y, S);

     y := y + Canvas.TextHeight(S) + 5;

     Seek(f,size div 2);

     S := 'Position is now ' + IntToStr(FilePos(f));

     Canvas.TextOut(5, y, S);

     CloseFile(f);

   end;

 end;


SeekEof function

See also

Unit

System

Category

Text File Routines

SeekEof returns the end-of-file status of a file.

function SeekEof [ (var F: Text) ]: Boolean;

Description

SeekEof can only be used on open text files.

{$I+} handles run-time errors using exceptions. For more information on handling run-time library exceptions, see Handling RTL Exceptions.

When using {$I-}, use IOResult to check for I/O errors.

Example

var

   f : System.TextFile;

   i, j, Y : Integer;

 begin

   AssignFile(f,'TEST.TXT');

   Rewrite(f);

   { Create a file with 8 numbers and some

     whitespace at the ends of the lines }

   Writeln(f,'1 2 3 4 ');

   Writeln(f,'5 6 7 8 ');

   Reset(f);

   { Read the numbers back. SeekEoln returns TRUE if there are no more numbers on the

     current line; SeekEof returns TRUE if there is no more text (other than whitespace)

     in the file. }

   Y := 5;

   while not SeekEof(f) do

   begin

     if SeekEoln(f) then

       Readln; { Go to next line }

     Read(f,j);

     Canvas.TextOut(5, Y, IntToStr(j));

     Y := Y + Canvas.TextHeight(IntToStr(j)) + 5;

   end;

 end;


SeekEoln function

See also

Unit

System

Category

Text File Routines

SeekEoln returns the end-of-line status of a file.

function SeekEoln [ (var F: Text) ]: Boolean;

Description

SeekEoln can be used only on open text files.

{$I+} handles run-time errors using exceptions. For more information on handling run-time library exceptions, see Handling RTL Exceptions.

When using {$I-}, use IOResult to check for I/O errors.

Example

var

   f : System.TextFile;

   i, j, Y : Integer;

 begin

   AssignFile(f,'TEST.TXT');

   Rewrite(f);

   { Create a file with 8 numbers and some

     whitespace at the ends of the lines }

   Writeln(f,'1 2 3 4 ');

   Writeln(f,'5 6 7 8 ');

   Reset(f);

   { Read the numbers back. SeekEoln returns TRUE if there are no more numbers on the

     current line; SeekEof returns TRUE if there is no more text (other than whitespace)

     in the file. }

   Y := 5;

   while not SeekEof(f) do

   begin

     if SeekEoln(f) then

       Readln; { Go to next line }

     Read(f,j);

     Canvas.TextOut(5, Y, IntToStr(j));

     Y := Y + Canvas.TextHeight(IntToStr(j)) + 5;

   end;

 end;


SelectDirectory function

See also

Unit

FileCtrl

SelectDirectory brings up a dialog to allow the user to enter a directory name.

function SelectDirectory(var Directory: string; Options: TSelectDirOpts; HelpCtx: Longint):Boolean;

Description

Call SelectDirectory to let the user enter a directory name. Calling the SelectDirectory function displays the Select Directory dialog box. The directory passed to the function with the Directory parameter appears as the currently selected directory when the dialog box appears. The name of the directory the user selects becomes the value of Directory when the function returns. SelectDirectory does not change the value of the current directory.

The HelpCtx parameter is the help context ID number.

The Options parameter is a set of values. If Options is the empty set, the user can only select a directory that already exists. No edit box is provided for the user to enter a new directory name.

These are the possible values that can be added to the Options set:

Value	Meaning
sdAllowCreate	An edit box appears to allow the user to type in the name of a directory that does not exist. This option does not create a directory, but the application can access the Directory parameter to create the directory selected if desired.
sdPerformCreate	Used only when Options contains sdAllowCreate. If the user enters a directory name that does not exist, SelectDirectory creates it.
sdPrompt	Used when Options contains sdAllowCreate. Displays a message box that informs the user when the entered directory does not exist and asks if the directory should be created. If the user chooses OK, the directory is created if Options contains sdPerformCreate. If Options does not contain sdPerformCreate, the directory is not created: the application should create it when SelectDirectory returns.
The function returns True if the user selected a directory and chose OK, and False if the user chose Cancel or closed the dialog box without selecting a directory.

Example

This example uses a button on a form. When the user clicks the button, a Select Directory dialog box appears. The current directory displayed in the dialog box is C:\MYDIR. The user can select a directory from the directory list, or enter a new directory in the edit box. If the user enters a new directory, a message box asks the user if the directory should be created. If the user chooses Yes, the directory is created. If the user chooses No, the message box goes away without creatubg the directory. The name of the directory the user selects appears as the caption of the label:

uses FileCtrl;

procedure TForm1.Button1Click(Sender: TObject);

var

  Dir: string;

begin

  Dir := 'C:\MYDIR';

  if SelectDirectory(Dir, [sdAllowCreate, sdPerformCreate, sdPrompt]) then

    Label1.Caption := Dir;

end;


Set8087CW

Unit

System

Sets both the control word in the floating point unit and the variable Default8087CW declared in the system unit.

procedure Set8087CW(NewCW: Word);

Description

The floating point unit control word controls the precision of floating point calculcations, the rounding mode, and whether certain floating point operations trigger exceptions. See Intel's processor documentation for details.

The variable Default8087CW is initialized to the initial setting of the floating point unit control word after hardware exceptions.

Changing the control word can be used to disable certain floating exceptions in numerical code (e.g. in third party code). Use this function to set the floating point processor control word to limit which kinds of floating point calculation errors (division by zero, overflow, etc.) will raise exceptions. This applies to the entire application and all modules that the application calls.

For example, it is recommended that you disable all floating point exceptions when using OpenGL to render 3D graphics. To do this, call Set8087CW($133f) in your main form's OnCreate event before calling any OpenGL functions.

Example

  procedure NumericExample;

  var

    Saved8087CW: Word;

  begin

    Saved8087CW := Default8087CW;

    Set8087CW($133f);  { Disable all fpu exceptions }

    ThirdPartyRoutine;

    Set8087CW(Saved8087CW);

  end;


SetCurrentDir function

See also

Unit

SysUtils

SetCurrentDir sets the current directory and returns true if successful.

function SetCurrentDir(const Dir: string): Boolean;

Description

The SetCurrentDir function sets the current directory. The return value is True if the current directory was successfully changed, or False if an error occurred.


SetLength procedure

Unit

System

SetLength sets the dynamic length of a string variable.

procedure SetLength(var S: string; NewLength: Integer);

Description

For a short string variable, SetLength simply sets the length indicator character (the character at S[0]) to the given value. In this case, NewLength must be a value between 0 and 255.

For a long string variable, SetLength reallocates the string referenced by S to the given new length. Any existing characters in the string are preserved, but the contents of any newly allocated space is undefined. If there is not enough memory available to reallocate the string, an EOutOfMemory exception is raised. Following a call to SetLength, S is guaranteed to reference a unique string, that is a string with a reference count of one.


SetMemoryManager procedure

See also

Unit

System

SetMemoryManager sets entry points of the memory manager.

procedure SetMemoryManager(const MemMgr: TMemoryManager);

Description

The SetMemoryManager procedure sets the entry points of the memory manager to the three functions specified by the MemMgr parameter. Use SetMemoryManager to change the memory allocation routines that are used for:

The GetMem, ReallocMem, and FreeMem standard procedures.

The New and Dispose standard procedures.

Allocation and deallocation of objects through constructors and destructors.

Allocation and deallocation of dynamic strings.

The GetMem field of the MemMgr parameter must point to a function that allocates the given number of bytes and returns a pointer to the newly allocated block. The Size parameter passed to the GetMem function will never be zero. If the GetMem function cannot allocate a block of the given size, it should return nil.

The FreeMem field of the MemMgr parameter must point to a function that deallocates the given block. The pointer parameter passed to the FreeMem function will never be nil. If the FreeMem function successfully deallocates the given block, it should return zero. Otherwise, it should return a non-zero value.

The ReallocMem field of the MemMgr parameter must point to a function that reallocates the given block to the given new size. The pointer parameter passed to the ReallocMem function will never be nil, and the Size parameter will never be zero. The ReallocMem function must reallocate the given block to the given new size, possibly moving the block if it cannot be resized in place. Any existing contents of the block must be preserved, but newly allocated space can be uninitialized. The ReallocMem function must return a pointer to the reallocated block, or nil if the block cannot be reallocated.

Example

The following example implements a memory manager that counts the number of times the GetMem, FreeMem, and ReallocMem entry points are called. The new memory manager is installed through a call to the SetNewMemMgr routine. Notice how the new memory manager routines simply pass on the requests to the previous memory manager after incrementing the appropriate counter.

var

  GetMemCount: Integer;

  FreeMemCount: Integer;

  ReallocMemCount: Integer;

  OldMemMgr: TMemoryManager;

function NewGetMem(Size: Integer): Pointer;

begin

  Inc(GetMemCount);

  Result := OldMemMgr.GetMem(Size);

end;

function NewFreeMem(P: Pointer): Integer;

begin

  Inc(FreeMemCount);

  Result := OldMemMgr.FreeMem(P);

end;

function NewReallocMem(P: Pointer; Size: Integer): Pointer;

begin

  Inc(ReallocMemCount);

  Result := OldMemMgr.ReallocMem(P, Size);

end;

const

  NewMemMgr: TMemoryManager = (

  GetMem: NewGetMem;

  FreeMem: NewFreeMem;

  ReallocMem: NewReallocMem);

procedure SetNewMemMgr;

begin

  GetMemoryManager(OldMemMgr);

  SetMemoryManager(NewMemMgr);

end;


SetOleFont procedure

See also

Unit

AX

Connects an OLE font object to a TFont object, and copies the properties of the OLE font object to the TFont.

procedure SetOleFont(Font: TFont; const OleFont: IFontDisp);

Description

OLE conventions implement fonts as automation objects that contain the properties of the font.  This procedure associates an OLE font object (the OleFont parameter) with a native Delphi VCL font (the Font parameter), allowing the font to be accessed by both OLE programs and Delphi programs.  The TFont object is initialized to have the same properties as OleFont.

Call this method when you implement an automation method that takes an OLE font as a parameter, and which needs to pass the font along as a native TFont object.


SetOlePicture procedure

See also

Unit

AX

Connects an OLE picture object to a TPicture object, and copies the properties of the OLE picture object to the TPicture.

procedure SetOlePicture(Picture: TPicture; const OlePicture: IPicture);

Description

OLE conventions implement pictures as automation objects that contain the properties of the picture.  This procedure associates an OLE picture object (the OlePicture parameter) with a native Delphi VCL picture (the Picture parameter), allowing the picture to be accessed by both OLE programs and Delphi programs.  The TPicture object is initialized to have the same properties as OlePicture.

Call this method when you implement an automation method that takes an OLE picture as a parameter, and which needs to pass the picture along as a native TPicture object.


SetString procedure

Unit

System

SetString sets the contents and length of the given string.

procedure SetString(var s: string; buffer: PChar; len: Integer);

Description

The SetString standard procedure sets the contents and length of the given string variable to the block of characters given by the Buffer and Len parameters.

For a short string variable, SetString sets the length indicator character (the character at S[0]) to the value given by Len and then, if the Buffer parameter is not nil, copies Len characters from Buffer into the string starting at S[1]. For a short string variable, the Len parameter must be a value between 0 and 255.

For a long string variable, SetString sets S to reference a newly allocated string of the given length. If the Buffer parameter is not nil, SetString then copies Len characters from Buffer into the string; otherwise, the contents of the new string is left uninitialized. If there is not enough memory available to create the string, an EOutOfMemory exception is raised. Following a call to SetString, S is guaranteed to reference a unique string, that is a string with a reference count of one.


SetTextBuf procedure

See also

Unit

System

Category

Text File Routines

SetTextBuf assigns an I/O buffer to a text file.

procedure SetTextBuf(var F: Text; var Buf [ ; Size: Integer] );

Description

F is a text file variable, Buf is any variable, and Size is a optional expression.

Each Text file variable has an internal 128-byte buffer that buffers Read and Write operations. This buffer is adequate for most operations. However, heavily I/O-bound programs benefit from a larger buffer to reduce disk head movement and file system overhead.

SetTextBuf changes the text file F to use the buffer specified by Buf instead of F's internal buffer. Size specifies the size of the buffer in bytes. If Size is omitted, SizeOf(Buf) is assumed. The new buffer remains in effect until F is next passed to AssignFile.

SetTextBuf can be called immediately after Reset, Rewrite, and Append, but never apply it to an open file.

When SetTextBuf is called on an open file once I/O operations have taken place, data could be lost because of the change of buffer.

Delphi does not ensure that the buffer exists for the entire duration of I/O operations on the file. A common error is to install a local variable as a buffer, then use the file outside the procedure that declared the buffer.

Example

uses Dialogs;

var

  F, FTwo: System.TextFile;

  Ch: Char;

  Buf: array[1..4095] of Char;  { 4K buffer }

begin

  if OpenDialog1.Execute then begin

    AssignFile(F, ParamStr(1));

    { Bigger buffer for faster reads }

    SetTextBuf(F, Buf);

    Reset(F);

    { Dump text file into another file }

    AssignFile(FTwo, 'WOOF.DOG');

    Rewrite(FTwo);

    while not Eof(f) do

    begin

      Read(F, Ch);

      Write(FTwoCh);

    end;

    System.CloseFile(F);

    System.CloseFile(FTwo);

  end;

end;


ShortCut function

See also

Unit

Menus

ShortCut creates a menu shortcut for a specified key combination.

function ShortCut(Key: Word; Shift: TShiftState): TShortCut ;

Description

Call ShortCut to create a menu shortcut at runtime. Specify a Key value using a virtual key code. Specify the values for the Shift, Control, and Alt keys by using a set of type TShiftState. For example, to specify the Shift key, use the set [ssShift]. To specify a Shift and Ctrl key combination, use the set [ssShift, ssCtrl].

Assign the value returned by ShortCut as the value of the ShortCut property of a menu item.

Note

The TextToShortCut function can also create a shortcut. TextToShortCut converts a string to a shortcut, so it can be used to let the user specify the shortcut. However, TextToShortCut executes much more slowly than ShortCut. Use ShortCut whenever possible.

Example

This code creates a shortcut, Ctrl+O, at run time and assigns it to the Open command on a File menu.

begin

  OpenCommand.ShortCut := ShortCut(Word('O'), [ssCtrl]);

end;


ShortCutToKey procedure

See also

Unit

Menus

ShortCutToKey returns the virtual key code and shift state of a menu shortcut.

procedure ShortCutToKey(ShortCut: TShortCut var Key: Word; var Shift: TShiftState ;

Description

Call ShortCutToKey to parse a menu shortcut into its virtual key code and shift state parts.

Example

The following code redefines the ShortCut of CloseCommand if the original short cut used the [ssCtrl] shift state.

var

  TheKey: Word;

  TheShiftState: TShiftState;

begin

  ShortCutToKey(CloseCommand.ShortCut, TheKey, TheShiftState);

  if TheShiftState = [ssCtrl] then

    CloseCommand.ShortCut := ShortCut(Word('C'), [ssShift]);

end;


ShortCutToText function

See also

Unit

Menus

ShortCutToText converts a menu shortcut into a string that describes the shortcut.

function ShortCutToText(ShortCut: TShortCut): string;

Description

Call ShortCutToText to obtain a text description of the shortcut associated with a menu item. Use this function when the application needs to display a description of a shortcut to the user.

Example

This line converts the menu shortcut assigned to the OpenCommand to a string and displays it in an edit box:

Edit1.Text := ShortCutToText(OpenCommand.ShortCut);


ShowException procedure

Unit

SysUtils

Category

Exception handling routines

ShowException displays an exception message with its physical address

procedure ShowException(ExceptObject: TObject; ExceptAddr: Pointer);

Description

This procedure displays the message associated with an exception, together with the exception's physical address. The exception's address can be used with Search|Find Error menu command to find the statement that raised the exception.


ShowMessage procedure

See also

Unit

Dialogs

ShowMessage displays a message box with an OK button.

procedure ShowMessage(const Msg: string);

Description

Call ShowMessage to display a simple message box with an OK button. The Msg parameter is the message string that appears in the message box. The name of the application's executable file appears as the caption of the message box.

To display a message in a message box with other buttons, or with an icon, use the MessageDlg function.

Example

This example uses a button on a form. When the user clicks the button, a message dialog box appears with instructions to push the OK button.

procedure TForm1.Button1Click(Sender: TObject);

begin

  ShowMessage('Push this button');

end;


ShowMessageFmt procedure

See also

Unit

Dialogs

ShowMessageFmt displays a message box with a formatted message.

procedure ShowMessageFmt(const Msg: string; Params: array of const);

Description

Call ShowMessageFmt to display a simple message box with an OK button. The Msg parameter is a format string for the message that appears in the message box. The Params parameter provides the parameters that are assembled into the message. The name of the application's executable file appears as the caption of the message box.

For more information about how messages are formatted, see Format Strings.

To display a message in a message box with other buttons, or with an icon, use the MessageDlg function.


Sin function

See also

Unit

System

Category

Arithmetic Routines

Sin returns the sine of the angle in radians.

function Sin(X: Extended): Extended;

Description

The Sin function returns the sine of the argument.

X is a real-type expression. Sin returns the sine of the angle X in radians.

Example

var

  R: Extended;

  S: string;

begin

  R := Sin(Pi);

  Str(R:5:3, S);

  Canvas.TextOut(10, 10, 'The Sin of Pi is ' + S);

end;


SinCos procedure

Unit

Math

SinCos returns sine and cosine of an angle.

procedure SinCos(Theta: Extended; var Sin, Cos: Extended) register;

Description

The SinCos procedure is twice as fast as calling Sin and Cos separately for the same angle.


Sinh function

Unit

Math

Sinh returns the hyperbolic sine of an angle.

function Sinh(X: Extended): Extended;

Description

The Sinh function calculates the hyperbolic sine of X.


SizeOf function

See also

Unit

System

Category

Miscellaneous Routines

SizeOf returns the number of bytes occupied by X.

function SizeOf(X): Integer;

Description

X is either a variable reference or a type identifier.

Always use SizeOf when passing values to FillChar, Move, and GetMem.

Example

type

  CustRec = record

    Name: string[30];

    Phone: string[14];

  end;

 var

  P: ^CustRec;

begin

  GetMem(P, SizeOf(CustRec));

  Canvas.TextOut(10, 10, 'The size of the record is ' + IntToStr(SizeOf(CustRec)));

  FreeMem (P, SizeOf(CustRec));

  Readln;

end;


Slice function

Unit

System

Slice returns a sub-section of an array.

function Slice(var A: array; Count: Integer): array;

Description

Use the Slice standard function to select a sub-section (slice) of an array to be passed as an open array parameter. Slice is only allowed as an actual parameter in a call to a procedure or function that expects an open array parameter. Slice selects the first Count elements of the array given by A to be passed as an open array parameter. A can itself be an open array parameter, alllowing dynamically allocated arrays to be passed to open array parameters.


SLNDepreciation function

Unit

Math

SLNDepreciation returns the straight-line depreciation allowance of an asset.

function SLNDepreciation(Cost, Salvage: Extended; Life: Integer): Extended;

Description

The SLNDepreciation function calculates the straight-line depreciation allowance for an asset over one period of its life. The function divides the Cost minus the Salvage by the number of years of useful Life of the asset. Cost is the amount initially paid for the asset. Salvage is the value of the asset at the end of its useful life.

To compute accelerated depreciation (allowing higher depreciation values in the first years of the assets life), use the SYDDepreciation function.


Sqr function

See also

Unit

System

Category

Arithmetic Routines

Sqr returns X squared

function Sqr(X: Extended): Extended;

Description

The Sqr function returns the square of the argument.

X is a floating-point expression. The result, of the same type as X, is the square of X, or X*X.

Example

var

  S, Temp: string;

begin

   Str(Sqr(5.0):3:1, Temp);

   S := '5 squared is ' + Temp + #13#10;

   Str(Sqrt(2.0):5:4, Temp);

   S := S + 'The square root of 2 is ' + Temp;

   MessageDlg(S, mtInformation, [mbOk], 0);

end;


Sqrt function

See also

Unit

System

Category

Arithmetic Routines

Sqrt returns the square root of X.

function Sqrt(X: Extended): Extended;

Description

X is a floating-point expression. The result is the square root of X.

Example

var

  S, Temp: string;

begin

   Str(Sqr(5.0):3:1, Temp);

   S := '5 squared is ' + Temp + #13#10;

   Str(Sqrt(2.0):5:4, Temp);

   S := S + 'The square root of 2 is ' + Temp;

   MessageDlg(S, mtInformation, [mbOk], 0);

end;


StatusString function

See also

Unit

HTTPApp

StatusString returns the explanatory string associated with one of the predefined HTTP response status codes.

function StatusString(StatusCode: Integer): string;

Description

The HTTP specification defines a number of standard status codes that indicate the status of an HTTP request message. HTTP applications interpret these status codes, but for human beings, each of these codes has a corresponding string that provides a more understandable indication of the status of the HTTP request.

Call StatusString to obtain the string that corresponds to a standard status code. If the StatusCode parameter is not one of the codes defined in the HTTP 1.1 standard, StatusString returns an empty string.


StdDev function

Unit

Math

StdDev returns the sample standard deviation for elements in an array.

function StdDev(const Data: array of Double): Extended;

Description

The StdDev function calculates the sample standard deviation (the square root of the sample variance) of all values in the Data array parameter.


Str procedure

See also

Unit

System

Category

String Handling Routines (Pascal style)

Str formats a string and returns it to a variable.

procedure Str(X [: Width [: Decimals ]]; var S);

Description

The Str procedure converts X to a string representation according to the Width and Decimals formatting parameters. The effect is like a call to Write except the resulting string is stored in S instead of being written to a text file.

X is an integer-type or real-type expression. Width and Decimals are integer-type expressions. S is a string-type variable or a zero-based character array variable if extended syntax is enabled.

Example

function MakeItAString(I: Longint): string;

{ Convert any integer type to a string }

var

  S: string[11];

begin

  Str(I, S);

  MakeItAString:= S;

end;

begin

  Canvas.TextOut(10, 10, MakeItAString(-5322));

end;


StrAlloc function

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrAlloc allocates a buffer for a null-terminated string and returns a pointer the first character of the string.

function StrAlloc(Size: Cardinal): PChar;

Description

This function allocates a buffer for a null-terminated string with a maximum length of Size - 1 (1 byte must be reserved for the termination character). The result points to the location where the first character of the string is to be stored. A 32-bit number giving the total amount of memory allocated is stored in the four bytes preceding the first character; it is equal to Size + 4. If space for a string is allocated with StrAlloc, it should be deallocated via StrDispose.

Since long strings are implicitly null terminated and dynamically allocated, the use of StrAlloc is in decline.


StrBufSize function

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrBufSize returns max number of characters that can be stored in a buffer allocated by StrAlloc.

function StrBufSize(Str: PChar): Cardinal;

Description

This number includes the termination character. If Str does not point to a string buffer allocated by StrAlloc, no error message is returned, and the result is unpredictable.


StrByteType function

See also

Unit

SysUtils

StrByteType indicates whether a byte in a string is a single byte character, the first byte of a double byte character, or the second byte of a double byte character.

function StrByteType(Str: PChar; Index: Cardinal): TMbcsByteType;

Description

Call ByteType to determine the type of the byte specified by the Index parameter, where 0 specifies the first byte in the string Str, 1 specifies the second byte, and so on.

If the system is not using a double byte character system (DBCS), ByteType always returns mbSingleByte. Otherwise, ByteType returns mbSingleByte if the indicated byte represents a complete character in Str, mbLeadByte if it represents the first byte of a double byte character, and mbTrailByte if it represents the second byte of a double byte character.

Note

No checking is done to ensure that Index is less than the length of Str. It is the caller's responsibility to ensure that Index is not out of bounds.


StrCat function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrCat appends a copy of Source to the end of Dest and returns the concatenated string.

function StrCat(Dest, Source: PChar): PChar;

Description

StrCat does not perform any length checking. The destination buffer must have room for at least StrLen(Dest)+StrLen(Source)+1 characters.

To check length, use the StrLCat function.

Example

uses SysUtils;

const

  Obj: PChar = 'Object';

  Pascal: PChar = 'Pascal';

 var

  S: array[0..15] of Char;

begin

  StrCopy(S, Obj);

  StrCat(S, ' ');

  StrCat(S, Pascal);

  Canvas.TextOut(10, 10, StrPas(S));

end;


StrComp function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrComp compares Str1 to Str2

function StrComp(Str1, Str2 : PChar): Integer;

Description

Return value	Condition
<0	if Str1< Str2
=0	if Str1= Str2
>0	if Str1 > Str2
 Call StrCompare to compare two strings with case sensitivity.

:

When working with International characters, use AnsiStrComp instead.

Example

uses SysUtils;

const

  S1: PChar = 'Wacky';

  S2: PChar = 'Code';

var

  C: Integer;

  ComStr: string;

begin

  C := StrComp(S1, S2);

  if C < 0 then ComStr := ' is less than ' else

    if C > 0 then ComStr := ' is greater than ' else

      ComStr := ' is equal to ';

  Canvas.TextOut(10, 10, StrPas(S1) + ComStr + StrPas(S2));

end;


StrCopy function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrCopy copies Source to Dest and returns Dest.

function StrCopy(Dest, Source: PChar): PChar;

Description

StrCopy does not perform any length checking. The destination buffer must have room for at least StrLen(Source)+1 characters.

For length checking, use the StrLCopy function.

Example

uses SysUtils;

var

  S: array[0..12] of Char;

begin

  StrCopy(S, 'ObjectPascal');

  Canvas.TextOut(10, 10, StrPas(S));

end;


StrDispose procedure

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrDispose disposes of a string.

procedure StrDispose(Str: PChar);

Description

The StrDispose procedure is provided for backwards compatibility only. StrDispose disposes of a string on a heap that was previously allocated with StrAlloc or StrNew.

If Str is nil, StrDispose does nothing.


StrECopy function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrECopy copies Source to Dest and returns a pointer to the null character ending the string.

function StrECopy(Dest, Source: PChar): PChar;

Description

The StrECopy function copies Source to Dest and returns StrEnd(Dest).

StrECopy does not perform any length checking. The destination buffer must have room for at least StrLen(Source)+1 characters.

Nested calls to StrECopy to concatenate a sequence of strings will run more efficiently than multiple calls to StrCat.

Example

uses SysUtils;

const

  Turbo: PChar = 'Object';

  Pascal: PChar = 'Pascal';

 var

  S: array[0..15] of Char;

begin

  StrECopy(StrECopy(StrECopy(S, Turbo), ' '), Pascal);

  Canvas.TextOut(10, 10, StrPas(S));

end;


StrEnd function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrEnd returns a pointer to the end of a null terminated string.

function StrEnd(Str: PChar): PChar;

Description

The StrEnd function returns a pointer to the null character at the end of Str.

Example

uses SysUtils;

const

  S: PChar = 'Yankee Doodle';

begin

  Canvas.TextOut(5, 10, 'The string length of "' + StrPas(S) + '" is ' +

    IntToStr(StrEnd(S) - S));

end;


StrFmt function

See also

Unit

SysUtils

Category

String Formatting Routines

StrFmt formats entries in an array.

function StrFmt(Buffer, Format: PChar; const Args: array of const): PChar;

Description

This function formats the series of arguments in the open array Args. Formatting is controlled by the null-terminated format string Format; the results are returned in Buffer. The function result contains a pointer to the destination buffer.


StrIComp function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrIComp compares Str1 to Str2 without case sensitivity.

function StrIComp(Str1, Str2:PChar): Integer;

Description

Call StrIComp to compare two strings without case sensitivity. StrIComp returns a value greater than 0 if Str1 > Str2, less than 0 if Str1 < Str2, and returns 0 if the strings are equal except for differences in case. When working with international characters, use AnsiStrIComp instead.

Example

uses SysUtils;

const

  S1: PChar = 'Wacky';

  S2: PChar = 'Code';

var

  C: Integer;

  ComStr: string;

begin

  C := StrIComp(S1, S2);

  if C < 0 then ComStr := ' is less than ' else

    if C > 0 then ComStr := ' is greater than ' else

      ComStr := ' is equal to ';

  Canvas.TextOut(10, 10, StrPas(S1) + ComStr + StrPas(S2));

end;


StringOfChar function

Unit

System

StringOfChar returns a string with the specified number of characters.

function StringOfChar(Ch: Char; Count: Integer): string;

Description

The StringOfChar function returns a string containing Count characters with the character value given by Ch. For example,

S := StringOfChar('A', 10);

sets S to the string 'AAAAAAAAAA'.


StringToGUID function

See also

Unit

ComObj

StringToGUID converts a string to a GUID.

function StringToGUID(const S: string): TGUID;

Description

StringToGUID converts a string, S, into the original CLSID.

If StringToGUID succeeds it returns a the requested CLSID. If StringToGUID fails an EOleSysError exception is raised with an error code indicating the cause of the error.


StringToOleStr function

See also

Unit

System

StringToOleStr allocates memory and copies a Delphi string to the OLE format.

function StringToOleStr(const Source: string): PWideChar;

Description

The StringToOleStr function allocates memory and copies string data from a native <Default ｶ Font>Delphi string into a format that can be passed to OLE functions.


StringToWideChar function

Unit

System

Category

Wide character routines

StringToWideChar returns a UNICODE string from an ANSI string.

function StringToWideChar(const Source: string; Dest: PWideChar; DestSize: Integer):

   PWideChar;

Description

The StringToWideChar function converts the string given by Source from ANSI to UNICODE and stores the result in the buffer given by Dest and DestSize. Following the call, the Dest buffer contains at most DestSize - 1 characters from the source string, terminated by a NULL wide character. The function result value is Dest.


StrLCat function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrLCat appends a specified maximum number of characters to string.

function StrLCat(Dest, Source: PChar; MaxLen: Cardinal): PChar;

Description

The StrLCat function appends at most MaxLen - StrLen(Dest) characters from Source to the end of Dest and returns Dest. The SizeOf standard function can be used to determine the MaxLen parameter.

Example

uses SysUtils;

var

  S: array[0..13] of Char;

begin

  StrLCopy(S, 'Object', SizeOf(S) - 1);

  StrLCat(S, ' ', SizeOf(S) - 1);

  StrLCat(S, 'Pascal', SizeOf(S) - 1);

  Canvas.TextOut(10, 10, StrPas(S));

end;


StrLComp function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrLComp compares a specified maximum number of characters in two strings.

function StrLComp(Str1, Str2: PChar; MaxLen: Cardinal): Integer;

Description

The StrLComp function compares Str1 to Str2, up to a maximum length of MaxLen characters. The return value is the same as StrComp.

Example

uses SysUtils;

const

  S1: PChar = 'Enterprise'

  S2: PChar = 'Enter'

var

  ComStr: string;

begin

  if StrLComp(S1, S2, 5) = 0 then

    ComStr := 'equal'

  else

    ComStr := 'different';

  Canvas.TextOut(10, 10, 'The first five characters are ' + ComStr);

end;

Note

When working with international characters, use AnsiStrLComp instead.


StrLCopy function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrLCopy copies a specified maximum number of characters from Source to Dest.

function StrLCopy(Dest, Source: PChar; MaxLen: Cardinal): PChar;

Description

The StrLCopy function copies at most MaxLen characters from Source to Dest and returns Dest. The SizeOf standard function can be used to determine the MaxLen parameter.

Example

uses SysUtils;

var

  S: array[0..11] of Char;

begin

  StrLCopy(S, 'ObjectPascal', SizeOf(S) - 1);

  Canvas.TextOut(10, 10, StrPas(S));

end;


StrLen function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrLen returns number of character in a string excluding the null terminator.

function StrLen(Str: PChar): Cardinal;

Description

The StrLen function returns the number of characters in Str, not counting the null terminator.

Example

uses SysUtils;

const

  S: PChar = 'E Pluribus Unum';

begin

  Canvas.TextOut(5, 10, 'The string length of "' + StrPas(S) + '" is ' +

    IntToStr(StrLen(S)));

end;


StrLFmt function

See also

Unit

SysUtils

Category

String Formatting Routines

StrLFmt formats a series of arguments from the open array specified.

function StrLFmt(Buffer: PChar; MaxLen: Cardinal; Format: PChar; const Args: array of const): PChar;

Description

This function formats the series of arguments in the open array Args. Formatting is controlled by the null-terminated format string Format; the results are returned in Buffer, whose maximum length is given by MaxLen. The function result contains a pointer to the destination buffer.

For information on the format strings, see Format Strings.


StrLIComp function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrLIComp compares strings up to a specified maximum number of characters, not case sensitive.

function StrLIComp(Str1, Str2: PChar; MaxLen: Cardinals): Integer;

Description

StrLIComp compares Str1 to Str2 , up to a maximum length of MaxLen characters, without case sensitivity.

The return value is the same as StrComp.

Example

uses SysUtils;

const

  S1: PChar = 'Enterprise'

  S2: PChar = 'Enter'

var

  ComStr: string;

begin

  if StrLIComp(S1, S2, 5) = 0 then

    ComStr := 'equal'

  else

    ComStr := 'different';

  Canvas.TextOut(10, 10, 'The first five characters are ' + ComStr);

end;

Note

When working with international characters, use AnsiStrLIComp instead.


StrLower function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrLower converts a string to lowercase.

function StrLower(Str: PChar): PChar;

Description

The StrLower function converts Str to lowercase and returns Str.

Example

uses SysUtils;

const

  S: PChar = 'A fUnNy StRiNg'

begin

  Canvas.TextOut(5, 10, StrPas(StrLower(S)) + ' ' + StrPas(StrUpper(S)));

end;


StrMove function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrMove copies specified number of characters to string.

function StrMove(Dest, Source: PChar; Count: Cardinal): PChar;

Description

The StrMove function copies exactly Count characters from Source to Dest and returns Dest. Source and Dest can overlap.

Example

uses SysUtils;

function AHeapaString(S: PChar): PChar;

{ Allocate string on heap }

 var

  L: Cardinal;

  P: PChar;

begin

 StrNew := nil;

 if (S <> nil) and (S[0] <> #0) then

  begin

    L := StrLen(S) + 1;

    GetMem(P, L);

    StrNew := StrMove(P, S, L);

  end;

end;

procedure DisposeDaString(S: PChar);

{ Dispose string on heap }

begin

  if S <> nil then FreeMem(S, StrLen(S) + 1);

end;

var

  S: PChar;

begin

  AHeapaString(S);

  DisposeDaString(S);

end;


StrNew function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrNew allocates space on and copies a string to the heap; returns a pointer to the string.

function StrNew(Str: PChar): PChar;

Description

The StrNew function allocates a copy of Str on the heap.

If Str is nil or points to an empty string, StrNew returns a pointer to a new empty string.

Otherwise, StrNew makes a duplicate of Str, obtaining space with a call to the StrAlloc procedure, and returns a pointer to the duplicated string.

The allocated space is StrLen(Str) + 5 bytes long.

Example

uses SysUtils;

const

  S: PChar = 'Nevermore';

 var

  P: PChar;

begin

  P := StrNew(S);

  Canvas.TextOut(10, 10, StrPas(P));

  StrDispose(P);

end;


StrPas function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrPas converts null-terminated Str to a Pascal-style string.

function StrPas(Str: PChar): string;

Description

This function is provided for backwards compatibility only. To convert a null terminated string to a Pascal style string, use a typecast or an assignment.

Example

uses SysUtils;

const

  A: PChar = 'I love the smell of Object Pascal in the morning.';

 var

  S: string[79];

begin

  S := StrPas(A);

  Canvas.TextOut(10, 10, S);

{ note that the following also works }

  Canvas.TextOut(10, 10, A);

end;


StrPCopy function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrPCopy copies Pascal-style string to a null-terminated string.

function StrPCopy(Dest: PChar; const Source: string): PChar;

Description

The StrPCopy function copies a Pascal-style string Source into a null-terminated string Dest.

StrPCopy does not perform any length checking.

The destination buffer must have room for at least Length(Source)+1 characters.

Example

uses SysUtils;

var

  A: array[0..79] of Char;

  S: String;

begin

  S := 'Honk if you know Blaise.';

  StrPCopy(A, S);

  Canvas.TextOut(10, 10, StrPas(A));

end;


StrPLCopy function

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrPLCopy copies characters from a Pascal-style string into a null-terminated string.

function StrPLCopy(Dest: PChar; const Source: string; MaxLen: Cardinal): PChar;

Description

StrPLCopy copies a maximum of MaxLen characters from the Pascal-style string Source into the null-terminated string Dest. Dest is also returned as the function result.


StrPos function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrPos returns a pointer to the first occurance of STR2 in STR1.

function StrPos(Str1, Str2: PChar): PChar;

Description

The StrPos function returns a pointer to the first occurrence of Str2 in Str1. If Str2 does not occur in Str1, StrPos returns nil.

Example

uses SysUtils;

const

  S: PChar = 'Ready, Set, Go! ';

  SubStr: PChar = 'Set';

var

  P: PChar;

begin

  P := StrPos(S, SubStr);

  if P = nil then

    Canvas.TextOut(10, 10, 'Substring not found')

  else

    Canvas.TextOut(10, 10, 'Substring found at index ' + IntToStr(P - S));

end;


StrRScan function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrRScan returns a pointer to the last occurance of Chr in Str.

function StrRScan(Str: PChar; Chr: Char): PChar;

Description

The StrRScan function returns a pointer to the last occurrence of Chr in Str.

If Chr does not occur in Str, StrRScan returns nil. The null terminator is considered to be part of the string.

Example

{ Return pointer to name part of a full path name }

uses SysUtils;

function NamePart(FileName: PChar): PChar;

 var

  P: PChar;

begin

  P := StrRScan(FileName, '\');

  if P = nil then

  begin

    P := StrRScan(FileName, ':');

    if P = nil then P := FileName;

  end;

  NamePart := P;

end;

var

  S : string;

begin

  S := StrPas(NamePart('C:\Test.fil'));

  Canvas.TextOut(10, 10, S);

end;


StrScan function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrScan returns a pointer to first occurrence of a specified character in a string.

function StrScan(Str: PChar; Chr: Char): PChar;

Description

If Chr does not occur in Str, StrScan returns nil. The null terminator is considered to be part of the string.

Example

uses SysUtils;

function HasWildcards(FileName: PChar): Boolean;

{ Return true if file name has wildcards in it }

begin

  HasWildcards := (StrScan(FileName, '*') <> nil) or

    (StrScan(FileName, '?') <> nil);

end;

const

  P: PChar = 'C:\Test.* ';

begin

  if HasWildcards(P) then

    Canvas.TextOut(20, 20, 'The string has wildcards')

  else

    Canvas.TextOut(20, 20, 'The string doesn't have wildcards')

end;


StrToCurr function

See also

Unit

SysUtils

StrToCurr converts a floating point number to a currency value.

function StrToCurr(const S: string): Currency;

Description

For further details, see the description of the StrToFloat function.


StrToDate function

See also

Unit

SysUtils

Category

Date/Time Routines

StrToDate converts a string to a date format.

function StrToDate(const S: string): TDateTime;

Description

The date in the string must be a valid date.

The string must consist of two or three numbers, separated by the character defined by the DateSeparator global variable. The order for month, day, and year is determined by the ShortDateFormat global variable--possible combinations are m/d/y, d/m/y, and y/m/d.

If the string contains only two numbers, it is interpreted as a date (m/d or d/m) in the current year. Year values between 0 and 99 are assumed to be in the current century.

If the given string does not contain a valid date, an EConvertError exception is raised.

Note

The format of the date string varies when the value of any the date and time typed constants are changed.

Example

This example uses an edit box, a label, and a button on a form. When the user enters a date in the edit box in the MM/DD/YY format, the string entered is converted to a TDateTime value. This value is then converted back to a string value so it can appear as the caption of the label:

procedure TForm1.Button1Click(Sender: TObject);

var

  ADate: TDateTime;

begin

  ADate := StrToDate(Edit1.Text);

  Label1.Caption := DateToStr(ADate);

end;


StrToDateTime function

See also

Unit

SysUtils

Category

Date/Time Routines

StrToDateTime converts a string into TDateTime format.

function StrToDateTime(const S: string): TDateTime;

Description

The string specified as the S parameter must be in the MM/DD/YY HH:MM:SS format. Specifying AM or PM as part of the time is optional, as are the seconds. Use 24-hour time (7:45 PM is entered as 19:45, for example) AM or PM is not specified.

Note

If the date and time typed constants are redefined for the system, the string returned by this function will change.

Example

This example uses an edit box, a label, and a button on the form. When the user enters a date and time in the edit box in the MM/DD/YY HH:MM:SS format, the string entered is converted to a TDateTime value. This value is then converted back to a string value so it can appear as the caption of the label:

procedure TForm1.Button1Click(Sender: TObject);

var

  ADateAndTime: TDateTime;

begin

  ADateAndTime := StrToDateTime(Edit1.Text);

  Label1.Caption := DateTimeToStr(ADateAndTime);

end;


StrToFloat function

Unit

SysUtils

Category

Floating-Point Conversion Routines

StrToFloat converts given string to a floating-point value.

function StrToFloat(const S: string): Extended;

Description

The string must consist of an optional sign (+ or -), a string of digits with an optional decimal point, and an optional 'E' or 'e' followed by a signed integer. Leading and trailing blanks in the string are ignored.

The DecimalSeparator global variable defines the character that must be used as a decimal point. Thousand separators and currency symbols are not allowed in the string. If the string doesn't contain a valid value, an EConvertError exception is raised.


StrToInt function

See also

Unit

SysUtils

Category

String Handling Routines (Pascal style)

StrToInt converts a string representing an integer (decimal or hex notation) to a number.

function StrToInt(const S: string): Integer;

Description

The StrToInt function converts a string representing an integer-type number in either decimal or hexadecimal notation into a number. If the string does not represent a valid number, StrToInt raises an EConvertError exception.

Example

This example uses an edit box and a button on a form. When the user clicks the button, the code converts the string '22467' into an integer, increments that value, then reconverts that new value back to an a string so that it can display in the edit box:

procedure TForm1.Button1Click(Sender: TObject);

var

  S: string;

  I: Integer;

begin

  S := '22467';

  I := StrToInt(S);

  Inc(I);

  Edit1.Text := IntToStr(I);

end;


StrToIntDef function

See also

Unit

Sysutils

Category

String Handling Routines (Pascal style)

StrToIntDef function converts a string to a number.

function StrToIntDef(const S: string; Default: Integer): Integer;

Description

If S does not represent a valid number, StrToIntDef returns the number passed in Default.

Example

This example uses two edit boxes and a button on a form. The user enters a number in the first edit box and clicks the button. If the number entered was a valid integer, the same value appears in the second edit box. If the number was not a valid integer, the default value of 1000 appears in the second edit box:

procedure TForm1.Button1Click(Sender: TObject);

var

  NumberString: string;

  Number: Integer;

begin

  NumberString := Edit1.Text;

  Number := StrToIntDef(NumberString, 1000);

  Edit2.Text := IntToStr(Number);

end;


StrToTime function

See also

Unit

SysUtils

Category

Date/Time Routines

StrToTime converts a string to a time value.

function StrToTime(const S: string): TDateTime;

Description

The string must consist of two or three numbers, separated by the character defined by the TimeSeparator global variable, optionally followed by an AM or PM indicator. The numbers represent hour, minute, and (optionally) second, in that order. If the time is followed by AM or PM, it is assumed to be in 12-hour clock format. If no AM or PM indicator is included, the time is assumed to be in 24-hour clock format. If the given string does not contain a valid time, an EConvertError exception is raised.

Example

This example uses an edit box, a label, and a button on a form. When the user enters a time in the edit box in the HH:MM:SS format, the string entered is converted to a TDateTime value. This value is then converted back to a string value so it can appear as the caption of the label:

procedure TForm1.Button1Click(Sender: TObject);

var

  ATime: TDateTime;

begin

  ATime := StrToTime(Edit1.Text);

  Label1.Caption := TimeToStr(ATime);

end;


StrUpper function

See also

Unit

SysUtils

Category

String Handling Routines (null-terminated)

StrUpper returns a string in upper case.

function StrUpper(Str: PChar): PChar;

Description

The StrUpper function converts Str to uppercase and returns Str.

Example

uses SysUtils;

const

  S: PChar = 'A fUnNy StRiNg'

begin

  Canvas.TextOut(5, 10, StrPas(StrLower(S)) + ' ' +   StrPas(StrUpper(S)));

end;


Succ function

See also

Unit

System

Category

Ordinal Routines

Succ returns the successor of the argument.

function Succ(X);

Description

The Succ function returns the successor of the argument.

X is an ordinal-type expression. The result, of the same type as X, is the successor of X. Do not use Succ on properties if the property uses a write procedure.

Example

uses Dialogs;

type

   Colors = (RED,BLUE,GREEN);

 var

   S: string;

 begin

   S := 'The predecessor of 5 is ' + IntToStr(Pred(5)) + #13#10;

   S := S + 'The successor of 10 is ' + IntToStr(Succ(10)) + #13#10;

   if Succ(RED) = BLUE then

     S := S + 'In the type Colors, RED is the predecessor of BLUE.';

   MessageDlg(S, mtInformation, [mbOk], 0);

 end;


Sum function

See also

Unit

Math

Sum returns the sum of the elements from an array.

function Sum(const Data: array of Double): Extended register;

Description

The Sum function calculates the sum of all the values in the Data array parameter.


SumInt function

See also

Unit

Math

SumInt returns the sum of the elements from an integer array.

function SumInt(const Data: array of Integer): Integer register;

Description

The Sum function calculates the sum of all the values in the Data array parameter.


SumOfSquares function

Unit

Math

SumOfSquares returns the sum of the squared values from a data array.

function SumOfSquares(const Data: array of Double): Extended;

Description

The SumOfSquares function returns the sum of the squares of the Data values: Data[0]2 + Data[1]2 + Data[2]2...


SumsAndSquares procedure

Unit

Math

SumsAndSquares returns the sum of the values and the sum of the squared values in an array.

procedure SumsAndSquares(const Data: array of Double;

  var Sum, SumOfSquares: Extended) register;

Description

The SumsAndSquares procedure returns the sum of the Data values in Sum and the sum of the squares in SumOfSquares. This function is faster than calculating the sums separately.


Swap function

See also

Unit

System

Category

Miscellaneous Routines

Swap exchanges high order byte with the low order byte of an integer or word.

function Swap(X);

Description

The Swap function exchanges the high-order bytes with the low-order bytes of the argument. X is an expression of type Integer, as a 16-bit value, or Word. This is for backwards compatibility only.

Example

var

  X: Word;

begin

  X := Swap($1234);   { $3412 }

end;


SYDDepreciation function

Unit

Math

SYDDepreciation calculates depreciation for an asset.

function SYDDepreciation(Cost, Salvage: Extended; Life, Period: Integer): Extended;

Description

The SYDDepreciation function (for "sum-of-years-digits depreciation") calculates depreciation amounts for an asset using an accelerated depreciation method. This allows for higher depreciation in the earlier years of an asset's life.

Cost is the initial cost of the asset. Salvage is the value of the asset at the end of its life expectancy. Life is the length of the asset's life expectancy. Period is the period for which to calculate the depreciation.


SysErrorMessage function

Unit

SysUtils

SysErrorMessage converts Win32 API error codes into strings.

function SysErrorMessage(ErrorCode: Integer): string;

Description

The SysErrorMessage returns an error message string that corresponds to the specified Win32 API routine error code. This function can be used to convert those error codes into strings.


SysFreeMem function

See also

Unit

System & ShareMem

SysFreeMem frees the memory pointed to by the specified pointer.

function SysFreeMem(P: Pointer): Integer;

Description

When implementing a custom memory manager, use SysFreeMem to free the memory pointed to by the P parameter. Include the System unit if the memory was allocated from the global heap. Include the ShareMem unit instead if the memory was shared with other processes.


SysGetMem function

See also

unit

System or ShareMem

SysGetMem allocates the specified number of bytes and returns a pointer to it.

function SysGetMem(Size: Integer): Pointer;

Description

When implementing a custom memory manager, use SysGetMem to dynamically allocate Size bytes of memory. If the System unit is included, the memory is allocated from the Global heap. If the ShareMem unit is included instead, the memory is reference counted memory that can be shared with other processes.


SysReallocMem function

See also

Unit

System or ShareMem

SysReallocMem returns a pointer to the specified number of bytes, preserving the values pointed to by the Pointer parameter.

function ReallocMem(P: Pointer; Size: Integer): Pointer;

Description

When implementing a custom memory manager, use SysReallocMem to change the size of a dynamically allocated chunk of memory. The memory pointed to by the P parameter is freed, but the values are copied to the newly allocated memory that is returned. If Size is less than the number of bytes pointed to by P, only the first Size bytes are preserved. Otherwise, the entire value of the memory pointed to by P is copied to the newly allocated memory.

If the System unit is included, both the return value and P must point to memory from the global heap. If the ShareMem unit is included instead, P and the return value point to memory that can be shared with other processes.


SystemTimeToDateTime function

See also

Unit

SysUtils

SystemTimeToDateTime converts a TSystemTime value into a Delphi TDateTime value.

function SystemTimeToDateTime(const SystemTime: TSystemTime): TDateTime;

Description

Call SystemTimeToDateTime to convert a value from Windows 32's TSystemTime API format to a Delphi's TDateTime format. For example, the following code retrieves the current date and time using the Windows GetLocalTime API call, and converts this value to a TDateTime value.

function GetCurrentDateTime: TDateTime;

var

  SystemTime: TSystemTime;

begin

  GetLocalTime(SystemTime);

  Result := SystemTimeToDateTime(SystemTime);

end;


Tan function

Unit

Math

Tan returns the tangent of X.

function Tan(X: Extended): Extended;

Description

The Tan function returns the tangent of X. Tan(X) = Sin(X) / Cos(X).


Tanh function

Unit

Math

Tanh returns the hyperbolic tangent of X.

function Tanh(X: Extended): Extended;

Description

The Tanh function calculates the hyperbolic tangent of X.


TerminateExtension function

See also

Unit

ISAPIApp

TerminateExtension indicates whether an ISAPI or NSAPI application is ready to be shut down.

function TerminateExtension(dwFlags: DWORD): BOOL;

Description

Do not call TerminateExtension. TerminateExtension is exported by ISAPI and NSAPI DLLs. It provides an entry point that is called by ISAPI or NSAPI web servers when they are ready to shut down the ISAPI or NSAPI application, to check whether it would cause problems to do so.


TextToFloat function

Unit

SysUtils

Category

Floating Point Conversion Routines

TextToFloat returns a floating point value from a null-terminated string.

function TextToFloat(Buffer: PChar; var Value; ValueType: TFloatValue): Boolean;

Description

TextToFloat converts the null-terminated string given by Buffer to a floating-point value which is returned in the variable given by Value. The Value parameter must be a variable of type Extended or Currency, as indicated by the ValueType parameter. The return value is True if the conversion was successful, or False if the string is not a valid floating-point value. For further details, see the description of the StrToFloat function.

For further details, see the description of the StrToFloat function.


TextToShortCut function

See also

Unit

Menus

TextToShortCut creates a menu shortcut from a text string.

function TextToShortCut(Text: string): TShortCut;

Description

Call TextToShortCut to create a menu shortcut from a descriptivet string. For example, an application can allow users to specify what they want the shortcut to be in an edit box control, then call TextToShortCut to create a menu shortcut for the value entered by the user.

Note

TextToShortCut executes slowly. When possible, use the ShortCut function to create a menu shortcut instead.

Example

This example uses a main menu that contains an Open command, an edit box, and a button. Delphi automatically names the menu item for the Open command Open1. When the user enters the desired shortcut text in the edit box and clicks the button, a shortcut is created and the shortcut text appears next to the Open menu item.

procedure TForm1.Button1Click(Sender: TObject);

var

  NewShortCut: TShortCut;

begin

  NewShortCut := TextToShortCut(Edit1.Text);

  Open1.ShortCut := NewShortCut;

end;


Time function

See also

Unit

SysUtils

Category

Date/Time Routines

Time returns the current time.

function Time: TDateTime;

Description

The Time function returns the current time.

Example

This example uses a label and a button on a form. When the user clicks the button, the current time displays in the caption of the label:

procedure TForm1.Button1Click(Sender: TObject);

begin

  Label1.Caption := 'The time is  ' + TimeToStr(Time);

end;


TimeStampToDateTime function

See also

Unit

SysUtils

TimeStampToDateTime converts a TTimeStamp value into the corresponding TDateTime value.

function TimeStampToDateTime(const TimeStamp: TTimeStamp): TDateTime;

Description

Call TimeStampToDateTime to convert a TTimeStamp value into a TDateTime value. TTimeStamp values represent time as separate date and time values, where the date is the number of calandar days since the start of the current calandar (that is, January 1, 0001 would have a value of 1), and time is the number of milliseconds since midnight. TDateTime values represent time as the number of days (including fractional days) that have elapsed since 12:00 am on December 30, 1899.


TimeStampToMSecs function

See also

Unit

SysUtils

TimeStampToMSecs converts a TTimeStamp value into an absolute number of milliseconds.

function TimeStampToMSecs(const TimeStamp: TTimeStamp): Comp;

Description

Call TimeStampToMSecs to convert TimeStamp, a TTimeStamp value, into the total number of milliseconds that comprise the Date field plus the number of milliseconds given in the Time field.


TimeToStr function

See also

Unit

SysUtils

Category

Date/Time Routines

TimeToStr returns a string from a TDateTime variable.

function TimeToStr(Time: TDateTime): string;

Description

The TimeToStr function converts the Time parameter, a variable of type TDateTime, to a string. The conversion uses the format specified by the LongTimeFormat global variable. Change the format of the string display by changing the values of some of the date and time variables.

Example

This example uses a label and a button on a form. When the user clicks the button, the current time appears as the caption of the label:

procedure TForm1.Button1Click(Sender: TObject);

begin

  Label1.Caption := TimeToStr(Time);

end;


TotalVariance function

Unit

Math

TotalVariance returns the statistical variance from an array of values.

function TotalVariance(const Data: array of Double): Extended;

Description

The TotalVariance function returns the sum of the squares of the difference between each Data value and the mean of the data values.

{Total Variance: SUM(i=1,N)[(X(i) - Mean)**2]}


Trim function

See also

Unit

SysUtils

Trim trims a string of leading and trailing spaces and control characters.

function Trim(const S: string): string;

Description

The Trim function trims leading and trailing spaces and control characters from the given string S.


TrimLeft function

See also

Unit

SysUtils

TrimLeft trims string of leading spaces and control characters.

function TrimLeft(const S: string): string;

Description

The TrimLeft function trims leading spaces and control characters from the given string S.


TrimRight function

See also

Unit

SysUtils

TrimRight trims string of trailing spaces and control characters.

function TrimRight(const S: string): string;

Description

The TrimRight function trims trailing spaces and control characters from the given string S.


Trunc function

See also

Unit

System

Category

Transfer Routines

Trunc truncates a real number to an integer.

function Trunc(X: Extended): Longint;

Description

The Trunc function truncates a real-type value to an integer-type value.

X is a real-type expression. Trunc returns a Longint value that is the value of X rounded toward zero.

If the truncated value of X is not within the Longint range, an error occurs, which can be handled using the EInvalidOp exception. If it is not handled, a run-time error will be generated.

Example

var

   S, T: string;

begin

   Str(1.4:2:1, T);

   S := T + ' Truncs to ' + IntToStr(Trunc(1.4)) + #13#10;

   Str(1.5:2:1, T);

   S := S + T + ' Truncs to ' + IntToStr(Trunc(1.5)) + #13#10;

   Str(-1.4:2:1, T);

   S := S + T + ' Truncs to ' + IntToStr(Trunc(-1.4)) + #13#10;

   Str(-1.5:2:1, T);

   S := S + T + ' Truncs to ' + IntToStr(Trunc(-1.5));

   MessageDlg(S, mtInformation, [mbOk], 0);

end;


Truncate procedure

See also

Unit

System

Category

I/O Routines

Truncate deletes all the records after the current file position.

procedure Truncate(var F);

Description

The current file position also becomes end-of-file (Eof(F) is True).

F is a file variable of any type. Truncate does not work on text files. F must be open.

Example

var

   f: file of Integer;

   i,j: Integer;

 begin

   AssignFile(f,'TEST.INT');

   Rewrite(f);

   for i := 1 to 6 do

     Write(f,i);

   Writeln('File before truncation:');

   Reset(f);

   while not Eof(f) do

   begin

     Read(f,i);

     Writeln(i);

   end;

   Reset(f);

   for i := 1 to 3 do

     Read(f,j); { Read ahead 3 records }

   Truncate(f); { Cut file off here }

   Writeln;

   Writeln('File after truncation:');

   Reset(f);

   while not Eof(f) do

   begin

     Read(f,i);

     Writeln(i);

   end;

   CloseFile(f);

   Erase(f);

 end;


TypeInfo function

Unit

System

TypeInfo returns a pointer to compiler generated run-time type information for a type identifier.

function TypeInfo(TypeIdent): Pointer;

Description

Certain low-level VCL procedures and functions require run-time type information pointers as parameters. The actual format of the run-time type information is internal to the compiler and may change between releases.


UniqueString procedure

Unit

System

UniqueString makes a given string unique.

procedure UniqueString(var S: string);

Description

Following a call to SetString, S is guaranteed to reference a unique string; that is, a string with a reference count of one. For normal string handling, there is no need to ever call UniqueString. Only in cases where an application casts a string to a PChar and then modifies the contents of the string must UniqueString be used.


UnixPathToDosPath function

See also

Unit

HTTPApp

UnixPathToDosPath converts a Unix-compatible path specification to a Dos-compatible path specification.

function UnixPathToDosPath(const Path: string): string;

Description

Use UnixPathToDosPath to convert a path name obtained from an HTTP message or other Unix-based application to a path name that can be used by Windows. UnixPathToDosPath converts all forward slashes (/) to backslash characters (\).

The Path parameter is the Unix-compatible path. The return value is the corresponding Dos-compatible path.


UnloadPackage procedure

See also

Unit

SysUtils

UnloadPackage unloads a package.

procedure UnloadPackage(Module: HMODULE);

Description

Call UnloadPackage to unload a package that was loaded using the LoadPackage function. UnloadPackage calls the finalization blocks of all units contained in the package and then unloads the package DLL.


UnregisterClass procedure

See also

Unit

Classes

UnregisterClass unregisters an object class.

procedure UnRegisterClass(AClass: TPersistentClass);

Description

Call UnregisterClass to unregister a an object class. When a class is unregistered, its name can be reused to register another object class. Unregistered classes can not be obtained from the class name using the GetClass function.


UnregisterClasses procedure

See also

Unit

Classes

UnregisterClasses unregisters a set of classes.

procedure UnRegisterClasses(AClasses: array of TPersistentClass);

Description

Call UnregisterClasses to unregister several persistent object classes in a single line. When a class is unregistered, its name can be reused to register another object class. Unregistered classes can not be obtained from the class name using the GetClass function.


UnregisterModuleClasses procedure

See also

Unit

Classes

UnregisterModuleClasses unregisters all classes defined in a specified module.

procedure UnRegisterModuleClasses(Module: HMODULE);

Description

Call UnregisterModuleClasses to unregister all object classes that were registered by the module with the handle specified by the Module parameter. When a class is unregistered, its name can be reused to register another object class. Unregistered classes can not be obtained from the class name using the GetClass function.


UpCase function

See also

Unit

System

Category

Miscellaneous Routines

UpCase converts a character to uppercase.

function UpCase(Ch: Char): Char;

Description

The UpCase function converts a Ch to uppercase.

Ch is an expression of type Char. Character values not in the range a..z are unaffected.

Example

uses Dialogs;

var

   s : string;

   i : Integer;

 begin

   { Get string from TEdit control }

   s := Edit1.Text;

   for i := 1 to Length(s) do

     s[i] := UpCase(s[i]);

   MessageDlg('Here it is in all uppercase: ' + s, mtInformation, [mbOk], 0);

 end;


UpperCase function

See also

Unit

SysUtils

Category

String Handling Routines (Pascal style)

UpperCase returns a string in uppercase.

function UpperCase(const S: string): string;

Description

The UpperCase function returns a string containing the same text as S, but with all 7-bit ASCII characters between 'a' and 'z' converted to uppercase. To convert 8-bit international characters, use AnsiUpperCase instead.

Example

This example uses a list box and a button on a form. Use the Items property editor in the Object Inspector to enter a list of strings in the list box. When the application runs and the button is clicked, the strings in the list box become uppercase.

procedure TForm1.Button1Click(Sender: TObject);

var

  I: Integer;

begin

  for I := 0 to ListBox1.Items.Count -1 do

    ListBox1.Items[I] := UpperCase(ListBox1.Items[I]);

end;


Val procedure

See also

Unit

System

Category

String Handling Routines (Pascal style)

Val converts a string to a numeric representation.

procedure Val(S; var V; var Code: Integer);

Description

The Val function converts the string value S to its numeric representation, as if it were read from a text file with Read.

S is a string-type expression; it must be a sequence of characters that form a signed whole number. V is an integer-type or real-type variable. Code is a variable of type Integer.

If the string is invalid, the index of the offending character is stored in Code; otherwise, Code is set to zero. For a null-terminated string, the error position returned in Code is one larger than the actual zero-based index of the character in error.

Val performs range checking differently depending upon the state of $R and the type of the parameter V.

Setting	Result
{$R+}	An out-of-range value always generates a run-time error.
{$R-}	The values for out-of-range vary depending upon the data type of V.
Example

uses Dialogs;

var

  I, Code: Integer;

begin

  { Get text from TEdit control }

  Val(Edit1.Text, I, Code);

  { Error during conversion to integer? }

  if code <> 0 then

    MessageDlg('Error at position: ' + IntToStr(Code), mtWarning, [mbOk], 0);

  else

    Canvas.TextOut(10, 10, 'Value = ' + IntToStr(I));

  Readln;

end;


ValidParentForm function

See also

Unit

Forms

ValidParentForm returns the form or property page that contains a specified control.

function ValidParentForm(Control: TControl): TCustomForm;

Description

Call ValidParentForm to obtain the descendant of TCustomForm that contains the control specified by the Control parameter. If the control is not contained in a Delphi form (for example, an ActiveX control embedded in another type of window), ValidParentFrom raises an EInvalidOperation exception.


VarArrayCreate function

See also

Unit

System

Category

Variant support routines

VarArrayCreate creates a variant array.

function VarArrayCreate(const Bounds: array of Integer; VarType: Integer): Variant;

Description

The VarArrayCreate function creates a variant array with the bounds given by Bounds and the element type given by VarType. The Bounds parameter must contain an even number of values, and each pair of values specify the upper and lower bounds of one dimension of the array. The element type of the array, given by the VarType parameter, must be one of the TVarData type codes, and cannot include the varArray or varByRef bits. The element type cannot be varString. To create a variant array of strings use the varOleStr type code. If the element type is varVariant, the elements of the array are themselves variants and can in turn contain variant arrays.

Note :

Variant arrays with an element type of varByte are the preferred method of passing binary data between OLE Automation controllers and servers. Such arrays are subject to no translation of their data, and can be efficiently accessed using the VarArrayLock and VarArrayUnlock routines.

Example

The following example creates a one-dimensional variant array with five elements. Each of the elements are of type Variant, and can therefore contain values of varying types, as is illustrated by the example. Notice in particular how the value of the last element of the array is itself a variant array.

var

  A: Variant;

begin

  A := VarArrayCreate([0, 4], varVariant);

  A[0] := 1;

  A[1] := 1234.5678;

  A[2] := 'Hello world';

  A[3] := True;

  A[4] := VarArrayOf([1, 10, 100, 1000]);

  WriteLn(A[2]);	{ Hello world }

  WriteLn(A[4][2]);	{ 100 }

end;


VarArrayDimCount function

See also

Unit

System

Category

Variant support routines

VarArrayDimCount returns number of dimensions of a variant array.

function VarArrayDimCount(const A: Variant): Integer;

Description

The VarArrayDimCount function returns the number of dimensions of the given variant. The resulting value is zero if the given variant is not a variant array.


VarArrayHighBound function

See also

Unit

System

Category

Variant support routines

VarArrayHighBound returns high bound for a dimension in a variant array.

function VarArrayHighBound(const A: Variant; Dim: Integer): Integer;

Description

The VarArrayHighBound function returns the high bound of the given dimension in the given variant array. The Dim parameter should be 1 for the leftmost dimension, 2 for the second leftmost dimension, and so on. An EVariantError exception is raised if the variant given by A is not an array, or if the dimension specified by Dim does not exist.


VarArrayLock function

See also

Unit

System

Category

Variant support routines

VarArrayLock locks a variant array and returns a pointer to the data.

function VarArrayLock(var A: Variant): Pointer;

Description

The VarArrayLock function locks the given variant array and returns a pointer to the data stored in the array. While locked, a variant array can not be resized and any calls to the VarArrayRedim procedure will fail. Once locked, a variant array must later be unlocked using the VarArrayUnlock procedure. An EVariantError exception is raised if the variant given by A is not an array.

The pointer returned by VarArrayLock points to an array of elements in which the leftmost dimension increases first. In other words, the dimensions of the returned array pointer are reversed from the dimensions of the variant array.

Once it is verified that a variant array has the correct bounds and dimensions, VarArrayLock can be used to gain direct access to the array data which results in much improved performance.

Example

type

  PArrayData = ^TArrayData;

  TArrayData = array[0..9, 1..3] of Integer;

var

  A: Variant;

  P: PArrayData;

  I, J: Integer;

begin

  A := VarArrayCreate([1, 3, 0, 9], varInteger);

  P := VarArrayLock(A);

  try

  for I := 0 to 9 do

    for J := 1 to 3 do

      P^[I, J] := J * 10 + I;

  finally

  VarArrayUnlock(A);

  end;

  WriteLn(A[1, 9]);	{ 19 }

  WriteLn(A[3, 4]);	{ 34 }

end;


VarArrayLowBound function

See also

Unit

System

Category

Variant support routines

VarArrayLowBound returns the low bound of a dimension in a variant array.

function VarArrayLowBound(const A: Variant; Dim: Integer): Integer;

Description

The VarArrayLowBound function returns the low bound of the given dimension in the given variant array. The Dim parameter should be 1 for the leftmost dimension, 2 for the second leftmost dimension, and so on. An EVariantError exception is raised if the variant given by A is not an array, or if the dimension specified by Dim does not exist.


VarArrayOf function

See also

Unit

System

Category

Variant support routines

VarArrayOf creates and fills a one-dimensional variant array.

function VarArrayOf(const Values: array of Variant): Variant;

Description

The VarArrayOf function returns a one-dimensional variant array with the elements given by the Values parameter. The low bound of the returned array is zero, the high bound is the number of values given by the Values parameter less one, and the element type is Variant.


VarArrayRedim procedure

See also

Unit

System

Category

Variant support routines

VarArrayRedim resizes a variant array.

procedure VarArrayRedim(var A: Variant; HighBound: Integer);

Description

VarArrayRedim resizes the given variant array by changing the high bound of the rightmost dimension to the given value. The A parameter can be a Variant or an OleVariant, and it must be an lvalue.

Existing elements of the array are preserved, and new elements are set to zero or empty. An EVariantError exception is raised if the variant given by A is not an array, or if there is not enough memory to resize the array.


VarArrayRef function

See also

Unit

System

Category

Variant support routines

Refurns a reference to the passed variant array.

function VarArrayRef(const A: Variant): Variant;

Description

Use this function to reference a variant array when a referenced variant array is expected in some API call.


VarArrayUnlock procedure

See also

Unit

System

Category

Variant support routines

VarArrayUnlock unlocks a variant array.

procedure VarArrayUnlock(var A: Variant);

Description

The VarArrayUnlock procedure unlocks a variant array that was previously locked by VarArrayLock. An EVariantError exception is raised if the variant given by A is not an array.


VarAsType function

See also

Unit

System

Category

Variant support routines

VarAsType converts a variant to specified type.

function VarAsType(const V: Variant; VarType: Integer): Variant;

Description

The VarAsType function converts the variant given by V to the type given by VarType. The resulting value is a variant of the type given by VarType. The VarType parameter must be one of the TVarData type codes, and cannot include the varArray or varByRef bits. An EVariantError exception is raised if the variant cannot be converted to the given type.

The VarCast procedure provides the same functionality as VarAsType.


VarCast procedure

See also

Unit

System

Category

Variant support routines

VarCast converts a variant to a specified type storing the result in a variable.

procedure VarCast(var Dest: Variant; const Source: Variant; VarType: Integer);

Description

The VarCast procedure converts the variant given by Source to the type given by VarType and stores the resulting variant in Dest. Dest can be a Variant or an OleVariant, and it must be an lvalue. Source is defined as a Variant, but an OleVariant should be silently allowed because it is a compatible type. The VarType parameter must be one of the TVarData type codes, and cannot include the varArray or varByRef bits. An EVariantError exception is raised if the variant cannot be converted to the given type.

The following table lists the expected behavior when using Variant and OleVariant types as parameters:

Dest	Source	Behavior
Variant	OleVariant	Fine as is.
Variant	Variant	Fine as is.
OleVariant	OleVariant	OleVariants use a WideString rather than a Pascal string.
OleVariant	Variant	OleVariants use a WideString rather than a Pascal string.
The VarAsType function provides the same functionality as VarCast.


VarClear procedure

See also

Unit

System

Category

Variant support routines

VarClear clears the given variant.

procedure VarClear(var V: Variant);

Description

After the call to VarClear, the variant, V, has the value Unassigned. V can be either a Variant or an OleVariant, but it must be an lvalue.


VarCopy procedure

Unit

System

Category

Variant support routines

VarCopy copies a variant.

procedure VarCopy(var Dest: Variant; const Source: Variant);

Description

The VarCopy procedure copies the variant given by Source into the variant given by Dest. The call VarCopy(Dest, Source) is the same as writing Dest := Source. Dest can be a Variant or an OleVariant, and it must be an lvalue. Source is defined as a Variant, but an OleVariant should be silently allowed because it is a compatible type. The following table lists the expected behavior when using Variant and OleVariant types as parameters:

Dest	Source	Behavior
Variant	OleVariant	Fine as is.
Variant	Variant	Fine as is.
OleVariant	OleVariant	Fine as is.
OleVariant	Variant	Source should be implicitly cast to an OleVariant.
Note

Casts such as Variant(Integer) should fail. Casts of the form PVariant(@somevariable)^ will work.


VarFromDateTime function

See also

Unit

System

Category

Variant support routines

VarFromDateTime returns a variant containing a specified data and time.

function VarFromDateTime(DateTime: TDateTime): Variant;

Description

The VarFromDateTime function returns a variant that contains the given date and time value. The type code of the resulting variant is varDate.


Variance function

Unit

Math

Variance calculates statistical sample variance from an array of data.

function Variance(const Data: array of Double): Extended;

Description

The Variance function calculates the sample variance of all values in the Data array parameter, using the n-1 method (unbiased): TotalVariance / (n-1).


VarIsArray function

See also

Unit

System

Category

Variant support routines

VarIsArray returns true if the specified variant is an array.

function VarIsArray(const V: Variant): Boolean;

Description

The VarIsArray function returns True if the given variant is an array. Otherwise, the function result is False.


VarIsEmpty function

See also

Unit

System

Category

Variant support routines

VarIsEmpty returns true if the specified variant is Unassigned.

function VarIsEmpty(const V: Variant): Boolean;

Description

The VarIsEmpty function returns True if the given variant contains the value Unassigned. If the variant contains any other value, the function result is False.


VarIsNull function

See also

Unit

System

Category

Variant support routines

VarIsNull returns True is the specified variant is Null.

function VarIsNull(const V: Variant): Boolean;

Description

The VarIsNull function returns True if the given variant contains the value Null. If the variant contains any other value, the function result is False.


VarToDateTime function

See also

Unit

System

Category

Variant support routines

VarToDateTime converts a specified variant to date and time.

function VarToDateTime(const V: Variant): TDateTime);

Description

The VarToDateTime function converts the given variant to a date and time value. An EVariantError exception is raised if the conversion fails.


VarToStr function

Unit

System

VarToStr converts variant to string.

function VarToStr(const V: Variant): string;

Description

The VarToStr function converts the data in a variant to a string.


VarType function

See also

Unit

System

Category

Variant support routines

VarType returns type code of specified variant.

function VarType(const V: Variant): Integer;

Description

The VarType function returns the type code of the given variant. The resulting value is constructed from the following constants declared in the System unit.

const

  varEmpty    = $0000;

  varNull     = $0001;

  varSmallint = $0002;

  varInteger  = $0003;

  varSingle   = $0004;

  varDouble   = $0005;

  varCurrency = $0006;

  varDate     = $0007;

  varOleStr   = $0008;

  varDispatch = $0009;

  varError    = $000A;

  varBoolean  = $000B;

  varVariant  = $000C;

  varUnknown  = $000D;

  varByte     = $0011;

  varString   = $0100;

  varTypeMask = $0FFF;

  varArray    = $2000;

  varByRef    = $4000;

The lower twelve bits of a variant type code (the bits defined by the varTypeMask bit mask) define the type of the variant. The varArray bit is set if the variant is an array of the given type. The varByRef bit is set if the variant is a reference to a value of the given type as opposed to an actual value.

The following table describes the meaning of each of the variant type codes.

VarType	Contents of variant
varEmpty	The variant is Unassigned.
varNull	The variant is Null.
VarSmallint	16-bit signed integer (type Smallint).
varInteger	32-bit signed integer (type Integer).
varSingle	Single-precision floating-point value (type Single).
varDouble	Double-precision floating-point value (type Double).
varCurrency	Currency floating-point value (type Currency).
varDate	Date and time value (type TDateTime).
varOLEStr	Reference to a dynamically allocated UNICODE string.
varDispatch	Reference to an OLE automation object (an IDispatch interface pointer).
varError	Operating system error code.
varBoolean	16-bit boolean (type WordBool).
varUnknown	Reference to an unknown OLE object (an IUnknown interface pointer).
varString	Reference to a dynamically allocated Pascal string (type AnsiString).
The value returned by VarType corresponds to the VType field of a TVarData record.

The type of a variant can be changed using the VarAsType standard function.


WideCharLenToString function

See also

Unit

System

Category

Wide character routines

WideCharLenToString converts Unicode characters to an ANSI string.

function WideCharLenToString(Source: PWideChar; SourceLen: Integer): string;

Description

The WideCharLenToString function converts SourceLen Unicode characters from the buffer given by Source to an ANSI string. The function uses the WideCharToMultiByte Win32 API function to perform the actual conversion.


WideCharToString function

See also

Unit

System

Category

Wide character routines

WideCharToString converts null-terminated Unicode string to an ANSI string.

function WideCharToString(Source: PWideChar): string;

Description

The WideCharToString function converts the given null-terminated Unicode string to an ANSI string. The function uses the WideCharToMultiByte Win32 API function to perform the actual conversion.


WideCharToStrVar procedure

See also

Unit

System

WideCharToStrVar converts Unicode string to a single byte character data.

procedure WideCharToStrVar(Source: PWideChar; var Dest: string);

Description

The WideCharToStrVar procedure converts WideChar (Unicode) string data into single byte character data, and copies the result into the provided destination string variable. The source must be null-terminated.


Win32Check function

See also

Unit

SysUtils

Win32Check checks the return value of a Windows API call and raises an appropriate exception when it indicates failure.

function Win32Check(RetVal: BOOL): BOOL;

Description

Call Win32Check with the return value of a Windows API call that returns a Boolean to indicate success or failure. If the Windows API function returns False (indicating failure), Win32Check calls RaiseLastWin32Error to raise an exception.  If the API function returns True, Win32Check returns True.


Write procedure

Unit

System

There are two versions of the standard procedure Write, one for text files, the other for typed files.

Write procedure for text files

Write procedure for typed files


Write procedure (for text files)

See also

Write writes to a text file.

procedure Write( [var F: Text; ] P1 [ , P2,..., Pn] );

Description

The Write procedure writes one or more values to a text file. F, if specified, is a text file variable. If F is omitted, the standard file variable Output is assumed. Each P is a write parameter. Each write parameter includes an output expression whose value is to be written to the file. A write parameter can also contain the specifications of a field width and a number of decimal places. Each output expression must be of a type Char, one of the Integer types (Byte, Shortint, Word, Longint, Cardinal), one of the floating-point types (Single, Real, Double, Extended, Currency), one of the string types (PChar, AnsiString, ShortString), a packed string, or one of the Boolean types (Boolean, Bool).

A write parameter has the form

OutExpr [: MinWidth [: DecPlaces ] ]

where OutExpr is an output expression. MinWidth and DecPlaces are type integer expressions.

MinWidth specifies the minimum field width, which must be greater than 0. Exactly MinWidth characters are written (using leading blanks if necessary) except when OutExpr has a value that must be represented in more than MinWidth characters. In that case, enough characters are written to represent the value of OutExpr. Likewise, if MinWidth is omitted, then the necessary number of characters are written to represent the value of OutExpr.

DecPlaces specifies the number of decimal places in a fixed-point representation of one of the Real types. It can be specified only if OutExpr is one of the Real types, and if MinWidth is also specified. When MinWidth is specified, it must be greater than or equal to 0.

Write with a character-type value:

If MinWidth is omitted, the character value of OutExpr is written to the file. Otherwise, MinWidth - 1 blanks followed by the character value of OutExpr is written.

Write with one of the integer type values:

If MinWidth is omitted, the decimal representation of OutExpr is written to the file with no preceding blanks. If MinWidth is specified and its value is larger than the length of the decimal string, enough blanks are written before the decimal string to make the field width MinWidth.

Write with one of the real type values:

If OutExpr has one of the real type values, its decimal representation is written to the file. The format of the representation depends on the presence or absence of DecPlaces.

If DecPlaces is omitted (or if it's present but has a negative value), a floating-point decimal string is written. If MinWidth is also omitted, a default MinWidth of 17 is assumed; otherwise, if MinWidth is less than 8, it's assumed to be 8. The format of the floating-point string is

[   | - ] <digit> . <decimals> E [ + | - ] <exponent>

The following table lists the components of the output string.

Component	Meaning
[  | - ]	" " or "-", according to the sign of OutExpr
<digit>	Single digit, "0" only if OutExpr is 0
<decimals>	Digit string of MinWidth-7 (but at most 10) digits
E	Uppercase [E] character
[ + | - ]	According to sign of exponent
<exponent>	Two-digit decimal exponent
If DecPlaces is present, a fixed-point decimal string is written. If DecPlaces is larger than 11, it's assumed to be 11. The format of the fixed-point string follows:

[ <blanks> ] [ - ] <digits> [ . <decimals> ]

The following table lists the components of the fixed-point string.

Component	Meaning
[ <blanks> ]	Blanks to satisfy MinWidth
[ - ]	If OutExpr is negative
<digits>	At least one digit, but no leading zeros
[ . <decimals> ]	Decimals if DecPlaces > 0
Write with one of the string-type values:

If MinWidth is omitted, the string value of OutExpr is written to the file with no leading blanks. If MinWidth is specified, and its value is larger than the length of OutExpr, enough blanks are written before the decimal string to make the field width MinWidth.

Write with a packed string-type value:

If OutExpr is of packed string type, the effect is the same as writing a string whose length is the number of elements in the packed string type.

Write with one of the Boolean type values:

If OutExpr is of type Boolean, the effect is the same as writing the strings True or False, depending on the value of OutExpr.

Note

When using Write the file must be open for output.


Write procedure (for typed files)

See also

Write writes to a typed file.

procedure Write(F, V1,...,Vn);

Description

The Write procedure writes a file to a file component. F is a file variable, and each V is a variable of the same type as the component type of F. For each variable written, the current file position is advanced to the next component. If the current file position is at the end of the file (that is, if Eof(F) is True), the file is expanded.


WriteComponentResFile procedure

See also

Unit

Classes

WriteComponentResFile writes components and their properties to a file using a Windows resource file format.

procedure WriteComponentResFile(const FileName: string; Instance: TComponent);

Description

Use WriteComponentResFile to save the component specified by the Instance parameter to the specified file, storing it in a Windows resource-file format.

To read a component written with WriteComponentResFile, call the ReadComponentResFile function.


WriteIn procedure

See also

Unit

System

Category

Text File Routines

Writeln writes an end-of-line marker to a text file.

procedure Writeln([ var F: Text; ] P1 [, P2, ...,Pn ] );

Description

The Writeln procedure is an extension to the Write procedure, as it is defined for text files.

After executing Write, Writeln writes an end-of-line marker (carriage-return/linefeed) to the file. Writeln(F) with no parameters writes an end-of-line marker to the file. (Writeln with no parameter list corresponds to Writeln(Output).)

The file must be open for output.

Note

When an application is compiled as a console application (using the Generate console application checkbox on the Linker page of the Project|Options dialog, or a -cc command line switch with the command-line compiler), Delphi automatically associates the Input and Output files with the application's console window. For non-console applications, any attempt to read from Input or write to Output will generate an I/O error.

Example

var

   s : string;

 begin

   Write('Enter a line of text: ');

   Readln(s);

   Writeln('You typed: ',s);

   Writeln('Hit <Enter> to exit');

   Readln;

 end;;


Application 変数
Application 変数3425001

ユニット

Forms および HTTPApp

Application 変数には，標準アプリケーション用と Web サーバーアプリケーション用の 2 種類があります。

標準アプリケーション用 Application 変数

Web サーバーアプリケーション用 Application 変数


Application 変数（標準アプリケーション用）
Application 変数（標準アプリケーション用）3425002

参照

ユニット

Forms

Forms ユニットの Application 変数は，プロジェクトのアプリケーションのインスタンスを宣言します。

var Application: TApplication;

説明

デフォルトでは，プロジェクトを新規作成すると Delphi がアプリケーションオブジェクトを作成し，それを Application に割り当てます。Application には実行中のアプリケーションについての情報を得るために使える複数のプロパティがあります。プロパティリストについては TApplication コンポーネントを参照してください。

例

次のコードはプロジェクト名を編集ボックスに表示します。

procedure TForm1.Button1Click(Sender: TObject);

begin

Edit1.Text := Application.Title;

end;


Application 変数（Web サーバーアプリケーション用）
Application 変数（Web サーバーアプリケーション用）3425003

参照

ユニット

HTTPApp

HTTPApp ユニットの Application 変数は，インターネットプロジェクトの Web サーバーアプリケーションのインスタンスを宣言します。

var Application: TWebApplication = nil;

説明

デフォルトでは，インターネットサーバープロジェクトを新規作成すると Delphi がアプリケーションオブジェクトを作成し，それを Application に割り当てます。プロジェクトが CGI または Win-CGI サーバーアプリケーションを表している場合，Application は TCGIApplication オブジェクトに初期化されます。プロジェクトが ISAPI または NSAPI サーバーアプリケーションを表している場合，Application は TISAPIApplication オブジェクトに初期化されます。どちらの種類の TWebApplication オブジェクトが作成されるかは，プロジェクトの使用リストに ISAPIApp ユニットと CGIApp ユニットのどちらが含まれているかによって決まります。

実際には，Application 変数には TISAPIApplication，TCGIApplication，および TApplication の 3 種類があり，それぞれ ISAPIApp ユニット，CGIApp ユニット，Forms ユニットで初期化されます。1 つのプロジェクトには，これらのユニットの 1 つだけを設定してください。プロジェクトの使用リストに複数のユニットを追加してはなりません。プログラムが起動すると，Delphi はプロジェクトのユニットに宣言された Application 変数をインスタンス化し，Initialize メソッド，CreateForm メソッド，そして Run メソッドを呼び出します。アプリケーションの動作は，作成される Application オブジェクトのクラスにおけるこれらのメソッドの実現方法によって決まります。


Automation 変数
Automation 変数3425004

ユニット

OleAuto

Automation 変数は，Delphi 2.0 との下位互換性のために提供されています。

var Automation: TAutomation

説明

OleAuto ユニットの宣言は下位互換性のために提供されています。

注意	現行バージョンの Delphi では，OleAuto ユニットの宣言が新しい OLE と ActiveX の項目に書き換えられています。Automation 変数の機能は次のとおりです。

オートメーションマネージャクラスのグローバルインスタンスです。Delphi で作成された OLE オートメーションサーバー用のオートメーションマネージャとして働きます。

OLE オートメーションオブジェクト（TAutoObject から派生したオブジェクト）を作成する場合，そのオブジェクトを定義するユニットは Automation.RegisterClass を呼び出し，TAutoClassInfo 型のレコードを渡さなければなりません。その後は，オートメーションマネージャが，オートメーションオブジェクトと OLE オートメーション API の間のすべての対話を処理します。


CmdLine 変数
CmdLine 変数3425005

参照

ユニット

System

CmdLine 変数は，アプリケーションの起動時に指定されたコマンドライン変数へのポインタです。

var CmdLine: PChar;

説明

プログラムの場合，CmdLine 変数には，アプリケーションの起動時に指定されたコマンドライン引数を含むヌルで終わる文字列へのポインタが格納されます。ParamStr 関数を使うと，個々の引数にアクセスできます。

ライブラリ（DLL）の場合，CmdLine は nil です。


CmdShow 変数
CmdShow 変数3425006

ユニット

System

CmdShow 変数は，Windows の ShowWindow に渡されます。

var CmdShow: Integer;

説明

プログラムの場合，CmdShow 変数には，アプリケーションがメインウィンドウを生成するときに Windows が ShowWindow に渡すパラメータ値が格納されます。

ライブラリ（DLL）の場合，CmdShow は常にゼロです。


ComClassManager 変数
ComClassManager 変数3425007

参照

ユニット

ComObj

ComClassManager 変数は，TComClassManager クラスのインスタンスです。

var ComClassManager: TComClassManager;

説明

ComClassManager は，com サーバーが所有するクラスファクトリのクラスマネージャのインスタンスを宣言します。デフォルトでは，プロジェクトに ComObj ユニットを 設定すると Delphi がクラスマネージャオブジェクトを作成し，それを ComClassManager に割り当てます。ComClassManager には，クラスファクトリについての情報を操作したり提供したりするときに使える複数のメソッドがあります。メソッドリストについては TComClassManager コンポーネントを参照してください。


ComServ 変数
ComServer 変数3425008

参照

ユニット

ComServ

ComServer 変数は，TComServer クラスのインスタンスです。

var ComServer: TComServer;

説明

ComServ は COM サーバーのインスタンスを宣言します。デフォルトでは，プロジェクトに ComServ ユニットを 設定すると Delphi が COM サーバーオブジェクトを作成し，それを ComServ に割り当てます。ComServ には，サーバーにロードされたオブジェクトについてのクラス情報やレジストリ情報を提供する複数のプロパティとメソッドがあります。プロパティおよびメソッドのリストについては TComServer オブジェクトを参照してください。


通貨および日付/時刻の形式変数
通貨および日付/時刻の形式変数3425009

参照

ユニット

SysUtils

通貨または日付/時刻の文字列を定義するために使われる変数です。

var CurrencyString: string;

var CurrencyFormat: Byte;

var NegCurrFormat: Byte;

var ThousandSeparator: Char;

var DecimalSeparator: Char;

var CurrencyDecimals: Byte;

var DateSeparator: Char;

var ShortDateFormat: string;

var LongDateFormat: string;

var TimeSeparator: Char;

var TimeAMString: string;

var TimePMString: string;

var ShortTimeFormat: string;

var LongTimeFormat: string;

var ShortMonthNames: array[1..12] of string;

var LongMonthNames: array[1..12] of string;

var ShortDayNames: array[1..7] of string;

var LongDayNames: array[1..7] of string;

説明

SysUtils ユニットには，日付と時刻のルーチンが使う多くの変数が含まれています。これらの変数に値を割り当てれば，日付や時刻の形式を変更できます。これらの変数の初期値は Win32 API の GetLocaleInfo 関数を使ってシステムレジストリから取り出されます。Delphi の VCL（非コンソール）アプリケーションは，WM_WININICHANGE メッセージに従って自動的にこれらの形式変数を更新します。Application.UpdateFormatSettings はシステム設定の変更を動的に反映するかどうかを表します。デフォルト値は True です。この値を False に設定するとシステム設定は動的に反映されません。

各変数の記述は，GetLocaleInfo Win32 API を使って初期値を取り出すのに使われる LOCALE_XXXX 定数を指定します。

型付き定数	定義
CurrencyString	浮動小数点数から 10 進数への変換に使う通貨記号。初期値は LOCALE_SCURRENCY からとる
CurrencyFormat	浮動小数点数から 10 進数への変換に使う通貨記号の位置と区切り。次の値がある 0='$1' 1='1$' 2='$1' 3='1$' 初期値は LOCALE_SCURRENCY 変数からとる
NegCurrFormat	負の浮動小数点数から10進数への変換に使う通貨形式。次の値がある 0=($1) 4=(1$) 8=-1$ 12=$-1 1=-$1 5=-1$ 9=-$1 13=1-$ 2=$-1 6=1-$ 10=1$- 14=($1) 3=$1- 7=1$- 11=$1- 15=(1$) 初期値はLOCALE_INEGCURRからとる
ThousandSeparator	整数部分が 3 桁を超える数値の 3 桁区切り文字。初期値は LOCALE_STHOUSAND 変数からとる
DecimalSeparator	数値の整数部分と小数部分の区切り文字。初期値はLOCALE_ICURRDIGITS からとる
CurrencyDecimals	通貨値の小数点以下の桁数。初期値は LOCALE_ICURRDIGITS からとる
DateSeparator	日付値の年，月，日の区切り文字。初期値はLOCALE SDATE からとる
ShortDateFormat	日付値を編集用の短い文字列に変換するために使う形式文字列。日付と時刻の形式文字列についての詳細は FormatDateTime 関数を参照。短い日付形式で使えるのは，日付区切り文字，m, mm, d, dd, yy, yyyy の各形式指定子だけである。初期値は LOCALE_SSHORTDATE からとる
LongDateFormat	日付値を編集用ではなく表示用の長い文字列に変換するために使う形式文字列。日付と時刻の形式文字列についての詳細は FormatDateTime 関数を参照。初期値は LOCALE_SLONGDATE からとる
TimeSeparator	時刻値の時，分，秒の区切り文字。初期値は LOCALE_STIME からとる
TimeAMString	午前 0 時から午前 11 時 59 分までの間の時刻値に使う 12 時間形式のサフィックス文字列。初期値は LOCALE_S1159 からとる
TimePMString	正午から午後 11 時 59 分までの間の時刻値に使う 12 時間形式のサフィックス文字列。初期値は LOCALE_S2359 からとる
ShortTimeFormat	時刻値を時と分だけの短い文字列に変換するために使う形式文字列。デフォルト値は LOCALE_ITIME および LOCALE_ITLZERO から計算される
LongTimeFormat	時刻値を時，分，秒の長い文字列に変換するために使う形式文字列。デフォルト値は LOCALE_ITIME および LOCALE_ITLZERO から計算される
ShortMonthNames	月の省略名を含む文字配列。形式文字列内の mmm 形式指定子を FormatDateTime に渡すと，月の名前が省略名で置換される。デフォルト値は LOCALE_SABBREVMONTHNAME システムロケールエントリからとる
LongMonthNames	月の完全名を含む文字配列。形式文字列内の mmmm 形式指定子を FormatDateTime に渡すと，月の名前が完全名で置換される。デフォルト値は LOCALE_SMONTHNAME システムロケールエントリからとる
ShortDayNames	曜日の省略名を含む文字配列。形式文字列内の ddd 形式指定子を FormatDateTime に渡すと，曜日の名前が省略名で置換される。デフォルト値は LOCALE_SABBREVDAYNAME システムロケールエントリからとる
LongDayNames	曜日の完全名を含む文字配列。形式文字列内の dddd 形式指定子を FormatDateTime に渡すと，完全名で置換される。デフォルト値は LOCALE_SDAYNAME システムロケールエントリからとる
例

この例では，フォームのラベルとボタンを使っています。ボタンをクリックすると，現在の日付がラベルのキャプションに表示されます。日付変数 DateSeparator には新しい値が割り当てられているので，ラベルの日付の形式は変更されます。たとえば，日付が1994年9月15日の場合は，94-09-15 のように表示されます。

procedure TForm1.Button1Click(Sender: TObject);

begin

DateSeparator := '-';

Label1.Caption := DateToStr(Date);

end;


DateDelta 定数
DateDelta 定数3425010

参照

ユニット

SysUtils

DateDelta 変数は，異なる年から始まる 2 つの日付/時刻型の差を計算するときの修正要素です。

const DateDelta = 693594;

説明

DateDelta は 1/1/0001 から 12/31/1899 までの日数です。この定数を使うと，異なる年から始まる日付/時刻型の算術比較を行うことができます。たとえば，TDateTime は 12/31/1899 に始まり，TTimeStamp は 1/1/0001 に始まります。修正はすでに経過した日数に対して行われるので，TDateTime の場合，12/31/1899 は 0 と表されます。


DBIResult 型
DBIResult 型3425011

参照

ユニット

DBITypes

DBIResult 型は，DBIError 手続きで使う BDE エラーコードを指定するのに使います。

DBIResult: Word;

説明

DBIResult は DBIError 手続き用のボーランドデータベースエンジンエラーコードを指定するために使います。


DLLProc 変数
DLLProc 変数3425012

ユニット

System

DLLProc 変数は，DLL エントリポイントによって呼び出される手続きを指すポインタです。

var DLLProc: Pointer;

説明

DLLProc 変数は DLL のエントリポイントが呼び出されるたびに呼び出される手続きを指定するのに使います。DLLProc に割り当てる手続きは Integer 型のパラメータを 1 つとらなければなりません。次に例を示します。

procedure LibraryProc(Reason: Integer);

手続きが呼び出されるときに，次に示す Windows ユニットの定数グループの定義に従って，Reason パラメータは 0 から 3 の値を示します。

const

DLL_PROCESS_DETACH	= 0;

DLL_PROCESS_ATTACH	= 1;

DLL_THREAD_ATTACH	= 2;

DLL_THREAD_DETACH	= 3;

この定数の意味についての詳細は，Win32 API の DllEntryPoint 関数の説明を参照してください。


ErrorAddr 変数
ErrorAddr 変数3425013

参照

ユニット

System

ErrorAddr 変数は，実行時エラーを起こした文のアドレスが格納されます。

var ErrorAddr: Pointer;

説明

プログラムが正常終了した場合，または Halt の呼び出しにより停止した場合は，ErrorAddr は nil です。プログラムが実行時エラーのため終了した場合，ErrorAddr 変数にはエラーが発生した文のアドレスが格納されます。


ErrorProc 変数
ErrorProc 変数3425014

参照

ユニット

System

ErrorProc 変数は，RTL の実行時エラーハンドラを指します。

var ErrorProc: Pointer;

説明

ErrorProc は RTL の実行時エラーハンドラを指す手続き変数です。RTL の標準の ErrorProc は実行時エラーを通知してプログラムを終了します。

ErrorProc 変数は，主に以前の Pascal によって書かれたコードとの互換性を保つ目的で Delphi 2.0/3.0 に残されました。SysUtils がこの変数を使って実行時エラーを例外に変換するので，Delphi アプリケーションは ErrorProc 変数で別の実行時エラー手続きを指定してはなりません。実行時エラーとは異なり，例外は Delphi アプリケーションで処理される場合ができます。

ただし，プログラムで SysUtils を使う場合は，ErrorProc のかわりに強制的に SysUtils 独自のルーチンが使われ，実行時エラーは例外に変換されます。実行時ライブラリエラーが発生したときに，ErrorProc 変数が呼び出されます。ErrorCode パラメータには実行時エラー番号が格納され，ErrorAddr パラメータには実行時エラーを発生させたマシンコードアドレスが格納されます。

例

procedure MyErrorHandler(ErrorCode: Integer; ErrorAddr: Pointer);

ErrorProc := MyErrorHandler

end;


ExceptProc 変数
ExceptProc 変数3425015

ユニット

System

ExceptProc 変数は，RTL の最下位レベルの例外ハンドラを指すポインタです。

var ExceptProc: Pointer;

説明

未処理の例外は ExceptProc によって処理されます。ExitProc にフックするのと同じように ExitProc にフックして，未処理の例外の通知方法を変更することができます。


ExitCode 変数
ExitCode 変数3425016

参照

ユニット

System

ExitCode 変数は，アプリケーションの終了コードが格納されます。これは下位互換性のためです。

var ExitCode: Integer;

説明

終了手続きは，ExitCode を調べることで終了の原因を知ることができます。

ExitCode 変数はアプリケーションの終了コードを保持します。終了手続きは ExitCode を調べることでプログラム終了の原因を知ることができます。プログラムが正常終了した場合，ExitCode はゼロです。プログラムが Halt の呼び出しにより終了した場合，ExitCode には Halt に渡された値が格納されます。プログラムが実行時エラーにより終了した場合，ExitCode にはエラーコードが格納されます。


ExitProc 変数
ExitProc 変数3425017

参照

ユニット

System

ExitProc 変数は，プログラムの終了手続きを指すポインタです。

var ExitProc: Pointer;

説明

ExitProc ポインタ変数を使えば，終了手続きをインストールすることができます。終了手続きは常に，プログラムの終了処理の一部として呼び出されます。

ExitProc 変数は下位互換性のために残されています。代わりに finalization を使用してください。

正しく実現すれば，終了手続きを連鎖させることも可能です。終了時の連鎖手続きは，インストールされた順序とは逆の順に実行されます。

終了の連鎖を保持するためには，ExitProc を終了手続きのアドレスに変更する前に ExitProc の現在の内容を保存しなくてはなりません。

終了手続きの最初の文で，保存されている ExitProc の値を再インストールしなくてはなりません。


ファイルモード定数
ファイルモード定数3425018

参照

ユニット

SysUtils

ファイルモード定数は，ディスクファイルのオープンとクローズに使います。

const fmClosed	 = $D7B0;

const fmInput	 = $D7B1;

const fmOutput	 = $D7B2;

const fmInOut	 = $D7B3;

説明

file mode 定数はディスクファイルのオープンとクローズに使います。TFileRec と TTextRec の Mode フィールドには，上のいずれかの値が設定されます。


ファイルオープンモード定数
ファイルオープンモード定数3425019

ユニット

SysUtils

ファイルオープンモード定数は，ファイルまたはストリームへのアクセスモード制御に使います。

const fmOpenRead	= $0000;

const fmOpenWrite	= $0001;

const fmOpenReadWrite	= $0002;

const fmShareCompat	= $0000;

const fmShareExclusive	= $0010;

const fmShareDenyWrite	= $0020;

const fmShareDenyRead	= $0030;

const fmShareDenyNone	= $0040;

説明

ファイルオープンモード定数は，開くファイルまたはストリームの共有性を制御するために使います。

TFileStream.Create の Mode パラメータには，次のいずれかの定数を設定できます。

定数	定義
fmOpenRead	読み出し専用で開く
fmOpenWrite	書き込み専用で開く
fmOpenReadWrite	読み書き両用で開く
fmShareCompat	共有で利用するとき FCB と互換のモードで開く
fmShareExclusive	ほかからの読み書きを禁止する
fmShareDenyWrite	ほかからの書き込みを禁止する
fmShareDenyRead	ほかからの読み出しを禁止する
fmShareDenyNone	ほかからのすべてのアクセスを許可する


FileMode 変数
FileMode 変数3425020

参照

ユニット

System

FileMode 変数は，型付きファイルや形なしファイルを Reset 手続きで開いたときのアクセスモードを示します。

var FileMode: Byte;

説明

FileMode 変数は，型付きファイルや型なしファイル（テキストファイルは含まれません）を Reset 手続きで開いたときに使うアクセスモードを決めます。

FileMode 変数のデフォルト値は 2 です。2 以外の値を割り当てると，それ以降の Reset 手続きはそのモードを使います。

FileMode の値は次のとおりです。

0	読み出し専用
1	書き込み専用
2	読み書き両用


形式文字列
形式文字列3425021

文字列形式ルーチンに必要な形式を指定します。

説明

文字列形式ルーチンに渡される形式文字列には，プレーンな文字と形式指定子の 2 種類のオブジェクトが含まれます。プレーンな文字はそのまま結果の文字列にコピーされます。形式指定子は引数リストから引数を取り出し，その引数に形式を適用します。

形式指定子の構文を次に示します。

"%" [index ":"] ["-"] [width] ["." prec] type

形式指定子は % 文字で開始し，その後に次の各部を順に指定します。変換型文字 type 以外は省略可能です。

引数インデックス指定子 [index ":"］

左揃えインジケータ ["-"]

幅指定子 [width]

精度指定子 ["." prec]

変換型文字 type

次の表に type に指定できる値を示します。

D	10 進数。引数は整数値でなくてはならない。この値は 10 進数に変換される。形式文字列に精度指定子が含まれる場合，結果の文字列は指定された桁数以上でなくてはならない。指定された桁数より少ないときは，結果の文字列の左側にゼロが埋め込まれる
e	指数。引数は浮動小数点値でなくてはならない。この値は "-d.ddd...E+ddd" 形式の文字列に変換される。値が負ならば先頭に負符号が付き，小数点の左側に必ず 1 桁表示される結果の文字列の合計桁数は形式文字列の精度指定子によって示される。
	合計桁数（小数点の左側の桁も含まれる）は，形式文字列の精度指定子によって与えられる。精度指定子を指定しない場合，デフォルトの精度は 15 桁である。結果の文字列の指数文字 E の右側には，正符号または負符号と 3 桁以上の数が表示される
f	固定小数点。引数は浮動小数点値でなくてはならない。この値は "-ddd.ddd..." 形式の文字列に変換される。値が負のときは，結果の文字列の先頭に負符号が付く。 小数点の右側の桁数は形式文字列の精度指定子によって示される。精度指定子を指定しない場合，デフォルトの精度は 2 桁である
g	汎用表現。引数は浮動小数点値でなくてはならない。この値は固定小数点表現または指数表現を使って，できるだけ短い 10 進数に変換される。結果の文字列の有効桁数は形式文字列の精度指定子によって示される。精度指定子を指定しない場合，デフォルトの精度は 15 桁である。 結果の文字列の末尾部分のゼロは削除され，必要な場合だけ小数点が表示される。小数点の左側の桁数が指定された桁数以下で値が 0.00001 以上の場合，結果の文字列では固定小数点表現が使われる。それ以外の場合は指数表現が使われる
n	数値表現。引数は浮動小数点値でなくてはならない。この値は "-d, ddd, ddd.ddd" 形式の文字列に変換される。結果の文字列に 3 桁ごとの区切り文字が含まれない場合，"n" 形式は "f" 形式に対応する
m	金額。引数は浮動小数点値でなくてはならない。この値は通貨量を表す値に変換される。この変換は，CurrencyString, CurrencyFormat, NegCurrFormat, ThousandSeparator, DecimalSeparetor, CurrencyDecimals の各グローバル変数によって制御され，そのすべては Windows のコントロールパネルの［各国対応］にある［通貨の形式］で初期化する。形式文字列に精度指定子が含まれる場合，グローバル変数 CurrencyDecimal で与えられた値を精度指定子がオーバーライドする
p	ポインタ。引数はポインタ値でなくてはならない。この値は "XXXX:YYYY" 形式の文字列に変換される。XXXX および YYYY は，4 桁の 16 進数で表されたポインタのそれぞれセグメント部分とオフセット部分である
s	文字列表現。引数は文字，文字列，PChar のいずれかの値でなくてはならない。形式指定子のかわりに文字列または文字が挿入される。形式文字列に精度指定子が含まれる場合，精度指定子は結果の文字列の最大長を指定する。引数の文字列がこの最大長より長い場合，はみ出す文字列が切り捨てられる
x	16 進数。引数は整数値でなくてはならない。この値は 16 進数の文字列に変換される。形式文字列に精度指定子が含まれる場合，結果の文字列は指定された桁数以上でなくてはならない。指定された桁数より少ない場合，結果の文字列の左側にはゼロがパディングされる
変換文字には大文字も小文字も使えますが，結果は同じです。

すべての浮動小数点形式で使われる小数点または 3 桁ごとの区切り文字は，グローバル変数 DecimalSeparator および ThousandSeparator から取得されます。

インデックス指定子，幅指定子，精度指定子は "%10d" のように 10 進数の文字列で直接指定することも，"%*.*f" のようにアスタリスクで間接的に指定することもできます。アスタリスクを使う場合，引数リスト内の次の引数（整数値）が実際に使われる値です。例を次に示します。

Format('%*.*f', [8, 2, 123.456])

これは次の形式指定子と同じです。

Format('%8.2f', [123.456]).

幅指定子は変換時の最小フィールド幅を設定します。結果の値が最小フィールド幅より小さい場合でも，指定されたフィールド幅が確保されます。デフォルトでは，そのフィールドに値が右寄せで表示されます。形式指定子に左揃えインジケータ（幅指定子の先頭の "-"）が指定されている場合は，そのフィールドに値が左寄せで表示されます。

インデックス指定子は，現在の引数リストインデックスを指定の値に設定します。引数リストの最初の引数のインデックスは 0 です。インデックス指定子を使うと，同じ引数を繰り返して指定できます。たとえば，"Format('%d %d %0:d %d，[10, 20])" のように指定すると，'10 20 10 20' という文字列が生成されます。

形式文字列は次のルーチンで使います。

Format 関数

FormatBuf 関数

FmtStr 手続き

StrFmt 関数

StrLFmt 関数


HMetafile 型
HMetafile 型3425022

参照

ユニット

Graphics

HMetafile 型は，TMetafile オブジェクトへのハンドルです。

type HMETAFILE = THandle;

説明

HMetafile は TMetafile オブジェクトのハンドルです。


HInstance 変数
HInstance 変数3425023

ユニット

System

HInstance 変数は，Windows によってアプリケーションまたはライブラリに提供されるハンドルです。

var HInstance: Longint;

説明

HInstance 変数は Windows 環境が提供する，アプリケーションまたはライブラリのインスタンスハンドルを保持します。


InOutRes 変数
InOutRes 変数3425024

ユニット

System

InOutRes 変数は，組み込み入出力ルーチンが IOResult から戻された値を格納するのに使います。

var InOutRes: Integer;

説明

組み込み入出力ルーチンは InOutRes 変数を使って，IOResult 標準関数の次の呼び出しで返される値を格納します。


Input 変数
Input 変数3425025

参照

ユニット

System

Input 変数は，オペレーティングシステムの標準入力デバイスに関連付けられた読み出し専用ファイルです。

var Input: Text;

説明

Input 変数は，オペレーティングシステムの標準入力デバイス（通常はキーボード）に関連付けられた読み出し専用ファイルです。

Delphi の多くの標準ファイル処理ルーチンでは，ファイル変数パラメータを省略できます。その場合，これらのルーチンは Input または Output ファイル変数で動作します。次の標準ファイル処理ルーチンは，ファイルパラメータが指定されていないと Input ファイルで動作します。

Eof

Eoln

Read

Readln

SeekEof

SeekEoln

［プロジェクト(P)｜オプション(O)］で表示されるダイアログボックスの［リンカ］ページで［コンソールアプリケーションの作成(C)］チェックボックスを使用することにより，またはコマンドラインコンパイラで -cc スイッチを指定することにより，アプリケーションがコンソールアプリケーションとしてコンパイルされると，Delphi は自動的に Input および Output ファイルをアプリケーションのコンソールウィンドウに関連付けます。非コンソールアプリケーションでは，Input から読み出そうとしたり Output に書き込んだりしようとすると入出力エラーになります。


IsConsole 変数
IsConsole 変数3425026

参照

ユニット

System

IsConsole 変数は，論理値です。モジュールがコンソールアプリケーションとしてコンパイルされた場合にTrue になります。

var IsConsole: Boolean;

説明

IsConsole 変数はモジュールがコンソールアプリケーションとしてコンパイルされた場合に True になります。IsConsole は EXE と DLL のどちらでもTrue になります。


IsLibrary 変数
IsLibrary 変数3425027

参照

ユニット

System

IsLibrary 変数は，論理値です。モジュールが DLL のときに True になります。

var IsLibrary: Boolean;

説明

IsLibrary 変数はモジュールが DLL の場合に True になります。


IsMultiThread 変数
IsMultiThread 変数3425028

参照

ユニット

System

IsMultiThread 変数は，論理値です。BeginThread によって True に設定されます。

var IsMultiThread: Boolean;

説明

IsMultiThread が BeginThread によって True に設定されると，複数のスレッドを持つ Delphi アプリケーションをメモリマネージャが安全に実行できるようになります。1 番目のスレッドがメモリマネージャから出るまでは，2 番目のスレッドがメモリ割り当てを試みたとしてもブロックされます。


LeadBytes 変数
LeadBytes 変数3425029

参照

ユニット

SysUtils

LeadBytes 変数は，2 バイト文字の第 1 バイトの Char 値の集合です。

var	LeadBytes: set of Char = [];

説明

LeadBytes を使うと，Char 値が 2 バイト文字の第 1 バイトを表すことができるかどうかを確認できます。ただし，Char が LeadBytes の集合に含まれている場合，その文字は必ずしも 2 バイト文字の最初のバイトに使われるとは限らず，2 番目のバイトになることもあります。文字が最初のバイトとして使われているかどうかを判断するには，グローバル関数 ByteType または StrByteType を使います。

注意

ロケールで 2 バイト文字システム（DBCS）を使わないシステムで操作する場合，LeadBytes は常に空です。


LongRec 型
LongRec 型3425030

参照!Alink(Hi_function;Lo_function, 1)

ユニット

SysUtils

LongRec 型は，指定された変数の上位ワードと下位ワードを Word 型として格納します。

type LongRec = packed record

Lo, Hi: Word;

end;

説明

指定された Longint 型変数の上位ワードと下位ワードを Word 型として格納するユーティリティレコードを宣言します。

LongRec は 4 バイトのデータ型（ポインタや整数など）を型キャストしてその上位ワードまたは下位ワードを個別にアクセスするときに便利です。


MSecsPerDay 定数
MSecsPerDay 定数3425031

参照

ユニット

SysUtils

MSecsPerDay 定数は，1 日をミリ秒で表します。

const

SecsPerDay = 24 * 60 * 60;

MSecsPerDay = SecsPerDay * 1000;

説明

MSecsPerDay 変数は，1 日当たりのミリ秒数を宣言します。


Null 定数
Null 定数3425032

参照

ユニット

System

Null 定数は，バリアントが値なしで初期化されていることを示します。

const Null: Variant;

説明

Null 定数はバリアントが値を持たないが初期化されている（したがって Unassigned ではない）ことを示すのに使います。Null は消失したデータや未定義のデータを示すためにデータベースアプリケーションで使います。

Null の値は式全体に伝わります。Variant の値を含む式で Null を使うと，その式全体の結果が Null になります。

Variant 変数を Null に設定するには，Null 定数をその変数に代入します。Variant の値が Null かどうかをテストするには，その値を Null 定数と比較するか，標準関数 VarIsNull を使います。Null のバリアントに標準関数 VarType を使うと，varNull が返されます。

Variant 以外の型の変数に Null を代入すると，EVariantError 例外が生成されます。同様に，Null のバリアントをほかの型に変換しようとすると（VarAsType や VarCast を使った場合），EVariantError 例外が生成されます。


NullStr 定数
NullStr 定数3425033

ユニット

SysUtils

NullStr 定数は，EmptyStr へのポインタを宣言します。

const NullStr: PString = @EmptyStr;

説明

NullStr 変数は，文字列が空の場合に多くの文字列操作ルーチンが使う戻り値です。


Output 変数
Output 変数3425034

参照

ユニット

System

Output 変数は，標準出力（通常はディスプレイ）と関連付けられた書き込み専用ファイルです。

var Output: Text;

説明

Output 変数は，オペレーティングシステムの標準出力ファイル（通常はディスプレイ）に関連付けられた書き込み専用ファイルです。

Delphi の多くの標準ファイル処理ルーチンでは，ファイル変数パラメータを省略できます。その場合，これらのルーチンは Input または Output ファイル変数で動作します。次の標準ファイル処理ルーチンは，ファイルパラメータが指定されていないと Output ファイルで動作します。

Write

Writeln

［プロジェクト(P)｜オプション(O)］で表示されるダイアログボックスの［リンカ］ページで［コンソールアプリケーションの作成(C)］チェックボックスを使用することにより，またはコマンドラインコンパイラで -cc スイッチを指定することにより，コンソールアプリケーションとしてアプリケーションがコンパイルされると，Delphi は自動的に Input および Output ファイルをアプリケーションのコンソールウィンドウに関連付けます。非コンソールアプリケーションでは，Input から読み出そうとしたり Output に書き込んだりしようとすると入出力エラーになります。


RandSeed 変数
RandSeed 変数3425035

参照

ユニット

System

RandSeed 変数は，組み込みの乱数生成ルーチンのシードを（元データ）格納します。

var RandSeed: LongInt;

説明

RandSeed に特定の値を代入することによって Random 関数が特定の乱数系列をくり返し作成するように設定できます。これはデータの統計，シミュレーションを扱うアプリケーションでは便利な機能です。暗号化を扱うアプリケーションについては Random 関数の注意事項を参照してください。


Screen 変数
Screen 変数3425036

参照

ユニット

Forms

Screen 変数は，TScreen コンポーネントです。通常は画面デバイスを表します。

var Screen: TScreen;

説明

Screen 変数は TScreen コンポーネントであり，通常は画面デバイスを表します。デフォルトでは，アプリケーションは Windows の現在の画面デバイスに関する情報に基づいて画面コンポーネントを作成し，そのコンポーネントを Screen に割り当てます。

例

次のコードは Form1 という名前のフォームを画面の半分の幅に設定します。

Form1.Width := Screen.Width div 2;


SecsPerDay 定数
SecsPerDay 定数3425037

参照

ユニット

SysUtils

SecsPerDay 定数は，1 日を秒で表します。

const SecsPerDay = 24 * 60 * 60;

説明

SecsPerDay 変数は，1 日当たりの秒数を宣言します。


Session 変数
Session 変数3425038

参照

ユニット

DBTables

Session 変数は，アプリケーションで使われるデータベースコンポーネントを管理します。

var Session: TSession;

説明

Session 変数は，アプリケーションで使われるすべてのデータベースコンポーネントの管理に使用されます。Session 変数はアプリケーションの初期化の一部として自動的に作成され，アプリケーションの終了処理の一部として自動的に廃棄されます。Session 変数はアプリケーションの実行中はずっとアクティブでなければならず，廃棄したり再作成したりはできません。


Sessions 変数
Sessions 変数3425039

参照

ユニット

DBTables

Sessions 変数は，TSessionList のメソッドおよびプロパティへのアクセスを提供します。

var

Sessions: TSessionList;

説明

Sessions 変数はセッション操作用の TSessionList のメソッドとプロパティにアクセスするのに使います。Sessions は DB ユニットで自動的に作成と廃棄が行われるので，使う以外の操作は不要です。

一方 Session 変数は，アプリケーションで使われるすべてのデータベースコンポーネントの管理に使用されます。Session 変数はアプリケーションの初期化の一部として自動的に作成され，アプリケーションの終了処理の一部として自動的に廃棄されます。Session 変数はアプリケーションの実行中はずっとアクティブでなければならず，廃棄したり再作成したりはできません。


SocketErrorProc
SocketErrorProc3425040

参照

ユニット

ScktComp

SocketErrorProc は，Windows ソケット接続から受信したエラーメッセージを処理します。

threadvar SocketErrorProc: procedure (ErrorCode: Integer);

説明

SocketErrorProc に値を代入すると，ソケットコンポーネントが例外を生成する前に，Windows ソケット API 呼び出しから返されたエラーメッセージを処理できます。また，SocketErrorProc を設定すると，ソケットコンポーネントは例外を生成しません。

SocketErrorProc はスレッドローカル変数です。この変数は，1 つの実行スレッド内の Windows ソケット API 呼び出しで発生するエラーを処理するだけです。


TActiveXRegType 型
TActiveXRegType 型3425041

参照

ユニット

Classes

TActiveXRegType 型は，どのコンポーネントを ActiveX ウィザードで使えるようにするかを指定するために RegisterNonActiveX 手続きが使います。

type

TActiveXRegType = (axrComponentOnly, axrIncludeDescendants);

説明

TActiveXRegType は RegisterNonActiveX 手続きの AxRegType パラメータの型です。次の表に TActiveXRegType の値の説明を示します。

値	説明
axrComponentOnly	ComponentClasses パラメータで暗黙的に一覧表示されるコンポーネントクラスのみが ActiveX ウィザードに表示されないようにブロックされる
axrIncludeDescendants	ComponentClasses パラメータで一覧表示されるすべてのコンポーネントクラスとその下位クラスが ActiveX ウィザードに表示されないようにブロックされる


TAlign 型
TAlign 型3425042

参照

ユニット

Controls

TAlign 型は，Align プロパティで使える値を定義します。

type TAlign = (alNone, alTop, alBottom, alLeft, alRight, alClient);

説明

TAlign は Align プロパティがとりうる値を定義します。次の表に TAlign の値の説明を示します。

値	説明
alNone	フォーム内の配置場所からコンポーネントを移動しない。これがデフォルト値である
alTop	フォームの最上部にコンポーネントを移動し，フォームの幅いっぱいまでサイズ変更する。コンポーネントの高さは変わらない
alBottom	フォームの最下部にコンポーネントを移動し，フォームの幅いっぱいまでサイズ変更する。コンポーネントの高さは変わらない
alLeft	フォームの左端にコンポーネントを移動し，フォームの高さいっぱいまでサイズ変更する。コンポーネントの幅は変わらない
alRight	フォームの右端にコンポーネントを移動し，フォームの高さいっぱいまでサイズ変更する。コンポーネントの幅は変わらない
alClient	コンポーネントをフォームのクライアント領域いっぱいになるまでサイズ変更する。別のコンポーネントがすでにクライアント領域の一部を占めている場合，残りのクライアント領域いっぱいまでコンポーネントをサイズ変更する


TAlignment 型
TAlignment 型3425043

参照

ユニット

Classes

TAlignment 型は，Alignment プロパティで使う値を定義します。

type TAlignment = (taLeftJustify, taRightJustify, taCenter);

説明

TAlignment は Alignment プロパティの型です。次の表に TAlignment 型の値の説明を示します。

値	説明
taLeftJustify	テキストをコントロールの左端に揃える
taCenter	テキストをコントロールの横方向に中央揃えする
taRightJustify	テキストをコントロールの右端に揃える


TAttachMode 型
TAttachMode 型3425044

ユニット

Outline

TAttachMode 型は，アウトライン項目が新しい位置にどのようにアタッチするかを指定します。

type TAttachMode = (oaAdd, oaAddChild, oaInsert);

説明

TAttachMode は MoveTo メソッドの AttachMode パラメータの型です。TAttachMode は，アウトライン内で移動したアウトライン項目が新しい位置にどのようにアタッチするかを指定します。次の表に TAttachMode の値の説明を示します。

値	説明
oaAdd	Add メソッドを使って追加するのと同様に項目がアタッチされる。移動した項目は Destination パラメータで指定する項目の最後の兄弟項目になる。移動した項目の親は Destination で指定する項目の親と同じになる
oaAddChild	AddChild メソッドを使って追加するのと同様に項目がアタッチされる。移動した項目は Destination パラメータで指定する項目の最後の子になる。Destination で指定する項目が移動した項目の親になる
oaInsert	Insert メソッドを使って挿入するのと同様に項目がアタッチされる。アウトライン内の Destination で指定した項目は移動した項目で更新される。Destination で指定した項目とそれ以降のすべての項目は 1 行ずつ下へ移動する


TBatchMode 型
TBatchMode 型3425045

ユニット

DBTables

TBatchMode 型の値は，TTable の BatchMove メソッドか，TBatchMove コンポーネントの Mode プロパティに渡されます。

type TBatchMode = (batAppend, batUpdate, batAppendUpdate, batDelete, batCopy);

説明

TBatchMode 型は，TTable コンポーネントの BatchMove メソッドまたは TBatchMove コンポーネントの Mode プロパティに渡される値のセットです。batAppend はすべてのレコードを追加します（ターゲットにはソースレコードのキーと同じキーを持つレコードがあってはなりません）。batUpdate はすべてのレコードを新しい値で置換します（ソースのすべてのレコードに対してターゲットに同じキーを持つレコードが必要です）。batAppendUpdate はターゲットにないレコードを追加し，ターゲットにあるレコードは置換します。batDelete はソースにあるレコードをターゲットから削除します（ソースのすべてのレコードに対してターゲットに同じキーを持つレコードが必要です）。batCopy はソーステーブルの正確な複製を作成します。

次の表に TBatchMode の値の説明を示します。

プロパティ	目的
batAppend	ターゲットテーブルにレコードを追加する。ターゲットテーブルは既存のものでなくてはならない。デフォルトのモード
batUpdate	ソーステーブルのレコードでターゲットテーブルの対応するレコードを更新する。ターゲットテーブルは既存のもので，レコードを対応させるためのインデックスが定義されていなくてはならない
batAppendUpdate	ターゲットテーブルに対応するレコードがあればそれを更新する。対応するレコードがない場合，ターゲットテーブルにレコードを追加する。ターゲットテーブルは既存のもので，レコードを対応させるためのインデックスが定義されていなくてはならない
batCopy	ソーステーブルの構造に基づいてターゲットテーブルを作成する。ターゲットテーブルは既存のものであってはならない。既存のものである場合は削除される
batDelete	ターゲットテーブルのレコードでソーステーブルのレコードに対応するものを削除する。ターゲットテーブルは既存のもので，インデックスが定義されていなくてはならない


TBevelShape 型
TBevelShape 型3425046

ユニット

StdCtrls

TBevelShape 型は，TBevel の Shape プロパティで使える値を定義します。

type TBevelShape = (bsBox, bsFrame, bsTopLine, bsBottomLine, bsLeftLine, bsRightLine);

説明

TBevelShape 型は TBevel コンポーネントの Shape プロパティで使える値を定義します。次の表に TBevelShape の値の説明を示します。

値	説明
bsBox	ベベルはボックスの形状を想定する
bsFrame	ベベルは枠の形状を想定する
bsTopLine	ベベルはベベルコントロールの上部の線になる
bsBottomLine	ベベルはベベルコントロールの下部の線になる
bsLeftLine	ベベルはベベルコントロールの左側の線になる
bsRightLine	ベベルはベベルコントロールの右側の線になる


TBevelStyle 型
TBevelStyle 型3425047

ユニット

ExtCtrls

TBevelStyle 型は，TBevel の Style プロパティで使える値を定義します。

type TBevelStyle = (bsLowered, bsRaised);

説明

TBevelStyle 型は TBevel コンポーネントの Style プロパティで使える値を定義します。次の表に TBevelStyle の値の説明を示します。

値	説明
bsLowered	ベベルを低くする
bsRaised	ベベルを高くする


TBevelWidth 型
TBevelWidth 型3425048

ユニット

ExtCtrls

TBevelWidth 型は，TPanel の BevelWidth プロパティで使える値を定義します。

type TBevelWidth: 1..MaxInt;

説明

TBevelWidth 型はパネルコンポーネント（TPanel）の BevelWidth プロパティで使える値を定義します。


TBitBtnKind 型
TBitBtnKind 型3425049

ユニット

Buttons

TBitBtnKind 型は，TBitBtn ビットマップボタンの Kind プロパティで使える値を定義します。

type TBitBtnKind = (bkCustom, bkOK, bkCancel, bkHelp, bkYes, bkNo, bkClose, bkAbort, bkRetry, bkIgnore, bkAll);

説明

TBitBtnKind 型は TBitBtn ビットマップボタンの Kind プロパティがとりうる値を定義します。次の表に TBitBtnKind 型の値の説明を示します。

値	説明
bkCustom	選択するビットマップに Glyph プロパティ値を設定してビットマップボタンに対応するビットマップを指定する。押しボタンと同様に，ボタンの ModalResult を選択することも OnClick イベントに対応するコードを指定することもできる
bkOK	緑色のチェックマークと「OK」という文字列がボタンに表示される。ボタンはデフォルトボタンになる（Default プロパティが自動的に True に設定される）。このボタンを選択すると，ダイアログボックスが閉じる。ビットマップボタンの ModalResult 値は mrOK である
bkCancel	赤い×印と「キャンセル」という文字列がボタンに表示される。ボタンは［キャンセル］ボタンになる（Cancel プロパティが自動的に True に設定される）。このボタンを選択すると，ダイアログボックスが閉じる。ビットマップボタンの ModalResult 値は mrCancel である
bkYes	緑色のチェックマークと「はい(Y)」という文字列がボタンに表示される。ボタンはデフォルトボタンになる（Default プロパティが自動的に True に設定される）。このボタンを選択すると，ダイアログボックスで変更した結果が受け入れられ，ダイアログボックスが閉じる。ビットマップボタンの ModalResult 値は mrYes である
bkNo	赤い否定マークと「いいえ(N)」という文字列がボタンに表示される。ボタンは［キャンセル］ボタンになる（Cancel プロパティが自動的に True に設定される）。このボタンを選択すると，ダイアログボックスで変更した結果がキャンセルされ，ダイアログボックスが閉じる。ビットマップボタンの ModalResult 値は mrNo である
bkHelp	水色の疑問符と「ヘルプ(H)」という文字列がボタンに表示される。このボタンを選択するとアプリケーションのヘルプファイル（アプリケーションの HelpFile プロパティで指定したヘルプファイル）のヘルプ画面が表示される。ボタンの HelpContext プロパティでヘルプファイルのどのヘルプ画面を表示するか指定する
bkClose	終了記号が付いた緑色のドアと「終了(C)」という文字列がボタンに表示される。このボタンを選択するとフォームが閉じる。ボタンの Default プロパティは True である
bkAbort	赤い×印と「中止(A)」という文字列がボタンに表示される
bkRetry	緑色の環状矢印と「再試行(R)」という文字列がボタンに表示される
bkIgnore	緑色の人が歩み去る絵と「無視(I)」という文字列がボタンに表示される。エラーが発生した後に処理を続行する場合に使う
bkAll	緑色の二重チェックマークと「すべて」という文字列がボタンに表示される


TBlobStreamMode 型
TBlobStreamMode 型3425050

ユニット

DBTables

TBlobStreamMode 型は，TBlobStream オブジェクトの Create メソッドに値を渡します。

type TBlobStreamMode = (bmRead, bmWrite, bmReadWrite);

説明

TBlobStreamMode 型は TBlobStream オブジェクトの Create メソッドに渡される値のセットです。既存の TBlobField, TBytesField, TVarBytesField にアクセスするには bmRead を使います。項目の内容をクリアして新しい値を割り当てるには bmWrite を使います。既存の値を変更するには bmReadWrite を使います。


TBlobType 型
TBlobType 型3425051

ユニット

DBTables

TBlobType 型は TBlobField コンポーネントが使う BlobType プロパティを定義します。

type TBlobType = ftBlob..ftTypedBinary;

説明

TBlobType 型は BLOB 項目である TFieldType 型の値のサブセットです。TBlobType は TBlobField コンポーネントの BlobType プロパティの型です。


TBookmark 型
TBookmark 型3425052

参照

ユニット

DB

TBookmark 型は，GetBookmark，GotoBookmark，および FreeBookmark メソッドに渡されるポインタです。

type TBookmark = Pointer;

説明

TBookmark 型はデータセットコンポーネントの GetBookmark, GotoBookmark, FreeBookmark メソッドを呼び出すときに使う Bookmark パラメータの型です。


TBorderIcons 型
TBorderIcons 型3425053

ユニット

Forms

TBorderIcons 型は，フォームのタイトルバーにどのアイコンを表示するかを定義します。

type TBorderIcon = (biSystemMenu, biMinimize, biMaximize, biHelp);
   TBorderIcons = set of TBorderIcon;

説明

TBorderIcons 型はフォームのタイトルバーに表示するアイコンを定義します。TBorderIcons は BorderIcons プロパティの型です。次の表に TBorderIcons 型の値の説明を示します。

値	説明
biSystemMenu	コントロールメニュー（システムメニューともいう）をフォームに表示する
biMinimize	アイコン化ボタンをフォームに表示する
biMaximize	最大表示ボタンをフォームに表示する
biHelp	ヘルプは，Windows のヘルプ（WINHELP.EXE）を起動せずにポップアップウィンドウに表示する。biMinimize と biMaximize が除外された場合，フォームのタイトルバーには疑問符が表示される。そうでない場合は非表示になる


TBorderStyle 型
TBorderStyle 型3425054

ユニット

Forms

TBorderStyle 型は，フォームやウィンドウの BorderStyle プロパティが使います。

type TBorderStyle = bsNone..bsSingle;

説明

フォームやウィンドウの BorderStyle プロパティは，TFormBorderStyle 型を使います。次の表に TBorderStyle 型の値の説明を示します。

値	説明
bsNone	非可視境界
bsSingle	一重境界線


TBorderWidth 型
TBorderWidth 型3425055

ユニット

ExtCtrls

TBorderWidth 型は，TPanel の BorderWidth プロパティで使える値を定義します。

type TBorderWidth: 0..MaxInt;

説明

TBorderWidth 型はパネルコンポーネント（TPanel）の BorderWidth プロパティで使える値を定義します。


TBrushStyle 型
TBrushStyle 型3425056

参照

ユニット

Graphics

TBrushStyle 型は，Style プロパティが TBrush オブジェクトの定義に使います。

type TBrushStyle = (bsSolid, bsClear, bsHorizontal, bsVertical, bsFDiagonal, bsBDiagonal, bsCross, bsDiagCross);

説明

TBrushStyle は Style プロパティで使う型で，TBrush オブジェクトの模様を決めます。


TButtonLayout 型
TButtonLayout 型3425057

ユニット

Buttons

TButtonLayout 型は，TBitBtn や TSpeedButton の Layout プロパティの値を定義します。

type TButtonLayout = (blGlyphLeft, blGlyphRight, blGlyphTop, blGlyphBottom);

説明

TButtonLayout 型はビットマップボタン（TBitBtn）やスピードボタン（TSpeedButton）の Layout プロパティで使える値を定義します。次の表に TButtonLayout の値の説明を示します。

値	説明
blGlyphLeft	ボタンの左端にイメージが表示される
blGlyphRight	ボタンの右端にイメージが表示される
blGlyphTop	ボタンの上部にイメージが表示される
blGlyphBottom	ボタンの下部にイメージが表示される


TButtonSet 型
TButtonSet 型3425058

ユニット

MPlayer および DBCtrls

TButtonSet 型には，メディアプレーヤ用とデータベースナビゲーションコントロール用の 2 種類があります。

メディアプレーヤ用 TButtonSet 型

データベースナビゲーションコントロール用 TButtonSet 型


TButtonSet 型（メディアプレーヤ用）
TButtonSet 型（メディアプレーヤ用）3425059

ユニット

MPlayer

Mplayer ユニットの TButtonSet 型は，メディアプレーヤコンポーネントのボタンのセットです。

type

TMPBtnType = (btPlay, btPause, btStop, btNext, btPrev, btStep, btBack, btRecord, btEject);

TButtonSet = set of TMPBtnType;

説明

TButtonSet 型はメディアプレーヤコンポーネントのボタンのセットです。このセットは ColoredButtons，EnabledButtons，VisibleButtons の各プロパティで使われ，ボタンがどのように表示されるかを決めます。次の表に，各ボタン型で使われるボタン，TButtonSet 型の各値，各ボタンを押したときの動作を示します。

ボタン	値	動作
Play	btPlay	メディアプレーヤを再生する
Pause	btPause	再生または録音を一時停止する。クリックしたときにすでに一時停止していれば再生または録音を再開する
Stop	btStop	再生または録音を停止する
Next	btNext	次のトラック（メディアがトラックを使っていない場合は最後）へスキップする
Prev	btPrev	直前のトラック（メディアがトラックを使っていない場合は最初）へスキップする
Step	btStep	指定するフレーム数だけ進む
Back	btBack	指定するフレーム数だけ戻る
Record	btRecord	録音を開始する
Eject	btEject	メディアを取り出す


TButtonSet 型（データベースナビゲーションコントロール用）
TButtonSet 型（データベースナビゲーションコントロール用）3425060

ユニット

DBCtrls

DBCtrls ユニットの TButtonSet はデータベースナビゲーションコントロール用に提供されています。

type

TNavigateBtn = (nbFirst, nbPrior, nbNext, nbLast, nbInsert, nbDelete, nbEdit, nbPost, nbCancel, nbRefresh);

TButtonSet = set of TNavigateBtn;

説明

TButtonSet 型は，データベースナビゲーションコントロールの VisibleButtons プロパティがとりうる値を定義します。次の表に，データベースナビゲーションコントロール用の TButtonSet 型を使う場合に関連付けられるボタン，型値，実行される動作を示します。

ボタン	値	動作
First	nbFirst	最初のレコードに移動する
Prior	nbPrior	前のレコードに移動する
Next	nbNext	次のレコードに移動する
Last	nbLast	最後のレコードに移動する
Insert	nbInsert	空白レコードを挿入する
Delete	nbDelete	カレントレコードを削除する
Edit	nbEdit	カレントレコードの編集を許可する
Post	nbPost	カレントレコードを通知する
Cancel	nbCancel	現在の編集を取り消す
Refresh	nbRefresh	データセット内のデータを再度取り出す


TButtonStyle 型
TButtonStyle 型3425061

ユニット

Buttons

TButtonStyle 型は，TBitBtn および TSpeedButton の Style プロパティの値です。

type TButtonStyle = (bsAutoDetect, bsWin31, bsNew);

説明

TButtonStyle 型はビットマップボタン（TBitBtn）とスピードボタン（TSpeedButton）の Style プロパティで使える値を定義します。次の表に TButtonStyle 型の値の説明を示します。

値	説明
bsAutoDetect	Windows 3.x を使っている場合，ビットマップボタンは標準的な Windows 3.x の外観になる。それ以降のバージョンの Windows を使っている場合，ビットマップボタンは新しい外観になる
bsWin31	どのバージョンの Windows を実行しているかに関係なく標準の Windows 3.1 の外観になる
bsNew	どのバージョンの Windows を実行しているかに関係なく新しいビットマップボタンの外観になる


TByteArray 型
TByteArray 型3425062

ユニット

SysUtils

TByteArray 型は，型 Byte の汎用配列です。

type PByteArray = ^TByteArray;

      TByteArray = array[0..32767] of Byte;

説明

TByteArray 型は，型キャストに使える型 Byte の汎用配列を宣言します。


TCaption 型
TCaption 型3425063

ユニット

Controls

TCaption 型は，コントロールのキャプションに使う文字列型を定義します。

type TCaption = string;

説明

TCaption 型はコントロールのキャプションに使う文字列型を定義します。TCaption は Caption プロパティと Text プロパティの型です。


TChangeRange 型
TChangeRange 型3425064

ユニット

Outline

TChangeRange 型は，ChangeLevelBy メソッドの有効な値を指定します。

type TChangeRange = -1..1;

説明

TChangeRange は ChangeLevelBy メソッドに渡せる有効値を指定します。-1 はアウトライン項目を 1 つ上のレベルに移動し，1 はアウトライン項目を 1 つ下のレベルに移動します。0 の場合は何も起こりません。


TCheckBoxState 型
TCheckBoxState 型3425065

ユニット

StdCtrls

TCheckBoxState 型は TCheckBox の State プロパティを定義します。

type TCheckBoxState = (cbUnchecked, cbChecked, cbGrayed);

説明

TCheckBoxState 型はチェックボックスの各種状態の型を定義します。TCheckBoxState は TCheckBox チェックボックスコントロールの State プロパティの型です。次の表に TCheckState 型の値の説明を示します。

値	説明
cbUnchecked	チェックボックスにチェックマークがなく，ユーザーがそのオプションを選択しなかったことを示す
cbChecked	チェックボックスの中にチェックマークがあり，ユーザーがそのオプションを選択したことを示す
cbGrayed	チェックボックスは淡色表示され，チェックマークがあるともないともいえない第 3 の状態を示す。この状態のチェックボックスの意味はアプリケーションが決める


TColor 型
TColor 型3425066

ユニット

Graphics

TColor 型は，オブジェクトの色の指定に使います。

type TColor = -(COLOR_ENDCOLORS + 1)..$02FFFFFF;

説明

TColor 型はオブジェクトの色の指定に使います。TColor は多くのコンポーネントの Color プロパティとタブセット（TTabSet）の BackgroundColor で使われます。

TColor で使える定数は Graphics ユニットに定義されます。これらの定数は，システムパレットで最も近い色（たとえば clBlue は青）または Windows のコントロールパネルの Color セクションで定義されているシステム画面要素カラー（たとえば，clBtnFace はボタンの表面のシステムカラー）にマップします。

最も近いシステムカラーにマップする定数は，clAqua，clBlack，clBlue，clDkGray，clFuchsia，clGray，clGreen，clLime，clLtGray，clMaroon，clNavy，clOlive，clPurple，clRed，clSilver，clTeal，clWhite，clYellow です。

システム画面要素カラーにマップする定数は，clActiveBorder，clActiveCaption，clAppWorkSpace，clBackground，clBtnFace，clBtnHighlight，clBtnShadow，clBtnText，clCaptionText，clGrayText，clHighlight，clHighlightText，clInactiveBorder，clInactiveCaption，clInactiveCaptionText，clMenu，clMenuText，clScrollBar，clWindow，clWindowFrame，clWindowText です。

TColor を Graphics ユニットに定義された定数で指定せずに，4 バイトの 16 進数で指定した場合，下位の 3 バイトはそれぞれ青，緑，赤の RGB カラーの輝度を表します。$00FF0000 という値は最高の輝度，つまり純粋の青を示し，$0000FF00 は純粋の緑を示し，$000000FF は純粋の赤を示します。$00000000 は黒，$00FFFFFF は白です。

最上位のバイトが 0（$00）ならば，システムパレットで最も近い色になります。最上位のバイトが 1（$01）の場合は，現在のパレットで最も近い色になります。最上位のバイトが 2（$02）の場合は，現在のデバイスコンテキストの論理パレットで最も近い色になります。


TColorDialogOptions 型
TColorDialogOptions 型3425067

ユニット

Dialogs

TColorDialogOptions 型は，TColorDialog コンポーネントの Options プロパティで使われるオプションを宣言します。

type TColorDialogOption = (cdFullOpen, cdPreventFullOpen, cdShowHelp,
   cdSolidColor, cdAnyColor);

      TColorDialogOptions = set of TColorDialogOption;

説明

TColorDialogOptions 型は，中に列挙されている 3 つのオプションを，TColorDialog コンポーネントの Options プロパティで使うセットのメンバーとして宣言します。次の表に TColorDialogOptions 型の値の説明を示します。

値	説明
cdFullOpen	［色の設定］ダイアログボックスが開いたときにカスタムカラーオプションを表示する
cdPreventFullOpen	ユーザーが独自にカスタムカラーを作成できないよう［色の設定］ダイアログボックスの［色の作成(D)］ボタンを使用不可にする
cdShowHelp	［色の設定］ダイアログボックスに［ヘルプ(H)］ボタンを追加する
cdSolidColor	ダイアログボックスでべたの色だけを表示するよう指示する
cdAnyColor	ダイアログボックスであらゆる色を表示するよう指示する


TColumnButtonStyle 型
TColumnButtonStyle 型3425068

ユニット

DBGrids

TColumnButtonStyle 型は TColumn の ButtonStyle プロパティがとりうる値を定義します。

type

TColumnButtonStyle = (cbsAuto, cbsEllipsis, cbsNone);

説明

TColumnButtonStyle 型は TColumn の ButtonStyle プロパティに指定できる値を定義します。TColumnButtonStyle はユーザーが列の値を選択するための方法を示します。次の表に TColumnButtonStyle 型の値の説明を示します。

値	説明
cbsAuto	列の項目が参照項目であるか，列の項目に選択リストが割り当てられていれば，TDBGrid が列にコンボボックスを表示するため，ユーザーはドロップダウンリストで値を選択できる
cbsEllipsis	値を選択するためにユーザーがクリックできる省略記号のボタンが列に必ず表示される。省略記号のボタンをクリックすると，OnEdtiButtonClick イベントが発生する
cbsNone	列の項目が参照項目であっても，列の項目に選択リストが割り当てられていても，ユーザーがリストで値を選択するためのコンボボックスや省略記号のボタンは表示されない


TColumnValues 型
TColumnValues 型3425069

ユニット

DBGrids

TColumnValues 型は TColumn の AssignedValues プロパティに指定できる値を定義します。

type

TColumnValue = (cvColor, cvWidth, cvFont, cvAlignment, cvReadOnly, cvTitleColor, cvTitleCaption, cvTitleAlignment, cvTitleFont);

TColumnValues = set of TColumnValue;

説明

TColumnValues は列とそのタイトル（TColumnTitle オブジェクト）に設定できる属性を示します。次の表に TColumnValues 型の値の説明を示します。

値	説明
cvColor	この値が AssignedValues にあれば，列の Color プロパティがデフォルト値から変更されている
cvWidth	この値が AssignedValues にあれば，列の Width プロパティがデフォルト値から変更されている
cvFont	この値が AssignedValues にあれば，列の Font プロパティがデフォルト値から変更されている
cvAlignment	この値が AssignedValues にあれば，列の Alignment プロパティがデフォルト値から変更されている
cvReadOnly	この値が AssignedValues にあれば，列の ReadOnly プロパティがデフォルト値から変更されている
cvTitleColor	この値が AssignedValues にあれば，列のタイトルの Color プロパティがデフォルト値から変更されている
cvTitleCaption	この値が AssignedValues にあれば，列のタイトルの Caption プロパティがデフォルト値から変更されている
cvTitleAlignment	この値が AssignedValues にあれば，列のタイトルの Alignment プロパティがデフォルト値から変更されている
cvTitleFont	この値が AssignedValues にあれば，列のタイトルの Font プロパティがデフォルト値から変更されている


TComboBoxStyle 型
TComboBoxStyle 型3425070

ユニット

StdCtrls

TComboBoxStyle 型はコンボボックスのスタイルを定義します。

type TComboBoxStyle = (csDropDown, csSimple, csDropDownList, csOwnerDrawFixed, csOwnerDrawVariable);

説明

TComboBoxStyle はコンボボックスコントロールの Style プロパティの型です。次の表に TComboBoxStyle 型の値の説明を示します。

値	説明
csDropDown	ユーザーがテキストを入力できる編集ボックスがあるドロップダウンリストを作成する。すべての項目は文字列であり，どの項目も同じ高さになる。データベースコンボボックスではカレントレコードの項目内容がコンボボックスに表示される。ユーザーはドロップダウンリストから別の項目を選択し，項目値を変更したり編集ボックスに新しい値を入力したりできる
csSimple	リストがない編集ボックスを作成する。データベースコンボボックスではリンクされた項目の現在の内容がコンボボックス内に表示される。ユーザーは新しい値を入力すれば項目の内容を変更できる
csDropDownList	編集ボックスがアタッチされていない，つまりユーザーが項目を編集したり新しい項目を入力したりできないドロップダウンリストを作成する。すべての項目は文字列であり，どの項目も同じ高さになる。データベースコンボボックスでは項目の現在の内容がドロップダウンリスト内で指定した Items の 1 つに一致する場合以外，編集ボックスは空白になる。ユーザーはドロップダウンリストから 1 つの文字列を選択することによってのみ，項目の内容を変更できる
csOwnerDrawFixed	コンボボックス内の項目はどれも ItemHeight プロパティで指定した高さになる。データベースコンボボックスでは項目の現在の内容がドロップダウンリスト内で指定した Items の 1 つに一致する場合以外，コンボボックスは空白になる。ユーザーはドロップダウンリストから 1 つの文字列を選択することによってのみ，項目の内容を変更できる
csOwnerDrawVariable	コンボボックス内の項目は可変の高さにできる。データベースコンボボックスでは項目の現在の内容がドロップダウンリスト内で指定した Items の 1 つに一致する場合以外，コンボボックスは空白になる。ユーザーはドロップダウンリストから 1 つの文字列を選択することによってのみ，項目の内容を変更できる


TComponentName 型
TComponentName 型3425071

ユニット

Classes

TComponentName 型は，すべてのコンポーネントの Name プロパティの型です。

type TComponentName: string;

説明

TComponentName 型はすべてのコンポーネントの Name プロパティの型です。


TConfigMode 型
TConfigMode 型3425072

ユニット

DB

TConfigMode 型は TSession および TDatabase の ConfigMode プロパティに指定できる値を定義します。

type TConfigMode = (cmPersistent, cmSession, cmAll);

説明

TConfigMode 型は TSession コンポーネントの ConfigMode プロパティに指定できる値を定義します。次の表に TConfigMode 型の値の説明を示します。

値	説明
cmPersistent	追加するエリアスはグローバルエリアスである（SaveConfigFile を呼び出すと永続的なエリアスになる）。GetAliasNames はグローバルエリアスだけを返す
cmSession	追加するエリアスはローカルエリアスであり保存できない（セッションが終了するとローカルエリアスは失われる）。GetAliasNames はローカルエリアスだけを返す
cmAll	追加するエリアスはグローバルエリアスである（SaveConfigFile を呼び出すと永続的なエリアスになる）。GetAliasNames はグローバルエリアスとローカルエリアスの両方を返す


TConsistentAttributes 型
TConsistentAttributes 型3425073

ユニット

ComCtrls

TConsistentAttributes 型は，TTextAttributes オブジェクトの ConsistentAttirbutes プロパティがとりうる値を定義します。

type TConsistentAttribute = (caBold, caColor, caFace, caItalic, caSize,
   caStrikeout, caUnderline, caProtected);
   TConsistentAttributes = set of TConsistentAttribute;

説明

TConsistentAttributes 型は TTextAttributes オブジェクトの ConsistentAttributes プロパティに指定できる値を定義します。TConsistentAttributes は書式付きテキストコントロールのデフォルトテキストと選択テキストに対する文字書式情報を示します。TTextAttributes は TRichEdit コンポーネントの DefAttributes プロパティと SelAttributes プロパティの型です。

次の表に TConsistentAttributes 型の値の説明を示します。

値	説明
caBold	選択した範囲内で文字が太字かそうでないかのどちらかに統一されている
caColor	選択した範囲内で文字フォントの色が統一されていることを示す
caFace	選択した範囲内で文字のフォントが統一されていることを示す
caItalic	選択した範囲内で文字が斜体かそうでないかのどちらかに統一されている
caSize	選択した範囲内で文字のフォントサイズが統一されていることを示す
caStrikeout	選択した範囲内で文字が打ち消し線付きかそうでないかのどちらかに統一されている
caUnderline	選択した範囲内で文字が下線付きかそうでないかのどちらかに統一されている
caProtected	テキストが保護されているかそうでないかのどちらかに統一されている。テキストが保護されているとは読み出し専用テキストであることを意味する


TConversionClass 型
TConversionClass 型3425074

参照

ユニット

ComCtrls

TConversionClass 型は，TConversion へのクラス参照です。

type

TConversionClass = class of TConversion;

説明

TRichEdit の RegisterConversionFormat メソッドと DefaultConverter プロパティで使われます。


TCopyMode 型
TCopyMode 型3425075

ユニット

Graphics

TCopyMode 型は，TCanvas オブジェクトの CopyMode プロパティの型です。

type TCopyMode = Longint;

説明

TCopyMode は TCanvas オブジェクトの CopyMode プロパティの型です。


TCreateInfo 型
TCreateInfo 型3425076

参照

ユニット

OleCtnrs

TCreateInfo 型は，TOleContainer の CreateObjectFromInfo メソッドが使うレコードです。

type

TCreateInfo = record

CreateType: TCreateType;

ShowAsIcon: Boolean;

IconMetaPict: HGlobal;

ClassID: TCLSID;

FileName:WideStrng;

DataObject: IDataObject;

end;

説明

TCreateInfo 型は，TOleContainer の CreateObjectFromInfo メソッドで使われるレコードです。TCreateInfo のフィールドについては次の表で説明します。

フィールド	説明
CreateType	オブジェクトの読み取り元を指定する TCreateType 値。詳細については TCreateType を参照
ShowAsIcon	オブジェクトがアイコンとして示されるか（True），サーバーアプリケーションで動いているように表示されるか（False）を示す
IconMetaPict	OLE オブジェクトのデフォルトアイコンのかわりに表示するメタファイル画像（TMetaFilePict）へのグローバルメモリハンドル指定する。IconMetaPict は任意指定であり，0 に設定した場合，そのオブジェクトのデフォルトアイコンが使われる（ShowAsIcon が True の場合）
ClassID	作成したい OLE オブジェクトのクラス識別子。ClassID が使われるのは，CreateType が ctNewObject の場合だけである。ProgIDToClassID 関数を使って，OLE オブジェクトのクラス名のクラス識別子（またはプログラマティック識別子）を取得できる
FileName	OLE オブジェクトとしてリンクまたは埋め込まれるファイルの名前。FileName が使われるのは，CreateType が ctFromFile または ctLinkToFile の場合だけである
DataObject	OLE データ転送オブジェクト。DataObject が使われるのは，CreateType が ctFromData または ctLinkFromData の場合だけである


TCreateType 型
TCreateType 型3425077

参照

ユニット

OleCtnrs

TCreateType 型は，列挙型。TCreateInfo の CreateType フィールドの値を定義します。.

type	 TCreateType = (ctNewObject, ctFromFile, ctLinkToFile, ctFromData, ctLinkFromData);

説明

列挙型 TCreateType は，次の表で定義されているように，TCreateInfo の CreateType フィールドで可能な値を定義します（TOleContainer の CreateObjectFromInfo メソッドの場合）。

値	説明
ctNewObject	クラス識別子で指定された埋め込み OLE オブジェクトを作成する（TCreateInfo.ClassID）
ctFromFile	指定されたファイルの内容から埋め込み OLE オブジェクトを作成する（TCreateInfo.FileName）
ctLinkToFile	指定されたファイルの内容からリンク OLE オブジェクトを作成する（TCreateInfo.FileName）
ctFromData	指定されたデータ転送オブジェクトから埋め込み OLE オブジェクトを作成する（TCreateInfo.DataObject）
ctLinkFromData	指定されたデータ転送オブジェクトからリンク OLE オブジェクトを作成する（TCreateInfo.DataObject）


TCursor 型
TCursor 型3425078

ユニット

Controls

TCursor 型は，コンポーネント用の各種の標準的なカーソルを定義します。

type TCursor = -32768..32767;

説明

TCursor 型はコンポーネントで使える各種の標準的なカーソルを定義します。TCursor は Cursor プロパティと DragCursor プロパティの型です。


TCustomColors 型
TCustomColors 型3425079

ユニット

Dialogs

TCustomColors 型は，ユーザーが作成する色の値を定義する配列です。

type TCustomColors = array[0..MaxCustomColors - 1] of LongInt;

説明

TCustomColors 型は，ユーザーが［色の設定］ダイアログボックス（TColorDialog コンポーネント）を使って作成できる色の値を入れる配列です。MaxCustomColors 定数は 16 と定義されています。


TDataAction 型
TDataAction 型3425080

ユニット

DB

TDataAction 型は，OnDeleteError，OnEditError，およびOnPostError の各イベントの Action パラメータの値を定義します。

type TDataAction = (daFail, daAbort, daRetry);

説明

TDataAction 型は OnDeleteError, OnEditError, OnPostError の各イベントの Action パラメータに割り当てることができる値を定義します。次の表に TDataAction 型の値の説明を示します。

値	説明
daFail	（Action のデフォルト値）エラーは通常の場合と同様に例外として通知される
daAbort	サイレント例外 EAbort が生成されてエラーは廃棄される
daRetry	アプリケーションはループに入り，削除，編集，登録の処理が成功するまで，または Action に daFail か daAbort が割り当てられるまでその処理を繰り返す


TDataMode 型
TDataMode 型3425081

ユニット

DDEMan

TDataMode 型は，DDE 接続の有効な接続モードの型を定義します。

type TDataMode = (ddeAutomatic, ddeManual);

説明

TDataMode 型は DDE 対話を開始するときに使う接続モードの種類を定義します。接続モードは ConnectMode プロパティで指定します。次の表に TDataMode 型の値の説明を示します。

値	説明
ddeAutomatic	TDDEClient コンポーネントを持つフォームを作成すると，実行時にリンクが自動的に確立される。これはデフォルト値である
ddeManual	OpenLink メソッドを呼び出したときだけリンクが確立される


TDataSetNotifyEvent 型
TDataSetNotifyEvent 型3425082

ユニット

DB

TDataSetNotifyEvent 型は，イベントが発生したことをデータセットコンポーネントに知らせるメソッドを指すポインタです。

type TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

説明

TDataSetNotifyEvent 型はデータセットコンポーネントにイベントが発生したことを通知するメソッドを指します。この型はテーブル，問い合わせ，ストアドプロシージャ（TTable, TQuery, TStoredProc の各コンポーネント）のすべてのイベントで使われます。


TDataSetState 型
TDataSetState 型3425083

ユニット

DB

TDataSetState 型は，データセットコンポーネントの State プロパティの値です。

type TDataSetState = (dsInactive, dsBrowse, dsEdit, dsInsert, dsSetKey, dsCalcFields, dsUpdateNew, dsUpdateOld, dsFilter);

説明

TDataSetState型は次の表のように定義されたデータセットコンポーネントの State プロパティの値のセットです。

値	説明
dsInactive	データセットは開いていない
dsBrowse	レコード間を移動中
dsEdit	レコードを編集中
dsInsert	新しいレコードの挿入または追加中
dsSetKey	レコードの検索または範囲の設定のために項目を操作してキー値を設定中
dsCalcFields	計算項目の値を計算中
dsUpdateNew	内部状態。項目の NewValue プロパティにアクセス中に使用される
dsUpdateOld	内部状態。項目の OldValue プロパティにアクセス中に使用される
dsFilter	データセットで OnFilterRecord イベントを処理中


TDateTime 型
TDateTime 型3425084

参照

ユニット

System

TDateTime 型は，日付時刻ルーチンが日付と時刻の値を保持するために使う型です。

type TDateTime = type Double;

説明

Delphi は TDateTime 型の日付値と時刻値を格納します。TDateTime 値の整数部は西暦 1899 年 12 月 30 日からの経過日数を示します。TDateTime の小数部はその日の時間を示します。

次の表に TDateTime 値の例とそれに対応する日付と時間を示します。

0	1899 年 12 月 30 日 午前 12:00

2.75	1900 年 1 月 1 日 午後 6:00

-1.25	1899 年 12 月 29 日 午前 6:00

35065	1996 年 1 月 1 日 午前 12:00

2 つの日付の間の日数を表す小数部を計算するには，2 つの値を減算します。同様に，小数部の日数分だけ日付時刻値をインクリメントするには，小数部の数値をを日付時刻値に加算します。

注意	Delphi 1.0 では日付を 1899 からではなく 1 から計算していました。Delphi 1.0 の日付を Delphi 2.0/3.0 の日付に変換するには，Delphi 1.0 の日付から 693594.0 を減算してください。この変更は OLE オートメーションと互換性を確保するためです。


TDBCtrlGridBorder 型
TDBCtrlGridBorder 型3425085

ユニット

DBCtrls

TDBCtrlGridBorder 型は，TDBCtrlGrid コンポーネントの PanelBorder プロパティがとりうる値を定義します。

type TDBCtrlGridBorder = (gbNone, gbRaised);

説明

TDBCtrlGridBorder 型は TDBCtrlGrid コンポーネントの PanelBorder プロパティに指定できる値を定義します。次の表に TDBCtrlGridBorder 型の値の説明を示します。

値	説明
gbNone	枠なし
gbRaised	枠が浮き出す


TDBCtrlGridKey 型
TDBCtrlGridKey 型3425086

ユニット

DBCtrls

TDBCtrlGridKey 型は，TDBCtrlGrid コンポーネントの DoKey メソッドで使う Key パラメータの値を定義します。

type TDBCtrlGridKey = (gkNull, gkEditMode, gkPriorTab, gkNextTab, gkLeft, gkRight, gkUp, gkDown, gkScrollUp, gkScrollDown, gkPageUp, gkPageDown, gkHome, gkEnd, gkInsert, gkAppend,	 gkDelete, gkCancel);

説明

TDBCtrlGridKey 型は TDBCtrlGrid コンポーネントの DoKey メソッドに渡す Key パラメータに指定できる値を定義します。次の表に TDBCtrlGridKey 型の値の説明を示します。

値	説明
gkNull	処理なし
gkEditMode	EditMode を切り替える
gkPriorTab	タブ順で前のコントロールにフォーカスを移動する
gkNextTab	タブ順で次のコントロールにフォーカスを移動する
gkLeft	1 列左に移動する。必要であればスクロールする
gkRight	1 列右に移動する。必要であればスクロールする
gkUp	前の行に移動する。必要であればスクロールする
gkDown	次の行に移動する。必要であればスクロールする
gkScrollUp	前の行にあるレコードをカレントレコードにする。グリッド内の位置は変更しない
gkScrollDown	次の行にあるレコードをカレントレコードにする。グリッド内の位置は変更しない
gkPageUp	グリッド内の前のページに移動する
gkPageDown	グリッド内の次のページに移動する
gkHome	最初のレコードに移動する
gkEnd	最後のレコードに移動する
gkInsert	新規レコードを挿入する（AllowInsert が True の場合）
gkAppend	新規レコードを追加する（AllowInsert が True の場合）
gkDelete	カレントレコードを削除する（AllowDelete が True の場合）
gkCancel	既存レコードまたは新規レコードに対する未確定の変更を取り消す


TDBCtrlGridOrientation 型
TDBCtrlGridOrientation 型3425087

ユニット

DBCtrls

TDBCtrlGridOrientation 型は，TDBCtrlGrid コンポーネントの Orientation プロパティの値を定義します。

type TDBCtrlGridOrientation = (goVertical, goHorizontal);

説明

TDBCtrlGridOrientation 型は TDBCtrlGrid コンポーネントの Orientation プロパティに指定できる値を定義します。次の表に TDBCtrlGridOrientation 型の値の説明を示します。

値	説明
goVertical	パネルが垂直方向（列単位）に並ぶ
goHorizontal	パネルが水平方向（行単位）に並ぶ


TDBGridClickEvent 型
TDBGridClickEvent 型3425088

ユニット DBGrids

TDBGridClickEvent 型は，イベントが発生したことを TDBGrid オブジェクトに通知するメソッドへのポインタです。

type TDBGridClickEvent = procedure (Column: TColumn) of object;

説明

TDBGridClickEvent は，イベントが発生したことを TDBGrid コントロールに通知するメソッドを指します。この型はグリッドの OnCellClick イベントと OnTitleClick イベントで使われます。その場合，クリックイベントが発生した列が渡されます。


TDBGridColumnsState 型
TDBGridColumnsState 型3425089

ユニット

DBGrids

TDBGridColumnsState 型は，TDBGridColumns の State プロパティの値を定義します。

type

TDBGridColumnsState = (csDefault, csCustomized);

説明

TDBGridColumnsState 型は TDBGridColumns の State プロパティに指定できる値を定義します。次の表に TDBGridColumnsState 型の値の説明を示します。

値	説明
csDefault	グリッドの列オブジェクトは，データセットの項目オブジェクトのプロパティを使って作成されたデフォルトの列オブジェクトである。列オブジェクトへの変更は項目オブジェクトに反映され，項目オブジェクトへの変更は列オブジェクトに反映される
csCustomized	グリッドの列オブジェクトは静的オブジェクトである。つまり，グリッドの列オブジェクトはデータセットの項目のプロパティから独立している。静的な列には，対応するどの項目にも影響を及ぼさずに変更を加えることができる


TDBGridOptions 型
TDBGridOptions 型3425090

ユニット

DBGrids

TDBGridOptions 型は，TDBGrid の Options プロパティの値を定義します。

type

TDBGridOption = (dgEditing, dgAlwaysShowEditor, dgTitles, dgIndicator, dgColumnResize,dgColLines, dgRowLines, dgTabs, dgRowSelect, dgAlwaysShowSelection, dgConfirmDelete, dgCancelOnExit, dgMultiSelect);

TDBGridOptions = set of TDBGridOption;

説明

TDisplayCode 型は，DisplayRect プロパティを使って現在のリストビューにある項目の全体または一部の境界を示す四角形を抽出するときに，境界の種類を指定するのに使います。次の表に TDBGridOptions 型の値の説明を示します。

値	説明
dgEditing	True ならばユーザーはデータグリッド内のデータを編集できる
dgAlwaysShowEditor	True ならば，gdEditing も True であればグリッドは自動編集モードになる。グリッドが自動編集モードのとき，ユーザーは〔Enter〕や〔F2〕を押さなくてもセルの内容を編集できる。gdAlwaysShowEditor が False で gdEditing が True ならば，ユーザーはセルの内容を編集する前に〔Enter〕か〔F2〕を押さなくてはならない。gdEditing が False ならば gdAlwaysShowEditor を True に設定しても効果はない。dgRowSelect とは互いに排他的となる
dgTitles	True ならば列のタイトルは可視になる
dgIndicator	True ならば，どの列が現在の列かを示す小さいポインタが可視になる
dgColumnResize	True ならば列をサイズ変更できる。ただし，列のサイズ変更はその項目がグリッドへ追加されるまでできない。グリッドへ項目を追加するには，項目エディタで［追加］を選択する
dgColLines	True ならば列の間に線が表示される
dgRowLines	True ならば行間に線が表示される
dgTabs	True ならば，ユーザーが〔Tab〕キーと〔Shift+Tab〕キーを押すとデータグリッドの列の間を移動する
dgRowSelect	True ならばユーザーは個々のセルでなく行全体だけを選択できる。dgAlwaysShowEditor とは互いに排他的となる
dgAlwaysShowSelection	True ならば，グリッド内の選択したセルはそのデータグリッドにフォーカスがなくても引き続き選択状態で表示される
dgConfirmDelete	True ならば，ユーザーが〔Ctrl+Delete〕を使ってグリッド内の行を削除するときにメッセージボックスが表示される。このメッセージボックスは行を本当に削除するかの確認を求める
dgCancelOnExit	True ならば，挿入が保留中でユーザーが何も変更を加えなかった場合，挿入はユーザーがグリッドを出た時点で取り消される。これによって部分レコードや空白レコードを誤って登録することが防止される
dgMultiSelect	True ならば，ユーザーは〔Ctrl〕+クリックまたは〔Shift〕+矢印キーを使って隣り合わない複数の行を選択できる。複数選択リストボックスと同様な働きをする


TDisplayCode 型
TDisplayCode 型3425091

ユニット

ComCtrls

TDisplayCode 型は，DisplayRect メソッドの表示型を指定します。

type TDisplayCode = (drBounds, drIcon, drLabel, drSelectBounds);

説明

TDisplayCode 型は，DisplayRect プロパティを使って現在のリストビューにある項目の全体または一部の境界を示す四角形を抽出するときに，境界の種類を指定するのに使います。次の表に TDisplayCode 型の値の説明を示します。

値	説明
drBounds	アイコンとラベルも含めたリスト項目全体の境界となる四角形を返す
drIcon	アイコンまたは小型アイコンの境界となる四角形を返す
drLabel	項目テキストの境界となる四角形を返す
drSelectBounds	アイコンとラベルも含めたリスト項目全体の境界となる四角形を返すが，ViewStyle が vsReport の場合は列が除外される


TDragMode 型
TDragMode 型3425092

ユニット

Controls

TDragMode 型は，DragMode プロパティの値を定義します。

type TDragMode = (dmManual, dmAutomatic);

説明

TDragMode 型はコントロールの DragMode プロパティの値を定義します。次の表に TDragMode 型の値の説明を示します。

値	説明
dmAutomatic	dmAutomatic を選択するとコントロールはいつでもドラッグできる。ユーザーはコントロールをクリックしドラッグするだけでよい
dmManual	dmManual を選択するとアプリケーションが BeginDrag メソッドを呼び出すまでコントロールをドラッグできない


TDragState 型
TDragState 型3425093

参照

ユニット

Controls

TDragState 型は，ドラッグされたコントロールを他のコントロールから区別するためのドラッグ状態を指定します。

type TDragState = (dsDragEnter, dsDragLeave, dsDragMove);

説明

TDragState 型は他のコントロールに対してドラッグされるコントロールの状態を指定します。TDragState は OnDragOver イベントハンドラで使う State パラメータの型です。TDragState 型には次の状態があります。

値	意味
dsDragEnter	ドラッグオブジェクトをドロップできるコントロールに入った状態（デフォルト）
dsDragMove	ドラッグオブジェクトをドロップできるコントロール上で移動している
dsDragLeave	ドラッグオブジェクトをドロップできるコントロールから離れた
例

次のコードは OnDragOver イベントハンドラで，ラベルコントロールをパネルコントロールの上にドロップするのを禁止するために，ラベルがパネル上にドラッグされた時点でドラッグを停止させます。

procedure TForm1.Panel1DragOver(Sender, Source: TObject; X, Y: Integer;

State: TDragState; var Accept: Boolean);

begin

Accept := False;

if (Source is TLabel) and (State = dsDragEnter) then

(Source as TLabel).EndDrag(False);

end;

Source パラメータはドラッグされるラベル，Sender パラメータはパネルコントロール，State パラメータはドラッグ状態です。


TDuplicates 型
TDuplicates 型3425094

ユニット

Classes

TDuplicates 型は，TStringList の Duplicates プロパティがとりうる値を定義します。

type TDuplicates = (dupIgnore, dupAccept, dupError);

説明

TDuplicates 型は文字列リストオブジェクト（TStringList）の Duplicates プロパティで使える値を定義します。


TEditCharCase 型
TEditCharCase 型3425095

ユニット

StdCtrls

TEditCharCase 型は，TEdit の CharCase プロパティの値を定義します。

type TEditCharCase = (ecNormal, ecUpperCase, ecLowerCase);

説明

TEditCharCase 型は編集ボックス（TEdit）の CharCase プロパティで使える値を定義します。次の表に TEditCharCase 型の値の説明を示します。

値	説明
ecLowerCase	編集ボックスのテキストを小文字に変換する
ecNormal	編集ボックスのテキストを大文字と小文字の混在を許す。特に変換しない
ecUpperCase	編集ボックスのテキストを大文字に変換する


TFieldClass 型
TFieldClass 型3425096

ユニット

DB

TFieldClass 型は，TField へのオブジェクト参照を作成するのに使われます。

type TFieldClass = class of TField;

説明

TFieldClass 型は TField のオブジェクト型です。TFieldClass は TField へのオブジェクト参照の作成に使います。


TFieldKind 型
TFieldKind 型3425097

ユニット

DB

TFieldKind 型は，TField コンポーネントの FieldKind プロパティがとりうる値のセットです。

type TFieldKind = (fkData, fkCalculated, fkLookup, fkInternalCalc);

説明

TFieldKind 型は TField コンポーネントの FieldKind プロパティの値のセットです。次の表に TFieldKind 型の値の説明を示します。

値	説明
fkData	項目はデータベーステーブルの物理項目を表す
fkCalculated	項目は計算項目である
fkLookup	項目は参照項目である
fkInternalCalc	項目は，データセットによって格納される計算値を示す


TFieldType 型
TFieldType 型3425098

ユニット

DB

TFieldType 型は，TField または TFieldDef コンポーネントの DataType プロパティがとりうる値のセットです。

type TFieldType = (ftUnknown, ftString, ftSmallint, ftInteger, ftWord, ftBoolean, ftFloat, ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftBytes, ftVarBytes, ftAutoInc, ftBlob, ftMemo, ftGraphic, ftFmtMemo, ftParadoxOle, ftDBaseOle, ftTypedBinary, ftCursor);

説明

TFieldType 型は，TField コンポーネントや TFieldDef コンポーネントの DataType プロパティの値のセットです。各値は次の表のとおりです。

値	説明
ftUnkown	未知または未定
ftString	文字または文字列項目
ftSmallint	16 ビット整数項目
ftInteger	32 ビット整数項目
ftWord	16 ビット符号なし整数項目
ftBoolean	論理型項目
ftFloat	浮動少数点数値型項目
ftCurrency	金額型項目
ftBCD	2 進化 10 進数型項目
ftDate	日付型項目
ftTime	時刻型項目
ftDateTime	日付時刻型項目
ftBytes	固定長バイト型項目（バイナリ格納）
ftVarBytes	可変長バイト型項目（バイナリ格納）
ftAutoInc	自動インクリメント 32 ビット整数カウンタ型項目
ftBlob	バイナリ大規模オブジェクト型項目
ftMemo	テキストメモ項目
ftGraphic	ビットマップ項目
ftFmtMemo	書式付きメモ項目
ftParadoxOle	Paradox OLE 項目
ftDBaseOle	dBASE OLE 項目
ftTypedBinary	型付きバイナリ項目
ftCursor	Oracle ストアドプロシージャの出力カーソル（TParam のみ）


TFileEditStyle 型
TFileEditStyle 型3425099

ユニット

Dialogs

TFileEditStyle 型は，TOpenDialog および TSaveDialog の FileEditStyle プロパティの値を定義します。.

type TFileEditStyle = (fsEdit, fsComboBox);

説明

TFileEditStyle 型は［ファイルを開く］ダイアログボックス（TOpenDialog）と［ファイル名を付けて保存］ダイアログボックス（TSaveDialog）の FileEditStyle プロパティで使える値を定義します。


TFileName 型
TFileName 型3425101

ユニット

SysUtils

TFileName 型は，[ファイルを開く]ダイアログボックスと[ファイル名を付けて保存]ダイアログボックスの FileName プロパティを定義します。

type TFileName = string;

説明

TFileName 型は[ファイルを開く]ダイアログボックスと[ファイル名を付けて保存]ダイアログボックスの FileName プロパティの型です。


TFileRec 型
TFileRec 型3425102

参照

ユニット

SysUtils

TFileRec 型は，型付きファイルおよび型なしファイルの内部形式です。

type TFileRec = record

Handle: Integer;

Mode: Integer;

RecSize: Cardinal;

Private: array[1..28] of Byte;

UserData: array[1..32] of Byte;

Name: array[0..259] of Char;

end;

説明

型付きファイルと型なしファイルの内部形式です。TFileRec をファイル変数に型キャストすれば，その内部フィールドにアクセスできます。

注意	通常，この型の変数を宣言することはありません。


TFileType 型
TFileType 型3425103

ユニット

FileCtrl

TFileType 型は，ファイル属性のセットです。

type

TFileAttr = (ftReadonly, ftHidden, ftSystem, ftVolumeID, ftDirectory, ftArchive, ftNormal);

TFileType = set of TFileAttr;

説明

TFileType 型はファイル属性のセットです。TFileType 型はファイルリストボックス（TFileListBox）の FileType プロパティで使います。以下に TFileType 型の値を示します。

値	説明
ftReadOnly	ftReadOnly が True ならば，リストボックスに読み出し専用属性を持つファイルを表示できる
ftHidden	ftHidden が True ならば，リストボックスに非表示属性を持つファイルを表示できる
ftSystem	ftSystem が True ならば，リストボックスにシステム属性を持つファイルを表示できる
ftVolumeID	ftVolumeID が True ならば，リストボックスにボリューム名を表示できる
ftDirectory	ftDirectory が True ならば，リストボックスにディレクトリを表示できる
ftArchive	ftArchive が True ならば，リストボックスにアーカイブ属性を持つファイルを表示できる
ftNormal	ftNormal が True ならば，リストボックスに属性を持たないファイルを表示できる


TFillStyle 型
TFillStyle 型3425104

ユニット

Graphics

TFillStyle 型は，TCanvas の FloodFill メソッドで使われる塗りつぶしを決めます。

type TFillStyle = (fsSurface, fsBorder);

説明

TFillStyle 型はキャンバス（TCanvas オブジェクト）の FloodFill メソッドで使う塗りつぶし方法を決めます。以下に TFillStyle 型の値を示します。

値	説明
fsBorder	Color パラメータで指定する色境界まで領域を塗りつぶす
fsSurface	Color パラメータで指定する色が続くかぎり領域を塗りつぶす。fsSurface は複数の色境界を持つ領域を塗りつぶすのに便利


TFilterOptions 型
TFilterOptions 型3425105

ユニット

DB

TFilterOptions 型は，TTable，TQuery，および TStoredProc の各コンポーネントの FilterOptions プロパティの値を定義します。

type

TFilterOption = (foCaseInsensitive, foNoPartialCompare);

TFilterOptions = set of TFilterOption;

説明

TFilterOptions 型は TTable, TQuery, TStoredProc の各コンポーネントの FilterOptions プロパティに指定できる値を定義します。次の表に TFilterOptions 型の値の説明を示します。

値	説明
foCaseInsensitive	フィルタの処理ではデータセットのデータの大文字と小文字は区別されない
foNoPartialCompare	文字列の長さはデータセットのデータの長さと正確に一致しなければならない。部分的な一致は認められない


TFilterRecordEvent 型
TFilterRecordEvent 型3425106

ユニット

DB

TFilterRecordEvent 型は，OnFilterRecord イベントに対応するメソッドを指します。

type TFilterRecordEvent = procedure(DataSet: TDataSet; var Accept: Boolean) of object;

説明

TFilterRecordEvent 型は，OnFilterRecord イベントに対応するメソッドを指します。OnFilterEvent ではデータセット内で表示するレコードの取捨選択を行うことができます。


TFindItemKind 型
TFindItemKind 型3425107

ユニット

Menus

TFindItemKind 型は，FindItem メソッドの Kind パラメータの値を定義します。

type TFindItemKind = (fkCommand, fkHandle, fkShortCut);

説明

TFindItemKind はメニューコンポーネントの FindItem メソッドの Kind パラメータで使える値を定義します。以下に TFindItemKind 型の値を示します。

値	説明
fkCommand	Windows WM_COMMAND メッセージが使うメニューコマンド
fkHandle	メニューハンドル
fkShortCut	メニューショートカット


TFindOptions 型
TFindOptions 型3425108

ユニット

Dialogs

TFindOptions 型は，TFindDialog および TReplaceDialog コンポーネントの Options プロパティの値です。

type

TFindOption = (frDown, frFindNext, frHideMatchCase, frHideWholeWord, frHideUpDown, frMatchCase, frDisableMatchCase, frDisableUpDown, frDisableWholeWord, frReplace, frReplaceAll, frWholeWord, frShowHelp);

TFindOptions = set of TFindOption;

説明

TFindOptions 型は［検索］ダイアログボックスと［置換］ダイアログボックス（TFindDialog と TReplaceDialog コンポーネント）の Options プロパティで使える値のセットを定義します。以下に TFindOptions 型の値を示します。

値	説明
frDisableMatchCase	True ならば，［大文字と小文字を区別する(C)］チェックボックスが淡色表示になり，ユーザーはチェックマークを付けられない。False ならば，ユーザーは［大文字と小文字を区別する(C)］チェックボックスにチェックマークを付けられる
frDisableUpDown	True ならば，［検索する方向］の［上へ向かって(U)］と［下へ向かって(D)］ボタンが淡色表示になり，ユーザーはどちらも選択できない。False ならば，ユーザーは［検索する方向］の［上へ向かって(U)］と［下へ向かって(D)］ボタンのどちらかを選択できる。この値は［置換］ダイアログボックスでは無視される
frDisableWholeWord	True ならば，［単語単位で検索(W)］チェックボックスが単色表示になり，ユーザーは選択できない。False ならば，ユーザーはこのチェックボックスにチェックマークを付けられる
frDown	True ならば，ダイアログボックス内で［下へ向かって(D)］ボタンが選択され，検索方向が下になる。frDown が False ならば，［上へ向かって(U)］ボタンが選択され，検索方向は上になる。frDown は設計時に設定できるが，ユーザーは実行時にこのダイアログボックスを使うときに値を変更できる
frFindNext	ユーザーが［次を検索(F)］ボタンを選択したときに設定されるフラグ。frFindNext が True ならば，アプリケーションは FindText プロパティの文字列を求めて検索する
frHideMatchCase	True ならば，［大文字と小文字を区別する(C)］チェックボックスはダイアログボックスの中に表示されない。False ならば，［大文字と小文字を区別する(C)］チェックボックスは可視になる
frHideWholeWord	True ならば，［単語単位で検索(W)］チェックボックスはダイアログボックスの中に表示されない。False ならば，［単語単位で検索(W)］チェックボックスは可視になる
frHideUpDown	True ならば，［検索する方向］の［上へ向かって(U)］ボタンと［下へ向かって(D)］ボタンはダイアログボックスの中に表示されない。False ならば，［検索する方向］の［上へ向かって(U)］ボタンと［下へ向かって(D)］ボタンは可視になる。この値は［置換］ダイアログボックスでは無視される
frMatchCase	True ならば，［大文字と小文字を区別する(C)］チェックボックスにチェックマークが付く。False ならば，［大文字と小文字を区別する(C)］チェックボックスにチェックマークが付かない。frMatchCase は設計時に設定できるが，ユーザーは実行時にこの値を変更できる
frReplace	frReplace はシステムによって設計されるフラグで，現在検出した FindText 文字列をアプリケーションが ReplaceText 文字列に置き換えなくてはならないことを示す。frReplace は［置換］ダイアログボックスにだけ適用される
frReplaceAll	frReplaceAll はシステムによって設定されるフラグで，検出したすべての FindText 文字列をアプリケーションが ReplaceText 文字列に置き換えなくてはならないことを示す。frReplaceAll は［置換］ダイアログボックスにだけ適用される
frShowHelp	True ならば，［ヘルプ(H)］ボタンがダイアログボックスの中に表示される。frShowHelp が False ならば，［ヘルプ(H)］ボタンは存在しない
frWholeWord	True ならば，ダイアログボックスの中で［単語単位で検索(W)］チェックボックスにチェックマークが付く。frWholeWord は設計時に設定できるが，ユーザーは実行時にこのダイアログボックスを使うときに値を変更できる


TFloatFormat 型
TFloatFormat 型3425109

参照

ユニット

SysUtils

TFloatFormat 型は，浮動小数点関数の形式コードの列挙型リストです。

type TFloatFormat = (ffGeneral, ffExponent, ffFixed, ffNumber, ffCurrency);

説明

浮動小数点関数で使う形式コードの列挙型リストを定義します。

形式	定義
ffGeneral	汎用数値形式。値は固定小数点形式または指数形式を使った最短の 10 進文字列に変換される。変換後の文字列から末尾部分のゼロは除去され，小数点は必要な場合だけ表示される。整数部の桁数が指定された精度以下で，値が 0.00001 以上の場合，変換後の文字列は固定小数点形式になる。それ以外の場合は，指数形式が使われる。Digits パラメータには指数部の最小桁数（0 以上 4 以下）を指定する
ffExponent	指数形式。値は "-d.ddd...E+dddd" の形式文字列に変換される。負の数の場合，変換後の文字列は負符号で始まり，整数部に 1 桁表示される。変換後の文字列の全桁数（小数点の前の 1 桁も含む）を Precision パラメータで指定する。変換後の文字列の指数文字 E の後には，正符号または負符号と 4 桁までの数字が続く。Digits パラメータには指数部の最小桁数（0 以上 4 以下）を指定する
ffFixed	固定小数点形式。値は "-ddd.ddd..." 形式の文字列に変換される。負の数の場合，変換後の文字列は負符号で始まり，整数部に最低 1 桁は表示される。小数点以下の桁数（0 以上 18 以下）を Digits パラメータで指定する。整数部の桁数が指定された精度より多い場合，変換後の文字列は指数形式になる
ffNumber	数値形式。値は "-d, ddd, ddd.ddd..." 形式の文字列に変換される。変換後の文字列に 3 桁区切りの記号が含まれる点を除いて，ffFixed 形式と同じである
ffCurrency	通貨形式。値は金額を表す文字列に変換される。変換方法は CurrencyString, CurrencyFormat, NegCurrFormat, ThounsandSeparator, DecimalSeparator の各グローバル変数で指定する。これらの変数はすべて，Windows のコントロールパネルにある各国対応の通貨の形式に定義されている値で初期化される。小数点以下の桁数（0 以上 18 以下）を Digits パラメータで指定する


TFloatRec 型
TFloatRec 型3425110

ユニット

SysUtils

TFloatRec 型は，FloatToDecimal の結果レコードです。

type TFloatRec = record

Exponent: Smallint;

Negative: Boolean;

Digits: array[0..20] of Char;

end;

説明

TFloatRec は FloatToDecimal の結果レコードです。


TFloatValue 型
TFloatValue 型3425111

ユニット

SysUtils

TFloatValue 型は，FloatToText，FloatToTextFmt，TextToFloat および FloatToDecimal の ValueType パラメータの型です。

type TFloatValue = (fvExtended, fvCurrency);

説明

TFloatValue は FloatToText, FloatToTextFmt, TextToFloat の各関数と FloatToDecimal 手続きの ValueType パラメータの型です。ValueType パラメータはこれらの関数または手続きに渡される値が通貨型か標準の浮動小数点型かを示します。

値	意味
fvExtended	値は標準の浮動小数点型である
fvCurrency	値は通貨型である


TFontDialogDevice 型
TFontDialogDevice 型3425112

ユニット

Dialogs

TFontDialogDevice 型は，TFontDialog の Device プロパティの値のリストを定義します。

type TFontDialogDevice = (fdScreen, fdPrinter, fdBoth);

説明

TFontDialogDevice 型は［フォントの指定］ダイアログボックス（TFontDialog）の Device プロパティで使える値を定義します。以下に TFontDialogDevice 型の値を示します。

値	説明
fdScreen	画面に適用する
fdPrinter	プリンタに適用する
fdBoth	画面とプリンタに適用する


TFontDialogOptions 型
TFontDialogOptions 型3425113

ユニット

Dialogs

TFontDialogOptions 型は，TFontDialog の Options プロパティがとることのできる値です。

type

TFontDialogOption = (fdAnsiOnly, fdTrueTypeOnly, fdEffects, fdFixedPitchOnly, fdForceFontExist, fdNoFaceSel, fdNoOEMFonts, fdNoSimulations, fdNoSizeSel, fdNoStyleSel, fdNoVectorFonts, fdShowHelp, fdWysiwyg, fdLimitSize, fdScalableOnly, fdApplyButton);

TFontDialogOptions = set of TFontDialogOption;

説明

TFontDialogOptions 型は［フォントの指定］ダイアログボックス（TFontDialog）の Options プロパティで使える値のセットです。以下に値を示します。

値	説明
fdAnsiOnly	True ならば，ユーザーは Windows 文字セットだけを使うフォントを選択できる。つまり，ユーザーはシンボルフォントを選択できない。シンボルは［フォント(F)］コンボボックスに表示されないからである
fdApplyButton	OnApply イベントのイベントハンドラがある場合に適用ボタンが自動的に表示され，この場合フラグは無視される。OnApply のイベントハンドラがない場合，フラグがボタンの表示を制御する
fdEffects	True ならば，［フォントの指定］ダイアログボックスに［文字飾り］のチェックボックスと［色(C)］リストボックスが表示される。ユーザーは［文字飾り］のチェックボックスを使って打ち消し線や下線が付いたテキストを指定し，［色(C)］リストボックスを使って色を選択する。fdEffects が False ならば，［文字飾り］のチェックボックスと［色(C)］リストボックスは［フォントの指定］ダイアログボックスの中に表示されない
fdFixedPitchOnly	True ならば，モノスペースフォントだけが［フォント名(F)］コンボボックスに表示される
fdForceFontExist	True ならば，存在しないフォントを［フォント名(F)］コンボボックスに入力して［OK］を選択した場合，フォント名が無効であることを知らせるメッセージダイアログボックスが表示される
fdLimitSize	True ならば，ダイアログボックス内で使用可能なフォントの数を MinFontSize プロパティと MaxFontSize プロパティによって制限できる
fdNoFaceSel	True ならば，ダイアログボックスが表示されたとき，［フォント名(F)］コンボボックスの中でフォント名が選択されていない
fdNoOEMFonts	True ならば，ベクタフォントでないフォントだけが［フォント名(F)］コンボボックスに表示される
fdScalableOnly	True ならば，スケーラブルフォントだけが［フォント名(F)］コンボボックスに表示される
fdNoSimulations	True ならば，GDI フォントシミュレーションでないフォントだけが［フォント名(F)］コンボボックスに表示される
fdNoSizeSel	True ならば，ダイアログボックスが表示されたとき，［サイズ(S)］コンボボックスの中でサイズが選択されていない
fdNoStyleSel	True ならば，ダイアログボックスが表示されたとき，［スタイル(Y)］コンボボックスの中でスタイルが選択されていない
fdNoVectorFonts	fdNoOEMFonts と同じ
fdShowHelp	True ならば，［ヘルプ(H)］ボタンがダイアログボックスの中に表示される
fdTrueTypeOnly	True ならば，TrueType フォントだけが［フォント名(F)］リストボックスに表示される
fdWysiwyg	True ならば，プリンタと画面の両方に使用可能なフォントだけが［フォント名(F)］コンボボックスに表示される


TFontName 型
TFontName 型3425114

ユニット

Graphics

TFontName 型は，TFont の Name プロパティで使われる型です。

type TFontName = string;

説明

TFontName 型はフォントオブジェクト（TFont）の Name プロパティで使います。文字の最大数は 32 なので，32 文字を超えた部分のフォント名は切り捨てられます。


TFontPitch 型
TFontPitch 型3425115

ユニット

Graphics

TFontPitch 型は，TFont の Pitch プロパティで使う型です。

type TFontPitch = (fpDefault, fpVariable, fpFixed);

説明

TFontPitch 型はフォントオブジェクト（TFont）の Pitch プロパティで使います。以下に値を示します。

値	説明
fpDefault	フォントピッチはデフォルト値に設定される。デフォルト値は Name プロパティに指定したフォントによって異なる
fpFixed	フォントピッチは固定ピッチに設定される。フォント内のすべての文字は同じ幅になる
fpVariable	フォントピッチは可変ピッチに設定される。フォント内の文字は幅が異なる


TFontStyles 型
TFontStyles 型3425116

ユニット

Graphics

TFontStyles 型は，TFont の Style プロパティで使えるスタイルです。

type

TFontStyle = (fsBold, fsItalic, fsUnderline, fsStrikeOut);

TFontStyles = set of TFontStyle;

説明

TFontStyles 型はフォントオブジェクト（TFont）の Style プロパティで使えるフォントのセットです。以下に値を示します。

値	説明
fsBold	フォントは太字になる
fsItalic	フォントは斜体になる
fsUnderline	フォントは下線付きになる
fsStrikeout	フォントは打ち消し線付きになる


TFormBorderStyle 型
TFormBorderStyle 型3425117

ユニット

Forms

TFormBorderStyle 型は，フォームの BorderStyle プロパティで使える境界のスタイルを定義します。

type

TFormBorderStyle = (bsNone, bsSingle, bsSizeable, bsDialog, bsToolWindow, bsSizeToolWin);

説明

TFormBorderStyle 型はフォームで使える境界のスタイルを定義します。TFormBorderStyle はフォームの BorderStyle プロパティの型です。以下に値を示します。

値	説明
bsNone	サイズ変更不可; 可視境界線，アイコン化ボタン，最大表示ボタン，コントロールメニューのいずれもない
bsSingle	サイズ変更不可; 一重境界線
bsSizeable	標準のサイズ変更可能境界
bsDialog	サイズ変更不可; 標準のダイアログボックス境界
bsToolWindow	bsSingle と同じだがキャプションが小さい
bsSizeToolWin	bsSizeable と同じだがキャプションが小さい


TFormStyle 型
TFormStyle 型3425118

ユニット

Forms

TFormStyle 型は，TForm の FromStyle プロパティの値を定義します。

type TFormStyle = (fsNormal, fsMDIChild, fsMDIForm, fsStayOnTop);

説明

TFormStyle 型はフォーム（TForm）の FormStyle プロパティで使える値を定義します。以下に値を示します。

値	説明
fsNormal	フォームは MDI 親ウィンドウでも MDI 子ウィンドウでもない
fsMDIChild	フォームは MDI 子ウィンドウである
fsMDIForm	フォームは MDI 親ウィンドウである
fsStayOnTop	フォームはプロジェクトのほかのフォーム（FormStyle が fsStayOnTop に設定されているフォームを除く）の上にくる


TGridDrawState 型
TGridDrawState 型3425119

ユニット

Grids

TGridDrawState 型は，描画中のセルがとりうる状態を定義します。

type TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

説明

TGridDrawState 型は描画中のセルの状態を定義します。TGridDrawState は TDrawCellEvent メソッドポインタで使う AState パラメータの型です。


TGridOptions 型
TGridOptions 型3425120

ユニット

Grids

TGridOptions 型は，TDrawGrid または TStringGrid コンポーネントの Options プロパティの値を定義します。

type

TGridOption = (goFixedVertLine, goFixedHorzLine, goVertLine, goHorzLine, goRangeSelect, goDrawFocusSelected, goRowSizing, goColSizing, goRowMoving, goColMoving, goEditing, goTabs, goRowSelect, goAlwaysShowEditor, goThumbTracking);

TGridOptions = set of TGridOption;

説明

TGridOptions は TDrawGrid または TStringGrid コンポーネントの Options プロパティで使える値のセットです。以下に値を示します。

値	説明
goFixedHorzLine	True ならば，非スクロール領域内の行間に横線が表示される
goFixedVertLine	True ならば，非スクロール領域内の列の間に縦線が表示される
goHorzLine	True ならば，行間に横線が表示される
goVertLine	True ならば，列の間に縦線が表示される
goRangeSelect	True ならば，セルの範囲を一度に選択できる。goEditing が True ならば，ユーザーはセルの範囲をそれ以上選択できない
goDrawFocusSelected	True ならば，フォーカスがあるセルは選択したブロック内のセルと同じ色になる。False ならば，フォーカスがあるセルは選択されていないすべてのセルと同じ色，つまりグリッドの Color プロパティで指定した色になる
goRowSizing	True ならば，固定行と非スクロール行を除いて行を個別にサイズ変更できる
goColSizing	True ならば，固定列と非スクロール列を除いて列を個別にサイズ変更できる
goRowMoving	True ならば，ユーザーはマウスを使って行をグリッド内の新しい位置へ移動できる
goColMoving	True ならば，ユーザーはマウスを使って列をグリッド内の新しい位置へ移動できる
goEditing	True ならば，ユーザーはグリッド内のテキストを編集できる。goEditing が True ならば，ユーザーはセルの範囲を一度に選択できない
goAlwaysShowEditor	True ならば，goEditing が True の場合にグリッドは自動編集モードになる。グリッドが編集モードのとき，ユーザーは〔Enter〕や〔F2〕を押さなくてもセルの内容を編集できる。goAlwaysShowEditor が False で goEditing が True ならば，ユーザーはセルの内容を編集する前に〔Enter〕か〔F2〕を押さなくてはならない。goEditing が False ならば，goAlwaysShowEditor を True に設定しても効果はない。goRowSelect とは互いに排他的となる
goTabs	True ならば，ユーザーは〔Tab〕と〔Shift〕+〔Tab〕を使ってグリッド内の列から列へ移動できる
goRowSelect	True ならば，ユーザーは個々のセルでなく行全体を一度に選択できるgoAlwaysShowEditor とは互いに排他的となる
goThumbTracking	True ならば，ユーザーがグリッドスクロールバーのスクロールボックスを移動しているときにグリッドの内容がスクロールする。False ならば，ユーザーがスクロールボックスを新しい位置で放すまでグリッドの内容はスクロールしない


TGridRect 型
TGridRect 型3425121

ユニット

Grids

TGridRect 型は，グリッドコントロール内の四角形の領域を定義します。

type

TGridCoord = record

X: Longint;

Y: Longint;

end;

TGridRect = record

case Integer of

0: (Left, Top, Right, Bottom: Longint);

1: (TopLeft, BottomRight: TGridCoord);

end;

説明

TGridRect はグリッドコントロール内の四角形の領域を定義します。TGridRect は TDrawGrid と TStringGrid コンポーネントの Selection プロパティの型です。


THeaderSectionStyle 型
THeaderSectionStyle 型3425122

ユニット

ComCtrls

THeaderSectionStyle 型は，THeaderSection の Style プロパティの値を定義します。

type THeaderSectionStyle = (hsText, hsOwnerDraw);

説明

THeaderSectionStyle 型は THeaderSection オブジェクトの Style プロパティに指定できる値を定義します。THeaderSection オブジェクトは THeaderControl コンポーネントのヘッダーを構成する個々の項目です。以下に値を示します。

値	説明
hsText	項目は文字列である
hsOwnerDraw	項目はコードにより Canvas に描画される


THeapStatus 型
THeapStatus 型3425123

参照

ユニット

System

THeapStatus 型は，GetHeapStatus 関数が戻す型です。

type

THeapStatus = record

TotalAddrSpace: Cardinal;

TotalUncommitted: Cardinal;

TotalCommitted: Cardinal;

TotalAllocated: Cardinal;

TotalFree: Cardinal;

FreeSmall: Cardinal;

FreeBig: Cardinal;

Unused: Cardinal;

Overhead: Cardinal;

HeapErrorCode: Cardinal;

end;

説明

THeapStatus 型は GetHeapStatus 関数が返す型です。次に THeapStatus レコードの値の意味を示します。

フィールド	意味
TotalAddrSpace	Pascal プログラムで使用している現在のアドレス空間のトータルのバイト数。プログラムの動的メモリ使用量が増えると大きくなる
TotalUncommitted	TotalAddrSpace の中で，スワップファイルに割り当てられていない空間のトータルのバイト数
TotalCommitted	TotalAddrSpace の中で，スワップファイルに割り当てられている空間のトータルのバイト数。 注意: TotalUncommitted + TotalCommitted = TotalAddrSpace
TotalAllocated	プログラムが動的に割り当てたトータルのバイト数
TotalFree	現在のアドレス空間でプログラムによる割り当てに使用可能なトータルの空きバイト数。この数を超過した場合，十分な仮想メモリがあれば，オペレーティングシステムから割り当てられるアドレス空間が増え，それに従って TotalAddrSpace が大きくなる
FreeSmall	プログラムが現在割り当てていない小型メモリブロックのトータルのバイト数
FreeBig	プログラムが現在割り当てていない大型メモリブロックのトータルのバイト数。連続する小型の空きブロックをまとめるか，大型の動的割り当てを解放すれば，大型の空きブロックを作成できる。ブロックの正確なサイズは重要ではない
Unused	プログラムが割り当てたことがないトータルのバイト数。 Unused + FreeBig + FreeSmall = TotalFree 注意: この 3 つのフィールドはユーザープログラムからの動的割り当てに関連している
Overhead	プログラムが動的に割り当てたすべてのブロックを管理するために，ヒープマネージャが必要とするトータルのバイト数
HeapErrorCode	内部的に決められたヒープの現在の状態を示す。
注意	TotalAddrSpace, TotalUncommitted, TotalCommitted はプログラムによって使われるオペレーティングシステムメモリに関連していますが，TotalAllocated と TotelFree は動的割り当てによってプログラム内で使われるヒープメモリに関連しています。したがって，プログラムで使われる動的メモリを管理するには，TotalAllocated と TotalFree を使います。


THelpContext 型
THelpContext 型3425124

ユニット

Classes

THelpContext 型は，ヘルプコンテキスト番号の定義に使います。

type THelpContext = -MaxLongInt..MaxLongInt;

説明

THelpContext 型はヘルプコンテキスト番号を定義します。


THintInfo 型
THintInfo 型3425125

ユニット

Forms

THintInfo 型は，ヘルプウィンドウの外観および動作の定義に使います。

type

PHintInfo = ^THintInfo;

THintInfo = record

HintControl: TControl;

HintWindowClass: THintWindowClass;

HintPos: TPoint;

HintMaxWidth: Integer;

HintColor: TColor;

CursorRect: TRect;

CursorPos: TPoint;

ReshowTimeout: Integer;

HideTimeout: Integer;

HintStr: string;

HintData: Pointer;

end;

説明

THintInfo 型は TShowHintEvent 型の OnShowHint イベントハンドラのヘルプウィンドウの外観と動作を定義します。


THitTests 型
THitTests 型3425126

ユニット

ComCtrls

THitTests 型は，ツリービューコントロールのクライアント領域を基準にしてポイントの位置を決めます。

type

THitTest = (htAbove, htBelow, htNowhere, htOnItem, htOnButton, htOnIcon, htOnIndent, htOnLabel, htOnRight, htOnStateIcon, htToLeft, htToRight);

THitTests = set of THitTest;

説明

THitTests 型はツリービューコントロールのクライアント領域を基準として，指定されたポイントの相対的な位置を表します。THitsTests 型は TTreeView コンポーネントの GetHitTestInfoAt メソッドで返される値のセットを定義します。以下に値を示します。

値	説明
htAbove	その点はツリービューコントロールのクライアント領域より上にある
htBelow	その点はツリービューコントロールのクライアント領域より下にある
htNowhere	その点はツリービューコントロールのクライアント領域にあるが，最後の項目より下にある
htOnItem	その点はある項目に関連付けられているビットマップかラベルの上にある
htOnButton	その点はある項目に関連付けられているボタンの上にある
htOnIcon	その点はある項目に関連付けられているビットマップの上にある
htOnIndent	その点はある項目に関連付けられているインデントの上にある
htOnLabel	その点はある項目に関連付けられているラベル（テキスト）の上にある
htOnRight	その点はある項目の右側の領域にある
htOnStateIcon	その点はユーザー定義状態にあるツリービュー項目の状態アイコンの上にある
htToRight	その点はツリービューコントロールのクライアント領域の右側にある
htToLeft	その点はツリービューコントロールのクライアント領域の左側にある


THKInvalidKeys 型
THKInvalidKeys 型3425127

ユニット

ComCtrls

THKInvalidKeys 型は，THotKey の InvalidKeys プロパティの値を定義します。

type

THKInvalidKey = (hcNone, hcShift, hcCtrl, hcAlt, hcShiftCtrl, hcShiftAlt, hcCtrlAlt, hcShiftCtrlAlt);

THKInvalidKeys = set of THKInvalidKey;

説明

THKInvalidKeys 型は THotKey コンポーネントの InvalidKeys プロパティに指定できる値のセットを定義します。以下に値を示します。

値	説明
hcNone	修飾解除キーは無効である
hcShift	〔Shift〕は修飾子として無効である
hcCtrl	〔Ctrl〕は修飾子として無効である
hcAlt	〔Alt〕は修飾子として無効である
hcShiftCtrl	〔Shift〕+〔Ctrl〕の組み合わせは修飾子として無効である
hcShiftAlt	〔Shift〕+〔Alt〕の組み合わせは修飾子として無効である
hcCtrlAlt	〔Ctrl〕+〔Alt〕の組み合わせは修飾子として無効である
hcShiftCtrlAlt	〔Shift〕+〔Ctrl〕+〔Alt〕の組み合わせは修飾子として無効である


THKModifiers 型
THKModifiers 型3425128

ユニット

ComCtrls

THKModifiers 型は，THotKey の Modifiers プロパティの値を定義します。

type

THKModifier = (hkShift, hkCtrl, hkAlt, hkExt);

THKModifiers = set of THKModifier;

説明

THKModifiers 型は THotKey コンポーネントの Modifiers プロパティに指定できる値のセットを定義します。以下に値を示します。

値	説明
hkShift	〔Shift〕を修飾キーとして使う
hkCtrl	〔Ctrl〕を修飾キーとして使う
hkAlt	〔Alt〕を修飾キーとして使う
hkExt	〔Extra〕を修飾キーとして使う


TIconArrangement 型
TIconArrangement 型3425129

ユニット

ComCtrls

TIconArrangement 型は，リストビューでアイコンをどこに合わせるかを指定するのに使います。

type TIconArrangment = (iaTop, iaLeft);

説明

リストビューの TIconOptions オブジェクトの Arrangement プロパティを使うと，TIconArrangement の値を指定できます。リストビューでアイコンの位置合わせを有効にするには，ViewStyle を vsIcon または vsSmallIcon に設定しなければなりません。以下に TIconArrangement 型の値を示します。

値	説明
iaTop	項目を，リストボックスビューコントロールの最上行に左から右へ並べる
iaLeft	項目を，リストボックスビューコントロールの左端の列に上から下へ並べる


TImageType 型
TImageType 型3425130

ユニット

Controls

TImageType 型は，ImageType プロパティのとりうる値を示します。

type TImageType = (itImage, itMask);

説明

TImageType 型は TImageList オブジェクトの ImageType プロパティに指定できる値を示します。TImageList オブジェクトはイメージまたはマスクイメージを描画するときに，ImageType の設定を使います。以下に TImageType 型の値を示します。

値	説明
itImage	イメージを描画する
itMask	マスクイメージを描画する


TIndexOptions 型
TIndexOptions 型3425131

ユニット

DB

TIndexOptions 型は，新しいインデックスの作成に使える値を定義します。

type

TIndexOptions = set of (ixPrimary, ixUnique, ixDescending, ixExpression,

ixCaseInsensitive);

説明

TIndexOptions 型は新しいインデックスの作成で使える値のセットです。データセットコンポーネントの AddIndex メソッドで使います。

注意	dBASE テーブルでは ixCaseInsensitive はサポートされません。


TItemStates 型
TItemStates 型3425132

ユニット

ComCtrls

TItemStates 型は，リスト項目の外観および機能の状態を調べるための値を定義します。

type

TItemState = (isNone, isCut, isDropHilited, isFocused, isSelected);

TItemStates = set of TItemState;

説明

TItemStates 型はリスト項目の外観と機能を決めるのに指定できる状態のセットです。指定された状態でリストビューの次の項目を取得するために，GetNextItem メソッドで TItemStates 型のパラメータを使います。以下に TItemState 型の値を示します。

値	説明
isNone	その項目はデフォルトの状態にある
isCut	その項目は切り取りと貼り付け用にマークされている
isDropHilited	その項目はドラッグアンドドロップのターゲットとして強調表示されている
isFocused	その項目はフォーカスが設定されているので標準的なフォーカス四角形で囲まれている。複数の項目を選択できるが，フォーカスを設定できるのは 1 つだけである。
isSelected	その項目は選択されている。選択した項目の外観はフォーカスが設定されているかどうかと選択用に使われているシステムカラーによって異なる


TLastReleaseEvent 型
TLastReleaseEvent 型3425133

参照

ユニット

OLEAuto

TLastReleaseEvent 型は，OnLastRelease イベントを指すポインタです。

type

TLastReleaseEvent = procedure(var Shutdown: Boolean) of object;

説明

TLastReleaseEvent 型は，OnLastRelease イベントで使われるメソッドへのポインタの型です。変数パラメータの Shutdown を使うと，アプリケーションはデフォルトの動作をオーバーライドして，すべてのインスタンスが解放されたときにサーバーアプリケーションをシャットダウンするかどうかの動作を変更できます。


TLeftRight 型
TLeftRight 型3425134

ユニット

Classes

TLeftRight 型は，チェックボックスおよびラジオボタンの Alignment プロパティを定義します。

type

TAlignment = (taLeftJustify, taRightJustify, taCenter);

TLeftRight = taLeftJustify..taRightJustify;

説明

TLeftRight はチェックボックスとラジオボタンの Alignment プロパティの型です。以下に値を示します。

値	説明
taLeftJustify	キャプションをチェックボックスまたはラジオボタンの左側に表示する
taRightJustify	キャプションをチェックボックスまたはラジオボタンの右側に表示する


TListArrangement 型
TListArrangement 型3425135

ユニット

ComCtrls

TListArrangement 型は，TListView の Arrange メソッドの Code パラメータがとりうる値を定義します。

type

TListArrangement = (arAlignBottom, arAlignLeft, arAlignRight, arAlignTop, arDefault, arSnapToGrid);

説明

TListArrangement 型は TListView コンポーネントの Arrange メソッドの Code パラメータに指定できる値を定義します。この値は，リストビューでの項目の整列方法を指定するのに使います。以下に値を示します。

値	説明
arAlignBottom	項目をウィンドウの下端に合わせる
arAlignLeft	項目をウィンドウの左端に合わせる
arAlignRight	項目をウィンドウの右端に合わせる
arAlignTop	項目をウィンドウの上端に合わせる
arDefault	リストビューコントロールの現在の位置合わせスタイルに従って項目を合わせる（デフォルト値）
arSnapToGrid	すべてのアイコンを最も近いグリッドに合わせる


TListBoxStyle 型
TListBoxStyle 型3425136

ユニット

StdCrtls

TListBoxStyle 型は，TListBox の Style プロパティを定義します。

type

TListBoxStyle = (lbStandard, lbOwnerDrawFixed, lbOwnerDrawVariable);

説明

TListBoxStyle 型はリストボックス（TListBox コンポーネント）の Style プロパティの型です。以下に値を示します。

値	説明
lbStandard	すべての項目を同じ高さの文字列にする
lbOwnerDrawFixed	リストボックス内の項目を ItemHeight プロパティで指定した高さにする
lbOwnerDrawVariable	リストボックス内の項目を可変の高さにできる


TLoadResource 型
TLoadResource 型3425137

ユニット

Controls

TLoadResource 型は，GetResource メソッドのリソースフラグを指定するのに使います。

type

TLoadResource = (lrDefaultColor, lrDefaultSize, lrFromFile, lrMap3DColors, lrTransparent, lrMonoChrome);

説明

TLoadResources 型は GetResource メソッドのリソースフラグを指定するのに使います。以下に値を示します。

値	説明
lrNone	特定のリソースフラグがない
lrDefaultColor	ディスプレイの色形式を使う
lrDefaultSize	GetResource への Width パラメータが 0 ならば，Height と Width にシステムメトリックスを使う。Width パラメータが 0 でこのオプションをカーソルとアイコン用に指定しなかった場合，リソースの幅と高さが使われる
lrFromFile	指定したファイルからリソースをロードする
lrMap3DColors	イメージの灰色の陰影を 3 次元ウィンドウカラーに置き換える
lrTransparent	リソースの第 1 ピクセルのカラーテーブルエントリをデフォルトのウィンドウカラー（COLOR_WINDOW）で置き換える。これはカラーテーブルを持つイメージだけに適用される
lrMonoChrome	リソースをモノクロとしてロードする


TLocale 型
TLocale 型3425138

ユニット

DB

TLocale 型は，Locale または DBLocale プロパティの型。BDE の直接呼び出しに使います。

type TLocale = Pointer;

説明

TLocale 型は Locale や DBLocale プロパティの型です。これらのプロパティはボーランドデータベースエンジンを直接呼び出すときだけ必要です。


TLocateOptions 型
TLocateOptions 型3425139

ユニット

DB

TLocateOptions 型は，TTable，TQuery，および TStoredProc の Locate メソッドの Options パラメータで使う値を定義します。

type

TLocateOption = (loCaseInsensitive, loPartialKey);

TLocateOptions = set of TLocateOption;

説明

TLocateOptions 型は TTable, TQuery, TStoredProc の各コンポーネントの Locate メソッドの Options パラメータに指定できる値を定義します。次の表に TLocateOptions 型の値の説明を示します。

値	説明
loCaseInsensitive	キー設定項目とキー値は大文字と小文字の区別なしで一致する
loPartialKey	キー値にはキー設定項目値の一致部分だけ含むことができる。たとえば，HAM は HAMM にも HAMMER にも一致する


TLockType 型
TLockType 型3425140

参照

ユニット

DBTables

TLockType 型は，TTable の LockTable メソッドおよび UnlockTable メソッドのパラメータを定義します。

type

TLockType = (ltReadLock, ltWriteLock);

説明

TLockType は，次の表で定義されているように，TTable の LockTable メソッドと UnlockTable メソッドのパラメータに可能な値を定義します。

値	説明
ltReadLock	ほかのプロセスは，テーブルへ書き込みロックをかけられない。dBASE テーブルと SQL テーブルの場合，ltReadLock は ltWriteLock に相当する
ltWriteLock	ほかのプロセスは，テーブルへどのロックもかけられない


TMbcsByteType 型
TMbcsByteType 型3425141

参照

ユニット

SysUtils

TMbcsByteType 型は 2 バイト文字セット（DBCS）文字列内の各バイトのタイプを表します。

 type TMbcsByteType = (mbSingleByte, mbLeadByte, mbTrailByte);

説明

TMbcsByteType は ByteType 関数および StrByteType 関数の戻り値を表します。以下に値を示します。

値	説明
mbSingleByte	ANK 文字，すなわち ASCII 文字もしくは半角カタカナである
mbLeadByte	2 バイト文字の第 1 バイトである。この文字は LeadBytes セットに含まれている
mbTrailByte	2 バイト文字の第 2 バイトである


TMemoryManager 型
TMemoryManager 型3425142

参照

ユニット

System

TMemoryManager 型は，GetMemoryManager および SetMemoryManager のメモリブロックを定義します。

type

PMemoryManager = ^TMemoryManager;

TMemoryManager = record

GetMem: function(Size: Integer): Pointer;

FreeMem: function(P: Pointer): Integer;

ReallocMem: function(P: Pointer; Size: Integer): Pointer;

end;

説明

TMemoryManager 型は GetMemoryManager 手続きと SetMemoryManager 手続きで使われます。


TMenuBreak 型
TMenuBreak 型3425143

ユニット

Menus

TMenuBreak 型は，メニュー項目の Break プロパティがとりうる値を定義します。

type TMenuBreak = (mbNone, mbBreak, mbBarBreak);

説明

TMenuBreak 型はメニュー項目の Break プロパティに使える値を定義します。以下に値を示します。

値	説明
mbNone	メニューを分割しない
mbBarBreak	メニューを分割して別の列を作成し，新しい列の最上部にメニュー項目を表示する。古い列と新しい列をバーで区切る
mbBreak	メニューを分割して別の列を作成し，新しい列の最上部にメニュー項目を表示する。古い列と新しい列をスペースで区切る


TMethod 型
TMethod 型3425144

ユニット

SysUtils

TMethod 型は，Code および Data fields を Pointer 型として格納するレコードの型です。

type

TMethod = record

Code, Data: Pointer;

end;

説明

Code フィールドと Data フィールドを Pointer 型として格納するレコードを宣言します。

TMethod 型は，メソッドポインタのコード部とデータ部にアクセスするための，メソッドポインタの型キャストに使うことができます。


TModalResult 型
TModalResult 型3425145

ユニット

Forms

TModalResult 型は，ModalResult からの結果を示すように定義されます。

type TModalResult = Low(Integer)..High(Integer);

説明

TModalResult 型は ModalResult プロパティの型です。


TMouseButton 型
TMouseButton 型3425146

参照

ユニット

Controls

TMouseButton 型は，マウスイベントハンドラが使うマウスボタン定数を定義します。

type TMouseButton = (mbLeft, mbRight, mbMiddle);

説明

TMouseButton 型はマウスイベントを生成したボタンを区別するためにマウスイベントハンドラによって使われるマウスボタン定数を定義します。


TMPBtnType 型
TMPBtnType 型3425147

ユニット

MPlayer

TMPBtnType 型は，TMediaPlayer コンポーネントのボタンを定義します。

type TMPBtnType = (btPlay, btPause, btStop, btNext, btPrev, btStep, btBack, btRecord, btEject);

説明

ボタンは，ColoredButtons, EnabledButtons，および VisibleButtons プロパティの TButtonSet 型のセットに含まれます。TMPBtnType は，メディアプレーヤの OnClick イベントと OnPostClick イベントの Button パラメータにも使われます。以下に，押されるボタン，それらの関連値，および結果動作を示します。

ボタン	値	動作
Play	btPlay	メディアプレーヤーを再生する
Record	btRecord	録音を開始する
Stop	btStop	再生または録音を停止する
Next	btNext	次のトラックまでスキップする。トラックを使っていないメディアの場合は最後までスキップする
Prev	btPrev	直前のトラックまでスキップする。トラックを使っていないメディアの場合は先頭までスキップする
Step	btStep	数フレームだけ前方に移動する
Back	btBack	数フレームだけ後方に移動する
Pause	btPause	再生または録音を一時停止する。クリックしたときにすでに停止していれば，再生または録音を再開する
Eject	btEject	媒体をイジェクトする


TMPDevCapsSet 型
TMPDevCapsSet 型3425148

ユニット

MPlayer

TMPDevCapsSet 型は，TMediaPlayer で使われるオープンマルチメディアデバイスの機能を定義します。

type

TMPDevCaps = (mpCanStep, mpCanEject, mpCanPlay, mpCanRecord, mpUsesWindows);

TMPDevCapsSet = set of TMPDevCaps;

説明

TMPDevCapsSet 型は TMediaPlayer コンポーネントで使われるオープンマルチメディアデバイスの機能のセットです。TMPDevCapsSet は Capabilities プロパティの型です。以下に値を示します。

値	機能
mpCanEject	メディアをイジェクトする
mpCanPlay	メディアを再生する
mpCanRecord	メディアに記録する
mpCanStep	メディアの先送りまたは巻き戻し
mpUsesWindows	ウィンドウに出力を表示する


TMPDeviceTypes 型
TMPDeviceTypes 型3425149

ユニット

MPlayer

TMPDeviceTypes 型は，TMediaPlayer コンポーネントが使うマルチメディアデバイスタイプを示します。

type

TMPDeviceTypes = (dtAutoSelect, dtAVIVideo, dtCDAudio, dtDAT, dtDigitalVideo, dtMMMovie, dtOther, dtOverlay, dtScanner, dtSequencer, dtVCR, dtVideodisc, dtWaveAudio);

説明

TMPDeviceTypes 型には TMediaPlayer コンポーネントでオープンできるマルチメディアデバイスタイプが格納されます。TMPDeviceTypes は DeviceType プロパティの型です。


TMPModes 型
TMPModes 型3425150

ユニット

MPlayer

TMPModes 型は，TMediaPlayer コンポーネントが使うデバイスのモードを定義します。

type

TMPModes = (mpNotReady, mpStopped, mpPlaying, mpRecording, mpSeeking, mpPaused, mpOpen);

説明

TMPModes 型は TMediaPlayer コンポーネントで使われるマルチメディアデバイスのモードを定義します。TMPModes は Mode プロパティの型です。以下に値を示します。

値	モード
mpNotReady	準備中
mpStopped	停止
mpPlaying	再生中
mpRecording	録音中
mpSeeking	検索中
mpPaused	一時停止
mpOpen	オープン


TMPNotifyValues 型
TMPNotifyValues 型3425151

ユニット

MPlayer

TMPNotifyValues 型は，TMediaPlayer で使われるデバイスが通知する値を定義します。

type TMPNotifyValues = (nvSuccessful, nvSuperseded, nvAborted, nvFailure);

説明

TMPNotifyValues 型は TMediaPlayer コンポーネントで使われるマルチメディアデバイスが通知する値を定義します。TMPNotifyValues は NotifyValue プロパティの型です。以下に値を示します。

値	結果
nvSuccessful	コマンドが正常終了した
nvSuperseded	コマンドが別のコマンドに打ち消された
nvAborted	コマンドが手動で強制終了された
nvFailure	コマンドが失敗した


TMPTimeFormats 型
TMPTimeFormats 型3425152

ユニット

MPlayer

TMPTimeFormats 型は，TMediaPlayer で使われるデバイスが使う時刻形式を定義します。

type

TMPTimeFormats = (tfMilliseconds, tfHMS, tfMSF, tfFrames, tfSMPTE24, tfSMPTE25, tfSMPTE30, tfSMPTE30Drop, tfBytes, tfSamples, tfTMSF);

説明

TMPTimeFormats 型は TMediaPlayer コンポーネントで使われるマルチメディアデバイスの時刻形式を定義します。TMPTimeFormats は TimeFormat プロパティの型です。以下に値を示します。

値	時刻形式	データ値
tfMilliseconds	ミリ秒は 4 バイトの整数型変数として格納される
tfHMS	4 バイト整数にパックされた時，分，秒。最下位バイトから最上位バイトまでのデータ値は右のとおり	時（最下位バイト），分，秒，未使用（最上位バイト）
tfMSF	4 バイト整数にパックされた分，秒，フレーム。最下位バイトから最上位バイトまでのデータ値は右のとおり	分（最下位バイト），秒，フレーム，未使用（最上位バイト）
tfFrames	フレームは 4 バイトの整数型変数として格納される
tfSMPTE24	24 フレーム SMPTE は値を 4 バイト変数にパックする。最下位バイトから最上位バイトまでのデータ値は右のとおり	時（最下位バイト），分，秒，フレーム（最上位バイト）。SMPTE（Society of Motion Picture and Television Engineers）時間は時，分，秒，フレームで表現される絶対時刻形式である。標準 SMPTE 除算型の場合，1 秒当たりのフレーム数は 24，25，30 である
tfSMPTE25	25 フレーム SMPTE はデータを 24 フレーム SMPTE と同じ順番で 4 バイト変数にパックする
tfSMPTE30	30 フレーム SMPTE はデータを 24 フレーム SMPTE と同じ順番で 4 バイト変数にパックする
tfSMPTE30Drop	30 ドロップフレーム SMPTE はデータを 24 フレーム SMPTE と同じ順番で 4 バイト変数にパックする
tfBytes	バイトは 4 バイトの整数型変数として格納される
tfSamples	サンプルは 4 バイトの整数型変数として格納される
tfTMSF	トラック，分，秒，フレームは 4 バイト変数にパックされる。最下位バイトから最上位バイトまでのデータ値は右のとおり	トラック（最下位バイト），分，秒，フレーム（最上位バイト）。MCI では連続トラック番号になることに注意する


TMsgDlgButtons 型
TMsgDlgButtons 型3425153

ユニット

Dialogs

TMsgDlgButtons 型は，MessageDlg および MessageDlgPos が使う値のセットを定義します。

type

TMsgDlgBtn = (mbYes, mbNo, mbOK, mbCancel, mbAbort, mbRetry, mbIgnore, mbAll, mbHelp);

TMsgDlgButtons = set of TMsgDlgBtn;

説明

TMsgDlgButtons 型はメッセージボックス内のボタンに使える値のセットを定義します。TMsgDlgButtons 型は MessageDlg 関数と MessageDlgPos 関数で使われます。以下に値を示します。

値	説明
mbYes	文字列 はい(Y) が表示されているボタン
mbNo	文字列 いいえ(N) が表示されているボタン
mbOK	文字列 OK が表示されているボタン
mbCancel	文字列 キャンセル が表示されているボタン
mbHelp	文字列 ヘルプ(H) が表示されているボタン
mbAbort	文字列 中止(A) が表示されているボタン
mbRetry	文字列 再試行(R) が表示されているボタン
mbIgnore	文字列 無視(I) が表示されているボタン
mbAll	文字列 すべて が表示されているボタン


TMsgDlgType 型
TMsgDlgType 型3425154

ユニット

Dialogs

TMsgDlgType 型は，メッセージボックスの種類を表す値を定義します。

type TMsgDlgType = (mtWarning, mtError, mtInformation, mtConfirmation, mtCustom);

説明

TMsgDlgButtons 型はメッセージボックス内のボタンに使える値のセットを定義します。TMsgDlgButtons 型は MessageDlg 関数と MessageDlgPos 関数で使われます。以下に値を示します。

値	説明
mtWarning	黄色の感嘆符が表示されているメッセージボックス
mtError	赤色の停止のマークが表示されているメッセージボックス
mtInformation	青色の i が表示されているメッセージボックス
mtConfirmation	緑色の疑問符が表示されているメッセージボックス
mtCustom	ビットマップがないメッセージボックス。メッセージボックスのキャプションにはアプリケーションの実行可能ファイルの名前が表示されている


TNavigateBtn 型
TNavigateBtn 型3425155

ユニット

DBCtrls

TNavigateBtn 型は，TButtonSet，ENavClick 型および Click メソッドで使う値を定義します。

type

TNavigateBtn = (nbFirst, nbPrior, nbNext, nbLast, nbInsert, nbDelete, nbEdit, nbPost, nbCancel, nbRefresh);

説明

TNavigateBtn 型は TButtonSet 型で使える値を定義します。Click メソッドと ENavClick 型でも使われます。以下に値を示します。

ボタン	値	動作
First	nbFirst	最初のレコードに移動する
Prior	nbPrior	前のレコードに移動する
Next	nbNext	次のレコードに移動する
Last	nbLast	最後のレコードに移動する
Insert	nbInsert	空白のレコードに挿入する
Delete	nbDelete	カレントレコードを削除する
Edit	nbEdit	カレントレコードの編集を許可する
Post	nbPost	カレントレコードを通知する
Cancel	nbCancel	現在の編集を取り消す
Refresh	nbRefresh	データセット内のデータを再度取り出す


TNodeAttachMode 型
TNodeAttachMode 型3425156

ユニット

ComCtrls

TNodeAttachMode 型は，MoveTo メソッドに渡されて，項目を再アタッチする方法を指定します。

type TNodeAttachMode = (naAdd, naAddFirst, naAddChild, naAddChildFirst, naInsert);

説明

TNodeAttachMode 型は項目をツリービューコントロールに結び付けるのに使える方法のセットです。この型の変数はツリービューの MoveTo メソッドに渡されて，ツリービューで項目が移動したときに，移動先のノードと項目をどのように結び付けるか（再アタッチするか）を指定します。以下に値を示します。

値	説明
naAdd	項目をリストの末尾に追加する
naAddFirst	項目をリストの先頭に追加する
naAddChild	項目をターゲットの子として子項目のリストの末尾に追加する
naAddChildFirst	項目をターゲットの子項目としてリストの先頭に追加する
naInsert	項目をターゲットノードの後に挿入する


TNotifyEvent 型
TNotifyEvent 型3425157

ユニット

Classes

TNotifyEvent 型は，パラメータを要求しないイベントが使います。

type TNotifyEvent = procedure (Sender: TObject) of object;

説明

TNotifyEvent 型はパラメータを持たないイベントの型です。これらのイベントは特定のイベントが発生したことをコンポーネントに単に通知するだけです。たとえば，OnClick は TNotifyEvent 型ですが，クリックイベントがコントロール上で発生したことをコントロールに通知します。


TNumberingStyle 型
TNumberingStyle 型3425158

ユニット

ComCtrls

TNumberingStyle 型は，TParaAttributes の Numbering プロパティの値を定義します。

type TNumberingStyle = (nsNone, nsBullet);

説明

TNumberingStyle 型は TParaAttributes オブジェクトの Numbering プロパティに指定できる値を定義します。TParaAttributes は TRichEdit コンポーネントの Paragraph プロパティの型です。以下に値を示します。

値	説明
nsNone	左側をインデントしない
nsBullet	黒丸スタイルのナンバリングを指定する。黒丸用に十分なインデントを施す


TNumGlyphs 型
TNumGlyphs 型3425159

ユニット

Buttons

TNumGlyphs 型は，TBitBtn または TSpeedButton の NumGlyphs プロパティの値の範囲を定義します。

type TNumGlyphs: 1..4;

説明

TNumGlyphs 型はビットマップボタン（TBitBtn）またはスピードボタン（TSpeedButton）の NumGlyphs プロパティの値の範囲（1-4）を定義します。


TObjectState 型
TObjectState 型3425160

参照

ユニット

OleCtnrs

TObjectState 型は，TOleContainer の State プロパティの値を定義します。

type

TObjectState = (osEmpty, osLoaded, osRunning, osOpen, osInPlaceActive, osUIActive);

説明

TObjectState 列挙型は，次の表で定義されているように，TOleContainer の State プロパティに可能な値を定義します。

値	説明
osEmpty	コンテナに OLE オブジェクトがない
osLoaded	コンテナに OLE オブジェクトがあるが，そのサーバーアプリケーションが現在実行中でない
osRunning	OLE オブジェクトのサーバーが実行中である
osOpen	OLE オブジェクトが別のウィンドウで開いている
osInPlaceActive	OLE オブジェクトがインプレースアクティベーション状態であるが，そのメニューまたはツールバーをまだマージしていない。これは中間的な状態で，State プロパティはメニューまたはツールバーがマージされるとすぐに osUIActive に移る
osUIActive	OLE オブジェクトがインプレースアクティベーション状態であり，メニューとツールバーがマージされている


TOpenOptions 型
TOpenOptions 型3425161

ユニット

Dialogs

TOpenOptions 型は，TOpenDialog の Options プロパティの値を定義します。

type

TOpenOption = (ofReadOnly, ofOverwritePrompt, ofHideReadOnly, ofNoChangeDir, ofShowHelp, ofNoValidate, ofAllowMultiSelect, ofExtensionDifferent, ofPathMustExist, ofFileMustExist, ofCreatePrompt, ofShareAware, ofNoReadOnlyReturn, ofNoTestFileCreate, ofNoNetworkButton, ofNoLongNames, ofOldStyleDialog, ofNoDereferenceLinks);

TOpenOptions = set of TOpenOption;

説明

TOpenOptions 型は［ファイルを開く］ダイアログボックス（TOpenDialog）の Options プロパティに使える値のセットを定義します。以下に値を示します。

値	説明
ofAllowMultiSelect	True ならば，ユーザーは［ファイル名(N)］リストボックスで複数のファイルを選択できる
ofCreatePrompt	True ならば，ユーザーが存在しないファイル名を［ファイル名(N)］編集ボックスに入力して［OK］を選択するとメッセージダイアログボックスが表示される。メッセージはファイルが存在しないことをユーザーに知らせ，その名前で新しいファイルを作成するかどうかをユーザーに訪ねる
ofExtensionDifferent	このオプションはデフォルトのファイル拡張子（つまり DefaultExt プロパティ値）と異なる拡張子が付いたファイル名をダイアログボックスが返したときに設定される。この情報はアプリケーションで使う。オブジェクトインスペクタで ofExtensionDifferent 値を設定しても意味はない
ofFileMustExist	True ならば，存在しないファイル名を［ファイル名(N)］編集ボックスに入力して［OK］ボタンを選択するとメッセージダイアログボックスが表示される。メッセージはファイルが見つからないことをユーザーに知らせ，正しいパスとファイル名を入力するようにユーザーに求める
ofHideReadOnly	True ならば，［上書き禁止(R)］チェックボックスがダイアログボックスの中に表示されない
ofNoChangeDir	True ならば，カレントディレクトリはダイアログボックスが最初に表示されたときのカレントディレクトリになり，ユーザーがダイアログボックスを使用中に実行したディレクトリ変更は無視される
ofNoDereferenceLinks	True ならば，選択されたショートカット（.LNK）ファイルのパスとファイル名を返す。この値を指定しないと，ダイアログボックスはショートカットによって参照されるファイルのパスとファイル名を返す
ofNoLongNames	長いファイル名ではなく，短縮されたファイル名が［ファイル名(N)］リストボックス表示される。ofOldStyleDialog が True の場合はこの値は無視される
ofNoNetworkButton	True ならば，［Network］ボタンを非表示に，使用不可にする
ofNoReadOnlyReturn	True ならば，選択したファイルが読み出し専用かどうかユーザーに知らせるメッセージボックスが表示される
ofNoTestFileCreate	このオプションはファイルの作成しか許されていない（いったんファイルを閉じると再び開くことができない）環境で使う。ofNoTestFileCreate が True の場合，アプリケーションはファイル保存時に書き込み禁止かどうか，ディスクがいっぱいかどうか，ドライブのドアが開いていないか，ネットワークが保護されていないかを検査しない。そのような検査ではテストファイルが作成されてしまうからである。アプリケーションでのファイル操作は，ファイルを本当に閉じたいときまで閉じないように慎重に処理しなくてはならない
ofNoValidate	True ならば，ユーザーはファイル名の中に無効な文字でも使える。ofNoValidate が False ならば，ユーザーが［ファイル名(N)］編集ボックスにファイル名として無効な文字を入力すると，ファイル名に無効な文字が入っていることを知らせるメッセージダイアログボックスが表示される
ofOldStyleDialog	このオプションがあれば，［ファイルを開く］ダイアログボックスと［ファイル名を付けて保存］ダイアログボックスを Windows 3.1 や NT のスタイルで描画できる
ofOverwritePrompt	True ならば，ユーザーがすでに存在するファイルを保存しようとするとメッセージダイアログボックスが表示される。メッセージはそのファイルが存在することをユーザーに知らせ，ユーザーは既存のファイルを上書きするかどうかを選択する
ofReadOnly	True ならば，ダイアログボックスが表示されたときに［上書き禁止(R)］チェックボックスにチェックマークが付く
ofPathMustExist	True ならば，ユーザーは［ファイル名(N)］編集ボックスにファイル名の一部として既存のパス名だけを入力できる。存在しないパス名を入力すると，そのパス名が無効であることを知らせるメッセージボックスが表示される
ofShareAware	True ならば，ダイアログボックスはすべての共有エラーを無視し，共有違反が起きた場合でも選択されたファイルの名前を返す。ofShareAware が False ならば，共有違反が起きるとユーザーに問題を知らせるメッセージボックスが表示される
ofShowHelp	True ならば，［ヘルプ(H)］ボタンがダイアログボックスの中に表示される


TOutlineOptions 型
TOutlineOptions 型3425162

ユニット

Outline

TOutlineOptions 型は，TOutline コンポーネントの表示オプションを定義します。

type
TOutlineOption = (ooDrawTreeRoot, ooDrawFocusRect,
ooStretchBitmaps);

TOutlineOptions = set of TOutlineOption:;

説明

TOutlineOptions 型は TOutline コンポーネントの表示オプションを決めます。TOutlineStyle は Options プロパティの型です。以下に値を示します。

値	説明
ooDrawTreeRoot	最初の項目（インデックス値が 1）はアウトラインツリーによってルート項目に接続される。つまり，ツリーがアウトラインのトップから最初のレベルのすべての項目に拡張されるのである。ooDrawTreeRoot がないと，最初のレベルの項目はアウトラインの左端に表示され，ツリーで接続されない
ooDrawFocusRect	アウトラインは選択された項目の周りにフォーカス四角形を描画する
ooStretchBitmaps	アウトラインが，項目のサイズ（Text の Font サイズで決まる）に合わせて標準ビットマップ（PictureLeaf，PictureOpen，PictureClosed，PicturePlus，PictureMinus）を伸縮する。ooStretchBitmap がないと，ビットマップは伸縮されない。項目のテキストの高さより大きい場合，ビットマップは余分な部分が切り取られ，テキストより小さい場合は項目のスペース全体を満たせない


TOutlineStyle 型
TOutlineStyle 型3425163

ユニット

Outline

TOutlineStyle 型は，Style が osStandard に設定されているときの TOutline コンポーネントの描画スタイルを定義します。

type

TOutlineStyle = (osText, osPlusMinusText, osPictureText, osPlusMinusPictureText,osTreeText, osTreePictureText);

説明

TOutlineStyle 型は Style プロパティが osStandard に設定されている場合，TOutline コンポーネントの項目を描画する方法を決めます。TOutlineStyle は OutlineStyle プロパティの型です。以下に値を示します。

値	説明
osPictureText	オープン画像 (PictureOpen で指定されたもの)，クローズ画面 (PictureClosed で指定されたもの)，リーフ画面 (PictureLeaf で指定されたもの)，項目テキスト (Text で指定されたもの) を表示する
osPlusMinusPictureText	(+)正符号画像 (PicturePlus で指定されたもの)，(-)負符号画像 (PictureMinus で指定されたもの)，オープン画像，クローズ画像，リーフ画像，項目テキストを表示する
osPlusMinusText	(+)正符号画像，(-)負符号画像，項目テキストを表示する
osText	項目テキストを表示する
osTreePictureText	アウトラインツリー，オープン画像，クローズ画像，リーフ画像，項目テキストを表示する
osTreeText	アウトラインツリーと項目テキストを表示する


TOutlineType 型
TOutlineType 型3425164

ユニット

Outline

TOutlineType 型は，TOutline の Style プロパティを定義します。

type TOutlineType = (otStandard, otOwnerDraw);

説明

TOutlineType 型は TOutline コンポーネントが標準方法で描画するのか，それともその項目を描画するコードを作成する必要があるのかを決めます。TOutlineType は Style プロパティの型です。以下に値を示します。

値	説明
otStandard	項目は OutlineStyle の設定に従って描画される
otOwnerDraw	項目はコードによって Canvas 上に描画される


TOverlay 型
TOverlay 型3425165

ユニット

Controls

TOverlay 型は，オーバーレイマスクのインデックスです。

type TOverlay = 0..3;

説明

TImageList は，ほかのイメージの上に透過的に表示できる 4 つまでのイメージのリストを保持します。TImageList の DrawOverlay メソッドと Overlay メソッドは TOverlay のインデックスを使ってこのリストにアクセスします。


TOwnerDrawState 型
TOwnerDrawState 型3425166

ユニット

StdCtrls

TOwnerDrawState 型は，TDrawItemEvent の State パラメータの値を定義します。

type TOwnerDrawState = set of (odSelected, odGrayed, odDisabled, odChecked, odFocused);

説明

TOwnerDrawState 型はオーナー描画リストボックスの TDrawItemEvent メソッドポインタの State パラメータに指定できる値を定義します。以下に値を示します。

値	説明
odSelected	項目は選択されている
odDisabled	リストボックス全体が使用不可になっている
odFocused	項目に現在のフォーカスが当たっている


TPackageInfoProc 型
TPackageInfoProc 型3425167

参照

ユニット

SysUtils

TPackageInfoProc 型は，GetPackageInfo 手続きへのパラメータ型として使われるコールバック手続きを指すポインタです。

type

TNameType = (ntContainsUnit, ntRequiresPackage);

TPackageInfoProc = procedure (const Name: string; NameType: TNameType; Flags: Byte; Param: Pointer);

説明

TPackageInfoProc 型は GetPackageInfo 手続きに指定されているコールバックの型です。Name はパッケージ要素の実際の名前です。NameType が ntContainsUnit の場合，Name は含まれているユニットの名前です。NameType が ntRequiresPackage の場合，Name は要求されるパッケージの名前です。Flags はパッケージの情報テーブルにリストされているフラグです。Param は GetPackageInfo に渡される値です。

TNameType は TPackageInfoProc 型の NameType パラメータの型です。以下に TNameType の値を示します。

値

ntContainsUnit

ntRequiresPackage


TPanelBevel 型
TPanelBevel 型3425168

ユニット

StdCtrls

TPanelBevel 型は，BevelInnerプロパティ および BevelOuter プロパティの値を定義します。

type TPanelBevel = (bvNone, bvLowered, bvRaised);

説明

TPanelBevel 型は BevelInner プロパティと BevelOuter プロパティに使える値を定義します。以下に値を示します。

値	説明
bvNone	内部ベベルなし
bvLowered	内部ベベルを陥没させる
bvRaised	内部ベベルを隆起させる


TParamBindMode 型
TParamBindMode 型3425169

ユニット

DBTables

TParamBindMode 型は，TStoredProc の PramBindMode プロパティの値を定義します。

type TParamBindMode = (pbByName, pbByNumber);

説明

TParamBindMode 型はストアドプロシージャ（TStoredProc）の ParamBindMode プロパティで使える値を定義します。以下に値を示します。

値	説明
pbByName	パラメータはストアドプロシージャでの名前に基づいて結び付けられる
pbByNumber	パラメータはストアドプロシージャ内で定義されている順番に基づいて結び付けられる


TParamType 型
TParamType 型3425170

ユニット

DBTables

TParamType 型は，TParam オブジェクトの ParamType プロパティの値を設定します。

type TParamType = (ptUnknown, ptInput, ptOutput, ptInputOutput, ptResult);

説明

TParamType 型は TParam オブジェクトの ParamType プロパティの値のセットです。以下に値を示します。

値	説明
ptUnknown	サーバーがパラメータ型を識別しなかった。ストアドプロシージャを実行する前に，アプリケーションはこの型のパラメータを変更しなければならない
ptInput	処理用に値をストアドプロシージャに渡すために使われるパラメータを識別する
ptOutput	値をアプリケーションに返すためにストアドプロシージャによって使われるパラメータを識別する
ptInputOutput	処理用に値をストアドプロシージャに渡し，またストアドプロシージャからアプリケーションに値を返すために使われるパラメータを識別する
ptResult	エラーまたは状態値を返すためにストアドプロシージャによって使われるパラメータを識別する。ストアドプロシージャは ptResult 型のパラメータを 1 つだけ持つことができる
通常，Delphi はこのプロパティを設定しますが，サーバーが必要な情報を提供しない場合は開発者が設定します。


TPaymentTime 型
TPaymentTime 型3425171

ユニット

Math

TPaymentTime 型は，財務関数のパラメータとして使われる列挙型です。

type TPaymentTime = (ptEndOfPeriod, ptStartOfPeriod);

説明

TPaymentTime は財務関数でパラメータとして使われる列挙型です。たとえば，利子が支払い期首残高の原則に基づいて計算される場合は，ptStartOfPeriod を渡します。以下に値を示します。

値	説明
ptStartOfPeriod	利子が支払い期首残高の原則に基づいて計算される
ptEndOfPeriod	利子が支払い期末に計算される


TPenMode 型
TPenMode 型3425172

ユニット

Graphics

TPenMode 型は，TPen の Mode プロパティの値を指定します。

type

TPenMode = (pmBlack, pmWhite, pmNop, pmNot, pmCopy, pmNotCopy,pmMergePenNot, pmMaskPenNot, pmMergeNotPen, pmMaskNotPen, pmMerge,pmNotMerge, pmMask, pmNotMask, pmXor, pmNotXor);

説明

TPenMode 型はペンオブジェクト（TPen）の Mode プロパティに使える値を指定します。以下に値を示します。

モード	ピクセルの色
pmBlack	必ず黒
pmWhite	必ず白
pmNop	変化なし
pmNot	画面の色の反転
pmCopy	Color プロパティで指定するペン色
pmNotCopy	ペン色の反転色
pmMergePenNot	ペン色と画面反転色の組み合わせ
pmMaskPenNot	ペン色と画面反転色のどちらにも共通な色の組み合わせ
pmMergeNotPen	画面色とペン反転色の組み合わせ
pmMaskNotPen	画面色とペン反転色のどちらにも共通な色の組み合わせ
pmMerge	ペン色と画面色の組み合わせ
pmNotMerge	ペン色と画面色の pmMerge 組み合わせの反転
pmMask	ペン色と画面色のどちらにも共通な色の組み合わせ
pmNotMask	ペン色と画面のどちらにも共通な pmMask 組み合わせの反転
pmXor	ペンまたは画面の（両方ではなく）どちらかの色の組み合わせ
pmNotXor	ペン色または画面色の（両方ではなく）どちらかの色の pmXor 組み合わせの反転


TPenStyle 型
TPenStyle 型3425173

ユニット

Graphics

TPenStyle 型は，TPen の Style プロパティの値を指定します。

type

TPenStyle = (psSolid, psDash, psDot, psDashDot, psDashDotDot, psClear, psInsideFrame);

説明

TPenStyle 型はペンオブジェクト（TPen）の Style プロパティに使える値を指定します。以下に値を示します。

スタイル	説明
psSolid	実線を描画する
psDash	破線を描画する
psDot	点線を描画する
psDashDot	一点鎖線を描画する
psDashDotDot	二点鎖線を描画する
psClear	不可視のマークからなる線を描画する
psInsideFrame	外接長方形を指定する閉じた図形の枠内に線を描画する


TPoint 型
TPoint 型3425174

ユニット

Windows

TPoint 型は，画面上のピクセル位置を定義します。

type TPoint = record

X: Longint;

Y: Longint;

end;

説明

TPoint 型は原点を左上隅にして，画面上のピクセル位置を定義します。X は点の水平座標を指定し，Y は垂直座標を指定します。


TPopupAlignment 型
TPopupAlignment 型3425175

ユニット

Menus

TPopupAlignment 型は，TPopupMenu が表示される位置を決めます。

type TPopupAlignment = (paLeft, paRight, paCenter);

説明

PopupAlignment 型はポップアップメニュー（TPopupMenu）を表示する位置を決めます。ポップアップメニューの Alignment プロパティは TPopupAlignment 型です。以下に値を示します。

値	説明
paLeft	マウスポインタの下にポップアップメニューの左上がくるように表示する
paCenter	マウスポインタの下にポップアップメニューの最上部中央がくるように表示する
paRight	マウスポインタの下にポップアップメニューの右上がくるように表示する


TPosition 型
TPosition 型3425176

ユニット

Forms

TPosition 型は，フォームの Position プロパティの値を列挙します。

type

TPosition = (poDesigned, poDefault, poDefaultPosOnly, poDefaultSizeOnly, poScreenCenter);

説明

TPosition 型はフォームの Position プロパティに使える値を列挙します。以下に値を示します。

値	説明
poDesigned	フォームは設計時と同じ画面上の位置，高さ，幅で表示される
poDefault	フォームは Windows が決める画面上の位置，高さ，幅で表示される。フォームはアプリケーションを起動するたびに少しずつ右下へ移動する。画面の解像度に関係なくフォームの右側は常に画面の右端に近く，フォームの下端は常に画面の下端に近くなる
poDefaultPosOnly	フォームは設計時にフォームを作成したサイズで表示されるが，画面上の位置は Windows が選択する。フォームはアプリケーションを起動するたびに少しずつ右下へ移動する。同じサイズのまま全体が画面上に表示されるようにフォームをそれ以上右下へ移動できなくなると，画面の左上隅にフォームが表示される
poDefaultSizeOnly	フォームは設計時の位置に表示されるが，サイズは Windows が選択する。画面の解像度に関係なくフォームの右側は常に画面の右端に近く，フォームの下端は常に画面の下端に近くなる
poScreenCenter	フォームは設計時のサイズで表示されるが，画面の中央に配置される


TPrintDialogOptions 型
TPrintDialogOptions 型3425177

ユニット

Dialogs

TPrintDialogOptions 型は，TPrintDialog の Options プロパティの値をを定義します。

type

TPrintDialogOption = (poPrintToFile, poPageNums, poSelection, poWarning, poHelp, poDisablePrintToFile);

TPrintDialogOptions = set of TPrintDialogOption;

説明

TPrintDialogOptions 型は［印刷］ダイアログボックス（TPrintDialog）の Options プロパティに使える値のセットを定義します。以下に値を示します。

値	説明
poHelp	True ならば，［ヘルプ(H)］ボタンがダイアログボックスの中に表示される
poPageNums	True ならば，［ページ指定(P)］ラジオボタンが使用可能になり，ユーザーは印刷するページ範囲を指定できる
poPrintToFile	True ならば，［ファイルへ出力(L)］チェックボックスがダイアログボックスの中に表示され，ユーザーにプリンタでなくファイルへ出力するオプションが与えられる
poSelection	True ならば，［選択した部分(E)］ラジオボタンが使用可能になり，ユーザーはテキストを選択して印刷できる
poWarning	True ならば，プリンタがインストールされていない場合にユーザーが［OK］を選択すると警告メッセージが表示される
poDisablePrintToFile	True ならば，poPrintToFile が True の場合，ダイアログボックスが表示されたときに［ファイルへ出力(L)］チェックボックスが淡色表示になる。poPrintToFile が False の場合，ダイアログボックスに［ファイルへ出力(L)］がないので poDisablePrintToFile を True に設定しても効果はない


TPrinterOrientation 型
TPrinterOrientation 型3425178

ユニット

Printers

TPrinterOrientation 型は，TPrinter の Orientation プロパティの値を定義します。

type TPrinterOrientation = (poPortrait, poLandscape);

説明

TPrinterOrientation 型はプリンタオブジェクト（TPrinter）の Orientation プロパティに使える値を定義します。

値	説明
poPortrait	印刷ジョブでページを垂直方向に印刷する
poLandscape	印刷ジョブでページを水平方向に印刷する


TPrintRange 型
TPrintRange 型3425179

ユニット

Dialogs

TPrintRange 型は，TPrintDialog の PrintRange プロパティの値を定義します。

type TPrintRange = (prAllPages, prSelection, prPageNums);

説明

TPrintRange 型は［印刷］ダイアログボックス（TPrintDialog）の PrintRange プロパティに使える値を定義します。

値	説明
prAllPages	実行時に設定された場合，ユーザーは印刷ジョブのすべてのページの印刷を選択した。設計時に PrintRange 値を prAllPages に設定すると，［印刷］ダイアログボックスが最初に表示されたときに［すべて(A)］ラジオボタンが選択されている
prSelection	実行時に設定された場合，ユーザーは選択したテキストだけの印刷を選択した。設計時に PrintRange 値を prSelection に設定すると，［印刷］ダイアログボックスが最初に表示されたときに［選択した部分（S）］ラジオボタンが選択される
prPageNums	実行時に設定された場合，ユーザーは印刷するページ範囲の指定を選択した。設計時に PrintRange 値を prPageNum に設定すると，［印刷］ダイアログボックスが最初に表示されたときに［ページ指定(G)］ラジオボタンが選択され，ユーザーはページ番号で印刷範囲を指定できる。ページ番号は MinPage プロパティと MaxPage プロパティで設定する


TPrintScale 型
TPrintScale 型3425180

ユニット

Forms

TPrintScale 型は，フォームの PrintScale プロパティの値を定義します。

type TPrintScale = (poNone, poProportional, poPrintToFit);

説明

TPrintScale 型はフォームの PrintScale プロパティに使える値を定義します。以下に値を示します。

値	説明
poNone	画面に表示されたフォームをプリンタの解像度で印刷する
poProportional	フォームは画面上のサイズと同じサイズになるように印刷される（WYSIWYG）。フォームイメージは，印刷されるイメージが画面上に見えるサイズと同じになるように拡大/縮小される
poPrintToFit	フォームは同じ画面比率を使うが，印刷ページにちょうど収まるサイズで印刷される


TProcedure 型
TProcedure 型3425181

ユニット

SysUtils

TProcedure 型は，引数を持たない汎用手続きの型として使われます。

type TProcedure = procedure;

説明

TProcedure 型は，渡されている手続きが引数をとらない場合に多くのルーチンへのパラメータの型として使われます。


TRect 型
TRect 型3425182

ユニット

Windows

TRect 型は，長方形を定義します。

type

TPoint = record

X: Longint;

Y: Longint;

end;

TRect = record

case Integer of

0: (Left, Top, Right, Bottom: Integer);

1: (TopLeft, BottomRight: TPoint);

end;

説明

座標は上下左右の辺のピクセル位置を表す別々の 4 つの整数としてか，または左上隅と右下隅のピクセル位置を表す 2 つの点として指定されます。ピクセル座標系の原点は画面の左上隅です。


TResType 型
TResTypes 型3425183

ユニット

Controls

TResTypes 型は，ImageList のグラフィックリソースの型を指定します。

type TResType = (rtBitmap, rtCursor, rtIcon);

説明

TResTypes 型は ImageList にロードしたり，ImageList から取り出すグラフィックリソースの種類を指定するために ResourceLoad, GetResource, FileLoad などのイメージリストのメソッドで使われます。

値	説明
rtBitmap	ビットマップの読み書き
rtCursor	カーソルの読み書き
rtIcon	アイコンの読み書き


TScrollBarInc 型
TScrollBarInc 型3425184

ユニット

Forms

TScrollBarInc 型は，TScrollBar の SmallChange プロパティおよび LargeChange プロパティの値を定義します。

type TScrollBarInc = 1..32767;

説明

TScrollBarInc 型はスクロールバー（TScrollBar）の SmallChange プロパティと LargeChange プロパティに使える値を定義します。


TScrollBarKind 型
TScrollBarKind 型3425185

ユニット

Forms

TScrollBarKind 型は，スクロールバーコントロールの Kind プロパティを定義します。

type TScrollBarKind = (sbHorizontal, sbVertical);

説明

TScrollBarKind 型はスクロールバーの方向として水平方向と垂直方向の 2 つの異なる方向を定義します。TScrollBarKind はスクロールバーコントロールの Kind プロパティの型です。以下に値を示します。

値	説明
sbHorizontal	水平スクロールバー
sbVertical	垂直スクロールバー


TScrollCode 型
TScrollCode 型3425186

ユニット

StdCtrls

TScrollEvent が，スクロールバーのとりうる状態を定義するために使います。

type

TScrollCode = (scLineUp, scLineDown, scPageUp, scPageDown, scPosition, scTrack, scTop, scBottom, scEndScroll);

説明

TScrollCode 型はスクロールバーで可能な状態を定義します。スクロールバーは TScrollEvent メソッドポインタで使われます。以下に値を示します。

値	説明
scLineUp	ユーザーは上向きまたは左向きのスクロール矢印をクリックしたか，上向きの矢印キーを押した
scLineDown	ユーザーは下向きまたは右向きのスクロール矢印をクリックしたか，下向きの矢印キーを押した
scPageUp	ユーザーはスクロールボックスの上または左の領域をクリックしたか〔PgUp〕を押した
scPageDown	ユーザーはスクロールボックスの下または右の領域をクリックしたか〔PgDn〕を押した
scPosition	ユーザーはスクロールボックスを位置付けて放した
scTrack	ユーザーはスクロールボックスを位置付けた放した
scTop	ユーザーはスクロールボックスをスクロールバーの一番上または一番左に移動した
scBottom	ユーザーはスクロールボックスをスクロールバーの一番下または一番右に移動した
scEndScroll	ユーザーはスクロールボックスの移動を終えた


TScrollStyle 型
TScrollStyle 型3425187

ユニット

StdCtrls

TScrollStyle 型は，TMemo，TDBMemo，TDrawGrid，および TStringGrid のScrollBars プロパティを定義します。

type TScrollStyle = (ssNone, ssHorizontal, ssVertical, ssBoth);

説明

TScrollStyle 型はメモコントロールまたはグリッドに使えるスクロールバーのいくつかの組み合わせを定義します。TScrollStyle は TMemo, TDBMemo, TDrawGrid, TStringGrid の ScrollBars プロパティの型です。以下に値を示します。

値	説明
ssNone	スクロールバーなし
ssHorizontal	右端にスクロールバーを付ける
ssVertical	下端にスクロールバーを付ける
ssBoth	右端と下端の両方にスクロールバーを付ける


TSearchDirection 型
TSearchDirection 型3425188

ユニット

ComCtrls

TSearchDirection 型は，GetNextItem および GetNearestItem の検索方向を指定します。

type TSearchDirection = (sdLeft, sdRight, sdAbove, sdBelow, sdAll);

説明

TSearchDirection 型はリストビューコンポーネントの GetNextItem メソッドと GetNearestItem メソッドを使うときにリスト項目の検索方向を指定するのに使われます。

値	説明
sdLeft	指定のリスト項目から左へリスト項目を検索する
sdRight	指定のリスト項目から右へリスト項目を検索する
sdAbove	指定のリスト項目より上にあるリスト項目を検索する
sdBelow	指定のリスト項目より下にあるリスト項目を検索する
sdAll	インデックスにより後続のリスト項目を検索する（デフォルト値）


TSearchRec 型
TSearchRec 型3425189

ユニット

SysUtils

TSearchRec 型は，FindFirst または FindNext によって検索されるファイルの情報を定義します。

type

TFileName = string;

TSearchRec = record

Time: Integer;

Size: Integer;

Attr: Integer;

Name: TFileName;

ExcludeAttr: Integer;

FindHandle: THandle;

FindData: TWin32FindData;

end;

説明

FindFirst 関数または FindNext 関数を使って検索されるファイル情報を定義します。ファイルが見つかると，TSearchRec 型パラメータの各フィールドに見つかったファイルの情報が格納されます。

Attr はファイル属性を表します。Attr を次の属性定数または値と比較すれば，そのファイルの属性がわかります。

定数	値	説明
faReadOnly	$00000001	読み出し専用ファイル
faHidden	$00000002	非表示ファイル
faSysFile	$00000004	システムファイル
faVolumeID	$00000008	ボリュームファイル
faDirectory	$00000010	ディレクトリファイル
faArchive	$00000020	アーカイブファイル
faAnyFile	$0000003F	すべてのファイル
ファイルがある属性を持っているかどうかを調べるには，その属性定数と Attr フィールド値の論理積をとります。その属性を持っていれば，結果は 0 より大きくなります。たとえば，見つかったファイルが非表示ファイルならば，（SearchRec.Attr and faHidden > 0）の評価結果は True になります。

Time にはファイルのタイムスタンプが格納されます。Size にはファイルサイズがバイト単位で格納されます。Name には DOS のファイル名と拡張子が格納されます。FindData には，ファイル作成時刻，最終アクセス時刻，長いファイル名と短いファイル名などの追加情報が格納されます。


TSearchTypes 型
TSearchTypes 型3425190

ユニット

ComCtrls

TSearchTypes 型は，TRichEdit の FindText メソッドの Options パラメータで使う値を定義します。

type

TSearchType = set of (stWholeWord, stMatchCase);

TSearchTypes = set of TSearchType;

説明

TSearchTypes 型は TRichEdit コンポーネントの FindText メソッドの Options パラメータに設定可能な値を定義します。以下に値を示します。

値	意味
stWholeWord	ワードサーチを行う
stMachCase	大文字/小文字を区別する


TSelectDirOpts 型
TSelectDirOpts 型3425191

ユニット

FileCtrl

TSelectDirOpts 型は，SelectDirectory の Options パラメータの値を定義します。

type

TSelectDirOpt = (sdAllowCreate, sdPerformCreate, sdPrompt);

TSelectDirOpts = set of TSelectDirOpt;

説明

TSelectDirOpts 型は SelectDirectory 関数の Options パラメータに使える値を定義します。以下に値を示します。

値	説明
[ ],（空集合）	ユーザーは現在存在するディレクトリだけを選択できる。新しいディレクトリ名を入力する編集ボックスがないので，ユーザーは存在しないディレクトリを指定できない
sdAllowCreate	ダイアログボックス内に編集ボックスが表示されるので，ユーザーは存在しないディレクトリの名前も入力できる。このオプションではディレクトリは作成されないが，必要ならアプリケーションから Directory パラメータにアクセスし，選択されたディレクトリを作成できる
sdPerformCreate	Options セットに sdAllowCreate が入っているときだけ使う。存在しないディレクトリ名をユーザーが入力した場合，この関数はそのディレクトリを作成する
sdPrompt	Options セットに sdAllowCreate が入っているときだけ使う。入力されたディレクトリが存在しないことをユーザーに知らせるメッセージボックスを表示し，ユーザーにそのディレクトリを作成するかどうか訪ねる。ユーザーが［OK］を選択した場合，Options セットに sdPerformCreate 値が入っているときだけディレクトリを作成する。sdAllowCreate だけが True の場合，ディレクトリは実際には作成されないが，必要であればアプリケーションから作成できる


TShapeType 型
TShapeType 型3425192

ユニット

StdCtrls

TShapeType 型は，TShape コンポーネントの Shape プロパティを定義します。

type TShapeType = (stRectangle, stSquare, stRoundRect, stRoundSquare, stEllipse, stCircle);

説明

TShapeType 型は TShape コンポーネントを長方形，正方形，角の丸い長方形，角の丸い正方形，楕円，円として表示するかを決めるために TShape コンポーネントの Shape プロパティで使われます。以下に値を示します。

値	説明
stEllipse	図形は楕円である
stRectangle	図形は長方形である
stRoundRect	図形は角の丸い長方形である
stRoundSquare	図形は角の丸い正方形である
stSquare	図形は正方形である
stCircle	図形は円である


TShiftState 型
TShiftState 型3425193

参照

ユニット

Classes

TShiftState 型は，〔Alt〕，〔Ctrl〕，〔Shift〕の各キーおよびマウスボタンの状態を決めます。

type TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

説明

TShiftState 型は，イベントが発生したときの〔Alt〕，〔Ctrl〕，〔Shift〕の状態やマウスボタンの状態を決めるためにキーイベントハンドラとマウスイベントハンドラで使われます。以下に値を示します。

値	意味
ssShift	Shift キーが押されている
ssAlt	Alt キーが押されている
ssCtrl	Ctrl キーが押されている
ssLeft	マウスの左ボタンが押されている
ssMiddle	マウスの中央ボタンが押されている
ssDouble	マウスの左右両方のボタンが押されている


TShortCut 型
TShortCut 型3425194

ユニット

Menus

TShortCut 型は，ShortCutToText および ShortCutToKey が使うメニューショートカットです。

type TShortCut = Low(Word) .. High(Word);

説明

TShortCut 型はメニューに表示されるメニューショートカットで，キーボードでメニューコマンドを選択するための代替方法をユーザーに与えます。ShortCut プロパティは TShortCut型であり，ShortCutToText ルーチンと ShortCutToKey ルーチンは TShortCut 型のパラメータを使います。


TSizeMode 型
TSizeMode 型3425195

参照

ユニット

OLECtnrs

TSizeMode 型は，TOleContainer の SizeMode プロパティの値を定義します。

type

TSizeMode = (smClip, smCenter, smScale, smStretch, smAutoSize);

説明

TSizeMode 列挙型は，次の表で定義されているように，TOleContainer の SizeMode プロパティで可能な値を定義します。

値	説明
smClip	（デフォルト）。通常のサイズで OLE オブジェクトを表示し，コンテナ内部に収まらない部分をクリッピングする
SmCenter	通常のサイズで OLE オブジェクトを表示し，コンテナ内部で中央に位置を合わせる
SmScale	OLE の表示をコンテナ内部に収まるように拡大または縮小する（幅と高さの割合は一定に保たれる）
SmStretch	OLE の表示をコンテナ内部に収まるように拡大または縮小する（OLE オブジェクトの均整は保たれない）
SmAutoSize	smClip と同じだが，OLE オブジェクトのサイズに変更があると必ずコンテナのサイズも自動的に変更する


TSortType 型
TSortType 型3425196

ユニット

ComCtrls

TSortType 型は，リストビューコンポーネントおよびツリービューコンポーネントの SortType プロパティを定義します。

type TSortType = (stNone, stData, stText, stBoth);

説明

TSortType 型は，ツリービューコンポーネントとリストビューコンポーネントの項目をソートするのに適用できる方法を定義します。リストビューコンポーネントとツリービューコンポーネントの SortType プロパティはこの型で指定されます。以下に値を示します。

値	説明
stNone	ソートをしない
stData	Data オブジェクトまたは SortType が変更されたときに項目をソートする
stText	Caption または SortType が変更されたときに項目をソートする
stBoth	Data オブジェクト，Caption または SortType のいずれかが変更されたときに項目をソートする


TStartMode 型
TStartMode 型3425197

参照

ユニット

OLEAuto

TStartMode 型は，StartMode プロパティの値を指定し，OLE オートメーションサーバーの起動理由を示します。

type

TStartMode = (smStandalone, smAutomation, smRegServer, smUnregServer);

説明

TStartMode 型は，StartMode プロパティに可能な値を指定して，OLE オートメーションサーバーが起動した理由をそれぞれ示します。

次の表に起動モードに可能な値と，それぞれに対応するコマンドラインスイッチを示して説明します。

起動モード	スイッチ	意味
smAutomation	embedding	オートメーションコントローラからの要求に応答して Windows がアプリケーションを起動した
smRegServer	regserver	OLE サーバーをシステムレジストリに追加するためだけにアプリケーションを起動した
smStandalone	---	ユーザーがアプリケーションをスタンドアロンの対話型アプリケーションとして起動した
smUnregServer	unregserver	システムレジストリから OLE サーバーを削除するためだけにアプリケーションを起動した


TStatusPanelBevel 型
TStatusPanelBevel 型3425198

ユニット

ComCtrls

TStatusPanelBevel 型は，TStatusPanel の Bevel プロパティの値を定義します。

type TStatusPanelBevel = (pbNone, pbLowered, pbRaised);

説明

TStatusPanelBevel 型は，TStatusPanel オブジェクトの Bevel プロパティの値を定義します。TStatusPanel オブジェクトは，TStatusBar コンポーネントの個々のパネルです。以下に値を示します。

値	説明
pbNone	パネルにはベベルがなく平らに見える
pbLowered	パネルのベベルは下がっており，押し込まれたように見える
pbRaised	パネルは浮き上がって見える


TStatusPanelStyle 型
TStatusPanelStyle 型3425199

参照

ユニット

ComCtrls

TStatusPanelStyle 型は，TStatusPanel の Style プロパティを定義します。

type TStatusPanelStyle = (psText, psOwnerDraw);

説明

TStatusPanelStyle 型は，TStatusPanel オブジェクトの Style プロパティの型を定義します。TStatusPanel オブジェクトは，TStatusBar コンポーネントのパネルです。psText スタイルのパネル上にテキストを設定するには，Text プロパティを使います。psOwnerDraw スタイルのパネルはオーナー描画で，OnDrawPanel イベントハンドラを記述しなければなりません。以下に値を示します。

値	説明
psText	項目は文字列である
psOwnerDraw	項目はコードにより Canvas に描画される


TSystemTime 型
TSystemTime 型3425200

参照

ユニット

Windows

TSystemTime 型は，Windows 32 API 関数の呼び出しで日付時刻値を表すために使われる型です。

type

TSystemTime = record

wYear: Word;

wMonth: Word;

wDayOfWeek: Word;

wDay: Word;

wHour: Word;

wMinute: Word;

wSecond: Word;

wMilliseconds: Word;

end;

説明

TSystemTime を使うと，Win32 API 関数を呼び出すときに SYSTEMTIME 値を表すことができます。DateTimeToSystemTime 関数と SystemTimeToDateTime 関数を使うと，TSystemTime 値と Delphi の TDateTime 値を変換できます。


TTableType 型
TTableType 型3425201

ユニット

DBTables

TTableType 型は，TTable コンポーネントの TableType プロパティの値です。

type TTableType = (ttDefault, ttParadox, ttDBase, ttASCII);

説明

TTableType 型は TTable コンポーネントの TableType プロパティの値のセットです。TableType が ttDefault に設定されている場合，テーブルの種類は以下に示すようにファイル拡張子によって決まります。

ファイル拡張子 .DB またはファイル拡張子がない場合は Paradox テーブル

ファイル拡張子 .DBF は dBASE テーブル

ファイル拡張子 .TXT はテキストファイルのテーブル

TableType の値が ttDefault でない場合，テーブルはファイル拡張子とは関係なく，指定されたテーブルの種類になります。

ttASCII はテキストファイル

ttDBase は dBASE テーブル

ttParadox は Paradox テーブル


TTabOrder 型
TTabOrder 型3425202

ユニット

Controls

TTabOrder 型は，TabOrder の値として使える整数を定義します。

type TTabOrder = -1..32767;

説明

TTabOrder 型は TabOrder プロパティの値として使える整数の部分範囲を定義します。


TTabStyle 型
TTabStyle 型3425203

ユニット

Tabs

TTabStyle 型は，タブセットコントロールのタブのスタイルを定義します。

type TTabStyle = (tsStandard, tsOwnerDraw);

説明

TTabStyle 型はタブセットコントロールのタブのスタイルを定義します。TTabStyle はタブセットコントロールの Style プロパティの型です。以下に値を示します。

値	説明
tsStandard	タブは標準的なサイズと外観になる
tsOwnerDraw	タブは TabHeight プロパティで指定された高さになり，テキストまたはグリフを入れるのに必要な幅になる


TTextCase 型
TTextCase 型3425204

ユニット

FileCtrl

TTextCase 型は，TDriveComboBox の TextCase プロパティの値を定義します。

type TTextCase = (tcLowerCase, tcUpperCase);

説明

TTextCase 型はドライブコンボボックス（TDriveComboBox）の TextCase プロパティに使える値を定義します。以下に値を示します。

値	説明
tcLowerCase	Text プロパティに指定されたボリューム名は小文字で表示される
tcUpperCase	Text プロパティに指定されたボリューム名は大文字で表示される


TTextRec 型
TTextRec 型3425205

ユニット

SysUtils

TTextRec 型は，テキスト型変数の内部形式です。

type

PTextBuf = ^TTextBuf;

TTextBuf = array[0..127] of Char;

TTextRec = record

Handle: Integer;

Mode: Integer;

BufSize: Cardinal;

BufPos: Cardinal;

BufEnd: Cardinal;

BufPtr: PChar;

OpenFunc: Pointer;

InOutFunc: Pointer;

FlushFunc: Pointer;

CloseFunc: Pointer;

UserData: array[1..32] of Byte;

Name: array[0..259] of Char;

Buffer: TTextBuf;

end;

説明

テキスト型変数の内部形式です。この型の変数を宣言することは絶対にありません。ただし，フィールド名などの内部データフィールドにアクセスするために，TTextRec をテキストファイル変数に型キャストすることはあります。

TextBuf は TTextRec レコードの Buffer エントリの型で，使われるバッファのサイズを示します。

注意	Object Pascal テキストファイルのデバイスドライバの開発に慣れていない場合は使わないでください。


TThreadFunc 型
TThreadFunc 型3425206

参照

ユニット

System

TThreadFunc 型は，実行する新しいスレッドの開始アドレスとなるルーチンの型を定義します。

type TThreadFunc = function(Parameter: Pointer): Integer;

説明

TThreadFunc ルーチンは，Delphi ルーチン BeginThread 関数か Windows API の CreateThread 関数に渡されます。BeginThread を実行すると，TThreadFunc は新しいスレッドのエントリポイントとして機能します。

TThreadFunc ルーチンに渡される Parameter ポインタは直接 BeginThread に渡されます。Parameter には，32 ビット値か，他のデータを指す 32 ビットポインタを指定できます。Parameter の値は TTreadFunc ルーチン内部で使用できます。

TThreadFunc はスレッドのエントリポイント手続きの値を戻します。この関数の戻り値は通常 EndThread ルーチンに渡されます。アプリケーションは，Windows API の GetExitCodeThread 関数を呼び出して TThreadFunc の戻り値を取得できます。


TThreadPriority 型
TThreadPriority 型3425207

参照

ユニット

Classes

TThreadPriority 型は，TThread の Priority プロパティの値を定義します。

type

TThreadPriority = (tpIdle, tpLowest, tpLower, tpNormal, tpHigher, tpHighest, tpTimeCritical);

説明

TThreadPriority は，次の表で定義されているように，TThread コンポーネントの Priority プロパティに可能な値を定義します。Windows は優先度の段階に基づいてスレッドのスケジューリングを行います。Priority プロパティを使うと，スレッドの優先度の段階を高くしたり低くしたり調整できます。

値	説明
tpIdle	スレッドが実行されるのは，システムがアイドルのときのみ。他のスレッドが動作しているときには tpIdle のスレッドは実行されない
tpLowest	スレッドの優先度は通常よりも 2 ポイント低い
tpLower	スレッドの優先度は通常よりも 1 ポイント低い
tpNormal	スレッドは通常の優先度である
tpHigher	スレッドの優先度は通常よりも 1 ポイント高い
tpHighest	スレッドの優先度は通常よりも 2 ポイント高い
tpTimeCritical	スレッドはもっとも高い優先度を取得する


TTickMark 型
TTickMark 型3425208

ユニット

ComCtrls

TTickMark 型は，TTrackBar コンポーネントの TickMarks プロパティの値を定義します。

type TTickMark = (tmBottomRight, tmTopLeft, tmBoth);

説明

TTickMark 型は，TTrackBar コンポーネントの TickMarks プロパティとして可能な値を定義します。以下に値を示します。

値	説明
tmBottomRight	トラックバーの下側または右側に目盛りが表示される
tmTopLeft	トラックバーの上側または左側に目盛りが表示される
tmBoth	トラックバーの両側に目盛りが表示される。デフォルト設定は tmBottomRight


TTickStyle 型
TTickStyle 型3425209

ユニット

ComCtrls

TTickStyle 型は，TTrackBar コンポーネントの TickStyle プロパティの値を定義します。

type TTickStyle = (tsNone, tsAuto, tsManual);

説明

TTickStyle 型は，TTrackBar コンポーネントの TickStyle プロパティとして可能な値を定義します。以下に値を示します。

値	説明
tsAuto	トラックバーの範囲内で，単位ごとに自動的に目盛りが表示される。Frequency プロパティを使うには，このスタイルの設定をしなければならない
tsManual	トラックバーの両端にメモリが表示される。SetTick メソッドと一緒にこのスタイルを使えば，目盛りを任意の位置に設定できる
tsNone	トラックバーに目盛りは表示されない


TTileMode 型
TTileMode 型3425210

ユニット

Forms

TTileMode 型は，フォームの TileMode プロパティの値を定義します。

type TTileMode = (tbHorizontal, tbVertical);

説明

TTileMode 型はフォームの TileMode プロパティに使える値を定義します。以下に値を示します。

値	説明
tbHorizontal	各フォームは親フォームの幅の方向に広がる
tbVertical	各フォームは親フォームの高さの方向に広がる


TTimeStamp 型
TTimeStamp 型3425211

参照

ユニット

SysUtils

TTimeStamp 型は，日付時刻値を表します。

type TTimeStamp = record

Time: Integer;	{ 夜中の 0 時からのミリ秒数 }

Date: Integer;	{ 1/1/0001 から日付数プラス 1}

end;

説明

時刻部分に厳密な正確さが求められるときには TTimeStamp を使って日付時刻値を表します。時刻部分にミリ秒までの正確さが必要でない場合は，よりコンパクトな TDateTime で表します。

TTimeStamp は夜中の 0 時から経過した秒数を表す Time 項目と，カレンダーの最初からの暦日数を表す Date 項目を持つレコードです。


TTrackBarOrientation 型
TTrackBarOrientation 型3425212

ユニット

ComCtrls

TTrackBarOrientation 型は，TTrackBar の Orientation プロパティの値を定義します。

type TTrackBarOrientation = (tbHorizontal, tbVertical);

説明

TTrackBarOrientation 型は，TTrackBar コンポーネントの Orientation プロパティとして可能な値を定義します。以下に値を示します。

値	説明
tbHorizontal	TTrackBar は水平方向
tbVertical	TTrackBar は垂直方向


TTransIsolation 型
TTransIsolation 型3425213

ユニット

DBTables

TTransIsolation 型は，TransIsolation プロパティが使用。トランザクションの開始に使う値のセットです。

type TTransIsolation = (tiDirtyRead, tiReadCommitted, tiRepeatableRead);

説明

TTransIsolation 型は TransIsolation プロパティで使う，トランザクションの開始用の値のセットです。TTransIsolation 型は別のアプリケーションで変更されたレコードがサーバーからアプリケーションにどのように返されるかを制御します。以下に値を示します。

TransIsolation の設定	Paradox と dBASE	Oracle
tiDirtyRead	tiDirtyRead	コミット読み出し
tiReadCommitted（デフォルト）	（設定できない）	コミット読み出し
tiRepeatableRead	（設定できない）	反復可能読み出し（読み出し専用）
TransIsolation の設定	Sybase，Microsoft SQL	InterBase
tiDirtyRead	コミット読み出し	コミット読み出し
tiReadCommitted（デフォルト）	コミット読み出し	コミット読み出し
tiRepeatableRead	（設定できない）	反復可能読み出し


TUDAlignButton 型
TUDAlignButton 型3425214

ユニット

ComCtrls

TUDAlignButton 型は，TUpDown の AlignButton プロパティの値を定義します。

type TUDAlignButton = (udLeft, udRight);

説明

TUDAlignButton 型は，TUpDown コンポーネントの AlignButton プロパティとして可能な値を定義します。以下に値を示します。

値	説明
udLeft	アップダウンコントロールは関連コントロールの左端の位置に合わせる
udRight	アップダウンコントロールは関連コントロールの右端の位置に合わせる


TUDBtnType 型
TUDBtnType 型3425215

ユニット

ComCtrls

TUDBtnType 型は，TUDClickEvent の Button パラメータの値を定義します。

type TUDBtnType = (btNext, btPrev);

説明

TUDBtnType 型は，TUpDown コンポーネント用の OnClick イベントの Button パラメータの型です。TUDClickEvent 型に対して Button パラメータとして可能な値を定義します。btNext 値は，〔→〕または〔↑〕の矢印ボタンがクリックされたことを示します。btPrev 値は，〔←〕または〔↓〕の矢印ボタンがクリックされたことを示します。


TUDOrientation 型
TUDOrientation 型3425216

ユニット

ComCtrls

TUDOrientation 型は，TUpDown の Orientation プロパティの値を定義します。

type TUDOrientation = (udHorizontal, udVertical);

説明

TUDOrientation 型は，TUpDown コンポーネントの Orientation プロパティとして可能な値を定義します。以下に値を示します。

値	説明
udHorizontal	アップダウンコントロールの矢印は左右を指す
udVertical	アップダウンコントロールの矢印は上下を指す


TUpdateAction 型
TUpdateAction 型3425217

ユニット

DBTables

TUpdateAction 型は，TTable，TQuery，および TStandProc の OnUpdateError イベントおよび OnUpdateRecord イベントのUpdateAction パラメータの値を定義します。

type

TUpdateAction = (uaFail, uaAbort, uaSkip, uaRetry, uaApplied);

説明

TUpdateAction 型は，次の表に示すように，TTable, TQuery, TStoredProc の各コンポーネントの OnUpdateError イベントと OnUpdateRecord イベントの UpdateAction パラメータとして可能な値を定義します。

値	説明
uaFail	例外が発生したらキャッシュされた更新の反映をとりやめる
uaAbort	EAbort 例外が発生したらキャッシュされた更新の反映をとりやめる
uaSkip	エラーを起こしたレコードをスキップして，その他の処理を続行する.
uaRetry	キャッシュされた更新を繰り返し反映する
uaApplied	OnUpdateRecord イベント中に更新が適用された


TUpdateKind 型
TUpdateKind 型3425218

ユニット

DB

TUpdateKind 型は，TTable，TQuery，および TStandProc の OnUpdateError イベントおよび OnUpdateRecord イベントのUpdateKind パラメータの値を定義します。

type

TUpdateKind = (ukModify, ukInsert, ukDelete);

説明

TUpdateKind 型は，次の表に示すように，TTable, TQuery, TStoredProc の各コンポーネントの OnUpdateError イベントと OnUpdateRecord イベントの UpdateKind パラメータとして可能な値を定義します。

値	説明
ukModify	レコードの内容の変更がキャッシュされている
ukInsert	新しいレコードの挿入がキャッシュされている
ukDelete	そのレコードを削除したことがキャッシュされている


TUpdateRecordTypes 型
TUpdateRecordTypes 型3425219

ユニット

DBTables

TUpdateRecordTypes 型は，データセットコンポーネントの UpdateRecordTypes プロパティの戻り値です。

type TUpdateRecordTypes = set of (rtModified, rtInserted, rtDeleted, rtUnModified);

説明

TUpdateRecordTypes 型は，次の表に示すように，データセットコンポーネントの UpdateRecordTypes プロパティの戻り値を定義します。

値	説明
rtModified	変更レコード
rtInserted	挿入レコード
rtDeleted	削除レコード
rtUnmodified	変更を元に戻したレコード


TUpdateStatus 型
TUpdateStatus 型3425220

ユニット

DB

データセットコンポーネントの UpdateStatus メソッドの戻り値です。

type TUpdateStatus = (usUnmodified, usModified, usInserted, usDeleted);

説明

TUpdateStatus 型は，次の表に示すように，データセットコンポーネントの UpdateStatus メソッドの戻り値です。

値	説明
usUnmodified	レコード内容が変更されなかった
usModified	レコード内容が変更された
usInserted	レコードが挿入された
usDeleted	レコードが削除された


TVarData 型
TVarData 型3425221

参照

ユニット

System

TVarData 型は，Variant 変数の内部構造です。

const

varEmpty	= $0000;

varNull	= $0001;

varSmallint	= $0002;

varInteger	= $0003;

varSingle	= $0004;

varDouble	= $0005;

varCurrency	= $0006;

varDate	= $0007;

varOleStr	= $0008;

varDispatch	= $0009;

varError	= $000A;

varBoolean	= $000B;

varVariant	= $000C;

varUnknown	= $000D;

varString	= $0100;

varTypeMask	= $0FFF;

varArray	= $2000;

varByRef	= $4000;

type

TVarArrayBound = record

ElementCount: Integer;

LowBound: Integer;

end;

PVarArray = ^TVarArray;

TVarArray = record

DimCount: Word;

Flags: Word;

ElementSize: Integer;

LockCount: Integer;

Data: Pointer;

Bounds: array[0..255] of TVarArrayBound;

end;

TVarData = record

VType: Word;

Reserved1, Reserved2, Reserved3: Word;

case Integer of

varSmallint:	(VSmallint: Smallint);

varInteger:	(VInteger: Integer);

varSingle:	(VSingle: Single);

varDouble:	(VDouble: Double);

varCurrency:	(VCurrency: Currency);

varDate:	(VDate: Double);

varOleStr:	(VOleStr: PWideChar);

varDispatch:	(VDispatch: Pointer);

varError:	(VError: Integer);

varBoolean:	(VBoolean: WordBool);

varUnknown:	(VUnknown: Pointer);

varString:	(VString: Pointer);

varArray:	(VArray: PVarArray);

varByRef:	(VPointer: Pointer);

end;

説明

TVarData 型は Variant 変数の内部構造を表します。Variant の内部構造は OLE と Win32 API で使うバリアント型と同じです。

TVarData 型を Variant 変数の型キャストで使うと，変数の内部にアクセスできます。次に例を示します。

var

V: Variant;

begin

...

if TVarData(V).VType = varEmpty then ...;

...

VarClear(V);

TVarData(V).VType := varInteger;

TVarData(V).VInteger := 1234567;

...

end;

TVarData レコードの VType フィールドはバリアントの型コードを下位ビット（varTypeMask 定数で定義されたビット）に保持します。また，varArray ビットが設定されると，バリアントが配列であることが示されます。varByRef ビットが設定されると，バリアントが値ではなく参照を保持していることが示されます。

TVarData レコードの Reserved1, Reserved2, Reserved3 の各フィールドは未使用のフィールドです。

TVarType レコードの残りの 8 バイトの内容は VType フィールドによって決まります。varArray ビットも varByRef ビットも設定されていない場合，バリアントは指定された型の値を保持します。

varArray ビットが設定されている場合，バリアントは配列の詳細を定義する TVarArray 構造体へのポインタを保持します。各配列要素の型は VType フィールドの varTypeMask ビットで指定されます。

varByRef ビットが設定されている場合，バリアントは VType フィールドの varTypeMask ビットおよび varArray ビットによって指定された型の値への参照を保持します。

varString 型コードが Delphi 専用であることに注意してください。varString の値を保持するバリアントを Delphi にはない関数に渡さないようにします。Delphi の OLE オートメーションサポートは，varString のバリアントをパラメータとして外部関数に渡す前に，このバリアントを自動的に varOleStr のバリアントに変換します。


TVarRec 型
TVarRec 型3425222

ユニット

System

TVarRec 型は，パラメータ型が array of const である手続きの内部で使われます。

const

vtInteger	= 0;

vtBoolean	= 1;

vtChar	= 2;

vtExtended	= 3;

vtString	= 4;

vtPointer	= 5;

vtPChar	= 6;

vtObject	= 7;

vtClass	= 8;

vtWideChar	= 9;

vtPWideChar	= 10;

vtAnsiString	= 11;

vtCurrency	= 12;

vtVariant	= 13;

vtInterface	= 14;

vtWideString	= 15;

type

PVarRec = ^VarRec;

TVarRec = record

case Byte of

vtInteger:	(VInteger: Integer; VType: Byte);

vtBoolean:	(VBoolean: Boolean);

vtChar:	(VChar: Char);

vtExtended:	(VExtended: PExtended);

vtString:	(VString: PShortString);

vtPointer:	(VPointer: Pointer);

vtPChar:	(VPChar: PChar);

vtObject:	(VObject: TObject);

vtClass:	(VClass: TClass);

vtWideChar:	(VWideChar: WideChar);

vtPWideChar:	(VPWideChar: PWideChar);

vtAnsiString:	(VAnsiString: Pointer);

vtCurrency:	(VCurrency: PCurrency);

vtVariant:	(VVariant: PVariant);

vtInterface:	(VInterface: Pointer);

vtWideString:	(VWideString: Pointer);

end;

説明

TVarRec 型は array of const のパラメータ型と一緒に手続き内で使われます。手続きは Vtype フィールドにより，オープン配列内に渡された各パラメータの単純型を知ることができます。

各種の型の定数は TVarRec 構造体のタグに渡された値を表します。


TViewStyle 型
TViewStyle 型3425223

ユニット

ComCtrls

ViewStyle 型は，リストビュー内の項目の表示に使う値を示します。

type TViewStyle = (vsIcon, vsSmallIcon, vsList, vsReport);

説明

TViewStyle 型は，リストビュー項目の表示方法を定義します。vsIcon は，各項目をフルサイズのアイコンとして表示します。vsList は，各項目を列に並べて，右側にラベルの付いた小型アイコンとして表示します。vsSmallIcon は，各項目を右側にラベルの付いた小型アイコンとして表示します。vsReport は，各項目にそれぞれ 1 行ずつ割り当てて，その行に配置されたいくつかの列に付加情報を表示します。一番左の列に小型アイコンとラベルが表示されて，それに続く列に子項目が入ります。

以下に TViewStyle 型の値を示します。

値	説明
vsIcon	各項目は，下にラベルの付いたフルサイズのアイコンとして表示される。ユーザーはリストビューウィンドウ内でその項目をどこにでもドラッグできる
vsSmallIcon	各項目は，右側にラベルの付いた小型アイコンとして表示される。ユーザーはその項目をどこにでもドラッグできる
vsList	各項目は，右側にラベルの付いた小型アイコンとして表示される。項目は列に並べて表示され，ユーザーは項目をドラッグして移動できない
vsReport	各項目はそれぞれ 1 行ずつ割り当てられ，列に情報を表示する。一番左の列に小型アイコンとラベルが表示され，それに続く列にアプリケーションで指定された子項目が入る。ShowColumnHeaders が False でない限り，各列にはヘッダが表示される


TWidth 型
TWidth 型3425224

ユニット

ComCtrls

TWidth 型は，Width プロパティおよび WidthType プロパティを定義し，リストビューコンポーネントの列見出しの幅を決めます。

type TWidth = ColumnHeaderWidth..MaxInt;

説明

TWidth 型は，リストビューコンポーネントの列見出しの幅を決める Width プロパティと WidthType プロパティの型です。


TWindowState 型
TWindowState 型3425225

ユニット

Forms

TWindowState 型は，フォームの WindowState プロパティがとりうる 3 つの状態を定義します。

type TWindowState = (wsNormal, wsMinimized, wsMaximized);

説明

TWindowState型はフォームで可能な状態として通常，最小化，最大化の3つを定義します。TWindowStateはフォームのWindowStateプロパティの型です。以下に値を示します。

値	説明
wsNormal	フォームは最大化も最小化もされずに表示される
wsMaximized	フォームは最大化される
wsMinimized	フォームは最小化される


TWordArray 型
TWordArray 型3425226

ユニット

SysUtils

TWordArray 型は，Word 型の汎用配列を宣言します。

type

PWordArray = ^TWordArray;

TWordArray = array[0..16383] of Word;

説明

TWordArray 型は型キャストに使える Word 型の汎用配列を宣言します。


Unassigned 定数
Unassigned 定数3425227

参照

ユニット

System

Unassigned 定数は，Variant 変数に値が代入されていないことを示すのに使います。

const Unassigned: Variant;

説明

Unassigned 定数は Variant 変数に値が代入されていないことを示すのに使います。どの Variant 変数でも初期値は Unassigned です。Unassigned の値は，Variant 変数にほかの値（0，長さゼロの文字列，Null の値など）が代入されるまで続きます。

式で Unassigned のバリアントを使うと，EVariantError 例外が生成されます。同様に，Unassigned のバリアントをほかの型に変換しようとすると（VarAsType や VarCast を使った場合），EVariantError 例外が生成されます。

Unassigned 定数を Variant 変数に代入すると，その変数を値が代入されていない状態にできます。Variant が OLE オートメーションオブジェクトへの参照を保持しているため，その Variant にほかの値が代入されるまではそのオブジェクトを有効にしておく場合に，特にこの処理が役立ちます。たとえば，次に示すコードでは，Unassigned を MSWord 変数に代入する文を使って，Word とのインターフェースとして作成された OLE オートメーションオブジェクトを解放します。

var

MSWord: Variant;

begin

...

MSWord := CreateOleObject('Word.Basic');

...

MSWord := Unassigned;

...

end;

Variant の値が Unassigned かどうかをテストするには，その値を Unassigned 定数と比較するか，標準関数 VarIsEmpty を使います。値が代入されていないバリアントに標準関数 VarType を使うと，varEmpty が返されます。


Win32Platform 変数
Win32Platform 変数3425228

ユニット

SysUtils

Win32Platform 変数は，Win32 プラットフォーム識別子です。

var Win32Platform: Integer = 0;

説明

Win32Platform はシステムが動作している Win32 プラットフォームの型を識別するために使われます。以下に値を示します。

値	説明
VER_PLATFORM_WIN32s	システムは Win32s である
VER_PLATFORM_WIN32_WINDOWS	システムは Windows 95 である
VER_PLATFORM_WIN32_NT	システムは Windows NT である
関連する数値については WINDOWS.PAS を参照してください。


WordRec 型
WordRec 型3425229

参照

ユニット

SysUtils

WordRec 型は，指定された変数の上位バイトと下位バイトを Byte 型として格納するユーティリティレコードを宣言します。

type

WordRec = packed record

Lo, Hi: Byte;

end;

説明

指定された変数の上位バイトと下位バイトを Byte 型として格納するユーティリティレコードを宣言します。WordRec はおもに型キャストに使用されます。.


TActiveForm
TActiveForm3001001

継承	プロパティ	メソッド	イベント	参照

TActiveForm オブジェクトはクラスファクトリを介して作成され，ActiveX ホストアプリケーションで ActiveX コントロールとして使われる Delphi フォームです。

ユニット

axctrls

説明

Delphi では，TActiveForm オブジェクトを使って，Web ブラウザから表示および実行できるフォーム ActiveX コントロールを作成します。


TActiveForm プロパティ3001002

TActiveForm	アルファベット順	凡例

TActiveForm

AxBorderStyle

TCustomForm からの継承

Active

ActiveControl

ActiveOleControl

Canvas

ClientRect

Designer

DropTarget

KeyPreview

Menu

ModalResult

OleFormObject

Parent

PixelsPerInch

PrintScale

Scaled

WindowState

TScrollingWinControl からの継承

AutoScroll

HorzScrollBar

VertScrollBar

TWinControl からの継承

Brush

ClientOrigin

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

Enabled

Font

Height

Hint

Left

Name

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TActiveForm プロパティ3001003

TActiveForm	オブジェクト順	凡例

Active

ActiveControl

ActiveOleControl

Align

AutoScroll

AxBorderStyle

BoundsRect

Brush

Canvas

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

Designer

DesignInfo

DropTarget

Enabled

Font

Handle

Height

HelpContext

Hint

HorzScrollBar

KeyPreview

Left

Menu

ModalResult

Name

OleFormObject

Owner

Parent

ParentWindow

PixelsPerInch

PopupMenu

PrintScale

Scaled

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

VertScrollBar

Visible

Width

WindowProc

WindowState


TActiveForm.AxBorderStyle
TActiveForm.AXBorderStyle3001004

TActiveForm	参照

AXBorderStyle プロパティは，TActiveForm の境界のスタイルを指定します。

constructor Create(AOwner: TComponent); override;

説明

以下に AXBorderStyle の値を示します。

値	意味

afbNone 	フォームに境界は付けられない

afbSingle	フォームに標準の一重境界線が付けられる

afbSunken	フォームに，縁がへこんでいるように見える 3 次元表示の境界が付けられる

afbRaised	フォームに，縁が浮き上がって見える境界が付けられる


TActiveForm イベント3001005

TActiveForm	アルファベット順	凡例

TCustomForm からの継承

OnActivate

OnCreate

OnDeactivate

OnDestroy

OnPaint

TWinControl からの継承

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnMouseDown

OnMouseMove

OnMouseUp


TActiveForm イベント3001006

TActiveForm	オブジェクト順	凡例

OnActivate

OnClick

OnCreate

OnDblClick

OnDeactivate

OnDestroy

OnDragDrop

OnDragOver

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnPaint


TActiveForm メソッド3001007

TActiveForm	アルファベット順

TActiveForm

Create

WantChildkey

TCustomForm からの継承

Close

CloseQuery

CreateNew

DefocusControl

Destroy

FocusControl

GetFormImage

Hide

Print

Release

SendCancelMode

SetFocus

SetFocusedControl

Show

ShowModal

TScrollingWinControl からの継承

DisableAutoRange

EnableAutoRange

ScrollInView

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TActiveForm メソッド3001008

TActiveForm	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Close

CloseQuery

ContainsControl

ControlAtPos

Create

CreateNew

CreateParented

DefaultHandler

DefocusControl

Destroy

DestroyComponents

Destroying

DisableAlign

DisableAutoRange

Dispatch

DragDrop

Dragging

EnableAlign

EnableAutoRange

EndDrag

FieldAddress

FindComponent

FocusControl

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetFormImage

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Print

Realign

Refresh

Release

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

ScrollInView

SendCancelMode

SendToBack

SetBounds

SetFocus

SetFocusedControl

SetTextBuf

Show

ShowModal

Update

UpdateControlState

WantChildkey


TActiveForm.Create
TActiveForm.Create3001009

TActiveForm	参照

Create メソッドは，TActiveForm のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは呼び出した継承コンストラクタをオーバーライドして，AxBorderStyle プロパティを初期化します。


スコープ3001010

published

読み出し／書き込み

読み出し専用


スコープ3001011

published


継承3001012

TObject

TPersistent

TComponent

TControl

TWinControl

TScrollingWinControl

TCustomForm


TActiveForm 例3001013

TActiveForm


TAdapterNotifier
TAdapterNotifier3002001

継承	プロパティ	メソッド	参照

TAdapterNotifier は，Delphi 型オブジェクトと比較 OLE 型オブジェクトとの結合を提供します。

ユニット

axctrls

説明

TAdapterNotifer は，TCustomAdapter の下位オブジェクトと連携して Delphi 型オブジェクトと OLE 型オブジェクトとの結合を提供します。たとえば，TAdapterNotifier は，TFont オブジェクトと OLE フォントオブジェクトとの結合またはTPicture と OLE 画像オブジェクトとの結合を提供します。


TAdapterNotifier のプロパティ3002002

TAdapterNotifier	アルファベット順	凡例

TInterfacedObject からの継承

RefCount


TAdapterNotifier のプロパティ3002003

TAdapterNotifier	オブジェクト順	凡例

RefCount


TAdapterNotifier のメソッド3002004

TAdapterNotifier	アルファベット順

TAdapterNotifier

Create

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TAdapterNotifier のメソッド3002005

TAdapterNotifier	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TAdapterNotifier.Create
TAdapterNotifier.Create3002006

TAdapterNotifier	参照

Create メソッドは，TAdapterNotifier オブジェクトのインスタンスを作成し，初期化します。

constructor Create(Adapter: TCustomAdapter);

説明

通常は，このクラスのオブジェクトを作成することはありません。このオブジェクトは TCustomAdapter の下位オブジェクトによって作成され，TCustomAdapter の下位オブジェクトに結び付けられます。


アクセス種別3002007

読み出し専用


継承3002008

TObject

TInterfacedObject


TAdapterNotifier の例

TAdapterNotifier


TActiveFormControl
TActiveFormControl3003001

継承	プロパティ	メソッド	参照

ActiveX コントロールのサポートに必要なインターフェースを提供するCOM オブジェクトです。

ユニット

axctrls

説明

TActiveFormControl は，Delphi フォームと ActiveX コントロール API とのブリッジとして機能します。


TActiveFormControl のプロパティ3003002

TActiveFormControl	アルファベット順	凡例

TActiveXControl からの継承

Control

TComObject からの継承

Controller

Factory

RefCount


TActiveFormControl のプロパティ3003003

TActiveFormControl	オブジェクト順	凡例

Controller

Control

Factory

RefCount


TActiveFormControl のメソッド3003004

TActiveFormControl	アルファベット順

TActiveFormControl

FreeOnRelease

InitializeControl

Invoke

ObjQueryInterface

TActiveXControl からの継承

Destroy

Initialize

PropChanged

PropRequestEdit

TComObject からの継承

Create

CreateAggregated

CreateFromFactory

ObjAddRef

ObjRelease

SafeCallException

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TActiveFormControl のメソッド3003005

TActiveFormControl	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

CreateAggregated

CreateFromFactory

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

FreeOnRelease

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitializeControl

Initialize

InitInstance

InstanceSize

Invoke

MethodAddress

MethodName

NewInstance

ObjAddRef

ObjQueryInterface

ObjRelease

PropChanged

PropRequestEdit

SafeCallException


TActiveFormControl.FreeOnRelease
TActiveFormControl.FreeOnRelease3003006

TActiveFormControl

FreeOnRelease メソッドは，IVCLComObject インターフェースをサポートします。

procedure FreeOnRelease;

説明

FreeOnRelease メソッドは，IVCLComObject のサポートのためにのみ存在しており，実装はされません。


TActiveFormControl.InitializeControl
TActiveFormControl.InitializeControl3003007

TActiveFormControl	参照

InitializeControl メソッドは，TActiveForm インスタンスを作成し，自身とコントロールプロパティが参照する TActiveForm との間にリンクを確立します。

procedure InitializeControl; override;

説明

InitializeControl メソッドは，TActiveForm の Initialize メソッド呼び出します。


TActiveFormControl.Invoke
TActiveFormControl.Invoke3003008

TActiveFormControl

Invoke メソッドは，OLE オートメーションディスパッチの Invoke 関数です。

function Invoke(DispID: Integer; const IID: TGUID; LocaleID: Integer; Flags: Word; var Params; VarResult, ExcepInfo, ArgErr: Pointer): HResult; override;

説明

TActiveFormControl に IDispatch のサポートを提供します。


TActiveFormControl.ObjQueryInterface
TActiveFormControl.ObjQueryInterface3003009

TActiveFormControl	参照

ObjQueryInterface メソッドは，インターフェース ID（IID パラメータ）を受け取り，要求された COM インターフェースをオブジェクトに返します。

function ObjQueryInterface(const IID: TGUID; out Obj): Integer; override;

説明

ObjQueryInterface メソッドは，要求されたインターフェースをサポートしている場合に関連付けられている TActiveForm オブジェクトにその呼び出しを送り，それ以外の場合には自身のインターフェースを問い合わせます。


アクセス種別3003010

読み出し専用


継承3003011

TObject

TComObject

TTypedComObject

TAutoObject

TActiveXControl


TActiveFormControl の例3003012

TActiveFormControl


TActiveFormFactory
TActiveFormFactory3004001

継承	プロパティ	メソッド	参照

ActiveFormFactory オブジェクトは TActiveForm のクラスファクトリです。

ユニット

axctrls

説明

ActiveFormFactory オブジェクトは，TActiveFormControl のインスタンスを作成するクラスファクトリであり，したがって TActiveForm オブジェクトです。


TActiveFormFactory のプロパティ3004002

TActiveFormFactory	アルファベット順	凡例

TActiveXControlFactory からの継承

EventIID

EventTypeInfo

MiscStatus

ToolboxBitmapID

WinControlClass

TAutoObjectFactory からの継承

DispIntfEntry

DispTypeInfo

TTypedComObjectFactory からの継承

ClassInfo

TComObjectFactory からの継承

ClassID

ClassName

ComClass

ComServer

Description

ErrorIID

Instancing

LicString

ProgID

ShowErrors

SupportsLicensing


TActiveFormFactory のプロパティ3004003

TActiveFormFactory	オブジェクト順	凡例

ClassID

ClassInfo

ClassName

ComClass

ComServer

Description

DispIntfEntry

DispTypeInfo

ErrorIID

EventIID

EventTypeInfo

Instancing

LicString

MiscStatus

ProgID

ShowErrors

SupportsLicensing

ToolboxBitmapID

WinControlClass


TActiveFormFactory のメソッド3004004

TActiveFormFactory	アルファベット順

TActiveFormFactory

GetIntfEntry

TActiveXControlFactory からの継承

AddVerb

Create

Destroy

UpdateRegistry

TTypedComObjectFactory からの継承

GetInterfaceTypeInfo

TComObjectFactory からの継承

CreateComObject

RegisterClassObject

TObject からの継承

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TActiveFormFactory のメソッド3004005

TActiveFormFactory	オブジェクト順

AddVerb

ClassNameIs

ClassParent

ClassType

CleanupInstance

CreateComObject

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetInterfaceTypeInfo

GetIntfEntry

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RegisterClassObject

SafeCallException

UpdateRegistry


TActiveFormFactory.GetIntfEntry
TActiveFormFactory.GetIntfEntry3004006

TActiveFormFactory	参照

GetIntfEntry メソッドは，ディスパッチインターフェースへのポインタを取得します

function GetIntfEntry(Guid: TGUID): PInterfaceEntry; override;

説明

GetIntfEntry メソッドは，関連付けられている TActiveForm オブジェクトからディスパッチインターフェースへのポインタを取得します。


アクセス種別3004007

読み出し専用


継承3004008

TObject

TComObjectFactory

TTypedComObjectFactory

TAutoObjectFactory

TActiveXControlFactory


TActiveFormFactory の例3004009

TActiveFormFactory


TAggregatedObject
TAggregatedObject3005001

継承	プロパティ	メソッド	参照

TAggregatedObject は，コントロール IUnknown に委任するために IUnknown メソッドを実現することによって，集約の内部オブジェクトに機能を提供するクラスです。

ユニット

axctrls

説明

TAggregatedObject はそれ自体インターフェースはサポートしませんが，典型的な集合体として IUnknown のメソッドを実現し，そのメソッドは集合体に格納されるオブジェクトに使われます。したがって，TAggregatedObject は，集合体の一部となるオブジェクトを作成するためにインターフェースを実現するクラスの基本として使われます。

集約 COM オブジェクトとは，実際に複数の COM オブジェクトからなるオブジェクトです。各オブジェクトは自身の動作とインターフェースを実現しますが，オブジェクトはすべて同じコントローラオブジェクトの参照カウントを共有します。コンテナパターンの中では，コントローラはコンテナオブジェクトです。

集約，コントロールオブジェクト，インターフェースについての詳細は，Microsoft Web サイトの Inside OLE 第 2 版（Kraig Brockschmidt）か，Windows の SDK ヘルプ を参照してください。

Delphi のクラス継承の中で，TAggregatedObject は，格納オブジェクトと接続オブジェクトを作成するクラスの基本として使われます。 TAggregatedObject は，IUknown メソッドを呼び出すと集合体のコントロール IUnknown に委任されることを保証する機能を提供します。

コントロール IUnkonwn はTAggregatedObject のコンストラクタで指定され，Controller プロパティで示されます。


TAggregatedObject のプロパティ3005002

TAggregatedObject	アルファベット順	凡例

TAggregatedObject

Controller


TAggregatedObject のプロパティ3005003

TAggregatedObject	オブジェクト順	凡例

Controller


TAggregatedObject.Controller
TAggregatedObject.Controller3005004

TAggregatedObject	参照

Controller プロパティは，集合体の IUnknown です。

property Controller: IUnknown;

説明

Controller プロパティは，集合体の IUnknown インターフェース参照です。TAggregatedObject は集合体の一部で，集合体はコントロール IUnknown を 1 つ持っています。集合体内で実現される IUnknown メソッドは，Controller に委任されます。

集合体が作成されると，コンストラクタにコントロール IUnknown が渡されます。Controller はコンストラクタ内でこの IUnknown に初期化されます。


TAggregatedObject のメソッド3005005

TAggregatedObject	アルファベット順

TAggregatedObject

Create

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TAggregatedObject のメソッド3005006

TAggregatedObject	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TAggregatedObject.Create
TAggregatedObject.Create3005007

TAggregatedObject	参照

Create メソッドは集約オブジェクトをインスタンス化します。

constructor Create(const Controller: IUnknown);

説明

Create メソッドを呼び出すと，実行時に集約オブジェクトをインスタンス化できます。

Create は集約オブジェクトにメモリを割り当て，渡された Controller パラメータに Controller プロパティを設定します。Controller は集約オブジェクトのコントロール IUnknown です。集約オブジェクト内で実現されるほかのすべてのインターフェースは，IUnknown メソッドの呼び出しを，この Controller に委任します。


アクセス種別3005008

読み出し専用


継承3005009

TObject


TAggregatedObject の例3005010

TAggregatedObject


TWebActionItem
TWebActionItem3006001

継承	プロパティ	メソッド	イベント	参照

TWebActionItem コンポーネントは，Web サーバーアプリケーションが HTTP 要求メッセージに対する応答メッセージを作成および送信するとき使用するコンポーネントです。

ユニット

httpapp

説明

TWebActionItem コンポーネントは，Web サーバーアプリケーションが特定の HTTP 要求メッセージに対して応答メッセージを作成するとき使用するコンポーネントです。各アクション項目は，URI パスおよび HTTP 要求メソッドに固有なものです。

TWebDispatcher オブジェクトは，適当なアクション項目を選んで HTTP 要求メッセージを処理します。この処理を行なうために，Web クライアントが要求した URI のパス部分と TWebActionItem オブジェクト内の PathInfo プロパティとを比較し，さらに Web クライアントが要求したメソッドの型と，アクション項目がその処理方法を知っているメソッドの型を比較します。

アクション項目は OnAction イベントハンドラ内で HTTP 要求メッセージを処理します。OnAction イベントハンドラは，要求メッセージを読み，TWebResponse オブジェクトのプロパティを設定することで応答メッセージを作成します。このイベントハンドラは，TWebResponse オブジェクトに指示して応答メッセージを Web クライアントに送り返したり，他のアクション項目で応答メッセージを追加した場合にはその後に TWebApplication オブジェクトに指示して応答メッセージを送信したりします。


TWebActionItem プロパティ3006002

TWebActionItem	アルファベット順	凡例

TWebActionItem

Default

DisplayName

Enabled

MethodType

Name

PathInfo

TCollectionItem からの継承

Collection

ID

Index


TWebActionItem プロパティ3006003

TWebActionItem	オブジェクト順	凡例

Collection

Default

DisplayName

Enabled

ID

Index

MethodType

Name

PathInfo


TWebActionItem.Default
TWebActionItem.Default3006004

TWebActionItem	参照

Default プロパティは，利用可能な別のアクション項目と一致しない要求メッセージをアクション項目が処理するかどうかを示します。

property Default: Boolean;

説明

Default プロパティを True に設定すると，TWebDispatcher オブジェクトが管理するアクション項目リスト内のデフォルトアクション項目に現在のアクション項目がなります。TWebDispatcher は，ターゲット URI の MethodType プロパティおよび PathInfo プロパティを比較することで HTTP 要求メッセージを各アクション項目と比較します。比較して一致しなかった場合，Methodtype プロパティや PathInfo プロパティが何であっても，TWebDispatcher はデフォルトアクション項目の OnAction イベントハンドラを呼び出します。

あるアクション項目がデフォルトアクション項目として選ばれると，Enabled プロパティの値は無視されます。アクション項目が Enabled プロセスを False に，Default プロパティを True に設定した場合，デフォルトアクション項目の PathInfo プロパティと MethodType プロパティが要求と完全に一致していても，TWebDispatcher はまず，他のアクション項目の中で一致するものがないかチェックします。次に，一致するアクション項目がなかった場合はじめて，デフォルトアクション項目を選択します。デフォルトアクション項目が有効な場合，これを選択してから他のアクション項目をチェックすることもできます。それは，デフォルトアクション項目の MethodType プロパティと PathInfo プロパティが要求メッセージと一致しているからです。

MethodType プロパティと PathInfo プロパティが何であっても，あらゆる HTTP 要求に対して応答メッセージを作成するため，デフォルトアクション項目の OnAction イベントハンドラを作成する必要があります。この作成は，応答ステータスコード 404（URI が一致しなかった）あるいは 405（要求されたメソッドがサポートされていない）を設定するだけでできます。

Default プロパティを True に設定すると，前のデフォルトアクション項目の Default プロパティが FALSE に設定されます。


TWebActionItem.DisplayName
TWebActionItem.DisplayName3006005

TWebActionItem	参照

DisplayName プロパティは，アクション項目コレクションに存在する個々のアクション項目の名前を示す文字列です。

property DisplayName: string;

説明

DisplayName プロパティは，TCustomWebDispatcher オブジェクトが管理するアクション項目リスト内の特定のアクション項目を指定します。このプロパティを設定するときは，他のアクション項目の DisPlayName プロパティと同じ値を指定してはいけません。すでに使用中の名前を指定しようとすると，例外が発生します。


TWebActionItem.Enabled
TWebActionItem.Enabled3006006

TWebActionItem	参照

Enabled プロパティは，MethodTYpe プロパティと PathInfo プロパティが同じ HTTP 要求メッセージに対して当該アクション項目が応答できるかどうかを示します。

property Enabled: Boolean;

説明

Enabled プロパティを False に設定すると，アクション項目が無効になります。TWebDispatcher は，要求を処理するアクション項目を捜すとき，無効なアクション項目を無視します。

あるアクション項目がデフォルトアクション項目として選ばれると，Enabled プロパティの値は無視されます。アクション項目が Enabled プロセスを False に，Default プロパティを True に設定した場合，デフォルトアクション項目の PathInfo プロパティと MethodType プロパティが要求と完全に一致していても，TWebDispatcher はまず，他のアクション項目の中で一致するものがないかチェックします。次に，一致するアクション項目がなかった場合はじめて，デフォルトアクション項目を選択します。デフォルトアクション項目が有効な場合，これを選択してから他のアクション項目をチェックすることもできます。それは，デフォルトアクション項目の MethodType プロパティと PathInfo プロパティが要求メッセージと一致しているからです。


TWebActionItem.MethodType
TWebActionItem.MethodType3006007

TWebActionItem	参照

MethodType プロパティは，アクション項目がその対処方法を知っている，HTTP 要求メッセージの型を指定します。

TMethodType = (mtAny, mtGet, mtPut, mtPost, mtHead);

property MethodType: TMethodType;

説明

MethodType プロパティで，OnAction イベントハンドラが処理する要求メッセージの型を指定できます。TWebDispatcher は，アクション項目の MethodType プロパティと要求メッセージの同プロパティが同じとき（PathInfo プロパティも同じでなければならない），要求メッセージを処理するアクション項目を選択します。

MethodType プロパティは，以下の値のいずれかです。

値	意味

mtGet	応答メッセージは，要求の URI プロパティが示す情報を与えなければならない

mtHead	応答メッセージは，mtGet 要求を処理するときと同じヘッダープロパティを与えなければならない。ただし，応答の内容を削除する

mtPut	要求の内容は，要求の URL プロパティによって示されるリソースを置き換えるために使用される

mtPost	通常は要求の内容をターゲット URI に登録するが，必ずそうする必要はない

mtAny	アクション項目は，mtGet，mtHead，mtPost を含めてすべての要求の型を処理する

MethodType プロパティが，mtAny のアクション項目が TWebDispatcher オブジェクトの Actions リストの末尾に追加されます。MethodType が mtGet，meHead，mtPut，または mtPost である要求と完全に一致するアクション項目を選択してから，mtAny の要求を選択します。


TWebActionItem.Name
TWebActionItem.Name3006008

TWebActionItem	参照

Name プロパティは，個々のアクション項目を他のオブジェクトから参照するとき，そのアクション項目を示す文字列です。

property Name: string;

説明

Name プロパティは，アプリケーションのどこからでも個々のアクション項目を一意に指定できます。アクション項目において，Name プロパティの値は DisplayName プロパティの値と同じです。したがって，Name プロパティを新しく設定するとき，その値は他のアクション項目の DisplayName プロパティと同じであってはいけません。同じ名前を指定しようとすると，例外が発生します。


TWebActionItem.PathInfo
TWebActionItem.PathInfo3006009

TWebActionItem	参照

PathInfo プロパティは，アクション項目が処理する要求メッセージの Uniform Resource Identifier（URI）のパス部分です。

property URI: string;

説明

PathInfo プロパティは，アクション項目が処理する要求メッセージのターゲット URI のパス部分を設定します。TWebDispatcher は，アクション項目と要求メッセージが一致するかどうかを決めるために，アクション項目の PathInfo プロパティと，URI のパス部分を比較します。PathInfo プロパティと MethoType プロパティが一致した場合，TWebDispatcher は一致したアクション項目の OnAction イベントハンドラを呼び出して，要求メッセージに応答します。


TWebActionItem イベント3006010

TWebActionItem	アルファベット順	凡例

TWebActionItem

OnAction


TWebActionItem イベント3006011

TWebActionItem	オブジェクト順	凡例

OnAction


TWebActionItem.OnAction
TWebActionItem.OnAction3006012

TWebActionItem	参照

OnAction イベントは，TWebDispatcher が，新しく到着した HTTP 要求メッセージとアクション項目を比較するとき発生します。

THTTPMethodEvent = procedure (Sender: TObject; Request: TWebRequest;

    Response: TWebResponse; var Handled: Boolean) of object;

property OnAction: THTTPMethodEvent;

説明

OnAction イベントハンドラは，MethodType プロパティと PathInfo プロパティの両方が一致した HTTP 要求メッセージへの応答処理を作成するハンドラです。Request パラメータは，HTTP 要求メッセージをカプセル化した TWebRequest オブジェクトです。Response パラメータは，OnAction メソッドによって設定される TWebResponse オブジェクトです。Handled パラメータは，アクション項目が応答メッセージの処理を終了したかどうかを示す出力パラメータです。

OnAction イベントハンドラは，Request パラメータを読み出し，できる限り要求されたメソッドを実行します。Response パラメータのプロパティを要求にあわせて適切に設定します。OnAction イベントハンドラが応答処理を行わない場合，あるいは部分的にしか行わず，他のアクション項目に応答処理を終了させなければならない場合，Handled パラメータを FALSE に設定します。

OnAction イベントハンドラは，Response パラメータの SendRedirect メソッドまたは SendResponse メソッドを呼び出して，Web クライアントに応答メッセージを送信できます。OnAction イベントハンドラが応答を送信しない場合，すべてのアクション項目が Response パラメータの設定を終わった後，Web アプリケーションが送信します。

注意

OnAction イベントハンドラは，TCustomContentProducer の下位オブジェクトを使って，応答メッセージの内容作成をサポートします。


TWebActionItem メソッド3006013

TWebActionItem	アルファベット順

TWebActionItem

AssignTo

Create

Destroy

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TWebActionItem メソッド3006014

TWebActionItem	オブジェクト順

Assign

AssignTo

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TWebActionItem.AssignTo
TWebActionItem.AssignTo3006015

TWebActionItem	参照

AssignTo メソッドは，継承メソッドをオーバーライドして，あるアクション項目を別のアクション項目に代入できるようにします。

procedure AssignTo(Dest: TPersistent); override;

説明

あるアクション項目の値を別のアクション項目に割り当てるには，ターゲットアクション項目の Assign メソッドを使います。

AssignTo メソッドは，ターゲットアクション項目の Assign メソッドを有効にして，あるアクション項目のプロパティをコピーします。このメソッドは，Dest パラメータがアクション項目の場合，Default，Enabled，MethodType，PathInfo の各プロパティの値を Dest パラメータにコピーします。アクション項目でない場合，継承メソッドを呼び出します。


TWebActionItem.Create
TWebActionItem.Create3006016

TWebActionItem	参照

Create メソッドは，TWebActionItem のインスタンスを作成します。

constructor Create(Collection: TCollection); override;

説明

Create メソッドを呼び出すと，実行時に TWebActionItem オブジェクトを作成できます。設計時にアクションエディタで作られたアクション項目は，自動的にインスタンス化されます。

Create メソッドは，継承コンストラクタを呼び出した後，Enabled プロパティを True に初期化し，空の PathInfo パラメータを持つ URI に対する HTTP 要求とアクション項目が一致するようにアクション項目を設定します。


TWebActionItem.Destroy
TWebActionItem.Destroy3006017

TWebActionItem	参照

Destroy メソッドは，TWebActionItem のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。TWebActionItem オブジェクトを管理する TWebActionItems オブジェクトが Free メソッドを呼び出すと，TWebActionItem オブジェクトは破棄されます。Free メソッドは，TWebActionItem が解放されていないことを確認してからのみ Destroy メソッドを呼び出します。


スコープ3006018

published

読み出し／書き込み

読み出し専用


スコープ3006019

published


継承3006020

TObject

TPersistent

TCollectionItem


TWebActionItem 例3006021

TWebActionItem


TWebActionItems
TWebActionItems3007001

継承	プロパティ	メソッド	参照

TWebActionItems コンポーネントは TWebActionItem オブジェクトのコレクションです。

ユニット

httpapp

説明

TCustomWebDispatcher は，TWebActionItems を使って，管理する個々のアクション項目を格納および操作します。TWebActionItems には，以下の処理を行うためのプロパティとイベントがあります。

・	新しいアクション項目をコレクションに追加する

・	他の TWebActionItems からアクション項目リストをコピーする

・	コレクション内の指定されたアクション項目の属性を取得する

・	コレクションのアクション項目を空にする


TWebActionItems プロパティ3007002

TWebActionItems	アルファベット順	凡例

TWebActionItems

Items

WebDispatcher

TCollection からの継承

Count

ItemClass


TWebActionItems プロパティ3007003

TWebActionItems	オブジェクト順	凡例

Count

ItemClass

Items

WebDispatcher


TWebActionItems.Items
TWebActionItems.Items3007004

TWebActionItems	参照

Items プロパティは，インデックス付けされた TWebActionItem オブジェクト配列で，TWebActionItem オブジェクトによって格納されたものです。

property Items[Index: Integer]: THTTPActionItem; default;

説明

Items プロパティは，TWebActionItems によって格納された個々のアクション項目にアクセスできます。Items プロパティはインデックス配列で，最初のアクション項目はインデックス 0，次のアクション項目はインデックス 1 となります。Count プロパティと一緒に使うと，コレクション内の全アクション項目にアクセスできます。


TWebActionItems.WebDispatcher
TWebActionItems.WebDispatcher3007005

TWebActionItems	参照

WebDispatcher は，TWebActionItems コンポーネントを使ってそのコンポーネントのアクション項目を格納および処理するディスパッチャオブジェクトです。

property WebDispatcher: TCustomWebDispatcher;

説明

WebDispatcher オブジェクトは，アクション項目のコレクションを使って HTTP リクエストメッセージに応答するディスパッチャオブジェクトにアクセスできます。


TWebActionItems メソッド3007006

TWebActionItems	アルファベット順

TWebActionItems

Add

Create

TCollection からの継承

Assign

BeginUpdate

Clear

Destroy

EndUpdate

FindItemID

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TWebActionItems メソッド3007007

TWebActionItems	オブジェクト順

Add

Assign

BeginUpdate

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

EndUpdate

FieldAddress

FindItemID

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TWebActionItems.Add
TWebActionItems.Add3007008

TWebActionItems	参照

Add メソッドは，コレクションの末尾に新しいアクション項目を追加します。

function  Add: TWebActionItem;

説明

Add メソッドを呼び出すと，ディスパッチャによって管理されるアクション項目コレクションに新しいアクション項目が追加されます。追加は Items 配列の末尾に対して行われます。Add メソッドは，追加されたアクション項目を呼び出し側に返すので，そのアクション項目のプロパティを設定して使い方を指定できます。

ディスパッチャは HTTP リクエストメッセージを処理するためにアクション項目を捜そうとするときは，各アクション項目を最初から順番に走査するので，HTTP リクエストを前処理するアクション項目を最初に追加し，次に特定の処理を行うものを追加してください。


TWebActionItems.Create
TWebActionItems.Create3007009

TWebActionItems	参照

Create メソッドは，TWebActionItems のインスタンスを作成します。

TCollectionItemClass = class of TCollectionItem;

constructor Create(WebDispatcher: TCustomWebDispatcher; ItemClass: TCollectionItemClass);

説明

TWebActionItems のコンストラクタは呼び出さないでください。TWebActionItems は TCustomWebDispatcher で処理できるように変更されます。TCustomWebDispatcher オブジェクトは自身のコンストラクタ内で TWebActionItems を作成します。


読み出し／書き込み3007010

読み出し専用


継承3007011

TObject

TPersistent

TCollection


TWebActionItems 例3007012

TWebActionItems


TAnimate
TAnimate3008001

継承	プロパティ	メソッド	イベント	参照

TAnimate は Windows アニメーションコントロールのラッパーです。

ユニット

comctrls

説明

TAnimate を使うと，アニメーションコントロールをフォーム上に配置できます。アニメーションコントロールとは，Audio Video Interleaved（AVI）クリップをサイレントで表示するウィンドウです。AVI クリップは，映画のような一連のビットマップフレームで構成されます。AVI クリップはサウンドを持つことができますが，アニメーションコントロールはサウンドは扱いません。TAnimate は，伸長された AVI ファイルやランレングスエンコーディング（RLE）で圧縮された AVI クリップを扱います。

TAnimate がその AVI クリップを取得できるのは AVI リソースおよび AVI ファイルです。また，アプリケーションが Windows 95 または NT 4.0 環境で動作している場合には Shell32.dll からも取得できます。


TAnimate プロパティ3008002

TAnimate	アルファベット順	凡例

TAnimate

Active

AutoSize

Center

CommonAVI

FileName

FrameCount

FrameHeight

FrameWidth

Open

Repetitions

ResHandle

ResID

ResName

StartFrame

StopFrame

Timers

Transparent

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ParentColor

ParentShowHint

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TAnimate プロパティ3008003

TAnimate	オブジェクト順	凡例

Active

Align

AutoSize

BoundsRect

Brush

Center

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

CommonAVI

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

FileName

FrameCount

FrameHeight

FrameWidth

Handle

Height

HelpContext

Hint

Left

Name

Open

Owner

Parent

ParentColor

ParentShowHint

ParentWindow

Repetitions

ResHandle

ResID

ResName

ShowHint

Showing

StartFrame

StopFrame

TabOrder

TabStop

Tag

Timers

Top

Transparent

VCLComObject

Visible

Width

WindowProc


TAnimate.Active
TAnimate.Active3008004

TAnimate	参照

Active プロパティは，アニメーションコントロールが AVI クリップを再生しているかどうかを示します。

property Active: Boolean;

説明

Active プロパティを True に設定すると，Repetitions プロパティで指定された反復回数だけ，StartFrame プロパティと StopFrame プロパティで指定されたフレーム間を循環します。Active を False に設定すると，AVI クリップを再生しているアニメーションコントロールに割り込みます。

アニメーションコントロールが Active になるには，その前に Open プロパティが True に設定されていなければなりません。


TAnimate.AutoSize
TAnimate.AutoSize3008005

TAnimate	参照

AutoSize プロパティは，アニメーションコントロールがそのサイズを AVI クリップ内のフレームに合うように調節するかどうかを指定します。

property AutoSize: Boolean;

説明

AutoSize プロパティを True に設定すると，アニメーションコントロールのサイズを AVI クリップ内のフレームサイズに自動的に合わせるようにできます。AutoSize を False に設定すると，アニメーションコントロールのサイズを一定に固定できます。AutoSize が False の場合，AVI クリップのフレームはコントロールのクライアント領域全体を占めることはありませんし，そのクライアント領域より大きいときにはトリミングされて表示されます。

注意

Align プロパティの値が alNone でない場合，AutoSize を True に設定したときにだけ，固定されたアニメーションコントロールの辺々をサイズ変更して親コントロールに合うようにできます。


TAnimate.Center
TAnimate.Center3008006

TAnimate	参照

Center プロパティは，アニメーションコントロールで AVI クリップのフレームを中央に配置するかどうかを指定します。

property Center: Boolean;

説明

Center プロパティを使うと，FrameHeight が ClientHeight と同じでないか FrameWidth が ClientWidth と同じでない場合にアニメーションコントロールで AVI クリップのフレームの位置を決められます。Center が True の場合，フレームはコントロールのクライアント領域で縦横の中央に配置されます。Center が False の場合，フレームの左上隅がクライアント領域の左上隅に合わせて配置されます。


TAnimate.CommonAVI
TAnimate.CommonAVI3008007

TAnimate	参照	例

CommonAVI プロパティは，アニメーションコントロールが Shell32.dll で提供される組み込みの Windows AVI クリップの 1 つを表示するかどうかを示します。

TCommonAVI = (aviNone, aviFindFolder, aviFindFile, aviFindComputer, aviCopyFiles,

    aviCopyFile, aviRecycleFile, aviEmptyRecycle, aviDeleteFile);

property CommonAVI: TCommonAVI;

説明

CommonAVI プロパティを設定すると，組み込みの Windows AVI クリップの 1 つをアニメーションコントロールで表示できます。CommonAVI が aviNone のときは FileName プロパティに指定された AVI クリックが表示されます。

CommonAVI プロパティを設定すると，FileName が空の文字列に，ResHandle と ResID が 0 に，ResName が空の文字列に自動的に設定されます。

注意

CommonAVI は，NT 3.51 環境は使用できません。


TAnimate.FileName
TAnimate.FileName3008008

TAnimate	参照

FileName プロパティは，アニメーションコントロールで表示される AVI クリップが入っているファイルの名前です。

TFileName = string;

property FileName: TFileName;

説明

FileName プロパティを設定すると，ファイルに格納された AVI クリップをアニメーションコントロールに表示できます。FileName は，AVI クリップが入ったファイルの名前でなければなりません。

注意

FileName を設定すると，CommonAVI プロパティが aviNone に，ResHandle と ResID が 0 に，ResName が空の文字列に自動的に設定されます。


TAnimate.FrameCount
TAnimate.FrameCount3008009

TAnimate	参照

FrameCount プロパティは，AVI クリップ内のフレームの合計数です。

property FrameCount: Integer;

説明

FrameCount プロパティでアニメーションコントロールで表示可能なフレーム数を取得できます。アニメーションコントロールは，AVI クリップ内のすべてのフレームを再生したり，あるいは一部を映したりできます。


TAnimate.FrameHeight
TAnimate.FrameHeight3008010

TAnimate	参照

FrameHeight プロパティは，AVI クリップ内の各イメージのピクセル単位の高さです。

property FrameHeight: Integer;

説明

FrameHeight プロパティは，AVI クリップのフレームを完全に表示するのに必要な高さを設定できます。AutoSize が True の場合，アニメーションコントロールは自動的にそのサイズを変更して FrameHeight の値に合わせます。


TAnimate.FrameWidth
TAnimate.FrameWidth3008011

TAnimate	参照

FrameWidth プロパティは，AVI クリップ内の各イメージのピクセル単位の幅です。

property FrameWidth: Integer;

説明

FrameWidth プロパティは，AVI クリップのフレームを完全に表示するのに必要な幅を設定できます。AutoSize が True の場合，アニメーションコントロールは自動的にそのサイズを変更して FrameWidth の値に合わせます。


TAnimate.Open
TAnimate.Open3008012

TAnimate	参照

Open プロパティは，AVI クリップがメモリにロードされているかどうかを示します。

property Open: Boolean;

説明

Open プロパティは，AVI クリップがロードされていて再生の準備が整っているかどうかを取得できます。AVI クリップが CommonAVI，FileName，ResName，または ResID プロパティを使って指定されているときは，アニメーションコントロールが自動的に開かれます。Open が True の場合，アニメーションコントロールは，Active プロパティまたは Play メソッドを使ってクリップが再生されるまで StartFrame プロパティで指定されたフレームを表示します。

Open を False に設定すると，AVI クリップで使われたリソースを解放できます。アニメーションコントロールが開いていないときは，どのフレームも表示できせません。

注意

Open プロパティが False から True に変更されると，StartFrame プロパティが 1 にリセットされ，StopFrame プロパティが FrameCount にリセットされます。


TAnimate.Repetitions
TAnimate.Repetitions3008013

TAnimate	参照

Repetitions プロパティは，フレームのシーケンスを繰り返す回数です。

property Repetitions: Integer;

説明

Repetitions プロパティを設定すると，Active プロパティが True に設定されているときに AVI クリップ内のフレームの再生を繰り返す回数を指定できます。指定された回数だけ再生が繰り返されると，Active の値が再び False になります。

1 度だけ再生するには，Repetitions を 1 に設定します。Repetitions を 0 に設定すると，無限に再生を繰り返すことを示します。Repetitions が 0 の場合，Active プロパティまたは Stop メソッドを使ってアニメーションに割り込みます。

注意

Play メソッドは，Count パラメータとして渡される値で Repetitions をオーバーライドします。


TAnimate.ResHandle
TAnimate.ResHandle3008014

TAnimate	参照

ResHandle プロパティは，AVI クリップをリソースとして持つモジュールの Windows ハンドルです。

THandle = Integer;

property ResHandle: THandle;

説明

実行時にアニメーションリソースを含むモジュールのインスタンスハンドルまたはモジュールハンドルを ResHandle プロパティに設定し，その後，ResID または ResName プロパティを設定すると，示されたモジュールのどのリソースをアニメーションコントロールで表示する AVI クリップにするかを指定できます。

ResHandle の値が指定されていないときは，アニメーションコントロールはアプリケーションの実行形式ファイルのインスタンスを使います。

注意

ResHandle プロパティを設定すると，CommonAVI プロパティが aviNone に，RFileNam プロパティが空の文字列に自動的に設定されます。


TAnimate.ResID
TAnimate.ResID3008015

TAnimate	参照

ResID プロパティは AVI クリップのリソース ID です。

property ResID: Integer;

説明

ResID プロパティを設定すると，アニメーションコントロールで表示される AVI クリップとして使うリソースを識別できます。ResHandle を使うと，ResID で識別されるリソースを含むモジュールを示すことができます。

リソースファイルが AVI クリップを番号ではなく名前で識別するときは，かわりに ResName プロパティを使います。

注意

ResID プロパティを設定すると，CommonAVI プロパティが aviNone に，FileName プロパティが空の文字列に，ResName プロパティが空の文字列に自動的に設定されます。


TAnimate.ResName
TAnimate.ResName3008016

TAnimate	参照

ResName プロパティは AVI クリップのリソース名です。

property ResName: string;

説明

ResName プロパティを設定すると，アニメーションコントロールで表示される AVI クリップとして使うリソースを識別できます。ResHandle を使うと，ResName で識別されるリソースが入ったモジュールを示すことができます。

リソースファイルが AVI クリップを名前ではなく番号で識別するときは，かわりに ResID プロパティを使います。

注意

ResName プロパティを設定すると，CommonAVI プロパティが aviNone に，FileName プロパティが空の文字列に，ResID プロパティが 0 に自動的に設定されます。


TAnimate.StartFrame
TAnimate.StartFrame3008017

TAnimate	参照

StartFrame プロパティは，アニメーションコントロールがアクティブになったときに表示される最初のフレームです。

property StartFrame: SmallInt;

説明

StartFrame プロパティを設定すると，Active プロパティが True に設定されたときに表示される AVI クリップ内の最初のフレームを指定できます。StartFrame が 1 のときはクリップは冒頭から再生され，StartFrame が 2 のときはクリップが 2 番目のフレームから始まります。Repetitions が 1 でない場合，フレームが再生され一巡した後，StartFrame で指定されたフレーム（クリップ内の最初のフレームではない場合もある）から再生が再開されます。

アニメーションコントロールが Open プロパティでも Active でない場合，StartFrame で指定されたフレームを表示します。

注意

Play メソッドは，FromFrame パラメータとして渡される値で StartFrame をオーバーライドします。


TAnimate.StopFrame
TAnimate.StopFrame3008018

TAnimate	参照

StopFrame プロパティは，アニメーションコントロールがアクティブにされたときに表示される最後のフレームです。

property StopFrame: SmallInt;

説明

StopFrame プロパティを設定すると，アニメーションコントロールがそのフレームを再生するたびに最後に表示される AVI クリップ内のフレームを指定できます。StopFrame が 0 の場合，クリップの末尾まで再生されます。それ以外の場合，StopFrame は表示される最後のフレームの番号を示します。Active プロパティが True に設定されると，Repetitions プロパティで指定された反復回数だけ，アニメーションコントロールが StartFrame から StopFrame までの再生を繰り返します。

注意

Play メソッドは，ToFrame パラメータとして渡される値で StopFrame をオーバーライドします。


TAnimate.Timers
TAnimate.Timers3008019

TAnimate	参照

Timers プロパティは，フレームがタイマーを使って表示されるかどうかを指定します。

property Timers: Boolean;

説明

Timers プロパティを設定すると，AVI クリップ内のフレームをタイマーメッセージへの応答として変更するかどうか，シーケンスの進行を個別の実行スレッドで非同期にするかどうかを指定できます。Timers が True の場合，フレームはタイマーメッセージへの応答として進行します。これは，アニメーションシーケンスをサウンドトラックの再生などのほかのアクションと同期させるときに役立ちます。Timers が False の場合，AVI クリップは個別のスレッドで再生されます。


TAnimate.Transparent
TAnimate.Transparent3008020

TAnimate	参照

Transparent プロパティは，フレームの背景色を Color プロパティに一致させるかどうかを指定します。

property Transparent: Boolean;

説明

Transparent プロパティを True に設定すると，AVI ファイルに格納された背景色を Color プロパティの値で置き換えることができます。ただし，ParentColor の値が True の場合には親コントロールの色になります。Transparent を False に設定すると，AVI クリップに格納された背景色が表示されます。


TAnimate イベント3008021

TAnimate	アルファベット順	凡例

TAnimate

OnClose

OnOpen

OnStart

OnStop


TAnimate イベント3008022

TAnimate	オブジェクト順	凡例

OnClose

OnOpen

OnStart

OnStop


TAnimate.OnClose
TAnimate.OnClose3008023

TAnimate	参照

OnClose イベントは，アニメーションコントロールが閉じた直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnClose: TNotifyEvent;

説明

OnClose イベントハンドラを記述すると，Open プロパティが False に設定されたときに特定のアクションを実行できます。たとえば，アニメーションコントロールを使って一連の AVI クリップを循環する場合，クリップを OnClose イベントハンドラ内で変更できます。

クリップが再生を停止したとき（ただし，アニメーションコントロールが開いたままの状態）に応答するには，OnStop イベントを使います。


TAnimate.OnOpen
TAnimate.OnOpen3008024

TAnimate	参照

OnOpen イベントは，アニメーションコントロールが開いた直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnOpen: TNotifyEvent;

説明

OnOpen イベントハンドラを記述すると，Open プロパティが False から True に変わったときに特定のアクションを実行できます。これは，AVI クリップがアクティブにされる前に Repetitions，StartFrame，StopFrame プロパティを 設定したり，特定のフレームを探したりするために利用することができます。


TAnimate.OnStart
TAnimate.OnStart3008025

TAnimate	参照

OnStart イベントは，アニメーションコントロールが再生を開始した直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnStart: TNotifyEvent;

説明

OnStart イベントハンドラを記述すると，AVI クリップが再生されたときに特定のアクションを実行できます。Active プロパティを True に設定するか Play メソッドを呼び出すと，OnStart イベントが発生します。OnStart は，アニメーションの再生に同期させるほかのアクションを起動するのに役立ちます。


TAnimate.OnStop
TAnimate.OnStop3008026

TAnimate	参照

OnStop イベントは，アニメーションコントロールが再生を終了したときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnStop: TNotifyEvent;

説明

OnStop イベントハンドラを記述すると，AVI クリップがすべての繰り返し再生を完了したときに特定のアクションを実行できます。たとえば，OnStop イベントハンドラを使って，OnStart イベントハンドラ内で開始されたすべての同時進行のアクションを閉じることができます。


TAnimate メソッド3008027

TAnimate	アルファベット順

TAnimate

Create

Play

Reset

Seek

Stop

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TAnimate メソッド3008028

TAnimate	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Play

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

Reset

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

Seek

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Stop

Update

UpdateControlState


TAnimate.Create
TAnimate.Create3008029

TAnimate	参照

Create メソッドは，アニメーションコントロールを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，アニメーションコントロールをインスタンス化できます。設計時にフォーム上に配置されたアニメーションコントロールは自動的に作成されます。継承コンストラクタを呼び出した後，Create は以下のプロパティを初期化します。

・	AutoSize を True に設定

・	Center を True に設定

・	ControlStyle を [csReflector] に設定

・	StartFrame を 1 に設定

・	Transparent を True に設定


TAnimate.Play
TAnimate.Play3008030

TAnimate	参照

Play メソッドは，AVI クリップの指定されたフレームを再生します。

procedure Play(FromFrame, ToFrame: Word; Count: Integer);

説明

Play メソッドを呼び出すと，Count プロパティで指定された回数だけ指定されたフレームを再生することができます。FromFrame はシーケンスの最初のフレームで，1 であればクリップ内の最初のフレームを，2 であれば 2 番目のフレームといったように特定のフレームを指定できます。ToFrame はシーケンスの最後のフレームです。ToFrame の値は，FromFrame の値以上かつ FrameCount の値以下でなければなりません。Count は，再生が繰り返される回数を指定します。Count が 0 の場合，Stop メソッドが呼び出されるまで再生が繰り返されます。

アニメーションコントロールの Open プロパティが True でないときに Play が呼び出されると，Play が Open を True に設定します。

注意

Play を呼び出すのは，StartFrame を FromFrame に，StopFrame を ToFrame に，Repetitions を Count に設定してから Active を True に設定するのと同じです。


TAnimate.Reset
TAnimate.Reset3008031

TAnimate	参照

Reset メソッドは，StartFrame および StopFrame の値をクリアして，AVI クリップ内の最初のフレームを表示します。

procedure Reset;

説明

Reset メソッドを呼び出すと，アニメーションコントロールをデフォルト状態に戻せます。Reset はアニメーションコントロールを閉じてもう一度開き，OnClose イベントと OnOpen イベントを発生させます。アニメーションコントロールは開いたままでアクティブではない状態になります。


TAnimate.Seek
TAnimate.Seek3008032

TAnimate	参照

Seek メソッドは，シーケンス内で指定されたフレームを表示します。

procedure Seek(Frame: SmallInt);

説明

Seek メソッドを呼び出すと，AVI クリップ内の特定のフレームにジャンプできます。Frame パラメータはフレームを指定しますが，1 ではシーケンスの最初のフレーム，2 では 2 番目のフレームとなります。Frame は，FrameCount の値以下でなければなりません。

アニメーションコントロールが開いていないときに Seek が呼び出されると，Seek が Open を True に設定します。


TAnimate.Stop
TAnimate.Stop3008033

TAnimate	参照

Stop メソッドは，再生しているアニメーションコントロールに割り込みます。

procedure Stop;

説明

Stop メソッドを呼び出すと，アクティブなアニメーションコントロールでのイメージシーケンスを停止できます。Stop は，Active プロパティを False に設定したのと同じことをします。


スコープ3008034

published

読み出し／書き込み

読み出し専用


スコープ3008035

published


継承3008036

TObject

TPersistent

TComponent

TControl

TWinControl


TAnimate 例3008037

TAnimate


TWebApplication
TWebApplication3009001

継承	プロパティ	メソッド	参照

TWebApplication オブジェクトは Web サーバーアプリケーションをカプセル化します。

ユニット

httpapp

説明

TWebApplication は Web サーバーアプリケーションの基本動作を提供します。TWebApplication は，HTTP 要求メッセージとその応答をそれぞれ表す TWebRequest オブジェクトおよび TWebResponse オブジェクトを作成し，各オブジェクトをディスパッチャに渡して応答に項目を入れられるようにし，Web クライアントに応答を送り返すためのメソッド群を提供します。

各 Web サーバープロジェクトは自動的に，TWebApplication 型の Application 変数をアプリケーションのインスタンスとして宣言します。CGI アプリケーションでは，この変数は CGIApp ユニットで TCGIApplication オブジェクトに初期化されます。ISAPI アプリケーションでは，この変数は ISAPIApp ユニットで TISAPIApplication オブジェクトに初期化されます。

Application 変数をプロジェクトに追加するには，Delphi のメインウィンドウのメニューから［ファイル(F)｜新規作成(N)］を選択し，［新規作成］ダイアログで［Webサーバーアプリケーション］を選択します。Forms ユニットは衝突する TApplication 型の Application 変数を宣言しているので，プロジェクトのユーザーリストに追加しないでください。さらに，ISAPIApp ユニットを CGI アプリケーションに追加したり，CGIApp ユニットを ISAPI または NSAPI アプリケーションに追加したりしないでください。CGIApp ユニットと ISAPIApp ユニットはそれぞれ，Application 変数の初期インスタンスを作成します。ユーザーリストに 2 つのユニットを含めると，最初のユニットで作成されたオブジェクトのメモリが失われます。


TWebApplication プロパティ3009002

TWebApplication	アルファベット順	凡例

TWebApplication

ActiveCount

CacheConnections

InactiveCount

MaxConnections

Title

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TWebApplication プロパティ3009003

TWebApplication	オブジェクト順	凡例

ActiveCount

CacheConnections

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

InactiveCount

MaxConnections

Name

Owner

Tag

Title

VCLComObject


TWebApplication.ActiveCount
TWebApplication.ActiveCount3009004

TWebApplication	参照

ActiveCount プロパティは，アプリケーションで現在サービス中のアクティブな接続の数を示します。

property ActiveCount: Integer;

説明

ActiveCount プロパティは，アプリケーションがある時点でサービスしている HTTP 要求メッセージの数を取得できます。しばらくの間，この値が MaxConnections プロパティの最適値を示します。

ISAPI アプリケーションは HTTP 要求メッセージを受け取るたびに，Web データモジュールの新しいインスタンスを生成します。その応答が Web クライアントに返されると，Web データモジュールは破棄されるか非アクティブにされてから，後で再使用するためにキャッシュされます。アクティブな各 Web データモジュールは個別の実行スレッドに格納されます。

ActiveCount は，現在使用中の Web データモジュールの数です。InactiveCount は，後で再使用するためにキャッシュされる非アクティブになった Web データモジュールの数です。MaxConnections は，任意の時点でアクティブにできる Web データモジュールの最大数です。ActiveCount は決して MaxConnections を超えることはできません。

注意

ActiveCount は ISAPI アプリケーションに対してのみ意味を持ちます。各 CGI アプリケーションは 1 つの要求メッセージだけを処理します。


TWebApplication.CacheConnections
TWebApplication.CacheConnections3009005

TWebApplication	参照

CacheConnections プロパティは，アプリケーションが使う Web モジュールを再使用のためにキャッシュするかどうかを指定します。

property CacheConnections: Boolean;

説明

ISAPI アプリケーションまたは NSAPI アプリケーションは HTTP 要求メッセージを受け取るたびに，スレッドを呼び出して要求を処理し，Web アプリケーションが使うすべてのオブジェクトのインスタンスを保持する新しい Web モジュールを作成します。処理効率を向上させるためには，HTTP 要求メッセージに関連付けられたスレッドが実行を終了したときにこのような Web モジュールをキャッシュに保存できます。

CacheConnections を True に設定すると，Web アプリケーションに非アクティブな Web モジュールをキャッシュに保存させることができます。Web モジュールをキャッシュすると，Web モジュールとその内容の新しいインスタンスを要求メッセージを受け取るたびに作成する必要がなくなるので処理が高速化されます。CacheConnections を False に設定すると，Web アプリケーションに要求スレッドごとに新しい Web モジュールを作成させることができます。Web モジュールを再作成すると，最後の要求へのサービス時にモジュールやその内容に加えられた変更のせいで次回にモジュールがアクティブにされたときに予想外の動作が発生するのを確実に避けられます。

注意

CacheConnections は ISAPI Web アプリケーションと NSAPI Web アプリケーションのみに関係します。


TWebApplication.InactiveCount
TWebApplication.InactiveCount3009006

TWebApplication	参照

InactiveCount プロパティは，後の再使用のためにキャッシュされる Web データモジュールの数を示します。

property InactiveCount: Integer;

説明

InactiveCount プロパティは，未使用の Web データモジュールの数を取得できます。しばらくの間，この値が MaxConnections プロパティの最適値を示します。

CacheConnections が True の場合，ISAPI アプリケーションが HTTP 要求メッセージを受け取るたびに，非アクティブな Web モジュールの 1 つを再びアクティブにします。アプリケーションは，InactiveCount が 0 の場合に Web データモジュールの新しいインスタンスを生成します。応答が Web クライアントに返された後，Web データモジュールは再び非アクティブにされ，InactiveCount プロパティでカウントされます。

CacheConnections が False の場合，HTTP 要求メッセージのそれぞれに対して新しい Web データモジュールが作成され，応答が返された時点で破棄されます。CacheConnections が False の場合には InactiveCount は常に 0 です。

注意

InactiveCount は，ISAPI アプリケーションに対してのみ意味を持ちます。各 CGI アプリケーションは要求メッセージを 1 つだけ処理するので，未使用データモジュールをキャッシュする必要はありません。


TWebApplication.MaxConnections
TWebApplication.MaxConnections3009007

TWebApplication	参照

MaxConnections プロパティは，アプリケーションが同時に処理できる要求メッセージの最大数です。

property MaxConnections: Integer;

説明

MaxConnections プロパティを設定すると，アプリケーションが同時に処理できる HTTP 要求メッセージの数を調整できます。ActiveCount プロパティと InactiveCount プロパティを使って，要求メッセージの頻度と持続期間を感覚的に把握できます。次に，アプリケーションが Web データモジュールを使い果たしたときの例外を避けられる程度の数を上限とし，同時実行するスレッドが多すぎて処理能力を大幅に劣化させることがない程度の数を下限とするような MaxConnections を設定します。

ActiveCount が既に MaxConnections に達しているときに要求メッセージを受け取った場合，アプリケーションは例外を発生させます。

注意

MaxConnections は，ISAPI アプリケーションに対してのみ意味を持ちます。各 CGI アプリケーションは要求メッセージを 1 つだけ処理します。


TWebApplication.Title
TWebApplication.Title3009008

TWebApplication	参照

Title プロパティは，最小化されたアプリケーションを表すアイコンの下に表示されるテキストを保持します。

property Title: string;

説明

Title プロパティは，アプリケーションアイコンの下に表示されるこのテキスト文字列の名前を決定します。デフォルト値は，実行時に DLL/EXE ファイル名から取得されます。

Title と Name プロパティを混同しないでください。Name は，Web アプリケーションがコード内で参照されるときの識別子です。


TWebApplication メソッド3009009

TWebApplication	アルファベット順	凡例

TWebApplication

ActivateWebModule

Create

CreateForm

DeactivateWebModule

Destroy

DoHandleException

HandleRequest

Initialize

Run

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TWebApplication メソッド3009010

TWebApplication	オブジェクト順	凡例

ActivateWebModule

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateForm

DeactivateWebModule

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DoHandleException

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HandleRequest

HasParent

InheritsFrom

Initialize

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

Run

SafeCallException


TWebApplication.ActivateWebModule
TWebApplication.ActivateWebModule3009011

TWebApplication	参照

ActivateWebModule メソッドは，アプリケーションの Web データモジュールをアクティブにして返します。

function ActivateDataModule: TDataModule;

説明

ActivateDataModule メソッドは，アプリケーションが HTTP 要求メッセージを受け取ったときに内部的に呼び出されます。InactiveCount プロパティがゼロより大きいときは，キャッシュされた Web モジュールが再びアクティブにされます。それ以外の場合，Web データモジュールの新しいインスタンスが作成されます。

ActivateDataModule を呼び出す前に，CreateForm メソッドを呼び出してデータモジュールを登録しなければなりません。

Web アプリケーションオブジェクトは，Web データモジュールを 1 つだけ保持します。通常，その Web データモジュールは TWebModule オブジェクトですが，TWebDispatcher オブジェクトを保持する通常のデータモジュールでもありえます。Web アプリケーションに関連付けられた Web データモジュールがない場合，ActivateDataModule は例外を発生させます。ActivateWebModule が呼び出されたときに ActiveCount プロパティが既に MaxConnections に達している場合は，ActivateWebModule は例外を発生させます。


TWebApplication.Create
TWebApplication.Create3009012

TWebApplication	参照

Create メソッドは TWebApplication のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出さないでください。CGIApp ユニットや ISAPIApp ユニットがプロジェクトのユーザーリストにインクルードされると，Application という Web アプリケーションオブジェクトのインスタンスが自動的に 1 つ作成されます。

Create は，TWebApplication が使うヘルパーオブジェクトを割り当てます。


TWebApplication.CreateForm
TWebApplication.CreateForm3009013

TWebApplication	参照

CreateForm メソッドは，1 つの Web データモジュールを Web アプリケーションに登録します。

procedure CreateForm(InstanceClass: TComponentClass; var Reference); virtual;

説明

アプリケーションで CreateForm メソッドを呼び出さないでください。Delphi のモジュールマネージャは，Web アプリケーションの Web データモジュールを登録するために内部的に CreateForm を呼び出します。

Create は，アプリケーションの Web データモジュールのクラスを登録します。Web データモジュールオブジェクトは，ActivateDataModule メソッドが初めて呼び出されたときに後で作成されます。


TWebApplication.DeactivateWebModule
TWebApplication.DeactivateWebModule3009014

TWebApplication	参照

DeactivateWebModule メソッドは，アプリケーションの Web データモジュールを非アクティブにします。

procedure DeactivateDataModule(DataModule: TDataModule);

説明

DeactivateDataModule メソッドを直接呼び出さないでください。Web アプリケーションは HTTP 要求メッセージを処理した後に，DeactivateDataModule を内部的に呼び出します。CacheConnections が True の場合，次の要求メッセージを受け取るまで Web データモジュールは非アクティブのままです。CacheConnections が False の場合，Web データモジュールの実行時インスタンスが破棄されます。


TWebApplication.Destroy
TWebApplication.Destroy3009015

TWebApplication	参照

Destroy メソッドは TWebApplication のインスタンスを破棄します。

destructor Destroy; override;

説明

Destroy メソッドまたは Free メソッドは決して呼び出さないでください。アプリケーションは実行を停止した時点で自動的に解放されます。

Destroy は，アプリケーションが作成したすべての Web データモジュールだけでなく，スタートアップ時に作成されたヘルパーオブジェクトも解放します。


TWebApplication.DoHandleException
TWebApplication.DoHandleException3009016

TWebApplication	参照

DoHandleException メソッドは，アプリケーション内で発生した例外を処理するメソッドのインターフェースを提供します。

procedure DoHandleException(E: Exception); dynamic;

説明

TWebApplication の DoHandleException メソッドはすべての例外を破棄します。TWebApplication の下位オブジェクトは，アプリケーション内で例外が発生したときに特殊な応答を提供するためにこのメソッドをオーバーライドできます。


TWebApplication.HandleRequest
TWebApplication.HandleRequest3009017

TWebApplication	参照

HandleRequest は，サーバーが受け取る HTTP 要求メッセージに応答します。

function HandleRequest(Request: TWebRequest; Response: TWebResponse): Boolean;

説明

TWebApplication の派生オブジェクトが HTTP 要求メッセージを受け取ると，それはそのメッセージを表現するために TWebRequest オブジェクトを，その要求と対応させるために TWebResponse メッセージを作成します。これは次に HandleRequest を呼び出して，そういったオブジェクトを Request パラメータおよび Response パラメータとして渡します。

HandleRequest は，Web アプリケーションに関連付けられた Web データモジュールをアクティブにします。これは次に要求を適切なアクション項目にディスパッチできるように，要求オブジェクトと応答オブジェクトをディスパッチャに渡します。ディスパッチャが戻ると，HandleRequest はその応答が処理後に送られたかどうかをチェックして，送られていない場合にはそれを送ります。最後に，HandleRequest はデータモジュールを非アクティブにします。

HandleRequest は，要求メッセージが処理されて送られたかどうかを示す論理値を返します。


TWebApplication.Initialize
TWebApplication.Initialize3009018

TWebApplication	参照

Initialize メソッドは，アプリケーションを初期化するメソッドのインターフェースを導入します。

procedure Initialize; virtual;

説明

TWebApplication の Initialize メソッドは何もしません。Initialize は各 Delphi プロジェクトに対して呼び出される最初のメソッドです。アプリケーションが動作を始める前に初期化を実行しなければならない TWebApplication の下位オブジェクトは，その目的のためにこのメソッドをオーバーライドします。

注意

Initialize はプロジェクトソースコードで呼び出される最初のメソッドですが，アプリケーション内で実行される最初のコードではありません。


TWebApplication.Run
TWebApplication.Run3009019

TWebApplication	参照

Run メソッドは Web アプリケーションを実行します。

procedure Run; virtual;

説明

新しいプロジェクトを作成すると，Delphi は Run メソッド を呼び出す主要なプログラムブロックをプロジェクトファイルに自動的に作成します。アプリケーションが実行されると，アプリケーションの Run メソッドが呼び出されます。

TWebApplication の Run メソッドは，アプリケーションのデフォルトのエラーハンドラを設定してアプリケーションのシーケンスをシャットダウンします。TWebApplication の下位オブジェクトは，HTTP 要求メッセージを受け取るために Run メソッドをオーバーライドし，到着する要求用の TWebRequest オブジェクトと TWebResponse オブジェクトを作成し，その要求を処理するために HandleRequest メソッドを呼び出します。


スコープ3009020

published

読み出し／書き込み

読み出し専用


スコープ3009021

protected


継承3009022

TObject

TPersistent

TComponent


TWebApplication 例3009023

TWebApplication


TApplication
TApplication3010001

継承	プロパティ	メソッド	イベント	参照

TApplication は Delphi アプリケーションで使う型です。

ユニット

forms

説明

TApplcation クラスは，Windows アプリケーションをカプセル化します。TApplication で導入されるメソッドやプロパティは，Windows オペレーティングシステムの基本的要素を反映して，アプリケーションを作成，実行，維持，および廃棄します。つまり TApplication は，Windows アプリケーションの作成時に，ユーザーと Windows 環境との間のインターフェースを簡素化します。TApplication は以下の動作をカプセル化します。

・	Windows のメッセージ処理

・	状況感知型のオンラインヘルプ

・	メニューアクセラレータとキー処理

・	例外処理

・	Windows オペレーティングシステムがアプリケーションに対して定義する基本部分（MainWindow，WindowClass など）の管理

すべての Delphi アプリケーションでは，アプリケーションのインスタンスである Application 変数が自動的に宣言されます。Delphi アプリケーションが Web サーバーアプリケーションでない場合，この変数は TApplication 型です。TApplication はコンポーネントパレットに表示されないため，フォーム設計者が視覚的に操作することはできません。そのため TApplication には Published プロパティはありません。しかし，TApplication のいくつかの Public なプロパティは，設計時に［プロジェクト(P)｜オプション(O)］で表示される［プロジェクトオプション］ダイアログボックスの［フォーム］ページと［アプリケーション］ページで設定および修正することができます。


TApplication プロパティ3010002

TApplication	アルファベット順	凡例

TApplication

Active

AllowTesting

CurrentHelpFile

DialogHandle

ExeName

Handle

HelpFile

Hint

HintColor

HintHidePause

HintPause

HintShortPause

Icon

MainForm

ShowHint

ShowMainForm

Terminated

Title

UpdateFormatSettings

UpdateMetricSettings

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TApplication プロパティ3010003

TApplication	オブジェクト順	凡例

Active

AllowTesting

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

CurrentHelpFile

DesignInfo

DialogHandle

ExeName

Handle

HelpFile

Hint

HintColor

HintHidePause

HintPause

HintShortPause

Icon

MainForm

Name

Owner

ShowHint

ShowMainForm

Tag

Terminated

Title

UpdateFormatSettings

UpdateMetricSettings

VCLComObject


TApplication.Active
TApplication.Active3010004

TApplication	参照

Active プロパティは，アプリケーションがアクティブでフォーカスがあるかどうかを示します。

property Active: Boolean;

説明

Active プロパティは読み出し専用であり，アプリケーションがアクティブの場合は True を返し，アクティブでない場合は False を返します。Active はコンストラクタ内では True に設定されます。

アプリケーションは，フォームまたはアプリケーションにフォーカスがある場合はアクティブとなり，異なるアプリケーションのウィンドウがアクティブになる場合は非アクティブとなります。Active はデストラクタ内では False に設定されます。


TApplication.AllowTesting
TApplication.AllowTesting3010005

TApplication

AllowTesting プロパティは，内部でのみ使われます。

property AllowTesting: Boolean

説明

AllowTesting は使わないでください。このプロパティは内部でのみ使われます。


TApplication.DialogHandle
TApplication.DialogHandle3010006

TApplication	参照

DialogHandle プロパティは，Delphi アプリケーションで Delphi ダイアログボックス以外のダイアログボックスを使うためのメカニズムを提供します。

property DialogHandle: HWnd;

説明

DialogHandle プロパティは，CreateDialog API 関数を使って作成されていて，アプリケーションのメッセージループからのメッセージを参照して操作を行う必要があるモードなしダイアログボックスを作成できます。

このような場合は，ダイアログボックスがアクティブ化メッセージ（WM_NCACTIVATE）を受け取ったときに，モードなしダイアログボックスのハンドルを DialogHandle に割り当て，ダイアログボックスが非アクティブ化メッセージを受け取ったときに DialogHandle をゼロに設定します。サンプルコードを以下に示します。

例

以下に，Delphi によって Windows の検索置換コモンダイアログボックスをカプセル化するウィンドウプロシージャの一部を示します。

function SearchAndReplaceWndProc(Wnd: HWnd; Msg, WParam: Word; LParam: Longint): Longint;

begin

  try

    case Msg of

      WM_DESTROY: Application.DialogHandle := 0;	{ ハンドルをクリアする }

      WM_NCACTIVATE:

        if Bool(WParam) then	{ アクティブにしている場合... }

          Application.DialogHandle := Wnd	{ ...ハンドルを割り当てる... }

        else Application.DialogHandle := 0;
{ ...その他の場合はハンドルをクリアする }

      ...

    end;

    Result := CallDefDialogProc;

  except

    Application.HandleException(nil);

  end;

end;


TApplication.ExeName
TApplication.ExeName3010007

TApplication	参照

ExeName プロパティは，実行可能アプリケーションのファイル名（パス情報を含む）を提供します。

property ExeName: string;

説明

ExeName プロパティは読み出し専用です。ExeName は，アプリケーションの実行可能ファイル名を取得できます。

アプリケーション名は，プロジェクトファイルに指定した名前に拡張子 .EXE を付けたものです。デフォルト名は PROJECT1.EXE です。ExeName を変更するには，プロジェクトファイルを目的の名前で保存してアプリケーションを再構築します。


TApplication.Handle
TApplication.Handle3010008

TApplication	参照

Handle プロパティは，アプリケーションのメインフォーム（ウィンドウ）のウィンドウハンドルにアクセスできます。

property Handle: HWND;

説明

Handle プロパティは，親ウィンドウハンドルを要求する Windows API 関数を呼び出すことができます。たとえば，DLL がそれ自体のトップレベルのポップアップウィンドウを表示するには，アプリケーション内にそのウィンドウを表示するために親ウィンドウが必要です。Application.Handle を使うと，ウィンドウをアイコン化したり元に戻したり，アプリケーションで有効にしたり無効にしたりすることが可能な，アプリケーションのウィンドウ部分を作成できます。

注意

VCL を使う DLL を書くときは，EXE ホストのメインウィンドウのウィンドウハンドルを DLL の Application.Handle プロパティに割り当てます。これにより，ホストアプリケーションの DLL のフォーム部分が作成されます。このハンドルは EXE 内の Application.Handle に割り当ててはいけません。


TApplication.HelpFile
TApplication.HelpFile3010009

TApplication	参照

HelpFile プロパティは，アプリケーションがヘルプを表示するのに使うファイルの名前を示します。

property HelpFile: string;

説明

HelpFile プロパティは，Windows のヘルプシステムで利用するヘルプファイルを備えたアプリケーションで使います。Windows は HelpFile プロパティで指定されたファイルを表示します。実行時に HelpFile プロパティにファイル名を割り当てるか，または設計時に［プロジェクト(P)｜オプション(O)］で表示される［プロジェクトオプション］ダイアログボックスの［アプリケーション］ページでヘルプファイルを指定します。

デフォルト値はヌル文字列です。ヌルの場合，アプリケーションの Help メソッドはヘルプを表示しません。HelpFile にファイル名があれば，HelpContext メソッドはそのファイル名をヘルプに使うファイルの名前として Windows ヘルプシステムに渡します。

注意

アクティブフォームのヘルプファイルが割り当てられている場合，アプリケーションのヘルプファイルではなく，アクティブフォームのヘルプファイルが表示されます。


TApplication.Hint
TApplication.Hint3010010

TApplication	参照

Hint プロパティは，ヘルプヒントボックスに表示されるテキスト文字列を指定します。

property Hint: string;

説明

TApplication の Hint プロパティは，現在マウスポインタが置かれているコントロールまたはメニュー項目の Hint 値に割り当てられます。このプロパティは，ユーザーに何らかのアクションやエラー，およびその他の情報を知らせる文字列値にも割り当てることができます。

・	OnHint イベントハンドラを使って，ヒントをコントロールからステータスバーなど他の表示領域に移動して，Hint プロパティを読み込みます。

・	アプリケーションが何らかのアクションを処理している間に，そのアプリケーションのステータスを表示します。

OnHint イベントが発生するとヘルプヒントが表示されます。そのため，たとえば TApplication の Hint プロパティがステータスバーのキャプションに割り当てられると，ステータスバーコントロールのキャプションでは OnHint イベントの間に Hint プロパティの現在の文字列値が表示されます。

Hint 文字列には，ショートとロングの 2 つの部分があります。ショートヒントはポップアップツールヒントに使います。ロングヒントは，「|」文字で区切られた他方の文字列をステータスバーに使います。Controls ユニットにあるグローバル関数 GetShortHint と GetLongHint を使うと，ヒント文字列からロングヒントとショートヒントを抽出できます。

注意

アプリケーションでのイベントの発生をユーザーに知らせるメッセージに Hint を設定するときは，デフォルトではマウスカーソルをコントロール上に移動すると，Hint 文字列がコントロールの Hint 値にリセットされます。


TApplication.HintColor
TApplication.HintColor3010011

TApplication	参照

HintColor プロパティは，アプリケーションのヘルプヒントのヒントボックスの色を指定します。

property HintColor: TColor;

説明

ヒントボックスの色は HintColor で指定します。アプリケーションを作成すると，コンストラクタ内の HintColor プロパティにデフォルトのカラー値である clInfoBk が設定されます。HintColor を変更するには，実行時に HintColor に新しい TColor 値を割り当てます。


TApplication.HintHidePause
TApplication.HintHidePause3010012

TApplication	参照

HintHidePause プロパティは，マウスがコントロールから移動していない場合にヘルプヒントを隠すまでの一時停止時間を指定します。

property HintHidePause: Integer;

説明

HintHidePause プロパティは，コンストラクタ内に設定された一時停止時間のデフォルト値である 2500 ミリ秒（2 1/2 秒）と異なる値をミリ秒単位で指定できます。コントロールやメニュー項目のヘルプヒントは Hint プロパティで指定します。

注意

デフォルト値は，HintPause よりも少し長い時間の定義済み const 値です。


TApplication.HintPause
TApplication.HintPause3010013

TApplication	参照

HintPause プロパティは，マウスポインタをコントロールやメニュー項目に移動したときにコントロールのヘルプヒントが表示されるまでの時間間隔を指定します。

property HintPause: Integer;

説明

HintPause を使うと，コンストラクタ内に設定された一時停止時間のデフォルト値である 500 ミリ秒（1/2 秒）を別の値に変更できます。HintPause に値を割り当てるときは，ミリ秒単位の時間間隔を指定します。一時停止が終わったときに表示されるヘルプヒントは Hint プロパティで指定します。


TApplication.HintShortPause
TApplication.HintShortPause3010014

TApplication	参照

HintShortPause プロパティは，ヒントがすでに表示されている場合にヒントを呼び出すまでの一時停止時間を指定します。

property HintShortPause: Integer;

説明

HintShortPause プロパティは，ヘルプヒントがすべてオンになっている一連のボタンの上でマウスをすばやく移動したときに，画面のちらつきを抑えることができます。コンストラクタ内に設定されたデフォルト値の 50 ミリ秒と異なる値を指定するときはミリ秒単位で指定します。


TApplication.Icon
TApplication.Icon3010015

TApplication	参照

Icon プロパティは，Windows のタスクバーでアプリケーションを表すアイコンを指定します。

property Icon: TIcon;

説明

Icon プロパティは，アプリケーションに特定のアイコンを割り当てることができます。

・	実行時に TIcon を Icon プロパティに割り当てます。

・	設計時に［プロジェクト(P)｜オプション(O)］で表示される［プロジェクトオプション］ダイアログボックスの［アプリケーション］ページでアイコンをロードします。

アイコンは最小化状態のアプリケーションを示し，Windows のデスクトップや Windows 95 のタスクバーに表示されます。


TApplication.MainForm
TApplication.MainForm3010016

TApplication	参照

MainForm プロパティは，アプリケーションのどのフォームがメインウィンドウかを示します。

property MainForm: TForm;

説明

MainForm プロパティは，アプリケーションのメインウィンドウとして，デフォルトと異なるフォームを指定できます。この値は CreateForm メソッドで作成される最初のフォームになるように設定されます。新しいプロジェクトを作成すると，MainForm プロパティの値は自動的に Form1 になります。別のフォームを MainForm プロパティに割り当てるには，設計時に［プロジェクト(P)｜オプション(O)］で表示される［プロジェクトオプション］ダイアログボックスの［フォーム］ページを使います。MainForm は読み出し専用なので，実行時に修正することはできません。

メインフォームは，アプリケーションのメインプログラムで最初に作成されるフォームです。メインフォームを閉じるとアプリケーションは終了します。


TApplication.ShowHint
TApplication.ShowHint3010017

TApplication	参照

ShowHint プロパティは，アプリケーション全体を通じてヘルプヒントを使用可能にするか使用不可にするかを決めます。

property ShowHint: Boolean;

説明

ShowHints プロパティは，ヘルプヒントを表示できます。ShowHint が True ならばヘルプヒントは使用可能，False ならば使用不可です。デフォルト値は True です。ヘルプヒントは Hint プロパティで指定します。

アプリケーションで ShowHint を False に設定すると，個々のコントロールの ShowHint プロパティ値に関係なくすべてのヘルプヒントが使用不可になります。


TApplication.ShowMainForm
TApplication.ShowMainForm3010018

TApplication	参照

ShowMainForm プロパティは，アプリケーションが起動時にそのメインフォームを表示するかどうかを決めます。

property ShowMainForm: Boolean;

説明

ShowMainForm プロパティは，アプリケーションが起動時にそのメインフォームを表示するかどうか，またはいつ表示するかを制御します。

コンストラクタ内ではデフォルト値の True が設定され，デフォルトではメインフォームが表示されます。MainForm プロパティは，どのフォームがメインフォームなのかを指定します。

起動時にメインフォームを表示しない場合は，Application.Run の呼び出し前にメインプロジェクトファイルで ShowMainForm を False に設定し，フォームの Visible プロパティも False になっているかを確認します。これは多くの場合，OLE オートメーションサーバーの実装で役立ちます。通常，OLE オートメーションサーバーではメインフォームを表示しないためです。


TApplication.Terminated
TApplication.Terminated3010019

TApplication	参照

Terminated プロパティは，アプリケーションを終了する Windows の WM_QUIT メッセージをアプリケーションが受け取ったかを判定します。

property Terminated: Boolean;

説明

Terminated プロパティは読み出し専用です。通常 Terminated プロパティは，アプリケーションの終了後に Windows メッセージを処理しないように ProcessMessages メソッドを呼び出すときに使います。ProcessMessage が WM_QUIT メッセージを受け取ると，Terminated は True に設定されます。

通常，Delphi アプリケーションで WM_QUIT メッセージを受け取るのは，アプリケーションのメインウィンドウが閉じられたためか Terminate メソッドが呼び出されたためです。

ループ内で大量の計算を行うようなアプリケーションの場合は，Application.ProcessMessages を定期的に呼び出して Application.Terminated を調べ，計算処理を中止してアプリケーションを終了できるようにすべきかどうかを決めます。


TApplication.Title
TApplication.Title3010020

TApplication	参照

Title プロパティは，アプリケーションの最小化を表すアイコンの下に付けるテキストを指定します。

property Title: string;

説明

Title プロパティは，アプリケーションの最小化を表すアイコンの下に付けるテキスト文字列を指定できます。デフォルト値は実行時に DLL/EXE ファイル名から取得されます。

Title は実行時に設定するか，［プロジェクト(P)｜オプション(O)］で表示される［プロジェクトオプション］ダイアログボックスの［アプリケーション］ページの Title 値を指定します。


TApplication.UpdateFormatSettings
TApplication.UpdateFormatSettings3010021

TApplication

UpdateFormatSettings プロパティは，システムの設定が変更されたときにフォーマット設定を自動的に更新するかどうかを指定します。

property UpdateFormatSettings: Boolean;

説明

UpdateFormatSettings プロパティは，フォーマット設定の自動更新を制御できます。コンストラクタ内ではデフォルト値の True が設定されます。アプリケーションが WM_WININICHANGE メッセージを受け取ると，UpdateFormatSettings プロパティがチェックされます。

Windows のローカル設定に初期化されているデフォルトのフォーマット設定を使うことを推奨します。しかし，Delphi アプリケーションでフォーマット設定を変更したときに，アプリケーションの実行中は設定の変更を避ける場合には，UpdateFormatSettings を False に設定できます。


TApplication.UpdateMetricSettings
TApplication.UpdateMetricSettings3010022

TApplication

UpdateMetricSettings プロパティは，ヒントウィンドウとアイコンタイトルのフォントの設定を更新するかどうかを指定します。

property UpdateMetricSettings: Boolean;

説明

UpdateMetricSettings プロパティは，システム設定が変更された場合に，ヒントウィンドウのフォントとデスクトップ上のアイコンタイトルのフォントにその変更を反映するかどうかを指定できます。

コンストラクタ内では初期値の True が設定されます。


TApplication イベント3010023

TApplication	アルファベット順

TApplication

OnActivate

OnDeactivate

OnException

OnHelp

OnHint

OnIdle

OnMessage

OnMinimize

OnRestore

OnShowHint


TApplication イベント3010024

TApplication	オブジェクト順

OnActivate

OnDeactivate

OnException

OnHelp

OnHint

OnIdle

OnMessage

OnMinimize

OnRestore

OnShowHint


TApplication.OnActivate
TApplication.OnActivate3010025

TApplication	参照

OnActivate イベントはアプリケーションがアクティブになったときに発生します。

TNotifyEvent = procedure (Sender: TObject) of object;

property OnActivate: TNotifyEvent;

説明

OnActivate イベントを使うと，アプリケーションがアクティブになったときに特殊処理を実行するイベントハンドラを書けます。

アプリケーションは，最初に実行されたときや，フォーカスが別の Windows アプリケーションから元のアプリケーションのいずれかのウィンドウに戻ったときにアクティブになります。


TApplication.OnDeactivate
TApplication.OnDeactivate3010026

TApplication	参照

OnDeactivate イベントは，アプリケーションが非アクティブになったときに発生します。

TNotifyEvent = procedure (Sender: TObject) of object;

property OnDeactivate: TNotifyEvent;

説明

OnDeactive イベントは，アプリケーションが非アクティブになったときに発生させる特殊処理を指定できます。OnDeactivate イベントは，アプリケーションを別の Windows アプリケーションへ切り替えたときに発生します。


TApplication.OnException
TApplication.OnException3010027

TApplication	参照

OnException イベントは，アプリケーション内で処理されない例外が起きたときに発生します。

TExceptionEvent = procedure (Sender: TObject; E: Exception) of object;

property OnException: TExceptionEvent;

説明

OnException イベントは，アプリケーション内で処理されない例外が起きたときに発生するデフォルトの動作を変更できます。OnException イベントハンドラは HandleException メソッドで自動的に呼び出されます。

OnException イベントは，メッセージ処理の間に発生した例外のみを処理します。Application.Run の前後に発生する例外は，Application.HandleException または OnException を呼び出しません。

アプリケーションコードのどの try ブロックでも例外が処理されないと，アプリケーションはエラーの発生を知らせるダイアログボックスを表示する HandleException メソッドを自動的に呼び出します。EAbort 以外の例外オブジェクトでは，HandleException は OnException ハンドラがある場合はそれを呼び出し，ない場合は ShowException を呼び出してエラーの発生を示すメッセージダイアログボックスを表示します。

TExceptionEvent 型は OnException イベントの型です。TExceptionEvent はアプリケーション内で例外を処理するメソッドを指します。送り側のパラメータは例外を起こすオブジェクトであり，例外オブジェクトは E となります。


TApplication.OnHelp
TApplication.OnHelp3010028

TApplication	参照

OnHelp イベントは，アプリケーションがヘルプ要求を受け取ったときに発生します。

THelpEvent = function (Command: Word; Data: Longint;   var CallHelp: Boolean): Boolean of      object;

property OnHelp: THelpEvent;

説明

OnHelp イベントは，ヘルプが要求されたときに特殊処理を実行するイベントハンドラを記述できます。HelpContext および HelpJump メソッドは，自動的に OnHelp イベントを発生します。

イベントの後に VCL が WinHelp を呼び出すようにするには，CallHelp を True に設定します。VCL が WinHelp を呼び出さないようにするには，CallHelp を False に設定します。

すべてのアプリケーションのヘルプメソッドは OnHelp を呼び出します。OnHelp の CallHelp パラメータが True を返すか，または OnHelp が指定されない場合のみ，WinHelp が呼び出されます。

Command および Data パラメータ値についての解説は，Win32オンラインヘルプ（Win32.HLP）ファイルで WinHelp を探してください。WinHelp には WinHelp API （アプリケーションプログラミングインターフェース）についての説明があります。Data パラメータの適切な値は，Command パラメータの値によって決まります。

この関数が成功したときは戻り値 True を返し，失敗したときは戻り値 False を返します。


TApplication.OnHint
TApplication.OnHint3010029

TApplication	参照

OnHint イベントは，ヘルプヒントを表示することができるコントロールまたはメニュー項目にマウスポインタを置くと発生します。

TNotifyEvent = procedure (Sender: TObject) of object;

property OnHint: TNotifyEvent;

説明

OnHint イベントは，OnHint イベントが発生したときに特殊処理を実行するイベントハンドラを記述できます。OnHint イベントは，Hint プロパティ値が空文字列（''）以外のときに，マウスポインタをコントロール上に置くと発生します。

OnHint イベントの一般的な使い方は，コントロール項目またはメニュー項目の Hint プロパティの値をパネルコントロール（TStatusBar）のキャプションとして表示し，それによってパネルをステータスバーとして使うことです。Hint プロパティを使うと，ヘルプヒントや，OnHint イベントが発生したときにほかの場所に表示される長いヒントを指定できます。

例

次のコードでは，フォーム上のステータスバーコンポーネント，メニュー，および編集ボックスを使います。メニュー内の各メニュー項目ごとに Hint プロパティの値を指定します。また，編集ボックスの Hint プロパティの値も指定します。

OnHint イベントハンドラを書くには，TForm1 オブジェクトのメソッドを作成し，そのメソッドに DisplayHint などの適切な名前を付けます。このメソッドはユニットの implementation 部に書きますが，public セクションの TForm1 型宣言でメソッドを宣言します。

DisplayHint メソッドの中では，アプリケーションの Hint プロパティをパネルコンポーネントの Caption プロパティに割り当てます。

この新しいメソッドを OnHint イベントが使うメソッドとして割り当てます。この例では，この割り当てをフォームの OnCreate イベントハンドラの中で記述しています。

ユーザーがアプリケーションを実行し，カーソルを編集ボックスの上かメニューのいずれかのメニュー項目の上に置くと，指定したヒントがフォーム最下部のパネルのキャプションとして表示されます。

type

  TForm1 = class(TForm)

    Button1: TButton;

    StatusBar1: TStatusBar;

    Edit1: TEdit;

    procedure FormCreate(Sender: TObject);

  private

    { Private 宣言 }

  public

    procedure DisplayHint(Sender: TObject);

  end;

var

  Form1: TForm1;

implementation

{$R *.FRM}

procedure TForm1.DisplayHint(Sender: TObject);

begin

  StatusBar1.Caption := GetLongHint(Application.Hint);

end;

procedure TForm1.FormCreate(Sender: TObject);

begin

  Application.OnHint := DisplayHint;

end;


TApplication.OnIdle
TApplication.OnIdle3010030

TApplication

OnIdle イベントは，アプリケーションがアイドル状態のときに発生します。

TIdleEvent = procedure (Sender: TObject; var Done: Boolean) of object;

property OnIdle: TIdleEvent

説明

OnIdle イベントハンドラは，アプリケーションがアイドル状態のときに特殊処理を実行するイベントハンドラを記述できます。アプリケーションがアイドル状態になるのは，たとえばコードを処理しているときか，ユーザーからの入力を待っているときです。

OnIdle は，アプリケーションがアイドル状態になったときに一度だけ呼び出され，Done が False に設定されない限り再び呼び出されることはありません。Done が False の場合は，WaitMessage は呼び出されません。アプリケーションが Done を False に設定すると，CPU の負荷が極端に高まるため，システム全体のパフォーマンスが低下します。

TIdleEvent の型は OnIdle イベントの型であり，アプリケーションがアイドル状態のときに実行されるメソッドを指します。TIdleEvent は論理パラメータ Done を持ち，これはデフォルトでは True です。Done が True ならば，OnIdle が戻ったときに Windows API の WaitMessage 関数が呼び出されます。WaitMessage はアプリケーションのメッセージキューに新しいメッセージが現れるまで他のアプリケーションに制御を譲ります。Done が False ならば WaitMessage は呼び出されません。


TApplication.OnMessage
TApplication.OnMessage3010031

TApplication	参照

OnMessage イベントは，アプリケーションが受け取る Windows メッセージを処理します。

TMessageEvent = procedure (var Msg: TMsg; var Handled: Boolean) of object;

property OnMessage: TMessageEvent;

説明

OnMessage イベントは，アプリケーションのすべてのウィンドウに送られるすべての Windows メッセージをトラップできます。OnMessage イベントはアプリケーションが Windows メッセージを受け取ったときに発生します。アプリケーションの中に OnMessage イベントハンドラを作成すれば，TApplication のイベントで宣言されたメッセージ以外のメッセージに応答する別のハンドラを呼び出せます。アプリケーションに着信メッセージ用の特定のハンドラがない場合，そのメッセージは目的のウィンドウへディスパッチされ，Windows によって処理されます。

TMessageEvent の型は OnMessage イベントの型であり，送られた Windows メッセージを処理するメソッドを指します。Msg パラメータは Windows メッセージを指定し，Handled パラメータはメッセージが処理されるかどうかを指定します。メッセージが完全に処理されたら，Handled を True に設定して，メッセージが通常どおりに処理されないようにします。

注意

OnMessage WaitMessage はメッセージキューに送られたメッセージだけを受け取り，Windows API の SendMessage 関数によって直接送られたメッセージは受け取りません。

警告

1 秒間に数千のメッセージがこのイベントを通過するので，ハンドラをコーディングするときはパフォーマンスの低下に注意してください。


TApplication.OnMinimize
TApplication.OnMinimize3010032

TApplication	参照

OnMinimize イベントはアプリケーションが最小化されたときに発生します。

TNotifyEvent = procedure (Sender: TObject) of object;

property OnMinimize: TNotifyEvent;

説明

OnMinimize イベントは，アプリケーションが最小化されてアイコン状態になったときに特殊処理を実行するイベントハンドラを記述できます。アプリケーションは，ユーザーがメインウィンドウをアイコン化するか，Minimize メソッドが呼び出されるとアイコン化されます。Icon プロパティはアプリケーションをアイコン化したときに使うアイコンを指定します。


TApplication.OnRestore
TApplication.OnRestore3010033

TApplication	参照

OnRestore イベントは，前にアイコン化されたアプリケーションが元のサイズに復元されるときに発生します。

TNotifyEvent = procedure (Sender: TObject) of object;

property OnRestore: TNotifyEvent;

説明

OnRestore イベントは，アイコン化されたアプリケーションの復元時に特殊処理を実行するイベントハンドラを記述できます。アプリケーションは，ユーザーがアプリケーションを復元するか，アプリケーションが Restore メソッドを呼び出すと復元します。

注意

アプリケーションを復元することはフォームまたはウィンドウを元のサイズに復元することとは違います。ウィンドウまたはフォームを最小化，最大化，復元するには，WindowState プロパティの値を変更します。


TApplication.OnShowHint
TApplication.OnShowHint3010034

TApplication	参照

OnShowHint イベントは，アプリケーションが特定のコントロールについてヘルプヒント用のヒントウィンドウを表示しようとしたときに発生します。

THintInfo = record

    HintControl: TControl;

    HintPos: TPoint;

    HintMaxWidth: Integer;

    HintColor: TColor;

    CursorRect: TRect;

    CursorPos: TPoint;

    ReshowTimeout: Integer;

    HideTimeout: Integer;

    HintStr: string;

  end;

TShowHintEvent = procedure (var HintStr: string; var CanShow: Boolean; var HintInfo: THintInfo) of object;

property OnShowHint: TShowHintEvent;

説明

OnShowHint イベントは，ヘルプヒントの外観と動作を変更するイベントハンドラを記述できます。

TShowHintEvent は OnShowHint イベントの型です。TShowHintEvent はコントロールのヘルプヒントを表示するメソッドを指します。HintStr パラメータはヘルプヒントのテキストを設定します。特定のコントロール用のヒントのテキストは，GetLongHint または GetShortHint 関数を呼び出して結果を HintStr に代入すると得られます。テキストを変更したい場合はこの文字列の内容を変更します。

CanShow 変数を使うと，ヘルプヒントの表示を行うかどうかを指定できます。CanShow が True の場合はヘルプヒントが表示されます。CanShow が True の場合はヘルプヒントが表示され，False の場合は表示されません。

レコードの HintControl 項目にはヒント処理が発生しているコントロールの名前が入ります。

HintPos 項目はヒントウィンドウの左上隅のデフォルト位置となる画面座標を示します。この値を変更するとウィンドウの表示位置を変更できます。

HintMaxWidth 項目は，ヒントウィンドウでテキストの折り返しを行わない最大幅を指定します。デフォルトではこの値が画面の幅（Screen.Width）です。

CursorRect 項目は，ヒントウィンドウを表示するマウスポインタの位置を長方形で指定します。CursorRect のデフォルト値は，コントロールの長方形のクライアント領域です。アプリケーションでこの値を変更すると，単一コントロールをいくつかのヒント領域に分割することができます。ユーザーがマウスポインタを長方形の外に移動すると，ヒントウィンドウが消えます。

CursorPos 項目には，コントロール内のマウスポインタの位置が入ります。

ReshowTimeout 項目は，ヒントシステムがヒントの状態を再び問い合わせるまでの待ち時間を示します。デフォルトではこの項目はゼロで，ヒントの状態が変わらないことを示します。項目にゼロ以外の値を設定すると，要求された時間（ミリ秒）が経過した後，ヒントはあたかもユーザーがマウスをヒントの長方形の外に移動してから元に戻したかのように動きます。これは一定の時間ヒントの処理を延期したり，定期的にヒントを更新したりする場合に使われます。

HideTimeout 項目はヒントを表示する時間（ミリ秒）を示します。デフォルトでは，この項目は Application.HintHidePause に設定されます。

HintStr 項目にはヒントウィンドウに表示される文字列が入ります。これにより，OnHint イベントは表示前にヒントの内容を修正できます。デフォルトでは，この項目に GetShortHint(Application.Hint) という式の値が入ります。


TApplication メソッド3010035

TApplication	アルファベット順

TApplication

BringToFront

CancelHint

ControlDestroyed

Create

CreateForm

CreateHandle

Destroy

HandleException

HandleMessage

HelpCommand

HelpContext

HelpJump

HideHint

HintMouseMessage

HookMainWindow

Initialize

MessageBox

Minimize

NormalizeAllTopMosts

NormalizeTopMosts

ProcessMessages

Restore

RestoreTopMosts

Run

ShowException

Terminate

UnhookMainWindow

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TApplication メソッド3010036

TApplication	オブジェクト順

Assign

BringToFront

CancelHint

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ControlDestroyed

Create

CreateForm

CreateHandle

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HandleException

HandleMessage

HasParent

HelpCommand

HelpContext

HelpJump

HideHint

HintMouseMessage

HookMainWindow

InheritsFrom

Initialize

InitInstance

InsertComponent

InstanceSize

MessageBox

MethodAddress

MethodName

Minimize

NewInstance

NormalizeAllTopMosts

NormalizeTopMosts

ProcessMessages

RemoveComponent

Restore

RestoreTopMosts

Run

SafeCallException

ShowException

Terminate

UnhookMainWindow


TApplication.BringToFront
TApplication.BringToFront3010037

TApplication	参照

BringToFront メソッドは，デスクトップ上で直前にアクティブだったアプリケーションをそれ以外のすべてのアプリケーションの前に移動します。

procedure BringToFront;

説明

BringToFront メソッドを使うと，MainForm が保有する直前にアクティブだったウィンドウを見つけて前面に移動できます。BringToFront は，ウィンドウを最前面に移動する前に，そのウィンドウの可視性と有効性も調べます。


TApplication.CancelHint
TApplication.CancelHint3010038

TApplication	参照

CancelHint メソッドは，コントロール用のヒントの表示をキャンセルします。

procedure CancelHint;

説明

アプリケーションは CancelHint メソッドを直接呼び出すことはほとんどありません。CancelHint は VCL の内部で用いられ，ウィンドウが不正な場合やアプリケーションが閉じた場合などに応じて，ヒントの表示をキャンセルします。CancelHint は，画面をクリアしたりコントロール用のヒントウィンドウのタイミングを発行したりする一連のルーチンを呼び出します。


TApplication.ControlDestroyed
TApplication.ControlDestroyed3010039

TApplication	参照

ControlDestroyed メソッドは，内部的に使われ，コントロールが破棄されたことをアプリケーションに通知します。

procedure ControlDestroyed(Control: TControl);

説明

ConrolDestroyed は内部的に使われるメソッドで，TControl によって自動的に呼び出されます。このメソッドを直接呼び出す必要はありません。

注意

ControlDestroyed メソッドは，Control パラメータとして渡されたコントロールが破棄されたことをアプリケーションに知らせるので，MainForm や ActiveForm のようなアプリケーションのポインタが正しいコントロールオブジェクトや nil を指すように更新できます。


TApplication.Create
TApplication.Create3010040

TApplication	参照

Create メソッドは，新しいアプリケーションを作成します。

constructor Create(AOwner: TComponent); override;

説明

アプリケーションは Create を直接呼び出すことはありません。Delphi の各アプリケーションでは，アプリケーションオブジェクトのインスタンスが自動的に作成されます。

TApplication では，Create メソッドはいくつかのプロパティにはデフォルト値を設定します。また TApplication は，ヒントウィンドウ，アプリケーションアイコン，メインウィンドウハンドル，HInstance，メインウィンドウ（フォーム）の子ウィンドウについての管理リストなどを設定して，アプリケーションを実行する準備を整えます。


TApplication.CreateForm
TApplication.CreateForm3010041

TApplication	参照

CreateForm メソッドは，新しいフォームを作成します。

procedure CreateForm(FormClass: TFormClass; var Reference);

説明

アプリケーションは常に CreateForm メソッドを呼び出しますが，Delphi のプログラミングでは CreateForm を直接呼び出すコードを作成する必要はほとんどありません。

Delphi プロジェクトのメインの実行部には CreateForm の呼び出しが通常 1 つまたは複数個含まれており，フォームの作成を自動的に処理します。ただし，アプリケーションは，実行時に CreateFrom を呼び出して自分でフォームを作成することもできます。

CreateForm は FormClass パラメータで指定する型のフォームを新しく作成し，これを Reference パラメータで指定する変数に割り当てます。新しいフォームのオーナーは Application オブジェクトです。デフォルトでは，プロジェクトで最初に CreateForm を呼び出して作成するフォームがプロジェクトのメインフォームになります。


TApplication.CreateHandle
TApplication.CreateHandle3010042

TApplication	参照

CreateHandle メソッドは，アプリケーションの Handle プロパティにハンドルが 1 つもない場合にハンドルを生成します。

procedure CreateHandle;

説明

CreateHandle メソッドを直接呼び出してはいけません。TApplication.Create は，EXE では CreateHandle を呼び出しますが，DLL では呼び出しません。

CreateHandle は，おもに多くの Windows API 関数の WinMain をカプセル化したものです。たとえば，CreateHandle は Window Class を登録し，アプリケーションの作成やアプリケーションウィンドウの表示方法の指定を行います。


TApplication.Destroy
TApplication.Destroy3010043

TApplication	参照

Destroy メソッドは，アプリケーションのインスタンスを破棄し，それに割り当てていたメモリを解放します。

destructor Destroy; override;

説明

Application.Destroy や Application.Free を呼び出してはいけません。アプリケーションを終了するときは Application.Terminate を使います。

Destroy メソッドは，継承した Destroy を呼び出す前に，アプリケーションが非アクティブになったことを示す信号を発します。その後，Destroy はフックされているウィンドウやオブジェクトのインスタンス，アプリケーションの起動時に作成されたオブジェクトとリスト，および実行中に蓄積されたオブジェクトとリストについて，それぞれメモリを解放します。

アプリケーションはすべてのフォームを所有するので，そのアプリケーションのデストラクタを使えばどのフォームも破棄できます。


TApplication.HandleException
TApplication.HandleException3010044

TApplication	参照

HandleException メソッドは，アプリケーションの例外のデフォルト処理を行います。

procedure HandleException(Sender: TObject);

説明

コンポーネント開発者にとって HandleException は，Windows メッセージへの応答時に存在していなかったイベントを生成するカスタムコンポーネントを実現するときに便利なメソッドです。

アプリケーションにほかの例外処理コードを指定するには，OnException イベントハンドラを使います。

アプリケーションコードのどの try ブロックでも例外が処理されないと，アプリケーションは HandleException メソッドを自動的に呼び出します。このメソッドはエラーの発生を知らせるダイアログボックスを表示します。例外オブジェクトが EAbort 以外の場合は，HandleException は OnException ハンドラがあればそれを呼び出し，なければ ShowException を呼び出して，エラーの発生を知らせるメッセージダイアログボックスを表示します。


TApplication.HandleMessage
TApplication.HandleMessage3010045

TApplication	参照

HandleMessage メソッドは，アプリケーションの実行を中断して，Windows が Windows メッセージキューの単一メッセージを処理してから，制御をアプリケーションに戻します。

procedure HandleMessaage;

説明

メッセージキューが空のときは，HandleMessage メソッドはアプリケーションの Idle メソッドを呼び出します。このメソッドは，OnIdle イベントハンドラが定義されていればそれを順番に呼び出します。

注意

アプリケーションがアイドル状態になった場合，HandleMessage がリターンするまでには時間がかかります。このため，メッセージベースのアクションを待機しているときに，優先度の高いアクションも処理中の場合は，HandleMessage を呼び出さないでください。一方，メッセージだけでなく他のアクションも処理するときは ProcessMessages を呼び出します。


TApplication.HelpCommand
TApplication.HelpCommand3010046

TApplication	参照

HelpCommand メソッドは，WinHelp API のヘルプコマンドに簡単にアクセスできます。

function HelpCommand(Command: Word; Data: Longint): Boolean;

説明

WinHelp メソッドにアクセスするには HelpCommand を使います。

HelpCommand は，OnHelp イベントを呼び出すメソッドをそのまま呼び出すラッパー関数です。

呼び出せるコマンドとコマンドに渡されるデータについての詳細は，Windows API のヘルプで「WinHelp」のトピックを参照してください。


TApplication.HelpContext
TApplication.HelpContext3010047

TApplication	参照

HelpContext メソッドは，アプリケーションのヘルプファイルを表示します。

THelpContext = -MaxLongInt..MaxLongInt;

function HelpContext(Context: THelpContext): Boolean;

説明

HelpContext メソッドは，HelpFile プロパティで指定したアプリケーションのヘルプファイルを呼び出します。HelpContext は直接 OnHelp を呼び出します。

HelpContext は HelpFile で指定したファイル名と，Context パラメータで指定したコンテキスト番号を示します。たとえば Context パラメータに 714 を指定すると，HelpContext メソッドは指定したヘルプファイルのコンテキストヘルプ ID が 714 の画面を表示します。

HelpFile が空文字列の場合 HelpContext は False を返して，アプリケーションにヘルプファイルが割り当てられていないことを示します。そうでない場合は True を返します。


TApplication.HelpJump
TApplication.HelpJump3010048

TApplication	参照

HelpJump メソッドは，OnHelp を間接的に呼び出します。

function HelpJump(const JumpID: string): Boolean;

説明

HelpJump メソッドは，指定したトピックの Help を呼び出せます。HelpJump は HelpFile で指定したファイル名と JumpID パラメータで指定したコンテキスト文字列を示します。たとえば JumpID に vclDefaultProperty を指定すると HelpJump メソッドはコンテキスト文字列 vclDefaultProperty があるヘルプファイルの画面を表示します。

HelpFile が空文字列の場合 HelpJump は False を返して，アプリケーションにヘルプファイルが割り当てられていないことを示します。そうでない場合は True を返します。


TApplication.HideHint
TApplication.HideHint3010049

TApplication	参照

HideHint メソッドは，現在のヒントを非表示にします。

procedure HideHint;

説明

アプリケーションは HideHint メソッドを直接呼び出すことはほとんどありません。HideHint は Delphi の内部で用いられ，事前に定義済みの条件やタイマー値に応じて，ヒントウィンドウを消去します。たとえば，CancelHint は HideHint を呼び出します。


TApplication.HintMouseMessage
TApplication.HintMouseMessage3010050

TApplication	参照

HintMouseMessage メソッドは，ヒントウィンドウの表示を制限します。

procedure HintMouseMessage(Control: TControl; var Message: TMessage);

説明

アプリケーションは HintMouseMessage メソッドを直接呼び出すことはほとんどありません。HintMouseMessage は Delphi の内部で用いられ，ヒントウィンドウの表示を管理します。


TApplication.HookMainWindow
TApplication.HookMainWindow3010051

TApplication	参照

HookMainWindow メソッドは，非 Delphi ダイアログボックスが，その親に送られたメッセージを受け取れるようにします（親は，アプリケーションオブジェクトの Handle プロパティで示されます）。

type TWindowHook = function(var Message: TMessage): Boolean of object;

説明

HookMainWindow メソッドは，非 Delphi ダイアログボックスを単独のウィンドウとしてではなく，そのアプリケーションの子ウィンドウとして動作させます。たとえば，HookMainWindow の呼び出し後であれば，アプリケーションを〔Alt〕+〔Tab〕キーで切り替えるときに，非 Delphi ダイアログボックスは個別のタスクとして扱われず，アプリケーションはそのダイアログを含む単独のタスクとして扱われます。

TWindowHook の型は，HookMainWindow メソッドで使うパラメータ型です。これは，非 Delphi ダイアログボックスのダイアログ手続きで使うメソッドポインタ型です。ダイアログ手続きは，ウィンドウ用のウィンドウ手続きと似ていて，ダイアログボックスのメッセージを処理しますがその構文は多少異なります。

長期間ダイアログボックスをメインウィンドウにフックしておいても問題はありませんが，それでも，アプリケーションの終了時にはダイアログボックスを閉じ UnhookMainWindow メソッドを呼び出してフックを解放してください。


TApplication.Initialize
TApplication.Initialize3010052

TApplication

Initialize メソッドは，各 Delphi プロジェクトで呼び出される最初のメソッドであり，OLE オートメーションとほかのサブシステムを呼び出して初期化します。

procedure Initalize;

説明

Initialize メソッドは， InitProc の手続きポインタを自動的に呼び出します。このポインタは，OLE オートメーションを処理する手続きを指すポインタです。

Initialize は Delphi アプリケーションで呼び出される最初のメソッドであるため，InitProc ポインタは前もって定義しておかなければなりません。デフォルトでは，アプリケーションの Initialize を呼び出しても nil であるデフォルトの InitProc ポインタが呼び出されるため何も起こりません。

OLE オートメーション手続きを呼び出すには，以下のいずれかの方法を実行します。

・	ComObj ユニットなどのような，InitProc を定義するユニットを追加する

・	OLE オートメーションのカスタム手続きを定義して InitProc ポインタに割り当て，これをコードの最初の行（つまり Initialize を呼び出す前）として追加する

OLE オートメーションサーバーを含まないプロジェクトの場合は，Initialize の呼び出しを無視できます。

注意

Initialize はプロジェクトのメインソースコードで呼び出される最初のメソッドですが，アプリケーションで実行される最初のコードではありません。アプリケーションは，使用する各ユニットの「initialization」セクションを最初に実行します。


TApplication.MessageBox
TApplication.MessageBox3010053

TApplication

MessageBox メソッドは，指定されたメッセージをユーザーに表示します。

function MessageBox(Text, Caption: PChar; Flags: Longint): Integer;

説明

MessageBox メソッドは，メッセージが 1 つとボタンが 1 つ以上ある汎用ダイアログボックスを表示します。Caption はオプションであり，ダイアログボックスのキャプションを指定します。

MessageBox メソッドは Windows API MessageBox 関数をカプセル化します。TApplication を使って MessageBox をカプセル化すると，Windows API 関数で必要となるウィンドウハンドルのパラメータが自動的に提供されます。

Text パラメータの値はメッセージです（255 文字を超えるメッセージも指定できます）。長いメッセージはメッセージボックス内で自動的に折り返されます。Caption プロパティの値はダイアログボックスのタイトルバーに表示されるキャプションです。キャプションは 255 字を超えることができますが折り返されません。キャプションを長くすると幅の広いメッセージボックスになります。

Flags パラメータに指定できる値については Windows API ヘルプファイルの MessageBox 関数を参照してください。ヘルプ画面上で対応するパラメータは TextType です。Flags パラメータはメッセージボックスに表示するボタンとメッセージボックスの動作を指定します。必要な効果を得るため複数の値を指定できます。

メッセージボックスの作成に必要なメモリがない場合，MessageBox メソッドは 0 を返します。それ以外の場合は次の値のうちのどれかを返します。

値	数値	意味

IDABORT	3	［中止(A)］ボタンを選択した

IDCANCEL	2	［キャンセル］ボタンを選択した

IDIGNORE	5	［無視(I)］ボタンを選択した

IDNO	7	［いいえ(N)］ボタンを選択した

IDOK	1	［OK］ボタンを選択した

IDRETRY	4	［再試行(R)］ボタンを選択した

IDYES	6	［はい(Y)］ボタンを選択した


TApplication.Minimize
TApplication.Minimize3010054

TApplication	参照

Minimize メソッドは，アプリケーションを Windows のタスクバーに格納します。

procedure Minimize;

説明

アプリケーションを最小化するには，Minimize メソッドを直接呼び出します。ユーザーがアプリケーションを最小化するときに，Minimize メソッドが自動的に呼び出されます。

注意

Minimize メソッドではフォームまたはウィンドウを最小化することはできません。ウィンドウまたはフォームを最小化，最大化，復元するには，WindowState プロパティの値を変更します。


TApplication.NormalizeAllTopMosts
TApplication.NormalizeAllTopMosts3010055

TApplication	参照

NormalizeAllTopMosts メソッドは，フォーム（メインウィンドウを含む）を作成します。作成されるフォームは，一番上のフォームとして指定したフォーム（FormStyle が fsStayOnTop のフォーム）です。

procedure NormalizeAllTopMosts;

説明

NormalizeAllTopMosts メソッドは，NormalizeTopMosts メソッドと同じような動作をしますが，NormalizeAllTopMosts メソッドは，メインウィンドウも対象としている点が異なります。


TApplication.NormalizeTopMosts
TApplication.NormalizeTopMosts3010056

TApplication	参照

NormalizeTopMosts メソッドは，一番上のフォームとして指定したフォーム（FormStyle が fsStayOnTop のフォーム）の上に別のフォームを重ねて表示できるようにします。

procedure NormalizeTopMosts;

説明

NormalizeTopMosts は，MessageBox や MessageDlg などの Windows API 関数を直接呼び出して表示されるメッセージボックスやダイアログボックスを，一番上のフォームとして表示できます。NormalizeTopMosts を呼び出さないと，フォームが一番上に表示されたままとなり，メッセージボックスをフォームの上に重ねて表示できません。

たとえば Delphi メソッドや関数を使ってメッセージボックスを表示する場合は NormalizeTopMosts を呼び出す必要はありません。

fsStayOnTop として指定したフォームを再度一番上に表示するには，RestoreTopMosts を呼び出します。


TApplication.ProcessMessages
TApplication.ProcessMessages3010057

TApplication	参照

ProcessMessages メソッドは，Windows がイベントに応答できるようアプリケーションの実行を一時的に停止します。

procedure ProcessMessages;

説明

ProcessMessages を呼び出すと，アプリケーションは ProcessMessages が呼び出された時点で Windows がそれらのイベントを処理するのを許可します。ProcessMessages メソッドは Windows メッセージループが空になるまで循環し，その後アプリケーションへ制御を戻します。

注意

Win32 では，ProcessMessages を呼び出すアプリケーションのメッセージ処理だけを無視し，そうでないアプリケーションのメッセージは処理します。時間のかかる処理を行うときに ProcessMessages を定期的に呼び出すようにすれば，アプリケーションが描画や他のメッセージに応答することが可能になります。

注意

ProcessMessages は，HandleMessages と違ってアプリケーションをアイドル状態にすることはできません。


TApplication.Restore
TApplication.Restore3010058

TApplication	参照

Restore メソッドは，最小化したアプリケーションを通常のサイズに戻します。

procedure Restore;

説明

Restore メソッドは，アプリケーションを最小化する前のサイズに戻します。ユーザーがアプリケーションを通常のサイズに戻すときに，Restore メソッドが自動的に呼び出されます。

注意

Restore メソッドではフォームまたはウィンドウを元のサイズに戻すことはできません。ウィンドウまたはフォームを最小化，最大化，復元するには，WindowState プロパティの値を変更します。


TApplication.RestoreTopMosts
TApplication.RestoreTopMosts3010059

TApplication	参照

RestoreTopMosts メソッドは，fsStayOnTop として設計されたフォームを最上位フォームに復元します。

procedure RestoreTopMosts;

説明

RestoreTopMosts メソッドは，本来最上位フォーム（FormStyle が fsStayOnTop）として設計され，NormalizeTopMosts メソッドの呼び出しで一時的に非最上位フォームに変更されたフォームを最上位フォームとして復元します。


TApplication.Run
TApplication.Run3010060

TApplication	参照

Run メソッドは，アプリケーションを実行します。

procedure Run;

説明

Run メソッドにはアプリケーションのメインのメッセージループがあります。Run を呼び出すと，アプリケーションのメッセージループが終了するまでリターンしません。

新しいプロジェクトを作成すると，Delphi は自動的にプロジェクトファイルの中に Run メソッドを呼び出すメインプログラムブロックを作成します。アプリケーションを実行すると，そのアプリケーションの Run メソッドが呼び出されます。


TApplication.ShowException
TApplication.ShowException3010061

TApplication	参照

ShowException メソッドは，アプリケーション内で発生した例外をメッセージボックスに表示します。

procedure ShowException(E: Exception);

説明

ShowException メソッドは，OnException イベントのハンドラが 1 つも指定されていないときに，デフォルトのメソッドとして呼び出されます。

例外ハンドラで例外を選別した場合は，処理されなかった例外のために ShowException を呼び出す必要があります。

アプリケーションでの例外を処理するには，OnException イベントのハンドラを作成します。

注意

Delphi アプリケーションでは，VCL のデフォルト例外ハンドラが ShowException を自動的に呼び出すので，ShowException を呼び出す必要はほとんどありません。


TApplication.Terminate
TApplication.Terminate3010062

TApplication	参照

Terminate メソッドは，アプリケーションの実行を終了します。

procedure Terminate;

説明

Terminate メソッドは，Windows API PostQuitMessage 関数を呼び出して，アプリケーションを順番に閉じます。Terminate は即座には実行されません。

Terminate は，メインフォームが閉じるときに WM_QUIT メッセージに対して自動的に呼び出されます。


TApplication.UnhookMainWindow
TApplication.UnhookMainWindow3010063

TApplication	参照

UnhookMainWindow メソッドは，以前に HookMainWindow メソッドの呼び出しでフックされたダイアログ手続きのフックを解放します。

type TWindowHook = function(var Message: TMessage): Boolean of object;

説明

UnhookMainWindow メソッドは，ウィンドウのフックを解放できます。ダイアログ手続きは Hook のパラメータ値として指定します。

TWindowHook の型は InhookMainWindow メソッドで使われるパラメータ型です。これは，非 Delphi ダイアログボックスのダイアログ手続きで使うメソッドポインタ型です。ダイアログ手続きは，ウィンドウ用のウィンドウ手続きと似ていて，ダイアログボックスのメッセージを処理しますが，その構文は多少異なります。

Windows のフックについての詳細は，Windows API のヘルプで「SetWindowsEx 関数」および「UnhookWindowsEx 関数」を参照してください。


スコープ3010064

published

読み出し／書き込み

読み出し専用


継承3010065

TObject

TPersistent

TComponent


TApplication 例3010066

TApplication


EArrayError
EArrayError3011001

継承	プロパティ	メソッド	参照

EArrayError は，TBaseArray の下位を操作するときに発生したエラーの例外クラスです。

ユニット

mxarrays

説明

EArrayError は，アプリケーションが次の処理を行おうとした場合に生成されます。

・	配列の要素にアクセスするときに無効なインデックスを使おうとした

・	上限が固定されている配列にその上限を超える要素を追加しようとした

・	ソート済み配列に要素を挿入しようとした


EArrayError のプロパティ3011002

EArrayError	アルファベット順

Exception からの継承

HelpContext

Message


EArrayError のプロパティ3011003

EArrayError	オブジェクト順

HelpContext

Message


EArrayError のメソッド3011004

EArrayError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EArrayError のメソッド3011005

EArrayError	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3011006

TObject

Exception


EArrayError の例3011007

EArrayError


TAutoObject
TAutoObject3012001

継承	プロパティ	メソッド	参照

TAutoObject は，IDispatch インターフェースをサポートし OLEオートメーションサーバーの基本クラスとして使える CoClass です。

ユニット

comobj

説明

TAutoObject は Delphi ActiveX コントロールのクラスの基本クラスとして使われ，OLE オートメーションオブジェクトのサポートを提供します。IDispatch インターフェースを実装することで，TAutoObject は次の機能をカプセル化します。

・	メソッドを呼び出すか，必要なパラメータを設定して指定された DISPinterface のプロパティにアクセスすることでオブジェクトにエクスポーズされるプロパティおよびメソッドへのアクセスを提供する

・	プロパティとメソッド（引数を含む）のテキストでの名前を，それらを識別する DISPID に対応させて変換する

・	このディスパッチインターフェースに利用可能な型情報があるかどうかを調べる

・	指定されたディスパッチインターフェースに型情報を取得する

TAutoObject はデュアルインターフェースをサポートしていて，タイプライブラリを必要とする IProvideClassInfo インターフェースのサポートを継承するのでタイプライブラリを必要とします。TAutoObject はクラスファクトリを持っています。内部的に使用し，クラスファクトリを必要としないオートメーションオブジェクトを作成する場合，TAutoIntfObject を基本クラスとして使います。

IDispatch の実装済みメソッド

GetIDsOfNames，GetTypeInfo，GetTypeInfoCount，および Invoke が実装されています。


TAutoObject のプロパティ3012002

TAutoObject	アルファベット順	凡例

TComObject からの継承

Controller

Factory

RefCount


TAutoObject のプロパティ3012003

TAutoObject	オブジェクト順	凡例

Controller

Factory

RefCount


TAutoObject のメソッド3012004

TAutoObject	アルファベット順

TComObject からの継承

Create

CreateAggregated

CreateFromFactory

Destroy

Initialize

ObjAddRef

ObjQueryInterface

ObjRelease

SafeCallException

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TAutoObject のメソッド3012005

TAutoObject	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

CreateAggregated

CreateFromFactory

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

Initialize

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ObjAddRef

ObjQueryInterface

ObjRelease

SafeCallException


アクセス種別3012006

読み出し専用


継承3012007

TObject

TComObject

TTypedComObject


TAutoObject の例3012008

TAutoObject


TAutoObjectFactory
TAutoObjectFactory3013001

継承	プロパティ	メソッド

TAutoObjectFactory は TAutoObject のクラスファクトリです。

ユニット

comobj

説明

TAutoObjectFactory は，TAutoObject クラスのインスタンスを作成します。また，作成したすべてのオートメーションオブジェクトのインスタンスの機能を管理するメソッドを持っています。TAutoObjectFactory は，IClassFactory インターフェースおよび IClassFactory2 インターフェースのサポートを継承します。


TAutoObjectFactory のプロパティ3013002

TAutoObjectFactory	アルファベット順	凡例

TAutoObjectFactory

DispIntfEntry

DispTypeInfo

TTypedComObjectFactory からの継承

ClassInfo

TComObjectFactory からの継承

ClassID

ClassName

ComClass

ComServer

Description

ErrorIID

Instancing

LicString

ProgID

ShowErrors

SupportsLicensing


TAutoObjectFactory のプロパティ3013003

TAutoObjectFactory	オブジェクト順	凡例

ClassID

ClassInfo

ClassName

ComClass

ComServer

Description

DispIntfEntry

DispTypeInfo

ErrorIID

Instancing

LicString

ProgID

ShowErrors

SupportsLicensing


TAutoObjectFactory.DispIntfEntry
TAutoObjectFactory.DispIntfEntry3013004

TAutoObjectFactory	参照

DispIntfEntry には，ファクトリに作成された OLE Automation オブジェクトが実現するディスパッチインターフェースのエントリが入ります。

TInterfaceEntry = record

    IID: TGUID;

    VTable: Pointer;

    IOffset: Integer;

  end;

PInterfaceEntry = ^TInterfaceEntry;

property DispIntfEntry: PInterfaceEntry;

説明

DispIntfEntry はコンストラクタ内で初期化され，ディスパッチインターフェースのエントリを返します。


TAutoObjectFactory.DispTypeInfo
TAutoObjectFactory.DispTypeInfo3013005

TAutoObjectFactory

DispTypeInfo は，IDispatch インターフェースの型情報への ITypeInfo インターフェース参照を返します。IDispatch インターフェースは，OLE Automation オブジェクトによって実現されます。

property DispTypeInfo: ITypeInfo;

説明

DispTypeInfo は，ファクトリが作成した OLE Automation の型情報を提供するために使われます。


TAutoObjectFactory のメソッド3013006

TAutoObjectFactory	アルファベット順

TAutoObjectFactory

Create

GetIntfEntry

TTypedComObjectFactory からの継承

GetInterfaceTypeInfo

UpdateRegistry

TComObjectFactory からの継承

CreateComObject

Destroy

RegisterClassObject

TObject からの継承

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TAutoObjectFactory のメソッド3013007

TAutoObjectFactory	オブジェクト順

ClassNameIs

ClassParent

ClassType

CleanupInstance

CreateComObject

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetInterfaceTypeInfo

GetIntfEntry

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RegisterClassObject

SafeCallException

UpdateRegistry


TAutoObjectFactory.Create
TAutoObjectFactory.Create3013008

TAutoObjectFactory	参照

Create メソッドは，TAutoObjectFactory オブジェクトのインスタンスを作成します。

constructor Create(ComServer: TComServerObject; AutoClass: TAutoClass; const ClassID: TGUID; Instancing: TClassInstancing);

説明

Create メソッドは，TAutoObjectFactory オブジェクトにメモリを割り当てて，継承された Create を呼び出して同じパラメータを渡します。次に DispIntfEntry プロパティと DispTypeInfo プロパティを初期化し，エラー時に EOleError 例外エラーを生成させます。Create は，ErrorIID プロパティを DispIntEntry へのポインタに設定します。

クラスファクトリは，クラスファクトリがインスタンス化する CoClass のコードを含むユニットの初期化セクションでインスタンス化されなければなりません。ファクトリは，サーバーがロードされたとき自動的に使用可能になります。


TAutoObjectFactory.GetIntfEntry
TAutoObjectFactory.GetIntfEntry3013009

TAutoObjectFactory	参照

GetIntfEntry メソッドは，クラス内で実現された特定のインターフェースのエントリを返します。

TInterfaceEntry = record

    IID: TGUID;

    VTable: Pointer;

    IOffset: Integer;

  end;

PInterfaceEntry = ^TInterfaceEntry;

function GetIntfEntry(Guid: TGUID): PInterfaceEntry; virtual;

説明

GetIntfEntry メソッドは，クラスファクトリに関連付けられた CoClass の GetInterfaceEntry メソッドを呼び出します。

GetIntfEntry は，クラス内にあるインターフェース（IID パラメータで指定される）のエントリを返します。GetIntfEntry は内部的に使われ，直接呼び出されることはほとんどありません。

注意

このメソッドを使って，二重 IDispatch インターフェースの呼び出しを自動的にディスパッチをする方法を OLE に記述することもできます。コンパイラがインターフェースを関連付けられた GUID に置き換えるので，インターフェースの型の名前（IUnknown など）が IID パラメータとして提供されることもあります。


アクセス種別3013010

読み出し専用


継承3013011

TObject

TComObjectFactory

TTypedComObjectFactory


TAutoObjectFactory の例3013012

TAutoObjectFactory


TAutoIncField
TAutoIncField3014001

継承	プロパティ	メソッド	イベント	参照

TAutoIncField オブジェクトは，データセット内の自動インクリメント項目を表します。

ユニット

db

説明

自動インクリメント項目は，-2,147,483,648 ～ 2,147,483,647 の範囲の整数値を保持でき，データセット内のレコードのカウンタに使われます。自動インクリメント項目では，挿入されるレコードは 1 つ前に挿入したレコードの整数値をインクリメントした値を受け取るので，各レコードには一意の値が与えられます。自動インクリメント項目は，レコードに一意の一次キー値を与えるために一般に使用されます。

TAutoIncField オブジェクトは，TIntegerField クラスによって提供されているプロパティ，イベント，およびメソッド以外のものを新しく導入することはありません。TAutoIncField オブジェクトは，自動インクリメント項目の DataType を表す別個のクラスとして存在します。


TAutoIncField プロパティ3014002

TAutoIncField	アルファベット順	凡例

TIntegerField からの継承

AsFloat

AsInteger

AsString

AsVariant

MaxValue

MinValue

Value

TNumericField からの継承

DisplayFormat

EditFormat

TField からの継承

Alignment

AsBoolean

AsCurrency

AsDateTime

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject

TFields からの継承

HasConstraints


TAutoIncField プロパティ3014003

TAutoIncField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayFormat

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditFormat

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

MaxValue

MinValue

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TAutoIncField イベント3014004

TAutoIncField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TAutoIncField イベント3014005

TAutoIncField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TAutoIncField メソッド3014006

TAutoIncField	アルファベット順

TAutoIncField

Create

TIntegerField からの継承

IsValidChar

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TAutoIncField メソッド3014007

TAutoIncField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TAutoIncField.Create
TAutoIncField.Create3014008

TAutoIncField	参照

Create メソッドは，TAutoIncField のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，TAutoIncField のインスタンスを作成および初期化できます。継承コンストラクタを呼び出した後で，Create メソッドは DataType プロパティの値を ftAutoInc に設定します。


スコープ3014009

published

読み出し／書き込み

読み出し専用


スコープ3014010

published


継承3014011

TObject

TPersistent

TComponent

TField

TNumericField

TIntegerField


TAutoIncField 例3014012

TAutoIncField


TAutoIntfObject
TAutoIntfObject3015001

継承	プロパティ	メソッド	参照

TAutoIntfObject は IDispatch インタフェースとISupportErrorInfo インタフェースをサポートするクラスで，ディスパッチインタフェースを実現し内部的に使用されるオブジェクトの基本クラスとして使います。

ユニット

comobj

説明

TAutoIntfObject はディスパッチインタフェースをサポートするオブジェクトで使いますが，内部的にのみ使うことが前提となります。TAutoIntfObject は，IDispatch インタフェースを実現することで，オートメーションオブジェクト用の機能をカプセル化します。

TAutoIntfObject はクラスファクトリを持たないため，コンストラクタを呼び出すことによってのみインスタンス化できます。外部的にインスタンス化されるオブジェクトは特有のクラスファクトリを持つため，標準的な方法でインスタンス化することができます。

TAutoIntfObject は ISupportErrorInfo インタフェースを実現することで OLE 例外処理もサポートします。

TAutoIntfObject は TAutoObject に似ています。どちらのクラスも，IDispatch および（直接的まはた間接的に）ISupportErrorInfo インタフェースを実現し，デュアルインタフェースをサポートするために型ライブラリを必要とします。TAutoIntfObject は TAutoIntfObject と TAutoObject を区別するクラスファクトリを持ちます。

IDispatch の実装済みメソッド

GetIDsOfNames，GetTypeInfo，GetTypeInfoCount，および Invoke


TAutoIntfObject のプロパティ3015002

TAutoIntfObject	アルファベット順	凡例

TAutoIntfObject

DispIID

DispIntfEntry

DispTypeInfo

TInterfacedObject からの継承

RefCount


TAutoIntfObject のプロパティ3015003

TAutoIntfObject	オブジェクト順	凡例

DispIID

DispIntfEntry

DispTypeInfo

RefCount


TAutoIntfObject.DispIID
TAutoIntfObject.DispIID3015004

TAutoIntfObject

DispIID はディスパッチ識別子です。

property DispIID: TGUID;

説明

DispIID は例外処理で使います。


TAutoIntfObject.DispIntfEntry
TAutoIntfObject.DispIntfEntry3015005

TAutoIntfObject	参照

DispIntfEntry プロパティは，オートメーションオブジェクトで実現されるディスパッチインタフェースのエントリを持ちます。

TInterfaceEntry = record

    IID: TGUID;

    VTable: Pointer;

    IOffset: Integer;

  end;

PInterfaceEntry = ^TInterfaceEntry;

property DispIntfEntry: PInterfaceEntry;

説明

DispIntfEntry プロパティは，コンストラクタ内で初期化されます。DispIntfEntry はディスパッチインタフェースのエントリを返します。


TAutoIntfObject.DispTypeInfo
TAutoIntfObject.DispTypeInfo3015006

TAutoIntfObject

DispTypeInfo プロパティは，オートメーションオブジェクトで実現される dispinterface の型情報に対する ITypeInfo インタフェース参照を返します。

property DispTypeInfo: ITypeInfo;

説明

DispTypeInfo プロパティを使うとオートメーションオブジェクトの型情報を提供できます。


TAutoIntfObject のメソッド3015007

TAutoIntfObject	アルファベット順

TAutoIntfObject

Create

SafeCallException

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TAutoIntfObject のメソッド3015008

TAutoIntfObject	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TAutoIntfObject.Create
TAutoIntfObject.Create3015009

TAutoIntfObject

Create メソッドは，オートメーションインタフェースオブジェクトをインスタンス化します。

constructor Create(const TypeLib: ITypeLib; const DispIntf: TGUID);

説明

Create メソッドを呼び出すと，オートメーションインタフェースオブジェクトをインスタンス化できます。Create はオートメーションインタフェースオブジェクトに対してメモリを割り当て，型ライブラリが存在するか確認し，DispIntfEntry プロパティを初期化します。


TAutoIntfObject.SafeCallException
TAutoIntfObject.SafeCallException3015010

TAutoIntfObject

SafeCallException メソッドは，OLE 例外処理で使います。

function SafeCallException(ExceptObject: TObject; ExceptAddr: Pointer): HResult; override;

説明

SafeCallException メソッドは，例外が発生してそのスコープ外に制御が移るのを防ぎます。また，発生した例外はすべてメソッド内で処理する必要があります。

safecall メソッドを実現すると，黙示的な try...except ブロックにそのメソッドのコードを記述しても例外は発生しません。

注意

SafeCallException はグローバルルーチンの HandleSafeCallException を呼び出します。HandleSafeCallException はこの動作の標準的な処理方法を提供します。この関数は（ISupportErrorInfo インタフェースを実現する）OLE 例外処理をサポートする CoClass の各メソッドに影響を与えます。これらの CoClass メソッドが safecall 呼び出し規約を使う場合，それらは HRESULT を返すように変更されます。手続きは HRESULT を返し，関数はそれらの通常の結果の値を最後の（出力）パラメータとして渡して，そのかわりに HRESULT を返します。メソッドは try...finally ブロックに封入され，その後 HRESULT が返されて，ISupportErrorInfo の処理が正しく機能するように環境設定されます。


アクセス種別3015011

読み出し専用


継承3015012

TObject

TInterfacedObject


TAutoIntfObject の例3015013

TAutoIntfObject


TActiveXControl
TActiveXControl3016001

継承	プロパティ	メソッド	参照

TActiveXControl は VCL コントロールを ActiveX コンテナウィンドウに埋め込む機能を提供する抽象クラスです。

ユニット

axctrls

説明

TActiveXControl は ActiveX コントロールに必要となる中心的な機能およびインターフェースを定義し，その機能を TWinControl から派生した任意の VCL コントロールに接続します。これにより，Delphi をはじめとして Internet Explorer，Visual Basic，PowerBuilder，Paradox，Borland C++ および IntraBuilder などの任意の ActiveX コンテナにコントロールを埋め込むことができるようになります。

新しい ActiveX コントロールクラスを作成するには，ActiveX コントロールウィザードを使います。ActiveX コントロールを作成する手順についての詳細は『開発者ガイド』を参照してください。

TActiveXControl クラスは TAutoObject から派生するので，作成されるオブジェクトは OLE Automation という型ライブラリをサポートし，ファクトリを持つ COM オブジェクトになります。また，TActiveXControl は以下の機能も実現します。

・	コンテナ（サイト）での埋め込み

・	インプレースでのアクティブ化

・	持続性

・	イベント

・	プロパティページ

・	プロパティのブラウズ

TActiveXControl は抽象クラスなので，インスタンス化することはできません。かわりに，TActiveXControl から新しいクラスを派生させて ActiveX コントロールを実現する必要があります。この派生クラスは実装クラスと呼ばれます。TActiveXControl から派生する実装クラスは，通常，オートメーションインターフェースも実装して，オブジェクトのプロパティおよびメソッドを指定します。

通常は，実装クラスのインスタンスは直接作成しません。かわりに，クラス宣言のあるユニットの initialization セクションにファクトリオブジェクトを作成します。ファクトリオブジェクトは，システムから要求されたときに，ActiveX コントロールオブジクトを作成します。

インターフェース

TAutoObject から継承するインターフェースのほかに，TActiveXControl は以下のインターフェースを実装します。

IPersistStreamInit	IOleInPlaceActiveObject

IPersistStorage	IViewObject

IOleObject	IViewObject2

IOleControl	IPerPropertyBrowsing

IOleInPlaceObject	ISpecifyPropertyPages


TActiveXControl のプロパティ3016002

TActiveXControl	アルファベット順	凡例

TActiveXControl

Control

TComObject からの継承

Controller

Factory

RefCount


TActiveXControl のプロパティ3016003

TActiveXControl	オブジェクト順	凡例

Controller

Control

Factory

RefCount


TActiveXControl.Control
TActiveXControl.Control3016004

TActiveXControl	参照

Control プロパティは，VCL で実現した ActiveX コントロールへのポインタです。

property Control: TWinControl read FControl;

説明

Control プロパティは ActiveX コントロールを実現する TWinControl から派生した VCL コントロールへのポインタです。


TActiveXControl のメソッド3016005

TActiveXControl	アルファベット順	凡例

TActiveXControl

DefinePropertyPages

Destroy

EventSinkChanged

GetPropertyString

GetPropertyStrings

GetPropertyValue

Initialize

InitializeControl

LoadFromStream

ObjQueryInterface

PerformVerb

PropChanged

PropRequestEdit

SaveToStream

WndProc

TComObject からの継承

Create

CreateAggregated

CreateFromFactory

ObjAddRef

ObjRelease

SafeCallException

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TActiveXControl のメソッド3016006

TActiveXControl	オブジェクト順	凡例

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

CreateAggregated

CreateFromFactory

Create

DefaultHandler

DefinePropertyPages

Destroy

Dispatch

EventSinkChanged

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetPropertyStrings

GetPropertyString

GetPropertyValue

InheritsFrom

InitializeControl

Initialize

InitInstance

InstanceSize

LoadFromStream

MethodAddress

MethodName

NewInstance

ObjAddRef

ObjQueryInterface

ObjRelease

PerformVerb

PropChanged

PropRequestEdit

SafeCallException

SaveToStream

WndProc


TActiveXControl.DefinePropertyPages
TActiveXControl.DefinePropertyPages3016007

TActiveXControl	参照

DefinePropertyPages メソッドは，コントロールがプロパティページを表示しようとしたときに呼び出されます。

procedure DefinePropertyPages(DefinePropertyPage: TDefinePropertyPage); virtual;

説明

コントロールが任意のプロパティページを表示するようにしたい場合は，このメソッドをオーバーライドして，呼び出すプロパティページごとに DefinePropertyPage コールバック関数を 1 度呼び出します。このメソッドをオーバーライドしなければ，プロパティページは表示されません。

DefinePropertyPage にはパラメータが 1 つ必要で，プロパティダイアログに追加するプロパティページオブジェクトのクラス ID を指定します。

ActiveX プロパティページダイアログボックスは 1 つまたは複数の ActiveX オブジェクトのプロパティを編集するのに使うタブ付きのダイアログボックスです。各プロパティページは COM オブジェクトとして実現され，コントロールと同じライブラリまたは別の登録されたライブラリで実現できます。

デフォルトでは，ActiveX コントロールのエキスパートによって生成されたコードは，すでにこのメソッドをオーバーライドしていて，DefinePropertyPage の使い方の例を示すコメントが付いています。


TActiveXControl.Destroy
TActiveXControl.Destroy3016008

TActiveXControl	参照

Destroy メソッドは，TActiveXControl のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは ActiveX コントロールが解放されていないことを確認してからのみ，Destroy メソッドを呼び出します。Destroy メソッドは Control をActiveX コントロールに変えるために使ったリソースを解放します。Destroy メソッドは Control プロパティが参照しているオブジェクトは破棄しません。


TActiveXControl.EventSinkChanged
TActiveXControl.EventSinkChanged3016009

TActiveXControl	参照

EventSinkChanged メソッドは，コントロールのコンテナが新しいイベントシンクインターフェースをオブジェクトのイベント接続ポイントに接続したときに呼び出されます。

procedure EventSinkChanged(const EventSink: IUnknown); virtual;

説明

オブジェクトが標準イベント以外のイベントを発生させるようにしたい場合は，このメソッドをオーバーライドして，シンクのプライベートバージョンを格納します。EventSink パラメータはコンテナのイベントシンクインターフェースです。このインターフェースはコンテナに対するイベントを発生させるために IDispatch または任意のディスパッチインターフェースにキャストできます。

また，このメソッドはコンテナがイベントシンクインターフェースを変更または削除しようとしたときにも呼び出されます。EventSink が nil ならば，コントロールがイベントを発生させないようにコンテナが要求したので，イベントシンクは削除または，一時的に無効化されています。ActiveX コントロールエキスパートによって生成されるデフォルトのコードは，シンクをコントロールのアウトバウンドインターフェースの型の変数に代入します。


TActiveXControl.GetPropertyString
TActiveXControl.GetPropertyString3016010

TActiveXControl	参照

GetPropertyString メソッドは，プロパティの現在値を表すユーザーによる読み出しが可能な文字列を Object Inspector が取得しようとしたときに呼び出されます。この文字列は Object Inspector でプロパティ名の隣に表示されます。

function GetPropertyString(DispID: Integer; var S: string): Boolean; virtual;

説明

GetPropertyString メソッドをオーバーライドすると，ネイティブ形式ではなくユーザーが読める形式でプロパティの現在値を表示できるようになります。たとえば，フォントプロパティは "Arial, 12pt" などと表示されます。

ActiveX コンテナは，Object Inspector 内の各プロパティに対してこのメソッドを呼び出します。

DispID パラメータは要求されたプロパティを示します。このプロパティが特別な文字列を表示するようにしたい場合は，S パラメータをその文字列値に設定し，このメソッドから True を返します。

False を返す場合は，値を表示するために特別な文字列が必要でないことを示しています。この場合，Object Inspector は標準的な方法でプロパティの値を表示します。

ActiveX コントロールエキスパートによって生成されたデフォルトの実装メソッドは，自動的にタイプライブラリを調べて，見つかった型を処理します。


TActiveXControl.GetPropertyStrings
TActiveXControl.GetPropertyStrings3016011

TActiveXControl	参照

GetPropertyStrings メソッドは，ユーザーが選択できるプロパティ値のリストを Object Inspector が取得しようとしたときに呼び出されます。

function GetPropertyStrings(DispID: Integer; Strings: TStrings): Boolean; virtual;

説明

通常，Object Inspector は，ユーザーが Object Inspector のプロパティの隣のドロップダウン矢印をクリックしたときに，ピックリストが表示される前にピックリストに入れる値を判定するためにこのメソッドを呼び出します。Object Inspector はこれらの値を Object Inspector 内のプロパティの値の隣のドロップダウンリストに表示します。

DispID パラメータは値の文字列が要求されているプロパティを示します。Object Inspector がプロパティのピックリストを表示するようにしたい場合は，このメソッドをオーバーライドし，Strings.AddObject メソッドを呼び出してリストに項目を追加します。

Strings.AddObject の文字列パラメータには，ピックリストのエントリとして表示するテキストを指定します。

Strings.AddObject へのオブジェクトパラメータには，ユニークな「cookie 値」を指定します。この cookie 値はユーザーが選択した項目を識別するために GetPropertyValue メソッドに戻されます。cookie 値には任意のユニークな値を選択できますが，通例では整数値（0 はピックリストの 1 番目の項目で，1 はピックリストの 2 番目の項目という具合になる）を使います。

False を返した場合は，DispID によって指定されたプロパティに対して表示されるピックリストがないことを示します。

True を返した場合は，ピックリストが表示され，ピックリスト内の項目が Strings オブジェクトに追加されていることを示します。

このメソッドは，ユーザーがピックリスト内のエントリを選択した後で選択した文字列を Variant 値へ変換する GetPropertyValue メソッドと組み合わせて使います。プロパティにこのメソッドを実現する場合は GetPropertyValue も実現する必要があります。

ActiveX コントロールエキスパートによって生成されたデフォルトの実装メソッドは，自動的に型ライブラリを調べて，見つかった型を処理します。


TActiveXControl.GetPropertyValue
TActiveXControl.GetPropertyValue3016012

TActiveXControl	参照

GetPropertyValue メソッドは，ユーザーが Object Inspector でピックリストからプロパティ値を選択したときに，ピックリストの選択内容を Variant 値に変換するために呼び出されます。

procedure GetPropertyValue(DispID, Cookie: Integer; var Value: OleVariant); virtual;

説明

GetPropertyStrings メソッドを実現してピックリストを定義したときには，GetPropertyValue メソッドをオーバーライドする必要があります。

DispID パラメータは変更するプロパティを識別します。Cookie パラメータはユーザーが選択した項目を識別します。

実現したメソッドでは，Value パラメータで選択した項目に対応する Variant 値を返す必要があります。


TActiveXControl.Initialize
TActiveXControl.Initialize3016013

TActiveXControl	参照

Initialize メソッドは，TActiveXControl のクラスファクトリおよび接続オブジェクトを作成します。

procedure Initialize; override;

説明

Initialize メソッドはクラスファクトリオブジェクトを作成し，VCL コントロールを作成してカプセル化します。


TActiveXControl.InitializeControl
TActiveXControl.InitializeControl3016014

TActiveXControl	参照

InitializeControl メソッドは，コントロールおよび VCL コントロールが完全に作成された後で呼び出されます。

procedure InitializeControl; virtual;

説明

InitializeControl メソッドをオーバーライドすると，VCL コントロールが作成された後で ActiveX オブジェクトをさらに初期化する機会を提供できます。特に InitializeControl では，VCL コントロールのイベントプロパティに OLE イベント発生メソッドをバインドする必要があります。


TActiveXControl.LoadFromStream
TActiveXControl.LoadFromStream3016015

TActiveXControl	参照

LoadFromStream メソッドは，ストリームから ActiveX コントロールの状態をロードします。

procedure LoadFromStream(const Stream: IStream); virtual;

説明

LoadFromStream メソッドは，ストリームから VCL コントロールのストアドプロパティをロードします。

このメソッドをオーバーライドすると，SaveToStream メソッドによって保存された任意の付加データを復元できます。付加データを取り出すには，Stream.Read メソッドを呼び出します。ロードするデータは，SaveToStream メソッドで保存したデータと一致する必要があります。

このメソッドをオーバーライドする場合は，特にコントロールのプロパティが Stream から復元されないようにしたい場合を除いて，必ず継承するメソッドを呼び出して VCL オブジェクトのプロパティを復元する必要があります。

Delphi ストリームが必要な場合は，Ole ストリームを Delphi ストリームでラップする TOleStream を使うことができます。


TActiveXControl.ObjQueryInterface
TActiveXControl.ObjQueryInterface3016016

TActiveXControl	参照

ObjQueryInterface メソッドは，インターフェース ID（IID パラメータ）を指定すると，オブジェクト上の要求された COM インターフェースを返します。

function ObjQueryInterface(const IID: TGUID; out Obj): Integer; override;

説明

ObjQueryInterface メソッドは，要求されたインターフェースをサポートしていれば，最初に呼び出しを関連の TActiveXControl オブジェクトに転送し，サポートしていなければ自身のインターフェースに問い合わせます。


TActiveXControl.PerformVerb
TActiveXControl.PerformVerb3016017

TActiveXControl	参照

PerformVerb メソッドは，カスタムバーブを実行するために呼び出されます。

procedure PerformVerb(Verb: Integer); virtual;

説明

PerformVerb メソッドは，TActiveXControlFactory.AddVerb メソッドを使って ActiveX オブジェクトのファクトリにバーブを追加したときにオーバーライドします。

Verb パラメータは実行されるバーブを示します。この番号はファクトリの AddVerb メソッドで提供される識別子に一致します。


TActiveXControl.PropChanged
TActiveXControl.PropChanged3016018

TActiveXControl

PropChanged メソッドは，OnChanged イベントを生成します。

procedure PropChanged(const PropertyName: WideString);

説明

PropChanged メソッドは，PropertyName パラメータによって指定されたプロパティが変更されたときに呼び出します。PropChanged は IPropertyNotifySink インターフェースを使って OnChanged イベントを生成します。


TActiveXControl.PropRequestEdit
TActiveXControl.PropRequestEdit3016019

TActiveXControl

PropRequestEdit メソッドは，指定したプロパティが変更可能かどうかを示します。

function PropRequestEdit(const PropertyName: WideString): Boolean;

説明

PropRequestEdit メソッドを呼び出すと，PropertyName パラメータで指定したプロパティが 編集可能かどうかを判定できます。PropRequestEdit は IPropertyNotifySink インターフェースを使ってプロパティが変更可能かどうかを判定し，可能ならば True を返します。


TActiveXControl.SaveToStream
TActiveXControl.SaveToStream3016020

TActiveXControl	参照

SaveToStream メソッドは，指定されたストリームに ActiveX コントロールの状態を保存します。SaveToStreamのデフォルトの実装メソッドは，VCL コントロールのすべてのストアドプロパティをストリームに保存します。

procedure SaveToStream(const Stream: IStream); virtual;

説明

SaveToStream メソッドをオーバーライドすると，コントロールが必要とする付加データを保存することができます。付加データを保存するには，Stream.Write メソッドを呼び出します。実際に付加データを保存する場合は，LoadFromStream をオーバーライドして，データが正確に復元されるようにします。

このメソッドをオーバーライドする場合は，特にオブジェクトのプロパティが保存されないようにしたい場合を除いて，必ず継承メソッドを呼び出してオブジェクトのプロパティを復元します。


TActiveXControl.WndProc
TActiveXControl.WndProc3016021

TActiveXControl	参照

WndProc メソッドは，VCL で実現したコントロールのウィンドウ手続きを受け取ります。これにより ActiveX コントローラオブジェクトに，フォーカスの変更，アクティブ化など，ActiveX コントロールにとって関心のあるメッセージを処理する機会が与えられます。

procedure WndProc(var Message: TMessage); virtual;

説明

通常は，WndProc メソッドをオーバーライドしたり，呼び出したりする必要はありません。このメソッドは今後 Delphi ActiveX フレームワークを拡張できるようにプロテクト仮想メソッドとして宣言されます。

このメソッドは，ActiveX コンテナが ActiveX オブジェクトに処理ストリームからメッセージを選別するように指示した場合を除いて，通常はメッセージをコントロールの元のメッセージハンドラに渡します。


アクセス種別3016022

読み出し専用


スコープ3016023

protected


継承3016024

TObject

TComObject

TTypedComObject

TAutoObject


TActiveXControl の例3016025

TActiveXControl


TActiveXControlFactory
TActiveXControlFactory3017001

継承	プロパティ	メソッド	参照

ユニット

axctrls

説明

TActiveXControlFactory は ActiveX コントロールオブジェクトのファクトリクラスです。

ActiveX コントロールは COM オブジェクトなので，システムが ActiveX コントロールを作成できるように，そのコントロールが実現されるモジュールはファクトリオブジェクトを提供しなければなりません。TActiveXControlFactory クラスは，TActiveXControl クラスで実現される ActiveX コントロールのファクトリです。

COM ファクトリについての詳細は，TComObjectFactory の説明を参照してください。

ActiveX コントロールファクトリをプログラムに追加するには，TActiveXControl オブジェクトを定義するユニットの初期化セクションにファクトリオブジェクトを作成します。


TActiveXControlFactory のプロパティ3017002

TActiveXControlFactory	アルファベット順	凡例

TActiveXControlFactory

EventIID

EventTypeInfo

MiscStatus

ToolboxBitmapID

WinControlClass

TAutoObjectFactory からの継承

DispIntfEntry

DispTypeInfo

TTypedComObjectFactory からの継承

ClassInfo

TComObjectFactory からの継承

ClassID

ClassName

ComClass

ComServer

Description

ErrorIID

Instancing

LicString

ProgID

ShowErrors

SupportsLicensing


TActiveXControlFactory のプロパティ3017003

TActiveXControlFactory	オブジェクト順	凡例

ClassID

ClassInfo

ClassName

ComClass

ComServer

Description

DispIntfEntry

DispTypeInfo

ErrorIID

EventIID

EventTypeInfo

Instancing

LicString

MiscStatus

ProgID

ShowErrors

SupportsLicensing

ToolboxBitmapID

WinControlClass


TActiveXControlFactory.EventIID
TActiveXControlFactory.EventIID3017004

TActiveXControlFactory	参照

EventIID プロパティは，コントロールのイベントインターフェースの GUID です。

property EventIID: TGUID read FEventIID;

説明

EventIID プロパティは，コントロールとイベントインターフェース間を接続するために内部的に使われます。


TActiveXControlFactory.EventTypeInfo
TActiveXControlFactory.EventTypeInfo3017005

TActiveXControlFactory	参照

EventTypeInfo プロパティは，オブジェクトのイベントインターフェースの型情報オブジェクトです。

property EventTypeInfo: ITypeInfo read FEventTypeInfo;

説明

EventTypeInfo プロパティは，このプロパティを使うと，オブジェクトのイベントインターフェースの型情報を取得します。


TActiveXControlFactory.MiscStatus
TActiveXControlFactory.MiscStatus3017006

TActiveXControlFactory

MiscStatus プロパティは，レジストリに格納されているステータスビットです。

property MiscStatus: Integer read FMiscStatus;

説明

MiscStatus はクラスの CLSID エントリ下のレジストリエントリに格納されています。このエントリは，OLE サーバーに関する情報をコンテナに提供します。また，OLE で特定の意味が定義されているバイナリフラグのセットを保持します。MiscStatus のエントリは必須ではありません。

OLE コントロールコンテナは，以下の MiscStatus ビットを認識およびサポートします。

ステータスビット	コンテナの サポートの 必要性	コメント
ACTIVATEWHENVISIBLE	必要	オブジェクトは，UI アクティブ でない場合でも，可視になると必ずアクティブ化されることを要求している
IGNOREACTIVATEWHENVISIBLE	不要	非アクティブで，ウィンドウのないコントロールをサポートする場合に必要
INSIDEOUT	不要	通常はコントロールには使われず，複合ドキュメントの埋め込みオブジェクトに使われる。また，オブジェクトがインサイドアウトでアクティブ化される（UI-active と同じようにインプレースでアクティブ化できる）ように要求していることをコンテナに通知する
INVISIBLEATRUNTIME	必要	設計時には可視になり，実行時には不可視になるコントロールを指定する
ALWAYSRUN	必要	オブジェクトが常に実行状態になることを要求しており，デフォルトハンドラは最後までオブジェクトのロードを遅らせてはならないことをコンテナに通知する
ACTSLIKEBUTTON	不要	オブジェクトがボタンのように動作することをコンテナに通知する。これにより，コンテナはコントロールに自身をデフォルトのボタンまたは通常のボタンとして描画するよう要求できる
ACTSLIKELABEL	不要	オブジェクトがラベルのように動作することをコンテナに通知する。これによりコンテナは，コントロールのラベル付けにフォーカスが移ったときにコントロールを正常に処理できる
NOUIACTIVATE	必要	コントロールには，アクティブ化するユーザーインターフェースはない
ALIGNABLE	不要	ユーザーがコントロールの位置合わせを行うことができる
SIMPLEFRAME	不要	コントロールは，ほかのコントロールを保持する簡単な枠として使われる
SETCLIENTSITEFIRST	不要	コントロールは，その作成の早い段階でクライアントサイトにアクセスしなければならない
IMEMODE	不要	コントロールは Input Method Identifier（IME）をサポートして拡張文字を作成する。通常，IME をサポートするコンテナはコントロールに拡張 IMEMode プロパティを提供する


TActiveXControlFactory.ToolboxBitmapID
TActiveXControlFactory.ToolboxBitmapID3017007

TActiveXControlFactory	参照

ToolboxBitmapID プロパティは，ActiveX コントロールのリソース識別子です。

property ToolboxBitmapID: Integer read FToolboxBitmapID;

説明

ToolboxBitmapID プロパティは，設計パレットでコントロールを表現するときに使われるビットマップのリソース ID です。


TActiveXControlFactory.WinControlClass
TActiveXControlFactory.WinControlClass3017008

TActiveXControlFactory	参照

WinControlClass プロパティは，Windows での ActiveX コントロールの動作を実現する VCL コントロールクラスのクラスオブジェクトです。

property WinControlClass: TWinControlClass read FWinControlClass;

説明

ファクトリオブジェクトは VCL コントロールのクラスオブジェクトへの参照を保持しているので，ActiveX コントロールの作成時にクラスオブジェクトに VCL コントロールを作成するよう要求できます。


TActiveXControlFactory のメソッド3017009

TActiveXControlFactory	アルファベット順

TActiveXControlFactory

AddVerb

Create

Destroy

UpdateRegistry

TAutoObjectFactory からの継承

GetIntfEntry

TTypedComObjectFactory からの継承

GetInterfaceTypeInfo

TComObjectFactory からの継承

CreateComObject

RegisterClassObject

TObject からの継承

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TActiveXControlFactory のメソッド3017010

TActiveXControlFactory	オブジェクト順

AddVerb

ClassNameIs

ClassParent

ClassType

CleanupInstance

CreateComObject

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetInterfaceTypeInfo

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RegisterClassObject

SafeCallException

UpdateRegistry


TActiveXControlFactory.AddVerb
TActiveXControlFactory.AddVerb3017011

TActiveXControlFactory	参照

AddVerb メソッドは，オブジェクトがサポートしているバーブのリストに，負の数値や0 としてバーブを追加します。

procedure AddVerb(Verb: Integer; const VerbName: string);

説明

Verb パラメータには，バーブを識別する数値を渡します。通常，ユーザー定義のバーブは小さい正の数値になります。また，頻繁に使われるバーブは OLE でも定義されます。

OLEIVERB_PRIMARY	0
OLEIVERB_SHOW	�1
OLEIVERB_OPEN	�2
OLEIVERB_HIDE	�3
OLEIVERB_UIACTIVATE	�4
OLEIVERB_INPLACEACTIVATE	�5
OLEIVERB_DISCARDUNDOSTATE	�6
OLEIVERB_PROPERTIES	�7
VerbName パラメータでは，ユーザーがバーブを選択したときに表示されるテキストを渡します。OLE コンテナの場合，コントロールを右クリックしたときにバーブテキストがポップアップメニュー内に表示されることもあります。

VerbName 文字列の任意の文字の前にアンド記号（&）を指定すると，その文字はポップアップメニューに下線付きで表示されます。


TActiveXControlFactory.Create
TActiveXControlFactory.Create3017012

TActiveXControlFactory	参照

Create メソッドは，新しい TActiveXControlFactory オブジェクトを作成および初期化します。

constructor Create(ComServer: TComServerObject; ActiveXControlClass: TActiveXControlClass; WinControlClass: TWinControlClass; const ClassID: TGUID; ToolboxBitmapID: Integer; const LicStr: string; MiscStatus: Integer);

説明

ComServer パラメータは，プロパティページファクトリを保持するモジュールの COM サーバーオブジェクトへのポインタです。通常，このプロパティは ComServ ユニットで宣言されるグローバル変数 ComServer です。

ActiveXControlClass パラメータは，ActiveX コントロールを実現するコントローラオブジェクトのクラスオブジェクトです。このオブジェクトは TActiveXControl から継承しなければなりません。

WinControlClass パラメータは，Windows でのコントロールの動作を実現する VCL コントロールクラスのクラスオブジェクトです。このオブジェクトは TWinControl から継承しなければなりません。

ClassID パラメータは ActiveX コントロールの GUID です。各 COM オブジェクトには固有の GUID を割り当てなければなりません。

LicStr は，ActiveX コントロールファクトリで作成したコントロールのライセンス文字列です。このファクトリで作成したコントロールのライセンスを取得していない場合には，LicStr は空の文字列になります。MiscStatus はレジストリに格納されているステータスビットです。


TActiveXControlFactory.Destroy
TActiveXControlFactory.Destroy3017013

TActiveXControlFactory	参照

Destroy メソッドは，TActiveXControlFactory のインスタンスを解放します。

destructor Destroy; override;

説明

Destroy メソッドは，Create で作成した TActiveXControlFactory の下位オブジェクトのインスタンスを解放します。


TActiveXControlFactory.UpdateRegistry
TActiveXControlFactory.UpdateRegistry3017014

TActiveXControlFactory	参照

UpdateRegistry メソッドは，オブジェクトのレジストリエントリを追加または削除します。

procedure UpdateRegistry(Register: Boolean); override;

説明

UpdateRegistry メソッドは，システムレジストリのコントロールを追加または削除するときに呼び出されます。このメソッドのデフォルト動作は，通常の ActiveX コントロールレジストリキー，サーバーファイル情報，および型ライブラリ情報をレジストリに追加することです。また，UpdateRegistry は AddVerb メソッドで追加されたバーブも追加します。

Register パラメータが True の場合，コントロールは自身のキーをシステムレジストリに追加しなければなりません。Register パラメータが False の場合，コントロールは自身のキーをレジストリから削除しなければなりません。

基本設定で実現した UpdateRegistry を使った場合より多くの情報をレジストリに格納するようコントロールに要求する場合は，UpdateRegistry メソッドをオーバーライドします。このメソッドをオーバーライドするときには，必ず正しい順序で継承メソッドを呼び出してください。レジストリエントリを追加する場合（Register が True の場合）は，カスタムエントリを追加する前に継承メソッドを呼び出します。レジストリエントリを削除する場合（Register が False の場合）は，カスタムエントリを削除した後で継承メソッドを呼び出します。


アクセス種別3017015

読み出し専用


階層3017016

TObject

TComObjectFactory

TTypedComObjectFactory

TAutoObjectFactory


TActiveXControlFactory の例3017017

TActiveXControlFactory


TActiveXPropertyPageFactory
TActiveXPropertyPageFactory3018001

継承	プロパティ	メソッド	参照

Active プロパティページに COM ファクトリを実現します。

ユニット

axctrls

説明

プロパティページは COM オブジェクトです。つまり実装しているモジュールは，システムがオブジェクトを作成できるようにするためにシステムにファクトリを提供しなければなりません。TActiveXPropertyPageFactory クラスは ActiveX プロパティページのファクトリで，実装するには TPropertyPage クラスを細分化します。

COM ファクトリについての詳細は，TComObjectFactory を参照してください。

開発するプログラムにプロパティページファクトリを追加するには，プロパティページフォームを定義するユニットの初期化セクションにファクトリオブジェクトを作成します。


TActiveXPropertyPageFactory のプロパティ3018002

TActiveXPropertyPageFactory	アルファベット順	凡例

TComObjectFactory からの継承

ClassID

ClassName

ComClass

ComServer

Description

ErrorIID

Instancing

ShowErrors

ProgID


TActiveXPropertyPageFactory のプロパティ3018003

TActiveXPropertyPageFactory	オブジェクト順	凡例

ClassID

ClassName

ComClass

ComServer

Description

ErrorIID

Instancing

ShowErrors

ProgID


TActiveXPropertyPageFactory のメソッド3018004

TActiveXPropertyPageFactory	アルファベット順

TActiveXPropertyPageFactory

Create

TComObjectFactory からの継承

Destroy

RegisterClassObject

UpdateRegistry

TObject からの継承

ClassInfo

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TActiveXPropertyPageFactory のメソッド3018005

TActiveXPropertyPageFactory	オブジェクト順

ClassInfo

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RegisterClassObject

SafeCallException

UpdateRegistry


TActiveXPropertyPageFactory.Create
TActiveXPropertyPageFactory.Create3018006

TActiveXPropertyPageFactory	参照

Create メソッドは，プロパティページファクトリを作成してそのファクトリをプロパティページクラスに結び付けます。

constructor Create(ComServer: TComServerObject;ActiveXControlClass: TActiveXControlClass; WinControlClass: TWinControlClass; const ClassID: TGUID; ToolboxBitmapID: Integer);

説明

ComServer パラメータは， ActiveX ライブラリの COM サーバーオブジェクトへのポインタです。このパラメータは，通常，ComServ ユニットで宣言されるグローバル変数 ComServer です。

PropertyPageClass パラメータは，プロパティページの実現クラスのクラスオブジェクトです。実現クラスは TPropertyPage から継承されなければなりません。このクラスは，プロパティのダイアログに表示されるフォームを実現します。

ClassID パラメータは，プロパティページを識別する GUID です。各プロパティページには自身の GUID を持つ必要があります。GUID の作成方法については，プログラマーズガイドを参照してください。


アクセス種別3018007

読み出し専用


継承3018008

TObject

TComObjectFactory


TActiveXPropertyPageFactory の例3018009

TActiveXPropertyPageFactory


TActiveXPropertyPage
TActiveXPropertyPage3019001

継承	プロパティ	メソッド	参照

ユニット

axctrls

説明

TActiveXPropertyPage オブジェクトは，ActiveX プロパティページをサポートするために必要なインターフェースを提供する COM オブジェクトです。

このクラスは，Delphi フォームとActiveX プロパティページ API とのブリッジを提供するために TPropertyPage が内部的に使います。


TActiveXPropertyPage のプロパティ3019002

TActiveXPropertyPage	アルファベット順	凡例

TComObject からの継承

Controller

Factory

RefCount


TActiveXPropertyPage のプロパティ3019003

TActiveXPropertyPage	オブジェクト順	凡例

Controller

Factory

RefCount


TActiveXPropertyPage のメソッド3019004

TActiveXPropertyPage	アルファベット順

TActiveXPropertyPage

Destroy

Initialize

TComObject からの継承

Create

CreateAggregated

CreateFromFactory

ObjAddRef

ObjQueryInterface

ObjRelease

SafeCallException

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TActiveXPropertyPage のメソッド3019005

TActiveXPropertyPage	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

CreateAggregated

CreateFromFactory

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

Initialize

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ObjAddRef

ObjQueryInterface

ObjRelease

SafeCallException


TActiveXPropertyPage.Destroy
TActiveXPropertyPage.Destroy3019006

TActiveXPropertyPage

Destroy メソッドは，TPropertyPage のインスタンスを解放します。

destructor Destroy; override;

説明

Destroy メソッドは，Initialize で作成された TPropertyPage 下位オブジェクトのインスタンスを解放します。


TActiveXPropertyPage.Initialize
TActiveXPropertyPage.Initialize3019007

TActiveXPropertyPage

Initialize メソッドは，TPropertyPage の下位オブジェクトのインスタンスを作成し，初期化します。

procedure Initialize; override;

説明

Initialize メソッドを呼び出すと，TPropertyPage の下位オブジェクトのインスタンスを作成し，初期化できます。


アクセス種別3019008

読み出し専用


継承3019009

TObject

TComObject


TActiveXPropertyPage の例3019010

TActiveXPropertyPage


TBaseArray
TBaseArray3020001

継承	プロパティ	メソッド	参照

TBaseArray はデシジョンキューブコンポーネントが使うすべての配列の基本クラスです。

ユニット

mxarrays

説明

TBaseArray は，特定のデータ型の特殊な配列を定義するときに基本クラスとして使います。TList または TStringList オブジェクトと同様に，TBaseArray は動的に増加できる順序付けられた項目のリストを表します。ただし，TStringList の要素が文字列に制限され，TList の要素がポインタに制限されているのに対して，TBaseArray の要素はコンストラクタでサイズが指定される任意のデータ型です。

TBaseArray の下位オブジェクトは short 型整数など，特定のデータ型の配列を表します。


TBaseArray のプロパティ3020002

TBaseArray	アルファベット順	凡例

TBaseArray

AutoSize

Capacity

CompareProc

Count

Duplicates

ItemSize

Limit

List

SortOrder


TBaseArray のプロパティ3020003

TBaseArray	オブジェクト順	凡例

AutoSize

Capacity

CompareProc

Count

Duplicates

ItemSize

Limit

List

SortOrder


TBaseArray.AutoSize
TBaseArray.AutoSize3020004

TBaseArray	参照

AutoSize プロパティは，項目が追加されたときに配列が動的に大きくなるかどうかを示します。

property AutoSize: Boolean;

説明

AutoSize プロパティを True に設定すると，配列に値をいくつでも格納できます。AutoSize が True ならば，新しい項目が配列の現在の容量を超えて追加されると，Capacity プロパティが自動的に増加します。AutoSize が False の場合は，配列に入れることのできるエントリの数をCapacity プロパティで明示的に設定する必要があります。AutoSize が False の場合，Capacity プロパティで指定した数を超えて項目を追加しようとすると，EArrayError 例外が生成されます。


TBaseArray.Capacity
TBaseArray.Capacity3020005

TBaseArray	参照

Capacity プロパティは，配列に追加できる最大の項目数です。

property Capacity: Integer;

説明

Capacity プロパティを設定すると，配列に割り当てるメモリ量を変更できます。Capacity に Count プロパティの値より小さい値を設定しようとすると，EArrayError 例外が生成されます。

AutoSize プロパティが True ならば，配列の Capacity は新たに追加された項目を収容できるように必要に応じて自動的に増加します。

注意

配列で使っているメモリ量は，Capacity * ItemSize の値になります。


TBaseArray.CompareProc
TBaseArray.CompareProc3020006

TBaseArray	参照

CompareProc プロパティは，配列の要素のソート順を実現する関数です。

TCompareProc = function ( Var item1, item2 ): Integer;

property CompareProc: TCompareProc;

説明

CompareProc プロパティを設定すると，配列の要素のソートに使う関数を変更できます。SortOrder プロパティが TS_NONE でなければ，新しい項目が配列に追加される位置を見つけるとき，および FindItem メソッドを使って項目を見つけるときに CompareProc を使います。

CompareProc は，パラメータとして渡された 2 つの項目を比較し，item1 が item2 より前にくる場合は 0 より小さい値を返し，item1 が item2 の後の場合は 0 より大きい値を返し，item1 が item2 と同じなら 0 を返さなくてはなりません。


TBaseArray.Count
TBaseArray.Count3020007

TBaseArray	参照

Count プロパティは，配列内の項目数です。

property Count: Integer;

説明

Count プロパティを呼び出すと，配列内のエントリ数を取得できます。Count を設定すると，エントリ数を増加または減少させることができます。Count を増加させると，AutoSize プロパティが False でも，必要に応じて Capacity が増加します。Count プロパティを減少させると，配列の Count で指定した項目より後の部分が切り取られますが，配列の Capacity には影響はありません。

Count の値が増加すると，値 0 の新しいエントリが配列の最後に追加されます。配列がソートされていれば，内部的なソート順を破棄することになるので，FindItem メソッドは失敗します。配列がソートされている場合は，新たに追加された配列のメンバーに値を入れた後で，Sort メソッドを呼び出してソート順を復元します。


TBaseArray.Duplicates
TBaseArray.Duplicates3020008

TBaseArray	参照

Duplicates プロパティは，ソート済みの配列で重複項目を追加できるかどうかを指定します。

TDuplicates = (dupIgnore, dupAccept, dupError);

property Duplicates: TDuplicates;

説明

Duplicates プロパティを設定すると，ソート済みの配列に重複項目を追加しようとしたときの処理を指定できます。Duplicates には以下の値のいずれかを指定します。

値	意味

dupIgnore	配列へ重複項目を追加しようとすると無視される

dupError	配列へ重複項目を追加しようとすると EArrayError 例外が生成される

dupAccept	配列への重複項目の追加を許可する

Duplicates はリストに項目を追加する前に設定します。Duplicates を dupIgnore または dupError に設定しても，すでに配列内にある重複文字列に対しては無効です。

注意

Duplicates は配列がソートされていない場合は無効です。


TBaseArray.ItemSize
TBaseArray.ItemSize3020009

TBaseArray	参照

ItemSize プロパティは，配列内にそれぞれの項目を格納するのに使うバイト数です。

property ItemSize: Integer;

説明

ItemSize プロパティは，配列の要素のサイズを取得できます。ItemSize の値は Create メソッドにより iSize パラメータの値に設定されます。TBaseArray の派生オブジェクトは，表すデータ型のサイズにこの値を変更します。


TBaseArray.Limit
TBaseArray.Limit3020010

TBaseArray	参照

Limit プロパティは配列のサイズです。

property Limit: Integer;

説明

Limit プロパティは，配列のサイズを取得できます。配列が空の場合，Limit は Capacity プロパティと同じになります。配列が空でない場合，Capacity の値が Count の値より大きくても，Limit は Count プロパティと同じになります。Limit を設定すると，配列の Capacity が設定されます。


TBaseArray.List
TBaseArray.List3020011

TBaseArray	参照

List プロパティは，TBaseArray によって保持される値の配列へのポインタです。

property List: Pointer;

説明

List プロパティは，配列項目を格納するのに使われているメモリへ直接アクセスできます。リスト内の個々の項目の位置を算定するには，ItemSize プロパティを使います。

リスト内の特定の項目にアクセスするには，GetItem メソッドを使います。


TBaseArray.SortOrder
TBaseArray.SortOrder3020012

TBaseArray	参照

SortOrder プロパティは，配列がソートされるかどうかを指定します。

TSortOrder = ( TS_NONE, TS_ASCENDING, TS_DESCENDING );

property SortOrder: TSortOrder;

説明

SortOrder プロパティは，CompareProc プロパティを使って配列がソートされるかどうかを指定できます。配列がソートされるとき，ソート順が維持されるように，すべての新しい項目がソート順で正しい位置に追加されます。SortOrder には次の値のいずれかを指定できます。

値	意味

TS_NONE	配列はソートされない

TS_ASCENDING	配列の要素は昇順にソートされる

TS_DESCENDING	配列の要素は降順にソートされる

SortOrder プロパティを設定しても，配列内にすでにある項目はソートされません。SortOrder プロパティが TS_ASCENDING または TS_DESCENDING に変更されたときに配列が空ではない場合は，必ず明示的に Sortメソッドを呼び出して既存の項目をソートしてください。

注意

Duplicates プロパティは SortOrder が TS_NONE のときは無効です。


TBaseArray のメソッド3020013

TBaseArray	アルファベット順

TBaseArray

Clear

Create

Delete

Destroy

Exchange

FindItem

GetItem

IndexOf

Insert

InsertAt

PutItem

RemoveItem

Sort

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TBaseArray のメソッド3020014

TBaseArray	オブジェクト順

Assign

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Delete

Destroy

Dispatch

Exchange

FieldAddress

FindItem

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetItem

GetNamePath

IndexOf

InheritsFrom

InitInstance

InsertAt

Insert

InstanceSize

MethodAddress

MethodName

NewInstance

PutItem

RemoveItem

SafeCallException

Sort


TBaseArray.Clear
TBaseArray.Clear3020015

TBaseArray	参照

Clear メソッドは，配列からすべての項目を削除します。

procedure Clear;

説明

Clear メソッドを呼び出すと，配列を空にして関連付けられているメモリをすべて解放できます。Clearは Count プロパティと Capacity プロパティとを 0 に設定することと同じです。


TBaseArray.Create
TBaseArray.Create3020016

TBaseArray	参照

Create メソッドは，指定した要素のサイズで TBaseArray のインスタンスを作成します。

constructor Create( Itemcount, iSize: Integer ); virtual;

説明

Create メソッドを呼び出すと，iSize パラメータで指定したサイズの要素が入った配列を作成できます。Create は Capacity プロパティを Itemcount に，ItemSize プロパティを iSize に設定します。また，Create は AutoSize プロパティを True に，Count プロパティを 0 に初期化します。


TBaseArray.Delete
TBaseArray.Delete3020017

TBaseArray	参照

Delete メソッドは，配列から 1 つの要素を削除します。

procedure Delete(Index: Integer); virtual;

説明

Delete メソッドを呼び出すと，Index パラメータで示される要素を削除できます。0 が 1 番目の要素を示し，1 が 2 番目の要素を示します。要素が削除されると，配列内の以降のすべての要素は空きができないように繰り上がります。


TBaseArray.Destroy
TBaseArray.Destroy3020018

TBaseArray	参照

Destroy メソッドは，TBaseArray のインスタンスを破棄します。

destructor Destroy; override;

説明

直接アプリケーションで Destroy を呼び出さないでください。かわりに Free を呼び出します。Free は配列が解放されていないことを確認してからのみ Destroy を呼び出します。

Destroy は，継承するデストラクタを呼び出す前に，要素のリストを保持するために割り当てられているメモリを解放します。


TBaseArray.Exchange
TBaseArray.Exchange3020019

TBaseArray	参照

Exchange メソッドは，配列内の 2 つの要素の値をスワップするメソッドにインターフェースを提供します。

procedure Exchange(Index1, Index2: Integer); virtual;

説明

TBaseArray のExchange メソッドは，2 つの要素の値を交換するメソッドにインターフェースを提供する以外は何もしません。


TBaseArray.FindItem
TBaseArray.FindItem3020020

TBaseArray	参照

FindItem メソッドはソート済みの配列内で値を検索し，その値を持つ要素がすでに存在するかどうかを示します。

function FindItem( var Index: Integer; var Value ): Boolean;

説明

FindItem メソッドを呼び出すと，Value の値を持つ要素が追加されるソート済みの配列内でインデックスを取得できます。配列内に Value の値を持つ要素が存在する場合，FindItem は True を返します。配列内の要素の値がいずれもValue の値でない場合，FindItem はFalse を返します。

Value が現れるインデックスは Index パラメータで返されます。Index の値は0 から始まり，1 番目の要素がインデックス 0 で，2 番目の要素がインデックス 1 になります。

注意

FindItem は SortOrder プロパティが TS_ASCENDING であることを前提にしています。未ソートの配列の場合，かわりに IndexOf メソッドを使います。降順の配列の場合は，FindItem を呼び出す前に CompareProc プロパティを逆にします。


TBaseArray.GetItem
TBaseArray.GetItem3020021

TBaseArray	参照

GetItem メソッドは，配列内の指定した位置にある要素を返します。

procedure GetItem(index: Integer; Var Value );

説明

GetItem メソッドを呼び出すと，配列内の要素の値を取得できます。Index パラメータは配列の要素を示します。1 番目の要素がインデックス 0 で，2 番目の要素がインデックス 1 になります。


TBaseArray.IndexOf
TBaseArray.IndexOf3020022

TBaseArray	参照

IndexOf メソッドは，指定した値を持つ最初の要素の位置を返します。

function IndexOf( var Value ): Integer; virtual;

説明

IndexOf メソッドを呼び出すと，Value の値を持つ最初の要素の位置を取得できます。IndexOf は 0から始まる要素のインデックスを返します。つまり，Value が配列内の 1 番目の要素と一致する場合，IndexOf は 0 を返し，2 番目の要素と一致する場合は，1 を返します。値が配列内になければ，IndexOf は -1 を返します。

注意

IndexOf は降順にソートされている配列では無効です。


TBaseArray.Insert
TBaseArray.Insert3020023

TBaseArray	参照

Insert メソッドは，配列に要素を挿入し，値を代入します。

procedure Insert(Index: Integer; Var Value ); virtual;

説明

Insert メソッドを呼び出すと，配列内の Index で指定する位置に要素を追加し，その要素に Value の値を代入します。Index が 0 ならば，要素は配列の先頭に挿入され，Index が 1 ならば，要素は配列の 2 番目の位置に挿入されます。

注意

Insert は SortOrder プロパティをチェックしません。配列がソートされている場合は，必ずソート順の正しい位置に要素を挿入するようにします。


TBaseArray.InsertAt
TBaseArray.InsertAt3020024

TBaseArray	参照

InsertAt メソッドは，配列内の Index で指定した位置に要素を追加します。

procedure InsertAt(Index: Integer; var Value:);

説明

InsertAt メソッドはInsert メソッドと同じです。ほとんどの場合は Insert メソッドを使います。

TBaseArray の派生オブジェクトは，Insert メソッドをオーバーライドして，ソート済み配列に要素を挿入しようとしたときに例外が生成されるようにすることができます。InsertAt は Index の値が適切な値である限り必ず成功します。InsertAt は Index の値が適切であることがわかっているときに内部的に使用されるために用意されています。


TBaseArray.PutItem
TBaseArray.PutItem3020025

TBaseArray	参照

PutItem メソッドは，配列内の要素の値を置換します。

procedure PutItem(Index: Integer; Var Value );

説明

PutItem メソッドを呼び出すと，要素の値を Value パラメータの値に変更できます。Insert メソッドとは異なり，PutItem は新しい項目を配列に追加しないで，既存の要素の値を変更します。Index パラメータは変更する要素を示します。0 は 1 番目の要素を指定し，1 は 2 番目の要素を指定します。

注意

Index を Count プロパティの値に設定して PutItem を呼び出すと，新しい要素が配列の最後に追加されます。この場合のみ，PutItem は既存の要素を置換するのではなく，新しい要素を追加します。


TBaseArray.RemoveItem
TBaseArray.RemoveItem3020026

TBaseArray	参照

RemoveItem メソッドは，配列から 1 つの要素を削除します。

procedure RemoveItem( Index: Integer );

説明

RemoveItem は Delete メソッドと同じです。RemoveItem のかわりに Delete メソッドを使ってください。


TBaseArray.Sort
TBaseArray.Sort3020027

TBaseArray	参照

Sort メソッドは，配列内の要素をソートするメソッドにインターフェースを提供します。

procedure Sort( Compare: TCompareProc ); virtual;

説明

TBaseArray の Sort メソッドは何も行いません。TBaseArray の派生オブジェクトはこのメソッドをオーバーライドして，Compare パラメータで指定した順序付け関数を使って配列の要素をソートできます。


アクセス種別3020028

読み出し専用


継承3020029

TObject

TPersistent


TBaseArray の例3020030

TBaseArray


TBatchMove
TBatchMove3021001

継承	プロパティ	メソッド	参照	例

TBatchMove オブジェクトを使うと，アプリケーションが複数のレコードのまとまりやテーブル全体を処理することができます。

ユニット

dbtables

説明

TBatchMove オブジェクトは以下の処理を行います。

・	データセット内のレコードをデータベーステーブルに追加する

・	データベーステーブルのデータセットからレコードを削除する

・	データセットをコピーして，新しいデータベーステーブルを作成したり，既存のテーブルに上書きする

TBatchMove オブジェクトにプロパティを設定して目的の処理を指定します。実際に処理を実行するには Execute メソッドを呼び出します。TTable オブジェクトでも同様のバッチ処理を実行できますが，BatchMove プロパティのデフォルト値で指定されたオプションだけしか処理できません。

TBatchMove には，バッチ処理の実行時に発生する問題の処理方法をボーランドデータベースエンジン（BDE）に指定するいくつかのプロパティがあります。さらにアプリケーションは，発生する問題に対する応答を TBDECallback オブジェクトを使って詳細に設定できます。


TBatchMove プロパティ3021002

TBatchMove	アルファベット順	凡例

TBatchMove

AbortOnKeyViol

AbortOnProblem

ChangedCount

ChangedTableName

CommitCount

Destination

KeyViolCount

KeyViolTableName

Mappings

Mode

MovedCount

ProblemCount

ProblemTableName

RecordCount

Source

Transliterate

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TBatchMove プロパティ3021003

TBatchMove	オブジェクト順	凡例

AbortOnKeyViol

AbortOnProblem

ChangedCount

ChangedTableName

CommitCount

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Destination

KeyViolCount

KeyViolTableName

Mappings

Mode

MovedCount

Name

Owner

ProblemCount

ProblemTableName

RecordCount

Source

Tag

Transliterate

VCLComObject


TBatchMove.AbortOnKeyViol
TBatchMove.AbortOnKeyViol3021004

TBatchMove	参照

AbortOnKeyViol プロパティは，整合性違反またはキー違反が発生したときに，バッチ処理をすぐに終了するかどうかを指定します。

property AbortOnKeyViol: Boolean;

説明

AbortOnKeyViol プロパティを True に設定すると，転送先テーブルで整合性違反やキー違反が発生したときにバッチ処理が中止されます。AbortOnKeyViol を False に設定すると，整合性違反やキー違反の発生したレコードがキー違反テーブルに書き込まれます。AbortOnKeyViol を False に設定したときは KeyViolTableName を指定します。KeyViolTableName を指定しないと，AbortOnKeyViol を False に設定しても，問題のあるレコードがカウントされるだけで，テーブルには保存されません。

キー違反は，一次キーを持つテーブルにレコードを追加したときに発生します。一次キーを持つテーブルでは，キー設定項目すべてにおいて 2 つのレコードが同じ値をとることはできません。追加するレコードが，すべてのキー設定項目において転送先テーブルのレコードと同じ値を持つ場合，レコードは追加できません。

整合性違反は，参照整合性を定義しているテーブルでレコードを削除，追加，または更新すると発生します。参照整合性の仕様では，1 つのテーブルの各項目が，別のテーブルの特定の項目に存在する値を持つ必要があります。追加するレコードが参照整合性の制限に適合しない場合，レコードは追加できません。レコードを削除すると参照整合性の制限が厳しくなり，これを参照する別のテーブルがその条件を満たせなくなる場合はそのレコードは削除できません。


TBatchMove.AbortOnProblem
TBatchMove.AbortOnProblem3021005

TBatchMove	参照

AbortOnProblem プロパティは，指定した転送先に合わせてデータを切り捨てる必要があるときに，バッチ処理をすぐに終了するかどうかを指定します。

property AbortOnProblem: Boolean;

説明

AbortOnProblem プロパティを True に設定すると，Source テーブルレコードの項目型と転送先テーブルレコードの項目型が一致しないときにバッチ処理が中止されます。AbortOnProblem を False に設定すると，一致しない項目は切りつめられます。KeyViolTableName を指定しないと，AbortOnKeyViol を False に設定しても，問題のあるレコードがカウントされるだけで，テーブルには保存されません。AbortOnProblem が False の場合は，ProblemTableName を設定して，データを切り捨てるときに元のレコードを別のテーブルに保存します。

項目の切りつめとは，項目の値を転送先の項目型と互換性のある値に変換することです。たとえば，転送先テーブルの項目の文字列サイズが 10 文字で，ソーステーブルの対応する項目の文字列サイズが 15 文字の場合は，転送元テーブルの 10 文字より後のすべての値は切り捨てられます。値が変換できない場合は，TBatchMove が例外を生成します。

Mode プロパティを batCopy に設定した場合は切りつめは発生しません。削除処理を行う場合に，項目の切りつめが発生すると，ソーステーブルのレコードとは厳密には一致しないターゲットテーブルのレコードが削除される可能性があります。

注意

項目ごとに切りつめを指定するには，TBDECallback オブジェクトを使います。


TBatchMove.ChangedCount
TBatchMove.ChangedCount3021006

TBatchMove	参照

ChangedCount プロパティは，バッチ処理の結果変更された転送先テーブルのレコード数を示します。

property ChangedCount: Integer;

説明

ChangedCount プロパティは，Mode が batUpdate または batAppendUpdate の場合に更新される転送先テーブルのレコード数を調べたり，Mode が batDelete の場合に削除されるレコード数を調べたりできます。

ChangedTableName プロパティを設定すると，レコードの変更時に元のレコードを別のテーブルに保存できます。この場合，ChangedCount は別のテーブルのレコード数となります。


TBatchMove.ChangedTableName
TBatchMove.ChangedTableName3021007

TBatchMove	参照

ChangedTableName プロパティは，Paradox テーブルの名前を指定します。Paradox テーブルには，バッチ処理の結果変更された転送先テーブルのすべてのレコードが入ります。

property ChangedTableName: TFileName;

説明

ChangedTableName プロパティを設定すると，バッチ処理がレコードを変更するときに元のレコードを保存するテーブルを作成できます。ChangedTableName には，Paradox テーブルの名前を指定する必要があります。ChangedTableName を設定すると，転送先テーブルのレコードが変更または削除されたときに，そのテーブルの情報が失われないことを確実にできます。

Mode プロパティが batUpdate または batAppendUpdate のときは，更新されたすべてのレコードが ChangedTableName テーブルに保存されます。Mode プロパティが batDelete のときは，削除されたすべてのレコードが ChangedTableName テーブルに保存されます。

ChangedCount プロパティは，ChangedTableName テーブルのレコード数を示します。


TBatchMove.CommitCount
TBatchMove.CommitCount3021008

TBatchMove	参照

CommitCount プロパティは，コミットが発生する前にバッチによって移動されるレコード数を指定します。

property CommitCount: Integer;

説明

CommitCount プロパティは，バッチをいくつかの処理に分割したり，バッチ全体を処理できるほど大きくないサーバートランザクションログをアプリケーションで確保できます。CommitCount を 0 に設定すると，32KB に収まるレコード数毎の分割になります。

注意

テーブルを含んだデータベースの明示的なトランザクションで Execute メソッドが呼び出されると，CommitCount は無視されます。


TBatchMove.Destination
TBatchMove.Destination3021009

TBatchMove	参照

Destination プロパティは，バッチ処理の転送先のデータベーステーブルに対応する TTable オブジェクトを指定します。

property Destination: TTable;

説明

Destination プロパティは，バッチ処理で作成または変更されるデータベーステーブルを指定できます。Destination に対するバッチ処理は，Mode プロパティの値によって異なります。

Mode	Destination に対する処理

batAppend	転送先テーブルにレコードを追加する。以前から存在しているレコードは変更されない。転送先テーブルは既存のものでなくてはならない

batUpdate	転送元テーブルの対応する項目と一致するキー設定項目がある転送先テーブルのレコードを，ソースのレコードと一致するように変更する。新しいレコードは追加されない。転送先テーブルは既存のもので，インデックスが定義されていなければならない

batAppendUpdate	転送元テーブルの対応する項目と一致するキー設定項目がある転送先テーブルのレコードを，転送元のレコードと一致するように変更する。キー設定項目と一致しない転送元レコードは転送先テーブルに追加される。転送先テーブルは既存のもので，インデックスが定義されていなければならない

batDelete	転送先テーブルのレコードで転送元テーブルのレコードと一致するものを削除する。転送先テーブルは既存のもので，インデックスが定義されていなければならない

batCopy	転送元テーブルのレコードと一致するように転送先テーブルを作成する。転送先テーブルが既存のものの場合は，転送元テーブルのコピーで書き換えられる


TBatchMove.KeyViolCount
TBatchMove.KeyViolCount3021010

TBatchMove	参照

KeyViolCount プロパティは，整合性（またはキー）違反のために転送先に対して置き換え，追加，または削除が行えなかったレコードの数を報告します。

property KeyViolCount: Longint;

説明

KeyViolCount プロパティは，整合性（またはキー）違反のために転送先テーブルに適用できない転送元テーブルのレコード数を知ることができます。転送元テーブルから違反したレコードのテーブルを取得するには，KeyViolTableName を指定します。

キー違反は，一次キーを持つテーブルにレコードを追加したときに発生します。一次キーを持つテーブルでは，すべてのキー設定項目において 2 つのレコードが同じ値をとることはできません。追加するレコードが，すべてのキー設定項目においてターゲットテーブルのレコードと同じ値を持つ場合，レコードは追加できません。

整合性違反は，参照整合性を定義しているテーブルでレコードを削除，追加，または更新すると発生します。参照整合性の仕様では，1 つのテーブルの各項目が，別のテーブルの特定の項目に存在する値を持つ必要があります。追加するレコードが参照整合性の制限に適合しない場合，レコードは追加できません。レコードを削除すると参照整合性の制限が厳しくなり，これを参照する別のテーブルがその条件を満たせなくなる場合は，そのレコードは削除できません。

注意

AbortOnKeyViol プロパティが True の場合，最初の違反でバッチ処理が終了するため，KeyViolCount が 1 を超えることはありません。


TBatchMove.KeyViolTableName
TBatchMove.KeyViolTableName3021011

TBatchMove	参照

KeyViolTableName プロパティは，Paradox テーブルの名前を指定します。Paradox テーブルには，整合性違反またはキー違反のためにバッチ処理に加えることができない転送元のすべてのレコードが入ります。

property KeyViolTableName: TTable;

説明

KeyViolTableName プロパティは，整合性違反またはキー違反のために転送先テーブルに適用できないレコードのテーブルを取得できます。KeyViolCount は，作成されたテーブルのレコード数を保持します。

キー違反は，一次キーを持つテーブルにレコードを追加したときに発生します。一次キーを持つテーブルでは，すべてのキー設定項目において 2 つのレコードが同じ値をとることはできません。追加するレコードが，すべてのキー設定項目においてターゲットテーブルのレコードと同じ値を持つ場合，レコードは追加できません。

整合性違反は，参照の整合性を定義しているテーブルでレコードを削除，追加，または更新すると発生します。参照の整合性の仕様では，1 つのテーブルの各項目が，別のテーブルの特定の項目に存在する値を持つ必要があります。追加するレコードが参照の整合性の制限に適合しない場合，レコードは追加できません。レコードを削除すると参照の整合性の制限が厳しくなり，これを参照する別のテーブルがその条件を満たせなくなる場合はそのレコードは削除できません。

注意

AbortOnKeyViol プロパティが True の場合，テーブルの最初のレコードでバッチ処理が終了するため，テーブルに存在するレコードは最大でも 1 つとなります。


TBatchMove.Mappings
TBatchMove.Mappings3021012

TBatchMove	参照

Mappings プロパティは，バッチ処理の列マッピングを指定します。

property Mappings: TStrings;

説明

Mappings プロパティを設定すると，転送元テーブルの項目と転送先テーブルの項目の対応を指定できます。TBatchMove は，デフォルトの設定では項目を転送元テーブルと転送先テーブルでの位置に基づいて対応させます。つまり，転送元テーブルの最初の列が転送先テーブルの最初の列に対応し，以下も順に対応します。Mappings を設定すると，アプリケーションはこのデフォルト状態をオーバーライドできます。

Mappings プロパティは，以下のいずれかの形式で 1 行に 1 つづつ書いたリストです。転送元テーブルの ColName という列を，転送先テーブルの同じ名前の列にマップするときは次の形式を使います。

ColName

転送元テーブルの SourceColName という列を，転送先テーブルの DestColName という列にマップするときは次の形式を使います。

DestColName = SourceColName

レコードを追加する場合，Mappings にエントリのない転送先の項目は NULL に設定されます。データセットをコピーする場合，Mappings にエントリのない転送先の項目は，ターゲットテーブルの項目として存在しなくなります。

転送元テーブルの列と転送先テーブルの列のデータ型が異なる場合，TBatchMove はバッチ処理を中止するか，または「最善策」をとります。AbortOnProblem が True の場合は，型の不一致のためバッチ処理が終了します。それ以外の場合は，可能であれば転送元の項目値を転送先と互換性のある値に変換します。


TBatchMove.Mode
TBatchMove.Mode3021013

TBatchMove	参照

Mode プロパティは Execute メソッドが呼び出されたときの TBatchMove オブジェクトの処理内容を指定します。

property Mode: TBatchMode;

説明

Mode プロパティは，TBatchMove オブジェクトがレコードの追加，置換，削除，または Source のコピーを行うかどうかを指定します。

値	意味

batAppend	転送先テーブルに転送元テーブルのレコードを追加する。転送先テーブルは既存のものでなければならない。デフォルトのモード

batUpdate	転送元テーブルのレコードで転送先テーブルの対応するレコードを更新する。転送先テーブルは既存のもので，レコードを対応させるためのインデックスが定義されていなければならない

batAppendUpdate	転送先テーブルに対応するレコードがあればそれを更新する。対応するレコードがない場合，転送先テーブルにレコードを追加する。転送先テーブルは既存のもので，レコードを対応させるためのインデックスが定義されていなければならない

batCopy	転送元テーブルの構造に基づいて転送先テーブルを作成する。転送先テーブルが既存のものの場合は削除され，転送元テーブルの新しいコピーで書き換えられる

batDelete	転送先テーブルのレコードのうち転送元テーブルのレコードに対応するものを削除する。転送先テーブルは既存のもので，インデックスが定義されていなければならない


TBatchMove.MovedCount
TBatchMove.MovedCount3021014

TBatchMove	参照

MovedCount プロパティは，転送先テーブルに適用された転送元のレコード数を報告します。

property MovedCount: Longint;

説明

MovedCount プロパティは，Execute メソッドの実行中に読み出された転送元のレコード数を取得できます。MovedCount の値には，キーまたは整合性違反の発生したレコードや，切りつめられたレコードの数が含まれます。


TBatchMove.ProblemCount
TBatchMove.ProblemCount3021015

TBatchMove	参照

ProblemCount プロパティは，項目型の不一致により転送先に追加する際にデータを失ったレコードの数を示します。

property ProblemCount: Longint;

説明

ProblemCount プロパティは，データを切りつめないと転送先の項目にマップできなかった項目値を持つ転送元のレコード数を取得できます。ProblemTableName を指定すると，ProblemCount はそのテーブルのレコード数となります。

項目を切りつめることは，項目値を転送先テーブルの項目型と互換性がある値に変換することです。たとえば，転送先テーブルの項目が 10 文字で，転送元テーブルの対応する項目が 15 文字の場合，転送元テーブルの最後の 5 文字が切りつめられます。値が変換できない場合，TBatchMove は例外を生成します。

Mode プロパティが batCopy に設定されている場合，切りつめは発生しません。削除処理を行う場合，項目の切りつめが発生すると，ソーステーブルのレコードとは厳密には一致しないターゲットテーブルのレコードが削除される可能性があります。

注意

AbortOnKeyViol が True の場合，問題が発生すると処理が終了するため，ProblemCount は最大で 1 となります。


TBatchMove.ProblemTableName
TBatchMove.ProblemTableName3021016

TBatchMove	参照

ProblemTableName プロパティは，Paradox テーブルの名前を指定します。Paradox テーブルには，転送先テーブルの項目型に一致させるために項目を切りつめた転送元のすべてのレコードが入ります。

property ProblemTableName: TTable;

説明

ProblemTableName を設定すると，転送先と一致させるために切りつめられた項目を含む Source のレコードが入ったテーブルを作成できます。ProblemCount は，新しいテーブルに登録されたレコード数を保持します。ProblemTableName が指定されていなくても，レコード内のデータは転送先テーブルに適用されるときに切りつめられるので，どの項目が切りつめられたかを判別することは困難です。

項目を切りつめるということは，項目の値を転送先テーブルの項目型と互換性がある値に変換することを意味します。たとえば，転送先テーブルの項目が 10 文字で，転送元テーブルの対応する項目が 15 文字の場合，転送元テーブルの最後の 5 文字が切り捨てられます。値が変換できないと，TBatchMove は例外を発生します。

Mode プロパティが batCopy に設定されている場合，切りつめは発生しません。削除処理を行う場合，項目の切りつめが発生すると，ソーステーブルのレコードとは厳密に一致しないターゲットテーブルのレコードが削除される可能姓があります。

注意

AbortOnKeyViol プロパティが True の場合，問題がある最初のレコードで処理が終了するため，テーブルに存在するレコードは最大でも 1 つとなります。


TBatchMove.RecordCount
TBatchMove.RecordCount3021017

TBatchMove	参照

RecordCount プロパティは，Execute メソッドが呼び出されたときに転送先に適用されるレコードの最大数を指定します。

property RecordCount: Longint;

説明

RecordCount プロパティは，転送先に適用する転送元のレコード数を制限できます。この値に 0 を指定すると，転送元の最初のレコードからすべてのレコードが追加，削除，またはコピーされます。RecordCount が 0 より大きい場合は，データセット内のカレントレコードから最大 RecordCount 数のレコードが転送先に適用されます。RecordCount の値が転送元内の残りのレコード数より大きい場合，転送元の最初のレコードには戻らず，処理は終了します。


TBatchMove.Source
TBatchMove.Source3021018

TBatchMove	参照

Source プロパティは，バッチ処理の転送元となるデータセットを指定します。

property Source: TBDEDataSet;

説明

Source プロパティは，転送先で追加，削除，またはコピーされるレコードを含んだデータセットを指定できます。Mode プロパティは，転送元のレコードがどのように転送先に適用されるかを示します。

Mode	転送先に対する処理

batAppend	転送先テーブルにレコードを追加する

batUpdate	転送元テーブルの対応する項目と一致するキー設定項目がある転送先テーブルのレコードを，転送元のレコードと一致するように変更する

batAppendUpdate	転送元テーブルの対応する項目と一致するキー設定項目がある転送先テーブルのレコードを，転送元のレコードと一致するように変更する。キー設定項目と一致しない転送元レコードは転送先テーブルに追加される

batDelete	転送先テーブルのレコードで転送元テーブルのレコードと一致するものを削除する

batCopy	転送元テーブルのレコードと一致するように転送先テーブルを作成する


TBatchMove.Transliterate
TBatchMove.Transliterate3021019

TBatchMove	参照

Transliterate プロパティは，Execute メソッドの呼び出し時に，転送元のレコードのデータを Source プロパティの言語から Destination プロパティの言語に変換するかどうかを指定します。

property Transliterate: Boolean;

説明

転送元のデータセットと転送先テーブルが異なる言語ドライバを使っており，データに拡張 ASCII 文字が含まれているときは，Transliterate を True に設定します。転送元と転送先が同じ言語ドライバを使っているか，データに拡張 ASCII 文字が含まれていないときは，Transliterate を False に設定して文字セット変換のオーバーヘッドを生成しないようにします。


TBatchMove メソッド3021020

TBatchMove	アルファベット順

TBatchMove

Create

Destroy

Execute

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TBatchMove メソッド3021021

TBatchMove	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Execute

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TBatchMove.Create
TBatchMove.Create3021022

TBatchMove	参照

Create メソッドは TBatchMove のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，バッチ処理を実行するための TBatchMove のインスタンスが作成されます。Create は TBatchMove オブジェクトにメモリを割り当てて，以下の処理を行います。

・	AbortOnKeyViolation を True に設定する

・	AbortOnProblem を True に設定する

・	Transliterate を True に設定する

・	TStringList オブジェクトを作成して Mappings を保持する

Create で設定したこれらのプロパティは，TTable オブジェクトが BatchMove メソッドでバッチ処理を実行するときに使用する値です。


TBatchMove.Destroy
TBatchMove.Destroy3021023

TBatchMove	参照

Destroy メソッドは TBatchMove のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出すことはせず，Free メソッドを呼び出すようにしてください。Free メソッドは TBatchMove オブジェクトがまだ解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは Mappings プロパティを実現する TStringList オブジェクトを解放してから，継承したデストラクタを呼び出します。


TBatchMove.Execute
TBatchMove.Execute3021024

TBatchMove	参照

Execute メソッドは Mode に指定されたバッチ処理を実行します。

procedure Execute;

説明

実行するバッチ処理とその方法を示すプロパティを設定したら，Execute メソッドを呼び出して処理を実行します。Mode，Source，および Destination の各プロパティは必ず設定しなくてはなりません。

Execute メソッドを呼び出すと，ChangedCount，KeyViolCount，MovedCount，ProblemCount，および RecordCount の各プロパティの値が利用可能になります。これらのプロパティは，Execute を呼び出した結果行われた処理を示します。ChangedTableName，KeyViolTableName または ProblemTableName プロパティを設定すれば，バッチ処理に関する詳しい情報を得ることができます。


スコープ3021025

published

読み出し／書き込み

読み出し専用


継承3021026

TObject

TPersistent

TComponent


TBCDField
TBCDField3022001

継承	プロパティ	メソッド	イベント	参照

TBCDField オブジェクトは，データセット内の 2 進化 10 進数（BCD）型項目を表します。

ユニット

db

説明

BCD 値は浮動小数点数よりも正確で精度の高い値です。BCD 型項目は金額の値の格納と演算に使われます。通常，BCD 値は 10 進数の形式で格納および保存されます。しかし，Delphi はネイティブな 2 進化 10 進数型を持たないので，TBCDField オブジェクトは Currency 型を使って BCD 値を操作します。Currency はバイナリ形式です。

TBCDField オブジェクトは Currency 型を使って BCD 型項目のデータを扱うので，TBCDField オブジェクトで扱える BCD 値でサポートできる精度は小数点以下 4 桁で有効数字 20 桁です。データベーステーブルにはより高い精度の値を入れることができますが，そのような値に遭遇した場合 TBCDField オブジェクトは例外を生成します。

TNumericField オブジェクトの派生オブジェクトとして，TBCDField オブジェクトはデータベースの数値型項目に格納されている値およびプロパティの操作に便利なプロパティ，メソッド，およびイベントを数多く備えています。


TBCDField プロパティ3022002

TBCDField	アルファベット順	凡例

TBCDField

AsCurrency

AsFloat

AsInteger

AsString

AsVariant

Currency

MaxValue

MinValue

Value

TNumericField からの継承

DisplayFormat

EditFormat

TField からの継承

Alignment

AsBoolean

AsDateTime

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HastConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TBCDField プロパティ3022003

TBCDField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

Currency

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayFormat

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditFormat

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HastConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

MaxValue

MinValue

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TBCDField.AsCurrency
TBCDField.AsCurrency3022004

TBCDField	参照

AsCurrency プロパティは，項目値と通貨型値の間の変換を行います。

property AsCurrency: Currency;

説明

AsCurrency プロパティは以下の処理に使います。

・	2 進化 10 進数型項目の値を通貨型の値に代入する

・	金額型の値を 2 進化 10 進数型項目に代入する

次のコードは金額型の値を 2 進化 10 進数型項目の値に代入します。

MyBCDField.AsCurrency := CurrencyValue;

2 進化 10 進数型項目の値を金額型の値に代入するには，次のようなコードを使います。

CurrencyVariable := MyBCDField.AsCurrency;

BCD 型項目では，AsCurrency プロパティは Value プロパティと同じです。項目コンポーネントが BCD 型項目を含んでいるかもしれないときは，AsCurrency プロパティを使います。

項目に割り当てられた値が MinValue プロパティおよび MaxValue プロパティで指定された範囲の外にある場合，EDatabaseError 例外が生成されます。

注意

データの型を変換する AsCurrency プロパティと，データの形式を示す Currency プロパティを混同しないように注意してください。


TBCDField.AsFloat
TBCDField.AsFloat3022005

TBCDField	参照

AsFloat プロパティは，項目値と浮動小数点値の間の変換を行います。

property AsFloat: Double;

説明

AsFloat プロパティは次の処理に使います。

・	2 進化 10 進数型項目の値を浮動小数点値に代入する

・	浮動小数点値を 2 進化 10 進数型項目に代入する

次のコードは浮動小数点値を 2 進化 10 進数型項目の値に代入します。

MyBCDField.AsFloat := FloatVariable;

2 進化 10 進数型項目の値を浮動小数点値に代入するには，次のようなコードを使います。

FloatVariable := MyBCDField.AsFloat;

項目に割り当てられた値が MinValue プロパティおよび MaxValue プロパティで指定された範囲の外にある場合，EDatabaseError 例外が生成されます。


TBCDField.AsInteger
TBCDField.AsInteger3022006

TBCDField	参照

AsInteger プロパティは，項目値と整数値の間の変換を行います。

property AsInteger: Longint;

説明

AsInteger プロパティは次の処理に使います。

・	2 進化 10 進数型項目の値を整数型変数値に代入する

・	整数型変数値を 2 進化 10 進数型項目に代入する

次のコードは整数値を 2 進化 10 進数型項目の値に代入します。

MyBCDField.AsInteger := IntegerVariable;

2 進化 10 進数型項目の値を整数値に代入するには，次のようなコードを使います。

IntegerVariable := MyBCDField.AsInteger;

項目に割り当てられた値が MinValue プロパティおよび MaxValue プロパティで指定された範囲の外にある場合，EDatabaseError 例外が生成されます。


TBCDField.AsString
TBCDField.AsString3022007

TBCDField	参照

AsString プロパティは，項目値と 2 進化 10 進数値の間の変換を行います。

property AsString: string;

説明

AsString プロパティは次の処理に使います。

・	2 進化 10 進数型項目の値を文字列変数に代入する

・	文字列値を2 進化 10 進数型項目に代入する

次のコードは文字列値を2 進化 10 進数型項目の値に代入します。

MyBCDField.AsString := �12.32�;

2 進化 10 進数型項目の値を文字列値に入力するには，次のようなコードを使います。

NewString := MyBCDField.AsString;

項目に割り当てられた文字列が MinValue プロパティおよび MaxValue プロパティで指定された有効な通貨型の値の範囲外である場合，EDatabaseError 例外が生成されます。


TBCDField.AsVariant
TBCDField.AsVariant3022008

TBCDField	参照

AsVariant プロパティは，2 進化 10 進数型項目の値とバリアント値の間の変換を行います。

property AsVariant: Variant;

説明

AsVariant プロパティは次の処理に使います。

・	2 進化 10 進数型項目の値をバリアント値に代入する

・	バリアント値を2 進化 10 進数型項目の値に代入する

次のコードは Variant の値を2 進化 10 進数型項目の値に代入します。

MyBCDField.AsVariant := VariantVariable;

2 進化 10 進数型項目の値をバリアント値に代入するには，次のようなコードを使います。

VariantVariable:= MyBCDField.AsVariant;

バリアントは，項目の型およびデータの形式が不明の場合に使うと便利です。

項目に割り当てられた値が MinValue プロパティおよび MaxValue プロパティで指定された値の範囲外である場合，EDatabaseError 例外が生成されます。


TBCDField.Currency
TBCDField.Currency3022009

TBCDField	参照

Currency プロパティは，項目の値を金額として表示するかどうかを決めます。

property Currency: Boolean;

説明

Currency プロパティは，項目をデータ処理コントロールで表示および編集する際に値を表示する形式を指定できます。

項目の表示形式は，DisplayFormat プロパティが指定されていればそれによって決まります。DisplayFormat プロパティが指定されていない場合，Currency プロパティが項目の表示形式を決めます。Currency プロパティが True であれば，値の表示形式は FloatToText 関数によって，ffCurrency 形式で設定されます。Currency プロパティが False の場合は，値は ffGeneral 形式を使います。

編集時の項目の形式は，EditFormat（または DisplayFormat）プロパティが指定されていればそれによって決まります。EditFormat プロパティまたは DisplayFormat プロパティのどちらも指定がない場合，Currency プロパティが編集時の項目の形式を決めます。Currency プロパティが True であれば，編集時の値の形式は FloatToText 関数によって，ffFixed 形式で設定されます。Currency プロパティが False の場合は，値は ffGeneral 形式を使います。


TBCDField.MaxValue
TBCDField.MaxValue3022011

TBCDField	参照

MaxValue プロパティは，2 進化 10 進数型項目の最大値を制限します。

property MaxValue: Currency;

説明

MaxValue プロパティは，項目に入力できる値の最大値を取得または設定できます。MaxValue プロパティよりも大きい値が入力された場合，EDatabaseError 例外が生成されます。

新しく作成された BCD 型項目は，MaxValue プロパティを Currency のデータ型で表現できる最大値に設定します。


TBCDField.MinValue
TBCDField.MinValue3022012

TBCDField	参照

MinValue プロパティは，2 進化 10 進数型項目の最小値を制限します。

property MinValue: Currency;

説明

MinValue プロパティは，項目に入力できる値の最小値を取得または設定できます。MinValue プロパティよりも小さい値が入力された場合，EDatabaseError 例外が生成されます。

新しく作成された BCD 型項目は，MinValue プロパティを Currency のデータ型で表現できる最小値に設定します。


TBCDField.Value
TBCDField.Value3022013

TBCDField	参照

Value プロパティは，BCD 型項目の値を Currency 値で示します。

property Value: Currency;

説明

他の項目型とは異なり，BCD 型項目の Value はデータベーステーブルに保存されているデータの物理的な形式と正確に一致するわけではありません。Delphi には2 進化 10 進数のネイティブな型がありません。そのため，TBCDField オブジェクトはデータベーステーブルからデータを取り出すときに 2 進化 10 進数値のデータを Currency 値に変換し，データをデータベースに登録するときに Currency 値を 2 進化 10 進数値に変換します。BCD 型項目では，Value プロパティは AsCurrency プロパティと同じになります。

注意

TBCDField オブジェクトではデータを Currency 値として扱うので，単に項目の値を取得してその値をデータベーステーブルに登録し直すと，項目の内容を変更する結果になります。次のコードがその例です。

MyBCDField.SetData(MyBCDField.Value);

この行によって，データベーステーブルにある項目の内容が変更される場合があります。


TBCDField イベント3022014

TBCDField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TBCDField イベント3022015

TBCDField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TBCDField メソッド3022016

TBCDField	アルファベット順

TBCDField

Create

IsValidChar

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TBCDField メソッド3022017

TBCDField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TBCDField.Create
TBCDField.Create3022018

TBCDField	参照

Create メソッドは，TBCDField のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，TBCDField オブジェクトのインスタンスを作成して初期化できます。継承コンストラクタを呼び出した後で，Create メソッドは DataType プロパティを ftBCD に設定し，Size プロパティを 4 に初期化します。

データセット内の すべての BCD 型項目について BCD 型項目コンポーネントが自動的にインスタンス化されるので，Create メソッドを明示的に呼び出す必要はほとんどありません。


スコープ3022019

published

読み出し／書き込み

読み出し専用


スコープ3022020

published


継承3022021

TObject

TPersistent

TComponent

TField

TNumericField


TBCDField 例3022022

TBCDField


TBDECallback
TBDECallback3023001

継承	メソッド	参照

TBDECallback オブジェクトは，ボーランドデータベースエンジン（BDE）のコールバック関数のラッパーです。

ユニット

dbtables

説明

TBDECallback オブジェクトを使うと，コールバック関数を BDE に登録できます。コールバックを使うと，BDE 関数の呼び出し時に発生するイベントに応答して BDE が特定のアクションを起こすようにアプリケーションから指示できます。

たとえば TBatchMove オブジェクトは，対応する BDE バッチ処理が呼び出されると問題が発生する場合があると，コールバック関数はこれらの問題の処置として，BDE に対して problems テーブルの生成やデータの切り捨てを指示し，処理を継続させることができます。

TBDECallback オブジェクトを使う手順は以下のとおりです。

1.	TBDECallback のインスタンスを作成して，コールバックを BDE に登録します。

2.	適切なイベントを発生させることができる BDE 関数を呼び出します。たとえば，TBatchMove のインスタンスを作成して，その Execute メソッドを呼び出します。

3.	BDE 関数が終了したら，TBDECallback オブジェクトを破棄してコールバック関数の登録を解除します。


TBDECallback メソッド3023002

TBDECallback	アルファベット順

TBDECallback

Create

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TBDECallback メソッド3023003

TBDECallback	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TBDECallback.Create
TBDECallback.Create3023004

TBDECallback	参照

Create メソッドは，TBDECallback のインスタンスを作成して，指定したコールバックをボーランドデータベースエンジン（BDE）に登録します。

TBDECallbackEvent = function(CBInfo: Pointer): CBRType of Object;

constructor Create(AOwner: TObject; Handle: hDBICur; CBType: CBType; CBBuf: Pointer; CBBufSize: Integer; CallbackEvent: TBDECallbackEvent; Chain: Boolean);

説明

Create メソッドを呼び出すと，コールバックを BDE に登録できます。コールバックを使ってイベントに応答する BDE 関数を呼び出す前に，TBDECallback オブジェクトを作成します。

BDE が CBType パラメータで示されるイベントの型を見つけると，CallbackEvent パラメータで指定された関数が呼び出されます。CallbackEvent は，コールバック記述子を指すポインタを受け取ります。コールバック記述子の型は CBType によって異なります。Delphi アプリケーションは，コールバック記述子用にメモリを割り当てる必要があります。このメモリを指すポインタは CBBuf パラメータとして渡され，サイズが CBBufSize パラメータで与えられます。

Chain パラメータは，CallbackEvent 関数が CBType で指定される他のコールバックを更新するかどうかを指定します。Chain が False のときは，この CBType 用に登録されたすべてのコールバックが CallbackEvent 関数によって更新されます。Chain が True のときは，CallbackEvent 関数が他の登録済み関数とともに呼び出されます。

Handle パラメータはオプションのパラメータであり，コールバックを生成する可能性のある BDE 関数に関連付けられたデータベースカーソルを指定します。Handle を指定すると，コールバックをそのデータベースカーソルの関数呼び出しに限定できます。

以下に，それぞれの CBType に関連付けられたコールバック記述子の型を示します。詳細については BDE のマニュアルを参照してください。

CBType	用途	コールバック記述子

cbGENPROGRESS	大きなバッチ処理の進行状況に応答する。たとえば，プログレスバーや中止ボタンの実装など。cbrABORT を返すと処理が中止され，cbrCONTINUE を返すと続行される.	CBPROGRESSDesc
cbRESTRUCTURE	テーブルの再構築で発生した状況にどう対処するかを BDE に指示する。cbrYES を返すとデフォルト動作を行って処理を継続する。cbrNO を返すとデフォルト動作を行わずに処理を継続する。cbrABORT を返すとテーブルの再構築を中止する	CBRESTCbDesc
cbBATCHRESULT	バッチ処理中に発生した状況にどう対処するかを BDE に指示する。cbrYES を返すとデフォルト動作を行って処理を継続する。cbrNO を返すとデフォルト動作を行わなずに処理を継続する。cbrABORT を返すとバッチ処理を中止する	CBRESTDbDesc
cbTABLECHANGED	テーブル変更の通知に応答する。戻り値は無視される	使用しない
cbCANCELQRY	cbrABORT を返すと，処理時間のかかる問い合わせの実行を中止する。cbrCONTINUE を返すと処理を続行する。問い合わせの実行中はコールバックが定期的に呼び出される	使用しない
cbINPUTREQ	参照テーブルなどのファイルがないときにどう応答するかを BDE に指示する。選択した動作を CBInputDesc に指定し，cbrCONTINUE を返す	CBInputDesc
cbDBASELOGIN	暗号化化された dBASE テーブルのパスワードを入力して，cbrCONTINUE を返す	CBLoginDesc
cbFIELDRECALC	項目の再計算が必要だという通知に応答する。戻り値は無視される	使用しない
cbTRACE	BDE が行ったアクションに関するトレース情報に応答する。戻り値は無視される	TRACEDesc
cbDBLOGIN	データベースサーバーにログインする。cbrCONTINUE を返す	使用しない
cbDELAYEDUPD	キャッシュアップデートがレコードをデータベースに書き込めなかったという通知に応答する。cbrABORT を返すとキャッシュアップデートをすべて破棄する。cbrSKIP または cbrCONTINUE を返すと，更新できなかった内容を破棄してレコードの送信を続行する。cbrRETRY を返すと，失敗したコミットを再試行する	DELAYUPDCbDesc
注意

Delphi は多くの BDE コールバック関数を使います。Chain を False に設定して Create を呼び出すと，いくつかのオブジェクトに期待される動作が無効になる場合があります。


TBDECallback.Destroy
TBDECallback.Destroy3023005

TBDECallback	参照

Destroy メソッドは，コールバックの登録を解除して TBDECallback のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出すことはせずに，Free メソッドを呼び出すようにしてください。Free メソッドは TBDECallback オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy はコールバックの登録を解除してから，TBDECallback オブジェクトに関連付けられていたメモリを解放します。コールバックの登録を解除してから，以前に登録していた同じ型のコールバックは復元されます。


継承3023006

TObject


TBDECallback 例3023007

TBDECallback


TBDEDataSet
TBDEDataSet3024001

継承	プロパティ	メソッド	イベント	参照

TBDEDataSet コンポーネントは，データセットオブジェクト用にボーランドデータベースエンジン（BDE）機能をカプセル化します。

ユニット

dbtables

説明

TBDEDataSet はデータセットに BDE 機能を定義するデータセットオブジェクトです。アプリケーションは TBDEDataSet オブジェクトを直接使うことはありません。かわりに TBDEDataSet および TDBDataSet からデータベース関連プロパティとメソッドを継承する，TQuery，TStoredProc，および TTable を使います。

BDE を介して機能するカスタムデータセットコンポーネントを作成する場合，それらのコンポーネントを直接 TBDEDataSet から派生させ，TDataSet の機能と TBDEDataSet の BDE 関連のプロパティおよびメソッドをすべて継承しようとするでしょう。しかし Delphi データベースオブジェクトに対する制御を継承するには，ほとんどの場合，TBDEDataSet からではなく TDBDataSet から，BDE を使うカスタムデータセットコンポーネントを派生させます。


TBDEDataSet プロパティ3024002

TBDEDataSet	アルファベット順	凡例

TBDEDataSet

CacheBlobs

CachedUpdates

CanModify

ExpIndex

Filter

Filtered

FilterOptions

Handle

KeySize

Locale

RecNo

RecordCount

RecordSize

UpdateObject

UpdateRecordTypes

UpdatesPending

TDataSet からの継承

Active

AutoCalcFields

BOF

Bookmark

DataSource

DefaultFields

Designer

EOF

FieldCount

FieldDefs

Fields

FieldValues

Found

Modified

Name

State

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TBDEDataSet プロパティ3024003

TBDEDataSet	オブジェクト順	凡例

Active

AutoCalcFields

BOF

Bookmark

CacheBlobs

CachedUpdates

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DataSource

DefaultFields

Designer

DesignInfo

EOF

ExpIndex

FieldCount

FieldDefs

Fields

FieldValues

Filter

Filtered

FilterOptions

Found

Handle

KeySize

Locale

Modified

Name

Owner

RecNo

RecordCount

RecordSize

State

Tag

UpdateObject

UpdateRecordTypes

UpdatesPending

VCLComObject


TBDEDataSet.CacheBlobs
TBDEDataSet.CacheBlobs3024004

TBDEDataSet

CacheBlobs プロパティは，BLOB がメモリにキャッシュされるかどうかを決めます。

property CacheBlobs: Boolean;

説明

CacheBlobs は，BLOBイメージを表示するレコードをスクロールするときの性能を向上させるためにメモリ内に BLOB イメージを格納するかどうかを指定できます。デフォルトでは CacheBlobs は True で，BLOB がメモリにキャッシュされることを意味します。アプリケーションでレコードに関連付けられた BLOB を表示する必要がない場合には，CacheBlobs を False に設定してシステムリソースを節約します。


TBDEDataSet.CachedUpdates
TBDEDataSet.CachedUpdates3024005

TBDEDataSet	参照

CachedUpdates プロパティは，キャッシュアップデートがデータセットで使用可能かどうかを指定します。

property CachedUpdates: Boolean;

説明

CachedUpdates はデータセットでキャッシュアップデートを使用可能/使用不可にします。CachedUpdates が True の場合，キャッシュアップデートは使用可能です。CachedUpdates が False の場合，キャッシュアップデートは使用不可です。

キャッシュアップデートが使用可能な場合，データセットに行う更新（変更内容の登録，新しいレコードの挿入，レコードの削除など）はデータセットの基になるデータベーステーブルに直接書き込まれるのではなく，クライアントマシンの内部キャッシュに格納されます。変更が完了したときに，アプリケーションはキャッシュしたすべての変更を 1 つのトランザクションのコンテキストでデータベースに書き込みます。

キャッシュアップデートは，リモートデータベースサーバーを使うクライアントアプリケーションで特に便利です。キャッシュアップデートを使用可能にする利点を以下に示します。

・	トランザクションの回数が少なく時間も短い

・	ネットワークのトラフィックを最小限にできる

キャッシュアップデートを使用可能にすると以下のような不具合が生じる場合もあります。

・	ユーザーがデータのローカルコピーを編集している間に別のアプリケーションが実際のデータにアクセスして変更できるので，キャッシュアップデートをデータベースに適用したときに更新の衝突が起こる

・	キャッシュアップデートがデータベースに適用されるまで，アプリケーションが加えたデータの変更にほかのアプリケーションがアクセスできない


TBDEDataSet.CanModify
TBDEDataSet.CanModify3024006

TBDEDataSet	参照

CanModify プロパティは，データセットの基になるデータベースが書き込みアクセスを許可するかどうかを示します。

property CanModify: Boolean;

説明

CanModify プロパティは，データセットの基になるデータベースがデータへの書き込みアクセスを許可するかどうかを判別できます。データベース接続が確立されているとき，データセットは，通常，書き込みアクセスを要求します。CanModify は書き込みアクセスが許可されているかどうかを示します。CanModify が True の場合，そのデータベースサーバーに対するデータの変更および書き込みができます。CanModify が False の場合，データを読めますが変更はできません。

注意

指定されたユーザーの書き込みアクセスを制限すると， CanModify が True でも SQL データベースに書き込むことができない場合があります。


TBDEDataSet.ExpIndex
TBDEDataSet.ExpIndex3024007

TBDEDataSet

ExpIndex プロパティは，データセットが dBASE の式のインデックスを使っているかどうかを示します。

property ExpIndex: Boolean;

説明

ExpIndex を読み出すと，データセットが dBASE の式のインデックスを使っているかどうかを判別できます。ExpIndex が True の場合，式のインデックスが使われています。それ以外の場合，ExpIndex は False です。


TBDEDataSet.Filter
TBDEDataSet.Filter3024008

TBDEDataSet	参照

Filter プロパティは，データセットの現在のフィルタのテキストを指定します。

property Filter: string;

説明

Filter は，データセットフィルタを指定できます。フィルタ処理をデータセットに適用すると，フィルタの条件に適合するレコードだけがアプリケーションで利用できるようなります。Filter にはフィルタ条件を示す文字列を指定します。たとえば次のフィルタ条件を設定すると，State 項目が「CA」または「MA」のレコードだけが表示されます。

State = 'CA' or State = 'MA'

部分比較された文字列に基づいてフィルタ処理するには，ワイルドカードとしてアスタリスク（*）を使います。以下に例を示します。

State = 'M*'

注意

アプリケーションでは，データセットに対して（たとえばユーザーの入力に応答するとき）フィルタ処理条件を変更できるように実行時に Filter を設定できます。


TBDEDataSet.Filtered
TBDEDataSet.Filtered3024009

TBDEDataSet	参照

Filtered プロパティは，データセットでフィルタ処理がアクティブかどうかを指定します。

property Filtered: Boolean;

説明

Filtered プロパティで，データセットフィルタ処理が有効になっているかどうかを判別できます。Filtered が True ならば，フィルタが有効になっています。それ以外の場合 Filtered は False です。Filter プロパティまたは OnFilterRecord イベントハンドラで指定されるフィルタ条件を適用するには，Filtered を True に設定します。

注意

フィルタ処理がアクティブなときにユーザーがレコードを編集すると，そのレコードがフィルタの検査条件に適合しなくなることがあります。次にデータセットからそのレコードを取り出すときにフィルタが有効なままなら，レコードは表示されません。その場合は，フィルタ条件に適合した次のレコードがカレントレコードになります。


TBDEDataSet.FilterOptions
TBDEDataSet.FilterOptions3024010

TBDEDataSet	参照

FilterOptions プロパティは，フィルタ処理で大文字小文字の違いを区別するかどうか，およびレコードをフィルタ処理する際に部分的な比較を行えるようにするかどうかを指定します。

type

TFilterOption = (foCaseInsensitive, foNoPartialCompare);

TFilterOptions = set of TFilterOption;

property FilterOptions: TFilterOptions

説明

FilterOptions プロパティを設定すると，文字列または文字項目をフィルタ処理する際に大文字小文字の違いを区別するかどうか，およびフィルタ条件の照合で部分的な比較を行えるようにするかどうかを指定できます。

デフォルトでは，FilterOptions は空のセットに設定されています。文字列項目に基づくフィルタの場合は，FilterOptions に foCaseInsensitive を設定すれば，大文字小文字に関係なく指定した文字列のすべてのバリエーションを得ることができます。

複数の条件または項目に基づくフィルタ条件の場合には，FilterOptions を foNoPartialCompare に設定すれば正確に一致するものだけを得ることができます。

部分的な一致を許可しない場合は， FilterOptions に foNoPartialCompare を入れます。

注意

部分一致された文字列に基づいてフィルタ処理するには， FilterOptions から foNoPartialCompare を除外し，ワイルドカードとしてアスタリスク（*）を使います。以下に例を示します。

State = 'M*


TBDEDataSet.Handle
TBDEDataSet.Handle3024011

TBDEDataSet	参照

Handle プロパティは，データセットにボーランドデータベースエンジン（BDE）カーソルハンドルを設定します。

type

HDBICur: Longint;

property Handle: HDBICur;

説明

Handle プロパティは TDataSet メソッドをバイパスして BDE を直接呼び出すためだけに使います。BDE 関数呼び出しの多くはカーソルハンドルパラメータを必要とします。Handle はデータセットを開いたときに初期値を割り当てられます。現在のレコード位置を変更する BDE 呼び出しで使うときは，BDE 呼び出しから戻った直後に Resync を呼び出します。

注意

アプリケーションが標準 Delphi コンポーネントで提供されない BDE 機能を必要としない限り，このプロパティは使わないでください。


TBDEDataSet.KeySize
TBDEDataSet.KeySize3024012

TBDEDataSet

KeySize プロパティは，データセットの現在のインデックスのキーサイズを示します。

property KeySize: Word;

説明

KeySize を調べると，現在のインデックスのキーサイズをバイト数で取得できます。KeySize は現在のインデックスを構成する項目の数および型によって異なります。


TBDEDataSet.Locale
TBDEDataSet.Locale3024013

TBDEDataSet	参照

Locale プロパティは，データセットのボーランドデータベースエンジン（BDE）言語ドライバを示します。

type

TLocale: Pointer;

property Locale: TLocale;

説明

Locale プロパティで，データセットで使う BDE 言語ドライバを判別できます。BDE API を直接呼び出すアプリケーションは Locale 情報を関数パラメータとして要求される場合があります。

言語ドライバ情報は，データセットを所有する TDatabase コンポーネントの Params プロパティ内の値としても提供されます。

注意

アプリケーションが標準 Delphi コンポーネントで提供されない BDE 機能を必要としない限り，このプロパティは使わないでください。


TBDEDataSet.RecNo
TBDEDataSet.RecNo3024014

TBDEDataSet	参照

RecNo プロパティは，データセットに入っているカレントレコードを示します。

property RecNo: Longint;

説明

RecNo プロパティは，データセットに入っているカレントレコードのレコード番号を取得できます。通常，レコードの反復処理は First，Last，MoveBy，Next，および Prior を呼び出して実行しますが，アプリケーションがデータセット内のすべてのレコードを繰り返し処理するときには RecordCount とともにこのプロパティを使う場合があります。

注意

Paradox テーブルにアクセスする場合，レコード上にカーソルを位置付けるために RecNo を特定のレコード番号に設定することができます。


TBDEDataSet.RecordCount
TBDEDataSet.RecordCount3024015

TBDEDataSet	参照

RecordCount プロパティは，データセットに関連付けられているレコードの総数を示します。

property RecordCount: Longint;

説明

RecordCount プロパティは，データセット内のレコード総数を取得できます。通常，レコードの反復処理は First，Last，MoveBy，Next，および Prior を呼び出して実行しますが，アプリケーションがデータセット内のすべてのレコードを繰り返し処理するときには RecNo とともにこのプロパティを使う場合があります。

注意

RecordCount は注意して使ってください。レコード数のカウントは，特に結果セットが非常に大きくなる SQL 問い合わせの場合に時間がかかるからです。通常，アプリケーションでは Paradox テーブルと dBASE テーブルで RecordCount のみを使います。


TBDEDataSet.RecordSize
TBDEDataSet.RecordSize3024016

TBDEDataSet	参照

RecordSize プロパティは，データセット内のレコードサイズを示します。

property RecordSize: Word;

説明

RecordSize プロパティは， Delphi がデータセット内のレコードを保持するために割り当てるバッファの物理サイズをバイト単位で取得できます。データセットを開くときに，Open 手続きはボーランドデータベースエンジン（BDE）からレコードバッファサイズ情報を要求し，返された情報を RecordSize に格納します。Delphi はこの情報を内部的に使います。アプリケーションはほとんどこの情報を要求しません。


TBDEDataSet.UpdateObject
TBDEDataSet.UpdateObject3024017

TBDEDataSet	参照

UpdateObject プロパティは，キャッシュアップデートが使用可能なときに読み出し専用の結果セットを更新するのに使う更新オブジェクトコンポーネントを指定します。

type

TDataSetUpdateObject = class(TComponent)

property UpdateObject: TDataSetUpdateObject;

説明

UpdateObject プロパティは，ボーランドデータベースエンジン（BDE）から返された読み出し専用の結果セットを更新するための TUpdateObject コンポーネントを指定します。

BDE は，アプリケーションが特に読み出し専用のデータを要求しない限り，必ず更新可能つまり「ライブ」問い合わせ結果を提供しようとします。しかし，複数のテーブルに対して問い合わせをした場合などには，ライブ結果セットは返されません。こうした場合にアプリケーションに透過な別のトランザクションとして更新を実行する TUpdateSQL コンポーネントを UpdateObject に指定できます。


TBDEDataSet.UpdateRecordTypes
TBDEDataSet.UpdateRecordTypes3024018

TBDEDataSet	参照

UpdateRecordTypes プロパティは，キャッシュアップデートが使用可能なときにデータセット内で可視になるレコード型を指定します。

TUpdateRecordTypes = set of (rtModified, rtInserted, rtDeleted, rtUnmodified);

property UpdateRecordTypes: TUpdateRecordTypes;

説明

UpdateRecordTypesは，キャッシュアップデートが使用可能なときにデータセット内で可視になるレコードを指定できます。UpdateRecordTypes は次の値を指定できます。

値	意味

rtModified	変更されたレコードが表示される

rtInserted	挿入されたレコードが表示される

rtDeleted	削除されたレコードが表示される

rtUnmodified	変更されていないレコードが表示される

デフォルトでは，データセットは [rtModified，rtInserted，rtUnmodified] の UpdateRecordTypes セットで作成されます。つまり編集または挿入されたレコードと既存のレコードはすべて表示されます。

削除されたレコードをアンデリートするアプリケーションでは，UpdateRecordTypes を変更して，削除したレコードを「可視」にして，アンデリート処理を行うこともできます。

また，アプリケーションは UpdateRecordTypes をフィルタのように使って，一時的に可視レコードを，カレントセッションの実行中に追加または挿入されたレコードだけに制限する場合もあります。


TBDEDataSet.UpdatesPending
TBDEDataSet.UpdatesPending3024019

TBDEDataSet	参照

UpdatesPending プロパティは，キャッシュアップデートバッファに未適用のレコードが入っているかどうかを示します。

property UpdatesPending: Boolean;

説明

UpdatesPendingは，キャッシュアップデートバッファのステータスを確認できます。UpdatesPending が True の場合，編集，削除，または挿入したレコードとしてデータベースに適用するレコードがあります。UpdatesPending が False の場合，キャッシュにレコードはありません。


TBDEDataSet イベント3024020

TBDEDataSet	アルファベット順	凡例

TBDEDataSet

OnServerYield

OnUpdateError

OnUpdateRecord

TDataSet からの継承

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TBDEDataSet イベント3024021

TBDEDataSet	オブジェクト順	凡例

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError

OnServerYield

OnUpdateError

OnUpdateRecord


TBDEDataSet.OnServerYield
TBDEDataSet.OnServerYield3024022

TBDEDataSet	参照

OnServerYield イベントはリモートデータベースサーバー上で問い合わせの処理中に，そのサーバーがボーランドデータベースエンジン（BDE）に優先権コールバックを送ると発生します。

type

TOnServerYieldEvent = procedure(DataSet: TDataSet; var AbortQuery: Boolean) of object;

property OnServerYield: TOnServerYieldEvent;

説明

OnServerYield イベントハンドラを記述すると，データベースサーバーが問い合わせの操作中に一時的な制御を BDE に渡したときに生成される BDE コールバックに応答することができます。BDE は制御を受け取ると OnServerYield を呼び出します（ハンドラが存在する場合）。

問い合わせ処理を継続するには，OnServerYield は AbortQuery パラメータを False に設定する必要があります。問い合わせ処理を終了する場合には AbortQuery を True に設定します。

注意

現在，Sybase だけが問い合わせの処理中に制御を渡します。


TBDEDataSet.OnUpdateError
TBDEDataSet.OnUpdateError3024023

TBDEDataSet	参照

OnUpdateError イベントはキャッシュアップデートをデータベースに適用するときに例外が生成されると発生します。

type

TUpdateKind = (ukModify, ukInsert, ukDelete);

TUpdateAction = (uaFail, uaAbort, uaSkip, uaRetry, uaApplied);

TUpdateErrorEvent = procedure(DataSet: TDataSet; E: EDatabaseError;

UpdateKind: TUpdateKind; var UpdateAction: TUpdateAction) of object;

property OnUpdateError: TUpdateErrorEvent;

説明

OnUpdateError イベントハンドラを記述すると，キャッシュアップデートがデータベースに適用されたときに生成される例外に応答することができます。

レコードがキャッシュされてから更新が適用されるまでにはタイムラグがあるので，キャッシュされた変更が適用される前に別のアプリケーションがデータセット内の同一レコードを変更する可能性があります。ボーランドデータベースエンジン（BDE）はこの状態をチェックして例外を生成します。 Delphi は（記述してあれば）OnUpdateError イベントハンドラを呼び出して対応します。

DataSet は更新の適用先となるデータセットです。

E は，アプリケーションがエラーメッセージおよび実際のエラー状態の原因を取り出すEDBEngineError オブジェクトです。OnUpdateError ハンドラはエラー状態に対応するためにこの情報を使います。

UpdateKind はエラーを起こした更新の適用を表します。以下に UpdateKind の設定値とその意味を示します。

値	意味

ukModify	既存のレコードの編集がエラーの原因

ukInsert	新規のレコードの挿入または追加がエラーの原因

ukDelete	既存のレコードの削除がエラーの原因

UpdateAction は OnUpdateError ハンドラが終了した後に実行されるアクションを示します。ハンドラが呼び出されたとき，UpdateAction は必ず uaFail に設定されています。OnUpdateError はエラーハンドラが終了する前にエラーを処理または修正した場合には，UpdateAction を uaRetry に設定します。以下に UpdateAction の設定値とその意味を示します。

値	意味

uaAbort	更新処理を中止するが，エラーメッセージは表示しない

uaApplied	エラー処理ルーチンでは使われない

uaFail	更新処理を中止し，エラーメッセージを表示する

uaRetry	エラー状態を起こした更新処理を再度試みる

uaSkip	エラー状態を生成したレコード更新をスキップして，キャッシュにある未適用の変更をそのままにする

エラーハンドラは，エラー状態を評価するために TField.OldValue プロパティと TField.NewValue プロパティを使い，TField.NewValue を再適用する新しい値に設定することができます。その場合，終了前に UpdateAction を uaRetry に設定します。

注意

ApplyUpdates の呼び出しが例外を生成し，ApplyUpdates が try...except ブロック内で呼び出されていない場合，エラーメッセージが表示されます。OnUpdateError ハンドラがエラー状態を修正できないで UpdateAction が uaFail に設定されている場合には，エラーメッセージが 2 回表示されます。エラーメッセージが再表示されないようにするには，エラーハンドラ内で UpdateAction を uaAbort に設定してください。

重要

OnUpdateError ハンドラ内のコードでは，カレントレコードを変更するメソッドを呼び出してはいけません。


TBDEDataSet.OnUpdateRecord
TBDEDataSet.OnUpdateRecord3024024

TBDEDataSet	参照

OnUpdateRecord イベントは，キャッシュアップデートがレコードに適用されたときに発生します。

type

TUpdateKind = (ukModify, ukInsert, ukDelete);

TUpdateAction = (uaFail, uaAbort, uaSkip, uaRetry, uaApplied);

TUpdateRecordEvent = procedure(DataSet: TDataSet; UpdateKind: TUpdateKind;

var UpdateAction: TUpdateAction) of object;

property OnUpdateRecord: TUpdateRecordEvent;

説明

OnUpdateRecord イベントハンドラを記述すると，連続的な更新，挿入，または削除の実現など，単一の更新コンポーネントでは処理できない更新を実行することができます。このハンドラは更新コンポーネントのパラメータの代入に対する追加の制御を必要とするアプリケーションでも役立ちます。

DataSet は更新の適用先となるデータセットの名前です。

UpdateKind は実行する更新型を説明します。以下に UpdateKind の設定値とその意味を示します。

値	意味

ukModify	既存のレコードを編集する

ukInsert	新規のレコードを挿入または追加する

ukDelete	既存のレコードを削除する

UpdateAction は OnUpdateRecord ハンドラが終了後に実行されるアクションを示します。ハンドラが呼び出されたとき，UpdateAction は必ず uaFail に設定されています。OnUpdateRecord が成功すれば，終了する前に UpdateAction を uaApplied に設定してください。以下に UpdateAction の設定値とその意味を示します。

値	意味

uaAbort	更新処理を中止するが，エラーメッセージは表示しない

uaApplied	更新が適用された。キャッシュから更新レコードを開放する

uaFail	更新処理を中止し，エラーメッセージを表示する

uaRetry	レコード更新には使われない

uaSkip	更新をスキップする。キャッシュにある更新レコードは未適用

注意

OnUpdateRecord ハンドラ内のコードでは，カレントレコードを変更するメソッドを呼び出してはいけません。


TBDEDataSet メソッド3024025

TBDEDataSet	アルファベット順

TBDEDataSet

ApplyUpdates

BookmarkValid

Cancel

CancelUpdates

CommitUpdates

CompareBookmarks

Create

Destroy

DisableConstraints

EnableConstraints

FetchAll

FlushBuffers

GetCurrentRecord

GetIndexInfo

IsSequenced

Locate

Lookup

RevertRecord

UpdateStatus

TDataSet からの継承

ActiveBuffer

Append

AppendRecord

CheckBrowseMode

ClearFields

Close

ControlsDisabled

CursorPosChanged

Delete

DisableControls

Edit

EnableControls

FieldByName

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FreeBookmark

GetBookmark

GetFieldList

GetFieldNames

GotoBookmark

Insert

InsertRecord

IsEmpty

IsLinkedTo

Last

MoveBy

Next

Open

Post

Prior

Refresh

Resync

SetFields

Translate

UpdateCursorPos

UpdateRecord

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TBDEDataSet メソッド3024026

TBDEDataSet	オブジェクト順

ActiveBuffer

Append

AppendRecord

ApplyUpdates

Assign

BookmarkValid

Cancel

CancelUpdates

CheckBrowseMode

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearFields

Close

CommitUpdates

CompareBookmarks

ControlsDisabled

Create

CursorPosChanged

DefaultHandler

Delete

Destroy

DestroyComponents

Destroying

DisableConstraints

DisableControls

Dispatch

Edit

EnableConstraints

EnableControls

FetchAll

FieldAddress

FieldByName

FindComponent

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FlushBuffers

Free

FreeBookmark

FreeInstance

FreeNotification

FreeOnRelease

GetBookmark

GetCurrentRecord

GetFieldList

GetFieldNames

GetIndexInfo

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GotoBookmark

HasParent

InheritsFrom

InitInstance

Insert

InsertComponent

InsertRecord

InstanceSize

IsEmpty

IsLinkedTo

IsSequenced

Last

Locate

Lookup

MethodAddress

MethodName

MoveBy

NewInstance

Next

Open

Post

Prior

Refresh

RemoveComponent

Resync

RevertRecord

SafeCallException

SetFields

Translate

UpdateCursorPos

UpdateRecord

UpdateStatus


TBDEDataSet.ApplyUpdates
TBDEDataSet.ApplyUpdates3024027

TBDEDataSet	参照

ApplyUpdates メソッドは，データセットの未処理のキャッシュアップデートをデータベースに書き込みます。

procedure ApplyUpdates;

説明

ApplyUpdates を呼び出すと，データセットの未処理のキャッシュアップデートをデータベースに書き込むことができます。このメソッドは更新のためにキャッシュしたデータをデータベースに渡しますが，変更はデータベースにコミットしません。アプリケーションは，書き込みが成功した場合は変更をコミットするために明示的にデータベースコンポーネントの Commit メソッドを呼び出し，エラーが起こった場合は変更を元に戻すためにデータベースの Rollback メソッドを呼び出さなくてはなりません。

データベースへの書き込みが成功し，データベースの Commit メソッドの呼び出しが成功した後で，アプリケーションはキャッシュアップデートバッファをクリアするために CommitUpdates メソッドを呼び出す必要があります。

注意

データセットを更新する方法としては，個々のデータセットの ApplyUpdates メソッドを呼び出すよりは，データベースコンポーネントの ApplyUpdates メソッドを呼び出すことをお勧めします。データベースコンポーネントの ApplyUpdates メソッドはトランザクションのコミットおよびロールバックを処理するとともに，操作が成功したときにキャッシュをクリアします。

例

次の手続きは，ボタンクリックに応答してデータセットのキャッシュアップデートをデータベースに適用する方法を示します。

procedure ApplyButtonClick(Sender: TObject);

begin

  with CustomerQuery do

  begin

    Database1.StartTransaction;

    try

      ApplyUpdates; {更新をデータベースに書き込もうとします};

      Database1.Commit; {成功すると変更をコミットします};

    except

      Database1.Rollback; {エラーが起こったら変更を元に戻します};

      raise; {CommitUpdates を呼び出さないように例外を生成します}

    end;

    CommitUpdates; {成功するとキャッシュをクリアします}

  end;

end;


TBDEDataSet.BookmarkValid
TBDEDataSet.BookmarkValid3024028

TBDEDataSet	参照

BookmarkValid メソッドは，指定されたブックマークの有効性をテストします。

type

TBookmark = Pointer;

function BookmarkValid(Bookmark: TBookmark): Boolean; override;

説明

BookmarkValid を呼び出すと，指定されたブックマークに値が割り当てられているかどうかを判別できます。Bookmark はテストの対象となるブックマークを指定します。

BookmarkValid はブックマークが有効な場合に True を返します。それ以外の場合には False を返します。


TBDEDataSet.Cancel
TBDEDataSet.Cancel3024029

TBDEDataSet	参照

Cancel メソッドは，カレントレコードに対する変更がまだ登録されていない場合，その変更を取り消します。

procedure Cancel;

説明

Cancel を呼び出すと，カレントレコードに属する 1 つまたは複数の項目に対して加えられた変更を取り消すことができます。変更がデータベースに登録されていなければ，Cancel はそのレコードを以前の状態に戻し，データセットの状態を dsBrowse に設定します。

一般に Cancel は，ユーザーの要求に応答して変更を取り消したり，不正な項目値を取り消す項目検証ルーチンで変更を取り消したりするときに使います。TDBNavigator オブジェクトには，Cancel メソッドの呼び出しを発生させる Cancel ボタンがあります。


TBDEDataSet.CancelUpdates
TBDEDataSet.CancelUpdates3024030

TBDEDataSet	参照

CancelUpdates メソッドは，未処理のキャッシュアップデートをすべてキャッシュから削除してデータセットを元の状態に復元します。

procedure CancelUpdates;

説明

CancelUpdates を呼び出すと未処理のキャッシュアップデートをすべてキャッシュから削除して，データセットを元の状態（テーブルを開いたときの状態，キャッシュアップデートが最後に使用可能になったときの状態，またはキャッシュアップデートが最後にデータベースに適用されたときの状態）に復元できます。

データセットを閉じるか，CachedUpdates プロパティを False に設定すると，CancelUpdates は自動的に呼び出されます。

注意

単一のレコードに対する変更を元に戻すには RevertRecord を呼び出します。


TBDEDataSet.CommitUpdates
TBDEDataSet.CommitUpdates3024031

TBDEDataSet	参照

CommitUpdates メソッドは，キャッシュアップデートバッファをクリアします。

procedure CommitUpdates;

説明

CommitUpdates を呼び出すと，ApplyUpdates の呼び出しおよびデータベースコンポーネントの Commit メソッドの呼び出しが成功した後に，キャッシュアップデートバッファをクリアできます。更新を適用した後にキャッシュをクリアすると，キャッシュには OnUpdateRecord イベントハンドラまたは OnUpdateError イベントハンドラで処理できなかったレコードおよびスキップされたレコードだけが残ります。

CommitUpdates を呼び出した後でレコードを変更すると，キャッシュアップデートバッファが埋まるので，再び ApplyUpdates を呼び出してデータベースにその変更を移動する必要があります。

注意

データベースコンポーネントの ApplyUpdates メソッドを使って，データベースコンポーネントに関連付けられたすべてのデータセットの未処理の更新を適用およびコミットするアプリケーションでは，CommitUpdates を呼び出す必要はありません。

例

次の手続きは，ボタンクリックに応答してデータセットのキャッシュアップデートをデータベースに適用し，キャッシュアップデートバッファをクリアする方法を示します。

procedure ApplyButtonClick(Sender: TObject);

begin

  with CustomerQuery do

  begin

    Database1.StartTransaction;

    try

      ApplyUpdates; {データベースに更新を書き込もうとします};

      Database1.Commit; {成功すると変更をコミットします};

    except

      Database1.Rollback; {エラーが起こったら変更を元に戻します};

      raise; {CommitUpdates を呼び出さないように例外を生成します}

    end;

    CommitUpdates; {成功するとキャッシュをクリアします}

  end;

end;


TBDEDataSet.CompareBookmarks
TBDEDataSet.CompareBookmarks3024032

TBDEDataSet	参照

CompareBookmarks メソッドは，2 つのブックマークを比較します。

type

TBookmark = Pointer;

function CompareBookmarks(Bookmark1, Bookmark2: TBookmark): Integer;

説明

CompareBookmarks を呼び出すと 2 つのブックマークが同じかどうかを判別できます。Bookmark1 と Bookmark2 は比較対象となるブックマークです。

ブックマークが異なっていれば，CompareBookmarks は 1 を返します。ブックマークが同じであるかどちらのブックマークも nil であれば，CompareBookmarks は 0 を返します。


TBDEDataSet.Create
TBDEDataSet.Create3024035

TBDEDataSet	参照

Create メソッドは，TBDEDataSet コンポーネントのインスタンスを生成します。

constructor Create(AOwner: TComponent); override

説明

Create を呼び出すと，実行時にデータセットコンポーネントをインスタンス化できます。通常，アプリケーションは TTable，TQuery，TStoredProc などの TBDEDataSet から派生したオブジェクトをインスタンス化します。これらのインスタンス化されたオブジェクトは Delphi によって自動的に処理されます。

データベースアプリケーションが実行時に TBDEDataSet のインスタンスを作成しなければならない場合もあります。Create は以下の処理を実行します。

・	継承された Create メソッドを呼び出す

・	データセットの Locale プロパティをデフォルトセッションのロケールに設定する

・	CacheBlobs プロパティを True に設定する


TBDEDataSet.Destroy
TBDEDataSet.Destroy3024037

TBDEDataSet	参照

Destroy メソッドは，データセットコンポーネントのインスタンスを破棄します。

destructor Destroy;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さないでください。通常，データセットの破棄は Delphi によって自動的に処理されます。ただし，アプリケーション自身がデータセットのインスタンスを作成した場合は，Free メソッドを呼び出す必要があります。Free メソッドはデータセットコンポーネントが解放されていないことを確認してから Destroy メソッド を呼び出します。

Destroy は継承された Destroy デストラクタを呼び出し，必要なら，BDE 非同期コールバックに割り当てられていたリソースを解放して，そのデータセットの UpdateObject プロパティを nil に設定します。


TBDEDataSet.DisableConstraints
TBDEDataSet.DisableConstraints3024038

TBDEDataSet	参照

DisableConstraints メソッドは，データセットでのサーバーの制約条件を適用できないようにします。

procedure DisableConstraints;

説明

DisableConstraints を呼び出すと，一時的にサーバーの制約条件をデータセットに適用することを防げます。たとえば，アプリケーションがデータセットを反復処理するときに，一時的に制約条件を使用不可にすると性能が向上します。

注意

DisableConstraints を呼び出すと参照カウントがインクリメントされます。参照カウントが 0 より大きい場合に限り，データセットに対して制約条件は使用不可になります。意図しないで制約条件を使用不可にしないために，DisableConstraints への呼び出しと EnableConstraints への呼び出しを必ず組にしておきます。


TBDEDataSet.EnableConstraints
TBDEDataSet.EnableConstraints3024039

TBDEDataSet	参照

EnableConstraints メソッドは，データセットのエントリに対するサーバーの制約条件の適用を使用可能にします。

procedure EnableConstraints;

説明

EnableConstraints を呼び出すと，DisableConstraints への呼び出しによって使用不可になっていたサーバーの制約条件の適用を使用可能にします。

注意

EnableConstraints を呼び出すと参照カウントがデクリメントされます。参照カウントが 0 の場合，そのデータセットに対する制約条件は使用可能です。意図しないで制約条件を使用不可にしないために，DisableConstraints への呼び出しと EnableConstraints への呼び出しを必ず組にしておきます。


TBDEDataSet.FetchAll
TBDEDataSet.FetchAll3024040

TBDEDataSet	参照

FetchAll メソッドは，現在のカーソル位置からデータベースの最後までのすべてのレコードを取り出して，ローカルに格納します。

procedure FetchAll;

説明

FetchAll を呼び出すと，キャッシュアップデートを使うときのネットワークトラフィックを減らすことができます。FetchAll は CheckBrowseMode を呼び出して未処理の変更をすべて登録してから，現在のカーソル位置からデータベースの最後までのすべてのレコードを取り出して，ローカルに格納します。

通常，キャッシュアップデートが使用可能なとき，トランザクションは表示のために必要なだけしかデータを取り出しません。フェッチ処理は実行するたびに，新しい読み出し専用トランザクションを作成します。ネットワークトラフィックを減らすためには，FetchAll を呼び出して 1 つのトランザクションですべてのデータを取り出すと効果的です。

注意

FetchAll を使うことが常に適当であるとは限りません。たとえばアプリケーションが，同時に多数のクライアントによって使われているデータベースにアクセスし，同一のレコードに対する更新の競合が頻繁に起こる場合，一度にすべてのレコードを取り出すことは必ずしも有効ではありません。取り出したレコードの一部がほかのアプリケーションによって変更されている可能性があるからです。ネットワークトラフィックを減らす利点とレコード競合を減らす必要性を常に比較検討してください。


TBDEDataSet.FlushBuffers
TBDEDataSet.FlushBuffers3024041

TBDEDataSet

FlushBuffers メソッドは，レコードバッファに書き込まれた内容をすべて送信します。

procedure FlushBuffers;

説明

FlushBuffers メソッドを呼び出すと，データセットは変更内容をすべてデータベースに送信できます（キャッシュアップデートを含む）。キャッシュレコードバッファを送信したい場合は，CheckBrowseMode の代わりに FlushBuffers を使ってください。


TBDEDataSet.GetCurrentRecord
TBDEDataSet.GetCurrentRecord3024042

TBDEDataSet	参照

GetCurrentRecord メソッドは，カレントレコードをバッファに取り出します。

function GetCurrentRecord(Buffer: PChar): Boolean;

説明

ほとんどのアプリケーションでは GetCurrentRecord を呼び出す必要はありません。TDataSet はアクティブレコードに自動的にバッファを割り当てます。

GetCurrentRecord を呼び出すと，カレントレコードをアプリケーションによって割り当てられたバッファにコピーできます。バッファは最低でも RecordSize プロパティで示されるレコードサイズと同じでなければなりません。


TBDEDataSet.GetIndexInfo
TBDEDataSet.GetIndexInfo3024043

TBDEDataSet	参照

GetIndexInfo メソッドは，カレントインデックスについての情報をデータセットのインデックスデータ項目に取り出します。

procedure GetIndexInfo;

説明

GetIndexInfo を呼び出すと，カレントインデックスについての情報を更新できます。このルーチンは必要に応じてインデックス情報を取り出すために内部的に使われるので，通常，アプリケーションでは GetIndexInfo を呼び出す必要はありません。ただしアプリケーションによっては，データセットで使われているインデックス情報が最新のものであることを保証するために呼び出すことがあります。

GetIndexInfo は次のインデックス情報について BDE に問い合わせます。

・	カレントインデックスが dBASE の式のインデックスであるかどうか

・	インデックスが大文字小文字の違いを区別するかどうか

・	インデックスのキーを構成する項目の数

・	インデックスの項目マップ

・	インデックスキーのサイズ

インデックスが dBASE の式のインデックスの場合には，項目数および項目マップは取り出されません。


TBDEDataSet.IsSequenced
TBDEDataSet.IsSequenced3024044

TBDEDataSet

IsSequenced メソッドは，シーケンス番号がデータベースレコードにとって重要かどうかを示します。

function IsSequenced: Boolean override;

説明

IsSequenced メソッドを呼び出すと，データベースレコードがシーケンス番号順に配置されているかどうかを識別できます。IsSequenced が True の場合，RecNo プロパティを設定することにより，データセットはある特定のレコードに直接移動できます。IsSequenced が False の場合，ある特定のレコードに移動するには，レコード数をカウントするしかありません。


TBDEDataSet.Locate
TBDEDataSet.Locate3024045

TBDEDataSet	参照

Locate メソッドは，データセットから特定のレコードを検索し，そのレコードをカレントレコードにします。

type

TLocateOption = (loCaseInsensitive, loPartialKey);

TLocateOptions = set of TLocateOption;

function Locate(const KeyFields: string; const KeyValues: Variant; Options: TLocateOptions): Boolean;

説明

Locate を呼び出すと，データセットから特定のレコードを検索し，そのレコードにカーソルを移動できます。KeyFields は，検索の条件となる項目名をセミコロンで区切ったリスト形式の文字列です。

KeyValues はキー設定項目で一致する値を格納するバリアント配列です。複数の検索値を指定するには，引数にバリアント配列を渡すか，VarArrayOf ルーチンを使ってバリアント配列を構築します。以下に例を示します。

with CustTable do

  Locate('Company;Contact;Phone', VarArrayOf(['Sight Diver', ' P']), [loPartialKey]);

Options は文字列項目を検索するときにオプションであいまい検索を指定するセットです。Options に loCaseInsensitive 設定があると，Locate は項目を照合するときに大文字と小文字の区別をしません。Options に loPartialKey 設定があると，Locate はレコード照合で少なくとも KeyValues 条件の始めの一部を満たす最初のレコードを検索します。Options に空のセットを指定するか，KeyFields が文字列項目でない場合は，Options は無視されます。

Locate は一致するレコードを見つけると True を返し，それをカレントレコードにします。それ以外の場合，Locate は False を返します。

Locate は最も早い方法を使って一致するレコードを見つけます。KeyFields の検索項目がインデックス付けされており，そのインデックスが指定された検索オプションと互換性がある場合，Locate はそのインデックスを使います。それ以外の場合，Locate は検索のためにフィルタを作成します。


TBDEDataSet.Lookup
TBDEDataSet.Lookup3024046

TBDEDataSet	参照

Lookup メソッドは，指定された検索値に一致するレコードから項目値を取り出します。

function Lookup(const KeyFields: string; const KeyValues: Variant;

const ResultFields: string): Variant;

説明

Lookup を呼び出すと，検索条件に一致するレコードから指定された項目の値を取り出すことができます。KeyFields は，検索条件となる項目名をセミコロンで区切ったリスト形式の文字列です。

KeyValues はキー設定項目で一致する値を格納するバリアント配列です。複数の検索値を指定するには，引数にバリアント配列を渡すか，VarArrayOf ルーチンを使ってバリアント配列を構築します。

ResultFields は，一致するレコードから値を読み出す項目名をセミコロンで区切ったリスト形式の文字列です。

Lookup は ResultFields で指定された項目の値を格納するバリアント配列を返します。

Lookup メソッドは最も早い方法を使って一致するレコードを見つけます。KeyFields の検索項目がインデックス付けされている場合，Lookup はそのインデックスを使います。それ以外の場合，Lookup は検索のためフィルタを作成します。


TBDEDataSet.RevertRecord
TBDEDataSet.RevertRecord3024047

TBDEDataSet	参照

RevertRecord メソッドは，キャッシュアップデートが使用可能な場合にデータセット内のカレントレコードを変更前の状態に復元します。

procedure RevertRecord;

説明

RevertRecord を呼び出すと，キャッシュアップデートが使用可能なときにカレントレコードに対して行った変更を元に戻すことができます。短いコードを記述するだけで，RevertRecord は以下の手続きが示すように，キャッシュアップデートが使用可能なときにレコードの削除を取り消すのに使えます。

procedure UndeleteAll(DataSet: TDataSet);

begin

  with DataSet do

  begin

    UpdateRecordTypes := [rtDeleted]; {削除されたレコードだけを表示します}

    try

      First; {データセットの先頭に移動します}

      while not EOF do

      begin

        RevertRecord; {カレントレコードの削除を取り消します}

        Next; {次のレコードに移動します}

      end;

    finally

      UpdateRecordTypes := [rtModified, rtInserted, rtUnmodified];

    end;

  end;

end;

注意

キャッシュ内の未処理の更新に対するすべての変更を元に戻すには，CancelUpdates を呼び出します。


TBDEDataSet.UpdateStatus
TBDEDataSet.UpdateStatus3024048

TBDEDataSet	参照

UpdateStatus メソッドは，データセットの現在のアップデートステータスを報告します。

type

TUpdateStatus = (usUnmodified, usModified, usInserted, usDeleted);

function UpdateStatus: TUpdateStatus;

説明

UpdateStatus を呼び出すと，キャッシュアップデートが使用可能なときにデータセットの現在のアップデートステータスを特定できます。アップデートステータスはレコードの編集，挿入，または削除に伴って頻繁に変わります。UpdateStatus は，データセットのアップデートステータスに基づく操作を開始または完了する前に現在のステータスにアクセスする方法をアプリケーションに提供します。


スコープ3024049

published

読み出し／書き込み

読み出し専用


スコープ3024050

published


継承3024051

TObject

TPersistent

TComponent

TDataSet


TBDEDataSet 例3024052

TBDEDataSet


TBevel
TBevel3025001

継承	プロパティ	メソッド	参照	例

TBevel コンポーネントは，ベベルのアウトラインの種類を表します。

ユニット

extctrls

説明

TBevel を使うと，ベベルボックス，ベベル枠，またはベベル線を作成できます。ベベルはもり上がっているように見えたり，へこんでいるように見えたりします。ベベルがボックス，枠，線のいずれになるかは Shape プロパティの値によって決まります。


TBevel プロパティ3025002

TBevel	アルファベット順	凡例

TBevel

Shape

Style

TControl からの継承

Align

BoundsRect

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ParentShowHint

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TBevel プロパティ3025003

TBevel	オブジェクト順	凡例

Align

BoundsRect

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Height

Hint

Left

Name

Owner

Parent

ParentShowHint

Shape

ShowHint

Style

Tag

Top

VCLComObject

Visible

Width

WindowProc


TBevel.Shape
TBevel.Shape3025004

TBevel	参照

Shape プロパティは，ベベルの形状を決めます。

TBevelShape = (bsBox, bsFrame, bsTopLine, bsBottomLine, bsLeftLine, bsRightLine);

property Shape: TBevelShape;

説明

Shape を設定するとベベルの外観が線，ボックス，または枠のいずれになるかを指定できます。以下に Shape プロパティの値を示します。

値	意味

bsBox	ベベルはボックスになる

bsFrame	ベベルは枠になる

bsTopLine	ベベルはベベルコントロール上部の線になる

bsBottomLine	ベベルはベベルコントロール下部の線になる

bsLeftLine	ベベルはベベルコントロール左側の線になる

bsRightLine	ベベルはベベルコントロール右側の線になる


TBevel.Style
TBevel.Style3025005

TBevel	参照

Style プロパティは，ベベルを上にもり上げるか下にへこませるかを決めます。

TBevelStyle = (bsLowered, bsRaised);

property Style: TBevelStyle;

説明

Style プロパティを設定すると，ベベルがもり上がったように見せるかへこんだように見せるかを指定できます。Shape プロパティが bsBox の場合，クライアント領域全体がもり上がったように見えたりへこんだように見えたりします。Shape の値がこれ以外の場合，ベベルはクライアント領域の端に沿ってもり上がった線のように見えたり，へこんだ線に見えたりします。以下に Style プロパティの指定値を示します。

値	意味

bsLowered	ベベルをへこませる

bsRaised	ベベルをもり上げる


TBevel メソッド3025006

TBevel	アルファベット順

TBevel

Create

TGraphicControl からの継承

Destroy

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Invalidate

Perform

Refresh

Repaint

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TBevel メソッド3025007

TBevel	オブジェクト順

Assign

BeginDrag

BringToFront

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DragDrop

Dragging

EndDrag

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTextBuf

GetTextLen

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Perform

Refresh

RemoveComponent

Repaint

SafeCallException

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update


TBevel.Create
TBevel.Create3025008

TBevel	参照

Create メソッドは，TBevel オブジェクトを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと実行時にベベルをインスタンス化できます。設計時にフォームに配置されたベベルは自動的に作成されます。継承されたコンストラクタの呼び出し後，Create は Style を bsLowered に，Shape プロパティを bsBox にそれぞれ初期化します。


スコープ3025009

published

読み出し／書き込み

読み出し専用


継承3025010

TObject

TPersistent

TComponent

TControl

TGraphicControl


TBevel 例3025011

TBevel


TBinaryField
TBinaryField3026001

継承	プロパティ	メソッド	イベント	参照

TBinaryField オブジェクトはデータセット内の型なしバイナリ項目を表します。

ユニット

db

説明

TBinaryField オブジェクトは型なしバイナリ項目に共通する動作をカプセル化する抽象オブジェクトです。TField クラスで導かれるすべての項目に共通するプロパティ，メソッド，およびイベントのほかに，TBinaryField オブジェクトはデータベーステーブルとバイナリデータを読み書きするために必要なプロパティを再実装します。

TBinaryField オブジェクトのインスタンスを作らないでください。TBinaryField の派生オブジェクトはデータセットがアクティブ化されるときに自動的に作成されます。


TBinaryField プロパティ3026002

TBinaryField	アルファベット順	凡例

TBinaryField

AsVariant

Value

TField からの継承

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TBinaryField プロパティ3026003

TBinaryField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


AsString

AsString プロパティは，バイナリ項目の値を文字列として表します。

property AsString: string;

説明

AsString プロパティは，項目の値を文字列として取得および設定できます。Delphi の文字列は必ずしもテキストとは限らないので，AsString で表される値は，項目の形式設定されていないバイナリ値と同じになります。項目の DataSize より長い値を AsString に設定すると，DataSize バイトのデータだけが格納され，DataSize を超えるデータは切り詰められます。

注意

バイナリ項目の Text プロパティは，AsString の値ではなく項目名が設定されます。


TBinaryField.AsVariant
TBinaryField.AsVariant3026005

TBinaryField	参照

AsVariant プロパティは，バイナリ型項目の値と Byte 値のバリアント配列との変換をします。

property AsVariant: Variant;

説明

AsVariant プロパティは，項目の値をバイト値のバリアント配列として取得および設定できます。次のコードはバイト値のバリアント配列をバイナリ型項目に代入します。

var

  V: Variant;

begin

  V := VarArrayCreate([0, BinaryField.DataSize - 1], VarByte);

  V[i] := 1;

  ...

  BinaryField.AsVariant := V;

end;

バイナリ型項目の値をバリアント変数に代入するには，次のようなコードを使います。

VariantVariable:= MyBinaryField.AsVariant;

バイナリ型項目は形式のないバイト配列としてデータベーステーブルに格納されているので，バイナリ型項目の AsVariant プロパティは Value プロパティと同じになります。


TBinaryField.Value
TBinaryField.Value3026006

TBinaryField	参照

Value プロパティは，バイナリ型項目の実際のデータです。

property Value: variant;

説明

Value プロパティは，実行時にバイナリ型項目コンポーネントにデータを取得および設定できます。バイナリ型項目では，Value プロパティは AsVariant プロパティと同じです。


TBinaryField イベント3026007

TBinaryField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TBinaryField イベント3026008

TBinaryField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TBinaryField メソッド3026009

TBinaryField	アルファベット順

TBinaryField

Create

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TBinaryField メソッド3026010

TBinaryField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TBinaryField.Create
TBinaryField.Create3026011

TBinaryField	参照

Create メソッドは，バイナリ型項目コンポーネントのコンストラクタです。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは TBinaryField オブジェクトのインスタンスを作成および初期化します。Create メソッドは TField オブジェクトの継承された Create メソッドを呼び出します。


スコープ3026012

published

読み出し／書き込み

読み出し専用


スコープ3026013

published


継承3026014

TObject

TPersistent

TComponent

TField


TBinaryField 例3026015

TBinaryField


TBitBtn
TBitBtn3027001

継承	プロパティ	メソッド	イベント	参照

TBitBtn コンポーネントは，表面にビットマップを配置できる押しボタンコントロールです。

ユニット

buttons

説明

ビットマップボタンは，ボタンコントロールの一般的な機能を備えています。ビットマップボタンをフォームおよびダイアログボックスに配置してアクションを発生できます。

ビットマップボタンには，ビットマップイメージおよびボタン上のイメージの外観と配置を指定する追加のプロパティがあります。ボタンは定義済みのビットマップボタンのスタイルから選択することも，独自のビットマップを指定することもできます。ボタンに関連付けるビットマップは 1 つだけですが，そのビットマップ（Glyph プロパティ）は 4 つの部分に等分できます。各部分はボタンの状態（上がっている，下がっている，および使用不可）に応じて表示されます（スピードボタンは 4 番目の「下がったまま」と呼ばれる状態で Glyph の 4 つ目の部分を利用できます）。

TBitBtn の Kind プロパティを使うと，通常の動作（OK，Cancel，Help など）を備えたボタンを簡単に作成できます。こうした定義済みのボタン型は適切なグラフィックイメージやデフォルトの動作を備えているので，コーディングなしで必要とするボタンを簡単にアプリケーションに追加できます。


TBitBtn プロパティ3027002

TBitBtn	アルファベット順	凡例

TBitBtn

Glyph

Kind

Layout

Margin

NumGlyphs

Spacing

Style

TButton からの継承

Cancel

Default

ModalResult

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TBitBtn プロパティ3027003

TBitBtn	オブジェクト順	凡例

Align

BoundsRect

Brush

Cancel

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

Default

DesignInfo

DragCursor

DragMode

Enabled

Font

Glyph

Handle

Height

HelpContext

Hint

Kind

Layout

Left

Margin

ModalResult

Name

NumGlyphs

Owner

Parent

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

Spacing

Style

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TBitBtn.Glyph
TBitBtn.Glyph3027004

TBitBtn	参照

Glyph プロパティは，選択したビットマップボタンに表示するビットマップを指定します。

property Glyph: TBitmap;

説明

ボタンで使うビットマップファイル（拡張子が .BMP のファイル）を選択するにはオブジェクトインスペクタで［ファイルを開く］ダイアログボックスから選択するか，実行時にビットマップファイルを指定します。

1 つのビットマップでビットマップボタンまたはスピードボタンに指定できるイメージは 4 つまでです。Delphi は指定したイメージのいずれか 1 つをボタンの状態に従って表示します。

ビットマップ内の

イメージの位置	ボタンの状態	説明

1 番目	上がっている	ボタンを選択していないとき（通常の状態のとき）のイメージ。このイメージは，ボタンにフォーカスがある場合（ボタンを選択したときなど）にも使われる。この場合はフォーカスの長方形がボタンの周囲に描画される。ビットマップに他のイメージがない場合は，どの状態でもこのイメージが使われる

2 番目	使用不可	ボタンが選択できないことを示すイメージ。淡色表示される

3 番目	下がっている	ボタンをクリックしたときのイメージ。マウスボタンから指を離すと上がった状態のイメージに戻る

4 番目	下がったまま	ボタンを押し下げたままのときのイメージ。選択されたままであることを示す（スピードボタンだけに適用）

イメージが 1 つだけの場合は，下がったままの状態も上がっている状態と同じイメージになりますが，Delphi はイメージをやや異なる状態に変えて，他の状態になったことを表そうとします。

ビットマップに複数のイメージがある場合，NumGlyphs プロパティを使ってビットマップ内のイメージの数を指定しなくてはなりません。イメージはどれも同じサイズで，横に一列に並んでいなくてはなりません。

注意

ビットマップの左下のピクセルは「透過色」として予約されます。左下のピクセルと一致する色のビットマップのピクセルはすべて「透過色」になります。


TBitBtn.Kind
TBitBtn.Kind3027005

TBitBtn	参照

Kind プロパティは，ビットマップボタンの種類を示します。

TBitBtnKind = (bkCustom, bkOK, bkCancel, bkHelp, bkYes, bkNo, bkClose, bkAbort, bkRetry, bkIgnore, bkAll);

property Kind: TBitBtnKind;

説明

TBitBtnKind 型は，ボタンの種類を含む列挙型です。

指定できる値とその意味を以下に示します。

値	意味

bkCustom	選択するビットマップに Glyph プロパティ値を設定してビットマップボタンに対応するビットマップを指定する。押しボタンと同様に，ボタンの ModalResult を選択することも OnClick イベントに対応するコードを指定することもできる

bkOK	緑色のチェックマークと「OK」という文字列がボタンに表示される。ボタンはデフォルトボタンになる（Default プロパティが自動的に True に設定される）。このボタンを選択すると，ダイアログボックスが閉じる。ビットマップボタンの ModalResult 値は mrOK となる

bkCancel	赤い×印 と「キャンセル」という文字列がボタンに表示される。ボタンは［キャンセル］ボタンになる（Cancel プロパティが自動的に True に設定される)。このボタンを押すと，ダイアログボックスが閉じる。ビットマップボタンの ModalResult 値は mrCancel となる

bkYes	緑色のチェックマークと「はい(Y)」という文字列がボタンに表示される。ボタンはデフォルトボタンになる（Default プロパティが自動的に True に設定される）。このボタンを押すと，ダイアログボックスで変更した結果が受け入れられ，ダイアログボックスが閉じる。ビットマップボタンの ModalResult 値は mrYes となる

bkNo	赤い否定マークと「いいえ(N)」という文字列ボタンに表示される。ボタンは［キャンセル］ボタンになる（Cancel プロパティが自動的に True に設定される）。このボタンを押すと，ダイアログボックスで変更した結果がキャンセルされ，ダイアログボックスが閉じる。ビットマップボタンの ModalResult 値は mrNo となる

bkHelp	水色の疑問符と「ヘルプ(H)」という文字列がボタンに表示される。このボタンを押すとアプリケーションのヘルプファイル（アプリケーションの HelpFile プロパティで指定したヘルプファイル）のヘルプ画面が表示される。ボタンの HelpContext プロパティでヘルプファイルのどのヘルプ画面を表示するか指定する

bkClose	終了記号が付いた緑色のドアと「終了(C)」という文字列がボタンに表示される。このボタンを押すとフォームが閉じる。ボタンの Default プロパティは True である

bkAbort	赤い×印と「中止(A)」という文字列がボタンに表示される

bkRetry	緑色の環状矢印と「再試行(R)」という文字列がボタンに表示される

bkIgnore	緑色の人が歩み去る絵と「無視(I)」という文字列がボタンに表示される。エラーが発生した後に処理を続行する場合に使う

bkAll	緑色の二重チェックマークと「すべて(L)」という文字列がボタンに表示される


TBitBtn.Layout
TBitBtn.Layout3027006

TBitBtn	参照

Layout プロパティは，ビットマップボタンのどこにイメージを表示するかを指定します。

TButtonLayout = (blGlyphLeft, blGlyphRight, blGlyphTop, blGlyphBottom);

property Layout: TButtonLayout;

説明

TButtonLayout 型は，ビットマップボタン（TBitBtn）の Layout プロパティに値を指定します。次の値を指定できます。

値	意味

blGlyphLeft	テキストまたはキャプションの左端にイメージが表示される

blGlyphRight	テキストまたはキャプションの右端にイメージが表示される

blGlyphTop	テキストまたはキャプションの上部にイメージが表示される

blGlyphBottom	テキストまたはキャプションの下部にイメージが表示される


TBitBtn.Margin
TBitBtn.Margin3027007

TBitBtn	参照

Margin プロパティは，イメージ（Glyph プロパティで指定するイメージ）の端とボタンの端までの距離をピクセル数で指定します。

property Margin: Integer;

説明

マージンとその両端の関係はイメージとテキストのレイアウト（Layout プロパティで指定するレイアウト）によって決まります。たとえば Layout が blGlyphLeft ならばマージンはイメージの左端とボタンの左端の間にあります。Margin が 3 ならばイメージとボタンの両端は 3 ピクセル分離れます。Margin が 0 ならばイメージとボタンの両端は接します。

Margin が -1（デフォルト値）ならば，イメージとテキスト（Caption プロパティで指定するテキスト）は中央に揃えられます。イメージの端とボタンの端の間の距離（ピクセル数）はボタンの反対側の端とテキストの間の距離と同じです。


TBitBtn.NumGlyphs
TBitBtn.NumGlyphs3027008

TBitBtn	参照

NumGlyphs プロパティは，Glyph プロパティで指定するグラフィック内のイメージ（ビットマップボタンまたはスピードボタンで使うイメージ）の数を示します。

TNumGlyphs: 1..4;

property NumGlyphs: TNumGlyphs;

説明

ビットマップに複数のイメージがある場合，NumGlyphs プロパティを使ってビットマップ内のイメージの数を指定しなくてはなりません。イメージはすべて同じサイズで 1 行に隣り合って並んでいなくてはなりません。NumGlyphs の値は 1 ～ 3 （スピードボタンでは 1 ～ 4）です。デフォルト値は 1 です。

1 つのビットマップでビットマップボタンまたはスピードボタンに指定できるイメージは 4 つまでです。Delphi は指定したイメージのいずれか 1 つをボタンの状態に従って表示します。ビットマップのイメージは 1 つだけ表示されます。

ビットマップ内の

イメージの位置	スピードボタンの状態	説明

1 番目	上がっている	ボタンを選択していないときのイメージ。ビットマップに他のイメージがない場合，他の状態を表すにもこのイメージが使われる

2 番目	使用不可	選択できないことを示すイメージ。淡色表示される

3 番目	下がっている	ボタンをクリックしたときのイメージ。マウスボタンから指を離すと上がった状態のイメージに戻る

イメージが 1 つだけの場合は，下がったままの状態も上がっている状態と同じイメージになりますが，Delphi イメージをやや異なる状態に変えて，他の状態になったことを表そうとします。状態によりイメージを変える必要がある場合，ビットマップにイメージを追加できます。

TNumGlyphs 型は，ビットマップボタン（TBitBtn）の NumGlyphs プロパティのとりうる範囲の値（1～4）を表す部分範囲型です。


TBitBtn.Spacing
TBitBtn.Spacing3027009

TBitBtn	参照

Spacing プロパティは，イメージとテキストをビットマップボタンまたはスピードボタンのどの場所に表示するかを決めます。

property Spacing: Integer;

説明

Spacing プロパティは（Glyph プロパティで指定された）イメージと（Caption プロパティで指定された）テキストの間のピクセル数を決めます。デフォルト値は 4 です。

Spacing が正数ならば，その値はイメージとテキストの間のピクセル数です。Spacing が 0 ならば，イメージとテキストの間にピクセルはありません。Spacing が -1 ならば，テキストはイメージとボタンの端との中間に表示されます。イメージとテキストの間のピクセル数はテキストからボタンのグリフとは反対の端までのピクセル数に相当します。


TBitBtn.Style
TBitBtn.Style3027010

TBitBtn	参照

Style プロパティは，ビットマップボタンの外観を決めます。

TButtonStyle = (bsAutoDetect, bsWin31, bsNew);

property Style: TButtonStyle;

説明

TButtonStyle 型には，ビットマップボタンの Style プロパティに設定できる値が入っています。

指定できる値を以下に示します。

値	意味

bsAutoDetect	Windows 3.x を使っている場合，ビットマップボタンは標準的な Windows 3.x の外観になる。それ以降のバージョンの Windows を使っている場合，ビットマップボタンは新しい外観になる

bsWin31	どのバージョンの Windows を実行しているかに関係なく標準の Windows 3.1 の外観になる

bsNew	どのバージョンの Windows を実行しているかに関係なく新しいビットマップボタンの外観になる


TBitBtn イベント3027011

TBitBtn	アルファベット順	凡例

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TBitBtn イベント3027012

TBitBtn	オブジェクト順	凡例

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TBitBtn メソッド3027013

TBitBtn	アルファベット順

TBitBtn

Click

Create

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TBitBtn メソッド3027014

TBitBtn	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Click

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TBitBtn.Click
TBitBtn.Click3027015

TBitBtn	参照

Click メソッドは，ユーザーがボタンをクリックしたときの動作をシミュレートします。

procedure Click;

説明

Click を呼び出すと，OnClick イベントに結び付けられたコードが実行されます。

Kind プロパティの値が bkClose の場合は，Click を呼び出すとフォームが終了します。Kind の値が bkHelp の場合は，Click を呼び出すと HelpContext プロパティでビットマップボタンに割り当てられたヘルプ画面が表示されます。Kind が他の値の場合は，継承した Click メソッドが呼び出されます。


TBitBtn.Create
TBitBtn.Create3027016

TBitBtn	参照

Create メソッドは，ボタンコントロールのインスタンスを作成し値を初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは，ボタンをプログラム的にインスタンス化できます。ボタンを Delphi フォームデザイナで作成した場合は，Create が自動的に呼び出されます。

Create メソッドは以下の処理を行います。

・	継承した Create メソッドを呼び出す

・	ボタングリフを作成する

・	GlyphChanged メソッドを OnChange イベントに割り当てる

・	ビットマップボタン用の TCanvas オブジェクトを作成する

・	Style プロパティ値を bsAutoDetect に設定する

・	Kind プロパティ値を bkCustom に設定する

・	Layout プロパティ値を blGlyphLeft に設定する

・	Spacing プロパティ値を 4 に設定する

・	Margin プロパティ値を -1 に設定する


TBitBtn.Destroy
TBitBtn.Destroy3027017

TBitBtn	参照

Destroy メソッドは，ビットマップボタンオブジェクト用のデストラクタです。

destructor Destroy; override;

説明

Destroy メソッドは TGlyph オブジェクトと TCanvas オブジェクトを解放してから，継承した Destroy メソッドを呼び出します。


スコープ3027018

published

読み出し／書き込み

読み出し専用


スコープ3027019

published


継承3027020

TObject

TPersistent

TComponent

TControl

TWinControl

TButtonControl

TButton


TBitBtn 例3027021

TBitBtn


TBitmap
TBitmap3028001

継承	プロパティ	メソッド	イベント	参照	例

TBitmap オブジェクトは Windows の HBITMAP と HPALETTE をカプセル化します。

ユニット

graphics

説明

TBitmap オブジェクトは，ビットマップグラフィックの内部イメージを保持し，パレットを自動的に管理します。ビットマップは強力なグラフィックオブジェクトであり，イメージの作成や操作（スクロール，回転，描画）を行ったり，ファイルとしてディスクへ保存したりできます。

ビットマップをキャンバスに描画するには，TCanvas オブジェクトの Draw または StretchDraw メソッドを呼び出し，パラメータとして TBitmap を渡します。

TBitmap のコピーの作成は，単にハンドルがコピーされるだけなので，高速に行えます。複数のハンドルを共有している TBitmap オブジェクトのイメージが変更される場合，修正（書き込みコピーなど）が実行される前にイメージが複製されます。


TBitmap プロパティ3028002

TBitmap	アルファベット順	凡例

TBitmap

Canvas

Empty

Handle

HandleType

Height

IgnorePalette

Monochrome

Palette

PixelFormat

ScanLine

TransparentColor

TransparentMode

Width

TGraphic からの継承

Modified

PaletteModified

Transparent


TBitmap プロパティ3028003

TBitmap	オブジェクト順	凡例

Canvas

Empty

Handle

HandleType

Height

IgnorePalette

Modified

Monochrome

Palette

PaletteModified

PixelFormat

ScanLine

Transparent

TransparentColor

TransparentMode

Width


TBitmap.Canvas
TBitmap.Canvas3028004

TBitmap	参照	例

Canvas プロパティは，ビットマップを表す描画面に描画できます。

property Canvas: TCanvas;

説明

Canvas プロパティは，TCanvas オブジェクトを利用してビットマップに対する描画を可能にします。キャンバスに描画すると，基になっているビットマップを効率よく変更できます。Canvas プロパティを使うには，Canvas プロパティによって表示される Canvas オブジェクトの Draw メソッドと StretchDraw メソッドを呼び出します。ビットマップオブジェクトは各メソッドへの引数として渡されます。

キャンバスオブジェクトは自動的にビットマップ用に作成され，そのプロパティは読み出し専用となります。


TBitmap.Empty
TBitmap.Empty3028005

TBitmap	参照

Empty プロパティはビットマップオブジェクトにグラフィックが含まれているかどうかを取得します。

property Empty: Boolean;

説明

Empty プロパティを使うと，ビットマップがビットマップオブジェクトにロードされたかどうかを確認できます。

ビットマップにビットマップイメージが含まれていれば Empty は True となり，含まれていなければ Empty は False となります。


TBitmap.Handle
TBitmap.Handle3028006

TBitmap

Handle プロパティで Windows GDI オブジェクトのハンドルを指定すると GDI オブジェクトにアクセスできます。

property Handle: HBitmap;

説明

Handle を使って，ビットマップオブジェクトのハンドルが必要な Windows API 関数を呼び出します。それぞれの関数にはビットマップハンドルの引数として Handle を渡します。

Handle は，ビットマップオブジェクトによってカプセル化された HBITMAP です。複数の TBitmap がこのハンドルを共有している場合は，HBITMAP がコピーされるのを避けるため，このハンドルを直接操作しないでください。


TBitmap.HandleType
TBitmap.HandleType3028007

TBitmap

HandleType プロパティは，ビットマップがデバイスに依存するものかどうかを示します。

type

TBitmapHandleType = (bmDIB, bmDDB);

property HandleType: TBitmapHandleType;

説明

HandleType プロパティは，ビットマップの種類を識別して変更するために使用されます。


TBitmap.Height
TBitmap.Height3028008

TBitmap	参照

Height プロパティは，ビットマップの縦方向のサイズをピクセル数で示します。

property Height: Integer;

説明

Height プロパティは，ビットマップイメージの縦方向のサイズを調べたり設定したりします。Height プロパティを変更すると，新しい Height によってビットマップイメージが新しいイメージにコピーされます。


TBitmap.IgnorePalette
TBitmap.IgnorePalette3028009

TBitmap	参照

IgnorePalette プロパティは，ビットマップがイメージを描画するときにカスタムパレットを実装するかどうかを指定します。

property IgnorePalette: Boolean;

説明

IgnorePalette プロパティは，描画の速度が優先される場合に使います。IgnorePalette を True に設定した場合，ビットマップを描画するときにカスタムパレットは使用されません。その結果，256 色のビデオドライバでは画質が低下しますが，ビットマップの描画は速くなります。

注意

Delphi は TDBImage を TDBCtrlGrid 内に複製する場合にのみ IgnorePalette を使います。


MaskHandle

MaskHandle プロパティは，GDI ビットマップオブジェクトにアクセスするための，Windows GDI ビットマップハンドルにアクセスします。

property Maskhandle: HBitmap;

説明

MaskHandle プロパティは，ビットマップオブジェクトのハンドルを要求する Windows API 関数を呼び出すために使われます。MaskHandle をビットマップハンドル引数として API 関数に渡します。


TBitmap.Monochrome
TBitmap.Monochrome3028011

TBitmap	例

Monochrome プロパティはビットマップをモノクロで表示するかどうかを指定します。

property Monochrome: Boolean

説明

ビットマップをモノクロで表示する場合には Monochrome を True に設定し，ビットマップをカラーで表示する場合には Monochrome を False に設定します。


TBitmap.Palette
TBitmap.Palette3028012

TBitmap

Palette プロパティはビットマップのカラーマッピングを制御します。

property Palette: HPalette;

説明

Palette プロパティを使うと，ビットマップのパレットを変更できます。

Palette は，ビットマップで実現される HPALETTE です。複数の TBitmap がこのハンドルを共有している場合は，HPALETTE がコピーされるのを避けるため，このハンドルを直接操作しないでください。

Palette を使うと，CreatePalette で作成されたカスタムパレットがこのプロパティに割り当てられます。Palette にはビットマップの画面表示に使える最大 256 種類の色が入っています。

256 色ビデオモードを使っているときに，ビットマップがフォアグラウンドで実行されているアプリケーションによって描画される場合，Palette のすべての色が Windows システムパレットに追加されます。バックグラウンドで実行されているアプリケーションによってビットマップが描画される場合，別のアプリケーションがすでに独自の色のシステムパレットをロードしていると，ビットマップの色はシステムパレットにマップされます。ビットマップにパレットがない場合は Palette=0 です。


TBitmap.PixelFormat
TBitmap.PixelFormat3028013

TBitmap	参照

PixelFormat プロパティは，ビットマップイメージの表示形式を示します。

type

TPixelFormat = (pfDevice, pf1bit, pf4bit, pf8bit, pf15bit, pf16bit, pf24bit, pf32bit, pfCustom);

property PixelFormat: TPixelFormat;

説明

PixelFormat プロパティは，ビットマップイメージのピクセル形式を，ビットマップイメージのネイティブ形式を表示できないビデオドライバ用に，8 ビットに設定します。JPEG イメージオブジェクトの PixelFormat は，JPEG イメージがコピーされれば，ビットマップに適用されます。


TBitmap.ScanLine
TBitmap.ScanLine3028014

TBitmap	例

ScanLine プロパティは，ピクセル数を取得します。

property ScanLine[Row: Integer]: Pointer;

説明

ScanLine プロパティは，イメージ編集ツール用に，デバイス依存のビットマップに対して使用されます。


TBitmap.TransparentColor
TBitmap.TransparentColor3028015

TBitmap	参照	例

TransparentColor プロパティはビットマップが透過となっているときの色を表します。

property TransparentColor: TColor;

説明

TransparentColor プロパティを使うと，ビットマップの透過モード時の色を確認できます。TransparentColor は読み出し専用のため変更できません。TransParentMode プロパティが tmAuto（デフォルト）に設定されている場合，TransParentColor は，ビットマップイメージの左下端の色を返します。TransparentColor が割り当てられている場合は，TransparentMode は tmFixed に自動的に設定されます。これにより，新しい透過モード時の色を使用できます。再び左下端の色を返すようにするには，TransparentMode を tmAuto に設定してください。


TBitmap.TransparentMode
TBitmap.TransparentMode3028016

TBitmap	参照	例

TransparentMode プロパティは，TransparentColor のプロパティ値を自動的に計算するようにするか，ビットマップオブジェクトとともに保存するようにするかを示します。

property Transparent: TTransparentMode;

説明

TransparentMode を tmAuto に設定すると，TransparentColor プロパティはビットマップイメージの左下端のピクセルの色を返します。tmFixed に設定すると，ビットマップオブジェクトに格納されている色が参照されます。


TBitmap.Width
TBitmap.Width3028017

TBitmap

Width プロパティは，グラフィックオブジェクトの幅をピクセル単位で指定します。

property Width: Integer;

説明

Width プロパティは，ビットマップの幅を確認/設定します。


TBitmap イベント3028018

TBitmap	アルファベット順

TGraphic からの継承

OnChange

OnProgress


TBitmap イベント3028019

TBitmap	オブジェクト順

OnChange

OnProgress


TBitmap メソッド3028020

TBitmap	アルファベット順

TBitmap

Assign

Create

Destroy

Dormant

FreeImage

LoadFromClipboardFormat

LoadFromResourceID

LoadFromResourceName

LoadFromStream

Mask

ReleaseHandle

ReleaseMaskHandle

ReleasePalette

SaveToClipboardFormat

SaveToStream

TGraphic からの継承

LoadFromFile

SaveToFile

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TBitmap メソッド3028021

TBitmap	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

Dormant

FieldAddress

Free

FreeImage

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LoadFromClipboardFormat

LoadFromFile

LoadFromResourceID

LoadFromResourceName

LoadFromStream

Mask

MethodAddress

MethodName

NewInstance

ReleaseHandle

ReleaseMaskHandle

ReleasePalette

SafeCallException

SaveToClipboardFormat

SaveToFile

SaveToStream


TBitmap.Assign
TBitmap.Assign3028022

TBitmap	参照	例

Assign メソッドは，新しいビットマップイメージをビットマップオブジェクトにコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドは，Source 内のビットマップイメージをビットマップオブジェクトにコピーします。

その後，Assign は継承された Assign を呼び出します。

注意

ある型のオブジェクトは常に同じ型の別のオブジェクトに割り当てられます。また，画像の Graphic プロパティがビットマップの場合，Source は TPicture 型になります。


TBitmap.Create
TBitmap.Create3028023

TBitmap	参照

Create メソッドは，ビットマップオブジェクトをインスタンス化します。

constructor Create; override;

説明

Create メソッドを呼び出すと，実行時にビットマップオブジェクトをインスタンス化できます。また，Create はビットマップイメージが TImage にロードされたときに自動的に呼び出されます。

Create はビットマップオブジェクトにメモリを割り当てて，継承した Create を呼び出します。さらに，ビットマップで表示される内部のイメージとして TBitmapImage を作成します。


TBitmap.Destroy
TBitmap.Destroy3028024

TBitmap	参照

Destroy メソッドは，ビットマップオブジェクトのインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出すことはせず、Free メソッドを呼び出すようにしてください。Free メソッドはリストボックスオブジェクトが解放されていないことを確認してから Destroy メソッドを呼び出します。

Destroy は内部のビットマップイメージ（TBitmapImage オブジェクト）およびキャンバスを解放してから，継承した Destroy を呼び出します。


TBitmap.Dormant
TBitmap.Dormant3028025

TBitmap	参照	例

Dormant メソッドは，メモリのビットマップイメージを作成して，ビットマップのハンドルやサーバのリソースを解放します。

procedure Dormant;

説明

Dormant メソッドを呼び出すと，アプリケーションで使用する GDI リソースの総量を減らすことができます。

Dormant は，メモリストリームオブジェクトを使ってメモリ内にビットマップイメージを作成します。イメージを格納すると，ビットマップに割り当てられていた HBITMAP（Handle プロパティを介してアクセスされる）が解放されます。


TBitmap.FreeImage
TBitmap.FreeImage3028026

TBitmap	例

FreeImage メソッドは，ビットマップによってメモリに一時的に格納されていたファイルイメージを解放します。

procedure FreeImage;

説明

FreeImage メソッドを呼び出すと，色数を問題としない場合に，アプリケーションが要求するメモリの量を低減できます。イメージを解放すると，ビットマップイメージに割り当てられていたメモリが解放されると同時に，ビットマップの色がいくつか失われます。

ビットマップがビットマップオブジェクトにロードされると，Delphi はロードされたビットマップのイメージをメモリ内に作成します。ビットマップを変更しなかった場合は，ビットマップの保存時にメモリ内のイメージを使って，ビットマップの構成色が失われていないか検証されます。


TBitmap.LoadFromClipboardFormat
TBitmap.LoadFromClipboardFormat3028027

TBitmap	参照	例

LoadFromClipboardFormat メソッドは，クリップボード内のビットマップをビットマップオブジェクトにロードします。

procedure LoadFromClipboardFormat(AFormat: Word; AData: THandle; APalette: HPALETTE); override;

説明

LoadFromClipboardFormat メソッドは，RegisterClipboardFormat メソッドを使ってビットマップを TPicture オブジェクトに登録している場合に呼び出されます。

LoadFromClipboardFormat は，現在のイメージを AData パラメータが指すデータで更新します。ビットマップのパレットは引数 APalette で指定されます。


TBitmap.LoadFromResourceID
TBitmap.LoadFromResourceID3028028

TBitmap	参照

LoadFromResourceID メソッドは，リソース内のビットマップをビットマップオブジェクトにロードします。

procedure LoadFromResourceID(Instance: THandle; ResID: Integer);

説明

LoadFromResourceID を呼び出すと，指定したビットマップリソースとパレット情報をモジュールの実行形式ファイルからロードできます。ビットマップのリソース ID は ResID パラメータで指定されます。


TBitmap.LoadFromResourceName
TBitmap.LoadFromResourceName3028029

TBitmap	参照	例

LoadFromResourceName メソッドは，ビットマップリソースをビットマップオブジェクトにロードします。

procedure LoadFromResourceName(Instance: THandle; const ResName: String);

説明

LoadFromResourceName メソッドは，指定したビットマップリソースとパレット情報をモジュールの実行形式ファイルからロードします。ResName の値にはロードするリソースを指定します。


TBitmap.LoadFromStream
TBitmap.LoadFromStream3028030

TBitmap	参照

LoadFromStream メソッドは，ストリーム内のビットマップをビットマップオブジェクトにロードします。

procedure LoadFromStream(Stream: TStream); override;

説明

LoadFromStream を使うには，ビットマップをロードするストリームを Stream の値で指定します。


TBitmap.Mask
TBitmap.Mask3028031

TBitmap	参照

Mask メソッドは，ビットマップイメージをモノクロのマスクに変換します。

procedure Mask(TransparentColor: TColor);

説明

Mask メソッドは，与えられた透過色を基にして，モノクロのマスクビットマップを生成します。Mask は，MaskHandle が生成するものと同じイメージを生成しますが，Mask で生成されるイメージは，TBitmap オブジェクトのイメージに置き換わる点が異なります。したがって，Mask の呼び出しは 1 回行う場合に限り意味があります。MaskHandle の使用は，マスクイメージのビットマップハンドルが必要な場合に限られます。


TBitmap.ReleaseHandle
TBitmap.ReleaseHandle3028032

TBitmap	参照	例

ReleaseHandle メソッドはビットマップのハンドルを返し，TBitmap オブジェクトはそのハンドルを認識しなくなります。

function ReleaseHandle: HBitmap;

説明

ReleaseHandle メソッドは，ビットマップとビットマップハンドルの結び付きを解除します。


TBitmap.ReleaseMaskHandle
TBitmap.ReleaseMaskHandle3028033

TBitmap	参照

ReleaseMaskHandle メソッドは，ビットマップマスクへのハンドルを返します。これにより，TBitmap オブジェクトがマスクハンドルについて認識する必要はありません。

function ReleaseMaskHandle: HBitmap;

説明

ReleaseMaskHandle メソッドは，ビットマップオブジェクトとビットマップマスクハンドルの結び付きを解除します。


TBitmap.ReleasePalette
TBitmap.ReleasePalette3028034

TBitmap

ReleasePalette メソッドはビットマップのパレットのハンドルを返し，パレットと TBitmap オブジェクトの結び付きを解除します。

function ReleasePalette: HPalette;

説明

ReleasePalette メソッドを使うと，パレットとビットマップイメージの結び付きを解除できます。


TBitmap.SaveToClipboardFormat
TBitmap.SaveToClipboardFormat3028035

TBitmap	参照	例

SaveToClipboardFormat メソッドは，ビットマップをクリップボード形式で保存します。

procedure SaveToClipboardFormat(var AFormat: Word; var AData: THandle; var APalette: HPALETTE); override;

説明

SaveToClipboardFormat メソッドを使うと，APalette でパレットを，AFormat で保存形式を，AData で保存するデータをそれぞれ指定することで，ビットマップをクリップボード形式で保存できます。アプリケーションでビットマップを保存するには，あらかじめ RegisterClipboardFormat メソッドを使って保存形式を TBitmap オブジェクトに登録しておく必要があります。


TBitmap.SaveToStream
TBitmap.SaveToStream3028036

TBitmap	例

SaveToStream メソッドはビットマップをストリームに保存します。

procedure SaveToStream(Stream: TStream); override;

説明

SaveToStream メソッドを使うと，Stream パラメータで指定したストリームにビットマップを保存できます。


読み出し／書き込み3028037

読み出し専用


継承3028038

TObject

TPersistent

TGraphic


TBits
TBits3029001

継承	プロパティ	メソッド	参照

TBits クラスは論理値の「配列」を格納します。

ユニット

classes

説明

TBits クラスを使うと，不定個数の論理値を格納したりアクセスしたりできます。TBits は必要に応じて格納領域を自動的に拡大するので，使用可能なメモリが許す限り論理値をいくつでも格納できます。必要な論理値の数が 32 個以内ならば，整数型の値に対してビット演算子の AND と OR を使うことで同じ機能を実現できます。


TBits プロパティ3029002

TBits	アルファベット順

TBits

Bits

Size


TBits プロパティ3029003

TBits	オブジェクト順

Bits

Size


TBits.Bits
TBits.Bits3029004

TBits	参照

Bits プロパティは，TBits が示す論理値の配列です。

property Bits[Index: Integer]: Boolean

説明

Bits プロパティは，特定の論理値を Index パラメータでインデックス化して取得および設定できます。Index の値が 0～Size-1 の範囲にない場合は，EBitsError 例外が生成されます。


TBits.Size
TBits.Size3029005

TBits	参照

Size プロパティは，TBits オブジェクトが保持する論理値の数を示します。

property Size: Integer;

説明

Size プロパティを設定すると，配列の数を増減できます。サイズを大きくすると，新しいエントリは False に設定されます。サイズを小さくすると，指定したインデックスサイズよりも大きいエントリは失われます。


TBits メソッド3029006

TBits	アルファベット順

TBits

Destroy

OpenBit

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TBits メソッド3029007

TBits	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

OpenBit

SafeCallException


TBits.Destroy
TBits.Destroy3029008

TBits	参照

Destroy メソッドは，TBits のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出すことはせずに，Free メソッドを呼び出すようにしてください。Free メソッドは TBits オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy は，論理値の配列を格納するために使われたメモリを解放します。


TBits.OpenBit
TBits.OpenBit3029009

TBits	参照

OpenBit メソッドは，最初の False 値のインデックスを返します。

function OpenBit: Integer;

説明

OpenBit メソッドを呼び出すと，配列内で True に設定されていない最初のインデックスを取得することができます。


継承3029010

TObject


TBits 例3029011

TBits


TBlobField
TBlobField3030001

継承	プロパティ	メソッド	イベント	参照

TBlobField オブジェクトはバイナリ大規模オブジェクト（BLOB）への参照を保持するデータセット内の項目を表します。

ユニット

db

説明

BLOB 項目は，不特定サイズのバイナリデータを含むデータベース項目です。バイナリ項目とは異なり，BLOB 項目はデータベーステーブルにバイナリデータを直接格納しません。かわりに，物理データベーステーブルの項目が項目の BLOB 値を含む別個のファイルへの参照を含みます。

TBlobField オブジェクトは，BLOB 項目のデータのストリーム処理を可能にする新しいメソッドを導入します。

TField の派生オブジェクトとして，TBlobField オブジェクトはデータベースの項目の値およびプロパティの操作に便利なプロパティ，メソッド，およびイベントを数多く備えています。

BLOB 項目コンポーネントは，任意の大きさのさまざまなデータ形式を表すことができます。データ形式は，バイナリデータのヘッダによって区別されます。TBlobField オブジェクトは，直接サポートされている項目型であり，また BLOB 項目コンポーネント TMemoField（ftMemo）および TGraphicField（ftGraphic）の直接の上位オブジェクトでもあります。


TBlobField プロパティ3030002

TBlobField	アルファベット順	凡例

TBlobField

AsString

AsVariant

BlobSize

BlobType

Modified

Transliterate

Value

TField からの継承

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TBlobField プロパティ3030003

TBlobField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

BlobSize

BlobType

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Modified

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

Transliterate

ValidChars

Value

VCLComObject

Visible


TBlobField.AsString
TBlobField.AsString3030004

TBlobField	参照

AsString プロパティは，BLOB 項目の値と文字列値の間の変換を行います。

property AsString: string;

説明

AsString プロパティを使うと，BLOB 項目の値を文字列に代入したり，文字列値を BLOB 項目に代入したりできます。

次のコードは文字列値を BLOB 項目値に代入します。

MyBLOBField.AsString := �Assign the string to a BLOB field�;

BLOB 項目の値を文字列値に代入するには次のようなコードを使います。

BlobString := MyBLOBField.AsString;

通常，AsString プロパティは BLOB 項目がメモ項目コンポーネントのようなテキストを含む場合にのみ意味を持ちます。しかし，文字列データ型はバイナリデータも保存できます。そのため，ftGraphic または ftTypedBinary といった非テキスト BLOB 型が使う BLOB 項目でも AsString プロパティを使えます。

テキストデータに BLOB 項目の値を設定するには，Text プロパティではなく AsString プロパティを使います。Text プロパティを設定しようとすると例外が生成されます。


TBlobField.AsVariant
TBlobField.AsVariant3030005

TBlobField	参照

AsVariant プロパティは，BLOB 項目の値とバリアント値の間の変換を行います。

property AsVariant: Variant;

説明

AsVariant プロパティは次の処理に使います。

・	BLOB 項目の値をバリアント変数に代入する

・	バリアント値を BLOB 項目に代入する

バリアントを使うと，項目の型がわからないときにも As... 系のプロパティを使わずに項目の型変換ができる点が便利です。


TBlobField.BlobSize
TBlobField.BlobSize3030006

TBlobField	参照

BlobSize プロパティは，現在のレコードの BLOB 項目に格納されているデータのバイト数です。

property BlobSize: Integer;

説明

BlobSize プロパティは，BLOB 項目の内容を格納するときに必要なメモリ容量を示します。BLOB 項目の場合，DataSize プロパティは常に 0 を返すので，DataSize のかわりに BlobSize を使ってください。

注意

あらゆるレコードの項目データのサイズを表す DataSize プロパティと違って，BlobSize は現在のレコードの BLOB データのサイズだけを示します。


TBlobField.BlobType
TBlobField.BlobType3030007

TBlobField	参照

BlobType プロパティは，BLOB 項目オブジェクトと関連付けられている BLOB 項目の型を指定します。

TBlobType = ftBlob..ftTypedBinary;

property BlobType: TBlobType;

説明

BlobType プロパティは，項目コンポーネントと関連付けられた BLOB データのデータ型を設定したり取得したりできます。

直接サポートされていない BLOB 項目（書式付メモ BLOB など）の型を TBlobField オブジェクトを使って表すときに，BlobType プロパティを指定します。BlobType プロパティは，テーブルにある BLOB の型が項目の型と一致することを確認するのに使えます。

TBlobType プロパティは以下の TFieldType 値を取ります。

値	説明

ftBlob	BLOB 項目

ftMemo	テキストメモ項目

ftGraphic	ビットマップ項目

ftFmtMemo	書式付きテキストメモ項目

ftParadoxOle	Paradox OLE 項目

ftDBaseOle	dBase OLE 項目

ftTypedBinary	型付きバイナリ項目


IsNull

IsNull プロパティは，BLOB 項目がデータを保持しているかどうかを示します。

property IsNull: Boolean;

説明

IsNull プロパティは，BLOB 項目が空白かどうかを表します。BLOB 項目が空の場合，IsNull は True になります。BLOB 項目がデータを保持している場合，IsNull は False になります。


TBlobField.Modified
TBlobField.Modified3030009

TBlobField	参照

Modified プロパティは，最後にディスクから BLOB 項目の値を読み出してから，その値に変更あったかどうかを示します。

property Modified: Boolean;

説明

SetData メソッドを呼び出すか，直接ボーランドデータベースエンジン（BDE）の API を呼び出して BLOB 項目の値を変更する場合は，Modified を True に設定します。TBlobField のプロパティまたは TBlobStream オブジェクトを使って BLOB 項目の値を設定した場合には，Modified は自動的に True に設定されます。

BLOB 項目は Modified プロパティを使ってデータイベントを生成したり，BLOB データを格納していたバッファをいつ BDE がクリアすべきかを示したりします。


TBlobField.Transliterate
TBlobField.Transliterate3030010

TBlobField	参照

Transliterate プロパティは，BLOB 項目のテキストを ANSI 文字セットからデータセット指定の文字セットに変換したり，その逆の変換を行ったりするかどうかを決めます。

property Transliterate: Boolean;

説明

Transliterate プロパティは，ANSI 言語ドライバを使っていないデータセット指定の物理データベーステーブルでデータに拡張 ASCII 文字が含まれている可能性がある場合に使います。

Transliterate が True の場合，Value プロパティ，AsString プロパティ，または AsVariant プロパティを使って項目値を変更するときには BLOB 項目は AnsiToNative 関数を呼び出して，データセットが使う文字セットに ANSI 文字を変換します。これらのプロパティを読み出して BLOB 項目の値を取得するときには，NativeToAnsi 関数がデータベーステーブルの文字を ANSI 文字セットに変換します。

注意

TBlobStream オブジェクトも BLOB 項目の読み書きを行うときに Transliterate プロパティを調べます。


TBlobField.Value
TBlobField.Value3030011

TBlobField	参照

Value プロパティは，BLOB 項目の実際のデータです。

property Value: string;

説明

Value プロパティは，実行時に BLOB 項目コンポーネントと直接データの読み書きができます。BLOB 項目の Value プロパティは AsString プロパティに相当します。

注意

文字列型データはテキストと同様にバイナリデータも保持できます。そのため，非テキスト BLOB 型が使う BLOB 項目である ftGraphic または ftTypedBinary でも文字列でデータの取得と設定が行えます。


TBlobField イベント3030012

TBlobField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TBlobField イベント3030013

TBlobField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TBlobField メソッド3030014

TBlobField	アルファベット順

TBlobField

Assign

Clear

Create

IsBlob

LoadFromFile

LoadFromStream

SaveToFile

SaveToStream

SetFieldType

TField からの継承

AssignValue

Destroy

FocusControl

GetData

IsValidChar

RefreshLookupList

SetData

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TBlobField メソッド3030015

TBlobField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SaveToFile

SaveToStream

SetData

SetFieldType

Validate


TBlobField.Assign
TBlobField.Assign3030016

TBlobField	参照

Assign メソッドは，値を BLOB 項目にコピーします。

procedure Assign(Source: TPersistent);

説明

Assign メソッドを呼び出すと，データを BLOB 項目にコピーできます。Assign メソッドは BLOB 項目の値を以下の項目またはオブジェクトからコピーします。

・	他の BLOB 項目

・	TStrings オブジェクト

・	TBitmap オブジェクト，BlobType プロパティが ftGraphic または ftTypedBinary の場合

・	TPicture オブジェクト，BlobType プロパティが ftGraphic または ftTypedBinary の場合

・	AssignTo メソッドで TBlobField をサポートしている任意のオブジェクト


TBlobField.Clear
TBlobField.Clear3030017

TBlobField	参照

Clear メソッドは，BLOB 項目の現在の値を削除します。

procedure Clear;

説明

Clear メソッドを呼び出すと，項目の現在の値を削除して項目を値なしの状態にします。


TBlobField.Create
TBlobField.Create3030018

TBlobField	参照

Create メソッドは，BLOB 項目コンポーネントのインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，TBlobField オブジェクトのインスタンスを作成および初期化できます。Create メソッドは継承コンストラクタを呼び出した後で DataType プロパティを ftBlob に設定します。

Create メソッドを明示的に呼び出す必要はほとんどありません。データセット内のすべての BLOB 項目について BLOB 項目コンポーネントが自動的にインスタンス化されるからです。


TBlobField.IsBlob
TBlobField.IsBlob3030019

TBlobField	参照

IsBlob メソッドは，継承メソッドをオーバーライドして，オブジェクトが BLOB 項目であることを示します。

class function IsBlob: Boolean; override;

説明

TField オブジェクトを処理するときに IsBlob を使うと，そのオブジェクトが BLOB データを表しているかどうかがわかります。たとえば，GetData メソッドまたは SetData メソッドを使う前に IsBlob を呼び出すと，これらのメソッドを使用できるかどうかを知ることができます。TBlobField の IsBlob メソッドは常に True を返します。


TBlobField.LoadFromFile
TBlobField.LoadFromFile3030020

TBlobField	参照

LoadFromFile メソッドは，ファイルからの BLOB を項目にロードします。

procedure LoadFromFile(const FileName: string);

説明

LoadFromFile メソッドで呼び出すと，ファイルの内容を BLOB 項目にロードできます。項目にロードするファイルの名前は，FileName パラメータの値として指定します。


TBlobField.LoadFromStream
TBlobField.LoadFromStream3030021

TBlobField	参照

LoadFromStream メソッドは，ストリームからの BLOB を項目にロードします。

procedure LoadFromStream(Stream: TStream);

説明

LoadFromStream メソッドを呼び出すと，ストリームの内容を BLOB 項目にロードできます。項目の値のコピー元になるストリームの名前は，Stream パラメータの値として指定します。


TBlobField.SaveToFile
TBlobField.SaveToFile3030022

TBlobField	参照

SaveToFile メソッドは，BLOB 項目の内容をファイルに保存します。

procedure SaveToFile(const FileName: string);

説明

SaveToFile メソッドを呼び出すと，BLOB 項目の内容をファイルに保存できます。ファイル名は FileName パラメータの値として指定します。


TBlobField.SaveToStream
TBlobField.SaveToStream3030023

TBlobField	参照

SaveToStream メソッドは， BLOB 項目の内容をストリームに保存します。

procedure SaveToStream(Stream: TStream);

説明

SaveToStream メソッドを呼び出すと，BLOB 項目の内容をストリームに保存できます。項目の値を保存するストリームの名前を Stream パラメータに指定します。


TBlobField.SetFieldType
TBlobField.SetFieldType3030024

TBlobField	参照

SetFieldType メソッドは，BLOB 項目の型を指定します。

procedure SetFieldType(Value: TFieldType); override;

説明

SetFieldType メソッドを呼び出すと，BLOB 項目の型を変更して，デフォルトの型をオーバーライドできます。

通常は，物理データベース項目の型が調べられ，もっとも近い TFieldType が選択されます。BLOB 項目はデータベースにある BLOB の種類をより明示的に示すことができます。BLOB の型は Value パラメータの値として指定します。

以下に BLOB 項目で可能な値を示します。他のデータ型で SetFieldType メソッドを呼び出してもなにも起きません。

値	説明

ftBlob	BLOB 項目

ftMemo	テキストメモ項目

ftGraphic	ビットマップ項目

ftFmtMemo	書式付きテキストメモ項目

ftParadoxOle	Paradox OLE 項目

ftDBaseOle	dBase OLE 項目

ftTypedBinary	型付きバイナリ項目

注意

SetFieldType メソッド呼び出しは，BlobType プロパティを設定したのと同じことをします。


スコープ3030026

published

読み出し／書き込み

読み出し専用


スコープ3030027

published


継承3030028

TObject

TPersistent

TComponent

TField


TBlobField 例3030029

TBlobField


TBlobStream
TBlobStream3031001

継承	プロパティ	メソッド	参照

TBlobStream オブジェクトはストリームオブジェクトです。TBlobStream が提供するサービスによって，バイナリ大規模オブジェクト（BLOB）項目を示す項目オブジェクトをアプリケーションで読み書きできます。

ユニット

dbtables

説明

TBlobStream オブジェクトを使うと，BLOB 項目オブジェクトの値をアクセスしたり変更したりできます。BLOB 項目オブジェクトは TBlobField のオブジェクトであり，TGraphicField や TMemoField と同じように TBlobField の派生オブジェクトです。BLOB 項目は，BLOB ストリームを使ってさまざまなデータアクセスのプロパティやメソッドを実現します。

TBlobStream は，BLOB 項目にどのようにデータが格納されているかについて特定の情報を持たないオブジェクトが，統一したストリームインターフェースを使って BLOB 項目のデータを読み書きできるようにします。

BLOB ストリームを使うには，TBlobStream のインスタンスを作成して，データを読み書きするためのストリームのメソッドを使用します。次に，BLOB ストリームを解放します。複数のレコードのデータにアクセスする場合は，TBlobStream の別のインスタンスを使用してください。新しいレコードの BLOB データに対して読み書きを行う場合は，新たに TBlobStream オブジェクトを作成してください。


TBlobStream プロパティ3031002

TBlobStream	アルファベット順

TStream からの継承

Position

Size


TBlobStream プロパティ3031003

TBlobStream	オブジェクト順

Position

Size


TBlobStream メソッド3031004

TBlobStream	アルファベット順

TBlobStream

Create

Destroy

Read

Seek

Truncate

Write

TStream からの継承

CopyFrom

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TBlobStream メソッド3031005

TBlobStream	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyFrom

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Read

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

SafeCallException

Seek

Truncate

Write

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes


TBlobStream.Create
TBlobStream.Create3031006

TBlobStream	参照

Create メソッドは，TBlobStream のインスタンスを作成します。

TBlobStreamMode = (bmRead, bmWrite, bmReadWrite);

constructor Create(Field: TBlobField; Mode: TBlobStreamMode);

説明

Create を呼び出すと，TBlobStream のインスタンスを取得して TBlobField オブジェクトを読み書きできます。

Create メソッドは，Field パラメータで指定した項目オブジェクトに TBlobStream をリンクします。Mode はストリームの使い方を指定します。Mode には次のいずれかの値を指定する必要があります。

値	意味

bmRead	BLOB ストリームが項目からデータを読み込むことができる

bmWrite	BLOB ストリームが項目のデータを置換できる

bmReadWrite	BLOB ストリームが項目のデータを更新できる


TBlobStream.Destroy
TBlobStream.Destroy3031007

TBlobStream	参照

Destroy メソッドは，TBlobStream のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出すことはせずに，Free メソッドを呼び出すようにしてください。Free メソッドは TBlobStream オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

TBlobStream オブジェクトを破棄するには，BLOB 項目の読み書きが不要になったときに Free を呼び出します。

Destroy メソッドは，BLOB ストリームが項目内のデータを上書きまたは変更する場合でも，OnDataChange イベントを発生させます。その後 Destroy メソッドは，データ処理のために割り当てられたバッファを解放します。


TBlobStream.Read
TBlobStream.Read3031008

TBlobStream	参照

Read メソッドは，項目データの現在の位置から最大で Count バイトを読み出して Buffer にコピーします。

function Read(var Buffer; Count: Longint): Longint;

説明

Read メソッドを呼び出すと，BLOB 項目内のデータのバイト数が不明のときにデータを読み出せます。項目から読み出されたデータを保持するためには，Buffer に少なくとも Count バイト以上を割り当てる必要があります。

Read メソッドは，現在の位置から最大で Count バイトの BLOB データを Buffer に転送し，実際に転送されたバイト数の分だけ現在の位置を進めます。Read は，実際に転送されたバイト数（Count で要求された数値より小さい場合もある）を返します。

BLOB 項目が TMemoField のインスタンスである場合は，Read は BLOB 項目の Transliterate プロパティを調べて，Transliterate が True の場合に，データセットで指定した文字セットから ANSI へデータを変換します。

BLOB ストリームの他の 2 つのデータ読み出しメソッド（ReadBuffer，ReadComponent）は，Read を呼び出して実際の読み出しを行います。

注意

TBlobStream が bmWrite モードで作成されているときは Read を呼び出さないでください。


TBlobStream.Seek
TBlobStream.Seek3031009

TBlobStream	参照

Seek メソッドは，TBlobStream オブジェクト内の現在の位置を再設定します。

function Seek(Offset: Longint; Origin: Word): Longint;

説明

Seek メソッドを呼び出すと，指定したオフセットで BLOB データ内の現在の位置を移動します。Seek メソッドにより，BLOB データ内のある特定の位置に対して読み書きを実行できます。

Origin パラメータは，Offset パラメータをどのように解釈するかを指定します。Origin には以下のいずれかの値を指定します。

値	意味

soFromBeginning	Offset が BLOB データの先頭からの位置となる。Seek は Offset が示す位置に移動する。Offset >= 0 でなくてはならない

soFromCurrent	Offset が BLOB データの現在の位置からの位置となる。Seek は Position + Offset が示す位置に移動する

soFromEnd	Offset が BLOB データの末尾からの位置となる。Offset は，BLOB の末尾までのバイト数を示すために <= 0 でなくてならない

Seek は，Position プロパティの新しい値，つまり BLOB データの新しい現在の位置を返します。


TBlobStream.Truncate
TBlobStream.Truncate3031010

TBlobStream	参照

Truncate メソッドは，BLOB 項目の現在の位置以降のすべてのデータを破棄します。

procedure Truncate;

説明

Truncate は BLOB データのサイズを制限します。現在の位置が 0 のときに Truncate を呼び出すと，BLOB 項目の内容がクリアされます。

注意

TBlobStream が bmRead モードで作成されているときは Truncate を呼び出さないでください。


TBlobStream.Write
TBlobStream.Write3031011

TBlobStream	参照

Write メソッドは，Buffer から Count バイト分を項目の現在の位置に書き込んで，Count のバイト数に応じて現在の位置を更新します。

function Write(const Buffer; Count: Longint): Longint; override;

説明

Write メソッドを呼び出すと，現在の位置から Count バイト分を BLOB 項目に書き込むことができます。BLOB データには終端文字が含まれていない場合もあるので，TBlobStream の Write メソッドは常に Count バイト全体を書き込みます。つまり，Write メソッドは WriteBuffer メソッドと同じ機能を提供します。

BLOB 項目が TMemoField のインスタンスである場合は，Write はその項目の Transliterate プロパティを調べて，Transliterate が True の場合にデータを ANSI からデータセットの文字セットに変換します。

BLOB ストリームの他の 2 つのデータ書き込みメソッド（WriteBuffer，WriteComponent）は，Write を呼び出して実際の書き込みを行います。

注意

TBlobStream が bmRead モードで作成されているときは Write を呼び出さないでください。


継承3031013

TObject

TStream


TBlobStream 例3031014

TBlobStream


TBitmapImage
TBitmapImage3032001

継承	メソッド	参照

TBitmapImage オブジェクトは TBitmap オブジェクトのビットマップイメージを内部で表現します。

ユニット

graphics

説明

TBitmapImage オブジェクトは Delphi 内部の実装でのみ使います。TBitmapImage は，TBitmap オブジェクトでカプセル化されたビットマップの内部イメージを表します。TBitmapImage で実装されているすべてのデータやメソッドは Private です。それらには，特定の HBITMAP に関する情報が入っており，Windows で定義される標準の HBITMAP 構造体を指すポインタも含まれます。TBitmapImage は，ビットマップイメージが作成される TBitmap オブジェクトのコンストラクタで参照されます。

注意

複数鵜のインスタンスが同一の TBitmap イメージを参照できます。TBitmapImage は，ビットマップハンドルの実際のオーナーです。


TBitmapImage メソッド3032002

TBitmapImage	アルファベット順

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TBitmapImage メソッド3032003

TBitmapImage	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3032004

TObject

TSharedImage


TBitmapImage 例3032005

TBitmapImage


TBooleanField
TBooleanField3033001

継承	プロパティ	メソッド	イベント	参照

TBooleanField オブジェクトは，論理値を含む項目を表します。

ユニット

db

説明

論理型項目は値として True または False を保持できます。

TBooleanField オブジェクトは論理値と他のデータ形式の変換をしたり，データのさまざまな解釈を表す表示文字列を提供するためのプロパティを導入します。TField オブジェクトからの派生オブジェクトとして，TBooleanField オブジェクトはデータベース内の項目の値およびプロパティの管理に便利なプロパティ，メソッド，およびイベントを数多く含みます。


TBooleanField プロパティ3033002

TBooleanField	アルファベット順	凡例

TBooleanField

AsBoolean

AsString

AsVariant

DisplayValues

Value

TField からの継承

Alignment

AsCurrency

AsDateTime

AsFloat

AsInteger

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TBooleanField プロパティ3033003

TBooleanField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayLabel

DisplayName

DisplayText

DisplayValues

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TBooleanField.AsBoolean
TBooleanField.AsBoolean3033004

TBooleanField	参照

AsBoolean プロパティは，論理型項目の論理値を読み出したり，論理型項目に論理値を書き込んだりします。

property AsBoolean: Boolean;

説明

AsBoolean プロパティは，論理型を用いて論理型項目の値を設定および取得できます。物理論理データベース項目は論理値を WordBool の値として格納します。AsBoolean は WordBool の値を Delphi の論理型に変換したり，その逆の変換を行ったりします。


TBooleanField.AsString
TBooleanField.AsString3033005

TBooleanField	参照

AsString プロパティは，論理型項目の値を文字列値に変換したり，その逆の変換をしたりします。

property AsString: string;

説明

AsString プロパティは次の処理に使います。

・	論理型項目の値を文字列変数に代入

・	文字列値を論理型項目に代入

次のコードは文字列値を論理型項目の値に代入します。

MyBoolField.AsString := �TRUE�;

論理型項目の値を文字列変数に代入するには，次のようなコードを使います。

StringVar := MyBoolField.AsString;

DisplayValues プロパティが設定されていない場合，AsString プロパティで論理値を挿入または更新すると，文字列が �True� のときに値が True に， �False� のときに値が False に設定されます。他の文字列の場合は EDatabaseError 例外が生成されます。

DisplayValues プロパティは，True または False の値と関連付ける文字列を指定します。DisplayValues プロパティを変更すると，論理型項目の値を True または False に設定するために代入しなければならない文字列を変更することができます。

AsString プロパティは，項目の値と対応する文字列が戻ります。DisplayValues プロパティが設定されていない場合，この文字列は �True� または �False� です。


TBooleanField.AsVariant
TBooleanField.AsVariant3033006

TBooleanField	参照

AsVariant プロパティは，論理型項目の値をバリアント値に変換したり，その逆の変換をしたりします。

property AsVariant: Variant;

説明

AsVariant プロパティは次の処理に使います。

・	論理型項目の値をバリアント変数に代入

・	バリアント値を論理型項目に代入

次のコードはバリアント値を論理型項目に代入します。

MyBoolField.AsVariant := VariantVariable;

論理型項目の値をバリアント値に代入するには，次のようなコードを使います。

VariantVariant:= MyBoolField.AsVariant;

バリアントは，項目型もデータ形式も不明の場合に使うと便利です。


DataSize

DataSize プロパティは，ネイティブデータベース形式で論理型項目の値を格納するときに必要なメモリ容量です。

property DataSize: Word;

説明

DataSize プロパティを確認すると，論理型項目コンポーネントの値を格納するときに必要なバイト数がわかります。このプロパティを使うと，GetData メソッドおよび SetData メソッドを処理するときに必要なバッファサイズを決めることができます。GetData と SetData はネイティブデータベース形式で項目の値を処理します。

論理型項目の場合，論理値は WordBool 型でデータベーステーブルに格納されるので，DataSize は常に 2 です。この型は，TBooleanField が論理値を格納および操作するときに使う論理型とは異なります。


TBooleanField.DisplayValues
TBooleanField.DisplayValues3033008

TBooleanField	参照

DisplayValues プロパティは，論理型項目を表示形式に変換したり，その逆の変換をしたりする方法を制御します。

property DisplayValues: string;

説明

DisplayValues プロパティは，論理値を表す文字列を指定することができます。使用する文字列の組を，セミコロンで区切って指定します。たとえば，True および False の論理値をそれぞれ T および F という文字で表す場合は，DisplayValues プロパティを T;F と指定します。同様に，True および False に Yes および No をそれぞれ割り当てるには，DisplayValues プロパティを Yes;No に設定します。

True または False に空の文字列を関連付けることもできます。True に空の文字列を関連付けるには，DisplayValues プロパティの値としてセミコロンで始まる文字列を指定します。たとえば，True には空の文字列，False には Fail という文字列を関連付けるには，DisplayValues プロパティを ;Fail に設定します。False に空の文字列を関連付けるには，DisplayValues プロパティに True の文字列のみを指定して，その後にはセミコロンを付けません。

DisplayValues プロパティによって True および False と関連付けられた文字列は，データベース対応コントロールで論理型項目のデータを表示するときに使用されます。論理値に空の文字列が関連付けられている場合，データベース対応コントロールでは空白として表示されます。

これらの文字列は，論理型項目の AsString プロパティを取得したり設定したりするときにも使用されます。


TBooleanField.Value
TBooleanField.Value3033009

TBooleanField	参照

Value プロパティは，論理型項目の実際のデータです。

property Value: Boolean;

説明

Value プロパティは，実行時に論理型項目にデータを直接読み書きできます。Value プロパティを使うのは，AsBoolean プロパティを使うのと同じです。Value プロパティは，項目コンポーネントが論理型項目であることが分かっているときに使います。AsBoolean プロパティは，汎用項目コンポーネントを扱うときに使います。


TBooleanField イベント3033010

TBooleanField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TBooleanField イベント3033011

TBooleanField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TBooleanField メソッド3033012

TBooleanField	アルファベット順

TBooleanField

Create

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TBooleanField メソッド3033013

TBooleanField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TBooleanField.Create
TBooleanField.Create3033014

TBooleanField	参照

Create メソッドは，論理型項目オブジェクトのインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，TBooleanField オブジェクトのインスタンスを作成および初期化できます。継承コンストラクタを呼び出した後で，Create メソッドは DataType プロパティを ftBooleanに設定し，論理値と関連付けられた文字列を �True� および �False� に初期化します。

Create メソッドを直接呼び出す必要はほとんどありません。論理型項目オブジェクトはデータセット内のすべての論理型項目について自動的にインスタンス化されるからです。


スコープ3033015

published

読み出し／書き込み

読み出し専用


スコープ3033016

published


継承3033017

TObject

TPersistent

TComponent

TField


TBooleanField 例3033018

TBooleanField


TBrush
TBrush3034001

継承	プロパティ	メソッド	イベント

TBrush オブジェクトは色または模様を使って図形を塗りつぶします。

ユニット

graphics

説明

TBrush オブジェクトは Windows の HBRUSH 構造をカプセル化し，矩形や楕円などの図形を色または模様で塗りつぶします。


TBrush プロパティ3034002

TBrush	アルファベット順	凡例

TBrush

Bitmap

Color

Handle

Style

TGraphicsObject からの継承

OwnerCriticalSection


TBrush プロパティ3034003

TBrush	オブジェクト順	凡例

Bitmap

Color

Handle

OwnerCriticalSection

Style


TBrush.Bitmap
TBrush.Bitmap3034004

TBrush	参照

Bitmap プロパティは，ブラシの模様を定義した外部のビットマップイメージを示します。

property Bitmap: TBitmap;

説明

Bitmap プロパティは，BMP イメージを保持している TBitmap オブジェクトを示します。Bitmap プロパティがヌルでない限り，ブラシの模様は（Style プロパティではなく）このプロパティによって定義されます。このイメージは縦横が 8×8 ドットでなければなりません。

このイメージを変更しても，Bitmap プロパティに新たに TBitmap オブジェクトが代入されるまで，ブラシの模様は変わりません。TBrush オブジェクトはTBitmap オブジェクトを解放しないので，ブラシを使い終わったら必ず TBitmap オブジェクトを解放してください。


TBrush.Color
TBrush.Color3034005

TBrush	参照

Color プロパティは，ブラシの色を表します。

property Color: TColor default clWhite;

説明

Color プロパティによってブラシの色が決まります。


TBrush.Handle
TBrush.Handle3034006

TBrush

Handle プロパティは，ブラシの Windows ハンドルを指定します。

property Handle: HBrush;

説明

Handle プロパティによって Windows の GDI オブジェクトハンドルにアクセスできるようになります。


TBrush.Style
TBrush.Style3034007

TBrush	参照

Style プロパティは，ブラシの模様を指定します。

property Style: TBrushStyle default bsSolid;

説明

Bitmap プロパティに値が代入されていない場合，ブラシでペイントされる模様は Style プロパティで決まります。

値	パターン	値	パターン

bsSolid	bsCross

bsClear	bsDiagCross

bsBDiagonal	bsHorizontal

bsFDiagonal	bsVertical


TBrush イベント3034008

TBrush	アルファベット順

TGraphicsObject からの継承

OnChange


TBrush イベント3034009

TBrush	オブジェクト順

OnChange


TBrush メソッド3034010

TBrush	アルファベット順

TBrush

Assign

Create

Destroy

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TBrush メソッド3034011

TBrush	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TBrush.Assign
TBrush.Assign3034012

TBrush	参照

Assign メソッドは，ブラシの内容を別のブラシにコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドはブラシの内容を別の TBrush インスタンスにコピーします。


TBrush.Create
TBrush.Create3034013

TBrush

Create メソッドは，TBrush インスタンスを作成し，初期化します

constructor Create;

説明

Create メソッドは新しい TBrush インスタンスを生成します


TBrush.Destroy
TBrush.Destroy3034014

TBrush	参照

Destroy メソッドは，TBrush インスタンスを破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出してください。Free メソッドは，Destroy メソッドを呼び出す前に，TBrush インスタンスが破棄されていないことを確認します。


スコープ3034015

published


継承3034016

TObject

TPersistent

TGraphicsObject


TBrush 例3034017

TBrush


TButtonControl
TButtonControl3035001

継承	プロパティ	メソッド	参照

TButtonControl は Windows ボタンコントロールを表すオブジェクトの基本クラスです。

ユニット

stdctrls

説明

TButtonControl はボタンコントロール，チェックボックス，ラジオボタンに共通する動作をカプセル化します。


TButtonControl プロパティ3035002

TButtonControl	アルファベット順	凡例

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

、	ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObjcet


TButtonControl プロパティ3035003

TButtonControl	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

、	ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentWindow

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObjcet

Visible

Width

WindowProc


TButtonControl メソッド3035004

TButtonControl	アルファベット順	凡例

TButtonControl

WndProc

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

Create

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TButtonControl メソッド3035005

TButtonControl	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState

WndProc


TButtonControl.WndProc
TButtonControl.WndProc3035006

TButtonControl	参照

WndProc メソッドは，継承メソッドをオーバーライドしてボタンメッセージを処理します。

procedure WndProc(var Message: TMessage); override;

説明

WndProc メソッドによってボタンオブジェクトは，WM_LBUTTONDOWN メッセージおよび WM_LBUTTONDBLCLK メッセージが発生したときに入力フォーカスを得ることができます。


スコープ3035007

published

読み出し／書き込み

読み出し専用


スコープ3035008

protected


継承3035009

TObject

TPersistent

TComponent

TControl

TWinControl


TButtonControl 例3035010

TButtonControl


TButton
TButton3036001

継承	プロパティ	メソッド	イベント	参照

TButton は，押しボタンコントロールです。

ユニット

stdctrls

説明

ボタンコントロールを選択してアクションを開始します。ボタンはダイアログボックスでよく使用されるオブジェクトです。


TButton プロパティ3036002

TButton	アルファベット順	凡例

TButton

Cancel

Default

ModalResult

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TButton プロパティ3036003

TButton	オブジェクト順	凡例

Align

BoundsRect

Brush

Cancel

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

Default

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

Hint

Left

ModalResult

Name

Owner

Parent

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TButton.Cancel
TButton.Cancel3036004

TButton	参照

Cancel プロパティは，〔Esc〕キーが押されたときに OnClick イベントハンドラを実行するかどうかを決めます。

property Cancel: Boolean;

説明

Cancel プロパティが True の場合は〔Esc〕キーが押されるたびに OnClick イベントハンドラが実行されます。アプリケーションでは複数の Cancel ボタンを指定できますが，フォームはタブ順で最初に表示されているボタンについてだけ OnClick イベントハンドラを呼び出します。


TButton.Default
TButton.Default3036005

TButton	参照

Default プロパティは,，〔Enter〕キーが押されたときに OnClick イベントハンドラを実行するかどうかを決めます。

property Default: Boolean;

説明

Default プロパティが True の場合は〔Enter〕キーが押されるたびにそのボタンの OnClick イベントハンドラが実行されます。

アプリケーションでは複数の Default ボタンを指定できますが，フォームはタブ順で最初に表示されているボタンについてだけ OnClick ハンドラを呼び出します。さらに，どのボタンでもフォーカスがあれば，そのボタンが一時的にデフォルトボタンになるので，ユーザーが〔Enter〕キーを押す前に別のボタンを選択すると，そのボタンの OnClick ハンドラが代わりに実行されます。


TButton.ModalResult
TButton.ModalResult3036006

TButton	参照

ModalResult プロパティは，ボタンが（モード付き）親フォームを閉じるかどうか，またどのように閉じるかを指定します。

property ModalResult: TModalResult;

説明

TButton コンポーネントの ModalResult プロパティを設定すると，簡単にボタンクリックでモード付きフォームが閉じるようにできます。ボタンをクリックすると，親フォームの ModalResult プロパティはそのボタンの ModalResult プロパティと同じ値に設定されます。

たとえば，ダイアログボックスに〔OK〕と〔キャンセル〕の2つのボタンがある場合，それらのボタンの ModalResult プロパティは設計時にそれぞれ mrOk と mrCancel に設定することができます。設定すると実行時には，〔OK〕をクリックするダイアログボックスの ModalResult プロパティは mrOk に変わり，〔キャンセル〕をクリックするとダイアログボックスの ModalResult プロパティは mrCancel に変わります。それ以上処理が必要でない場合，そのボタンに OnClick イベントハンドラを記述する必要はありません。


TButton イベント3036007

TButton	アルファベット順	凡例

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TButton イベント3036008

TButton	オブジェクト順	凡例

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TButton メソッド3036009

TButton	アルファベット順

TButton

Click

Create

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TButton メソッド3036010

TButton	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Click

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TButton.Click
TButton.Click3036011

TButton	参照

Click メソッドは，マウスボタンをクリックしたときと同じ動作をシミュレートします。

procedure Click; override;

説明

Click メソッドを呼び出すと，ボタンの ModalResult プロパティの値が親フォームの ModalResult プロパティに割り当てられ，次に継承された Click メソッドが呼び出されます。


TButton.Create
TButton.Create3036012

TButton	参照

Create メソッドは，TButton のインスタンスを作成し初期化します。

onstructor Create(AOwner: TComponent); override;

説明

Create メソッドは，プログラムでボタンをインスタンス化するのに使います。Create メソッドは以下の処理を行います。

・	継承された Create メソッドを呼び出す

・	ボタンの ControlStyle フラグ（csSetCaption，csOpaque，csDoubleClicks）を設定する

・	Width を 75 ピクセル，Height を 25 ピクセルに設定する

・	TabStop プロパティを True に設定する


スコープ3036013

published

読み出し／書き込み

読み出し専用


スコープ3036014

published


継承3036015

TObject

TPersistent

TComponent

TControl

TWinControl

TButtonControl


TButton 例3036016

TButton


TBytesField
TBytesField3037001

継承	プロパティ	メソッド	イベント	参照

TBytesField オブジェクトはデータセット内のバイト項目を表します。

ユニット

db

説明

項目の値は，固定サイズの形式なしバイトの集合によって構成される値です。

TBytesField オブジェクトは，新しいプロパティ，イベント，およびメソッドは導入しません。このオブジェクトは DataSize プロパティと Create メソッドをオーバーライドして，ftBytes 型の項目の詳細を反映します。


TBytesField プロパティ3037002

TBytesField	アルファベット順	凡例

TBinaryField からの継承

AsVariant

Value

TField からの継承

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HastConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TBytesField プロパティ3037003

TBytesField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HastConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


DataSize

DataSize プロパティは，ネイティブデータベース形式で Bytes 項目の値を格納するときに必要なメモリ容量です。

property DataSize: Word;

説明

DataSize プロパティは，Bytes 項目コンポーネントの値を格納するときに必要なバイト数がわかります。GetData メソッドおよび SetData メソッドを処理するときに必要なバッファサイズを決めることができます。

Bytes 項目の場合，DataSize の値は Size プロパティと同じです。


TBytesField イベント3037005

TBytesField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TBytesField イベント3037006

TBytesField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TBytesField メソッド3037007

TBytesField	アルファベット順

TBytesField

Create

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TBytesField メソッド3037008

TBytesField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TBytesField.Create
TBytesField.Create3037009

TBytesField	参照

Create メソッドは，TBytesField のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出すと，TBytesField のインスタンスを作成および初期化できます。継承コンストラクタを呼び出した後で，Create は DataType プロパティの値を ftBytes に設定します。

Create を明示的に呼び出す必要はほとんどありません。データセット内のすべてのバイト項目について，バイト項目オブジェクトが自動的にインスタンス化されるからです。


スコープ3037010

published

読み出し／書き込み

読み出し専用


スコープ3037011

published


継承3037012

TObject

TPersistent

TComponent

TField

TBinaryField


TBytesField 例3037013

TBytesField


ECacheError
ECacheError3038001

継承	プロパティ	メソッド	参照

ECacheError は，デシジョンキューブのキャッシュを構築するときに発生したエラーの例外クラスです。

ユニット

mxstore

説明

ECacheError は次の場合に生成されます。

・	デシジョンキューブのデータセットの項目が多すぎる

・	デシジョンキューブのデータセットに，平均などの派生値を計算するために必要な集計値が入っていない

・	次元マップ内の次元項目が，日付項目または日付時刻項目を表さない次元に日付範囲を指定した


ECacheError のプロパティ3038002

ECacheError	アルファベット順

Exception からの継承

HelpContext

Message


ECacheError のプロパティ3038003

ECacheError	オブジェクト順

HelpContext

Message


ECacheError のメソッド3038004

ECacheError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


ECacheError のメソッド3038005

ECacheError	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3038006

TObject

Exception


ECacheError の例3038007

ECacheError


TCanvas
TCanvas3039001

継承	プロパティ	メソッド	イベント	参照

TCanvas は，オブジェクトが独自のイメージを表現するための抽象的な描画スペースを提供します。

ユニット

graphics

説明

TCanvas は，オブジェクトのイメージを描画するための描画表面として使います。編集コントロールやリストボックスなどの標準のウィンドウコントロールは，Windows による描画時にキャンバスを必要としません。

TCanvas は，以下の手段によるイメージの作成に役立つプロパティ，イベント，およびメソッドを提供します。

・	使用するブラシ，ペン，およびフォントの種類の指定

・	さまざまな図形や直線の描画や塗りつぶし

・	テキストの書き込み

・	グラフィックイメージの描画

・	現在のイメージにおける変更への対応

TCanvas には TControlCanvas および TMetafileCanvas という 2 つの下位オブジェクトがあり，各コントロールのイメージの描画や，オブジェクトのメタファイルイメージの作成を支援します。


TCanvas プロパティ3039002

TCanvas	アルファベット順	凡例

TCanvas

Brush

ClipRect

CopyMode

Font

Handle

LockCount

Pen

PenPos

Pixels


TCanvas プロパティ3039003

TCanvas	オブジェクト順	凡例

Brush

ClipRect

CopyMode

Font

Handle

LockCount

Pen

PenPos

Pixels


TCanvas.Brush
TCanvas.Brush3039004

TCanvas	参照

Brush プロパティは，キャンバスが図形と背景を塗りつぶすのに使う色と模様を指定します。

property Brush: TBrush;

説明

Brush プロパティは，背景の描画やグラフィック図形の塗りつぶしに使う色と模様を指定できます。Brush の値は TBrush オブジェクトです。キャンバスのスペースを塗りつぶすときに使う色と模様またはビットマップを指定するには，TBrush オブジェクトのプロパティを設定します。

注意

Brush プロパティを設定すると，現在の TBrush オブジェクトは置き換えられずに，指定した TBrush オブジェクトが割り当てられます。


TCanvas.ClipRect
TCanvas.ClipRect3039005

TCanvas	参照

ClipRect プロパティは，クリッピングする長方形の境界を指定します。

TRect = record

  case Integer of

    0: (Left, Top, Right, Bottom: Integer);

    1: (TopLeft, BottomRight: TPoint);

end;

property ClipRect: TRect;

説明

ClipRect プロパティは，キャンバスの描画領域を制限できます。ClipRect の外側の座標に描画したものはクリッピングされてイメージに表示されません。たとえば，大きな円の一部を小さなボックス内に描画するには，まずボックスを描画してから，次にそのボックスの内部の境界で指定される四角形に ClipRect を設定します。この状態で円全体を描画しても，ボックス内の部分だけしか表示されません。

フォームの OnPaint イベントを処理するときは，描画する必要がある四角形に対してキャンバスの ClipRect プロパティが設定されます。ClipRect に重ならないイメージ部分は描画する必要がありません。これによって，OnPaint ルーチンは ClipRect の値を使ってペイントを最適化して，アプリケーション全体の速度を高めることができます。


TCanvas.CopyMode
TCanvas.CopyMode3039006

TCanvas	参照

CopyMode プロパティは，グラフィックイメージをキャンバスにどのようにコピーするかを指定します。

property CopyMode: TCopyMode;

説明

CopyMode プロパティを設定すると，グラフィックイメージをキャンバスにどのように描画するかを指定できます。CopyMode は，CopyRect を使って他のキャンバスからイメージをコピーするときに使います。CopyMode は，TBitmap がそれ自体をキャンバスに描画するときにも使います。

CopyMode を使うと，イメージを描画するときにさまざまな効果を表現できます。たとえば，イメージを合成したり，異なる CopyMode で複数のイメージを結合してビットマップの一部を透過させるといった特殊効果を表現することができます。

以下に CopyMode の値と意味を示します。

値	意味

cmBlackness	キャンバス上のコピー先の四角形を黒色で塗りつぶす

cmDstInvert	キャンバス上のイメージを反転して，ソースを無視する

cmMergeCopy	AND 論理演算子を使ってキャンバス上のイメージとコピー元のビットマップを結合する

cmMergePaint	反転したコピー元ビットマップとキャンバス上のイメージを OR 論理演算子を使って結合する

cmNotSrcCopy	反転したコピー元ビットマップをキャンバスにコピーする

cmNotSrcErase	OR 論理演算子を使ってキャンバス上のイメージとコピー元のビットマップを結合して，その結果を反転する

cmPatCopy	コピー元の模様をキャンバスにコピーする

cmPatInvert	XOR 論理演算子を使ってコピー元の模様とキャンバス上のイメージを結合する

cmPatPaint	反転したコピー元ビットマップとその模様を OR 論理演算子を使って結合する。この演算結果とキャンバス上のイメージを OR 論理演算子を使って結合する

cmSrcAnd	キャンバス上のイメージとコピー元のビットマップを AND 論理演算子を使って結合する

cmSrcCopy	コピー元のビットマップをキャンバスにコピーする

cmSrcErase	キャンバス上のイメージを反転し，その結果とコピー元ビットマップを AND 論理演算子を使って結合する

cmSrcInvert	キャンバス上のイメージとコピー元のビットマップを XOR 論理演算子を使って結合する

cmSrcPaint	キャンバス上のイメージとコピー元ビットマップのピクセルを OR 論理演算子を使って結合する

cmWhiteness	キャンバス上のコピー先の四角形を白色で塗りつぶす


TCanvas.Font
TCanvas.Font3039007

TCanvas	参照

Font プロパティは，イメージ上にテキストを書くときに使うフォントを指定します。

property Font: TFont;

説明

Font プロパティは，イメージ上にテキストを書くときに使うフォントを指定できます。Font の値は TFont オブジェクトです。TFont オブジェクトのプロパティを設定すると，フォントの書体，色，サイズ，およびスタイルを指定できます。

注意

Font プロパティを設定すると，現在の TFont オブジェクトは置き換えられずに，指定した TFont オブジェクトが割り当てられます。


TCanvas.Handle
TCanvas.Handle3039008

TCanvas	参照

Handle プロパティは，キャンバスのデバイスコンテキストに渡される Windows GDI ハンドルです。

property Handle: HDC;

説明

Handle プロパティは，キャンバスが描画する必要があるデバイスコンテキスト HDC に設定します。ウィンドウコントロールが Windows のペイントメッセージに応答すると，描画用の HDC が PaintWindow メソッドに渡されます。それ以外の場合は，ウィンドウでコントロールの GetDeviceContext メソッドを呼び出して HDC を取得できます。また Windows では，プリンタ用またはメモリイメージ用の HDC を取得する API 呼び出しが提供されています。

Handle プロパティを読み出すと，デバイスコンテキストに渡すハンドルが必要な API 呼び出しに，TCanvas オブジェクトで提供される描画サービスを追加できます。ほとんどの場合，Windows GDI の呼び出しでは HDC が必要になります。

TCanvas は HDC を持たないので，アプリケーションは HDC を作成して Handle プロパティを設定する必要があります。また，キャンバスで HDC が不要になったときは，アプリケーションが HDC を解放する必要があります。すでに正規の HDC を持っているキャンバスの Handle プロパティを設定しても，最初の HDC の解放は自動的には行われません。

注意

TControlCanvas などの TCanvas の下位オブジェクトは HDC を持ちます。このようなオブジェクトには Handle プロパティを設定しないでください。これらのオブジェクトは独自の Handle を取り出して解放します。


TCanvas.LockCount
TCanvas.LockCount3039009

TCanvas	参照

LockCount プロパティは，他のスレッドからの干渉を防ぐためにキャンバスがロックされた回数を示します。

property LockCount: Integer;

説明

LockCount プロパティは，キャンバスがロックされているかどうかを取得できます。他のスレッドによるキャンバスへの干渉を防ぐために Lock メソッドが呼び出されると，LockCount が増加します。クリティカルセクションの最後で Unlock メソッドが呼び出されると，LockCount が減少します。LockCount が 0 ならば，他のスレッドはキャンバス上に描画できます。


TCanvas.Pen
TCanvas.Pen3039010

TCanvas	参照

Pen プロパティは，キャンバスが線とアウトライン形状の描画に使うペンの種類を指定します。

property Pen: TPen;

説明

Pen プロパティを設定すると，線とアウトライン形状のイメージ描画に使うペンの種類を指定できます。Pen の値は TPen オブジェクトです。TPen オブジェクトのプロパティを設定すると，ペンの色，スタイル，幅，およびモードを指定できます。

注意

Pen プロパティを設定すると，現在の TPen オブジェクトは置き換えられずに，指定した TPen オブジェクトが割り当てられます。


TCanvas.PenPos
TCanvas.PenPos3039011

TCanvas	参照

PenPos プロパティは，Pen の現在の描画位置を指定します。

TPoint = record

  X: Longint;

  Y: Longint;

end;

property PenPos: TPoint;

説明

PenPos プロパティは，Pen の現在の描画位置を取得できます。これは LineTo メソッドで描画する線の始点です。PenPos プロパティを設定することは，MoveTo メソッドを呼び出すことと同じです。


TCanvas.Pixels
TCanvas.Pixels3039012

TCanvas	参照

Pixels プロパティは，現在の ClipRect 内のピクセルの色を指定します。

property Pixels[X, Y: Integer]: TColor;

説明

Pixels プロパティは，描画表面にある特定のピクセル位置の色を取得できます。Pixels を記述すると，描画表面で個々のピクセルの色を変更できます。また，Pixels を使うとイメージ上で詳細な効果を表現できます。Pixels は，FillRect メソッドで使う色を決めるためにも使います。

Pixels の値は TColor です。Handle で示されるデバイスがこの値をサポートする場合は，任意の 4 バイトの RGB 値となります。Graphics ユニットで定義された定数を使わずに TColor を RGB 値で指定する場合，下位の 3 バイトはそれぞれ青，緑，赤の RGB カラーの輝度を表します。$00FF0000 という値は最高の輝度，つまり純色の青を示し，$0000FF00 は純色の緑を示し，$000000FF は純色の赤を示します。$00000000 は黒，$00FFFFFF は白です。

最上位バイトが 0（$00）の場合，得られる色はシステムパレットで最も近い色になります。最上位バイトが 1（$01）の場合，現在のパレットで最も近い色になります。最上位バイトが 2（$02）の場合，現在のデバイスコンテキストの論理パレットで最も近い色になります。

以下に Graphics ユニットで定義される collow 値の定数を示します。

値	意味

clBlack	黒色

clMaroon	栗色

clGreen	緑色

clOlive	黄緑色

clNavy	濃紺色

clPurple	紫色

clTeal	暗青緑色

clGray	灰色

clSilver	銀色

clRed	赤色

clLime	濃緑色

clBlue	青色

clFuchsia	赤紫色

clAqua	空色

clWhite	白色

clBackground	Windows デスクトップの現在の背景色

clActiveCaption	アクティブウィンドウのタイトルバーの現在の色

clInactiveCaption	アクティブでないウィンドウのタイトルバーの現在の色

clMenu	メニューの現在の背景色

clWindow	ウィンドウの現在の背景色

clWindowFrame	ウィンドウ枠の現在の色

clMenuText	メニュー上のテキストの現在の色

clWindowText	ウィンドウ内のテキストの現在の色

clCaptionText	アクティブウィンドウのタイトルバー上のテキストの現在の色

clActiveBorder	アクティブウィンドウの現在の境界色

clInactiveBorder	アクティブでないウィンドウの現在の境界色

clAppWorkSpace	アプリケーション作業領域の現在の色

clHighlight	選択したテキストの現在の背景色

clHightlightText	選択したテキストの現在の色

clBtnFace	ボタン面の現在の色

clBtnShadow	ボタンの影の現在の色

clGrayText	淡色表示されているテキストの現在の色

clBtnText	ボタン上のテキストの現在の色

clInactiveCaptionText	アクティブでないウィンドウのタイトルバー上のテキストの現在の色

clBtnHighlight	ボタンの強調表示の現在の色

cl3DDkShadow 	Windows 95 と NT 4.0 のみ。3 次元表示要素の暗い色

cl3DLight 	Windows 95 と NT 4.0 のみ。3 次元表示要素の明るい色（明るい面の縁用）

clInfoText 	Windows 95 と NT 4.0 のみ。ツールチップコントロールのテキストの色

clInfoBk 	Windows 95 と NT 4.0 のみ。ツールチップコントロールの背景色

すべてのデバイスコンテキストが Pixels プロパティをサポートしているわけではありません。Pixels プロパティをサポートしていないデバイスコンテキストの Pixels プロパティを読み出すと，値 -1 が返されます。このようなデバイスコンテキストの Pixels プロパティを設定しても効果はありません。

注意

Pixels プロパティは，ClipRect の現在の値で指定される範囲内のピクセルにのみ有効です。


TCanvas イベント3039013

TCanvas	アルファベット順

TCanvas

OnChange

OnChanging


TCanvas イベント3039014

TCanvas	オブジェクト順

OnChange

OnChanging


TCanvas.OnChange
TCanvas.OnChange3039015

TCanvas	参照

OnChange イベントは，イメージが変更されたときに発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラを記述すると，キャンバス上のイメージが変更されたときに特定のアクションを実行できます。アプリケーションが TCanvas の描画メソッドの 1 つを呼び出すと，以下の処理が行われます。

1.	OnChanging イベントが発生する

2.	TCanvas メソッドがイメージを変更する

3.	OnChange イベントが発生する

OnChange イベントはイメージが変更されると発生し，キャンバスのプロパティが変更されても発生しません。アプリケーションが Font，Brush，および Pen の各プロパティの変更に応答できるようにするには，OnChange イベントハンドラをそれぞれ対応する TFont，TBrush，および TPen オブジェクトに割り当てます。一方，TCanvas は独自の OnChange イベントハンドラをこれらのオブジェクトに割り当てます。OnChange イベントハンドラをこれらのオブジェクトの 1 つに割り当てる場合は、その前に既存のイベントハンドラを読み出してください。その値を使って，新しいイベントハンドラから TCanvas イベントハンドラを呼び出します。


TCanvas.OnChanging
TCanvas.OnChanging3039016

TCanvas	参照

OnChanging イベントは，イメージが変更される直前に発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnChanging: TNotifyEvent;

説明

OnChanging イベントハンドラを記述すると，キャンバス上のイメージが変更される前に特定のアクションを実行できます。アプリケーションが TCanvas の描画メソッドの 1 つを呼び出すと，以下の処理が行われます。

1.	OnChanging イベントが発生する

2.	TCanvas メソッドがイメージを変更する

3.	OnChange イベントが発生する


TCanvas メソッド3039017

TCanvas	アルファベット順

TCanvas

Arc

BrushCopy

Chord

CopyRect

Create

Destroy

Draw

DrawFocusRect

Ellipse

FillRect

FloodFill

FrameRect

LineTo

Lock

MoveTo

Pie

Polygon

Polyline

Rectangle

Refresh

RoundRect

StretchDraw

TextExtent

TextHeight

TextOut

TextRect

TextWidth

TryLock

Unlock

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCanvas メソッド3039018

TCanvas	オブジェクト順

Arc

Assign

BrushCopy

Chord

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyRect

Create

DefaultHandler

Destroy

Dispatch

Draw

DrawFocusRect

Ellipse

FieldAddress

FillRect

FloodFill

FrameRect

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LineTo

Lock

MethodAddress

MethodName

MoveTo

NewInstance

Pie

Polygon

Polyline

Rectangle

Refresh

RoundRect

SafeCallException

StretchDraw

TextExtent

TextHeight

TextOut

TextRect

TextWidth

TryLock

Unlock


TCanvas.Arc
TCanvas.Arc3039019

TCanvas	参照

Arc メソッドは，指定した四角形と境を接する楕円の縁にそって弧をイメージ上に描画します。

procedure Arc(X1, Y1, X2, Y2, X3, Y3, X4, Y4: Integer);

説明

Arc メソッドを呼び出すと，楕円状に曲がった線を現在の Pen で描画できます。弧は，座標（X1, Y1）および（X2, Y2）と境界を接する楕円の縁と交差します。弧は，楕円の縁にそって始点から終点まで反時計回りに描画されます。始点は，楕円の中心点と座標（X3,Y3）によって指定される線と楕円との交点で指定できます。終点は，楕円の中心点と座標（X4,Y4）によって指定される線と楕円との交点で指定できます。

注意

Windows 95 では，X1 + X2 および Y1 + Y2 の合計は 32768 以下でなければなりません。また，X1 + X2 + Y1 + Y2 の合計は 32768 以下でなければなりません。

NT では Windows API 呼び出し SetArcDirection を使って，描画の方向を時計回りに変更できます。


TCanvas.BrushCopy
TCanvas.BrushCopy3039020

TCanvas	参照

BrushCopy メソッドは，ビットマップの一部をキャンバスの一部にコピーし，ビットマップの色の 1 つをコピー先キャンバスのブラシで置換します。

TRect = record

  case Integer of

    0: (Left, Top, Right, Bottom: Integer);

    1: (TopLeft, BottomRight: TPoint);

end;

procedure BrushCopy(const Dest: TRect; Bitmap: TBitmap; const Source: TRect; Color: TColor);

説明

BrushCopy メソッドを呼び出すと，コピーしたイメージを部分的に透過させるといった特殊効果を表現できます。BrushCopy は主に下位互換性のために提供されています。BrushCopy ではなく TImageList を使ってください。

Dest パラメータはビットマップのコピー先となるキャンバス上の長方形部分を指定します。Bitmap パラメータはコピーするグラフィックを指定します。Source パラメータはビットマップのどの長方形部分をコピーするかを指定します。Color パラメータは Bitmap のどの色をキャンバスの Brush で置換するかを指定します。

BrushCopy プロパティはコピーするイメージを部分的に透過色にできます。部分的に透過色にするには，キャンバスの表面（clBackground など）の色を Brush プロパティの Color として指定してから BrushCopy を呼び出します。

Color パラメータに指定できる値についての詳細は，「Pixels プロパティ」の項を参照してください。


TCanvas.Chord
TCanvas.Chord3039021

TCanvas	参照

Chord メソッドは，線と楕円の交点で表現される閉じた図形を描画します。

procedure Chord(X1, Y1, X2, Y2, X3, Y3, X4, Y4: Integer);

説明

Chord メソッドを呼び出すと，弧の両端で結合する弧と直線で定義される図形を作成できます。弓形は，座標（X1,Y1）および（X2,Y2）と境界を接する楕円の一部で構成されます。楕円は，座標（X3,Y3）および（X4,Y4）の間を通過するで線によって 2 等分されます。

弓形は（X3, Y3）から始まり，反時計回りに楕円にそって（X4,Y4）を通り，まっすぐ（X3,Y3）に戻ります。(X3,Y3）および（X4,Y4）が楕円上にない場合は，弓形の対応する角は線と交差する縁上で最も近い座標となります。弓形のアウトラインは Pen の値で描画され，その図形は Brush の値で塗りつぶされます。

注意

Windows 95 では，X1 + X2 および Y1 + Y2 の合計は 32768 以下でなければなりません。また，X1 + X2 + Y1 + Y2 の合計は 32768 以下でなければなりません。

NT では Windows API 呼び出し SetArcDirection を使って，描画の方向を時計回りに変更できます。


TCanvas.CopyRect
TCanvas.CopyRect3039022

TCanvas	参照

CopyRect メソッドは，キャンバスのイメージの一部を別のキャンバスにコピーします。

TRect = record

  case Integer of

    0: (Left, Top, Right, Bottom: Integer);

    1: (TopLeft, BottomRight: TPoint);

end;

procedure CopyRect(Dest: TRect; Canvas: TCanvas; Source: TRect);

説明

CopyRect メソッドを呼び出すと，別のキャンバス上のイメージの一部を TCanvas オブジェクトのイメージに転送できます。Dest は，イメージがコピーされるキャンバス上の長方形を指定します。Canvas パラメータは，コピー元イメージが存在するキャンバスを指定します。Source は，コピー元キャンバスの領域に接する長方形を指定します。

コピー元キャンバスの領域は，CopyMode で指定したモードでコピーされます。


TCanvas.Create
TCanvas.Create3039023

TCanvas	参照

Create メソッドは，TCanvas のインスタンスを作成します。

constructor Create;

説明

Create メソッドを呼び出すと，TCanvas オブジェクトをインスタンス化できます。Create は，TCanvas のインスタンスにメモリを割り当てて，Font，Brush，および Pen の各プロパティに対して TFont，TBrush，および TPen の各オブジェクトを作成します。また，Create は CopyMode を cmSrcCopy に初期化します。


TCanvas.Destroy
TCanvas.Destroy3039024

TCanvas	参照

Destroy メソッドは，TCanvas のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出すことはせずに，Free メソッドを呼び出すようにしてください。Free メソッドは TCanvas オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは，Brush，Font，および Pen の各プロパティに対して作成された TBrush，TFont，および TPen の各オブジェクトを解放します。その後，Destroy は TCanvas オブジェクトに割り当てていたメモリを解放します。


TCanvas.Draw
TCanvas.Draw3039025

TCanvas	参照

Draw メソッドは，Graphic パラメータで指定したグラフィックを，座標（X, Y）で定義されるキャンバス上の位置に描画します。

procedure Draw(X, Y: Integer; Graphic: TGraphic);

説明

Draw メソッドを呼び出すと，キャンバスにグラフィックを描画できます。Draw はグラフィックの Draw メソッドを呼び出します。イメージは，グラフィックのサイズで定義される四角形に座標（X, Y）を左上隅として描画されます。

グラフィックはビットマップ，アイコン，メタファイルのいずれかです。グラフィックが TBitmap オブジェクトの場合，ビットマップは CopyMode の値を使って描画されます。


TCanvas.DrawFocusRect
TCanvas.DrawFocusRect3039026

TCanvas	参照

DrawFocusRect メソッドは，四角形内のオブジェクトがフォーカスを受け取ったことを示すのに使うスタイルで四角形を描画します。

procedure DrawFocusRect(const Rect: TRect);

説明

DrawFocusRect メソッドは，コントロールが入力フォーカスを取得または喪失したときに，コントロールのイメージの縁に対して呼び出します。DrawFocusRect は XOR 関数を使うので，同じ四角形を指定するときに DrawFocusRect をもう 1 度呼び出すと，画面から四角形が消去されます。

この関数で描画される四角形はスクロールできません。DrawFocusRect で描画される四角形を含む領域をスクロールするには，DrawFocusRect を呼び出して画面から四角形を削除し，領域をスクロールしてから DrawFocusRect を呼び出して四角形を新しい位置に描画します。


TCanvas.Ellipse
TCanvas.Ellipse3039027

TCanvas	参照

Ellipse メソッドは，外接長方形で定義される楕円をキャンバスに描画します。

procedure Ellipse(X1, Y1, X2, Y2: Integer);

説明

Ellipse を呼び出すと，キャンバスに円や楕円を描画できます。外接長方形の左上の座標は，ピクセル座標の（X1, Y1）であり，右下の座標は（X2, Y2）です。長方形の座標が正方形を形成する場合は，円が描画されます。

楕円のアウトラインは Pen の値を使って描画され，内部は Brush の値を使って塗りつぶされます。

注意

Windows 95 では，X1 + X2 および Y1 + Y2 の合計は 32768 以下でなければなりません。また，X1 + X2 + Y1 + Y2 の合計は 32768 以下でなければなりません。


TCanvas.FillRect
TCanvas.FillRect3039028

TCanvas	参照

FillRect メソッドはキャンバス上の指定した四角形を現在のブラシで塗りつぶします。

procedure FillRect(const Rect: TRect);

説明

FillRect メソッドを呼び出すと，現在のブラシを使って四角形の領域を塗りつぶすことができます。指定の領域を塗りつぶす場合，四角形の左と上の端は領域に含まれますが，右と下の端は含まれません。


TCanvas.FloodFill
TCanvas.FloodFill3039029

TCanvas	参照

FloodFill メソッドは，現在のブラシを使ってキャンバス上の領域を塗りつぶします。

TFillStyle = (fsSurface, fsBorder);

procedure FloodFill(X, Y: Integer; Color: TColor; FillStyle: TFillStyle);

説明

FloodFill メソッドを呼び出すと，イメージの四角形以外の領域を Brush の値で塗りつぶすことができます。塗りつぶす領域の境界は，座標（X, Y）から Color パラメータで指定する色境界までの範囲として定義されます。

以下に FillStyle による色の変化と境界の定義の関係を示します。

値	意味

fsSurface	Color パラメータで指定した色を持つすべての領域を塗りつぶす。別の色に達した場合は塗りつぶしを中止する

fsBorder	Color パラメータで指定した色以外の色を持つすべての領域を塗りつぶす。Color パラメータで指定した色に達した場合は塗りつぶしを中止する

Pixels プロパティを使うと，fsSurface の FillStyle を使うときに，座標（X, Y）の色の正確な値を取得できます。同様に，FillStyle が fsBorder のときは，境界の座標がわかっている場合に，Pixels を使って境界色の正確な値を取得できます。


TCanvas.FrameRect
TCanvas.FrameRect3039030

TCanvas	参照

FrameRect メソッドは，境界を作成するキャンバスのブラシを使って長方形を描画します。

procedure FrameRect(const Rect: TRect);

説明

FrameRect メソッドを呼び出すと，長方形の周囲に 1 ピクセル幅の境界線を描画できます。FrameRect は，長方形の内部を Brush の模様で塗りつぶしません。

FrameRect のかわりに Pen を使って境界を描画するには，Polygon メソッドを使います。


TCanvas.LineTo
TCanvas.LineTo3039031

TCanvas	参照

LineTo メソッドは，PenPos プロパティで指定されるキャンバス上の位置から，X と Y で指定される座標まで線を引き，ペン位置を（X, Y）に設定します。

procedure LineTo(X, Y: Integer);

説明

LineTo メソッドを呼び出すと，PenPos プロパティで指定される位置から，座標（X, Y）を除外して線を引くことができます。LineTo は PenPos の値を（X, Y）に変更します。

線は Pen を使って描画されます。


TCanvas.Lock
TCanvas.Lock3039032

TCanvas	参照

Lock メソッドは，他のスレッドがキャンバスに描画できないようにします。

procedure Lock;

説明

マルチスレッドアプリケーションで Lock メソッドを呼び出すと，他のスレッドがキャンバスに描画できないようにすることができます。Lock は，Unlock メソッドが呼び出されるまでアプリケーション内の他のすべてのスレッドが実行できないようにします。ネストした Lock の呼び出しは LockCount プロパティを増加させるので，最後のロックが解放されるまでキャンバスのロックは解除されません。

Lock は他のすべてのスレッドを実行できなくするので，処理効率に悪影響をおよぼすことがあります。他のスレッドがキャンバスの描画に干渉するおそれがある場合以外は Lock を呼び出さないでください。


TCanvas.MoveTo
TCanvas.MoveTo3039033

TCanvas	参照

MoveTo メソッドは，現在の描画位置を座標（X, Y）に変更します。

procedure MoveTo(X, Y: Integer);

説明

MoveTo メソッドを呼び出すと，LineTo を呼び出す前に PenPos の値を設定できます。MoveTo を呼び出すことは，PenPos プロパティを設定することと同じです。


TCanvas.Pie
TCanvas.Pie3039034

TCanvas	参照

Pie メソッドは，キャンバス上の四角形（X1, Y1）と（X2, Y2）に外接する楕円の扇形を描画します。

procedure Pie(X1, Y1, X2, Y2, X3, Y3, X4, Y4: Longint);

説明

Pie メソッドを呼び出すと，イメージの扇形を描画できます。扇形は，座標（X1, Y1）と（X2, Y2）で形成される長方形と外接する楕円によって定義されます。描画される扇形の形は，楕円の中心から始まって座標（X3, Y3）と（X4, Y4）を通過する 2 つの線で決まります。

くさび形のアウトラインは Pen で描画され，内部は Brush で塗りつぶされます。

注意

Windows 95 では，X1 + X2 および Y1 + Y2 の合計は 32768 以下でなければなりません。また，X1 + X2 + Y1 + Y2 の合計は 32768 以下でなければなりません。


TCanvas.Polygon
TCanvas.Polygon3039035

TCanvas	参照

Polygon メソッドは，与えられた点を結んでキャンバス上に一連の線を描画してから，最後の点から最初の点へ線を描画して閉じた図形にします。

TPoint = record

  X: Longint;

  Y: Longint;

end;

procedure Polygon(Points: array of TPoint);

説明

Polygon メソッドを呼び出すと，Pen の値を使ってキャンバス上に閉じた多角形を描画できます。図形が完成すると，Polygon は Brush の値を使ってその図形を塗りつぶします。

キャンバスに多角形を塗りつぶさずに描画するには，Polyline メソッドを使って，最後に始点をもう一度指定します。

Slice 関数を使うと点の配列の一部を Polygon メソッドに渡すことができます。たとえば，点が 100 個ある配列の最初の 10 個の点で多角形を構成するには，次のように Slice 関数を使います。

Canvas.Polygon.(Slice(PointArray, 10));


TCanvas.Polyline
TCanvas.Polyline3039036

TCanvas	参照

PolyLine メソッドは，現在のペンを使って，Points で渡された個々の点を結んでキャンバス上に連続線を描画します。

procedure Polyline(Points: array of TPoint);

説明

Polyline メソッドを呼び出すと，キャンバス上の各点を結ぶことができます。点が 2 つしかない場合，Polyline は 1 本の線を引きます。

最初の点の値で MoveTo 関数を呼び出して，連続する各点で LineTo を繰り返し呼び出すと，キャンバス上に同じイメージが描画されます。Polyline は LineTo とは違って PenPos の値は変更しません。

Slice 関数を使うと点の配列の一部を Polyline メソッドに渡すことができます。たとえば，点が 100 個ある配列の最初の 10 個の点を結ぶには，次のように Slice 関数を使います。

Canvas.Polyline.(Slice(PointArray, 10));


TCanvas.Rectangle
TCanvas.Rectangle3039037

TCanvas	参照

Rectangle メソッドは，点（X1, Y1）を左上隅，点（X2, Y2）を右下隅としてキャンバス上に長方形を描画します。

procedure Rectangle(X1, Y1, X2, Y2: Integer);

説明

Rectangle メソッドを呼び出すと，Pen を使って長方形を描画して，その図形を Brush で塗りつぶすことができます。現在のペンで境界を描画しないで長方形部分を塗りつぶすには FillRect を使います。長方形部分を塗りつぶさずに外枠を描画するには FrameRect または Polygon を使います。角の丸い長方形を描画するには RoundRect を使います。


TCanvas.Refresh
TCanvas.Refresh3039038

TCanvas	参照

Refresh メソッドは，デバイスコンテキストでの Pen，Brush，および Font の選択を解除します。

procedure Refresh;

説明

Refresh メソッドを呼び出すと，キャンバスで使う HDC をデフォルト状態に戻すことができます。Refresh は Font，Brush，または Pen の各プロパティの値は変更しません。Refresh を呼び出してからキャンバスのいずれかの描画メソッドを呼び出すと，描画メソッドで HDC が使われている場合に Font，Brush，または Pen が HDC で再設定されます。


TCanvas.RoundRect
TCanvas.RoundRect3039039

TCanvas	参照

RoundRect メソッドは，角の丸い長方形をキャンバス上に描画します。

procedure Rectangle(X1, Y1, X2, Y2: Integer);

説明

RoundRect メソッドを呼び出すと，角の丸い長方形を Pen で描画して，その図形を Brush で塗りつぶすことができます。長方形の端は座標（X1, Y1），（X2, Y1），（X2, Y2），（X1, Y2）で定義されますが，その角は丸く削られます。

長方形ではなく楕円を描画するには Ellipse を使います。正方形を描画するには Rectangle を使います。


TCanvas.StretchDraw
TCanvas.StretchDraw3039040

TCanvas	参照

StretchDraw メソッドは，Rect パラメータで指定した四角形の中に Graphic パラメータで指定したグラフィックを描画します。

procedure StretchDraw(const Rect: TRect; Graphic: TGraphic );

説明

StretchDraw メソッドを呼び出すと，指定した四角形にイメージが収まるようにキャンバス上にグラフィックを描画できます。StretchDraw はグラフィックの Draw メソッドを呼び出します。グラフィックオブジェクトはイメージの四角形への収め方を指定します。これにより，イメージの伸縮率や縦横比が変更される場合もあります。

グラフィックを実際のサイズで描画するには，StretchDraw ではなく Draw メソッドを使います。

グラフィックはビットマップ，アイコン，メタファイルのいずれかです。グラフィックが TBitmap オブジェクトの場合，ビットマップは CopyMode の値を使って描画されます。


TCanvas.TextExtent
TCanvas.TextExtent3039041

TCanvas	参照

TextExtent メソッドは，現在のフォントで描画された文字列の幅と高さ（ピクセル数）を返します。

TSize = record

    cx: Longint;

    cy: Longint;

  end;

function TextExtent(const Text: string): TSize;

説明

TextExtent メソッドを呼び出すと，文字列がイメージ内で占有するスペースを指定できます。線，ボックス，または追加のテキスト行など，イメージ内のその他の要素はテキストのサイズに対応するように配置されます。

高さだけを調べるには，TextHeight を呼び出します。幅だけを調べるには，TextWidth を呼び出します。


TCanvas.TextHeight
TCanvas.TextHeight3039042

TCanvas	参照

TextHeight は，現在のフォントで描画された文字列の高さをピクセル単位で返します。

function TextHeight(const Text: string): Integer;

説明

TextHeight メソッドを呼び出すと，文字列がイメージ内で占有する高さを指定できます。線，ボックス，または追加のテキスト行など，イメージ内のその他の要素はテキストの高さに対応するように配置されます。

TextHeight が返す値は TextExtent(Text).cy と同じです。


TCanvas.TextOut
TCanvas.TextOut3039043

TCanvas	参照

TextOut メソッドは，キャンバス上に座標（X, Y）から文字列を描画して，PenPos の値を文字列の最後の値に更新します。

procedure TextOut(X, Y: Integer; const Text: string);

説明

TextOut メソッドを呼び出すと，キャンバスに文字列を書き込むことができます。文字列は現在の Font 値に応じて書き込まれます。TextExtent メソッドを使うと，イメージ内のテキストが占有するスペースを指定できます。クリッピングする四角形に収まるテキストだけを書き込むには，TextOut のかわりに TextRect を使います。


TCanvas.TextRect
TCanvas.TextRect3039044

TCanvas	参照

TextRect メソッドは，クリッピングする四角形に文字列を書き込みます。

procedure TextRect(Rect: TRect; X, Y: Integer; const Text: string);

説明

TextRect メソッドを呼び出すと，限定された四角形の領域内に文字列を書き込むことができます。Rect パラメータで渡される四角形の外にはみ出してしまう文字列部分はクリッピングされ，画面上には表示されません。テキストの左上隅の位置は点（X, Y）になります。


TCanvas.TextWidth
TCanvas.TextWidth3039045

TCanvas	参照

TextWidth メソッドは，現在のフォントで描画された文字列の幅をピクセル単位で返します。

function TextWidth(const Text: string): Integer;

説明

TextWidth メソッドを呼び出すと，文字列がイメージ内で占有する長さを指定できます。TextWidth は，指定した文字列が有効スペース内に収まるかどうかを示します。線や追加の文字列など，イメージ内のその他のグラフィック要素はテキストの幅に対応するように配置されます。

TextWidth が返す値は TextExtent(Text).cx と同じです。


TCanvas.TryLock
TCanvas.Trylock3039046

TCanvas	参照

Trylock メソッドは，現在ロックれていないキャンバスをロックします。。

function TryLock: Boolean;

説明

TryLock メソッドを呼び出すと，Unlock メソッドを呼び出さない限り，他の実行スレッドがキャンバス上に書き込めないようにできます。Lock メソッドを呼び出した場合は，それに対応する Unlock メソッドを呼び出さなければなりません。これに対し TryLock メソッドは，キャンバスがロックされていなければ，Unlock を 1 回呼び出すだけで済みます。

キャンバスがロックされていない場合は，TryLock はそのキャンバスをロックします。次に，LockCount プロパティを 1 に設定して True を返します。キャンバスがすでにロックされている場合，TryLock は False を返すだけです。

Lock と Unlock の呼び出しによって保護されている他のコードとインターフェースをとるキャンバスに対して変更を加える場合は，まず，TryLock を呼び出してから行ってください。


TCanvas.Unlock
TCanvas.Unlock3039047

TCanvas	参照

Unlock メソッドは，LockCount プロパティをデクリメントして，ゼロになったときに他のスレッドで実行できるようにします。

procedure Unlock;

説明

Unlock メソッドは，Lock メソッドの呼び出しで始まったクリティカルセクションの最後で呼び出します。Lock を呼び出すときは必ず Unlock を対にして呼び出す必要があります。


スコープ3039048

published

読み出し／書き込み

読み出し専用


継承3039049

TObject

TPersistent


TCanvas 例3039050

TCanvas


TCustomDecisionGraph
TCustomDecisionGraph3040001

継承	プロパティ	メソッド	イベント	参照

TCustomDecisionGraph は，クロス集計されたデータをグラフ化するコントロールの基本クラスです。

ユニット

mxgraph

説明

TCustomDecisionGraph は，デシジョンソースからのデータをグラフ化するオブジェクトを定義するときに基本クラスとして使います。デシジョングラフは，多数の次元を元に計算された 1 つの集計をグラフで表します。次元はグラフの軸として表示されます。

集計される項目と集計の基になる項目（次元）は，デシジョンキューブの次元マップから選択された集計および次元の構成を見るために，実行時に動的に変更できます。次元および集計に対する変更は TDecisionPivot オブジェクトを使って開始できます。

TCustomDecisionGraph のインスタンスは作成しないでください。デシジョングラフをフォームに配置するには，TDecisionGraph を使います。


TCustomDecisionGraph プロパティ3040002

TCustomDecisionGraph	アルファベット順	凡例

TCustomDecisionGraph

DecisionSource

SaveSeries

TChart からの継承

AllowPanning

AllowZoom

AnimatedZoom

AnimatedZoomSteps

BackImage

BackImageInside

BackImageMode

BottomWall

Foot

Gradient

LeftWall

PrintResolution

Title

Zoomed

TCustomChart からの継承

AxisVisible

BackColor

BottomAxis

BufferedDisplay

Chart3DPercent

ClipPoints

Frame

LeftAxis

Legend

MarginBottom

MarginLeft

MarginRight

MarginTop

MaxPointsPerPage

Monochrome

Page

RightAxis

ScaleLastPage

Series

SeriesList

TopAxis

View3d

View3dWalls

TCustomTeePanel からの継承

Canvas

TCustomPanel からの継承

BevelInner

BevelOuter

BevelWidth

BorderStyle

BorderWidth

Locked

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomDecisionGraph プロパティ3040003

TCustomDecisionGraph	オブジェクト順	凡例

Align

AllowPanning

AllowZoom

AnimatedZoom

AnimatedZoomSteps

AxisVisible

BackColor

BackImage

BackImageInside

BackImageMode

BevelInner

BevelOuter

BevelWidth

BorderStyle

BorderWidth

BottomAxis

BottomWall

BoundsRect

Brush

BufferedDisplay

Canvas

Chart3DPercent

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ClipPoints

Color

ComObject

ComponentCount

ComponentIndex

ComponentState

Components

ComponentStyle

ControlCount

ControlState

Controls

ControlStyle

Ctl3D

Cursor

DecisionSource

DesignInfo

DragCursor

DragMode

Enabled

Foot

Frame

Gradient

Handle

Height

HelpContext

Hint

LeftAxis

Left

LeftWall

Legend

Locked

MarginBottom

MarginLeft

MarginRight

MarginTop

MaxPointsPerPage

Monochrome

Name

Owner

Page

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

Parent

ParentWindow

PopupMenu

PrintResolution

RightAxis

SaveSeries

ScaleLastPage

Series

SeriesList

ShowHint

Showing

TabOrder

TabStop

Tag

Title

TopAxis

Top

VCLComObject

View3d

View3dWalls

Visible

Width

WindowProc

Zoomed


TCustomDecisionGraph.DecisionSource
TCustomDecisionGraph.DecisionSource3040004

TCustomDecisionGraph	参照

DecisionSource プロパティは，デシジョングラフにデータ値を供給するデシジョンソースオブジェクトです。

property DecisionSource: TDecisionSource;

説明

DecisionSource プロパティを設定すると，デシジョングラフをデシジョンキューブからのクロス集計データにリンクできます。DecsionSource オブジェクトは現在のデータのピボット状態についての情報を保持します。したがって，同じデシジョンソースを共有する 2 つのデシジョンコントロールは，閉じた次元またはドリルドダウンされた値など，同じ次元の設定を使ってデシジョンキューブからのデータを表示します。


TCustomDecisionGraph イベント3040006

TCustomDecisionGraph	アルファベット順	凡例

TChart からの継承

OnAllowScroll

OnClickAxis

OnClickBackground

OnClickLegend

OnClickSeries

OnGetLegendPos

OnGetLegendRect

OnScroll

OnUndoZoom

OnZoom

TCustomChart からの継承

OnAfterDraw

OnGetAxisLabel

OnGetLegendText

OnGetNextAxisLabel

OnPageChange

TCustomPanel からの継承

OnResize

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp


TCustomDecisionGraph イベント3040007

TCustomDecisionGraph	オブジェクト順	凡例

OnAfterDraw

OnAllowScroll

OnClick

OnClickAxis

OnClickBackground

OnClickLegend

OnClickSeries

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnGetAxisLabel

OnGetLegendPos

OnGetLegendRect

OnGetLegendText

OnGetNextAxisLabel

OnMouseDown

OnMouseMove

OnMouseUp

OnPageChange

OnResize

OnScroll

OnUndoZoom

OnZoom


TCustomDecisionGraph メソッド3040008

TCustomDecisionGraph	アルファベット順

TCustomDecisionGraph

Create

Destroy

TChart からの継承

CalcClickedPart

CalcMetaBounds

ChartPrintRect

CopyToClipboardBitmap

CopyToClipboardMetafile

DrawToMetaCanvas

ExchangeSeries

FillSeriesSourceItems

FillValueSourceItems

GetEditorClass

IsScreenHighColor

NextPage

PreviousPage

Print

PrintLandscape

PrintOrientation

PrintPartial

PrintPartialCanvas

PrintPortrait

PrintRect

SaveToBitmapFile

SaveToMetafile

SaveToMetafileEnh

SaveToMetafileRect

SeriesDown

SeriesUp

TeeCreateMetafile

UndoZoom

ZoomPercent

ZoomRectTCustomChart からの継承

ActiveSeriesLegend

AddSeries

BackWallRect

CalcSize3d

CalcSize3dWalls

ChartRegionRect

CheckDatasource

CheckPenWidth

ClipRectangle

Draw

FormattedLegend

FormattedValueLegend

FreeAllSeries

GetASeries

GetAxisSeries

GetFreeSeriesColor

GetLabelsSeries

InternalDraw

IsFreeSeriesColor

IsValidDataSource

MarkText

MaxMarkWidth

MaxTextWidth

MaxXValue

MaxYValue

MinXValue

MinYValue

NumPages

RemoveAllSeries

RemoveSeries

SeriesCount

SeriesTitleLegend

UnClipRectangle

XLabelText

TCustomTeePanel からの継承

CanvasChanged

DoHorizLine

DoLine

DoPolygon

DoRectangle

DoVertLine

FontCanvas

GetCursorPos

GetRectangle

GetWidthHeight

ReCalcWidthHeight

RotateLabel

SetBooleanProperty

SetBrushCanvas

SetColorProperty

SetDoubleProperty

SetIntegerProperty

SetInternalCanvas

SetLongintProperty

SetStringProperty

TeeCharHeight

TeeTextHeight

TeeTextOut

TeeTextWidth

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomDecisionGraph メソッド3040009

TCustomDecisionGraph	オブジェクト順

ActiveSeriesLegend

AddSeries

Assign

BackWallRect

BeginDrag

BringToFront

Broadcast

CalcClickedPart

CalcMetaBounds

CalcSize3d

CalcSize3dWalls

CanFocus

CanvasChanged

ChartPrintRect

ChartRegionRect

CheckDatasource

CheckPenWidth

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ClipRectangle

ContainsControl

ControlAtPos

CopyToClipboardBitmap

CopyToClipboardMetafile

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DoHorizLine

DoLine

DoPolygon

DoRectangle

DoVertLine

DragDrop

Dragging

Draw

DrawToMetaCanvas

EnableAlign

EndDrag

ExchangeSeries

FieldAddress

FillSeriesSourceItems

FillValueSourceItems

FindComponent

Focused

FontCanvas

FormattedLegend

FormattedValueLegend

Free

FreeAllSeries

FreeInstance

FreeNotification

FreeOnRelease

GetASeries

GetAxisSeries

GetCursorPos

GetEditorClass

GetFreeSeriesColor

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetLabelsSeries

GetNamePath

GetParentComponent

GetRectangle

GetTabOrderList

GetTextBuf

GetTextLen

GetWidthHeight

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

InternalDraw

Invalidate

IsFreeSeriesColor

IsScreenHighColor

IsValidDataSource

MarkText

MaxMarkWidth

MaxTextWidth

MaxXValue

MaxYValue

MethodAddress

MethodName

MinXValue

MinYValue

NewInstance

NextPage

NumPages

PaintTo

Perform

PreviousPage

Print

PrintLandscape

PrintOrientation

PrintPartial

PrintPartialCanvas

PrintPortrait

PrintRect

Realign

ReCalcWidthHeight

Refresh

RemoveAllSeries

RemoveComponent

RemoveControl

RemoveSeries

Repaint

RotateLabel

SafeCallException

SaveToBitmapFile

SaveToMetafile

SaveToMetafileEnh

SaveToMetafileRect

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SeriesCount

SeriesDown

SeriesTitleLegend

SeriesUp

SetBooleanProperty

SetBounds

SetBrushCanvas

SetColorProperty

SetDoubleProperty

SetFocus

SetIntegerProperty

SetInternalCanvas

SetLongintProperty

SetStringProperty

SetTextBuf

Show

TeeCharHeight

TeeCreateMetafile

TeeTextHeight

TeeTextOut

TeeTextWidth

UnClipRectangle

UndoZoom

Update

UpdateControlState

XLabelText

ZoomPercent

ZoomRect


TCustomDecisionGraph.Create
TCustomDecisionGraph.Create3040010

TCustomDecisionGraph	参照

Create メソッドは，TCustomDecisionGraph のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にデシジョングラフを作成できます。設計時にフォームに配置されたデシジョングラフは自動的に作成されます。Create は SaveSeries プロパティを False に初期化します。


TCustomDecisionGraph.Destroy
TCustomDecisionGraph.Destroy3040011

TCustomDecisionGraph	参照

Destroy メソッドは，TCustomDecisionGraph のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはデシジョングリッドが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。


スコープ3040012

published

読み出し／書き込み

読み出し専用


スコープ3040013

published


継承3040014

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomPanel

TCustomTeePanel

TCustomAxisPanel

TCustomChart

TChart


TCustomDecisionGraph 例3040015

TCustomDecisionGraph


TCustomDecisionGrid
TCustomDecisionGrid3041001

継承	プロパティ	メソッド	イベント	参照

TCustomDecisonGrid は，クロス集計されたデータを 2 軸グリッドで表すコントロールの基本クラスです。

ユニット

mxgrid

説明

TCustomDecisionGrid は，デシジョングリッドオブジェクトを定義するときに基本クラスとして使います。デシジョングリッドは，任意の数の軸を元に計算した 1 つの集計を表すことができます。

集計される項目と集計の基になる項目（軸）は，デシジョンキューブの軸マップから選択された集計および軸の構成を見るために，実行時に動的に変更できます。軸および集計に対する変更は，直接デシジョングリッドを操作するか，TDecisionPivot オブジェクトを使うことで開始できます。

TCustomDecisionGrid のインスタンスは作成しないでください。デシジョングリッドをフォームに追加するには，TDecisionGrid オブジェクトを使います。


TCustomDecisionGrid プロパティ3041002

TCustomDecisionGrid	アルファベット順	凡例

TCustomDecisionGrid

CaptionColor

CaptionFont

Cells

ColCount

ColWidth

DataColor

DataFont

DataSumColor

DecisionSource

DefaultColWidth

DefaultRowHeight

Dimensions

FixedCols

FixedRows

GridLineColor

GridLineWidth

LabelColor

LabelFont

LabelSumColor

Options

RowCount

RowHeight

ShowCubeEditor

Totals

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomDecisionGrid プロパティ3041003

TCustomDecisionGrid	オブジェクト順	凡例

Align

BoundsRect

Brush

CaptionColor

CaptionFont

Cells

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ColCount

ColWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DataColor

DataFont

DataSumColor

DecisionSource

DefaultColWidth

DefaultRowHeight

DesignInfo

Dimensions

Enabled

FixedCols

FixedRows

GridLineColor

GridLineWidth

Handle

Height

HelpContext

Hint

LabelColor

LabelFont

LabelSumColor

Left

Name

Options

Owner

Parent

ParentWindow

RowCount

RowHeight

ShowCubeEditor

ShowHint

Showing

TabOrder

TabStop

Tag

Top

Totals

VCLComObject

Visible

Width

WindowProc


TCustomDecisionGrid.CaptionColor
TCustomDecisionGrid.CaptionColor3041004

TCustomDecisionGrid	参照

CaptionColor プロパティは，行と列の軸の名前が入るセルの背景色です。

property CaptionColor: TColor;

説明

CaptionColor プロパティは，行と列の軸の名前を際立たせるために使われる色に設定します。これらの名前はデシジョンキューブエディタで設定される軸の名前です。

行および列の軸を構成する項目の実際の値は，LabelColor プロパティを使って描画されます。


TCustomDecisionGrid.CaptionFont
TCustomDecisionGrid.CaptionFont3041005

TCustomDecisionGrid	参照

CaptionFont プロパティは，行と列の軸の名前を記述するのに使われるフォントです。

property CaptionFont: TFont;

説明

CaptionFont プロパティは，行と列の軸の名前を際立たせるために使われるフォントに設定します。これらの名前はデシジョンキューブエディタで設定される軸の名前です。

行および列の軸を構成する項目の実際の値は，LabelFont プロパティを使って記述されます。


TCustomDecisionGrid.Cells
TCustomDecisionGrid.Cells3041006

TCustomDecisionGrid	参照

Cells プロパティは，デシジョングリッド内のすべてのセルの値が入ったインデックス配列です。

property Cells[ACol, ARow: Integer]: String;

説明

Cells プロパティは，文字列としてフォーマットされたグリッド内のセルの値を取得できます。ACol および ARow パラメータはセルの列および行インデックスを示します。（0，0）は，グリッドの左上のセルではなく，データ領域の左上のセルを表します。［表示（S）|データ］または［表示（S）|小計］メニュー項目を使ってクローズアップされたセルは，可視でなくてもカウントされます。

セルが行または列キャプション（ACol または ARow が負の値）の場合，Cells は軸の名前を返します。セルが行または列ラベルの場合，Cells は軸項目の項目値を返します。セルが小計ラベルの場合，Cells は文字列 Sum を返します。セルがグリッドのデータ領域内にある場合，Cells は集計された値を返します。


TCustomDecisionGrid.ColCount
TCustomDecisionGrid.ColCount3041007

TCustomDecisionGrid	参照

ColCount プロパティは，デシジョングリッド内の列の総数です。

property ColCount:integer;

説明

ColCount プロパティは，軸のキャプションおよびラベルのセルの入った列を含めた，デシジョングリッド内の列数を取得できます。デシジョングリッドのデータ領域内の列数は，ColCount から FixedCols の値を引いて算出します。


TCustomDecisionGrid.ColWidth
TCustomDecisionGrid.ColWidth3041008

TCustomDecisionGrid	参照

ColWidth プロパティは，デフォルトの列幅です。

property ColWidth: Integer;

説明

ColWidth プロパティは，デシジョングリッド内の，ユーザーによってサイズ変更されていない列の幅を設定します。ColWidth を設定すると，マウスを使ってサイズ変更された列を含めて，グリッド内のすべての列のサイズが変更されます。


TCustomDecisionGrid.DataColor
TCustomDecisionGrid.DataColor3041009

TCustomDecisionGrid	参照

DataColor プロパティは，集計された値が入るセルの背景色です。

property DataColor: TColor;

説明

DataColor プロパティは，デシジョングリッドのスクロール可能なデータ領域に使われる色に設定します。データ領域には，デシジョンキューブの現在の集計の値が入ります。各セルは行および列の軸によって示される値を元に集計された項目の値を表します。

指定した軸内のすべての値を元に集計された値（および他の軸内の 1 つの値）を表す小計は，DataSumColor プロパティを使って描画されます。


TCustomDecisionGrid.DataFont
TCustomDecisionGrid.DataFont3041010

TCustomDecisionGrid	参照

DataFont プロパティは，デシジョングリッドのスクロール可能な領域に集計された値を記述するのに使うフォントです。

property DataFont: TFont;

説明

DataFont プロパティは，デシジョングリッドのデータ領域で使うフォントに設定します。データ領域には，デシジョンキューブの現在の集計の値が入ります。各セルは行および列の軸によって示される値を元に集計された項目の値を表します。また，集計項目を元にした軸の小計も入ります。


TCustomDecisionGrid.DataSumColor
TCustomDecisionGrid.DataSumColor3041011

TCustomDecisionGrid	参照

DataSumColor プロパティは，軸全体の小計を表すセルの背景色です。

property DataSumColor: TColor;

説明

DataSumColor プロパティを設定すると，軸全体の小計を，各軸内の 1 つの値についての情報を集約する集計値から際立たせることができます。小計セルは，スクロール可能なデータ領域内の，指定された軸に対応する行または列のセットの最後に配置されます。


TCustomDecisionGrid.DecisionSource
TCustomDecisionGrid.DecisionSource3041012

TCustomDecisionGrid	参照

DecisionSource プロパティは，クロス集計されたデータをデシジョングリッドに提供します。

property DecisionSource: TDecisionSource;

説明

DecisionSource プロパティを設定すると，デシジョングリッドをデシジョンキューブからのクロス集計されたデータにリンクできます。DecsionSource オブジェクトは現在のデータのピボット状態についての情報を保持します。したがって，同じデシジョンソースを共有する 2 つのデシジョンコントロールは，閉じた軸またはドリルダウンされた値など，同じ行および列の軸の設定を使ってデシジョンキューブからのデータを表示します。


TCustomDecisionGrid.DefaultColWidth
TCustomDecisionGrid.DefaultColWidth3041013

TCustomDecisionGrid	参照

DefaultColWidth プロパティは，明示的にサイズ変更されないすべての列の幅です。

property DefaultColWidth: Integer;

説明

DefaultColWidth プロパティは，デシジョングリッド内の，マウスを使ってサイズ変更されない列の幅に設定します。DefaultColWidth を設定すると，サイズ変更された列を含めて，グリッド内のすべての列のサイズが変更されます。


TCustomDecisionGrid.DefaultRowHeight
TCustomDecisionGrid.DefaultRowHeight3041014

TCustomDecisionGrid	参照

DefaultRowHeight プロパティは，明示的にサイズ変更されないすべての行の高さです。

property DefaultRowHeight: Integer;

説明

DefaultRowHeight プロパティは，デシジョングリッド内の，マウスを使ってサイズ変更されない行の高さに設定します。DefaultRowHeight を設定すると，サイズ変更された行を含めて，グリッド内のすべての行のサイズが変更されます。


TCustomDecisionGrid.Dimensions
TCustomDecisionGrid.Dimensions3041015

TCustomDecisionGrid	参照

Dimensions プロパティは，デシジョングリッド内の各軸の体裁を制御する TDisplayDim オブジェクトのコレクションです。

property Dimensions: TDisplayDims;

説明

個々の TDisplayDim オブジェクトのプロパティを設定すると，グリッド内の個々の軸の体裁を制御できます。TDisplayDim オブジェクトには，個々の軸を際立たせるために，グリッドのさまざまな色およびフォントのプロパティをオーバーライドできるプロパティがあります。また，それらのプロパティを使うと，軸の名前，位置合わせ，およびフォーマットをカスタマイズしたり，ある軸の軸小計をオンまたはオフに切り替えたりすることができます。

注意

Dimensions プロパティは変更しないで，Dimensions プロパティを通じてアクセスされる個々の TDisplayDim オブジェクトのプロパティを変更します。グリッド内に表示される軸の設定をプログラムで変更するには，デシジョンソースオブジェクトを使います。


TCustomDecisionGrid.FixedCols
TCustomDecisionGrid.FixedCols3041016

TCustomDecisionGrid	参照

FixedCols プロパティは，軸のキャプションおよび軸の値のラベルに使われる列の数です。

property FixedCols:integer;

説明

FixedCols プロパティは，デシジョングリッド内のデータ領域の一部にならない列の数を判定できます。ColCount プロパティの値から FixedCols の値を引くと，データ領域内の列の数が得られます。


TCustomDecisionGrid.FixedRows
TCustomDecisionGrid.FixedRows3041017

TCustomDecisionGrid	参照

FixedRows プロパティは，軸のキャプションおよび軸の値のラベルに使われる行の数です。

property FixedRows:integer;

説明

FixedRows プロパティは，デシジョングリッド内のデータ領域の一部にならない行の数を判定できます。RowCount プロパティの値から FixedRows の値を引くと，データ領域内の行の数が得られます。


TCustomDecisionGrid.GridLineColor
TCustomDecisionGrid.GridLineColor3041018

TCustomDecisionGrid	参照

GridLineColor プロパティは，デシジョングリッド内でセルを区切る線の色です。

property GridLineColor: TColor;

説明

GridLineColor プロパティを設定すると，グリッドのセル間の線の色を指定できます。グリッド線は Options プロパティに cgGridLines が含まれているときにだけ表示されます。


TCustomDecisionGrid.GridLineWidth
TCustomDecisionGrid.GridLineWidth3041019

TCustomDecisionGrid	参照

GridLineWidth プロパティは，グリッドのセルを区切る線の幅です（ピクセル単位）。

property GridLineWidth: Integer;

説明

GridLineWidth プロパティを設定すると，デシジョングリッド内でセルを区切る線を太くしたり細くしたりすることができます。グリッド線は Options プロパティに cgGridLines が含まれているときにだけ表示されます。


TCustomDecisionGrid.LabelColor
TCustomDecisionGrid.LabelColor3041020

TCustomDecisionGrid	参照

LabelColor プロパティは，個々の行および列ラベルの色です。

property LabelColor: TColor;

説明

LabelColor プロパティは行および列ラベルを際立たせるために使う色に設定します。デシジョングリッドの行および列ラベルには，デシジョンキューブの軸に対応する項目の値が入ります。これらの値は，データが集計される元の値です。


TCustomDecisionGrid.LabelFont
TCustomDecisionGrid.LabelFont3041021

TCustomDecisionGrid	参照

LabelFont プロパティは，個々の行および列ラベルを記述するのに使われるフォントです。

property LabelFont: TFont;

説明

LabelFont プロパティは，データが集計される元の軸の値を表示するラベルを記述するのに使われるフォントに設定します。デシジョングリッドの行および列ラベルには，デシジョンキューブの軸に対応する項目の値が入ります。また，LabelFont は軸の小計を表す行または列のラベルを記述するときにも使われます。


TCustomDecisionGrid.LabelSumColor
TCustomDecisionGrid.LabelSumColor3041022

TCustomDecisionGrid	参照

LabelSumColor プロパティは，小計ラベルの背景色です。

property LabelSumColor: TColor;

説明

LabelSumColor プロパティを設定すると，小計ラベルを，軸に沿って個々の項目値を表すラベルから際立たせることができます。小計ラベルは個々の軸の項目値ラベルのセットの最後に表示されます。


TCustomDecisionGrid.Options
TCustomDecisionGrid.Options3041023

TCustomDecisionGrid	参照

Options プロパティは，グリッド全体の表示に影響を与える各種の設定を指定します。

TDecisionGridOption = (cgGridLines, cgOutliner, cgPivotable);

TDecisionGridOptions = set of TDecisionGridOption;

property Options: TDecisionGridOptions;

説明

Options プロパティを設定すると，グリッドに目的のプロパティが含まれるようにすることができます。Options プロパティは以下の値の集合です。

値	意味

cgGridLines	スクロール可能なデータ領域でセルを区切るために垂直線と水平線が描かれる

cgOutliner	軸のキャプションのセルに，クリックするとグリッド内の軸を開いたり閉じたりするプラス（+）とマイナス（-）の記号が入る。マイナスの記号は隣の軸を閉じ（隠し），プラスの記号は隣の軸を開く（表示する）

cgPivotable	軸のキャプションのセルをクリックし，新しい位置へドラッグして軸を再配置できる

注意

Options プロパティに cgOutliner が含まれていなくても，個々の軸はデシジョンピボットを使って開いたり閉じたりすることはできます。同様に，Options プロパティに cgPivotable が含まれていなくても，個々の軸はデシジョンピボットを使って開いたり閉じたりすることはできます。


TCustomDecisionGrid.RowCount
TCustomDecisionGrid.RowCount3041024

TCustomDecisionGrid	参照

RowCount プロパティは，デシジョングリッド内の行の総数です。

property RowCount:integer;

説明

RowCount プロパティは，軸のキャプションおよびラベルのセルが入った行を含めた，デシジョングリッド内の行数を判定できます。デシジョングリッドのデータ領域内の行数を算出するには，RowCount の値から FixedRows の値を引きます。


TCustomDecisionGrid.RowHeight
TCustomDecisionGrid.RowHeight3041025

TCustomDecisionGrid	参照

RowHeight プロパティは，デフォルトの行の高さです。

property RowHeight: Integer;

説明

RowHeight プロパティは，デシジョングリッド内の，ユーザーによってサイズ変更されていない行の高さに設定します。RowHeight を設定すると，マウスを使ってサイズ変更された行を含めて，グリッド内のすべての行のサイズが変更されます。


TCustomDecisionGrid.Totals
TCustomDecisionGrid.Totals3041026

TCustomDecisionGrid	参照

Totals プロパティは，グリッドに小計が含まれるかどうかを示します。

property Totals: Boolean;

説明

Totals プロパティを設定すると，グリッド全体に対して行および列の小計をオンまたはオフにすることができます。個々の軸の小計をオンまたはオフにするには，Dimensions プロパティを使います。


TCustomDecisionGrid イベント3041027

TCustomDecisionGrid	アルファベット順

TCustomDecisionGrid

OnDecisionDrawCell

OnDecisionExamineCell

OnTopLeftChanged


TCustomDecisionGrid イベント3041028

TCustomDecisionGrid	オブジェクト順

OnDecisionDrawCell

OnDecisionExamineCell

OnTopLeftChanged


TCustomDecisionGrid.OnDecisionDrawCell
TCustomDecisionGrid.OnDecisionDrawCell3041029

TCustomDecisionGrid	参照

OnDecisionDrawCell イベントは，グリッド内のセルが描画される直前に発生します。

TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

TDecisionDrawStates = (dsGroupStart, dsRowCaption, dsColCaption, dsSum, dsRowValue,

   dsColValue, dsData, dsOpenAfter, dsCloseAfter, dsRowIndicator, dsColIndicator, dsRowPlus,

   dsColPlus, dsNone);

TDecisionDrawState = set of TDecisionDrawStates;

TDecisionDrawCellEvent = procedure (Sender: TObject; Col, Row: Longint; var Value: string;

   var AFont: TFont; var AColor: TColor; AState: TGridDrawState;

   ADrawState: TDecisionDrawState) of Object;

property OnDecisionDrawCell: TDecisionDrawCellEvent;

説明

OnDecisionDrawCell イベントハンドラを記述すると，グリッド内の個々のセルを表示するのに使う色，フォント，またはテキストを変更できます。色，フォント，またはテキストを変更するには，それぞれ AColor，AFont，または Value パラメータを変更します。

たとえば，行および列ラベルをデータセット内の項目の値からカスタマイズされたラベルに変更するには，Row および Column パラメータがラベルセルを表しているときにイベントハンドラの Value パラメータを変更します。

Row および Column パラメータは，グリッド内のセルの行および列を示します。（0，0）は，グリッドの左上隅ではなく，左上の集計値を指定します。したがって，ラベルセルには，負の値の行および列インデックスが入ります。また，セルがラベルセルであるとき，AState パラメータには gdFixed が含まれます。また，AState は描画されるセルが選択されるかどうかも示します。

ADrawState パラメータは描画されるセルの種類を示します。ADrawState には，以下の値の 1 つまたは複数を指定します。

値	意味

dsGroupStart	セルは軸の最初の行または列ラベルである。常に dsRowValue または dsColValue とともに使われる

dsRowCaption	セルは行キャプション（値がグリッドの左の列にリストされる軸の名前）を表示する

dsColCaption	セルは列キャプション（値がグリッドの上にリストされる軸の名前）を表示する

dsSum	セルは小計ラベルまたは値を表示する。常にdsRowValue，dsColValue，または dsData とともに使われる

dsRowValue	セルは行ラベルである。グリッドの左の列にリストされる軸からの値，または軸の値の各グループの最後に表示される集計ラベルを表す

dsColValue	セルは列ラベルである。グリッドの上にリストされる軸からの値，または軸の最後に表示される集計ラベルを表す

dsData	セルはグリッドのスクロール可能なデータ領域内にある

dsOpenAfter	セルの右に，クリックすると次の軸が開くプラス記号（+）がある。常に dsRowCaption，dsColCaption，dsRowPlus，または dsColPlus とともに使われる

dsCloseAfter	セルの右に，クリックすると次の軸が閉じるマイナス記号（-）がある。常に dsRowCaption，dsColCaption，dsRowPlus，または dsColPlus とともに使われる

dsRowIndicator	セルはオープンおよびクローズインジケータ（+ と -）を表示するのに使う左のグリッドマージンに表示される

dsColIndicator	セルはオープンおよびクローズインジケータ（+ と -）を表示するのに使う上のグリッドマージンに表示される

dsRowPlus	セルは左マージンに表示され，隣の軸が閉じられていることを示すプラス記号（+）が付く。常に dsRowIndicator とともに使われる

dsColPlus	セルは上マージンに表示され，隣の軸が閉じられていることを示すプラス記号（+）が付く。常に dsColIndicator とともに使われる

dsNone	セルには機能がない


TCustomDecisionGrid.OnDecisionExamineCell
TCustomDecisionGrid.OnDecisionExamineCell3041030

TCustomDecisionGrid	参照

OnDecisionExamineCell イベントは，ユーザーがグリッドのデータ領域内のセルを右クリックしたときに発生します。

 TDecisionExamineCellEvent = procedure (Sender: TObject; ICol, IRow: Longint; ISum: Integer;

const ValueArray: TSmallIntArray) of Object;

property OnDecisionExamineCell: TDecisionExamineCellEvent;

説明

OnDecisionExamineCell イベントハンドラを記述すると，集計されたデータの入ったセルをユーザーが右クリックしたときに特定の処理が行われるようにすることができます。ICol および IRow パラメータはセルの列および行インデックスを示します。列および行インデックスの 0 の値では，デシジョングリッドの左上のセルではなく，スクロール可能なデータ領域の一番上または一番左のセルが指定されます。ISum パラメータはデシジョンキューブでの現在の集計のインデックスです。最初のアクティブな集計のインデックスが 0 になります。ValueArray パラメータはデシジョンソースの軸でセルの座標を指定します。セルが小計値を表す場合，小計が計算される元の軸に対する ValueArray 内のエントリは負の数値になります。

Cells プロパティを使うと，セル内の集計の値を取得できます。デシジョンソースの GetDimensionName メソッドを使うと，ValueArray パラメータ内のエントリによって表される各軸の名前を取得できます。デシジョンソースの GetValueAsString または GetValueAsVariant メソッドを使うと，ValueArray パラメータで表される各軸のラベルの値を取得できます。


TCustomDecisionGrid.OnTopLeftChanged
TCustomDecisionGrid.OnTopLeftChanged3041032

TCustomDecisionGrid	参照

OnTopLeftChanged イベントは，グリッドのデータ領域がスクロールしたときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnTopLeftChanged: TNotifyEvent;

説明

OnTopLeftChanged イベントハンドラを記述すると，グリッド内の集計されたデータがスクロールしたときに特定の処理が行われるようにすることができます。Cells プロパティまたは CellDrawState メソッドを使うと，データセルの新しい値を取得できます。


TCustomDecisionGrid メソッド3041033

TCustomDecisionGrid	アルファベット順	凡例

TCustomDecisionGrid

CellDrawState

CellRect

CellValueArray

ColWidthsChanged

Create

Destroy

DrawCell

GetCells

MouseDown

MouseMove

MouseUp

Notification

Paint

RowHeightsChanged

SelectCell

TopLeftChanged

TCustomGrid からの継承

MouseCoord

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomDecisionGrid メソッド3041034

TCustomDecisionGrid	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

CellDrawState

CellRect

CellValueArray

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ColWidthsChanged

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

DrawCell

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetCells

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

MouseCoord

MouseDown

MouseMove

MouseUp

NewInstance

Notification

Paint

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

RowHeightsChanged

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectCell

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

TopLeftChanged

Update

UpdateControlState


TCustomDecisionGrid.CellDrawState
TCustomDecisionGrid.CellDrawState3041035

TCustomDecisionGrid	参照

CellDrawState メソッドは，グリッド内のデータセルについての情報を取り出します。

TDecisionDrawStates = (dsGroupStart, dsRowCaption, dsColCaption, dsHeader, dsSum,

   dsRowValue, dsColValue, dsData, dsOpenAfter, dsCloseAfter, dsCloseBefore, dsOpenBefore,

   dsRowIndicator, dsColIndicator, dsRowPlus, dsColPlus, dsNone,dsLeftPivot, dsMiddlePivot,

   dsRightPivot, dsTopPivot);

TDecisionDrawState = set of TDecisionDrawStates;

function CellDrawState(ACol, ARow: Integer; var Value: string;

   var DrawState: TDecisionDrawState): boolean;

説明

CellDrawState メソッドを呼び出すと，グリッドのスクロール可能なデータ領域内のセルについての情報を取得できます。ACol および ARow パラメータはセルのインデックスを指定します。（0，0）は，グリッドの左上のセルではなく，データ領域の左上のセルです。Value パラメータは表示用にフォーマットされたセル内の集計の値を返します。DrawState パラメータはセルに入っている情報の種類についての情報を返します。DrawState の値についての詳細は，「OnDecisionDrawCell イベント」を参照してください。

CellDrawState は，Value および DrawState パラメータに正しい値が入っていれば True を返します。CellDrawState は，ACol と ARow で指定されたセルがグリッドのデータ領域内にないと False を返します。


TCustomDecisionGrid.CellValueArray
TCustomDecisionGrid.CellValueArray3041036

TCustomDecisionGrid	参照

CellValueArray メソッドは，データセルが集計される元のすべての軸項目の値を返します。

function CellValueArray(ACol, ARow: Integer; var ValueArray: TSmallIntArray): boolean;

説明

CellValueArray メソッドを呼び出すと，デシジョンキューブによって保持される多軸配列内のデータセルの座標を取得できます。ACol および ARow パラメータはセルがある列と行のインデックスを示します。（0，0）は，グリッド内の左上のセルではなく，左上のデータセルを指定します。ValueArray パラメータは，セルがデータを集計する元になる各軸の項目値のインデックスを返します。デシジョンソースの GetMemberAsString または GetMemberAsVariant メソッドを使うと，ValueArray パラメータ内のインデックスを項目値に変換できます。CellValueArray は，関数が成功したかどうかを示す論理値を返します。


TCustomDecisionGrid.ColWidthsChanged
TCustomDecisionGrid.ColWidthsChanged3041037

TCustomDecisionGrid	参照

ColWidthsChanged メソッドは，列幅の変更に応答します。

procedure ColWidthsChanged; override;

説明

ColWidthsChanged メソッドは列幅が変更された直後に呼び出されます。列幅の変更は，ColWidth プロパティを設定したり，マウスを使って列をサイズ変更したりすることにより起こります。

ColWidthsChanged は変更内容に合わせてスクロールバーを調節します。設計時には，ColWidthsChanged は，マウスを使って列がサイズ変更されたときにすべての列が同じサイズになるようにします。


TCustomDecisionGrid.Create
TCustomDecisionGrid.Create3041038

TCustomDecisionGrid	参照

Create メソッドは，TCustomDecisionGrid のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にデシジョングリッドを作成できます。設計時にフォームに配置されたデシジョングリッドは自動的に作成されます。

Create メソッドは以下のプロパティを初期化します。

・	CaptionColor は clActiveCaption，CaptionFont.Color は clCaptionText

・	DataColor は clInfoBk，DataSumColor は clNone

・	LabelColor は clBtnFace，LabelSumColor は clTeal

・	Color は clWindow，ParentColor は False

・	Options は [cgGridLines, cgOutliner, cgPivotable]

・	GridLineColor は clBlack，GridLineWidth は 1

・	ColWidth は 80，RowHeight は 20

・	ScrollBars は ssBoth

・	DefaultDrawing は True


TCustomDecisionGrid.Destroy
TCustomDecisionGrid.Destroy3041039

TCustomDecisionGrid	参照

Destroy メソッドは，TCustomDecisionGrid のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはデシジョングリッドが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。Destroy メソッドは TCustomDecisionGrid によって使われたすべてのヘルパーオブジェクトを解放します。


TCustomDecisionGrid.DrawCell
TCustomDecisionGrid.DrawCell3041040

TCustomDecisionGrid	参照

DrawCell メソッドは，グリッド内のセルを描画します。

TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

procedure DrawCell(ACol, ARow: Longint; ARect: TRect; AState: TGridDrawState); override;

説明

DrawCell メソッドは，ACol および ARow パラメータで指定されるセルのペイントが必要になったときに自動的に呼び出されます。DrawCell は OnDecisionDrawCell イベントを生成してから，セルの色，フォント，値を使ってセルを描画します。


TCustomDecisionGrid.GetCells
TCustomDecisionGrid.GetCells3041041

TCustomDecisionGrid	参照

GetCells メソッドは，グリッド内の文字列としてフォーマットされているセルの値を返します。

function GetCells(ACol, ARow: Integer): String;

説明

GetCells メソッドは，Cells プロパティのプロテクトプロパティのアクセスメソッドです。GetCells をオーバーライドすると，Cells プロパティの実現を変更できます。


TCustomDecisionGrid.MouseDown
TCustomDecisionGrid.MouseDown3041042

TCustomDecisionGrid	参照

MouseDown メソッドは，軸の新しい位置へのドラッグを開始します。

procedure MouseDown(Button: TMouseButton; Shift: TShiftState; X, Y: Integer); override;

説明

MouseDown メソッドはユーザーがグリッドのセル内でマウスをクリックしたときに自動的に呼び出されます。継承するメソッドを呼び出した後で，MouseDown は，セルがドラッグ可能な軸ラベルならば，ピボット操作を開始します。

MouseDown メソッドをオーバーライドするときは，必ず継承するメソッドを呼び出すようにしてください。


TCustomDecisionGrid.MouseMove
TCustomDecisionGrid.MouseMove3041043

TCustomDecisionGrid	参照

MouseMove メソッドは，ピボット操作中の軸のドロップ場所を算定します。

procedure MouseMove(Shift: TShiftState; X, Y: Integer); override;

説明

MouseMove メソッドはユーザーがマウスを動かすと自動的に呼び出されます。継承するメソッドを呼び出した後で，軸が新しい位置にドラッグされていれば，MouseMove メソッドは新しいピボット状態を算定します。

MouseMove メソッドをオーバーライドするときは，必ず継承するメソッドを呼び出すようにしてください。


TCustomDecisionGrid.MouseUp
TCustomDecisionGrid.MouseUp3041044

TCustomDecisionGrid	参照

MouseUp メソッドは，ピボット操作の後で軸を再配置しデシジョンソースを更新します。

procedure MouseUp(Button: TMouseButton; Shift: TShiftState; X, Y: Integer); override;

説明

MouseUp メソッドはユーザーがマウスを離すと自動的に呼び出されます。継承するメソッドを呼び出した後で，MouseUp メソッドは軸が新しい位置にドラッグされたばかりかどうかを確認します。軸が移動されたばかりならば，MouseUp は Dimensions プロパティを適切に変更し，新しい設定が反映されるようにデシジョンソースを更新します。

MouseUp メソッドをオーバーライドするときは，継承するメソッドを呼び出すようにしてください。


TCustomDecisionGrid.Notification
TCustomDecisionGrid.Notification3041045

TCustomDecisionGrid	参照

Notification メソッドは TDecisionPivot 内のボタンをデシジョンソースにリンクします。

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

継承するメソッドを呼び出した後で，新しい要素がデシジョングリッドに追加されると，Notification メソッドは必要な内部調整を実行します。Notification メソッドをオーバーライドするときは，継承するメソッドを呼び出すようにしてください。


TCustomDecisionGrid.Paint
TCustomDecisionGrid.Paint3041046

TCustomDecisionGrid	参照

Paint メソッドは，デシジョングリッドのイメージを描画します。

procedure Paint; override;

説明

Paint メソッドは，グリッドが Windows のペイントメッセージを受け取ったときに呼び出されます。Paint は，各セルの内容をペイントすることが必要になると DrawCell メソッドを呼び出して，グリッドを描画します。すべてのセルが描画された後で，Paint はグリッド線を描画します。

DefaultDrawing が False ならば，Paint はセルの背景を描画したり，フォーカスがあるときに選択されているセルの周りのフォーカスを示す長方形を描画したりしません。


TCustomDecisionGrid.RowHeightsChanged
TCustomDecisionGrid.RowHeightsChanged3041047

TCustomDecisionGrid	参照

RowHeightsChanged メソッドは，行の高さの変更に応答します。

procedure RowHeightsChanged; override;

説明

RowHeightsChanged メソッドは行の高さが変更された直後に呼び出されます。行の高さの変更は，RowHeight プロパティを設定したり，マウスを使って行をサイズ変更したりすることによって起こります。

RowHeightsChanged は変更内容に合わせてスクロールバーを調整します。設計時には，RowHeightsChanged は，マウスを使って行がサイズ変更されるとき，すべての行が同じサイズになるようにします。


TCustomDecisionGrid.SelectCell
TCustomDecisionGrid.SelectCell3041048

TCustomDecisionGrid	参照

SelectCell メソッドは，OnSelectCell イベントを生成します。

function SelectCell(Arow, AColumn:LongInt): Boolean; override;

説明

デシジョングリッドは，ACol および ARow パラメータで識別されるセルに選択を移動しようとする前に，内部的に SelectCell メソッドを呼び出します。ACol と ARow はセルの列および行インデックスです。1 番目の列が列インデックス 0 で，1 番目の行が行インデックス 0 になります。


TCustomDecisionGrid.TopLeftChanged
TCustomDecisionGrid.TopLeftChanged3041049

TCustomDecisionGrid	参照

TopLeftChanged メソッドは，OnTopLeftChanged イベントを生成します。

procedure TopLeftChanged; override;

説明

デシジョングリッドは，グリッドのデータ領域がスクロールするたびに，内部的に TopLeftChanged メソッドを呼び出します。


スコープ3041050

protected

published

読み出し／書き込み

読み出し専用


スコープ3041051

protected


継承3041052

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomGrid


TCustomDecisionGrid 例3041053

TCustomDecisionGrid


TCGIApplication
TCGIApplication3042001

継承	プロパティ	メソッド	参照

TCGIApplication は CGI サーバーアプリケーションをカプセル化します。

ユニット

cgiapp

説明

TCGIApplication は CGI サーバーアプリケーションの基本動作を提供します。TCGIApplication は，CGI サーバーが HTTP 要求メッセージを受け取ると実行を開始します。TCGIApplication は，要求メッセージを表す TCGIRequest オブジェクトと，送り返される応答を表す TCGIResponse オブジェクトを作成し，応答の入力のためにこれらのオブジェクトをディスパッチャに渡し，TWebActionItem によってすでに送信されていなければ応答を送信します。

各 CGI サーバープロジェクトは自動的に TCGIApplication 型の Application 変数をアプリケーションのインスタンスとして宣言します。この宣言は，CGIApp ユニットがプロジェクトファイルのユーザーリストで最後に宣言される場合，Forms ユニットで宣言された Application 変数をオーバーライドします。各 CGI サーバーアプリケーションには CGIApp ユニットが含まれている必要があります。

ISAPI または NSAPI サーバーを使う場合は，かわりに TISAPIApplication オブジェクトを使います。


TCGIApplication プロパティ3042002

TCGIApplication	アルファベット順	凡例

TWebApplication からの継承

ActiveCount

CacheConnections

InactiveCount

MaxConnections

Title

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TCGIApplication プロパティ3042003

TCGIApplication	オブジェクト順	凡例

ActiveCount

CacheConnections

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

InactiveCount

MaxConnections

Name

Owner

Tag

Title

VCLComObject


TCGIApplication メソッド3042004

TCGIApplication	アルファベット順

TCGIApplication

Run

TWebApplication からの継承

Create

CreateForm

Destroy

Initialize

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCGIApplication メソッド3042005

TCGIApplication	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateForm

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

Initialize

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

Run

SafeCallException


TCGIApplication.Run
TCGIApplication.Run3042006

TCGIApplication	参照

Run メソッドは， HTTP 要求メッセージへの応答として CGI アプリケーションを実行します。

procedure Run; override;

説明

新しいプロジェクトを作成するとき，Delphi は自動的にプロジェクトファイルに Run メソッドを呼び出す main プログラムブロックを作成します。HTTP 要求メッセージへの応答としてアプリケーションが起動されると，CGI アプリケーションの Run メソッドが呼び出されます。

継承された Run メソッドを呼び出してデフォルトエラーハンドラをセットアップし，アプリケーションのシーケンスをシャットダウンした後で，TCGIApplication.Run メソッドは CGI アプリケーションを起動した HTTP 要求メッセージに対応する要求オブジェクトおよび応答オブジェクトを作成します。Run メソッドは HandleRequest メソッドを呼び出して，その要求と応答をディスパッチャに渡し，ディスパッチャで応答が完全に設定され，送信されます。最後に，Run メソッドは要求オブジェクトおよび応答オブジェクトを解放します。


スコープ3042007

published

読み出し／書き込み

読み出し専用


継承3042008

TObject

TPersistent

TComponent

TWebApplication


TCGIApplication 例3042009

TCGIApplication


TCGIRequest
TCGIRequest3043001

継承	プロパティ	メソッド	参照

TCGIRequest オブジェクトは，CGI Web サーバーアプリケーションに渡されるクライアント要求情報を表します。

ユニット

cgiapp

説明

TCGIRequest を使うと，CGI サーバーアプリケーションに対する HTTP 要求を解釈できます。

CGI アプリケーションオブジェクトは TCGIRequest オブジェクトを作成してクライアント要求を取得します。TCGIRequest のプロパティは Web サーバーから取得されます。CGI アプリケーションは TCGIRequest オブジェクトを使って，対応する TCGIResponse オブジェクトを作成します。次に，アプリケーションの TWebDispatcher は，TCGIRequest オブジェクトの URL のパス部分と関連付けられた TWebActionItem を呼び出します。


TCGIRequest プロパティ3043002

TCGIRequest	アルファベット順	凡例

TCGIRequest

Accept

Authorization

CacheControl

Connection

Content

ContentEncoding

ContentLength

ContentType

ContentVersion

Cookie

Date

DerivedFrom

Expires

From

Host

IfModifiedSince

Method

PathInfo

PathTranslated

ProtocolVersion

Query

Referer

RemoteAddr

RemoteHost

ScriptName

ServerPort

Title

URL

UserAgent

TWebRequest からの継承

ContentFields

CookieFields

MethodType

QueryFields


TCGIRequest プロパティ3043003

TCGIRequest	オブジェクト順	凡例

Accept

Authorization

CacheControl

Connection

Content

ContentEncoding

ContentFields

ContentLength

ContentType

ContentVersion

Cookie

CookieFields

Date

DerivedFrom

Expires

From

Host

IfModifiedSince

Method

MethodType

PathInfo

PathTranslated

ProtocolVersion

Query

QueryFields

Referer

RemoteAddr

RemoteHost

ScriptName

ServerPort

Title

URL

UserAgent


TCGIRequest.Accept
TCGIRequest.Accept3043004

TCGIRequest	参照

Accept プロパティは HTTP 要求メッセージの Accept ヘッダーの値です。

property Accept: string;

説明

Accept プロパティを読み出すと，Web クライアントが応答メッセージを受け取れる媒体の種類がわかります。すべての要求メッセージに Accept ヘッダーがあるわけではありません。Accept プロパティが設定されていない場合は，すべての媒体の種類が受け取り可能になります。

Accept ヘッダーはふつう，応答メッセージを受け取れる望ましい媒体が限られていることを示しています。たとえば，オーディオ応答を要求する Web クライアントは，Accept プロパティに次の文字列を設定した TCGIRequest オブジェクトを作成します。

audio/*; q=0.2, audio/basic

この要求は，望ましい媒体の種類がオーディオ／ベーシックであるが，性能が 80% ダウンした後に利用して最善なのであれば，どんなオーディオ媒体でもかまわないということを示しています。

Accept ヘッダーの形式については，現在のインターネット規格文書を参照してください。


TCGIRequest.Authorization
TCGIRequest.Authorization3043005

TCGIRequest	参照

Authorization プロパティは，HTTP 要求メッセージの Authorization ヘッダーの値です。

property Authorization: string;

説明

Authorization プロパティを読み出すと，要求メッセージを送ったクライアントが正しい認証情報を提供したかどうかがわかります。Authorization を使うと，CGI アプリケーションは URL プロパティで指定したリソースへのアクセスを制限できます。

HTTP 認証スキームについての詳細は，インターネット規格文書を参照してください。


TCGIRequest.CacheControl
TCGIRequest.CacheControl3043006

TCGIRequest	参照

CacheControl プロパティは HTTP 要求メッセージの Cache-Control ヘッダーの値です。

property CacheControl: string;

説明

CacheControl プロパティを読み出すと，要求／応答チェーンにおいてすべてのキャッシュメカニズムに従わなければならない Web クライアント疑似命令がすべてわかります。HTTP 要求の CacheControl 疑似命令を，対応する HTTP 応答に適用する必要はありません。

HTTP 1.1 規格では，次の CacheControl 疑似命令を定義しています。

値	意味

no-cache	要求をキャッシュできない。Web サーバーは要求を確認してから TCGIRequest オブジェクトを作成する

no-store	要求に感知型の情報があり，バックアップデープなどの永久的媒体に格納できない。この要求がファイル内に一時的に保存されている場合は，そのファイルを削除しなければならない

max-age=ss	要求は，ss 秒以上，古いものであれば無効とされる。Expires プロパティの方が制限時間が短いとしても，その Expires プロパティよりもこの疑似命令の方が優先する。Web サーバーが無効な要求を確認した後，TCGIRequest オブジェクトを作成する

max-stale or max-stale=ss	クライアントは，満了時間を超えた応答を受けとる用意がある。オプションの max-stale 疑似命令で，満了時間を何秒，超過してもよいかを示す

min-fresh=ss	クライアントは，ss 秒以内に満了になる応答を受け取らない


TCGIRequest.Connection
TCGIRequest.Connection3043007

TCGIRequest	参照

Connection プロパティは，HTTP 要求メッセージの Connection ヘッダーの値です。

property Connection: string;

説明

Connection プロパティを読み出すと，Web クライアントが要求するサーバーアプリケーションとの接続オプションがわかります。HTTP 1.1 規格では，Connection ヘッダーに 1 つしか値を指定しません。このプロパティの値が close の場合，応答処理完了後，接続を切断しないといけません。


TCGIRequest.Content
TCGIRequest.Content3043008

TCGIRequest	参照

Content プロパティは，HTTP 要求メッセージのまだ分解されていない内容を表します。

property Content: stringe;

説明

Content プロパティを使うと，サーバーに情報を送る HTTP 要求メッセージの内容を読み出すことができます。このプロパティの値は，HTTP 要求の Method によって決まります。Method が POST のとき，Content プロパティはまだ分解されていない文字列で，関連項目とともに登録される値を示します。Method が PUT のとき，Content プロパティは，URL プロパティによって指定された URL を置換する値になります。

注意

Method が POST の場合，分解済みの登録要求は ContentFields プロパティで得られます。


TCGIRequest.ContentEncoding
TCGIRequest.ContentEncoding3043009

TCGIRequest	参照

ContentEncoding プロパティは HTTP 要求メッセージの Content-Encoding ヘッダーの値です。

property ContentEncoding: string;

説明

ContentEncoding プロパティを読み出すと，HTTP 要求の Content に適用されたコード化メカニズムがある場合，それを知ることができます。コード化メカニズムは，Web クライアントが適用した順番で並び，カンマで区切られています。一般にこのプロパティは，拡張 ASCII 文字をネット上で転送するための圧縮方式ないしコード化方式を示しています。

ContentEncoding メカニズムを逆に使用すると，Content プロパティの値を復元して，ContentType プロパティが指定する形式に設定できます。


TCGIRequest.ContentLength
TCGIRequest.ContentLength3043010

TCGIRequest	参照

ContentLength プロパティは HTTP 要求メッセージの Content-Length ヘッダーの値です。

property ContentLength: Integer;

説明

ContentLength プロパティを読み出すと，Content プロパティの長さがわかります。ContentType が text/html 以外のとき，ContentLength プロパティで Content プロパティの末尾を知ることができます。ContentLength プロパティがゼロの場合，Content プロパティの長さはわかりません。要求にまったく Content がない場合もあれば，Web クライアントが Content プロパティの長さを知らなかった場合もあるからです。

注意

分割転送によって Content プロパティが渡されたとき，Content プロパティの長さは ContentLength 未満の場合があります。


TCGIRequest.ContentType
TCGIRequest.ContentType3043011

TCGIRequest	参照

ContentType プロパティは，HTTP 要求メッセージの Content-Type ヘッダーの値です。

property ContentType: string;

説明

ContentType プロパティを読み出すと，HTTP 要求メッセージの Content の媒体タイプがわかります。このプロパティは，Type/SubType 形式の文字列です。

ほとんどの HTTP 要求はまったく Content を要求しません。これを要求する Method を持った要求は大部分，ContentType が text/html です。ただし，サーバー固有の Method 値を持った HTTP 要求は，その要求に適したどんな媒体でも使用できます。


TCGIRequest.ContentVersion
TCGIRequest.ContentVersion3043012

TCGIRequest	参照

ContentVersion プロパティは，HTTP 要求メッセージの Content-Version ヘッダーの値です。

property ContentVersion: string;

説明

ContentVersion プロパティを読み出すと，HTTP 要求メッセージの Content のバージョンがわかります。ほとんどの HTTP 要求はまったく Content を要求しません。Method が Content の値を要求するときは，ContentVersion に内容のソースのバージョンを設定できます。ContentVersion の形式は要求の ContentType によって決まります。


TCGIRequest.Cookie
TCGIRequest.Cookie3043013

TCGIRequest	参照

Cookie プロパティは，HTTP 要求メッセージの Cookie ヘッダーの値です。

property Cookie: string;

説明

Cookie プロパティを使うと，Web クライアント要求内に指定されている「cookie」文字列を読み出すことができます。cookie 文字列を使えばどんな情報でもコード化できますが，この文字列は一般に Web アプリケーション内の状態情報を追跡するのに使用されます。Cookie プロパティは Cookie ヘッダーの分解されていない値です。Cookie ヘッダーには複数の項目をセミコロン（;）で区切って設定できます。項目単位で Cookie ヘッダーを処理するには，CookieFields プロパティを使います。


TCGIRequest.Date
TCGIRequest.Date3043014

TCGIRequest	参照

Date プロパティは，HTTP 要求メッセージの Date ヘッダーの値です。

property Date: TDateTime;

説明

Date プロパティを読み出すと，HTTP 要求メッセージが発生した日付と時間がわかります。このプロパティを使うと，要求の Content がまだ有効かどうかがわかります。このプロパティの値は，Web クライアントが設定した時間単位から，Windows のコントロールパネルで指定される地方時間に変換されます。

たとえば，HTTP 要求メッセージの MethodType 指定が mtPost で，Date プロパティが登録中の項目の最近値より古い場合，サーバーアプリケーションは，もっと新しい値に書き換えるのではなく，エラーを示すステータスコードを返します。

Date プロパティは TDateTime 型で表わされます。TDateTime の整数部は 1899 年 12 月 30 日からの経過日数で，小数部はその日の経過時間（24 時間制）です。


TCGIRequest.DerivedFrom
TCGIRequest.DerivedFrom3043015

TCGIRequest	参照

DerivedFrom プロパティは，HTTP 要求メッセージの Derived-From ヘッダーの値です。

property DerivedFrom: string;

説明

DerivedFrom プロパティを読み出すと，Content の値が発生した URI がわかります。このプロパティが意味を持つのは，要求に Content プロパティがあり，かつその Content プロパティが当該 Web クライアントから発生していないときだけです。


TCGIRequest.Expires
TCGIRequest.Expires3043016

TCGIRequest	参照

Expires プロパティは，HTTP 要求メッセージの Expires ヘッダーの値です。

property Expires: TDateTime;

説明

Expires プロパティを使うと，要求が「古く無効なもの」かどうかがわかります。このプロパティは，要求が無効になる日付と時間を表しています。このプロパティの値は，Web クライアントが設定した時間の単位から，Windows のコントロールパネルで示されるような地方時間に変換されます。

要求に max-age 疑似命令付きの CacheControl がある場合，この max-age 疑似命令で Expires プロパティの値がオーバーライドされます。

Expires プロパティは TDateTime 型で表わされます。TDateTime の整数部は 1899 年 12 月 30 日からの経過日数で，小数部はその日の経過時間（24時間制）です。


TCGIRequest.From
TCGIRequest.From3043017

TCGIRequest	参照

From プロパティは，HTTP 要求メッセージの From ヘッダーの値です。

property From: string;

説明

From プロパティを読み出すと，Web クライアントから HTTP 要求メッセージを送った人のインターネット e-mail アドレスがわかります。このプロパティの値は，ロギング用に使ったり，あるいは問題が発生した場合に要求の発信者と連絡するために使ったりできます。


TCGIRequest.Host
TCGIRequest.Host3043018

TCGIRequest	参照

Host プロパティは，HTTP 要求メッセージの Host ヘッダーの値です。

property Host: string;

説明

Host プロパティを読み出すと，要求されたリソースのインターネット上のホストとポート番号がわかります。たとえば，クライアントの要求が次の URL を指定しているとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

Host プロパティの値は次のようになります。

www.TSite.com

Host プロパティの値を使えば，内部的にあいまいな URL を区別できます。たとえば，1 つの IP アドレスに複数のホスト名があるサーバーのルート（/）URL などを区別できます。


TCGIRequest.IfModifiedSince
TCGIRequest.IfModifiedSince3043019

TCGIRequest	参照

IfModifiedSince プロパティは，HTTP 要求メッセージの If-Modified-Since ヘッダーの値です。

property IfModifiedSince: TDateTime;

説明

MethodType が mtGet である要求の IfModifiedSince プロパティを読み出すと，その要求が条件付き要求かどうかがわかります。Web クライアントが要求した情報が IfModifiedSince プロパティによって指定された時間以降，変更されていない場合，応答は，URL プロパティによって示される情報ではなく，変更なしエラーとなるはずです。

IfModifiedSince プロパティの値は，Web クライアントのクロックではなく，Windows コントロールパネル内に示されたローカルクロックによって指定されます。

IfModifiedSince プロパティは TDateTime 型で表わされます。TDateTime の整数部は 1899 年 12 月 30 日からの経過日数で，小数部はその日の経過時間（24時間制）です。


TCGIRequest.Method
TCGIRequest.Method3043020

TCGIRequest	参照

Method プロパティは，HTTP 要求メッセージの Method ヘッダーの値です。

property Method: string;

説明

Method プロパティを読み出すと，Web クライアントが要求したメソッドがわかります。HTTP 1.1 規格では，以下の値を定義しています。

値	意味

OPTIONS	利用できる通信オプションに関する情報を求める

GET	URL プロパティによって示される情報を求める

HEAD	HTTP 応答のプロパティ情報（応答の内容以外）を求める

POST	サーバーアプリケーションに，Content プロパティ内のデータを登録するよう求める

PUT	サーバーアプリケーションに，URL プロパティが示すリソースを Content プロパティ内のデータで置き換えるよう求める

DELETE	サーバーアプリケーションに，URL プロパティが示すリソースを削除または隠すよう求める

TRACE	要求が受取られたかどうかを確認するために，サーバーアプリケーションにループバックを返信するよう求める

Method プロパティは，Web クライアントがサーバーに要求した他のメソッドを示すことがあります。このプロパティが TCGIResponse オブジェクトの Allow プロパティと一致しない場合，その要求は処理できません。

MethodType プロパティは，Method プロパティの値が GET，HEAD，POST，PUT，あるいは他の文字列のいずれかであることを示します。できる限り，Method プロパティではなく MethodType プロパティを使って，文字列比較の負荷を減らしてください。

注意

HTTP アプリケーションは，メソッドのすべての種類に対処できる必要はありません。ただし，GET メソッドと HEAD メソッドの要求には応答しなければなりません。


TCGIRequest.PathInfo
TCGIRequest.PathInfo3043021

TCGIRequest	参照

PathInfo プロパティは，HTTP 要求メッセージ内に指定された URL のパス情報（存在する場合）の値です。

property PathInfo: string;

説明

PathInfo プロパティを読み出すと，要求のターゲットが存在するサーバーマシン上のパスがわかります。たとえば，次の URL があるとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

/gallery.dll が Web サーバーアプリケーションとすると，PathInfo は次のようになります。

/mammals

TWebDispatcher オブジェクトは，PathInfo を使って，要求メッセージを処理する適切な TWebActionItem を決定します。


TCGIRequest.PathTranslated
TCGIRequest.PathTranslated3043022

TCGIRequest	参照

PathTranslated プロパティは，PathInfo プロパティの値をフルパスに変換した値です。

property PathTranslated: string;

説明

PathTranslated プロパティを使うと，HTTP 応答内で要求ターゲットの場所を参照できます。


TCGIRequest.ProtocolVersion
TCGIRequest.ProtocolVersion3043023

TCGIRequest	参照

ProtocolVersion プロパティは，HTTP 要求メッセージの開始ヘッダ内に指定された HTTP プロトコルのバージョン番号です。

property ProtocolVersion: string;

説明

ProtocolVersion プロパティを使うと，Web クライアントが HTTP 要求メッセージを作成するときに使用するプロトコルがわかります。

HTTP 要求メッセージのプロパティには，ProtocolVersion プロパティの値によって解釈が異なるものがあります。たとえば，ProtocolVersion が 1.0 の場合，Connection プロパティが close オプションでなくても，接続は一時的とみなされます。


TCGIRequest.Query
TCGIRequest.Query3043024

TCGIRequest	参照

Query プロパティは，HTTP 要求メッセージ内に指定された URL の問い合わせ情報（存在する場合）の値です。

property Query: string;

説明

Query プロパティを読み出すと，Web クライアント要求の URL 内に指定された問い合わせの詳細な内容がわかります。たとえば，次の URL があるとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

/gallery.dll が Web サーバーアプリケーションとすると，Query は次のようになります。

animal=dog&color=black

Query プロパティは，URL の分解前の問い合わせ部分です。問い合わせには複数の項目があり，アンド記号（&）で区切られます。QueryFields プロパティを使うと，項目単位で問い合わせを処理できます。


TCGIRequest.Referer
TCGIRequest.Referer3043025

TCGIRequest	参照

Referer プロパティは，HTTP 要求メッセージの Referer ヘッダーの値です。

property Referer: string;

説明

Referer プロパティを読み出すと，HTTP 要求メッセージが発生したリソースの URI がわかります。このプロパティを使ってサーバーアプリケーションは，要求ソースへのバックリンクを作成できます。このプロパティが URI の一部である場合，これは URL プロパティへの相対パスとみなさないといけません。

HTTP 要求の URL が，ユーザーキーボードからの入力のように自身の URI を持っていないソースから取得したものであるとき，Referer プロパティは設定されません。


TCGIRequest.RemoteAddr
TCGIRequest.RemoteAddr3043026

TCGIRequest	参照

RemoteAddr プロパティは，HTTP 要求メッセージに関連付けられたクライアントのリモート IP アドレスです。

property RemoteAddr: string;

説明

RemoteAddr プロパティを読み出すと，Web クライアント要求が発生したソースの IP アドレスを取得できます。


TCGIRequest.RemoteHost
TCGIRequest.RemoteHost3043027

TCGIRequest	参照

RemoteHost プロパティは，HTTP 要求メッセージに関連付けられたクライアントの逆ドメイン参照（フルパス）です。

property RemoteHost: string;

説明

RemoteHost プロパティを使うと，Referer プロパティが指定されていないときに要求ソースへのバックリンクを示す URI 値を生成できます。このプロパティにはパス情報が含まれていません。


TCGIRequest.ScriptName
TCGIRequest.ScriptName3043028

TCGIRequest	参照

ScriptName プロパティは，HTTP 要求メッセージ内に指定された URL のスクリプト情報（存在する場合）の値です。

property ScriptName: string;

説明

ScriptName プロパティを読み出すと，クライアント要求によって指定された Web サーバーアプリケーションへのフルパスがわかります。たとえば，次の URL があるとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

/gallery.dll が Web サーバーアプリケーションとすると，ScriptName は次のようになります。

/art/gallery


TCGIRequest.ServerPort
TCGIRequest.ServerPort3043029

TCGIRequest	参照

ServerPort プロパティは，Web サーバー上で HTTP 要求メッセージを受け取るポートのポート番号です。

property ServerPort: Integer;

説明

ServerPort プロパティを読み出すと，Web サーバーの接続に使用されたポートの番号がわかります。ServerPort がクライアント要求の URL の一部として指定された場合，Host プロパティは ServerPort を含みます。


TCGIRequest.Title
TCGIRequest.Title3043030

TCGIRequest	参照

TiTle プロパティは，HTTP 要求メッセージの Title ヘッダーの値です。

property Title: string;

説明

Title プロパティを読み出すと，Web クライアント要求内で要求された情報のタイトルがわかります。


TCGIRequest.URL
TCGIRequest.URL3043031

TCGIRequest	参照

URL プロパティは，要求のターゲットを示すために HTTP 要求メッセージが指定した Uniform Resource Identifier（URI）です。

property URL: string;

説明

URL プロパティを使うと，要求メッセージのターゲットとして Web クライアントが指定したリソースがわかります。URL は，返すべき HTML ページ，作成または削除するリソース，Web クライアントに他のサービスを提供するオブジェクトのいずれかです。

TCGIRequest オブジェクトは，URL を各構成要素に分解して，Host，ScriptName，PathInfo，および Query の各プロパティを生成します。

注意

通常，URL プロパティは，ホスト，スクリプト，パス，および問い合わせに分解できる Uniform Resource Locator（URL）です。しかし，HTTP 要求メッセージでは，Uniform Resource Identifier（URI）のように一般的な用語でターゲットを指定することもできます。


TCGIRequest.UserAgent
TCGIRequest.UserAgent3043032

TCGIRequest	参照

UserAgent プロパティは，HTTP 要求メッセージの User-Agent ヘッダーの値です。

property UserAgent: string;

説明

UserAgent プロパティを読み出すと，クライアント要求を発生したユーザーエージェントに関する情報を取得できます。この情報は，統計目的やプロトコル違反の追跡に使ったり，クライアント要求を生成する特定のアプリケーションの既知の制限に合わせて応答を変えるために使います。UserAgent 文字列には 1 つまたは複数の記述子が含まれ，重要度の順番に並んでいます。各記述子は，要求を生成した製品やアプリケーションの名前，あるいはユーザーエージェントに関する注釈を表しています。


TCGIRequest メソッド3043033

TCGIRequest	アルファベット順	凡例

TCGIRequest

Create

GetDateVariable

GetFieldByName

GetIntegerVariable

GetStringVariable

ReadClient

ReadString

TranslateURI

WriteClient

WriteString

TWebRequest からの継承

Destroy

ExtractContentFields

ExtractCookieFields

ExtractFields

ExtractQueryFields

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCGIRequest メソッド3043034

TCGIRequest	オブジェクト順	凡例

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

ExtractContentFields

ExtractCookieFields

ExtractFields

ExtractQueryFields

FieldAddress

Free

FreeInstance

GetDateVariable

GetFieldByName

GetIntegerVariable

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetStringVariable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadClient

ReadString

SafeCallException

TranslateURI

WriteClient

WriteString


TCGIRequest.Create
TCGIRequest.Create3043035

TCGIRequest	参照

Create メソッドは，TCGIRequest のインスタンスを作成します。

constructor Create;

説明

アプリケーションは Create を呼び出して CGI 要求オブジェクトをインスタンス化する必要はありません。TCGIApplication オブジェクトは，クライアントの要求を受け取ると TCGIRequest オブジェクトを作成します。


TCGIRequest.GetDateVariable
TCGIRequest.GetDateVariable3043036

TCGIRequest	参照

GetDateVariable メソッドは，HTTP ヘッダー変数の内部テーブルから日付値を抽出します。

function GetDateVariable(Index: Integer): TDateTime; override;

説明

GetDateVariable は HTTP 要求メッセージのヘッダー文字列から日付時刻値を読み出します。CGI 要求オブジェクトは GetDateVariable を使って HTTP 要求ヘッダーから日付を表すプロパティにアクセスします。


TCGIRequest.GetFieldByName
TCGIRequest.GetFieldByName3043037

TCGIRequest	参照

GetFieldByName メソッドは，Name パラメータによって指定された HTTP ヘッダー変数の値を返します。

function GetFieldByName(const Name: string): string; override;

説明

GetFieldByName メソッドを使うと，TCGIRequest のプロパティとして表に示されていない HTTP ヘッダー変数の値を読み出すことができます。利用できる HTTP 要求ヘッダー変数については，現在のインターネット規格文書を参照してください。


TCGIRequest.GetIntegerVariable
TCGIRequest.GetIntegerVariable3043038

TCGIRequest	参照

GetIntegerVariable メソッドは，HTTP ヘッダー変数の内部テーブルから整数値を抽出します。

function GetIntegerVariable(Index: Integer): Integer; override;

説明

GetIntegerVariable メソッドは HTTP 要求メッセージのヘッダー文字列から整数値を読み出します。CGI 要求オブジェクトは GetIntegerVariable を使って HTTP 要求ヘッダーから整数を表すプロパティにアクセスします


TCGIRequest.GetStringVariable
TCGIRequest.GetStringVariable3043039

TCGIRequest	参照

GetStringVariable メソッドは，HTTP ヘッダー変数の内部テーブルから文字列値を抽出します。

function GetStringVariable(Index: Integer): string; override;

説明

GetStringVariable メソッドは HTTP 要求メッセージのヘッダー文字列から文字列値を読み出します。CGI 要求オブジェクトは GetStringVariable を使って HTTP 要求ヘッダーから文字列を表すプロパティにアクセスします。


TCGIRequest.ReadClient
TCGIRequest.ReadClient3043040

TCGIRequest	参照

ReadClient メソッドは，HTTP 要求から Count バイトのデータを Buffer に読み出します。

function ReadClient(var Buffer; Count: Integer): Integer; override;

説明

ReadClient メソッドを使うと，HTTP 要求の内容から，情報を小分けにしてバッファにロードできます。要求メッセージの内容が Content プロパティで読み出すには大きすぎる場合，このメソッドを使うと，サーバーアプリケーションは，何回かに分けて情報を取得できます。ReadClient は実際に読み出したバイト数を返します。読み出すべき情報がなくなったときは，-1 を返します。


TCGIRequest.ReadString
TCGIRequest.ReadString3043041

TCGIRequest	参照

ReadString メソッドは，HTTP 要求から Count バイトのデータを文字列に読み出します。

function ReadString(Count: Integer): string; override;

説明

ReadString メソッドを使うと，HTTP 要求の内容から，情報を小分けにして文字列にロードできます。要求メッセージの内容が Content プロパティで読み出すには大きすぎる場合，このメソッドを使うと，サーバーアプリケーションは，何回かに分けて情報を取得できます。


TCGIRequest.TranslateURI
TCGIRequest.TranslateURI3043042

TCGIRequest	参照

TranslateURI メソッドは，CGI 要求オブジェクトで使われる場合には何も処理を行いません。

function TranslateURI(const URI: string): string; override;

説明

TranslateURI は HTTP 要求オブジェクトとともに使われ，クライアント要求で指定された URI をサーバーアプリケーションが使える形式に変換します。CGI アプリケーションが直接 URI 値を扱う場合，変換の必要はありません。


TCGIRequest.WriteClient
TCGIRequest.WriteClient3043043

TCGIRequest	参照

WriteClient メソッドは，Count バイトのデータを Buffer から元の HTTP クライアントに書き込みます。

function WriteClient(var Buffer; Count: Integer): Integer; override;

説明

WriteClient メソッドを使うと，元の Web クライアントに応答の内容を書き込むことができます。


TCGIRequest.WriteString
TCGIRequest.WriteString3043044

TCGIRequest	参照

WriteString メソッドは，元の HTTP クライアントに文字列 AString を書き込みます。

function WriteString(const AString: string): Boolean; virtual; override;

説明

WriteString メソッドを使うと，元の Web クライアントに応答の内容を書き込むことができます。


読み出し／書き込み3043045

読み出し専用


スコープ3043046

protected


継承3043047

TObject

TWebRequest


TCGIRequest 例3043048

TCGIRequest


TCGIResponse
TCGIResponse3044001

継承	プロパティ	メソッド	参照

TCGIResponse オブジェクトは，CGI アプリケーションが HTTP 要求メッセージに応答して送る HTTP メッセージを表します。

ユニット

cgiapp

説明

TCGIResponse を使うと，CGI アプリケーションで HTTP 要求メッセージに対する応答を指定できます。

CGI アプリケーションは，Web クライアントから送られた要求メッセージの TCGIRequest オブジェクトに基づいて TCGIResponse オブジェクトを作成します。次にアプリケーションの TWebDispatcher は，TCGIRequest オブジェクトに関連付けられた TWebActionItem オブジェクトに TCGIResponse オブジェクトを渡します。TWebActionItem は TCGIResponse オブジェクトのプロパティを設定します。


TCGIResponse プロパティ3044002

TCGIResponse	アルファベット順	凡例

TCGIResponse

Allow

Content

ContentEncoding

ContentLength

ContentType

ContentVersion

Date

DerivedFrom

Expires

LastModified

Location

LogMessage

Realm

ReasonString

Server

StatusCode

Title

Version

WWWAuthenticate

TWebResponse からの継承

ContentStream

Cookies

CustomHeaders

HTTPRequest


TCGIResponse プロパティ3044003

TCGIResponse	オブジェクト順	凡例

Allow

Content

ContentEncoding

ContentLength

ContentStream

ContentType

ContentVersion

Cookies

CustomHeaders

Date

DerivedFrom

Expires

HTTPRequest

LastModified

Location

LogMessage

Realm

ReasonString

Server

StatusCode

Title

Version

WWWAuthenticate


TCGIResponse.Allow
TCGIResponse.Allow3044004

TCGIResponse	参照

Allow プロパティは，TWebResponse オブジェクトが対応できる HTTP 要求メソッドのリストです。

property Allow: string;

説明

Allow プロパティは，HTTPRequest プロパティに指定された URL に対してサーバーアプリケーションがどのようなタイプの要求メソッドに応答できるかを指定できます。このプロパティは，カンマで区切られたメソッド名からなる文字列です。これらのメソッド名には，HTTP の定義済みメソッドまたはサーバーアプリケーション作成の追加メソッドをすべて含めることができます。少なくとも，TCGIResponse オブジェクトは，GET 要求と HEAD 要求に対応できなければなりません。


TCGIResponse.Content
TCGIResponse.Content3044005

TCGIResponse	参照

Content プロパティは，HTTP 要求メッセージに対する応答として Web クライアントに返される情報です。

property Content: string;

説明

Content プロパティは，要求された情報を Web クライアントに送信できます。すべての HTTP 要求メッセージに対して情報を返す必要はありません。たとえば，OPTIONS，HEAD，POST，PUT，DELETE，または TRACE の Method を持った要求に対する応答には，Content を含めてはいけません。これらの場合にはいずれも，応答情報は完全に応答ヘッダーに含まれ，このヘッダーは TCGIResponse オブジェクトが持つ Content 以外のプロパティから作成されます。

応答内容は，HTML コマンドの文字列，HTML ファイル名，ビットストリームなどのグラフィックコンテンツ，または他の MIME コンテンツタイプです。

注意

ContentStream プロパティ が設定されている場合，それが Content プロパティの値に取って代わります。Content と ContentStream の両方が設定されている場合，Web クライアントは，Content プロパティの値ではなく，ContentStream の値を受け取ります。


TCGIResponse.ContentEncoding
TCGIResponse.ContentEncoding3044006

TCGIResponse	参照

ContentEncoding プロパティは，HTTP 応答メッセージの内容をコード化するためのメカニズム（存在する場合）をリストに表示します。

property ContentEncoding: string;

説明

ContentEncoding プロパティは，Content プロパティの値を Web クライアントに送る前にコード化したときに設定します。コード化メカニズムは，適用される順序でリストに表示され，カンマで区切られます。一般に，このプロパティは，ネット上で拡張 ASCII 文字を転送するのに使われる圧縮方式またはコード化方式を表します。


TCGIResponse.ContentLength
TCGIResponse.ContentLength3044007

TCGIResponse	参照

ContentLength プロパティは，Content プロパティの長さ（バイト単位）です。

property ContentLength: Integer;

説明

ContentLength プロパティは Content プロパティの長さがわかっている場合，その値を設定します。わかっていない場合，または HTTP 応答メッセージにまったく内容がない場合は，0 を設定します。Web クライアントは，ContentLength プロパティを使って，HTTP 応答メッセージの内容を読み出します。

応答メッセージの内容をストリームから得る場合は，ContentLength プロパティの値はそのストリームから設定されます。


TCGIResponse.ContentType
TCGIResponse.ContentType3044008

TCGIResponse	参照

ContentType プロパティは HTTP 応答メッセージの Content のメディアタイプの値です。

property ContentType: string;

説明

ContentType プロパティを設定すると，HTTP 応答メッセージの Content のメディアタイプを指定できます。このプロパティの値には，有効な MIME コンテンツタイプを指定しなくてはなりません。ContentType 文字列の形式は Type/SubType です。

たとえば，GET 要求に対する HTTP 応答メッセージとして HTML コマンドからなる文字列を Web クライアントに返す場合，ContentType は text/html になります。

注意

HTTP 要求メッセージに Accept ヘッダーが含まれている場合，ContentType は TCGIRequest.Accept プロパティに一覧表示されたコンテンツタイプのいずれかでなければなりません。


TCGIResponse.ContentVersion
TCGIResponse.ContentVersion3044009

TCGIResponse	参照

ContentVersion プロパティは，HTTP 応答メッセージの Content に関連付けられたバージョンを表す文字列です。

property ContentVersion: string;

説明

ContentVersion プロパティは，HTTP 応答の Content に関連付けられたバージョンを指定できます。ContentVersion の意味は，HTTP 応答として送る情報の種類によって変わります。たとえば，HTTP 応答の Content に text/html という ContentType が含まれている場合，ContentVersion の値は使用される HTML のバージョンになるはずです。

ContentVersion プロパティの意味を規定するサーバーアプリケーションは，その意味を明確に記述しておかなければなりません。


TCGIResponse.Date
TCGIResponse.Date3044010

TCGIResponse	参照

Date プロパティは，HTTP 応答メッセージを Web クライアントに送る日時です。

property Date: TDateTime;

説明

HTTP 応答メッセージを Web クライアントに送る直前に，Date プロパティに現在の日時を設定します。Web クライアントは，このプロパティを使って，返された情報の新しさを判断します。

Date は TDateTime 型で表します。TDateTime 値の整数部は 1899 年 12 月 30 日以降の経過日数です。小数部はその日の経過時間（24 時間制）です。


TCGIResponse.DerivedFrom
TCGIResponse.DerivedFrom3044011

TCGIResponse	参照

DerivedFrom プロパティは，HTTP 応答の Content が発生したリソースの URI です。

property DerivedFrom: string;

説明

DerivedFrom プロパティは，Content の値が発生した URI を設定します。この設定が特に重要になるのは，HTTP 応答メッセージの URL プロパティが示すリソースから HTTP 応答の Content が発生しなかったときです。


TCGIResponse.Expires
TCGIResponse.Expires3044012

TCGIResponse	参照

Expires プロパティは，HTTP 応答メッセージの Content についてそれ以降を無効とみなす日時を指定します。

property Expires: TDateTime;

説明

Expires プロパティは，時間が経過すると無効になる可能性がある情報が，HTTP 応答メッセージの Content に含まれているときに設定します。このプロパティを設定しても，設定した日時になったら，必ずメッセージの情報やソースが変わったりなくなったりするわけではありません。Web クライアントは，Expires プロパティが示す日時以降，情報の新しさをチェックするよう警告されるだけです。

Expires の値は，マシンの地方時間で指定されます。HTTP 応答メッセージは，この値を HTTP が使う日付コードに変換します。

Expires は TDateTime 型で表します。TDateTime 値の整数部は 1899 年 12 月 30 日以降の経過日数です。小数部はその日の経過時間（24 時間制）です。


TCGIResponse.LastModified
TCGIResponse.LastModified3044013

TCGIResponse	参照

LastModified プロパティは，Content プロパティの値が最後に更新された日時を示します。

property LastModified: TDateTime;

説明

LastModified プロパティは，HTTP 応答の Content プロパティが最後に変更された時間を設定します。この値によって Web クライアントは，情報のローカルバージョンが最新のものかどうかを知ることができます。HTTP 要求が HEAD メッセージの場合，Web クライアントとサーバーは，転送するとコストがかかりそうな情報をスキップできます。

LastModified の値は，マシンの地域時間で指定されます。 HTTP 応答メッセージは，この値を HTTP が使う日付コードに変換します。

LastModified は TDateTime 型で表します。TDateTime 値の整数部は 1899 年 12 月 30 日以降の経過日数です。小数部はその日の経過時間（24 時間制）です。


TCGIResponse.Location
TCGIResponse.Location3044014

TCGIResponse	参照

Location プロパティは，要求を完了するために Web クライアントが指さなくてはならないリソースの URI です。

property Location: string;

説明

Location プロパティは，HTTPResponse が HTTP 要求メッセージに対応する新しいリソースを作成したとき，または応答の処理を HTTP 要求メッセージ内で指定された URI 以外の URI に代行させなくてはならないときに設定します。


TCGIResponse.LogMessage
TCGIResponse.LogMessage3044015

TCGIResponse	参照

LogMessage プロパティは，処理の内容を記述した文字列で，イベントログ用に HTTP 応答メッセージ内に含めるものです。

property LogMessage: string;

説明

LogMessage プロパティは，HTTP 応答処理を行なう TWebActionItem オブジェクトが実行したアクションの内容を設定します。通常，このプロパティには，HTTP 要求メッセージを扱った URI と日時情報が含まれます。


TCGIResponse.Realm
TCGIResponse.Realm3044016

TCGIResponse	参照

Realm プロパティはプロテクトアクセス URI 群で，HTTP 要求メッセージによって指定された URI を含みます。

property Realm: string;

説明

Realm プロパティは，HTTP 応答メッセージが 401（Unauthorized）または 402（Payment required）を返したときに設定します。このプロパティは，Web クライアントがパスワードを指定したり，対価を払ったりしないとアクセスできない URI 群の名前です。HTTP 要求メッセージ内の URI を含めて，プロパティ内の URI はすべて，Web クライアントがパスワードを指定したり対価を払ったりすればすぐにアクセスできるようになります。サーバーアプリケーションは，THTTPRequest オブジェクトによるクライアント情報を使って，クライアントのパスワードや対価支払いについて内部的に継続して観察していかなくてはなりません。


TCGIResponse.ReasonString
TCGIResponse.ReasonString3044017

TCGIResponse	参照

ReasonString プロパティは，Web クライアントの要求に対する応答のステータスを示すテキスト文字列です。

property ReasonString: string;

説明

ReasonString プロパティを設定すると，HTTP 要求メッセージの成功または失敗を Web クライアントに通知できます。この原因文字列は応答のステータスを示す 3 桁のステータスコードに関連付けられています。HTTP 規格ではあらかじめ，多くのステータスコードと，それに対応する原因文字列を規定しています。これ以外に，サーバーアプリケーションは新しい原因文字列を定義して，未使用のステータスコードに関連付けることができます。


TCGIResponse.Server
TCGIResponse.Server3044018

TCGIResponse	参照

Server プロパティは，要求を処理するためにサーバーアプリケーションが使用するソフトウェアについての情報を提供します。

property Server: string;

説明

Server プロパティは，HTTP 応答メッセージの Content を提供するアプリケーションの名前とバージョン番号からなる文字列を設定します。Server プロパティの値には，複数の製品識別子とコメントを含めることができます。これらの製品識別子とコメントはスペースで区切られ，重要度の順に一覧表示されます。製品識別子は ProductName/VersionNumber の形式を取ります。


TCGIResponse.StatusCode
TCGIResponse.StatusCode3044019

TCGIResponse	参照

StatusCode プロパティは 3 桁の整数値で，HTTP 要求メッセージに対する応答のステータスを示します。

property StatusCode: Integer;

説明

StatusCode プロパティを設定すると，HTTP 要求メッセージのステータスを Web クライアントに通知できます。ステータスコードは，Web クライアントなら誰でも理解できる標準的な戻り値です。各ステータスコードには対応する原因文字列があり，これによって Web クライアントはステータスの意味を理解しやすくなります。

以下に，利用できるステータスコードとそれに対応する原因文字列を示します。

StatusCode	ReasonString

100	Continue

101	Switching Protocols

200	OK

201	Created

202	Accepted

203	Non-Authoritative Information

204	No Content

205	Reset Content

206	Partial Content

300	Multiple Choices

301	Moved Permanently

302	Moved Temporarily

303	See Other

304	Not Modified

305	Use Proxy

400	Bad Request

401	Unauthorized

402	Payment Required

403	Forbidden

404	Not Found

405	Method Not Allowed

406	Not Acceptable

407	Proxy Authentication Required

408	Request Time-out

409	Conflict

410	Gone

411	Length Required

412	Precondition Failed

413	Request Entity Too Large

414	Request-URI Too Large

415	Unsupported Media Type

500	Internal Server Error

501	Not Implemented

502	Bad Gateway

503	Service Unavailable

504	Gateway Time-out

505	HTTP Version not supported

上記のテーブルにないステータスコードは，サーバーアプリケーションで作成できます。新しいステータスコードを作成するときは，最上位桁に以下の応答クラスを指定しなくてはなりません。

・	1xx: 通知（要求受信済み，処理続行中）

・	2xx: 成功（要求受信済み，了解済み，受け入れ済み）

・	3xx: 転送（要求処理を終了するにはさらに処理が必要）

・	4xx: クライアントエラー（要求に不正な構文があるか，要求のサービスができない）

・	5xx: サーバーエラー（サーバーが有効な要求を処理できなかった）


TCGIResponse.Title
TCGIResponse.Title3044020

TCGIResponse	参照

Title プロパティは，HTTP 応答メッセージの Content のタイトルを指定します。

property Title: string;

説明

Title プロパティ を設定すると，HTTP 応答メッセージに Title ヘッダーを追加できます。このプロパティは，応答メッセージに含まれている情報に関連付けられたアプリケーション固有のオプションタイトルです。


TCGIResponse.Version
TCGIResponse.Version3044021

TCGIResponse	参照

Version プロパティは，Web クライアントが使用している HTTP プロトコルのバージョン番号です。

property Version: string;

説明

Version プロパティは，Web クライアントは TCGIResponse オブジェクトに設定されたプロパティを確実に理解できるようになります。Version プロパティの値は，HTTPRequest プロパティの ProtocolVersion プロパティから取得されます。

HTTP プロトコルの各種バージョンについては，World Wide Web Consortium のホームページ <http://www.w3.org> にアクセスして，プロトコルを参照してください。


TCGIResponse.WWWAuthenticate
TCGIResponse.WWWAuthenticate3044022

TCGIResponse	参照

WWWAuthenticate プロパティは，カンマで区切られた 1 つまたは複数の未処理アクセスからなるリストで，StatusCode 401（Unauthorized）で要求が失敗したときに提供されます。

property WWWAuthenticate: string;

説明

WWWAuthenticate プロパティは，Web クライアントにパスワードが提供されていない realm 内の URI へのアクセスを要求したために HTTP 要求が失敗したときに設定します。このプロパティは，認証方式名と，認証方式にパラメータを与えるためのカンマで区切られたパラメータ/値の組み合せのリストから構成されます。最初のパラメータ/値の組み合せは realm を示します。

HTTP 認証方式についての詳細は，World Wide Web Consortium のホームページ <http://www.w3.org> にアクセスして，プロトコルを参照してください。


TCGIResponse メソッド3044023

TCGIResponse	アルファベット順	凡例

TCGIResponse

Create

GetContent

GetDateVariable

GetIntegerVariable

GetLogMessage

GetStatusCode

GetStringVariable

SendRedirect

SendResponse

SendStream

Sent

SetContent

SetDateVariable

SetIntegerVariable

SetLogMessage

SetStatusCode

SetStringVariable

TWebResponse からの継承

Destroy

GetCustomHeader

SetCookieField

SetCustomHeader

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCGIResponse メソッド3044024

TCGIResponse	オブジェクト順	凡例

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetContent

GetCustomHeader

GetDateVariable

GetIntegerVariable

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetLogMessage

GetStatusCode

GetStringVariable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

SendRedirect

SendResponse

SendStream

Sent

SetContent

SetCookieField

SetCustomHeader

SetDateVariable

SetIntegerVariable

SetLogMessage

SetStatusCode

SetStringVariable


TCGIResponse.Create
TCGIResponse.Create3044025

TCGIResponse	参照

Create メソッドは，TCGIResponse のインスタンスを作成して，HTTPRequest パラメータに対する応答メッセージを生成します。

constructor Create(HTTPRequest: TWebRequest);

説明

CGI の応答オブジェクトをインスタンス化するために，アプリケーションで Create メソッドを呼び出す必要はありません。TCGIApplication オブジェクトは，各 TCGIRequest に対して TCGIResponse を作成します。


TCGIResponse.GetContent
TCGIResponse.GetContent3044026

TCGIResponse	参照

GetContent メソッドは，Content プロパティの値を読み出します。

function GetContent: string; override;

説明

GetContent メソッドは Content プロパティのためのアクセス機能です。


TCGIResponse.GetDateVariable
TCGIResponse.GetDateVariable3044027

TCGIResponse	参照

GetDateVariable メソッドは，HTTP ヘッダー変数の内部テーブルから日付を抽出します。

function GetDateVariable(Index: Integer): TDateTime; override;

説明

CGI 応答オブジェクトは GetDateVariable メソッドを使って，日付を表すプロパティにアクセスします。


TCGIResponse.GetIntegerVariable
TCGIResponse.GetIntegerVariable3044028

TCGIResponse	参照

GetIntegerVariable メソッドは，HTTP ヘッダー変数の内部テーブルから整数値を抽出します。

function GetIntegerVariable(Index: Integer): Integer; override;

説明

CGI 応答オブジェクトは GetIntegerVariable メソッドを使って，整数を表すプロパティにアクセスします。


TCGIResponse.GetLogMessage
TCGIResponse.GetLogMessage3044029

TCGIResponse	参照

GetLogMessage メソッドは，LogMessage プロパティの値を読み出します。

function GetLogMessage: string; override;

説明

GetLogMessage メソッドは LogMessage プロパティのためのアクセス機能です。


TCGIResponse.GetStatusCode
TCGIResponse.GetStatusCode3044030

TCGIResponse	参照

GetStatusCode メソッドは，StatusCode プロパティの値を読み出します。

function GetStatusCode: Integer; override;

説明

GetStatusCode メソッドは StatusCode プロパティのためのアクセス機能です。


TCGIResponse.GetStringVariable
TCGIResponse.GetStringVariable3044031

TCGIResponse	参照

GetStringVariable メソッドは，HTTP ヘッダー変数の内部テーブルから文字列値を抽出します。

function GetStringVariable(Index: Integer): string; override;

説明

CGI 応答オブジェクトは GetStringVariable メソッドを使って，文字列値を表すプロパティにアクセスします。


TCGIResponse.SendRedirect
TCGIResponse.SendRedirect3044032

TCGIResponse	参照

SendRedirect メソッドは，StatusCode が 301（Moved Permanently）で URI パラメータに Location が設定されている応答を送ります。

procedure SendRedirect(const URI: string); override;

説明

SendRedirect を呼び出すと，Web クライアント要求が，その要求の正しいターゲットである URI に転送されます。このメソッドは，StatusCode が 301 で URI に Location が設定されている状態で SendResponse を呼び出した場合とまったく同じように機能します。


TCGIResponse.SendResponse
TCGIResponse.SendResponse3044033

TCGIResponse	参照

SendResponse メソッドは，Web クライアントに CGI 応答メッセージを送ります。

procedure SendResponse; override;

説明

CGI 応答オブジェクトのプロパティを設定した後に SendResponse メソッドを呼び出すと，Web クライアントに送らなければならない応答を指定できます。要求を別の URI に転送しなければならないときは，SendRedirect メソッドを呼び出す方が便利です。


TCGIResponse.SendStream
TCGIResponse.SendStream3044034

TCGIResponse	参照

SendStream メソッドは，AStream の内容を設定した CGI 応答メッセージを送ります。

procedure SendStream(AStream: TStream); override;

説明

最初に SendResponse メソッドを呼び出した後にだけ，SendStream メソッドを呼び出してください。SendStream メソッドと違って，SendResponse メソッドは TISAPIResponse オブジェクトのプロパティを基にして HTTP 応答メッセージのヘッダーを設定します。最初に SendResponse を呼び出して HTTP 応答メッセージのヘッダーを設定したのでない場合は，ContentStream プロパティを AStream に設定して SendResponse を呼び出してください。


TCGIResponse.Sent
TCGIResponse.Sent3044035

TCGIResponse	参照

Sent メソッドは，CGI 応答メッセージがすでに送られたかどうかを示す論理値を返します。

function Sent: Boolean; override;

説明

Sent メソッドは，SendRedirect メソッドまたは SendStream メソッドが呼び出された場合に True を返します。TCGIApplication は Sent を呼び出して，いつ Web クライアントに未送信の応答を送信するかを認識します。


TCGIResponse.SetContent
TCGIResponse.SetContent3044036

TCGIResponse	参照

SetContent メソッドは，Content プロパティを設定します。

procedure SetContent(const Value: string); override;

説明

SetContent メソッドは，CGI 応答オブジェクトが Content プロパティを設定するために使う Protected メソッドです。


TCGIResponse.SetDateVariable
TCGIResponse.SetDateVariable3044037

TCGIResponse	参照

SetDateVariable メソッドは，HTTP ヘッダープロパティに日時を設定します。

procedure SetDateVariable(Index: Integer; const Value: TDateTime); override;

説明

SetDateVariable メソッドは，HTTP ヘッダー変数を格納するために使われる内部テーブルに日時を書き込みます。CGI 応答オブジェクトは SetDateVariable を使って，日付を表すプロパティを設定します。


TCGIResponse.SetIntegerVariable
TCGIResponse.SetIntegerVariable3044038

TCGIResponse	参照

SetIntegerVariable メソッドは，HTTP ヘッダープロパティに整数値を設定します。

procedure SetIntegerVariable(Index: Integer; Value: Integer); override;

説明

SetIntegerVariable メソッドは，HTTP ヘッダー変数を格納するために使われる内部テーブルに整数値を書き込みます。CGI 応答オブジェクトは SetIntegerVariable を使って，整数を表すプロパティを設定します。


TCGIResponse.SetLogMessage
TCGIResponse.SetLogMessage3044039

TCGIResponse	参照

SetLogMessage メソッドは，LogMessage プロパティの値を設定します。

procedure SetLogMessage(const Value: string); virtual; abstract;

説明

SetLogMessage メソッドは，CGI 応答オブジェクトが LogMessage プロパティを設定するために使う Protected メソッドです。


TCGIResponse.SetStatusCode
TCGIResponse.SetStatusCode3044040

TCGIResponse	参照

SetStatusCode メソッドは，StatusCode プロパティを設定します。

procedure SetStatusCode(Value: Integer); override;

説明

SetStatusCode メソッドは，CGI 応答オブジェクトが StatusCode プロパティを設定するために使う Protected メソッドです。


TCGIResponse.SetStringVariable
TCGIResponse.SetStringVariable3044041

TCGIResponse	参照

SetStringVariable メソッドは，HTTP ヘッダープロパティに文字列値を設定します。

procedure SetStringVariable(Index: Integer; const Value: string); override;

説明

SetStringVariable メソッドは，HTTP ヘッダー変数を格納するために使われる内部テーブルに文字列値を書き込みます。CGI 応答オブジェクトは SetStringVariable を使って，文字列を表すプロパティを設定します。


読み出し／書き込み3044042

読み出し専用


スコープ3044043

protected


継承3044044

TObject

TWebResponse


TCGIResponse 例3044045

TCGIResponse


TWinCGIRequest
TWinCGIRequest3045001

継承	プロパティ	メソッド	参照

TWinCGIRequest オブジェクトは，Windows 制御下の CGI Web サーバーアプリケーションに渡されるクライアント要求情報を表します。

ユニット

cgiapp

説明

TWinCGIRequest を使うと，Windows 制御下の CGI Web アプリケーションに対するクライアント要求を解釈できます。

CGI アプリケーションオブジェクトは TWinCGIRequest オブジェクトを作成してクライアント要求を取得します。TWinCGIRequest オブジェクトのプロパティは Web サーバーから取得されます。CGI アプリケーションは TWinCGIRequest オブジェクトを使って，対応する TWinCGIResponse オブジェクトを作成します。次に，アプリケーションの TWebDispatcher オブジェクトは，TWinCGIRequest オブジェクトの URL のパス部分と関連付けられた TWebActionItem を呼び出します。


TWinCGIRequest プロパティ3045002

TWinCGIRequest	アルファベット順	凡例

TWinCGIRequest

Accept

Authorization

CacheControl

Connection

Content

ContentEncoding

ContentType

ContentVersion

Cookie

DerivedFrom

From

Host

Method

PathInfo

PathTranslated

ProtocolVersion

Query

Referer

RemoteAddr

RemoteHost

ScriptName

Title

URL

UserAgent

TCGIRequest からの継承

ContentLength

Date

Expires

IfModifiedSince

ServerPort

TWebRequest からの継承

ContentFields

CookieFields

MethodType

QueryFields


TWinCGIRequest プロパティ3045003

TWinCGIRequest	オブジェクト順	凡例

Accept

Authorization

CacheControl

Connection

Content

ContentEncoding

ContentFields

ContentLength

ContentType

ContentVersion

Cookie

CookieFields

Date

DerivedFrom

Expires

From

Host

IfModifiedSince

Method

MethodType

PathInfo

PathTranslated

ProtocolVersion

Query

QueryFields

Referer

RemoteAddr

RemoteHost

ScriptName

ServerPort

Title

URL

UserAgent


TWinCGIRequest.Accept
TWinCGIRequest.Accept3045004

TWinCGIRequest	参照

Accept プロパティは，HTTP 要求メッセージの Accept ヘッダーの値です。

property Accept: string;

説明

Accept プロパティを読み出すと，Web クライアントが応答メッセージを受け取れる媒体の種類がわかります。すべての要求メッセージに Accept ヘッダーがあるわけではありません。Accept プロパティが設定されていない場合は，すべての媒体の種類が受け取り可能になります。

Accept ヘッダーはふつう，応答メッセージを受け取れる望ましい媒体が限られていることを示しています。たとえば，オーディオ応答を要求する Web クライアントは，Accept プロパティに次の文字列を設定した TWinCGIRequest オブジェクトを作成します。

audio/*; q=0.2, audio/basic

この要求は，望ましい媒体の種類がオーディオ／ベーシックであるが，性能が 80% ダウンした後に利用して最善なのであれば，どんなオーディオ媒体でもかまわないということを示しています。

Accept ヘッダーの形式については，現在のインターネット規格文書を参照してください。


TWinCGIRequest.Authorization
TWinCGIRequest.Authorization3045005

TWinCGIRequest	参照

Authorization プロパティは，HTTP 要求メッセージの Authorization ヘッダーの値です。

property Authorization: string;

説明

Authorization プロパティを読み出すと，要求メッセージを送ったクライアントが正しい認証情報を提供したかどうかがわかります。Authorization を使うと，CGI アプリケーションは URL プロパティで指定したリソースへのアクセスを制限できます。

HTTP 認証スキームについての詳細は，インターネット規格文書を参照してください。


TWinCGIRequest.CacheControl
TWinCGIRequest.CacheControl3045006

TWinCGIRequest	参照

CacheControl プロパティは，HTTP 要求メッセージの Cache-Control ヘッダーの値です。

property CacheControl: string;

説明

CacheControl プロパティを読み出すと，要求／応答チェーンにおいてすべてのキャッシュメカニズムに従わなければならない Web クライアント疑似命令がすべてわかります。HTTP 要求の CacheControl 疑似命令を，対応する HTTP 応答に適用する必要はありません。

HTTP 1.1 規格では，次の CacheControl 疑似命令を定義しています。

値	意味

no-cache	要求をキャッシュできない。Web サーバーは要求を確認してから TWinCGIRequest オブジェクトを作成する

no-store	要求に感知型の情報があり，バックアップデープなどの永久的媒体に格納できない。この要求がファイル内に一時的に保存されている場合は，そのファイルを削除しなければならない

max-age=ss	要求は，ss 秒以上，古いものであれば無効とされる。Expires プロパティの方が制限時間が短いとしても，その Expires プロパティよりもこの疑似命令の方が優先する。Web サーバーが無効な要求を確認した後，TWinCGIRequest オブジェクトを作成する

max-stale or max-stale=ss	クライアントは，満了時間を超えた応答を受けとる用意がある。オプションの max-stale 疑似命令で，満了時間を何秒，超過してもよいかを示す

min-fresh=ss	クライアントは，ss 秒以内に満了になる応答を受け取らない


TWinCGIRequest.Connection
TWinCGIRequest.Connection3045007

TWinCGIRequest	参照

Connection プロパティは，HTTP 要求メッセージの Connection ヘッダーの値です。

property Connection: string;

説明

Connection プロパティを読み出すと，Web クライアントが要求するサーバーアプリケーションとの接続オプションがわかります。HTTP 1.1 規格では，Connection ヘッダーに 1 つしか値を指定しません。このプロパティの値が close の場合，応答処理完了後，接続を切断しないといけません。


TWinCGIRequest.Content
TWinCGIRequest.Content3045008

TWinCGIRequest	参照

Content プロパティは，HTTP 要求メッセージのまだ分解されていない内容を表します。

property Content: stringe;

説明

Content プロパティを使うと，サーバーに情報を送る HTTP 要求メッセージの内容を読み出すことができます。このプロパティの値は，HTTP 要求メッセージの Method によって決まります。Method が POST のとき，Content プロパティはまだ分解されていない文字列で，関連項目とともに登録される値を示します。Method が PUT のとき，Content プロパティは，URL プロパティによって指定された URL を置換する値になります。

注意

Method が POST の場合，分解済みの登録要求は ContentFields プロパティで得られます。


TWinCGIRequest.ContentEncoding
TWinCGIRequest.ContentEncoding3045009

TWinCGIRequest	参照

ContentEncoding プロパティは，HTTP 要求メッセージの Content-Encoding ヘッダーの値です。

property ContentEncoding: string;

説明

ContentEncoding プロパティを読み出すと，HTTP 要求の Content に適用されたコード化メカニズムがある場合，それを知ることができます。コード化メカニズムは，Web クライアントが適用した順番で並び，コンマで区切られています。一般にこのプロパティは，拡張 ASCII 文字をネット上で転送するための圧縮方式ないしコード化方式を示しています。

ContentEncoding メカニズムを逆に使用すると，Content プロパティの値を復元して，ContentType プロパティが指定する形式に設定できます。


TWinCGIRequest.ContentType
TWinCGIRequest.ContentType3045010

TWinCGIRequest	参照

ContentType プロパティは，HTTP 要求メッセージの Content-Type ヘッダーの値です。

property ContentType: string;

説明

ContentType プロパティを読み出すと，HTTP 要求メッセージの Content の媒体タイプがわかります。このプロパティは，Type/SubType 形式の文字列です。

ほとんどの HTTP 要求はまったく Content を要求しません。これを要求する Method を持った要求は大部分，ContentType が text/html です。ただし，サーバー固有の Method 値を持った HTTP 要求は，その要求に適したどんな媒体でも使用できます。


TWinCGIRequest.ContentVersion
TWinCGIRequest.ContentVersion3045011

TWinCGIRequest	参照

ContentVersion プロパティは，HTTP 要求メッセージの Content-Version ヘッダーの値です。

property ContentVersion: string;

説明

ContentVersion プロパティを読み出すと，HTTP 要求メッセージの Content のバージョンがわかります。ほとんどの HTTP 要求はまったく Content を要求しません。Method が Content の値を要求するときは，ContentVersion に内容のソースのバージョンを設定できます。ContentVersion の形式は要求の ContentType によって決まります。


TWinCGIRequest.Cookie
TWinCGIRequest.Cookie3045012

TWinCGIRequest	参照

Cookie プロパティは，HTTP 要求メッセージの Cookie ヘッダーの値です。

property Cookie: string;

説明

Cookie プロパティを使うと，Web クライアント要求内に指定されている「cookie」文字列を読み出すことができます。cookie 文字列を使えばどんな情報でもコード化できますが，この文字列は一般に Web アプリケーション内の状態情報を追跡するのに使用されます。Cookie プロパティは Cookie ヘッダーの分解されていない値です。Cookie ヘッダーには複数の項目をセミコロン（;）で区切って設定できます。項目単位で Cookie ヘッダーを処理するには，CookieFields プロパティを使います。


TWinCGIRequest.DerivedFrom
TWinCGIRequest.DerivedFrom3045013

TWinCGIRequest	参照

DerivedFrom プロパティは，HTTP 要求メッセージの Derived-From ヘッダーの値です。

property DerivedFrom: string;

説明

DerivedFrom プロパティを読み出すと，Content の値が発生した URI がわかります。このプロパティが意味を持つのは，要求に Content プロパティがあり，かつその Content プロパティが当該 Web クライアントから発生していないときだけです。


TWinCGIRequest.From
TWinCGIRequest.From3045014

TWinCGIRequest	参照

From プロパティは，HTTP 要求メッセージの From ヘッダーの値です。

property From: string;

説明

From プロパティを読み出すと，Web クライアントから HTTP 要求メッセージを送った人のインターネット e-mail アドレスがわかります。このプロパティの値は，ロギング用に使ったり，あるいは問題が発生した場合に要求の発信者と連絡するために使ったりできます。


TWinCGIRequest.Host
TWinCGIRequest.Host3045015

TWinCGIRequest	参照

Host プロパティは，HTTP 要求メッセージの Host ヘッダーの値です。

property Host: string;

説明

Host プロパティを読み出すと，要求されたリソースのインターネット上のホストとポート番号がわかります。たとえば，クライアントの要求が次の URL を指定しているとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

Host プロパティの値は次のようになります。

www.TSite.com

Host プロパティの値を使えば，内部的にあいまいな URL を区別できます。たとえば，1 つの IP アドレスに複数のホスト名があるサーバーのルート（/）URL などを区別できます。


TWinCGIRequest.Method
TWinCGIRequest.Method3045016

TWinCGIRequest	参照

Method プロパティは，HTTP 要求メッセージの Method ヘッダーの値です。

property Method: string;

説明

Method プロパティを読み出すと，Web クライアントが要求したメソッドがわかります。HTTP 1.1 規格では，以下の値を定義しています。

値	意味

OPTIONS	利用できる通信オプションに関する情報を求める

GET	URL プロパティによって示される情報を求める

HEAD	HTTP 応答のプロパティ情報（応答の内容以外）を求める

POST	サーバーアプリケーションに，Content プロパティ内のデータを登録するよう求める

PUT	サーバーアプリケーションに，URL プロパティが示すリソースを Content プロパティ内のデータで置き換えるよう求める

DELETE	サーバーアプリケーションに，URL プロパティが示すリソースを削除または隠すよう求める

TRACE	要求が受取られたかどうかを確認するために，サーバーアプリケーションにループバックを返信するよう求める

Method プロパティは，Web クライアントがサーバーに要求した他のメソッドを示すことがあります。このプロパティが TCGIResponse オブジェクトの Allow プロパティと一致しない場合，その要求は処理できません。

MethodType プロパティは，Method プロパティの値が GET，HEAD，POST，PUT，あるいは他の文字列のいずれかであることを示します。できる限り，Method プロパティではなく MethodType プロパティを使って，文字列比較の負荷を減らしてください。

注意

CGI アプリケーションは，メソッドのすべての種類に対処できる必要はありません。ただし，GET メソッドと HEAD メソッドの要求には応答しなければなりません。


TWinCGIRequest.PathInfo
TWinCGIRequest.PathInfo3045017

TWinCGIRequest	参照

PathInfo プロパティは，HTTP 要求メッセージ内に指定された URL のパス情報（存在する場合）の値です。

property PathInfo: string;

説明

PathInfo プロパティを読み出すと，要求のターゲットが存在するサーバーマシン上のパスがわかります。たとえば，次の URL があるとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

/gallery.dll が Web サーバーアプリケーションとすると，PathInfo は次のようになります。

/mammals

TWebDispatcher オブジェクトは，PathInfo を使って，要求メッセージを処理する適切な TWebActionItem を決定します。


TWinCGIRequest.PathTranslated
TWinCGIRequest.PathTranslated3045018

TWinCGIRequest	参照

PathTranslated プロパティは，PathInfo プロパティの値をフルパスに変換した値です。

property PathTranslated: string;

説明

PathTranslated を使うと，HTTP 応答内で要求ターゲットの場所を参照できます。


TWinCGIRequest.ProtocolVersion
TWinCGIRequest.ProtocolVersion3045019

TWinCGIRequest	参照

ProtocolVersion プロパティは，HTTP 要求メッセージの開始ヘッダ内に指定された HTTP プロトコルのバージョン番号です。

property ProtocolVersion: string;

説明

ProtocolVersion プロパティを使うと，Web クライアントが HTTP 要求メッセージを作成するときに使用するプロトコルがわかります。

HTTP 要求メッセージのプロパティには，ProtocolVersion プロパティの値によって解釈が異なるものがあります。たとえば，ProtocolVersion が 1.0 の場合，Connection プロパティが close オプションでなくても，接続は一時的とみなされます。


TWinCGIRequest.Query
TWinCGIRequest.Query3045020

TWinCGIRequest	参照

Query プロパティは，HTTP 要求メッセージ内に指定された URL の問い合わせ情報（存在する場合）の値です。

property Query: string;

説明

Query プロパティを読み出すと，Web クライアント要求の URL 内に指定された問い合わせの詳細な内容がわかります。たとえば，次の URL があるとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

/gallery.dll が Web サーバーアプリケーションとすると，Query は次のようになります。

animal=dog&color=black

Query プロパティは，URL の分解前の問い合わせ部分です。問い合わせには複数の項目があり，アンド記号（&）で区切られます。QueryFields プロパティを使うと，項目単位で問い合わせを処理できます。


TWinCGIRequest.Referer
TWinCGIRequest.Referer3045021

TWinCGIRequest	参照

Referer プロパティは，HTTP 要求メッセージの Referer ヘッダーの値です。

property Referer: string;

説明

Referer プロパティを読み出すと，HTTP 要求メッセージが発生したリソースの URI がわかります。このプロパティを使ってサーバーアプリケーションは，要求ソースへのバックリンクを作成できます。このプロパティが URI の一部である場合，これは URL プロパティへの相対パスとみなさないといけません。

HTTP 要求の URL が，ユーザーキーボードからの入力のように自身の URI を持っていないソースから取得したものであるとき，Referer プロパティは設定されません。


TWinCGIRequest.RemoteAddr
TWinCGIRequest.RemoteAddr3045022

TWinCGIRequest	参照

RemoteAddr プロパティは，HTTP 要求メッセージに関連付けられたクライアントのリモート IP アドレスです。

property RemoteAddr: string;

説明

RemoteAddr プロパティを読み出すと，Web クライアント要求が発生したソースの IP アドレスを取得できます。


TWinCGIRequest.RemoteHost
TWinCGIRequest.RemoteHost3045023

TWinCGIRequest	参照

RemoteHost プロパティは，HTTP 要求メッセージに関連付けられたクライアントの逆ドメイン参照（フルパス）です。

property RemoteHost: string;

説明

RemoteHost プロパティを使うと，Referer プロパティが指定されていないときに要求ソースへのバックリンクを示す URI 値を生成できます。このプロパティにはパス情報が含まれていません。


TWinCGIRequest.ScriptName
TWinCGIRequest.ScriptName3045024

TWinCGIRequest	参照

ScriptName プロパティは，HTTP 要求メッセージ内に指定された URL のスクリプト情報（存在する場合）の値です。

property ScriptName: string;

説明

ScriptName プロパティを読み出すと，クライアント要求によって指定された Web サーバーアプリケーションへのフルパスがわかります。たとえば，次の URL があるとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

/gallery.dll が Web サーバーアプリケーションとすると，ScriptName は次のようになります。

/art/gallery


TWinCGIRequest.Title
TWinCGIRequest.Title3045025

TWinCGIRequest	参照

TiTle プロパティは，HTTP 要求メッセージの Title ヘッダーの値です。

property Title: string;

説明

Title プロパティを読み出すと，Web クライアント要求内で要求された情報のタイトルがわかります。


TWinCGIRequest.URL
TWinCGIRequest.URL3045026

TWinCGIRequest	参照

URL プロパティは，要求のターゲットを示すために HTTP 要求メッセージが指定した Uniform Resource Identifier（URI）です。

property URL: string;

説明

URL プロパティを使うと，要求メッセージのターゲットとして Web クライアントが指定したリソースがわかります。URL は，返すべき HTML ページ，作成または削除するリソース，Web クライアントに他のサービスを提供するオブジェクトのいずれかです。

TWinCGIRequest オブジェクトは，URL を各構成要素に分解して，Host，ScriptName，PathInfo，および Query の各プロパティを生成します。

注意

通常，URL プロパティは，ホスト，スクリプト，パス，および問い合わせに分解できる Uniform Resource Locator（URL）です。しかし，HTTP 要求メッセージでは，Uniform Resource Identifier（URI）のように一般的な用語でターゲットを指定することもできます。


TWinCGIRequest.UserAgent
TWinCGIRequest.UserAgent3045027

TWinCGIRequest	参照

UserAgent プロパティは，HTTP 要求メッセージの User-Agent ヘッダーの値です。

property UserAgent: string;

 説明

UserAgent プロパティを読み出すと，クライアント要求を発生したユーザーエージェントに関する情報を取得できます。この情報は，統計目的やプロトコル違反の追跡に使ったり，クライアント要求を生成する特定のアプリケーションの既知の制限に合わせて応答を変えるために使います。UserAgent 文字列には 1 つまたは複数の記述子が含まれ，重要度の順番に並んでいます。各記述子は，要求を生成した製品やアプリケーションの名前，あるいはユーザーエージェントに関する注釈を表しています。


TWinCGIRequest メソッド3045028

TWinCGIRequest	アルファベット順	凡例

TWinCGIRequest

Create

Destroy

GetFieldByName

GetStringVariable

ReadClient

ReadString

TranslateURI

WriteClient

WriteString

TWebRequest からの継承

ExtractContentFields

ExtractCookieFields

ExtractFields

ExtractQueryFields

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TWinCGIRequest メソッド3045029

TWinCGIRequest	オブジェクト順	凡例

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

ExtractContentFields

ExtractCookieFields

ExtractFields

ExtractQueryFields

FieldAddress

Free

FreeInstance

GetFieldByName

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetStringVariable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadClient

ReadString

SafeCallException

TranslateURI

WriteClient

WriteString


TWinCGIRequest.Create
TWinCGIRequest.Create3045030

TWinCGIRequest	参照

Create メソッドは，TWinCGIRequest のインスタンスを作成します。

constructor Create;

説明

アプリケーションは Create を呼び出して CGI 要求オブジェクトをインスタンス化する必要はありません。TCGIApplication オブジェクトは，クライアントの要求を受け取ると TWinCGIRequest オブジェクトを作成します。


TWinCGIRequest.Destroy
TWinCGIRequest.Destroy3045031

TWinCGIRequest	参照

Destroy メソッドは，TWinCGIRequest のインスタンスを破棄します。

destructor Destroy; override;

説明

直接 Destroy メソッドを呼び出さないでください。TCGIApplication は，TWinCGIRequest オブジェクトを Free メソッドで処理してから破棄します。Free メソッドは TWinCGIRequest オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。TWinCGIRequest オブジェクトは TCGIApplication オブジェクトが解放します。

Destroy は HTTP ヘッダー変数を管理していた内部構造体を解放します。


TWinCGIRequest.GetFieldByName
TWinCGIRequest.GetFieldByName3045032

TWinCGIRequest	参照

GetFieldByName メソッドは，Name パラメータによって指定された HTTP ヘッダー変数の値を返します。

function GetFieldByName(const Name: string): string; override;

説明

GetFieldByName メソッドを使うと，TCGIRequest のプロパティとしてテーブルに示されていない HTTP ヘッダー変数の値を読み出すことができます。利用できる HTTP 要求ヘッダー変数については，現在のインターネット規格文書を参照してください。


TWinCGIRequest.GetStringVariable
TWinCGIRequest.GetStringVariable3045033

TWinCGIRequest	参照

GetStringVariable メソッドは，HTTP ヘッダー変数の内部テーブルから文字列値を抽出します。

function GetStringVariable(Index: Integer): string; override;

説明

GetStringVariable メソッドは HTTP 要求メッセージのヘッダー文字列から文字列値を読み出します。CGI 要求オブジェクトは GetStringVariable を使って HTTP 要求ヘッダーから文字列を表すプロパティにアクセスします。


TWinCGIRequest.ReadClient
TWinCGIRequest.ReadClient3045034

TWinCGIRequest	参照

ReadClient メソッドは，HTTP 要求から Count バイトのデータを Buffer に読み出します。

function ReadClient(var Buffer; Count: Integer): Integer; override;

説明

ReadClient メソッドを使うと，HTTP 要求の内容から，情報を小分けにしてバッファにロードできます。要求メッセージの内容が Content プロパティで読み出すには大きすぎる場合，このメソッドを使うと，サーバーアプリケーションは，何回かに分けて情報を取得できます。ReadClient は実際に読み出したバイト数を返します。読み出すべき情報がなくなったときは，-1 を返します。


TWinCGIRequest.ReadString
TWinCGIRequest.ReadString3045035

TWinCGIRequest	参照

ReadString メソッドは，HTTP 要求から Count バイトのデータを文字列に読み出します。

function ReadString(Count: Integer): string; override;

説明

ReadString メソッドを使うと，HTTP 要求の内容から，情報を小分けにして文字列にロードできます。要求メッセージの内容が Content プロパティで読み出すには大きすぎる場合，このメソッドを使うと，サーバーアプリケーションは，何回かに分けて情報を取得できます。


TWinCGIRequest.TranslateURI
TWinCGIRequest.TranslateURI3045036

TWinCGIRequest	参照

TranslateURI メソッドは，CGI 要求オブジェクトで使われる場合には何も処理を行いません。

function TranslateURI(const URI: string): string; override;

説明

TranslateURI メソッドは HTTP 要求オブジェクトとともに使われ，クライアント要求で指定された URI をサーバーアプリケーションが使える形式に変換します。CGI アプリケーションが直接 URI 値を扱う場合，変換の必要はありません。


TWinCGIRequest.WriteClient
TWinCGIRequest.WriteClient3045037

TWinCGIRequest	参照

WriteClient メソッドは，Count バイトのデータを Buffer から元の HTTP クライアントに書き込みます。

function WriteClient(var Buffer; Count: Integer): Integer; override;

説明

WriteClient メソッドを使うと，元の Web クライアントに応答の内容を書き込むことができます。


TWinCGIRequest.WriteString
TWinCGIRequest.WriteString3045038

TWinCGIRequest	参照

WriteString メソッドは，元の HTTP クライアントに文字列 AString を書き込みます。

function WriteString(const AString: string): Boolean; virtual; abstract;

説明

WriteString メソッドを使うと，元の Web クライアントに応答の内容を書き込むことができます。


読み出し／書き込み3045039

読み出し専用


スコープ3045040

protected


継承3045041

TObject

TWebRequest

TCGIRequest


TWinCGIRequest 例3045042

TWinCGIRequest


TWinCGIResponse
TWinCGIResponse3046001

継承	プロパティ	メソッド	参照

TWinCGIResponse オブジェクトは，Windows 制御下の CGI アプリケーションが HTTP 要求メッセージに応答して送る HTTP メッセージを表します。

ユニット

cgiapp

説明

TWinCGIResponse を使うと，HTTP 要求メッセージに対する応答を指定できます。

CGI アプリケーションは Web クライアントから送られた要求メッセージの TWinCGIRequest オブジェクトに基づいて TWinCGIResponse オブジェクトを作成します。次にアプリケーションの TWebDispatcher は，TWinCGIRequest オブジェクトに関連付けられた TWebActionItem オブジェクトに TWinCGIResponse オブジェクトを渡します。TWebActionItem は TWinCGIResponse オブジェクトのプロパティを設定します。


TWinCGIResponse プロパティ3046002

TWinCGIResponse	アルファベット順	凡例

TCGIResponse からの継承

Allow

Content

ContentEncoding

ContentLength

ContentType

ContentVersion

Date

DerivedFrom

Expires

LastModified

Location

LogMessage

Realm

ReasonString

Server

StatusCode

Title

Version

WWWAuthenticate

TWebResponse からの継承

ContentStream

Cookies

CustomHeaders

HTTPRequest


TWinCGIResponse プロパティ3046003

TWinCGIResponse	オブジェクト順	凡例

Allow

Content

ContentEncoding

ContentLength

ContentStream

ContentType

ContentVersion

Cookies

CustomHeaders

Date

DerivedFrom

Expires

HTTPRequest

LastModified

Location

LogMessage

Realm

ReasonString

Server

StatusCode

Title

Version

WWWAuthenticate


TWinCGIResponse メソッド3046004

TWinCGIResponse	アルファベット順

TCGIResponse からの継承

Create

SendRedirect

SendResponse

SendStream

TWebResponse からの継承

Destroy

GetCustomHeader

SetCookieField

SetCustomHeader

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TWinCGIResponse メソッド3046005

TWinCGIResponse	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetCustomHeader

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

SendRedirect

SendResponse

SendStream

SetCookieField

SetCustomHeader


読み出し／書き込み3046006

読み出し専用


継承3046007

TObject

TWebResponse

TCGIResponse


TWinCGIResponse 例3046008

TWinCGIResponse


TCheckConstraints
TCheckConstraints3047001

継承	プロパティ	メソッド

TCheckConstraints は，項目コンポーネントのチェック制約のコレクションを格納します。

ユニット

db

説明

項目コンポーネントは，有効なデータ値を定義するチェック制約をサポートします。TCheckConstraints オブジェクトは，指定された項目に適用するチェック制約のコレクションを保持します。


TCheckConstraints のプロパティ3047002

TCheckConstraints	アルファベット順	凡例

TCheckConstraints

Items

TCollection からの継承

Count

ItemClass


TCheckConstraints のプロパティ3047003

TCheckConstraints	オブジェクト順	凡例

Count

ItemClass

Items


TCheckConstraints.Items
TCheckConstraints.Items3047004

TCheckConstraints	参照

検査制約のインデックス付き配列を保守します。

property Items[Index: Integer]: TCheckConstraint;

説明

Items を使うと，このチェック制約のコレクションを所有する項目コンポーネントに適用される検査制約のリストを保守できます。


TCheckConstraints のメソッド3047005

TCheckConstraints	アルファベット順

TCheckConstraints

Add

Create

TCollection からの継承

Assign

BeginUpdate

Clear

Destroy

EndUpdate

FindItemID

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCheckConstraints のメソッド3047006

TCheckConstraints	オブジェクト順

Add

Assign

BeginUpdate

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

EndUpdate

FieldAddress

FindItemID

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCheckConstraints.Add
TCheckConstraints.Add3047007

TCheckConstraints	参照

チェック制約項目を，このコレクションオブジェクトが保守しているリストに追加します。

function Add: TCheckConstraint;

説明

Add を呼び出すと，この検査制約のコレクションオブジェクトを所有する項目コンポーネントに適用されているチェック制約に別のチェック制約を追加できます。


TCheckConstraints.Create
TCheckConstraints.Create3047008

TCheckConstraints

検査制約のコレクションオブジェクトのインスタンスをインスタンス化します。

constructor Create(Owner: TPersistent);

説明

Create は，実行時にチェック制約のコレクションオブジェクトを必要としているが自動的には生成されていない場合に，チェック制約のコレクションオブジェクトをインスタンス化するために呼び出されます。Create は継承コンストラクタを呼び出し，Owner に指定されたコレクションをオーナーオブジェクトに設定します。


アクセス種別3047009

読み出し専用


継承3047010

TObject

TPersistent

TCollection


TCheckConstraints の例3047011

TCheckConstraints


TCheckBox
TCheckBox3048001

継承	プロパティ	メソッド	イベント	参照	例

TCheckBox コンポーネントは Windows のチェックボックスを表します。

ユニット

stdctrls

説明

TCheckBox コンポーネントはユーザーオプションを提供します。ユーザーはチェックボックスにチェックマークを付けてオプションを選択したり，チェックマークをはずしてオプションの選択を解除したりできます。


TCheckBox プロパティ3048002

TCheckBox	アルファベット順	凡例

TCustomCheckBox からの継承

Alignment

AllowGrayed

Checked

State

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCheckBox プロパティ3048003

TCheckBox	オブジェクト順	凡例

Align

Alignment

AllowGrayed

BoundsRect

Brush

Caption

Checked

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

State

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TCheckBox イベント3048004

TCheckBox	アルファベット順	凡例

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TCheckBox イベント3048005

TCheckBox	オブジェクト順	凡例

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TCheckBox メソッド3048006

TCheckBox	アルファベット順

TCustomCheckBox からの継承

Create

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCheckBox メソッド3048007

TCheckBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


スコープ3048008

published

読み出し／書き込み

読み出し専用


スコープ3048009

published


継承3048010

TObject

TPersistent

TComponent

TControl

TWinControl

TButtonControl

TCustomCheckBox


TCheckBox 例3048011

TCheckBox


TCheckConstraint
TCheckConstraint3049001

継承	プロパティ	メソッド

TCheckConstraint は項目コンポーネントにおけるチェック制約を示します。

ユニット

db

説明

項目コンポーネントは，チェック制約をサポートするプロパティを実装します。これらの制約はサーバーのデータディレクトリから継承して，アプリケーション内でカスタマイズすることができます。項目に関連付けられた個々の制約は TCheckConstraint オブジェクトによって示されます。


TCheckConstraint のプロパティ3049002

TCheckConstraint	アルファベット順	凡例

TCheckConstraint

CustomConstraint

ErrorMessage

FromDictionary

ImportedConstraint

TCollectionItem からの継承

Collection

DisplayName

ID

Index


TCheckConstraint のプロパティ3049003

TCheckConstraint	オブジェクト順	凡例

Collection

CustomConstraint

DisplayName

ErrorMessage

FromDictionary

ID

ImportedConstraint

Index


TCheckConstraint.CustomConstraint
TCheckConstraint.CustomConstraint3049004

TCheckConstraint	参照

アプリケーションによって項目に定義された制約を表す SQL テキストを格納します。

property CustomConstraint: string;

説明

CustomConstraint を使うと，アプリケーションが項目コンポーネントを使って定義したチェック制約を指定する SQL テキストを格納できます。カスタム制約はアプリケーションに対してローカルであり，アプリケーションがその変更内容をデータベースに書き込む場合はサーバーには適用されません。


TCheckConstraint.ErrorMessage
TCheckConstraint.ErrorMessage3049005

TCheckConstraint	参照

ユーザーによって項目に入力されたデータが制約の条件を侵害する場合に表示するエラーメッセージのテキストを格納します。

property ErrorMessage string;

説明

ErrorMessage を使うと，ユーザーがチェック制約の条件を侵害するデータを項目に入力した場合に，例外メッセージのダイアログボックスに表示するエラーメッセージの文字列を指定できます。


TCheckConstraint.FromDictionary
TCheckConstraint.FromDictionary3049006

TCheckConstraint	参照

Data Dictionary からチェック制約をフェッチするかどうかを示します。

property FromDictionary: Boolean;

説明

FromDictionary を使うと，このチェック制約を Data Dictionaryから派生させるかどうか（True）を指定したり，アプリケーションに対してのみ有効にするかどうか（False）を指定できます。


TCheckConstraint.ImportedConstraint
TCheckConstraint.ImportedConstraint3049007

TCheckConstraint	参照

Data Dictionary またはリモート SQL データベースサーバーからインポートされたチェック制約の SQL テキストを格納します。

property ImportedConstraint string;

説明

ImportedConstraint を使うと，Data Dictionary またはリモート SQL データベースサーバーからインポートされたチェック制約の SQL テキストを格納できます。アプリケーションは実行時にこのプロパティを設定できますが，通常は ImportedConstraint 内のテキストは自動的にアプリケーションに提供されます。


TCheckConstraint のメソッド3049008

TCheckConstraint	アルファベット順

TCheckConstraint

Assign

GetDisplayName

TCollectionItem からの継承

Create

Destroy

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCheckConstraint のメソッド3049009

TCheckConstraint	オブジェクト順

Assign

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetDisplayName

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCheckConstraint.Assign
TCheckConstraint.Assign3049010

TCheckConstraint

1 つの制約を別の制約に割り当てます。

procedure Assign(Source: TPersistent);

説明

Assign を呼び出すと，チェック制約のテキストを別の TCheckConstraint オブジェクトから現行の制約に読み出すことができます。Source にはテキストが読み出される TCheckConstraint を指定します。


TCheckConstraint.GetDisplayName
TCheckConstraint.GetDisplayName3049011

TCheckConstraint	参照

制約の現在のテキストを取得します。

function GetDisplayName: string;

説明

GetDisplayName を呼び出すと，チェック制約の現在のテキストを取得できます。GetDisplayName は，ImportedConstraint プロパティの現在の値が空の文字列でない場合はその値を読み出し，空の文字列の場合 は CustomConstraint プロパティの現在の値を読み出します。また，CustomConstraint も空の文字列の場合には GetDisplayName はその継承された GetDisplayName メソッドを呼び出します。


スコープ3049012

published

アクセス種別

読み出し専用


継承3049013

TObject

TPersistent

TCollectionItem


TCheckConstraint の例3049014

TCheckConstraint


TChangeLink
TChangeLink3050001

継承	プロパティ	メソッド	イベント	参照

TChangeLink オブジェクトは，TImageList が他のオブジェクトにイメージリストの変更を通知するために内部的に使われます。

ユニット

controls

説明

TImageList は TChangeLink オブジェクトのリストを保持します。各 TChangeLink オブジェクトは，ツリービューやリストビューのコントロールなどの特定のコンポーネントに関連付けられます。コンポーネントはイメージリストの RegisterChanges メソッドを呼び出すことで，そのコンポーネントの変更リンクをイメージリストに登録できます。この場合，コンポーネントを破棄する前に UnregisterChanges メソッドを呼び出す必要があります。

コンポーネントの作成者は，コントロールで使うイメージリストが変更されたときに，変更リンクオブジェクトを使ってその通知を受け取ることができます。変更リンクの OnChange イベントを使うと，イメージリストの変更時にいくつかのコードを実行できます。たとえば，ツリービューコントロールは変更リンクオブジェクトを使って，イメージリストがいつ変更されたかを知ることができます。


TChangeLink プロパティ3050002

TChangeLink	アルファベット順

TChangeLink

Sender


TChangeLink プロパティ3050003

TChangeLink	オブジェクト順

Sender


TChangeLink.Sender
TChangeLink.Sender3050004

TChangeLink	参照

Sender プロパティは，どのイメージリストコンポーネントが変更リンクオブジェクトに変更を知らせるかを指定します。

property Sender : TCustomImageList;

説明

TImageList は，RegisterChanges が呼び出されたときに自動的に Sender プロパティを設定します。


TChangeLink イベント3050005

TChangeLink	アルファベット順

TChangeLink

OnChange


TChangeLink イベント3050006

TChangeLink	オブジェクト順

OnChange


TChangeLink.OnChange
TChangeLink.OnChange3050007

TChangeLink	参照

OnChange イベントは，関連するイメージリストコンポーネントに格納されているイメージのどれかに変更があったときに発生します。

TNotifyEvent = procedure (Sender: TObject) of object;

property OnChange: TNotifyEvent

説明

OnChange イベントを記述すると，コントロールで使っているイメージリストがいつ変更されたかをそのコントロールに通知することができます。そのときに行う特定の処理は OnChange イベントハンドラに指定します。

TNotifyEvent 型は，パラメータのないイベントの型です。これらのイベントは，特定のイベント（この場合は OnChange イベント）が発生したことをオブジェクトに通知するだけです。


TChangeLink メソッド3050008

TChangeLink	アルファベット順

TChangeLink

Change

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TChangeLink メソッド3050009

TChangeLink	オブジェクト順

Change

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TChangeLink.Change
TChangeLink.Change3050010

TChangeLink	参照

Change メソッドは，OnChange イベントハンドラが 1 つでも定義されていればそれを呼び出します。

procedure Change;

説明

Change メソッドは，変更リンクオブジェクトの OnChange イベントハンドラを生成できます。


TChangeLink.Destroy
TChangeLink.Destroy3050011

TChangeLink	参照

Destroy メソッドは，変更リンクオブジェクトを破棄し，割り当てていたメモリを解放します。

destructor Destroy;

説明

Destroy は Free を呼び出す前にイメージリストの UnRegisterChanges を呼び出して，イメージリストの変更時に通知を受け取るための登録を解除します。

Destroy を呼び出す必要はほとんどありません。Create コンストラクタを呼び出して変更リンクオブジェクトを構築している場合は，Free を呼び出してメモリを解放し，そのオブジェクトを破棄する必要があります。Free はポインタが nil かどうかを確認してから Destroy を呼び出します。


継承3050012

TObject


TChangeLink 例3050013

TChangeLink


TCheckListBox
TCheckListBox3051001

継承	プロパティ	メソッド	イベント	参照

TCheckListBox は，各項目の隣にチェックボックスが付いたスクロール可能リストを表示します。

ユニット

checklst

説明

TCheckListBox は TListBox に似ていますが，各項目の隣にチェックボックスが付いている点が異なります。ユーザーはリスト内の項目にチェックマークを付けたり，はずしたりすることができます。


TCheckListBox プロパティ3051002

TCheckListBox	アルファベット順	凡例

TCheckListBox

AllowGrayed

Checked

State

TCustomListBox からの継承

BorderStyle

Columns

IntegralHeight

ItemHeight

ItemIndex

Items

SelCount

Selected

Sorted

Style

TabWidth

TopIndex

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject

TCustomControl からの継承

Canvas


TCheckListBox プロパティ3051003

TCheckListBox	オブジェクト順	凡例

Align

AllowGrayed

BorderStyle

BoundsRect

Brush

Canvas

Checked

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

IntegralHeight

ItemHeight

ItemIndex

Items

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

SelCount

Selected

ShowHint

Showing

Sorted

State

Style

TabOrder

TabStop

TabWidth

Tag

Top

TopIndex

VCLComObject

Visible

Width

WindowProc


TCheckListBox.AllowGrayed
TCheckListBox.AllowGrayed3051004

TCheckListBox	参照

AllowGrayed プロパティは，チェックボックスを「淡色表示」にできるかどうかを決めます。

property AllowGrayed: Boolean;

説明

AllowGrayed プロパティが True に設定されている場合，各項目の状態は，チェックマークが付けられている，はずされている，チェックボックスが淡色表示されている，の 3 つのいずれかになります。AllowGrayed プロパティが False に設定されている場合，各項目の状態は，チェックマークが付けられているか，はずされているかの 2 つのいずれかになります。


TCheckListBox.Checked
TCheckListBox.Checked3051005

TCheckListBox	参照

Checked プロパティは，どの項目にチェックマークが付けられているかを示します。

property Checked[Index: Integer]: Boolean;

説明

項目のチェックボックスにチェックマークが表示されている場合，Items 配列の各要素の Checked プロパティは True になります。これは State プロパティの cbChecked の状態と対応します。つまり，State = cbChecked ならば Checked は True で，State = cbUnchecked または State = cbGrayed ならば Checked は False です。


TCheckListBox.State
TCheckListBox.State3051006

TCheckListBox	参照

State プロパティは，どの項目にチェックマークが付けられているかを示します。

property State[Index: Integer]: TCheckBoxState;

説明

State プロパティは，Items 配列の要素ごとに，項目のチェックボックスが選択されている（cbChecked）か，選択されていない（cbUnchecked）か，淡色表示されている（cbGrayed）かを示します。cbChecked の状態は Checked プロパティと対応します。つまり，Checked = True ならば State = cbChecked です。


TCheckListBox イベント3051007

TCheckListBox	アルファベット順	凡例

TCheckListBox

OnClickCheck

TcustomListBox からの継承

OnDrawItem

OnMeasureItem

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TCheckListBox イベント3051008

TCheckListBox	オブジェクト順	凡例

OnClick

OnClickCheck

OnDblClick

OnDragDrop

OnDragOver

OnDrawItem

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMeasureItem

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TCheckListBox.OnClickCheck
TCheckListBox.OnClickCheck3051009

TCheckListBox	参照

OnClickCheck イベントは，ユーザーが項目のチェックボックスを選択または選択解除したときに発生します。

property OnClickCheck: TNotifyEvent;

説明

OnClickCheck イベントハンドラを記述すると，ユーザーが項目にチェックマークを付けたか，または解除したときに行われる特別な処理を実装できます。


TCheckListBox メソッド3051010

TCheckListBox	アルファベット順

TCheckListBox

Destroy

TCustomListBox からの継承

Clear

Create

ItemAtPos

ItemRect

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCheckListBox メソッド3051011

TCheckListBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

ItemAtPos

ItemRect

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TCheckListBox.Destroy
TCheckListBox.Destroy3051012

TCheckListBox	参照

Destroy メソッドは，TCheckListBox のインスタンスを破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに，Free メソッドを呼び出します。Free メソッドは，コンポーネントが解放されていないことを確認してから Destroy メソッドを呼び出します。


スコープ3051013

published

読み出し／書き込み

読み出し専用


スコープ3051014

published


継承3051015

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomListBox


TCheckListBox 例3051016

TCheckListBox


TClientDataSet
TClientDataSet3052001

継承	プロパティ	メソッド	イベント	参照

TClientDataSet は，データベースに依存しないデータセットコンポーネントを実現するクラスです。単層アプリケーションで独立的にも，または複層データベースアプリケーションのクライアントアプリケーション部でクライアントデータセットとして使うこともできます。

ユニット

dbclient

説明

TClientDataSet はデータベースに依存しない分散データセットをカプセル化する Delphi オブジェクトです。クライアントデータセットは次のように使うことができます。

・	単層データベースアプリケーションの単純で高機能な独立型フラットファイルデータセット。この場合，アプリケーションはデータベースエンジンにアクセスせずにユーザーのハードディスクとの間で直接読み書きするためにクライアントデータセットを使う

・	複層データベースアプリケーションのクライアントアプリケーション部のクライアントデータセット

注意

複層アプリケーションが「ブリーフケース」モデルを使って，オフラインでデータを扱うオプションをサポートするように設計されている場合，クライアントデータセットは上記の両方の役割を担います。サイトでアプリケーションサーバーとネットワークでつながれているときは，クライアントデータセットはアプリケーションサーバーのデータプロバイダと通信し，サイト以外でユーザーがクライアントアプリケーションおよびデータのスナップショットを扱うときは，クライアントデータセットは単層アプリケーションのフラットファイルデータセットとして機能します。

通常，クライアントデータセットは IProvider デュアルインターフェースを介してデータプロバイダと通信します。単層モデルおよびブリーフケースモデルで使われるときは，クライアントデータセットのプロバイダインターフェースは自動的に生成されます。クライアントアプリケーションで複層アプリケーションの一部として使われるときは，クライアントデータセットのプロバイダはアプリケーションサーバーの一部である TProvider オブジェクトであるのが普通です。


TClientDataSet プロパティ3052002

TClientDataSet	アルファベット順	凡例

TClientDataSet

CanModify

ChangeCount

Data

DataSource

Delta

FetchOnDemand

Filter

Filtered

FilterOptions

IndexDefs

IndexFieldCount

IndexFieldNames

IndexFields

IndexName

KeyExclusive

KeyFieldCount

KeySize

LogChanges

MasterFields

MasterSource

PacketRecords

Provider

ProviderName

ReadOnly

RecNo

RecordCount

RecordSize

RemoteServer

TDataSet からの継承

Active

AutoCalcFields

BOF

Bookmark

DefaultFields

Designer

EOF

FieldCount

FieldDefs

Fields

FieldValues

Found

Modified

Name

State

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TClientDataSet プロパティ3052003

TClientDataSet	オブジェクト順	凡例

Active

AutoCalcFields

BOF

Bookmark

CanModify

ChangeCount

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Data

DataSource

DefaultFields

Delta

Designer

DesignInfo

EOF

FetchOnDemand

FieldCount

FieldDefs

Fields

FieldValues

Filter

Filtered

FilterOptions

Found

IndexDefs

IndexFieldCount

IndexFieldNames

IndexFields

IndexName

KeyExclusive

KeyFieldCount

KeySize

LogChanges

MasterFields

MasterSource

Modified

Name

Owner

PacketRecords

Provider

ProviderName

ReadOnly

RecNo

RecordCount

RecordSize

RemoteServer

State

Tag

VCLComObject


TClientDataSet.CanModify
TClientDataSet.CanModify3052004

TClientDataSet	参照

CanModify プロパティは，アプリケーションがクライアントデータセット内のデータを挿入，編集，削除できるかどうかを示します。

property CanModify: Boolean;

説明

CanModify プロパティは，アプリケーションがデータセットに変更を加えることができるかどうかを取得できます。CanModify が True ならば，データセットは変更可能です。CanModify が False ならば，データセットは読み出し専用です。

CanModify はアプリケーションがデータセットを開いたときに自動的に設定されます。クライアントデータセットコンポーネントの ReadOnly プロパティが True ならば，CanModify は False に設定されます。


TClientDataSet.ChangeCount
TClientDataSet.ChangeCount3052005

TClientDataSet	参照

ChangeCount プロパティは，クライアントデータセットに対して加えられた変更の数を示します。

property ChangeCount: Integer;

説明

ChangeCount プロパティを調べると，データセットで保留にされている変更の数を判定できます。更新が適用され，クライアントデータセットによって違いが解消されると，ChangeCount はリセットされます。


TClientDataSet.Data
TClientDataSet.Data3052006

TClientDataSet	参照

Data プロパティは，プロバイダからのデータパケットを受け取ります。

property Data: OleVariant;

説明

Data プロパティを使うと，プロバイダからのデータパケットを受け取り，アクセスできます。複層アプリケーションでは，データパケットは一般にアプリケーションサーバーから受け取ります。単層アプリケーションでは，パケットはデータファイルから読み出します。

クライアントデータセットはこのデータのローカルコピーに対して処理を行います。たとえば，次の文は，サーバーからレコードを取り出し，Data に格納します。

ClientDataSet1.Data := Provider1.Data;


TClientDataSet.DataSource
TClientDataSet.DataSource3052007

TClientDataSet	参照

DataSource プロパティは，クライアントデータセットのデータソースを指定します。

property DataSource: TDataSource;

説明

DataSource プロパティは，データセットが使うマスタテーブルのデータソースコンポーネントを取得および設定することができます。


TClientDataSet.Delta
TClientDataSet.Delta3052008

TClientDataSet	参照

Delta プロパティは，変更ログデータのパケットをクライアントからプロバイダへ返します。

property Delta: OleVariant;

説明

Delta プロパティを使うと，変更ログデータのパケットをクライアントデータセットからプロバイダへ渡すことができます。Delta にはクライアントによって挿入，変更，削除されたレコードについての情報だけが入っています。Delta は ApplyUpdates および Reconcile メソッドに引数として渡されます。これらのメソッドは変更ログの情報を使ってデータベースを更新します。

更新の成功がアプリケーションから返されると，Delta はクリアされます。エラーが起こった場合には，ApplyUpdates を通してクライアントデータセットによって許可されているエラートレランスによって Delta には次のいずれかが入ります。

・	すべてのログ変更データ。最大許容エラー数に達し，すべての変更内容がロールバックされたため

・	適用できなかったログ変更のみ。発生したエラー数が許容レベルとして指定されている最大数より少なかったことを示す


TClientDataSet.FetchOnDemand
TClientDataSet.FetchOnDemand3052009

TClientDataSet	参照

FetchOnDemand プロパティは，プロバイダからデータパケットを必要に応じて取り出すかどうかを示します。

property FetchOnDemand: Boolean;

説明

デフォルトでは，FetchOnDemand プロパティは True であり，クライアントデータセットは必要に応じて（たとえば，ユーザーがデータをスクロールしたり，検索を行ったりした場合など）データパケットを取り出します。

FetchOnDemand は，クライアントアプリケーションに，必要なら GetNextPacket メソッドを使って明示的にデータパケットを取り出すコードがある場合にのみ False に設定します。


TClientDataSet.Filter
TClientDataSet.Filter3052010

TClientDataSet	参照

Filter プロパティは，データセットの現在のフィルタのテキストを指定します。

property Filter: string;

説明

Filter プロパティを使うと，データセットフィルタを指定できます。データセットにフィルタ処理を適用すると，アプリケーションで利用可能なレコードはフィルタの条件に適合するレコードだけになります。Filter にはフィルタ条件を示す文字列を指定します。たとえば次のようなフィルタ条件は，State 項目が「CA」または「MA」に設定されているレコードだけを表示します。

State = 'CA' or State = 'MA'

文字列を部分的な比較に基づいてフィルタリングするには，次のようにアスタリスクをワイルドカードとして使います。

State = 'M*'

注意

アプリケーションはデータセットのフィルタ条件を変更する（たとえば，ユーザーの入力への応答としてなど）ために実行時に Filter を設定することができます。


TClientDataSet.Filtered
TClientDataSet.Filtered3052011

TClientDataSet	参照

Filtered プロパティは，フィルタ処理がデータセットでアクティブであるかどうかを示します。

property Filtered: Boolean;

説明

Filtered プロパティを調べると，データセットのフィルタ処理が有効かどうかを判定できます。Filtered が True ならば，フィルタ処理はアクティブです。アクティブでない場合は Filtered は False です。Filter プロパティまたは OnFilterRecord イベントハンドラで指定したフィルタ条件を適用するには，Filtered を True に設定します。

注意

フィルタ処理が有効なとき，ユーザーがレコードを編集すると，レコードがフィルタのテスト条件に適合しなくなることがあります。フィルタが有効なまま，次にレコードをデータセットから取り出すときに，そのレコードが消えているように見えることがあります。その場合，フィルタ条件に適合する次のレコードがカレントレコードになります。


TClientDataSet.FilterOptions
TClientDataSet.FIlterOptions3052012

TClientDataSet	参照

FilterOptions プロパティは，フィルタ処理で大文字小文字を区別するかどうか，レコードのフィルタ処理の際に部分的な比較を許可するかどうかを示します。

type

TFilterOption = (foCaseInsensitive, foNoPartialCompare);

TFilterOptions = set of TFilterOption;

property FilterOptions: TFilterOptions

説明

FilterOptions プロパティを設定すると，文字列または文字項目に対するフィルタ処理で大文字小文字を区別するかどうか，フィルタ条件との部分的な一致を認めるかどうかを指定できます。

デフォルトでは，FilterOptions は空のセットに設定されます。文字列項目に基づくフィルタの場合，FilterOptions を foCaseInsensitive に設定すると，大文字小文字を区別せずに，すべてのバリエーションを取り出せます。

フィルタ式との部分的な一致を無効にするには，フィルタオプションに foNoPartialCompare を指定します。

注意

文字列を部分的な比較に基づいてフィルタリングするには，次のようにアスタリスクをワイルドカードとして使います。

State = 'M*'


TClientDataSet.IndexDefs
TClientDataSet.IndexDefs3052013

TClientDataSet	参照

IndexDefs プロパティは，クライアントデータセットのインデックスについての情報を保持します。

property IndexDefs: TIndexDefs;

説明

IndexDefs プロパティを調べると，インデックス情報が得られます。IndexDefs はそれぞれがデータセットの利用可能なインデックスを示すインデックス項目の配列です。通常，アプリケーションは IndexFieldNames または IndexFields プロパティを通じてインデックスのアクセスまたは指定を行います。

注意

IndexDefs のインデックス項目は常にデータセットで現在利用可能なインデックスを反映しているとは限りません。IndexDefs を調べる前には，インデックスリストに最新の情報が入るように IndexDefs.Updateメソッドを呼び出してください。


TClientDataSet.IndexFieldCount
TClientDataSet.IndexFieldCount3052014

TClientDataSet	参照

IndexFieldCount プロパティは，データセットのカレントインデックスを構成している項目数を示します。

property IndexFieldCount: Integer

説明

IndexFieldCount プロパティを調べると，データセットのカレントインデックスで使われている項目数を判定できます。


TClientDataSet.IndexFieldNames
TClientDataSet.IndexFieldNames3052015

TClientDataSet	参照

IndexFieldNames プロパティは，データセットのインデックスとして使う項目をリストします。

property IndexFieldNames: string;

説明

IndexFieldNames プロパティは，データセットで使うインデックスを指定する代替手段として使います。IndexFieldNames では，データセットのインデックスとして使う各項目の名前を指定します。項目名の順序が重要です。複数指定するときはセミコロンで区切ります。

参考

IndexFieldNames プロパティを使うと，実行時にその場でソート順序を作成できます。

注意

IndexFieldNames プロパティと IndexName プロパティを同時に使うことはできません。片方を設定すると，もう片方がクリアされます。


TClientDataSet.IndexFields
TClientDataSet.IndexFields3052016

TClientDataSet	参照

IndexFields プロパティは，カレントインデックスに関連付けられている項目の配列を指定します。

property IndexFields[Index: Integer]: TField;

説明

IndexFields プロパティは項目オブジェクトの 0 で始まる配列を提供します。各項目オブジェクトはカレントインデックスの項目に対応します。Index はインデックス内での項目の位置を示す番号です。インデックスの 1 番目の項目が IndexFields[0] で，2 番目の項目が IndexFields[1] となります。

注意

IndexFields プロパティは直接設定しないでください。かわりに，IndexFieldNames プロパティを使って実行時にその場でデータセットを順序付けます。


TClientDataSet.IndexName
TClientDataSet.IndexName3052017

TClientDataSet	参照

IndexName プロパティは，クライアントデータセットのインデックスを指定します。

property IndexName: string;

説明

IndexName プロパティを使うと，データセットの代替インデックスを指定できます。IndexName が空の場合，データセットのソート順序はデータパケットのデフォルト順序に基づいて決まります。デフォルト順序は定義済みインデックスの DEFAULT_ORDER によって決まります。

IndexName に有効なインデックス名があれば，レコードのソート順序を決めるのにそのインデックスが使われます。

注意

IndexFieldNames プロパティと IndexName プロパティを同時に使うことはできません。片方を設定すると，もう片方がクリアされます。


TClientDataSet.KeyExclusive
TClientDataSet.KeyExclusive3052018

TClientDataSet	参照

KeyExclusive プロパティは，範囲の上限と下限を指定します。

property KeyExclusive: Boolean;

説明

KeyExclusive プロパティを使うと，指定した範囲の開始値および終了値に一致するレコードが範囲に含まれるかどうかを指定できます。デフォルトでは KeyExclusive は True で，一致する値が含まれます。

指定した開始値より大きいレコードと，指定した終了値より小さいレコードに範囲を制限するには，KeyExclusive を False に設定します。


TClientDataSet.KeyFieldCount
TClientDataSet.KeyFieldCount3052019

TClientDataSet	参照

KeyFieldCount プロパティは，マルチ項目キーで部分キー検索を実行するときに使う項目数を指定します。

property KeyFieldCount: Integer;

説明

KeyFieldCount プロパティを使うと，マルチ項目キーに基づく検索を連続する項目の部分集合に制限することができます。KeyFieldCount の値は 0 から始まります。たとえば，データセットの一次キーが 3 つの項目から成る場合，KeyFieldCount を 0 に設定すれば，キーの最初の項目のみを使って部分キー検索を行えます。

注意

検索はキーの 1 番目の項目から始まる連続するキー項目に基づいて行われます。たとえば， 3 つの項目から成るキーの場合，KeyFieldCount を 0 に設定すれば 1 番目の項目で，1 に設定すれば 1 番目と 2 番目の項目で， 2 に設定すればすべての項目で検索を行えます。デフォルトでは，KeyFieldCount は検索にすべてのキーを使うように設定されます。


TClientDataSet.KeySize
TClientDataSet.KeySize3052020

TClientDataSet	参照

KeySize プロパティは，データセットで使われる現在のキーサイズを示します。

property KeySize: Word;

説明

KeySize プロパティを調べると，データセットで使われる現在のキーサイズを判定できます。KeySize はデータセットの一次インデックスのキー項目のサイズに対応します。


TClientDataSet.LogChanges
TClientDataSet.LogChanges3052021

TClientDataSet	参照

データの変更を記録するかどうかを示します。

property LogChanges: Boolean;

説明

LogChange プロパティを使うと，クライアントデータセット内のデータの変更を記録するかどうかを制御できます。LogChange が True ならば（デフォルト），すべての変更を記録し，アプリケーションサーバーに返すことができます。LogChange が False ならば，データの変更はメモリ内で行われますが，変更はサーバーに渡されません

CreateDataSet メソッドを使って一時データセットを作成するアプリケーションでは，新しいデータセットに初期値のセットを入れてから，LogChange を True に設定してデータ変更の記録を再開できるようにするために， LogChange を False に設定することがあります。

参考

アプリケーションによるデータ変更が他のデータセットに適用されない単層アプリケーションでクライアントデータセットを使うときは，LogChange を False に設定すると，システムリソースを節約できます。


TClientDataSet.MasterFields
TClientDataSet.MasterFields3052022

TClientDataSet	参照

マスターリンク関係を確立するためにこのデータセット内の項目とリンクさせるマスターテーブル内の 1 つ以上の項目を指定します。

property MasterFields: string;

説明

MasterSource プロパティを設定してから MasterFields プロパティを使うと，このデータセットと MasterSource で指定するデータセットとの間にマスターリンク関係を確立するのに使う 1 つ以上の項目の名前を指定できます。

MasterFields はマスターテーブル内の 1 つ以上の項目名からなる文字列です。項目名を複数指定するときはセミコロンで区切ります。

マスターテーブルのカレントレコードが変更されるたびに，そのレコードの項目の新しい値を使ってデータセットの対応するレコードが表示用に選択されます。

注意

設計時に 2 つのデータセット間のマスターリンク関係を確立するには，項目リンクデザイナを使います。


TClientDataSet.MasterSource
TClientDataSet.MasterSource3052023

TClientDataSet	参照

このデータセットと別のデータセットとの間でマスターリンク関係を確立するときにマスターテーブルとして使うデータソースコンポーネントの名前を指定します。

property MasterSource: TDataSource;

説明

MasterSource プロパティを使うと，このデータセットと別のデータセットとの間でマスターリンク関係を確立するときにマスターテーブルとして使うデータセットを持つデータソースコンポーネントの名前を指定できます。

注意

設計時には，オブジェクトインスペクタで MasterSource プロパティのドロップダウンリストから利用可能なデータソースを選択します。

MasterSource プロパティを設定した後で，MasterFields プロパティを設定して，マスターテーブルでどの項目を使うかを指定します。実行時には，マスターテーブルのカレントレコードが変更されるたびに，そのレコードの項目の新しい値を使ってデータセットの対応するレコードが表示用に選択されます。

注意

設計時に 2 つのデータセット間のマスターリンク関係を確立するには，項目リンクデザイナを使います。


TClientDataSet.PacketRecords
TClientDataSet.PacketRecords3052024

TClientDataSet	参照

1 つのデータパケット内のレコードの数または種類を示します。

property PacketRecords: Integer;

説明

PacketRecords プロパティを使うと，アプリケーションサーバーから取り出される 1 つのパケットにいくつのレコードを入れるかを指定したり，返されるパケットにサーバーからのメタデータのみを入れるように指定したりすることができます。

クライアントデータセットをインスタンス化すると，PacketRecords は自動的に -1 に設定され，1 つのパケットにデータセット内のすべてのレコードが入れられるようになります。

PacketRecords の値が 0 より大きい場合は，1 つのパケットに入れて返される実際のレコード数を示します。

データセットのメタデータを取り出すには，PacketRecords を 0 に設定します。PacketRecords が 0 ならば，アプリケーションは，リモートデータベースサーバーからテーブル，列，制約，ドメイン定義などのデータセットの構造を定義するすべての情報を返します。


TClientDataSet.Provider
TClientDataSet.Provider3052025

TClientDataSet	参照

クライアントデータセットがアプリケーションサーバー上のプロバイダオブジェクトと通信するのに使う IProvider インターフェースを指します。

property Provider: IProvider;

説明

Provider プロパティを使うと，クライアントデータセットがアプリケーションサーバー上の TProvider オブジェクトと通信するのに使う IProvider インターフェースを読み出したり，設定したりすることができます。クライアントデータセットが自分自身をクライアントアプリケーションのリモートサーバーオブジェクトに登録すると ProviderName プロパティに基づいて自動的に値が設定されるので，通常，アプリケーションはこのプロパティを問い合わせるだけです。アプリケーションサーバーに，クライアントアプリケーション上の異なるリモートサーバーオブジェクトで利用できるインターフェースが 2 つ以上ある場合，クライアントは実行時に Provider プロパティの値を変更してインターフェースを切り替えることができます。


TClientDataSet.ProviderName
TClientDataSet.ProviderName3052026

TClientDataSet	参照

クライアントアプリケーション上のこのクライアントデータセットが使うアプリケーションサーバー上の Provider プロパティの名前を指定します。

property ProviderName: string;

説明

ProviderName プロパティを使うと，サーバー上の通信相手となるプロバイダオブジェクトを指定できます。このプロパティは，リモートサーバーオブジェクトに特定の IProvider インターフェースを要求するのに使います。アプリケーションサーバーに複数のプロバイダオブジェクトがある場合，クライアントのリモートサーバーオブジェクトがアプリケーションサーバーへのイニシャル接続を確立したら，クライアントアプリケーションは  ProviderName をそれらのプロバイダオブジェクトのいずれかに設定することができます。


TClientDataSet.ReadOnly
TClientDataSet.ReadOnly3052027

TClientDataSet	参照

クライアントデータセットがこのアプリケーションで読み出し専用であるかどうかを示します。

property ReadOnly: Boolean;

説明

ReadOnly プロパティを使うと，ユーザーがデータセット内のデータを更新，挿入，削除できないようにすることができます。デフォルトでは，ReadOnly は False で，ユーザーはデータセットのデータを変更できます。

注意

ReadOnly が False でも，ユーザーはデータセットに対してデータの変更や追加を行えないこともあります。

ユーザーがデータセットに対してデータの変更や追加を行えないことが保証されるようにするには，ReadOnly プロパティを True に設定します。

ReadOnly が True ならば，データセットの CanModify プロパティは False です。


TClientDataSet.RemoteServer
TClientDataSet.RemoteServer3052031

TClientDataSet	参照

このクライアントデータセットが接続の目的で使うクライアントアプリケーション内のリモートサーバーオブジェクトを指定します。

property RemoteServer: TCustomRemoteServer;

説明

RemoteServer プロパティを使うと，このクライアントデータセットが使うリモートサーバーオブジェクトを指定できます。リモートサーバーは，複層アプリケーションでデータ交換のための IProvider インターフェースを取得するのに使います。クライアントアプリケーションが複数のリモートサーバーオブジェクトを使う場合，アプリケーションはこのプロパティの値を変更して，クライアントデータセットが使うリモートサーバーを変更することができます。


TClientDataSet イベント3052032

TClientDataSet	アルファベット順	凡例

TClientDataSet

OnReconcileError

TDataSet からの継承

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TClientDataSet イベント3052033

TClientDataSet	オブジェクト順	凡例

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError

OnReconcileError


TClientDataSet.OnReconcileError
TClientDataSet.OnReconcileError3052034

TClientDataSet	参照

OnReconcileError イベントは，アプリケーションサーバー上のプロバイダによって解決できなかったレコードの更新をクライアントデータセットが同期をとることが必要になったときに発生します。

type

TUpdateKind = (ukModify, ukInsert, ukDelete);

TReconcileAction = (raSkip, raAbort, raMerge, raCorrect, raCancel, raRefresh);

TReconcileErrorEvent = procedure(DataSet: TClientDataSet; E: EReconcileError;

UpdateKind: TUpdateKind; var Action: TReconcileAction) of object;

property OnReconcileError: TReconcileErrorEvent;

説明

OnReconcileError イベントハンドラを記述すると，更新をデータベースに適用した後で Reconcile メソッドがアプリケーションサーバーによって返されたレコードを反復するときに起こったエラー状況に応答できます。サーバーによって返されたレコードはサーバーがデータベースに適用できなかったレコードです。Reconcile はそれらのレコードの処理を試みます。OnReconcileError はサーバーによって返されるレコードごとに 1 度呼び出されます。

DataSet は，同期をとったレコードが適用されるクライアントデータセットの名前です。

E は，アプリケーションがエラーメッセージとエラー状況の実際の原因を引き出すことができる EReconcileError オブジェクトです。OnReconcileError ハンドラはこの情報を使ってエラー状況にどのように応答するかを決めます。

UpdateKind はエラーを生成した更新の種類を示します。以下に UpdateKind の値と意味を示します。

値	意味

ukModify	既存のレコードの編集が原因でエラーが起こった

ukInsert	新しいレコードの挿入または追加が原因でエラーが起こった

ukDelete	既存のレコードの削除が原因でエラーが起こった

Action は，OnReconcileError ハンドラが存在するときに実行するアクションを示します。ハンドラに入ると，Action は常にサーバーの解決プロセスによって行われるアクションに設定されます。OnReconcileError がエラー状況を処理または訂正できる場合は，エラーハンドラの終了の前に Action を raRetry に設定します。以下に Action の値と意味を示します。

値	意味

raSkip	エラー状況を引き起こしたレコードの更新をスキップし，適用されていない変更をキャッシュに残す

raAbort	エラーメッセージを表示せずに，処理を中止する

raMerge	更新されたレコードをサーバー上のレコードにマージする

raCorrect	更新されたレコードをデータベースに適用し直す

raCancel	変更ログから変更を削除する

raRefresh	現在のレコードの値を更新し，変更ログから変更を削除する

注意

OnReconcileError ハンドラのコードは，カレントレコードの各項目の OldValue，NewValue，CurValue プロパティを調べて適用することはできますが，別のレコードをカレントレコードにするメソッドを呼び出してはなりません。


TClientDataSet メソッド3052035

TClientDataSet	アルファベット順

TClientDataSet

AddIndex

AppendData

ApplyRange

ApplyUpdates

BookmarkValid

CancelRange

CancelUpdates

CloneCursor

CompareBookmarks

ConstraintsDisabled

Create

CreateBlobStream

CreateDataSet

DeleteIndex

Destroy

DisableConstraints

EditKey

EditRangeEnd

EditRangeStart

EmptyDataSet

EnableConstraints

FindKey

FindNearest

GetCurrentRecord

GetIndexInfo

GetIndexNames

GetNextPacket

GotoCurrent

GotoKey

GotoNearest

LoadFromFile

LoadFromStream

Locate

Lookup

MergeChangeLog

Reconcile

RevertRecord

SaveToFile

SaveToStream

SetKey

SetRange

SetRangeEnd

SetRangeStart

UndoLastChange

UpdateStatus

TDataSet からの継承

ActiveBuffer

Append

AppendRecord

Cancel

CheckBrowseMode

ClearFields

Close

ControlsDisabled

CursorPosChanged

Delete

DisableControls

Edit

EnableControls

FieldByName

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FreeBookmark

GetBookmark

GetFieldList

GetFieldNames

GotoBookmark

Insert

InsertRecord

IsEmpty

IsLinkedTo

IsSeguenced

Last

MoveBy

Next

Open

Post

Prior

Refresh

Resync

SetAltRecBuffers

SetFields

Translate

UpdateCursorPos

UpdateRecord

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TClientDataSet メソッド3052036

TClientDataSet	オブジェクト順

ActiveBuffer

AddIndex

Append

AppendData

AppendRecord

ApplyRange

ApplyUpdates

Assign

BookmarkValid

Cancel

CancelRange

CancelUpdates

CheckBrowseMode

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearFields

CloneCursor

Close

CompareBookmarks

ConstraintsDisabled

ControlsDisabled

Create

CreateBlobStream

CreateDataSet

CursorPosChanged

DefaultHandler

Delete

DeleteIndex

Destroy

DestroyComponents

Destroying

DisableConstraints

DisableControls

Dispatch

Edit

EditKey

EditRangeEnd

EditRangeStart

EmptyDataSet

EnableConstraints

EnableControls

FieldAddress

FieldByName

FindComponent

FindField

FindFirst

FindKey

FindLast

FindNearest

FindNext

FindPrior

First

Free

FreeBookmark

FreeInstance

FreeNotification

FreeOnRelease

GetBookmark

GetCurrentRecord

GetFieldList

GetFieldNames

GetIndexInfo

GetIndexNames

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetNextPacket

GetParentComponent

GotoBookmark

GotoCurrent

GotoKey

GotoNearest

HasParent

InheritsFrom

InitInstance

Insert

InsertComponent

InsertRecord

InstanceSize

IsEmpty

IsLinkedTo

IsSeguenced

Last

LoadFromFile

LoadFromStream

Locate

Lookup

MergeChangeLog

MethodAddress

MethodName

MoveBy

NewInstance

Next

Open

Post

Prior

Reconcile

Refresh

RemoveComponent

Resync

RevertRecord

SafeCallException

SaveToFile

SaveToStream

SetAltRecBuffers

SetFields

SetKey

SetRange

SetRangeEnd

SetRangeStart

Translate

UndoLastChange

UpdateCursorPos

UpdateRecord

UpdateStatus


TClientDataSet.AddIndex
TClientDataSet.AddIndex3052037

TClientDataSet	参照

クライアントデータセットに新しいインデックスを作成します。

type

 TIndexOptions = set of (ixPrimary, ixUnique, ixDescending, ixCaseInsensitive, ixExpression);

procedure AddIndex(const Name, Fields: string; Options: TIndexOptions);

説明

AddIndex メソッドを呼び出すと，クライアントデータセットに新しいインデックスを作成できます。Name は新しいインデックスの名前です。Fields は，セミコロンで区切られた，インデックスに入れる項目のリストです。Options は以下の 1 つまたは複数の値のセットです。

値	意味	制限事項

ixDescending	アルファベットの降順でソートする
ixCaseInsensitive	ソートの際，大文字小文字を区別しない	dBASE では使えない
テーブルに有効でないオプションを使ってインデックスを作成しようとすると，例外が生成されます。

注意

SaveToFile を使うときは，AddIndex によって追加されるインデックスはデータと一緒に保存されません。


TClientDataSet.AppendData
TClientDataSet.AppendData3052038

TClientDataSet	参照

新たに取り出したレコードのパケットを，クライアントデータセットにすでに格納されているレコードに追加します。

procedure AppendData(Data: OleVariant; HitEOF: Boolean);

説明

通常，アプリケーションは直接 AppendData メソッドを呼び出しません。代わりに，GetNextPacket メソッドを呼び出してレコードのパケットを取り出し，すでに利用可能なレコードに自動的に追加します。Data は新たに取り出した追加するレコードのパケットを示します。HitEOF は，データベースサーバーからレコードを取り出したときに，データセットの最後に到達したかどうかを示します。


TClientDataSet.ApplyRange
TClientDataSet.ApplyRange3052039

TClientDataSet	参照

データセットに範囲を適用します。

procedure ApplyRange;

説明

ApplyRange メソッドを呼び出すと，SetRangeStart メソッドと SetRangeEnd メソッド，または EditRangeStart メソッドと EditRangeEnd メソッドで設定した範囲を有効にすることができます。範囲が有効なときは，アプリケーションで表示および編集できるレコードは，範囲内にあるレコードだけになります。


TClientDataSet.ApplyUpdates
TClientDataSet.ApplyUpdates3052040

TClientDataSet	参照

データベースへの書き込みのために，更新，挿入，削除されたすべてのレコードをクライアントデータセットからアプリケーションサーバー上のプロバイダに送ります。

function ApplyUpdates(MaxErrors: Integer); Integer;

説明

ApplyUpdates メソッドを呼び出すと，更新，挿入，削除されたすべてのレコードをクライアントデータセットからアプリケーションサーバー上のプロバイダに書き込むことができます。MaxErrors は更新処理が中止されるまでにプロバイダによって許可されている最大エラー数を示します。

ペンディング中の更新がある場合，ApplyUpdates はクライアントデータセットの Reconcile メソッドを呼び出して，サーバーに更新を送り，サーバーによって返されたレコードをサーバーがデータベースに適用しようとするとエラーが生成されるので，サーバーによって返されたレコードの同期をとることを試みます。

ApplyUpdates は発生したエラーの数を返します。この戻り値と MaxErrors の設定に基づいて，適用に成功したレコードがクライアントデータセットの変更ログから削除されます。MaxErrors が -1 ならば，エラーが発生すると，更新処理は中止され，レコードは変更ログから削除されません。MaxErrors が正の値で，MaxErrors で許容されているより多くのエラーが発生した場合は，すべての更新が中止されます。発生したエラー数が MaxErrors に指定した値よりも少ない場合は，適用に成功したすべてのレコードが，データセットの変更ログから自動的に削除されます。


TClientDataSet.BookmarkValid
TClientDataSet.BookmarkValid3052041

TClientDataSet	参照

指定したブックマークの有効性を検査します。

type

TBookmark = Pointer;

function BookmarkValid(Bookmark: TBookmark): Boolean;

説明

ブックマークが有効かどうかを判定します。Bookmark は検査するブックマークのポインタです。ブックマークが有効ならば，BookmarkValid は True を返します。無効ならば False を返します。


TClientDataSet.CancelRange
TClientDataSet.CancelRange3052042

TClientDataSet	参照

クライアントデータセットで現在有効な範囲をすべて除去します。

procedure CancelRange;

説明

CancelRange メソッドを呼び出すと，クライアントデータセットに現在適用されている範囲を除去できます。範囲を取り消すと，再びデータセット内のすべてのレコードにアクセスできるようになります。


TClientDataSet.CancelUpdates
TClientDataSet.CancelUpdates3052043

TClientDataSet	参照

ペンディング中のキャッシュアップデートをすべて取り消し，変更ログをクリアします。

procedure CancelUpdates;

説明

CancelUpdates メソッドを呼び出すと，ペンディング中の更新を Delta プロパティからすべてクリアできます。Delta は，更新，挿入，削除を記録するためにクライアントデータセットによって保持されるバリアントです。


TClientDataSet.CloneCursor
TClientDataSet.CloneCursor3052044

TClientDataSet	参照

別のクライアントデータセットに属するデータを指します。

procedure CloneCursor(Source :TClientDataSet; Reset: Boolean);

説明

CloneCursor メソッドを呼び出すと，別のクライアントデータセットに属するデータの 2 つめの編集可能ビューを提供できます。Source はポインタを提供する別のクライアントデータセットを示します。Reset はソースデータセットの現在の範囲とフィルタをコピーするかどうかを指定します。Reset が False ならば，現在の範囲はコピーされたデータセットに適用されます。Reset が True ならば，データセットはコピーされますが，アクティブな範囲はコピーされたデータセットに適用されません。

指定したデータセットの以下のプロパティがコピーされます。

プロパティ	プロパティ	プロパティ

IndexFieldNames	IndexName	MasterSource

MasterFields	Provider	ProviderName

RemoteServer

CloneCursor はデータセットを閉じ，指定したクライアントデータセットを指し，2 つめのビューを開きます。例を示します。

ClientDataSet2.CloneCursor(ClientDataSet1, False);

この呼び出しの後では，ClientDataSet2 のデータは ClientDataSet1 のデータと同じです。いずれかのクライアントデータセットによって実行された編集は，ClientDataSet1 のデータに反映され，どちらのデータセットからも見ることができます。


TClientDataSet.CompareBookmarks
TClientDataSet.CompareBookmarks3052045

TClientDataSet	参照

2 つのブックマークを比較します。

type

TBookmark = Pointer;

function CompareBookmarks(Bookmark1, Bookmark2: TBookmark): Integer;

説明

CompareBookmarks メソッドを呼び出すと，2 つのブックマークが同じかどうかを判定できます。Bookmark1 と Bookmark2 は比較するブックマークです。CompareBookmarks は，Bookmark1 が Bookmark2 より小さければ -1 を返し，大きければ 1 を返し，両方のブックマークが同じか nil の場合， 0 を返します。


TClientDataSet.ConstraintsDisabled
TClientDataSet.ConstraintsDisabled3052046

TClientDataSet	参照

ConstraintsDisabled メソッドは，制約がクライアントデータセットにとって有効かどうかを示します。

function ConstraintsDisabled: Boolean;

説明

ConstraintsDisabled メソッドを呼び出すと，あるデータセットに対する制約が有効かどうかがわかります。ConstraintsDisabled が True を返した場合は，制約は現在無効です。False を返した場合は，有効です。


TClientDataSet.Create
TClientDataSet.Create3052047

TClientDataSet	参照

TClientDataSet コンポーネントのインスタンスを作成します。

constructor Create(AOwner: TComponent);

説明

Create メソッドを呼び出すと，実行時にクライアントデータセットコンポーネントをインスタンス化できます。Create は Data プロパティをクリアして，データセットにマスターリンクを設定します。


TClientDataSet.CreateDataSet
TClientDataSet.CreateDataSet3052048

TClientDataSet	参照

新しい空のクライアントデータセットを作成します。

procedure CreateDataSet;

説明

CreateDataSet メソッドを実行時に呼び出すと，新しい空のクライアントデータセットを作成できます。

FieldDefs プロパティに値がある場合は，項目定義を作成するのにその値が使われます。それ以外の場合は，Fields プロパティが使われます。データセットを作成するためには，この 2 つのプロパティの 1 つまたは両方に値が入っている必要があります。

IndexDefs に値がある場合，データセットのインデックス定義を作成するのにその値が使われます。


TClientDataSet.DeleteIndex
TClientDataSet.DeleteIndex3052049

TClientDataSet	参照

Deletes メソッドは，クライアントデータセットのインデックスを削除します。

procedure DeleteIndex(const Name: string);

説明

DeleteIndex メソッドを呼び出すと，クライアントデータセットのインデックスを削除できます。Name は削除するインデックスの名前です。

注意

予約済みインデックス，DEFAULT_ORDER および CHANGEINDEXを削除することはできません。


TClientDataSet.Destroy
TClientDataSet.Destroy3052050

TClientDataSet	参照

クライアントデータセットコンポーネントのインスタンスを破棄します。

destructor Destroy;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。通常，データセットの破棄は Delphi が自動的に処理します。ただし，アプリケーションが独自のデータセットのインスタンスを作成する場合は Free を呼び出す必要があります。Free はデータセットコンポーネントが解放されていないことを確認してから Destroy を呼び出します。

Destroy は Data プロパティをクリアしてから，継承された Destroy デストラクタを呼び出し，クライアントデータセットのマスターリンクを解放するとともに，インデックス定義リストを解放します。


TClientDataSet.DisableConstraints
TClientDataSet.DisableConstraints3052051

TClientDataSet	参照

データセットに対するサーバー制約の適用を無効にします。

procedure DisableConstraints;

説明

DisableConstraints メソッドを呼び出すと，一時的に，複製されたサーバー制約がデータセットに適用されないようにすることができます。たとえば，アプリケーションがデータセットを繰り返すときに，制約を一時的に無効にすると処理効率を改善できます。

注意

DisableConstraints を呼び出すと，参照カウントが増加します。この参照カウントが0 より大きいうちは，データセットへの制約は無効です。誤って制約を無効にしてしまうのを防ぐには，常に DisableConstraints の呼び出しを EnableConstraints の呼び出しと一緒に行うようにします。


TClientDataSet.EditKey
TClientDataSet.EditKey3052052

TClientDataSet	参照

検索キーバッファの変更を有効にします。

procedure EditKey;

説明

EditKey メソッドを呼び出すと，現在の検索キーバッファの現在の内容を保ちながら，クライアントデータセットを dsSetKey 状態にすることができます。現在の検索キーを調べるには，IndexFields プロパティを使ってカレントインデックスが使っている項目を繰り返します。

EditKey は，検索を何度か実行するときに，多数の項目値のうちの 1 つまたは 2 つだけが変更される場合に特に便利です。


TClientDataSet.EditRangeEnd
TClientDataSet.EditRangeEnd3052053

TClientDataSet	参照

既存の範囲の終了値を変更可能にします。

procedure EditRangeEnd;

説明

EditRangeEnd メソッドを呼び出すと，既存の範囲の終了値を変更できます。終了範囲値を指定するには，EditRangeEnd を呼び出してから FieldByName を呼び出します。新しい終了値を代入したら，ApplyRange を呼び出して変更した範囲をアクティブ化します。


TClientDataSet.EditRangeStart
TClientDataSet.EditRangeStart3052054

TClientDataSet	参照

既存の範囲の開始値を変更可能にします。

procedure EditRangeStart;

説明

EditRangeStart を呼び出すと，既存の範囲の開始値を変更できます。開始範囲値を指定するには，EditRangeStart を呼び出してから FieldByName を呼び出します。新しい開始値を代入したら，ApplyRange を呼び出して，変更した範囲をアクティブ化します。


TClientDataSet.EnableConstraints
TClientDataSet.EnableConstraints3052055

TClientDataSet	参照

データセットエントリに対するサーバー制約の適用を有効にします。

procedure EnableConstraints

説明

EnableConstraints メソッドを呼び出すと，DisableConstraints の呼び出しによって以前に無効にされたサーバー制約を有効にできます。

注意

EnableConstraints を呼び出すと，参照カウントが減少します。この参照カウントが 0 になると，制約がデータセットに対して有効になります。誤って制約を無効にしてしまうのを防ぐには，DisableConstraints を呼び出したら，必ず続けて EnableConstraints を呼び出すようにします。


TClientDataSet.FindKey
TClientDataSet.FindKey3052056

TClientDataSet	参照

指定した項目値が入ったレコードを検索します。

function FindKey(const KeyValues: array of const): Boolean;

説明

FindKey メソッドを呼び出すと，データセット内の特定のレコードを検索できます。KeyValues には，キーと呼ばれる，カンマで区切られた項目値の配列が入ります。キーのそれぞれの値にはリテラル，変数，ヌル，nil を指定できます。KeyValues で渡された値の数が，検索に使われるインデックス内の列数より少ない場合，足りない値はヌルとみなされます。

検索が成功すると，FindKey は一致したレコードにカーソルを置いて True を返します。それ以外の場合は，カーソルは移動せず，FindKey は False を返します。


TClientDataSet.FindNearest
TClientDataSet.FindNearest3052057

TClientDataSet	参照

指定したキー値のセットに最も近いレコードにカーソルを移動します。

procedure FindNearest(const KeyValues: array of const);

説明

FindNearest メソッドを呼び出すと，データセット内の特定のレコードまたは KeyValues パラメータで指定した値より大きいデータセット内の最初のレコードにカーソルを移動できます。KeyValues には，キーと呼ばれる，カンマで区切られた項目値の配列が入ります。KeyValues で渡された値の数が検索に使われるインデックス内の列数より少ない場合，足りない値はヌルとみなされます。

注意

FindNearest は文字列型データでのみ使えます。

FindNearest は，検索基準に正確に一致するレコード，または，検索基準に指定した値より大きい値を持つ最初のレコードのいずれかにカーソルを移動します。KeyExclusive の現在の設定値にも影響を受けます。


TClientDataSet.GetCurrentRecord
TClientDataSet.GetCurrentRecord3052058

TClientDataSet	参照

カレントレコードをバッファに取り出します。

function GetCurrentRecord(Buffer: PChar): Boolean;

説明

ほとんどのアプリケーションは GetCurrentRecord を呼び出す必要はありません。TClientDataSet は自動的にアクティブレコードにバッファを割り当てます。

GetCurrentRecord メソッドを呼び出すと，カレントレコードをアプリケーションによって割り当てられたバッファにコピーすることができます。Buffer は RecordSize プロパティで示されるレコードサイズ以上である必要があります。


TClientDataSet.GetIndexInfo
TClientDataSet.GetIndexInfo3052059

TClientDataSet	参照

データセットのカレントインデックスについての情報を取り出します。

procedure GetIndexInfo;

説明

GetIndexInfo メソッドを呼び出すと，データセットの内部インデックス項目に，項目数，マップ，キーサイズなどのカレントインデックスについての情報を入れることができます。


TClientDataSet.GetIndexNames
TClientDataSet.GetIndexNames3052060

TClientDataSet	参照

クライアントデータセットで利用可能なインデックスのリストを取り出します。

procedure GetIndexNames(List: TStrings);

説明

GetIndexNames メソッドを呼び出すと，クライアントデータセットで利用可能なすべてのインデックスのリストを取り出すことができます。List は，アプリケーションによって作成され，保持される文字列リストオブジェクトで，そのリストにインデックス名が取り出されます。

注意

すべてのクライアントデータセットに次の 2 つのインデックスが自動的に生成されます。

・	DEFAULT_ORDER。データパケットに入れられたときのデータ順を表す

・	CHANGEINDEX。別のデータセットに代入されたデルタである場合の順序にデータを順序付ける


TClientDataSet.GetNextPacket
TClientDataSet.GetNextPacket3052061

TClientDataSet	参照

アプリケーションサーバーから次のレコードのブロックを取り出します。

function GetNextPacket: Integer;

説明

GetNextPacket メソッドを呼び出すと，アプリケーションサーバーから次のレコードのブロックを取り出すことができます。1 つのパケットに入れて返される最大レコード数を指定するには，GetNextPacket を呼び出す前に PacketRecords プロパティを設定します。パケットは，Data プロパティにすでに格納されているレコードに追加されます。

GetNextPacket は Data に追加されたレコード数を返します。戻り値が 0 ならば，クライアントアプリケーションは，すでに利用可能なすべてのレコードをアプリケーションサーバーから受け取っています。


TClientDataSet.GotoCurrent
TClientDataSet.GotoCurrent3052062

TClientDataSet	参照

このデータセットのカレントレコードを別のクローンデータセットのカレントレコードと同じに設定します。

procedure GotoCurrent(DataSet: TClientDataset);

説明

GotoCurrent メソッドを呼び出すと，指定したデータセットでカレントである同じレコードにカーソルを移動できます。

GotoCurrent は，同じデータを表示および編集するのに別々のデータソースを使う 2 つのクライアントデータセットを同期させる場合にのみ便利です。


TClientDataSet.GotoKey
TClientDataSet.GotoKey3052063

TClientDataSet	参照

現在のキーで指定されるレコードにカーソルを移動します。

function GotoKey: Boolean;

説明

GotoKey メソッドを使うと，前回の SetKey メソッドまたは EditKey メソッドの呼び出しで代入されたキー値によって指定されるレコード，および検索キーバッファで示される実際の検索値に移動できます。

一致するレコードを見つけた場合，GotoKey はカーソルをそのレコードに移動し，True を返します。それ以外の場合は，現在のカーソル位置は変更されず，GotoKey は False を返します。


TClientDataSet.GotoNearest
TClientDataSet.GotoNearest3052064

TClientDataSet	参照

現在のキーに最も近いレコードにカーソルを移動します。

procedure GotoNearest;

説明

GotoNearest メソッドを呼び出すと，キーバッファの現在のキー値によって指定されるとおりのレコード，または指定した値より大きい値を持つ最初のレコードにカーソルを移動できます。

注意

レコードを検索範囲の一部とみなすかどうかは，KeyExclusive プロパティによって決まります。

GotoNearest を呼び出す前に，アプリケーションは，SetKey または EditKey メソッドを呼び出してキー値を指定してデータセットを dsSetKey 状態にしてから，FieldByName を使ってバッファに検索値を入れる必要があります


TClientDataSet.LoadFromFile
TClientDataSet.LoadFromFile3052065

TClientDataSet	参照

ファイルからクライアントデータセットのデータをロードします。

procedure LoadFromFile(const FileName: string);

説明

LoadFromFile メソッドを呼び出すと，クライアントデータセットの Data プロパティに外部ファイルのデータを入れることができます。FileName はロードするデータが入ったファイルの名前です。

注意

FileName には，前回のこのクライアントデータセットまたは別のクライアントデータセットの SaveToFile メソッドの呼び出しによってファイルに保存されたデータが入っていなければなりません。


TClientDataSet.LoadFromStream
TClientDataSet.LoadFromStream3052066

TClientDataSet	参照

ストリームからクライアントデータセットのデータをロードします。

procedure LoadFromStream(Stream: TStream);

説明

LoadFromStream メソッドを呼び出すと，クライアントデータセットの Data プロパティにストリームのデータを入れることができます。Stream はデータを読み出すストリームの名前です。できます。

注意

Stream には，クライアントデータセットの内部ブロックフォーマットのデータ（たとえば，SaveToStream メソッドを使って別のクライアントデータセットによってストリームに書き込まれたデータなど）が入っていなければなりません。


TClientDataSet.Locate
TClientDataSet.Locate3052067

TClientDataSet	参照

指定したレコードを検索し，そのレコードをカレントレコードにします。

type

TLocateOption = (loCaseInsensitive, loPartialKey);

TLocateOptions = set of TLocateOption;

function Locate(const KeyFields: string; const KeyValues: Variant;

Options: TLocateOptions): Boolean;

説明

Locate メソッドを呼び出すと，指定したレコードを検索し，そのレコードにカーソルを移動することができます。KeyFields は，セミコロンで区切られた，検索する項目名のリストが入った文字列です。

KeyValues は，キー項目で照合する値が入ったバリアントです。複数の検索値を指定するには，引数に KeyValues をバリアント配列として渡すか，または次のように VarArrayOf ルーチンを使ってバリアント配列を作成します。

with CustTable do

  Locate('Company;Contact;Phone', VarArrayOf(['Sight Diver', 'P']), loPartialKey);

Options は，文字列項目の検索での検索の許容度を指定するセットです。Options に loCaseInsensitive が含まれていれば，項目の照合の際，Locate は大文字小文字の違いを無視します。Options に loPartialKey が含まれていれば，Locate は KeyValues の基準の最初の部分だけでも満たしている最初のレコードを見つけます。Options が空のセットの場合，または KeyFields が文字列項目でない場合，Options は無視されます。

Locate は一致するレコードを見つけた場合は True を返し，そのレコードをカレントレコードにします。それ以外の場合は，Locate は False を返します。


TClientDataSet.Lookup
TClientDataSet.Lookup3052068

TClientDataSet	参照

指定した検索値に一致するレコードから項目値を取り出します。

function Lookup(const KeyFields: string; const KeyValues: Variant;

const ResultFields: string): Variant;

説明

Lookup メソッドを呼び出すと，検索基準に一致するレコードから指定した項目の値を取り出すことができます。KeyFields は，セミコロンで区切られた，検索する項目名のリストの入った文字列です。

KeyValues は，キー項目で照合する値が入ったバリアントです。複数の検索値を指定するには，引数に KeyValues をバリアント配列として渡すか，または VarArrayOf ルーチンを使ってバリアント配列を作成します。

ResultFields は，セミコロンで区切られた，一致するレコードから値が返される項目名のリストが入った文字列です。

Lookup は，ResultFields で指定される項目からの値が入ったバリアント配列を返します。


TClientDataSet.MergeChangeLog
TClientDataSet.MergeChangeLog3052069

TClientDataSet	参照

変更ログのすべてのデータ変更をクライアントデータセットにマージし，既存の値を上書きします。

procedure MergeChangeLog;

説明

MergeChangeLog メソッドを呼び出すと，変更ログのデータ変更をデータセットの実際のデータにマージし，効果的に新しいデータベースラインを作成できます。変更される既存値は上書きされます。

注意

通常，アプリケーションはこのメソッドを呼び出す必要はありません。このメソッドは，更新処理の一部として ApplyUpdates によって自動的に呼び出されます。


TClientDataSet.Reconcile
TClientDataSet.Reconcile3052070

TClientDataSet	参照

クライアントデータセットの変更のキャッシュから正しく更新されたレコードをクリアします。

function Reconcile(Results: OleVariant): Boolean;

説明

Reconcile メソッドは，更新処理中に発生したエラー状況を処理するために，ApplyUpdates 関数によって呼び出されます。Reconcile メソッドは，クライアントデータセットの Delta プロパティ内の変更から，プロバイダによって管理されているデータセットに変更が適用された後で呼び出されます。複層アプリケーションでは，プロバイダはアプリケーションサーバー上にあります。

Results はアプリケーションによって宣言される 2 つめのバリアントで，プロバイダが適用できなかったレコードのエラー情報とレコード情報が入ります。

すべての更新が正常に適用されれば，Results は null で，MergeChangeLog の呼び出しにより，データセットの変更ログからすべてのレコードが自動的に削除されます。

更新処理中にエラーが発生した場合，Results にはエラーレコードが入り，ApplyUpdates の MaxErrors パラメータの設定によっては，変更ログ内のレコードは削除されないことがあります。MaxErrors が -1 ならば，エラーが発生すると更新処理は中止され，レコードは変更ログから削除されず，Results の内容は Delta の内容と一致します。MaxErrors が正の値で，MaxErrors によって許容されている値より多くのエラーが発生した場合，すべての更新が中止され，Results にはエラーを生成したレコードのみが入ります。発生したエラー数が MaxErrors に指定した値よりも少ない場合，Results にはエラーレコードが入りますが，正常に適用されたレコードはすべてデータセットの変更ログから自動的にクリアされます。

Reconcile は同期をとる処理が成功したかどうかを示す論理値を返します。True ならば，Reconcile はエラーなしで成功したことを示し，False ならば，同期をとることができなかったエラーが 1 つ以上あることを示します。


TClientDataSet.RevertRecord
TClientDataSet.RevertRecord3052071

TClientDataSet	参照

カレントレコードの編集を取り消します。

procedure RevertRecord;

説明

RevertRecord メソッドを呼び出すと，カレントレコードに対するすべての変更を削除できます。RevertRecord が削除できるのは，アプリケーションサーバーがデータベースに適用していないレコードの変更だけです。

注意

レコードに対する直前の編集を元に戻すには，UndoLastChange メソッドを呼び出します。ペンディング中のすべての変更を取り消すには，CancelUpdates メソッドを呼び出します。


TClientDataSet.SaveToFile
TClientDataSet.SaveToFile3052072

TClientDataSet	参照

クライアントデータセットのデータを外部ファイルに保存します。

procedure SaveToFile(const FileName: string);

説明

SaveToFile メソッドを呼び出すと，このクライアントデータセットまたは他のクライアントデータセットが後で使えるように，クライアントデータセットのデータを外部ファイルに書き込むことができます。FileName は使用される外部ファイルの名前です。ファイルがすでに存在する場合は，ファイルの現在の内容は上書きされます。


TClientDataSet.SaveToStream
TClientDataSet.SaveToStream3052073

TClientDataSet	参照

クライアントデータセットのデータをストリームに保存します。

procedure SaveToStream(Stream: TStream);

説明

SaveToStream メソッドを呼び出すと，他のデータセットが直ちに使えるように，クライアントデータセットのデータをストリームに書き込むことができます。Stream は書き込み先の既存のストリーム名です。


SetAltRecBuffers

SetAltRecBuffers メソッドは，項目値を検索する前にレコードバッファを設定します。

procedure SetAltRecBuffers(Old, New, Cur:PChar);

説明

通常，アプリケーションではこのメソッドを直接呼び出す必要はありません。SetAltrecBuffers メソッドは，クライアントデータセットに属するコンポーネントの OldValue プロパティ，NewValue プロパティ，および CurValue プロパティにアクセスするときに使われるレコードバッファを指すポインタを設定します。これらの値は，更新処理中に限りアクセスされます。


TClientDataSet.SetKey
TClientDataSet.SetKey3052075

TClientDataSet	参照

検索の前に，データセットのキーおよび範囲の設定を有効にします。

procedure SetKey;

説明

SetKey メソッドを呼び出すと，データセットを dsSetKey 状態にし，検索キーバッファの現在の内容をクリアできます。検索の実行の前に， FieldByName を使ってバッファに新しい値のセットを入れます。

注意

既存のキーまたは範囲を変更するには，EditKey を呼び出します。


TClientDataSet.SetRange
TClientDataSet.SetRange3052076

TClientDataSet	参照

範囲の開始値と終了値を設定し，適用します。

procedure SetRange(const StartValues, EndValues: array of const);

説明

SetRange メソッドを呼び出すと，範囲を指定し，データセットに適用できます。StartValues は範囲内の最初のレコードを指定する項目値を示します。EndValues は範囲内の最後のレコードを指定する項目値を示します。

SetRange は SetRangeStart，SetRangeEnd，ApplyRange の機能を 1 度の手続き呼び出しにまとめたものです。SetRange は次の処理を実行します。

1.	データセットを dsSetKey 状態にする

2.	以前に指定した開始範囲値と終了範囲値を消去する

3.	開始範囲値と終了範囲値を設定する

4.	範囲をデータセットに適用する

StartValues と EndValues の値のいずれかがカレントインデックス内の項目数よりも少ない場合，残りのエントリは NULL に設定されます。


TClientDataSet.SetRangeEnd
TClientDataSet.SetRangeEnd3052077

TClientDataSet	参照

以後項目に代入される値が，データセットに入れる行の範囲の終了地点を指定することを示します。

procedure SetRangeEnd;

説明

SetRangeEnd メソッドを呼び出すと，データセットを dsSetKey 状態にし，既存の終了範囲値を消去し，その値を NULL に設定できます。それ以後に FieldByName メソッドに項目を代入すると，実際の範囲の終了値のセットが指定されます。

終了範囲値を代入した後で，変更した範囲をアクティブにするために ApplyRange メソッドを呼び出します。


TClientDataSet.SetRangeStart
TClientDataSet.SetRangeStart3052078

TClientDataSet	参照

以後項目に代入される値が，データセットに入れる行の範囲の開始地点を指定することを示します。

procedure SetRangeStart;

説明

SetRangeStart メソッドを呼び出すと，データセットを dsSetKey 状態にし，既存の開始範囲値を消去し，その値を NULL に設定できます。それ以後に FieldByName メソッドに項目を代入すると，実際の範囲の開始値のセットが示されます。

開始範囲値を FieldValues に代入した後で，変更した範囲をアクティブにするために ApplyRange メソッドを呼び出します。


TClientDataSet.UndoLastChange
TClientDataSet.UndoLastChange3052079

TClientDataSet	参照

クライアントデータセット内のレコードに対して直前に行った編集，挿入，または削除処理を取り消します。

function UndoLastChange(FollowChange: Boolean): Boolean;

説明

UndoLastChange メソッドを呼び出すと，クライアントデータセット内のレコードに対して直前に行った編集，挿入，または削除処理を取り消すことができます。FollowChange は復元されたレコードにカーソルを移動するどうかを示します。FollowChange が True ならば，復元されたレコードにカーソルが移動されます。FollowChange が False ならば，カーソルはカレントレコードに置かれたままです。


TClientDataSet.UpdateStatus
TClientDataSet.UpdateStatus3052080

TClientDataSet	参照

データセット内のカレントレコードの現在の更新ステータスを報告します。

type

TUpdateStatus = (usUnmodified, usModified, usInserted, usDeleted);

function UpdateStatus: TUpdateStatus;

説明

UpdateStatus メソッドを呼び出すと，クライアントデータセット内のカレントレコードの更新ステータスを判定できます。更新ステータスはレコードを編集，挿入，削除するたびに頻繁に変更されることがあります。UpdateStatus メソッドは，カレントレコードの更新ステータスに基づいて行われる処理を開始したり，完了したりする前に，アプリケーションが現在のステータスにアクセスするための便利な手段を提供します。

注意

データセット全体に対するペンディング中の更新があるかどうかを判定するには，ChangeCount プロパティを確認します。


スコープ3052081

published

読み出し／書き込み

読み出し専用


スコープ3052082

published


継承3052083

TObject

TPersistent

TComponent

TDataSet


TClientDataSet 例3052084

TClientDataSet


TClientSocket
TClientSocket3053001

継承	プロパティ	メソッド	イベント	参照

TClientSocket オブジェクトは TCP/IP クライアント用のクライアントソケット接続を管理します。

ユニット

scktcomp

説明

フォームまたはデータモジュールに TClientSocket オブジェクトを追加すると，アプリケーションを TCP/IP クライアントに変えることができます。TClientSocket は，TCP/IP サーバーへの接続の指定，オープン時の接続の管理，およびアプリケーション終了時の接続の終了を行います。


TClientSocket プロパティ3053002

TClientSocket	アルファベット順	凡例

TClientSocket

ClientType

Socket

TCustomSocket からの継承

Active

Address

Host

Port

Service

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TClientSocket プロパティ3053003

TClientSocket	オブジェクト順	凡例

Active

Address

ClientType

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Host

Name

Owner

Port

Service

Socket

Tag

VCLComObject


TClientSocket.ClientType
TClientSocket.ClientType3053004

TClientSocket	参照

ClientType プロパティは，クライアントソケットがソケット接続で非同期的に情報を読み書きするかどうかを指定します。

TClientType = (ctNonBlocking, ctBlocking);

property ClientType: TClientType;

説明

ClientType プロパティを ctNonBlocking に設定すると，クライアントソケットは非同期的な読み出しおよび書き込みイベントに応答できるようになります。ClientType が ctNonBlocking ならば，実行がソケット接続での読み書きによってブロックされることはありません。OnRead または OnWrite イベントは，ソケットが接続で読み書きを行うことが必要になったときに発生します。

ClientType プロパティを ctBlocking に設定すると，すべての読み書きが同期的に行われるようにすることができます。ClientType が ctBlocking の場合は，クライアントソケットオブジェクトをスレッドに組み込むとよいでしょう。そうすれば，入出力がクライアントアプリケーション内のすべての実行をブロックすることはありません。

ClientType プロパティが ctBlocking のときは，読み書きに TWinSocketStream オブジェクトを使います。TWinSocketStream は，読み書き中に問題が生じた場合に，アプリケーションが応答しなくなることを防ぐことができます。また，TWinSocketStream はソケット接続が読み出しを行えるようになるのを待つことができます。

読み書きをサーバーソケットと同期させる必要があるときは，非ブロッキングソケットを使います。


TClientSocket.Socket
TClientSocket.Socket3053005

TClientSocket	参照

Socket プロパティは，Windows クライアントソケット接続のクライアントエンドポイントを示す TClientWinSocket オブジェクトです。

property Socket: TClientWinSocket;

説明

Socket プロパティは，以下の処理を行うことができます。

・	接続にバインドされているクライアントソケットとサーバーソケットとの両方のアドレスおよびポートを判別する

・	ソケット接続を通じて情報を読み書きする

・	クライアントがどのサーバー通知に応答するかを判別する

・	Windows ソケット API 呼び出しを行うための Windows ソケットハンドルを取得する


TClientSocket イベント3053006

TClientSocket	アルファベット順	凡例

TCustomSocket からの継承

OnConnect

OnConnecting

OnDisconnect

OnError

OnLookup

OnRead

OnWrite


TClientSocket イベント3053007

TClientSocket	オブジェクト順	凡例

OnConnect

OnConnecting

OnDisconnect

OnError

OnLookup

OnRead

OnWrite


TClientSocket メソッド3053008

TClientSocket	アルファベット順

TClientSocket

Create

Destroy

TCustomSocket からの継承

Close

Open

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TClientSocket メソッド3053009

TClientSocket	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Close

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

Open

RemoveComponent

SafeCallException


TClientSocket.Create
TClientSocket.Create3053010

TClientSocket	参照

Create メソッドは，TClientSocket のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にクライアントソケットコンポーネントを作成および初期化できます。設計時に配置された TClientSocket オブジェクトは自動的に作成されます。

継承するコンストラクタを呼び出した後，Create は以下の処理を実行します。

・	Windows ソケット接続のクライアントエンドポイントを示す TClientWinSocket オブジェクトを割り当てる

・	クライアントソケットのイベントおよびエラーディスパッチャを初期化する


TClientSocket.Destroy
TClientSocket.Destroy3053011

TClientSocket	参照

Destroy メソッドは，TClientSocket のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはクライアントソケットが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy は Windows ソケット接続のクライアントエンドポイントを示す TClientWinSocket オブジェクトを解放します。


スコープ3053012

published

読み出し／書き込み

読み出し専用


スコープ3053013

published


継承3053014

TObject

TPersistent

TComponent

TCustomSocket


TClientSocket 例3053015

TClientSocket


TClipboard
TClipboard3054001

継承	プロパティ	メソッド	参照

TClipboard は Windows のクリップボードをカプセル化します。

ユニット

clipbrd

説明

Windows のクリップボードは，アプリケーションで切り取り，コピー，または貼り付けを行うテキストまたはグラフィックスを格納するコンテナです。TClipboard はWindows クリップボードの Delphi ラッパーオブジェクトです。

Clipbrd ユニットは，自動的に TClipboard をインスタンス化します。クリップボードオブジェクトは，インスタンス化するのではなく Create コンストラクタを呼び出して作成してください。Clipboard 関数は，クリップボードが誤って削除されるのを防ぎます。

クリップボードの各プロパティは，クリップボードが扱う形式として「登録された」形式の情報を持っています。

クリップボードの各メソッドは下記の処理を行います。

・	適当な形式でデータを取得し，取り出す

・	参照回数をカウントし，クリップボードを開き，閉じる

・	クリップボード内のオブジェクトの形式を管理，操作する


TClipboard プロパティ3054002

TClipboard	アルファベット順	凡例

TClipboard

AsText

FormatCount

Formats


TClipboard プロパティ3054003

TClipboard	オブジェクト順	凡例

AsText

FormatCount

Formats


TClipboard.AsText
TClipboard.AsText3054004

TClipboard	参照

AsText プロパティは，クリップボードの現在の内容を文字列として返します。

property AsText: string;

説明

AsText プロパティは，クリップボードにテキストを入れたり，クリップボードからテキストを取り出したりするのに使います。AsText プロパティは，文字列をクリップボードにコピーします。この場合，AsText の値として文字列を割り当ててください。

文字列の長さは 255 バイトまでです。255 バイトを超える文字列の書き込みと取り出しを行うには，SetTextBuf メソッドと GetTextBuf メソッドを使います。

クリップボードに文字列が入っていないと例外が発生します。文字列が入っているかどうかを知るには HasFormat メソッドを使います。


TClipboard.FormatCount
TClipboard.FormatCount3054005

TClipboard	参照

FormatCount プロパティは，Formats 配列プロパティ内の形式の数を表します。

property FormatCount: Integer;

説明

FormatCount プロパティは，クリップボードが登録している形式の数を知るのに使います。このプロパティは読み出し専用です。

クリップボードで特定の形式が使われているかどうかを知るには HasFormat メソッドを使います。新しい形式を登録するには TPicture の RegisterClipboardFormat メソッドを使います。


TClipboard.Formats
TClipboard.Formats3054006

TClipboard	参照

Formats プロパティは，クリップボードに含まれるすべての形式をリストします。

property Formats[Index: Integer]: Word;

説明

Formats プロパティで形式を取得するには，Index パラメータで配列内の位置を指定します。

通常，クリップボードへのコピーや切り取りを行うと，クリップボードには複数の形式が入ります。

アプリケーションはクリップボードに特定の形式の項目を入れ，その形式が Formats 配列にあればクリップボードでその形式の項目を検索できます。クリップボードで処理できる形式かどうかは HasFormat メソッドで確認できます。


TClipboard メソッド3054007

TClipboard	アルファベット順

TClipboard

Assign

Clear

Close

GetAsHandle

GetComponent

GetTextBuf

HasFormat

Open

SetAsHandle

SetComponent

SetTextBuf

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TClipboard メソッド3054008

TClipboard	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Close

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetAsHandle

GetComponent

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetTextBuf

HasFormat

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Open

SafeCallException

SetAsHandle

SetComponent

SetTextBuf


TClipboard.Assign
TClipboard.Assign3054009

TClipboard	参照

Assign メソッドは，クリップボードからオブジェクトを取り出したり，クリップボードにオブジェクトをコピーしたりします。

procedure Assign(Source: TPersistent);

説明

Assign メソッドは，ピクチャーをクリップボードに入れたり，クリップボードからピクチャーを取り出したりすることができます。

Source パラメータで指定されたオブジェクトがコピーされるオブジェクトです。たとえば次のコードでは，Bitmap1 というビットマップオブジェクトからクリップボードにビットマップをコピーします。

Clipboard.Assign(Bitmap1);

クリップボードからオブジェクトを取り出すには，クリップボード（内にあるオブジェクト）を新しいオブジェクト，つまり Assign メソッドを呼び出しているオブジェクトにコピーします。たとえば次のコードでは，クリップボードにあるビットマップを Bitmap1 というビットマップオブジェクトにコピーします。

Bitmap1.Assign(Clipboard);

HasFormat メソッドは，クリップボードにオブジェクトをコピーするとき使われる形式をリストします。ビットマップやメタファイルのようなグラフィックオブジェクトは，独自の形式を持っています。他のオブジェクトはほとんどテキストと同様の標準形式を使っています。


TClipboard.Clear
TClipboard.Clear3054010

TClipboard

Clear メソッドは，クリップボードの内容を削除します。

procedure Clear;

説明

Clear メソッドは，データがクリップボードに（切り取りまたはコピーで）追加されるたびに自動的に呼び出されます。


TClipboard.Close
TClipboard.Close3054011

TClipboard	参照

Close メソッドは，クリップボードが開いている場合それを閉じます。

procedure Close;

説明

Close メソッドは，クリップボードへの項目の追加を完了したときに呼び出します。

クリップボードは Open メソッドを呼び出せば何回でも開けます。Open および Close メソッドはクリップボードを開いた回数をカウントしています。実際にクリップボードが閉じるのは，閉じた回数が開いた回数と同じになったときです。


TClipboard.GetAsHandle
TClipboard.GetAsHandle3054012

TClipboard	参照

GetAsHandle メソッドは，クリップボードのデータを指定した形式の Windows ハンドルで返します。

function GetAsHandle (Format: Word): THandle;

説明

GetAsHandle メソッドを呼び出すと，Windows ハンドルを使ってクリップボードに他の形式を追加できます。ハンドルはアプリケーションによって所有されていないので，データはコピーする必要があります。

注意

GetAsHandle メソッドから返されるハンドルは，クリップボードが開いている間だけ有効です。クリップボードが閉じると，このハンドルはすぐに Windows によって割り当てを解除され，使えなくなります。したがって，このハンドルのデータを長期間必要とする場合は，他のハンドルにコピーする必要があります。

使用できる形式については，Windows API ヘルプファイルを参照してください。


TClipboard.GetComponent
TClipboard.GetComponent3054013

TClipboard	参照

GetComponent メソッドは，クリップボードからコンポーネントを取り出し，それを Owner パラメータおよび Parent パラメータの値に従って配置します。

function GetComponent(Owner, Parent: TComponent): TComponent;

説明

GetComponent メソッドを呼び出すと，Owner パラメータに取り出すコンポーネントのオーナーとなるコンポーネント（通常はフォーム）を指定して，コンポーネントオブジェクトをクリップボードに取り出すことができます。Parent パラメータには，コンポーネントの親になるコンポーネントを指定します。Owner と Parent のどちらにも nil 値を指定できます。

クラスをクリップボードから読み出せるようにするには，まず RegisterClasses を呼び出して Classes ユニットを登録しなければなりません。登録されていないクラスを読み出そうとすると EClassNotFound 例外が発生します。


TClipboard.GetTextBuf
TClipboard.GetTextBuf3054014

TClipboard	参照

GetTextBuf メソッドは，コントロールのテキストを取り出し，バッファにコピーます。

function GetTextBuf(Buffer: PChar; BufSize: Integer): Integer;

説明

GetTextBuf メソッドを呼び出すと，コントロールからテキストを取り出し，Buffer が指すバッファにコピーできます。GetTextBuf は最大で BufSize で指定するバイト数分コピーし，コピーしたバイト数を返します。

バッファに返されるテキストはヌルで終わる文字列です。

テキスト全体を入れるのに必要なバッファの文字数を調べるには，GetTextLen メソッドを呼び出してから GetTextBuf メソッドを呼び出します。


TClipboard.HasFormat
TClipboard.HasFormat3054015

TClipboard

HasFormat メソッドは，指定した特定の形式がクリップボードに含まれているかどうかを示します。

procedure HasFormat(Format: Word): Boolean;

説明

HasFormat メソッドを呼び出すと，指定した形式がクリップボードにあるかどうかを調べることができます。HasFormat が True なら指定した形式が存在し，False なら存在しません。クリップボードオブジェクトは，使える形式のリストを Formats 配列プロパティに保持しています。

Format パラメータには以下の値を指定できます。これ以外にも Windows が提供するクリップボード形式は多数あり，カスタマイズした形式も登録できます。そのすべての形式を HasFormat はサポートします。

値	意味

CF_TEXT	各行が CR＋LF で終わるテキスト。ヌル文字はテキストの終わりを示す

CF_BITMAP	Windows ビットマップグラフィック

CF_METAFILEPICT	Windows メタファイルグラフィック

CF_PICTURE	TPicture 型のオブジェクト

CF_OBJECT	永続的なオブジェクト


TClipboard.Open
TClipboard.Open3054016

TClipboard	参照

Open メソッドは，クリップボードを開き，クリップボードを閉じるまでその内容を他のアプリケーションに変更させないようにします。

procedure Open;

説明

1 つの項目しかクリップボードに追加しないときは，Open メソッドを呼び出す必要はありません。項目を続けて追加するときは，Open メソッドを呼び出して，それぞれ追加した内容が他のアプリケーションによって上書きされることがないようにします。

複数の項目を追加するには，Open メソッドを使って，追加した内容が他のアプリケーションによって上書きされたり，変更されたりすることがないようにします。

追加したい項目をすべてクリップボードに追加したら，Close メソッドを呼ばなければなりません。


TClipboard.SetAsHandle
TClipboard.SetAsHandle3054017

TClipboard

SetAsHandle メソッドは，データを指定の Windows ハンドルの形式にします。

procedure SetAsHandle (Format: Word; Value: THandle);

説明

SetAsHandle メソッドを呼び出すと，Windows ハンドルを使ってクリップボードに他の形式を追加できます。SetAsHandle はハンドルを指定した形式でクリップボードに配置します。

クリップボードにハンドルを与えた後は，そのハンドル Value を削除してはいけません。クリップボードがハンドルを削除します。

注意

Format パラメータに指定できる形式の詳細については，Windows API ヘルプファイルを参照してください。


TClipboard.SetComponent
TClipboard.SetComponent3054018

TClipboard	参照

SetComponent メソッドは，コンポーネントをクリップボードにコピーします。

procedure SetComponent(Component: TComponent);

説明

SetComponent メソッドを呼び出すと，コンポーネントオブジェクトをクリップボードに追加したり，クリップボードから取り出したりすることができます。Component パラメータにはコピーしたいコンポーネントを指定します。


TClipboard.SetTextBuf
TClipboard.SetTextBuf3054019

TClipboard	参照

SetTextBuf メソッドは，コントロールのテキストを Buffer が指すバッファ内のテキストにします。

procedure SetTextBuf(Buffer: PChar);

説明

SetTextBuf メソッドを呼び出すと，テキストをコントロールからバッファにコピーできます。Buffer パラメータが指すのはヌルで終わる文字列でなければなりません。


読み出し／書き込み3054020

読み出し専用


継承3054021

TObject

TPersistent


TClipboard 例3054022

TClipboard


TClientWinSocket
TClientWinSocket3055001

継承	プロパティ	メソッド	イベント	参照

TClientWinSocket オブジェクトは Windows ソケット接続のクライアントエンドポイントを示します。

ユニット

scktcomp

説明

TClientWinSocket は，TCP/IP クライアントアプリケーションの Windows ソケット API 呼び出しを管理するために，クライアントソケットコンポーネントによって使用されます。TClientWinSocket は，ブロッキングクライアントソケットと非ブロッキングクライアントソケットとを区別する ClientType プロパティを導入するという点でのみ，直接の上位オブジェクトである TCustomWinSocket と異なります。


TClientWinSocket プロパティ3055002

TClientWinSocket	アルファベット順	凡例

TClientWinSocket

ClientType

TCustomWinSocket からの継承

Addr

ASyncStyles

Connected

Data

Handle

LocalAddress

LocalHost

LocalPort

RemoteAddr

RemoteAddress

RemoteHost

RemotePort

SocketHandle


TClientWinSocket プロパティ3055003

TClientWinSocket	オブジェクト順	凡例

Addr

ASyncStyles

ClientType

Connected

Data

Handle

LocalAddress

LocalHost

LocalPort

RemoteAddr

RemoteAddress

RemoteHost

RemotePort

SocketHandle


TClientWinSocket.ClientType
TClientWinSocket.ClientType3055004

TClientWinSocket	参照

ClientType プロパティは，クライアント Windows ソケットがソケット接続で非同期的に情報を読み書きするかどうかを指定します。

TClientType = (ctNonBlocking, ctBlocking);

property ClientType: TClientType;

説明

ClientType プロパティを ctNonBlocking に設定すると，クライアント Windows ソケットは非同期的な読み出しおよび書き込みイベントに応答できるようになります。ClientType が ctNonBlocking ならば，実行がソケット接続での読み書きによってブロックされることはありません。OnSocketEvent イベントは，ソケットが接続で読み書きを行うことが必要になったときに発生します。

ClientType プロパティを ctBlocking に設定すると，すべての読み書きが同期的に行われるようにすることができます。ClientType が ctBlocking の場合は，すべての読み書きを 1 つの独立したスレッドで実行するとよいでしょう。独立したスレッドで読み書きを行えば，これらの処理がクライアントアプリケーション内のすべての実行をブロックしないことが保証されます。

ClientType プロパティが ctBlocking のときは，読み書きに TWinSocketStream オブジェクトを使います。TWinSocketStream は，読み書き中に問題が生じた場合に，アプリケーションの応答がなくなるのを防ぐためにタイムアウトします。また，TWinSocketStream は，読み出しを行う前に，ソケット接続が情報を送信できるようになるまで待つメソッドを提供します。

読み書きをサーバーソケットと同期させる必要があるときは，非ブロッキングソケットを使います。


TClientWinSocket イベント3055005

TClientWinSocket	アルファベット順

TCustomWinSocket からの継承

OnErrorEvent

OnSocketEvent


TClientWinSocket イベント3055006

TClientWinSocket	オブジェクト順

OnErrorEvent

OnSocketEvent


TClientWinSocket メソッド3055007

TClientWinSocket	アルファベット順

TCustomWinSocket からの継承

Close

Create

Destroy

Lock

LookupName

LookupService

ReceiveBuf

ReceiveLength

ReceiveText

SendBuf

SendStream

SendStreamThenDrop

SendText

Unlock

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TClientWinSocket メソッド3055008

TClientWinSocket	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Close

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

Lock

LookupName

LookupService

MethodAddress

MethodName

NewInstance

ReceiveBuf

ReceiveLength

ReceiveText

SafeCallException

SendBuf

SendStream

SendStreamThenDrop

SendText

Unlock


読み出し／書き込み3055009

読み出し専用


継承3055010

TObject

TCustomWinSocket


TClientWinSocket 例3055011

TClientWinSocket


TComponent
TComponent3056001

継承	プロパティ	メソッド	参照

TComponent は，Delphi のすべてのコンポーネントオブジェクトに共通する上位オブジェクトです。

ユニット

classes

説明

TComponent は，以下に示す機能を提供するメソッドやプロパティを導入して，Delphi のすべてのコンポーネントに共通する基本動作をカプセル化します。

・	コンポーネントを Component パレットに表示したり，フォームデザイナーで操作する機能

・	ほかのコンポーネントを所有したり管理する機能

・	強化されたストリーミングおよびファイル保存機能

・	ActiveX コントロールやインターフェースを実現するほかのオブジェクトのラッパーとしてコンポーネントを使う機能

TComponent のインスタンスは作成しないでください。TComponent は，コンポーネントパレットに表示したりフォームデザイナーで利用したりする非ビジュアルコンポーネントを宣言するときの基本クラスとして使います。TComponent のプロパティとメソッドは，下位のクラスが継承する基本動作や，コンポーネントがその動作をカズタマイズするためにオーバーライドできる動作を提供します。

ビジュアルコンポーネントを作成するには，TControl またはその下位オブジェクトを基本クラスとして使います。ビジュアルなウィンドウコントロールを作成するには，TWinControl またはその下位オブジェクトを基本クラスとして使います。


TComponent プロパティ3056002

TComponent	アルファベット順	凡例

TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TComponent プロパティ3056003

TComponent	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TComponent.ComObject
TComponent.ComObject3056004

TComponent	参照

ComObject プロパティは，COM をサポートしているコンポーネントが実現するインターフェース参照を返します。

property ComObject: IUnknown;

説明

ComObject を使うと，コンポーネントが実現するインターフェースをインターフェース参照に割り当てることができます。このプロパティは COM インターフェースをサポートしている VCL コンポーネントが使います。コンポーネントが COM コンポーネントのラッパーでない場合，ComObject は EComponentError 例外を生成します。


TComponent.ComponentCount
TComponent.ComponentCount3056005

TComponent	参照

ComponentCount プロパティは，コンポーネントが所有するコンポーネントの数を示します。所有コンポーネントは Components 配列プロパティで一覧表示されます。

property ComponentCount: Integer;

説明

ComponentCount を使うと，コンポーネントが所有するコンポーネントの数を確認したり，Components リストを繰り返し処理してすべての所有コンポーネントにいくつかのアクションを実行したりできます。Delphi の内部では，こうした反復手続きを処理するために ComponentCount が使われます。

注意

コンポーネントの ComponentCount には，そのコンポーネントの Components リストにあるだけの項目数があります。Components の最初のインデックス値は常に 0 なので，ComponentCount の値は Components の最大のインデックス値より必ず 1 大きくなります。


TComponent.ComponentIndex
TComponent.ComponentIndex3056006

TComponent	参照

ComponentIndex プロパティは，オーナーの Components 配列プロパティリストにおけるコンポーネントの位置を示します。

property ComponentIndex: Integer;

説明

ComponentIndex プロパティを使うと，Components リストを繰り返し処理して所有コンポーネントにいくつかのアクションを実行できます。ComponentIndex は ComponentCount と併用すると便利です。Delphi の内部では，割り当て手続きの反復を処理するために ComponentIndex が使われます。

注意

リスト内のコンポーネントの ComponentIndex 値は，最初のコンポーネントが 0 ，2 番目のコンポーネントが 1 という具合に増えていきます。そのため ComponentIndex を ComponentCount と併用するときは，ComponentCount の値が Components の最大のインデックス値より必ず 1 大きくなることに注意してください。


TComponent.Components
TComponent.Components3056007

TComponent	参照

Components プロパティは，コンポーネントが所有するすべてのコンポーネントのリストです。

property Components[Index: Integer]: TComponent;

説明

Components プロパティを使うと，任意の所有コンポーネント（フォームが所有するコントロールなど）にアクセスできます。Components プロパティは，名前でなく番号で所有コンポーネントを参照しなければならない場合に特に便利です。Components は，Delphi の内部ですべての所有コンポーネントを繰り返し処理する場合にも使われます。

注意

反復処理を行うときは，Components を ComponentCount と併用すると便利です。ただし，コンポーネントの ComponentCount に，そのコンポーネントの Components リストにあるだけの項目数がある場合は，Components の最初のインデックス値は常に 0 なので，ComponentCount の値が Components の最大のインデックス値より必ず 1 大きくなることに注意してください。


TComponent.ComponentState
TComponent.ComponentState3056008

TComponent	参照

ComponentState プロパティは，コンポーネントの現在の状態を示し，コンポーネントがどのような場合に特定のアクションを回避する必要があるかを指定します。

type TComponentState = set of (csLoading, csReading, csWriting, csDestroying, csDesigning, csAncestor, csUpdating, csFixups);

property ComponentState: TComponentState;

説明

Components プロパティは ComponentState プロパティを使って，コンポーネントの状態によって特定のアクションが許可されているどうかを検知します。たとえば，コンポーネントが実行時に行う特定の動作を設計時に回避する必要がある場合は csDesigning フラグを調べます。ComponentState は読み出し専用であり，そのフラグはさまざまなメソッドで目的に応じて自動的に設定されます。

TComponentState 型は，ComponentState プロパティに使用できる状態フラグ群を定義します。以下の表に，TComponentState 型で指定できるフラグとその意味を示します。

フラグ	コンポーネントの状態

csAncestor	コンポーネントが上位フォームに導入されている場合に設定する。csDesigning も設定されている場合のみ設定する

csDesigning	設計モード。フォームデザイナーによって操作されるフォーム内に存在することを意味する

csDestroying	コンポーネントは破棄される

csFixups	コンポーネントが，まだロードされていない別のフォームのコンポーネントにリンクされている場合に設定する。このフラグは，すべての未解決の問題が解決したときにクリアされる

csLoading	ファイラオブジェクトから読み込み中

csReading	コンポーネントのプロパティ値をストリームから読み込み中

csUpdating	上位フォーム内での変更をコンポーネントに反映中。csAncestor も設定されている場合のみ設定する

csWriting	コントロールのプロパティ値をストリームに書き込み中


TComponent.ComponentStyle
TComponent.ComponentStyle3056009

TComponent

ComponentStyle プロパティは，コンポーネントの動作を支配するスタイルのフラグを設定します。

type TComponentStyle = set of (csInheritable, csCheckPropAvail);

property ComponentStyle: TComponentStyle;

説明

ComponentStyle プロパティは，コンポーネント（およびそれを含むフォーム）が継承できるかどうか，そしてコンポーネントのプロパティの可読性を調べる必要があるかどうかを指定します。

TComponentStyle 型は，ComponentStyle プロパティの一連の値を定義します。TComponent は，csInheritable スタイルをデフォルトでコンストラクタ内に設定して，ほとんどの標準コンポーネントを継承できるようにします。

csInheritable スタイルは，コンポーネントが下位のフォーム型によって継承できることを示します。フォーム内のコンポーネントが csInheritable スタイルを持っていない場合，そのフォームを継承されたフォームの上位フォームとして使うことはできません。

csCheckPropAvail スタイルは，コンポーネントがプロパティの可読性を調べる必要があることを示します。このスタイルは，OLE コントロールのプロパティの読み出しおよび表示が可能であるかどうかをオブジェクトインスぺクタが直接判断できない場合にのみ使います。ネイティブの Delphi コンポーネントはこのスタイルを使いません。


TComponent.DesignInfo
TComponent.DesignInfo3056010

TComponent	参照

DesignInfo プロパティは，フォームデザイナーが使う情報を提供します。

property DesignInfo: Longint;

説明

DesignInfo は Delphi が内部の環境で使うので，アプリケーションではこのプロパティを使わないでください。


TComponent.Name
TComponent.Name3056011

TComponent	参照

Name プロパティは，他のコンポーネントが参照するコンポーネントの名前を示します。

type TComponentName: string;

property Name: TComponentName;

説明

Name プロパティを使うと，現在のアプリケーションの目的に合わせてコンポーネントの名前を変更できます。デフォルトでは，Delphi がコンポーネントの型に基づいて一連の名前（「Button1」，「Button2」など）を割り当てます。


TComponent.Owner
TComponent.Owner3056012

TComponent	参照

Owner プロパティは，コンポーネントを所有しているコンポーネントを示します。

property Owner: TComponent;

説明

Owner プロパティを使うと，コンポーネントのオーナーを確認できます。1 つのコンポーネントが他のコンポーネントに所有されている場合は，オーナーのメモリが解放されたときに所有コンポーネントのメモリが解放されます。したがって，フォームが破棄されると，そのフォーム上のすべてのコンポーネントも破棄されます。

Delphi では，フォームは自身の上にあるすべてのコンポーネントを所有し，フォームはアプリケーションに所有されます。したがって，アプリケーション自体のメモリが解放されると，フォーム（およびすべての所有コンポーネント）用のメモリも解放されます。

コンポーネントのオーナーは，コンポーネントの構築時に Create メソッドに渡されるパラメータによって定義されます。Delphi のフォームデザイナーでコンポーネントを作成すると，オーナーは自動的にコンストラクタに渡されます。


TComponent.Tag
TComponent.Tag3056013

TComponent

Tag プロパティは，整数値をコンポーネントの一部として格納します。

property Tag: Longint;

説明

Tag は，Delphi にとってあらかじめ定義された意味のあるプロパティではありません。Tag プロパティは，アプリケーションの特殊な用途に応じて追加の整数値やポインタ情報を格納するのに役立ちます。たとえば，コンポーネントで case 文を実現するときは Tag プロパティを使います。


TComponent.VCLComObject
TComponent.VCLComObject3056014

TComponent	参照

VCLComObject プロパティは，COM をサポートしているコンポーネントに対して Delphie が内部的に使用します。

property VCLComObject: Pointer;

説明

VCLComOnject は内部でのみ使われます。VCL COM コンポーネントが実現するインターフェースにアクセスするには，ComObject プロパティを使います。


TComponent メソッド3056015

TComponent	アルファベット順	凡例

TComponent

ChangeName

Create

DefineProperties

Destroy

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetChildOwner

GetChildParent

GetChildren

GetIDsOfNames

GetNamePath

GetOwner

GetParentComponent

GetTypeInfo

GetTypeInfoCount

HasParent

InsertComponent

Invoke

Loaded

Notification

QueryInterface

ReadState

RemoveComponent

SafeCallException

SetAncestor

SetChildOrder

SetDesigning

SetName

SetParentComponent

Updated

UpdateRegistry

Updating

ValidateContainer

ValidateInsert

ValidateRename

WriteState

_AddRef

_Release

TPersistent からの継承

Assign

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TComponent メソッド3056016

TComponent	オブジェクト順	凡例

Assign

ChangeName

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

DefineProperties

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetChildOwner

GetChildParent

GetChildren

GetIDsOfNames

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetOwner

GetParentComponent

GetTypeInfo

GetTypeInfoCount

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Invoke

Loaded

MethodAddress

MethodName

NewInstance

Notification

QueryInterface

ReadState

RemoveComponent

SafeCallException

SetAncestor

SetChildOrder

SetDesigning

SetName

SetParentComponent

Updated

UpdateRegistry

Updating

ValidateContainer

ValidateInsert

ValidateRename

WriteState

_AddRef

_Release


TComponent.ChangeName
TComponent.ChangeName3056017

TComponent	参照

ChangeName メソッドは，NewName メソッドで渡された文字列に対する Name プロパティを格納するプライベートな内部記憶を設定します。

type TComponentName: string;

procedure ChangeName(const NewName: TComponentName);

説明

ChangeName メソッドは，SetName メソッドが実際にコンポーネントの名前を変更するために使います。ChangeName は仮想プロパティではないので，オーバーライドしないでください。SetName をオーバーラードするときは，必ず継承された SetName を呼び出してください。


TComponent.Create
TComponent.Create3056018

TComponent	参照

Create メソッドは，十分なメモリを自動的に割り当てて，コンポーネントのインスタンスを構築して安全に初期化します。

constructor Create(AOwner: TComponent);

説明

Delphi のすべてのオブジェクトには，オブジェクトを構築する Create メソッドがあります。TComponent は Create を再定義するので，Create はコンポーネントについて以下の処理も行います。

・	コンポーネントとその Owner（AOwner パラメータで指定）との関係を構築する

・	ComponentStyle プロパティを csInheritable に設定して，下位のフォーム型がコンポーネントを継承できるようにする

通常，Delphi のフォームデザイナーで作成したコンポーネントでは Create を手動で呼び出す必要はありません。これらのコンポーネントは，アプリケーションを起動すると自動的に作成され，アプリケーションを終了すると破棄されます。

手動で作成したコンポーネントは，フォームデザイナーで作成したものではないため，Create を呼び出してオーナーのコンポーネントを AOwner パラメータに渡します。オーナーを破棄するとコンポーネントは破棄されます。コンポーネントが所有されていないときは，Free を呼び出してそのコンポーネントを破棄できます。

注意

AOwner パラメータに Self を渡すときは，Self の参照先に注意してください。コンポーネントがその 1 つのメソッドの中に他のコンポーネントを作成する場合，Self は最初のコンポーネントを参照します。最初のコンポーネントで所有される作成済みコンポーネントは参照されません。

注意

TComponent.Create は，クラス参照の多様なインスタンス化を可能にするという意味で仮想メソッドといえます。これはストリーミングシステムやフォームデザイナーにとっては重要です。新しいコンポーネントの Create コンストラクタを宣言するときは，オーバーライドの疑似命令を使うことを忘れないでください。


TComponent.DefineProperties
TComponent.DefineProperties3056019

TComponent	参照

DefineProperties メソッドは，オブジェクトの非 published データをフォームファイルなどのストリームに格納するためのメソッドを指定します。

procedure DefineProperties(Filer: TFiler); override;

説明

TComponent は，TPersistent に定義されている DefineProperties メソッドをオーバーライドして，「擬似的な」Top および Left プロパティを定義します。これらのプロパティを定義すると，設計時に非ビジュアルコンポーネントを操作できるようになります。しかし，非ビジュアルコンポーネントは実行時には表示されないため，Top および Left プロパティは隠されてパブリッシュにはなりません。

DefineProperties は仮想メソッドであるため，派生したクラスでオーバーライドできます。DefineProperties メソッドを記述またはオーバーライドするときは，TFiler の Ancestor プロパティが設定され，状況に応じてプロパティを記述しなくてはならない場合があることに注意してください。

DefineProperties はストリーミングシステムの一部として自動的に呼び出されるため，直接呼び出さないでください。


TComponent.Destroy
TComponent.Destroy3056020

TComponent	参照

Destroy メソッドはコンポーネントとその所有コンポーネントを破棄します。

destructor Destroy; override;

説明

TComponent メソッドは Destroy をオーバーライドして，メソッドが実行されるコンポーネントとそのすべての所有コンポーネントを破棄します。

注意

Destroy メソッドは直接呼び出さないでください。かわりに Free メソッドを呼び出します。

あるコンポーネントで Free を呼び出すと，そのコンポーネントリスト内のすべての所有コンポーネントで Free が呼び出されます。フォームは，自身の上に設計モードで作成されたすべてのコントロールと非ビジュアルコンポーネントを所有します。フォームを解放すると，同時にすべての所有コンポーネントが自動的に解放されます。デフォルトでは，すべてのフォームは Application オブジェクトで所有されるため，アプリケーションが終了すると，Application オブジェクトが解放されてすべてのフォームが解放されます。コンポーネントではないすべてのオブジェクトや，nil オーナーによって作成されたコンポーネントでは，オブジェクトを終了した後に必ず Free を呼び出してください。Free を呼び出さないと，そのオブジェクトに割り当てられていたメモリが失われてアプリケーションが終了します。

コンポーネント自体のイベントハンドラ内でそのコンポーネントを明示的に解放したり，コンポーネントが所有または包含するコンポーネントのイベントハンドラからコンポーネントを解放することはできません。

フォームを解放するには Release メソッドを呼び出します。Release は，フォームのすべてのイベントハンドラおよびフォームが所有するコンポーネントのイベントハンドラの処理が終了した後に，フォームを破棄して割り当てられていたメモリを解放します。


TComponent.DestroyComponents
TComponent.DestroyComponents3056021

TComponent	参照

DestroyComponents メソッドは，コンポーネントが所有するコンポーネントを繰り返し処理し，所有コンポーネントのリストから各コンポーネントを削除して破棄します。

procedure DestroyComponents;

説明

DestroyComponents メソッドは，所有コンポーネントがオーナーによって自動的に削除されるようにします。

DestroyComponents を直接呼び出す必要はありません。DestroyComponents は，デストラクタシーケンス内の Destroy から自動的に呼び出されます。Destroy は Free を呼び出すと処理を開始して，オブジェクトがそのオブジェクト自体を破棄すると終了します。


TComponent.Destroying
TComponent.Destroying3056022

TComponent	参照

Destroying メソッドは，コンポーネントおよびそのすべての所有コンポーネントに csDestroying フラグを設定して，コンポーネントが破棄されることを示します。

procedure Destroying;

説明

Destroying メソッドは ComponentState プロパティに csDestroying フラグを設定してから，各所有コンポーネントに対して Destroying メソッドを呼び出して，これらのコンポーネントにも csDestroying フラグを設定します。csDestroying がすでに設定されている場合，Destroying を呼び出しても無視されます。

Destroying を直接呼び出す必要はありません。Destroying は，デストラクタシーケンスで Destroy から自動的に呼び出されます。Destroy は Free を呼び出すと処理を開始して，オブジェクトがそのオブジェクト自体を破棄すると終了します。


TComponent.FindComponent
TComponent.FindComponent3056023

TComponent	参照

FindComponent メソッドは，AName で指定されたコンポーネントが他のコンポーネントで所有されているかどうかを示します。

function FindComponent(const AName: string): TComponent;

説明

FindComponent メソッドは，AName パラメータで指定する名前を持つコンポーネントを Components 配列プロパティに返します。FindComponent メソッドを使うと，指定されたコンポーネントが他のコンポーネントで所有されているかどうかを確認できます。

FindComponent は大文字と小文字を区別しません。


TComponent.FreeNotification
TComponent.FreeNotification3056024

TComponent	参照

FreeNotification メソッドは，コンポーネントが破棄されることを AComponent に通知します。

procedure FreeNotification(AComponent: TComponent);

説明

FreeNotification メソッドは，コンポーネントが他のコンポーネントのプロパティに割り当てられているときに使います。

FreeNotification は，そのコンポーネントを参照する他のフォームのコンポーネントに対して呼び出すことが必要です。コンポーネントと同じフォームのコンポーネントがない場合は，Notification メソッドが自動的に呼び出されます。


TComponent.FreeOnRelease
TComponent.FreeOnRelease3056025

TComponent

FreeOnRelease メソッドは，COM クラスから作成されたコンポーネントのインターフェース参照を解放します。

procedure FreeOnRelease;

説明

FreeOnRelease は，コンポーネントが実現しているインターフェースが解放されるときに呼び出されます。FreeOnRelease は内部的に使われるメソッドで，対応するインターフェースメソッドを呼び出します。FreeOnRealse を直接呼び出す必要はありません。


TComponent.GetChildOwner
TComponent.GetChildOwner3056026

TComponent	参照

GetChildOwner メソッドは，ストリームから読み出される子コンポーネントのオーナーを返します。

function GetChildOwner: TComponent; dynamic;

説明

TComponent では，GetChildOwner はデフォルトで nil を返し，オーナーは現在読み出されているルートコンポーネント（通常はフォーム）とみなされます。コンポーネントのオーナーは，そのコンポーネントを破棄しなければなりません。

GetChildOwner は Delphi のストリーミングシステムが内部で使います。GetChildOwner を直接呼び出す必要はほとんどありません。


TComponent.GetChildParent
TComponent.GetChildParent3056027

TComponent	参照

GetChildParent メソッドは，親を返すか親がない場合は，ストリームから読み出される子コンポーネントのオーナーを返します。

function GetChildParent: TComponent; dynamic;

説明

デフォルトでは，TComponent の GetChildParent メソッドは Self を返します。GetChildParent が nil を返した場合，その親は現在読み出されているルートコンポーネント（通常はフォーム）とみなされます。

GetChildParent は Delphi のストリーミングシステムが内部で使います。GetChildParent を直接呼び出す必要はありません。


TComponent.GetChildren
TComponent.GetChildren3056028

TComponent	参照

GetChildren メソッドは，ウィンドウコントロールがその子コンポーネントを返すために使うメソッドへのインターフェースを提供しますが，それ以外の処理は行いません。

procedure GetChildren(Proc: TGetChildProc; Root: TComponent); dynamic;

説明

GetChildren メソッドは，Delphi のストリーミングシステムで利用するために TComponent に実装されています。派生クラスは GetChildren をオーバーライドしてコンポーネントの「子」のコンポーネントを返します。子コンポーネントは GetParentComponent メソッドからコンポーネントを返します。


TComponent.GetIDsOfNames
TComponent.GetIDsOfNames3056029

TComponent	参照

GetIDsOfNames メソッドは，1 つのメンバーおよびオプションの引数名のセットを，対応する整数ディスパッチ識別子（dispID）のセットに割り当てます。マップ後の各パラメータは，後続の Invoke メソッドの呼び出しに使われます。

function GetIDsOfNames(const IID: TGUID; Names: Pointer; NameCount, LocaleID: Integer; DisplDs: Pointer): Interger; stdcall;

説明

GetIDsOfNames は，IDispatch インターフェースである GetIDsOfNames メソッドを実現したものです。インターフェースをサポートするコンポーネントの場合，GetIDsOfNames は，コンポーネントがサポートするインターフェース用に実現した GetIDsOfNames メソッドを呼び出し，指定されたパラメータを渡します。


TComponent.GetNamePath
TComponent.GetNamePath3056030

TComponent	参照

GetNamePath メソッドは Object Inspector が使う文字列を返します。

function GetNamePath: string; override;

説明

GetNamePath は内部でのみ使われるメソッドです。このメソッドは，編集中のオブジェクトの名前として Object Inspector に表示するテキストを決定するのに使われます。GetNamePath を TPersistent に導入すると，Object Inspector にコレクションなどの派生オブジェクトを表示できます。TComponent は GetNamePath をオーバーライドしてコンポーネントの名前を返します。GetNamePath は直接呼び出さないでください。


TComponent.GetOwner
TComponent.GetOwner3056031

TComponent	参照

GetOwner メソッドはコンポーネントのオーナーを返します。

function GetOwner: TPersistent; override;

説明

GetOwner は，GetNamePath メソッドがコンポーネントのオーナーを見つけるために使います。GetNamePath と GetOwner を TPersistent に導入すると，Object Inspector にコレクションなどの下位オブジェクトを表示できます。TComponent の GetOwner は Owner プロパティの値を返します。


TComponent.GetParentComponent
TComponent.GetParentComponent3056032

TComponent	参照

GetParentComponent メソッドは，TComponent に対して nil を返します。

function GetParentComponent: TComponent; dynamic;

説明

GetParentComponent メソッドは，Delphi のストリーミングシステムで利用するために TComponent に実装されています。下位クラスは GetParentComponent をオーバーライドして，特定の型のコンポーネントの適切な親を返すことができます。


TComponent.GetTypeInfo
TComponent.GetTypeInfo3056033

TComponent	参照

GetTypeInfo メソッドは，オブジェクトの型情報を取り出します。この情報は，コンポーネントが実現するインターフェースの型情報を取得するのに使うことができます。

function GetTypeInfo(Index, LocaleID: Integer; out TypeInfo): Interger; stdcall;

説明

GetTypeInfo は，IDispatch インターフェースである GetTypeInfo メソッドを実現したものです。インターフェースをサポートするコンポーネントの場合，GetTypeInfo は，コンポーネントがサポートするインターフェース用に実現した GetTypeInfo メソッドを呼び出し，指定されたパラメータを渡します。


TComponent.GetTypeInfoCount
TComponent.GetTypeInfoCount3056034

TComponent	参照

GetTypeInfoCount メソッドは，オブジェクトが提供する型情報インターフェースの数（0 または 1）を取り出します。

function GetTypeInfoCount(out Count: Integer): Integer; stdcall;

説明

GetTypeInfoCount は，IDispatch インターフェースである GetTypeInfoCount メソッドを実現したものです。インターフェースをサポートするコンポーネントの場合，GetTypeInfoCount は，コンポーネントがサポートするインターフェース用に実現した GetTypeInfoCount メソッドを呼び出します。out パラメータは，オブジェクトが提供する型情報インターフェース数を受け取る場所を指します。オブジェクトが型情報を提供する場合，この数は 1 です。それ以外の場合は 0 になります。


TComponent.HasParent
TComponent.HasParent3056035

TComponent	参照

HasParent メソッドは，TComponent に対して False を返します。

function HasParent: Boolean; dynamic;

説明

HasParent メソッドは，ストリーミングシステム用に TComponent に実装され，コンポーネントがファイルへの書き込みを処理する親コンポーネントを持っているかどうかを指定します。

戻り値が True の場合は，他のいくつかのオブジェクト（親）がストリームにオブジェクトを書き込む必要があることを示します。たいていの場合，他の親オブジェクトはコントロールを持つフォームやパネルコンポーネントです。

HasParent をオーバーライドする必要はほとんどありません。HasParent で True を返すすべての子コンポーネントは，同時に GetParentComponent および SetParentComponent メソッドを実装する必要があります。


TComponent.InsertComponent
TComponent.InsertComponent3056036

TComponent	参照

InsertComponent メソッドは，コンポーネントを AComponent パラメータで指定するコンポーネントのオーナーにします。

procedure InsertComponent(AComponent: TComponent);

説明

InsertComponet メソッドは，コンポーネントを Components 配列プロパティの最後に追加します。挿入したコンポーネントに名前を付けてはいけません（Name プロパティに値を指定してはいけません）。名前を付ける場合は Components リストのそれ以外のすべてのコンポーネントと重複しない名前を付ける必要があります。

オーナーのコンポーネントを破棄すると，AComponent も破棄されます。

Delphi のフォームデザイナーでコンポーネントを視覚的に操作すると，コンポーネントが自動的に挿入または削除されます。InsertComponent は，コンポーネントを別の Owner のコンポーネントの Components リストに手動で追加するときに使います。


TComponent.Invoke
TComponent.Invoke3056037

TComponent	参照

Invoke メソッドは，IDispatch インターフェースをサポートするオブジェクトによって提供された OLE オートメーションのプロパティおよびメソッドへのアクセスを可能にします。

function Invoke(DispID: Interger; const IID: TGUID; LocaleID: Integer; Flags: Word; var Params; VarResult, ExcepInfo, ArgErr: Pointer): Integer; stdcall;

説明

Invoke は，IDispatch インターフェースである Invoke メソッドを実現したものです。Invoke は，OLE Automation オブジェクトのプロパティやメソッドにアクセスするための標準のメカニズムです。インターフェースをサポートするコンポーネントの場合，Invoke はコンポーネントがサポートするインターフェース用に実現した Invoke メソッドを呼び出し，関数が指定するパラメータを渡します。


TComponent.Loaded
TComponent.Loaded3056038

TComponent	参照

Loaded メソッドは，コンポーネントがストリームからロードされたことを示す ComponentState プロパティの csLoading フラグをクリアします。

procedure Loaded; virtual;

説明

Loaded メソッドは，コンポーネント全体がストリームからロードされた後に，コンポーネントが自身を初期化することを可能にします。

たとえば，Delphi アプリケーションがフォームファイルからフォームをロードする場合には，最初にフォームの Create コンストラクタを呼び出してフォームを構築し，そのフォームのプロパティ値をフォームファイル（ストリーム）から読み出します。各コンポーネントのプロパティ値をすべて読み出すと，Delphi は各コンポーネントの Loaded メソッドをコンポーネントが作成された順番に呼び出します。これにより，コンポーネントは他のコンポーネントやコンポーネント自体の他の部分の値に応じてデータを初期化できます。

注意

Loaded が呼び出されるまでに，兄弟コンポーネントへの参照はすべて解決されます。Loaded は，ストリームに書き込んだ兄弟ポインタを使用できる最初の位置を示します。


TComponent.Notification
TComponent.Notification3056039

TComponent	参照

Notification メソッドは，すべての所有コンポーネントにメッセージを通知します。

type TOperation = (opInsert, opRemove);

procedure Notification(AComponent: TComponent; Operation: TOperation); virtual;

説明

Notification メソッドは，AComponent で指定したコンポーネントが Operation の設定に従って挿入または削除されることをコンポーネントに知らせます。デフォルトでは，コンポーネントは所有コンポーネント（存在する場合）にメッセージを通知します。

コンポーネントは必要に応じて，コンポーネントの挿入または削除の通知に対して処理を行うことができます。特に，コンポーネントに他のコンポーネントへの参照を含むオブジェクトの項目やプロパティがある場合，そのコンポーネントはコンポーネントの削除の通知を調べ，必要に応じて参照を無効にできます。


TComponent.QueryInterface
TComponent.QueryInterface3056040

TComponent	参照

QueryInterface メソッドは，特定のインターフェースがオブジェクトにサポートされている場合， そのインターフェースへの参照を返します。

function QueryInterface(const IID: TGUID; out Obj): Integer; stdcall;

説明

インターフェースをサポートするコンポーネントの場合，QueryInterface は，コンポーネントがサポートするインターフェース用に実現した QueryInterface メソッドを呼び出します。QueryInterface は，IID パラメータが指定するインターフェースへの参照を out パラメータの値として返します。コンポーネントがインターフェースをサポートしていない場合，out パラメータは nil になります。


TComponent.ReadState
TComponent.ReadState3056041

TComponent	参照

ReadState メソッドは，ストリーミングシステムがコンポーネントのデータをストリームから読み出すために使います。

procedure ReadState(Reader: TReader); virtual;

説明

ReadState メソッドは，Reader で指定されたリーダーオブジェクトと対話して，コンポーネントがストリームから正しく読み出されるようにします。

ReadState メソッドは，Delphi のストリーミングシステムがコンポーネントのすべてのパブリッシュプロパティの値や他の格納済みデータをストリームから読み出すのに使う呼び出しシーケンスの一部です。ReadState を直接呼び出す必要はありません。

ReadState は仮想メソッドですが，オーバーライドされることはほとんどありません。しかしながら，ReadState をオーバーライドする派生クラスは TComponent の 継承 ReadState メソッドの呼び出しで終了しなければなりません。

ReadState は，コンポーネントのパブリッシュプロパティや格納済みデータ，および所有コンポーネントの各値を，Reader で指定されるリーダーオブジェクトから読み出します。


TComponent.RemoveComponent
TComponent.RemoveComponent3056042

TComponent	参照

RemoveComponent メソッドは，AComponent パラメータで指定したコンポーネントをコンポーネントの Components リストから削除します。

procedure RemoveComponent(AComponent: TComponent);

説明

Delphi のフォームデザイナーでコンポーネントを視覚的に操作すると，コンポーネントが自動的に挿入または削除されます。RemoveComponent は，Owner のコンポーネントから手動でコンポーネントを削除するときに使います。


TComponent.SafeCallException
TComponent.SafeCallException3056043

TComponent	参照

SafeCallException は，OLE 例外をサポートするのに使われるエラー処理メソッドです。

function SafeCallException(ExceptObject: TObject; ExceptAddr: Pointer): Integer; override;

説明

SafeCallException は OLE 例外処理をサポートするのに使われます。COM インターフェースや OLE インターフェースを実現するクラスは，このメソッドをオーバーライドして，ほかに発生する可能性のあるエラーを処理しなければなりません。Delphi では，COM クラスと OLE クラスが SafeCallException をオーバーライドします。コンポーネントがサポートするインターフェースがあれば，TComponent はそのインターフェース用に実現した SafeCallException メソッドを呼び出します。コンポーネントがインターフェースをサポートしていなければ，このメソッドは継承メソッドを呼び出し，継承メソッドが E_UNEXPECTED を返します。これは，どのインターフェースもサポートしていないクラスに割り当てられるデフォルトの戻り値です。


TComponent.SetAncestor
TComponent.SetAncestor3056044

TComponent	参照

SetAncestor メソッドは，メソッドが実行されるコンポーネントやそのすべての所有コンポーネントについて ComponentState プロパティの csAncestor フラグを設定したりクリアしたりします。

procedure SetAncestor(Value: Boolean);

説明

SetAncestor メソッドは，Delphi のストリーミングシステムが内部で使います。SetAncestor を直接呼び出す必要はありません。

SetAncestor メソッドは csAncestor フラグの設定やクリアを行います。csAncestor フラグは，コンポーネントが上位フォームに導入されたかどうかを判定します。その後，SetAncestor はすべての所有コンポーネントの SetAncestor メソッドを呼び出して Value を渡し，所有コンポーネントの ComponentState プロパティをオーナーのプロパティと同期させます。


TComponent.SetChildOrder
TComponent.SetChildOrder3056045

TComponent	参照

SetChildOrder メソッドは，TComponent では何も処理を行いません。

procedure SetChildOrder(Child: TComponent; Order: Integer); dynamic;

説明

SetChildOrder は ，Delphi のストリーミングシステムで利用するために TComponent に実装されています。派生クラスは SetChildOrder をオーバーライドして，GetChildren で返される子コンポーネントリスト内の子の表示順序を変更することができます。


TComponent.SetDesigning

TComponent	参照

SetDesigning メソッドは，設計時に挿入されるコンポーネントに設計モードのフラグを設定させます。

procedure SetDesigning(Value: Boolean);

説明

SetDesigning メソッドは，Delphi のフォームデザイナーが内部で使います。SetDesigning を直接呼び出す必要はありません。

SetDesigning メソッドは，Value が True の場合は ComponentState プロパティの csDesigning オプションを設定し，それ以外の場合は csDesigning を削除します。その後，SetDesigning はすべての所有コンポーネントの SetDesigning メソッドを呼び出して Value を渡し，所有コンポーネントの ComponentState プロパティをオーナーのプロパティと同期させます。

InsertComponent および RemoveComponent メソッドは，挿入または削除されたコンポーネントの SetDesigning を呼び出して，これらのコンポーネントの設計モードフラグを正しく設定します。


TComponent.SetName
TComponent.SetName3056047

TComponent	参照

SetName メソッドは，Name プロパティの値を設定するプロパティアクセスメソッドです。

procedure SetName(const NewName: TComponentName); virtual;

説明

SetName メソッドは，Name プロパティの書き込み部分として使う仮想メソッドです。SetName は，名前の変更を実際に行う ChangeName メソッドを呼び出します。ChangeName は仮想メソッドではありません。Name プロパティの動作を変更するときは，ChangeName のかわりに SetName をオーバーライドしてください。


TComponent.SetParentComponent
TComponent.SetParentComponent3056048

TComponent	参照

SetParentComponent メソッドは，TComponent では何も処理を行いません。

procedure SetParentComponent(Value: TComponent); dynamic;

説明

SetParentComponent は，Delphi のストリーミングシステムで利用するために TComponent に導入されました。派生クラスは SetParentComponent をオーバーライドして，GetParentComponent が返す値を Value と同じ値に変更します。


TComponent.Updated
TComponent.Updated3056049

TComponent	参照

Updated メソッドは，コンポーネントの ComponentState プロパティの csUpdating 状態をクリアして，コンポーネントの更新が終了したことを示します。

procedure Updated; dynamic;

説明

Updated メソッドは，Delphi が内部で ComponentState プロパティを変更するために使います。Updated を直接呼び出す必要はありません。Updating を呼び出してフラグを設定した後は，必ず Updated を呼び出します。


TComponent.UpdateRegistry
TComponent.UpdateRegistry3056050

TComponent

UpdateRegistry メソッドは，COM インターフェースを実現するコンポーネントに対して内部でのみ使われます。

class procedure UpdateRegistry(Register: Boolean; const ClassID, ProgID: string); dynamic;

説明

UpdateRegistry メソッドは内部でのみ使われます。このメソッドは直接呼び出さないでください。


TComponent.Updating
TComponent.Updating3056051

TComponent	参照

Updating メソッドは，コンポーネントの ComponentState プロパティの csUpdating 状態を設定して，コンポーネントの更新が行われることを示します。

procedure Updating; dynamic;

説明

Updated メソッドは，Delphi が内部で ComponentState プロパティを変更するために使います。Updating を直接呼び出す必要はありません。Updating を呼び出した後は，必ず Updated を呼び出してフラグをクリアします。


TComponent.ValidateContainer
TComponent.ValidateContainer3056052

TComponent	参照

ValidateContainer メソッドは，コンテナオブジェクトにオブジェクトを挿入できるかどうかを決定します。

procedure ValidateContainer(AComponent: TComponent); dynamic;

説明

ValidateContainer メソッドは，コンポーネントがコンテナオブジェクトに挿入されるときにコンポーネントによって呼び出されます。デフォルトでは，ValidateContainer を使うとどのオブジェクトもコンテナに挿入できます。派生コンポーネントは，コンポーネントが挿入されないように ValidateContainer をオーバーライドすることができます。


TComponent.ValidateInsert
TComponent.ValidateInsert3056053

TComponent	参照

ValidateInsert メソッドは，TComponent では処理を行いません。

procedure ValidateInsert(AComponent: TComponent); dynamic;

説明

ValidateInsert メソッドは TComponent に導入されますが，これは挿入しようとしているオブジェクトをコンポーネントが受け入れないように，派生クラスが ValidateInsert をオーバーライドできるようにするためです。デフォルトでは，ValidateInsert を使うとどのオブジェクトもコンポーネントに挿入できます。コンポーネントで特定のオブジェクトだけを有効にする必要がある場合，下位クラスは ValidateInsert をオーバーライドして対象のオブジェクトを抽出できます。


TComponent.ValidateRename
TComponent.ValidateRename3056054

TComponent	参照

ValidateRename メソッドは，所有コンポーネントの名前を重複しない名前に変更します。

procedure ValidateRename(AComponent: TComponent; const CurName, NewName: string); virtual;

説明

ValidateRename メソッドは，コンポーネントがその 1 つの所有コンポーネントの名前（AComponentで指定される）を，現在の名前（CurNameで指定される）から NewName で指定される文字列に変更できるかどうかを調べます。AComponent が nil の場合や，NewName がすでに Components リスト内のコンポーネントの名前である場合，ValidateRename は EComponentError 例外を生成します。

ValidateRename は，Delphi が Name プロパティの変更時に内部で使います。ValidateRename を直接呼び出す必要はありません。


TComponent.WriteState
TComponent.WriteState3056055

TComponent	参照

WriteState メソッドは，ストリーミングシステムがコンポーネントのデータをストリームに書き込むために使います。

procedure WriteState(Writer: TWriter); virtual;

説明

WriteState メソッドは対話型メソッドであり，Writer で指定される書き込みオブジェクトと対話して，コンポーネントを正しく書き出します。

WriteState メソッドは，Delphi のストリーミングシステムがコンポーネントのすべてのパブリッシュプロパティの値や他の格納済みデータをストリームへ書き出すのに使う呼び出しシーケンスの一部です。WriteState を直接呼び出す必要はありません。

WriteState は仮想メソッドですが，オーバーライドされることはほとんどありません。しかしながら，WriteState をオーバーライドする派生クラスは TComponent の 継承 WriteState メソッドの呼び出しで終了しなければなりません。


TComponent._AddRef
TComponent._AddRef3056056

TComponent	参照

_AddRef メソッドは，コンポーネントに依存するインターフェース参照のカウントをインクリメントします。

function AddRef: Integer; stdcall;

説明

_AddRef メソッドは，COM が定義する IUnknown インターフェースメソッド AddRef を実現したものです。インターフェースをサポートするコンポーネントの場合，_AddRef は，コンポーネントがサポートするインターフェース用に実装した _AddRef メソッドを呼び出します。_AddRef は，結果として得られたコンポーネントの参照カウントの値を返します。


TComponent._Release
TComponent._Release3056057

TComponent	参照

_Release メソッドは，オブジェクトを呼び出しているインターフェースの参照カウントをデクリメントします。

function Release: Integer; stdcall;

説明

_Release メソッドは，COM が定義する IUnknown インターフェースメソッド Release を実装したものです。インターフェースをサポートするコンポーネントの場合，_Release は，コンポーネントがサポートするインターフェース用に実装した _Release メソッドを呼び出します。オブジェクトの参照カウントが 0 になると，オブジェクトはメモリから解放されます。

_Release は，結果として得られたコンポーネントの参照カウントの値を返します。


スコープ3056058

published

読み出し／書き込み

読み出し専用


スコープ3056059

protected


継承3056060

TObject

TPersistent


TComponent 例3056061

TComponent


TContainedObject
TContainedObject3057001

継承	プロパティ	メソッド	参照

ユニット

axctrls

説明

TContainedObject は，IUnknown インターフェースを内部オブジェクトとして実装するクラスです。

TContainedObject は，集約可能な（内部または格納）オブジェクトに適用される規則に従って実現されます。TContainedObject 自体を，集約の内部（格納）オブジェクトを作成するためのクラスの基本として使うこともできます。TComObject またはその下位オブジェクトを使うと，集約をサポートする外部オブジェクトをインスタンス化できます。

Delphi のクラス継承の中で，TContainedObject は接続ポイントの基本クラスとして使われます。接続ポイントは，集約の中にある内部オブジェクトでなければなりません。

以下に，TContainedObject がサポートする実現規則を示します。これらの規則は，集約可能な（内部または格納）オブジェクトの実現規則です。

・	オブジェクトが作成される場合，その型が要求された IUnknwon 型のインターフェースのときのみ作成が成功する

・	Unknown メソッドの AddRef と Release はコントロール IUnknown に機能を委ねる

・	QueryInterface は，格納されているオブジェクト内で実現されたインターフェースに対してのみ，TContainedObject 内で実現される

・	内部オブジェクトの参照カウントは，格納しているオブジェクト内でインクリメントされる

注意

集約 COM オブジェクトは，実際は複数の COM オブジェクトからなっています。各オブジェクトは独自の動作とインターフェースを実現しますが，オブジェクトはすべて同じコントローラオブジェクトの参照カウントを共有します。コンテナパターンの中では，コントローラはコンテナオブジェクトです。

集約，コントロールオブジェクト，インターフェースについての詳細は，Microsoft Web サイトの Inside OLE 第 2 版（Kraig Brockschmidt）か，Windows SDK のヘルプを参照してください。


TContainedObject のプロパティ3057002

TContainedObject	アルファベット順	凡例

TAggregatedObject からの継承

Controller


TContainedObject のプロパティ3057003

TContainedObject	オブジェクト順	凡例

TAggregatedObject からの継承

Controller


TContainedObject のメソッド

TContainedObject	アルファベット順

TAggregatedObject からの継承

Create

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TContainedObject のメソッド

TContainedObject	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


アクセス種別3057004

読み出し専用


継承3057005

TObject

TAggregatedObject


TContainedObject の例3057006

TContainedObject


TCollection
TCollection3058001

継承	プロパティ	メソッド	参照

TCollection オブジェクトは TCollectionItem オブジェクトのコンテナです。

ユニット

classes

説明

TCollection の各オブジェクトは TCollectionItem オブジェクトのグループを保持します。TCollection は，その Items 配列内のコレクション項目のインデックスを保持します。Count プロパティにはコレクションの項目数が入ります。コレクションの項目を追加するには Add メソッドを使い，項目を削除するには Clear メソッドを使います。

TCollection から派生するオブジェクトには，TCollectionItem から派生するオブジェクトを入れることができます。たとえば TDBGridColumns オブジェクトには TColumn オブジェクトを入れることができます。これらの 2 つのクラスは，TDBGrid がグリッドの列を表示するために使います。以下の表に，TCollection の下位オブジェクト，対応する TCollectionItem の派生オブジェクト，およびそれぞれの組合わせを使うコントロールコンポーネントを示します。TQueryTableProducer および TWebDispatcher 以外のコントロールは，TWinControl から派生します。

TCollection	TCollectionItem

の派生オブジェクト	の派生オブジェクト	コントロールコンポーネント

TCheckConstraints	TCheckConstraint	TField を使うコントロール

TCoolBands	TCoolBand	TCoolBar

TDBGridColumns	TColumn	TDBGrid

THeaderSections	THeaderSection	THeaderControl

THTMLTableColumns	THTMLTableColumn	TQueryTableProducer

TListColumns	TListColumn	TListView

TStatusPanels	TStatusPanel	TStatusBar

TWebActionItems	TWebActionItem	TWebDispatcher

TCollection および TCollectionItem の派生オブジェクトを使うコントロールは，コレクションを保持するパブリッシュプロパティを持ちます。たとえば，TStatusBar の Panels プロパティは TStatusPanels を保持します。オブジェクトインスペクタから標準のプロパティエディタ（コレクションエディタ）を起動して，コレクション内の項目を編集することができます。


TCollection プロパティ3058002

TCollection	アルファベット順	凡例

TCollection

Count

ItemClass

Items


TCollection プロパティ3058003

TCollection	オブジェクト順	凡例

Count

ItemClass

Items


TCollection.Count
TCollection.Count3058004

TCollection	参照

Count プロパティは，コレクション内の項目数を返します。

property Count: Integer;

説明

Count プロパティには Items 配列内の項目数が入ります。Items に付けられるはインデックスは 0 から始まるため，Count の値は Items の最後のインデックス番号よりも必ず 1 大きくなります。


TCollection.ItemClass
TCollection.ItemClass3058005

TCollection	参照

ItemClass プロパティは，コレクションの項目が所属しているクラスです。

TCollectionItemClass = class of TCollectionItem;

property ItemClass: TCollectionItemClass;

説明

ItemClass プロパティは，コレクション内の項目が所属しているクラス（TCollectionItem から継承）を返します。たとえば，TCollection の下位オブジェクト THeaderSections のインスタンスの場合，ItemClass プロパティは THeaderSection を返します。


TCollection.Items
TCollection.Items3058006

TCollection	参照

Items プロパティは，コレクション内の項目インデックスを示します。

property Items[Index: Integer]: TCollectionItem;

説明

Index パラメータの値は TCollectionItem の Index プロパティに対応しており，コレクション内の項目の位置を示します。


TCollection メソッド3058007

TCollection	アルファベット順

TCollection

Add

Assign

BeginUpdate

Clear

Create

Destroy

EndUpdate

FindItemID

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCollection メソッド3058008

TCollection	オブジェクト順

Add

Assign

BeginUpdate

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

EndUpdate

FieldAddress

FindItemID

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCollection.Add
TCollection.Add3058009

TCollection	参照

Add メソッドは，新しい TCollectionItem インスタンスを作成して Items 配列に追加します。

function Add: TCollectionItem;

説明

Add メソッドは新しいコレクション項目を返します。


TCollection.Assign
TCollection.Assign3058010

TCollection	参照

Assign メソッドは，メソッドが実行されるオブジェクトに別のコレクションの内容をコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドを呼び出すと，TCollection の インスタンスを別のインスタンスにコピーできます。Assign メソッドはターゲットのコレクション（メソッドが実行されるオブジェクト）からすべての項目を削除して，Source コレクションの Items 配列にある各項目のコピーを追加します。


TCollection.BeginUpdate
TCollection.BeginUpdate3058011

TCollection	参照

BeginUpdate メソッドは，画面の再描画を抑制します。

procedure BeginUpdate;

説明

BeginUpdate メソッドは，EndUpdate メソッドが呼び出されるまで画面の再描画を抑制します。BeginUpdate を呼び出すと，コレクションの項目の追加や削除を行っている間の処理を高速化できます。


TCollection.Clear
TCollection.Clear3058012

TCollection	参照

Clear メソッドは，コレクションからすべての項目を削除します。

procedure Clear;

説明

Clear メソッドは Items 配列を空にして各 TCollectionItem オブジェクトを破棄します。


TCollection.Create
TCollection.Create3058013

TCollection	参照

Create メソッドは，コレクションを作成し，初期化します。

constructor Create(ItemClass: TCollectionItemClass);

説明

Create メソッドは TCollectionItem の下位クラスの名前をパラメータにとります。このパラメータは，Add メソッドで作成される項目のクラスを指定します。


TCollection.Destroy
TCollection.Destroy3058014

TCollection	参照

Destroy メソッドは，コレクションとその項目を破棄します。

destructor Destroy; override;

説明

Destroy メソッドは Clear メソッドを呼び出して Items 配列で参照される各項目を解放し，コレクション自体を破棄します。


TCollection.EndUpdate
TCollection.EndUpdate3058015

TCollection	参照

EndUpdate メソッドは，抑止していた画面の再描画を再開します。

procedure EndUpdate;

説明

EndUpdate メソッドを呼び出すと，BeginUpdate メソッドで抑止していた画面の再描画が再開されます。


TCollection.FindItemID
TCollection.FindItemID3058016

TCollection	参照

FindItemID メソッドは，指定した ID を持つ項目を返します。

function FindItemID(ID: Integer): TCollectionItem;

説明

FindItemID メソッドは，ID プロパティがパラメータとして渡されたコレクション内の項目を返します。指定した ID を持つ項目がない場合，FindItemID は nil を返します。


読み出し／書き込み3058017

読み出し専用


継承3058018

TObject

TPersistent


TCollection 例3058019

TCollection


TCollectionItem
TCollectionItem3059001

継承	プロパティ	メソッド	参照

TCollectionItem はコレクションの項目を表します。

ユニット

classes

説明

TCollection オブジェクトは TCollectionItem オブジェクトのグループを保持します。TCollectionItem は TCollection の Add メソッドで作成され，Clear メソッドで破棄されます。TCollectionItem の各オブジェクトは，項目が属する TCollection オブジェクトを指す Collection プロパティを保持します。

TCollection から派生するオブジェクトには，TCollectionItem から派生するオブジェクトを入れることができます。たとえば TDBGridColumns オブジェクトには TColumn オブジェクトを入れることができます。これらの 2 つのクラスは，TDBGrid がグリッドの列を表示するために使います。TCollection および TCollectionItem の下位オブジェクトについての詳細は「TCollection」を参照してください。


TCollectionItem プロパティ3059002

TCollectionItem	アルファベット順	凡例

TCollectionItem

Collection

DisplayName

ID

Index


TCollectionItem プロパティ3059003

TCollectionItem	オブジェクト順	凡例

Collection

DisplayName

ID

Index


TCollectionItem.Collection
TCollectionItem.Collection3059004

TCollectionItem

Collection プロパティは，TCollectionItem が属している TCollection のインスタンスを指定します。

property Collection: TCollection;

説明

TCollectionItem の各オブジェクトは，それぞれを作成した TCollection に属します。Collection プロパティは，項目が属するコレクションオブジェクトを指します。


TCollectionItem.DisplayName
TCollectionItem.DisplayName3059005

TCollectionItem

DisplayName プロパティは，コレクションエディタで表示される名前です。

property DisplayName: string;

説明

DisplayName プロパティはコレクションエディタで項目を表す文字列です。コレクションエディタで項目が選択されると，DisplayName は別のプロパティの値として（たとえば，THeaderSection または TStatusPanel の Text プロパティとして）オブジェクトインスペクタにも表示されます。デフォルトでは，DisplayName は項目がインスタンスである TCollectionItem派生クラスの名前です。


TCollectionItem.ID
TCollectionItem.ID3059006

TCollectionItem	参照

ID プロパティは，項目のユニークな永続的インデックスです。

property ID: Integer;

説明

ほとんどの場合，ID プロパティは項目がコレクションに最初に追加されたときの項目の Index プロパティの値です。ただし，Index 値とは異なり，ID 値は変更されたり，再割り当てされたりすることはありません。コレクションから項目が削除された場合に，その項目の ID が再度使われることはありません。

コレクションから他の項目が削除されたり，項目が並べ替えられたりすると，項目の Index は変更されることがあります。ID は，コレクションが存続する限り変更されない，各項目のユニークな識別子を提供します。


TCollectionItem.Index
TCollectionItem.Index3059007

TCollectionItem	参照

Index プロパティは，TCollection の Items 配列内の項目の位置を返します。

property Index: Integer;

説明

TCollectionItem の各オブジェクトには，それぞれが属する TCollection の Items 配列内でインデックスが付けられます。TCollectionItem の Index プロパティは，その配列内に項目のインデックス値を格納します。

Items はインデックスがゼロから始まる配列です。コレクションの最初のメンバーのインデックス値は 0，2 番目のメンバーのインデックス値は 1，というように続きます。


TCollectionItem メソッド3059008

TCollectionItem	アルファベット順

TCollectionItem

Create

Destroy

TPersistent からの継承

Assign

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCollectionItem メソッド3059009

TCollectionItem	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCollectionItem.Create
TCollectionItem.Create3059010

TCollectionItem	参照

Create メソッドは，TCollectionItem インスタンスを作成し，初期化します。

constructor Create(Collection: TCollection); virtual;

説明

Create メソッドは TCollection インスタンスの名前をパラメータにとります。Create は TCollection の Add メソッドによって呼び出されます。


TCollectionItem.Destroy
TCollectionItem.Destroy3059011

TCollectionItem	参照

Destroy メソッドは，TCollectionItem インスタンスを破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

Destroy メソッドは TCollection の Clear メソッドによって間接的に呼び出されます。


読み出し／書き込み3059012

読み出し専用


継承3059013

TObject

TPersistent


TCollectionItem 例3059014

TCollectionItem


TColorDialog
TColorDialog3060001

継承	プロパティ	メソッド	イベント	例

TColorDialog コンポーネントはモード付き色選択ダイアログを表示します。

ユニット

dialogs

説明

TColorDialog コンポーネントは，色を選択するための Windows ダイアログボックスを表示します。実行時にこのダイアログボックスが表示されるのは，Execute メソッドの呼び出しによってアクティブになってからです。色を選択して［OK］をクリックすると，ダイアログボックスは閉じ，選択された色は Color プロパティに格納されます。


TColorDialog プロパティ3060002

TColorDialog	アルファベット順	凡例

TColorDialog

Color

CustomColors

Options

TCommonDialog からの継承

Ctl3D

Handle

HelpContext

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TColorDialog プロパティ3060003

TColorDialog	オブジェクト順	凡例

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Ctl3D

CustomColors

DesignInfo

Handle

HelpContext

Name

Options

Owner

Tag

VCLComObject


TColorDialog.Color
TColorDialog.Color3060004

TColorDialog	参照

Color プロパティは，選択された色を返します。

property Color: TColor default clBlack;

説明

ダイアログボックスで色を選択して［OK］をクリックすると，選択された色が Color プロパティの値になります。ダイアログボックスが開いたときデフォルトの色が表示されるようにするには，オブジェクトインスペクタかプログラムコード内であらかじめ Color プロパティに値を設定しておきます。


TColorDialog.CustomColors
TColorDialog.CustomColors3060005

TColorDialog

CustomColors プロパティは，ダイアログボックスで利用できるカスタムカラーを指定します。

property CustomColors: TStrings;

説明

カスタムカラーは，� ColorX=16進数値 � という形式の文字列で表します。たとえば次の文字列で，カスタムカラーのひとつを設定します。

ColorA=808022

最大 16 色（ColorA から ColorP）のカスタムカラーを設定できます。


TColorDialog.Options
TColorDialog.Options3060006

TColorDialog

Options プロパティは，ダイアログボックスのオプションとデフォルトの外観を指定します。

TColorDialogOption = (cdFullOpen, cdPreventFullOpen, cdShowHelp, cdSolidColor, cdAnyColor);

TColorDialogOptions = set of TColorDialogOption;

property Options: TColorDialogOptions default [];

説明

Options プロパティで，ダイアログボックスの外観と機能をカスタマイズします。

値	意味

cdFullOpen	ダイアログボックスが開いたとき，カスタムカラーオプションを表示する

cdPreventFullOpen	新しい色を定義できないように，ダイアログボックスの［色の作成(D)］ボタンを使用不可にする

cdShowHelp	ダイアログボックスに［ヘルプ］ボタンを追加する

cdSolidColor	選択された色に最も近い色を Windows に使わせる

cdAnyColor	ユーザーが任意の色（ディザリングを使わなければならないことがある）を選択できるようにする

デフォルトでは，以上のオプションはすべてオフです。


TColorDialog イベント3060007

TColorDialog	アルファベット順	凡例

TCommonDialog からの継承

OnClose

OnShow


TColorDialog イベント3060008

TColorDialog	オブジェクト順	凡例

OnClose

OnShow


TColorDialog メソッド3060009

TColorDialog	アルファベット順

TColorDialog

Create

Destroy

Execute

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TColorDialog メソッド3060010

TColorDialog	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Execute

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TColorDialog.Create
TColorDialog.Create3060011

TColorDialog	参照

Create メソッドは，色選択ダイアログボックスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは TColorDialog インスタンスを作成し，CustomColors プロパティを初期化します。


TColorDialog.Destroy
TColorDialog.Destroy3060012

TColorDialog	参照

Destroy メソッドは，色選択ダイアログボックスを破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは色選択ダイアログボックスが破棄されていないことを確認し，破棄されていなければ Destroy メソッドを呼び出します。


TColorDialog.Execute
TColorDialog.Execute3060013

TColorDialog

Execute メソッドは，色選択ダイアログボックスを表示します。

function Execute: Boolean; override;

説明

Execute メソッドは色選択ダイアログボックスを開き，ユーザーが色を選択して［OK］をクリックしたら True を返します。


スコープ3060014

published

読み出し／書き込み

読み出し専用


スコープ3060015

published


継承3060016

TObject

TPersistent

TComponent

TCommonDialog


TColorDialog 例3060017

TColorDialog


TColumnTitle
TColumnTitle3061001

継承	プロパティ	メソッド	参照

TColumnTitle はデータグリッドの列（TColumn）のタイトルを表します。

ユニット

dbgrids

説明

TDBGrid は，TDBGridColumns を使って TColumn オブジェクトのコレクションを保持します。TColumn の各オブジェクトは，そのタイトルについての情報を持つ TColumnTitle に関連付けられています。TColumnTitle インスタンスは列の Title プロパティに格納されます。


TColumnTitle プロパティ3061002

TColumnTitle	アルファベット順	凡例

TColumnTitle

Alignment

Caption

Color

Font


TColumnTitle プロパティ3061003

TColumnTitle	オブジェクト順	凡例

Alignment

Caption

Color

Font


TColumnTitle.Alignment
TColumnTitle.Alignment3061004

TColumnTitle	参照

Alignment プロパティは，列タイトル内でどのようにテキストを揃えるかを指定します。

property Alignment: TAlignment;

説明

以下に Alignment の値を示します。

値	意味

taLeftJustify	テキストを列の左端で揃える

taCenter	テキストを列の中央で揃える

taRightJustify	テキストを列の右端で揃える


TColumnTitle.Caption
TColumnTitle.Caption3061005

TColumnTitle	参照

Caption プロパティは，列の最上部に表示されるテキストを指定します。

property Caption: string;

説明

Caption プロパティには，列を識別するテキスト文字列が入ります。データグリッドの Options プロパティで dgTitles フラグが設定されている場合は，実行時にタイトルがフォームに表示されます。

TColumn で FieldName プロパティが設定されている場合は，Caption のデフォルト値は，Field.DisplayLabel（このデフォルト値は FieldName）になります。


TColumnTitle.Color
TColumnTitle.Color3061006

TColumnTitle	参照

Color プロパティは，列タイトルの背景色を指定します。

property Color: TColor;

説明

Color プロパティは列タイトルの背景色を指定します。Color は Graphics ユニットで定義される定数の 1 つ（clBlue など）に設定したり，明示的な RGB 整数値に設定したりできます。デフォルト値はグリッドの FixedColor プロパティです。


TColumnTitle.Font
TColumnTitle.Font3061007

TColumnTitle	参照

Font プロパティは，列タイトルにキャプションを表示するときに使うフォントを制御します。

property Font: TFont;

説明

Font プロパティは，列タイトルに表示されるテキストの書体の属性を決める TFont オブジェクトを指します。デフォルト値はグリッドの TitleFont プロパティです。


TColumnTitle メソッド3061008

TColumnTitle	アルファベット順

TColumnTitle

Assign

Create

DefaultAlignment

DefaultCaption

DefaultColor

DefaultFont

Destroy

RestoreDefaults

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TColumnTitle メソッド3061009

TColumnTitle	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultAlignment

DefaultCaption

DefaultColor

DefaultFont

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RestoreDefaults

SafeCallException


TColumnTitle.Assign
TColumnTitle.Assign3061010

TColumnTitle	参照

Assign メソッドは，ソースの列タイトルの内容を新しい列タイトルにコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドは，ソースオブジェクトと同じ Alignment，Color，Caption，および Font の値を使って新しい列タイトルを作成します。


TColumnTitle.Create
TColumnTitle.Create3061011

TColumnTitle	参照

Create メソッドは，列タイトルを作成し，初期化します。

constructor Create(Column: TColumn);

説明

Create メソッドは TColumn のインスタンスを引数にとります。


TColumnTitle.DefaultAlignment
TColumnTitle.DefaultAlignment3061012

TColumnTitle	参照

DefaultAlignment メソッドは，列タイトルのデフォルトの位置合わせを返します。

function DefaultAlignment: TAlignment;

説明

DefaultAlignment は常に taLeftJustify を返します。


TColumnTitle.DefaultCaption
TColumnTitle.DefaultCaption3061013

TColumnTitle	参照

DefaultCaption メソッドは列タイトルのデフォルトのキャプションを返します。

function DefaultCaption: string;

説明

DefaultCaption メソッドは，列に関連付けられた TField オブジェクトの DisplayLabel を返します。列に関連付けられたデータセット項目がない場合（すなわち Field プロパティが空の場合）は列の FieldName を返します。


TColumnTitle.DefaultColor
TColumnTitle.DefaultColor3061014

TColumnTitle	参照

DefaultColor メソッドは，列タイトルのデフォルトの背景色を返します。

function DefaultColor: TColor;

説明

DefaultColor メソッドは，列が属するデータグリッドの FixedColor を返します。列に関連付けられたデータグリッドがない場合は clBtnFace を返します。


TColumnTitle.DefaultFont
TColumnTitle.DefaultFont3061015

TColumnTitle	参照

DefaultFont メソッドは，列タイトルのデフォルトのフォントを返します。

function DefaultFont: TFont;

説明

DefaultFont メソッドは，列が属するデータグリッドの TitleFont を返します。列に関連付けられたデータグリッドがない場合は列の Font プロパティの現在の値を返します。


TColumnTitle.Destroy
TColumnTitle.Destroy3061016

TColumnTitle	参照

Destroy メソッドは，列を破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

Destroy メソッドは，TColumnTitle インスタンスとそれに関連付けられているフォント（TFont）を破棄します。


TColumnTitle.RestoreDefaults
TColumnTitle.RestoreDefaults3061017

TColumnTitle	参照

RestoreDefaults メソッドは，列タイトルのデフォルト設定を返します。

procedure RestoreDefaults; virtual;

説明

RestoreDefaults メソッドは Caption および Font プロパティを再初期化します。


スコープ3061018

published


継承3061019

TObject

TPersistent


TColumnTitle 例3061020

TColumnTitle


TColumn
TColumn3062001

継承	プロパティ	メソッド	参照

TColumn オブジェクトはデータグリッド（TDBGrid）内の列を表します。

ユニット

dbgrids

説明

TDBGrid の各コンポーネントは TDBGridColumns を使って TColumn オブジェクトのコレクションを保持します。


TColumn プロパティ3062002

TColumn	アルファベット順	凡例

TColumn

Alignment

AssignedValues

ButtonStyle

Color

DisplayName

DropDownRows

Field

FieldName

Font

Grid

ImeMode

ImeName

PickList

PopupMenu

ReadOnly

Title

Width

TCollectionItem からの継承

Collection

ID

Index


TColumn プロパティ3062003

TColumn	オブジェクト順	凡例

Alignment

AssignedValues

ButtonStyle

Collection

Color

DisplayName

DropDownRows

Field

FieldName

Font

Grid

ID

ImeMode

ImeName

Index

PickList

PopupMenu

ReadOnly

Title

Width


TColumn.Alignment
TColumn.Alignment3062004

TColumn	参照

Alignment プロパティは，列内でどのようにテキストを揃えるかを指定します。

property Alignment: TAlignment;

説明

以下に Alignment の値を示します。

値	意味

taLeftJustify	テキストを列の左端で揃える

taCenter	テキストを列の中央で揃える

taRightJustify	テキストを列の右側で揃える


TColumn.AssignedValues
TColumn.AssignedValues3062005

TColumn	参照

AssignedValues プロパティは，どの TColumn プロパティおよび TColumnTitle プロパティが設定されたかを示します。

TColumnValue = (cvColor, cvWidth, cvFont, cvAlignment, cvReadOnly, cvTitleColor, cvTitleCaption, cvTitleAlignment, cvTitleFont, cvImeMode, cvImeName);

TColumnValues = set of TColumnValue;

TColumnValue = (cvColor, cvWidth, cvFont, cvAlignment, cvReadOnly, cvTitleColor,

    cvTitleCaption, cvTitleAlignment, cvTitleFont, cvImeMode, cvImeName);

TColumnValues = set of TColumnValue;

property  AssignedValues: TColumnValues;

説明

読み出し専用の AssignedValues プロパティは，設定されたかまたはデフォルト値が変更された列とそのタイトル（TColumnTitle）のプロパティをリストします。AssignedValues の値は 0 または以下の値の組み合わせになります。

値	意味

cvColor	列の Color プロパティが変更された

cvWidth	列の Width プロパティが変更された

cvFont	列の Font プロパティが変更された

cvAlignment	列の Alignment プロパティが変更された

cvReadOnly	列の ReadOnly プロパティが変更された

cvTitleColor	列タイトルの Color プロパティが変更された

cvTitleCaption	列タイトルの Caption プロパティが変更された

cvTitleAlignment	列タイトルの Alignment プロパティが変更された

cvTitleFont	列タイトルの Font プロパティが変更された

cvImeMode	列の ImeMode プロパティが変更された

cvImeName	列の ImeName プロパティが変更された

たとえば AssignedValues が [cvColor, cvTitleCaption] を返した場合は，列のフォントとタイトルキャプションが変更され，それ以降はデフォルトソースに対する変更を追跡しないことを示します。

多くの列のプロパティは，関連付けられている TField オブジェクトのプロパティなど，外部ソースから値を取得します。列のプロパティに値が代入されるまでは，プロパティのデフォルトソースに対する変更内容が列に反映されます。代入後は，列のプロパティはデフォルトソースから独立したものになります。


TColumn.ButtonStyle
TColumn.ButtonStyle3062006

TColumn	参照

ButtonStyle プロパティは，ユーザーがリストから列の値を選択できるかどうかを指定し，その選択方法を指定します。

property ButtonStyle: TColumnButtonStyle;

説明

ButtonStyle プロパティは，ユーザーがデータグリッド列のデータを編集できる方法を指定します。ButtonStyle には以下の値を指定できます。

値	意味

cbsAuto	列が参照項目に関連付けられているか，PickList プロパティに値が割り当てられていれば，グリッドが列にコンボボックスを表示する。ユーザーはドロップダウンリストで値を選択できる

cbsEllipsis	ユーザーがクリックして値を選択できる省略記号のボタンが列に表示される。省略記号のボタンをクリックすると OnEdtiButtonClick イベントが発生する

cbsNone	コンボボックスや省略記号のボタンは表示されない。ユーザーはリストから列の内容を選択することはできない


TColumn.Color
TColumn.Color3062007

TColumn	参照

Color プロパティは，列の背景色を指定します。

property Color: TColor;

説明

Color プロパティはデータグリッド列の背景色を指定します。Color は Graphics ユニットで定義される定数（clBlue など）の 1 つに設定するか，明示的な RGB 整数値に設定することができます。


TColumn.DisplayName
TColumn.DisplayName3062008

TColumn	参照

DisplayName プロパティは，空白でなければ FieldName を返し，空白ならば TField.DisplayName を返します。

property DisplayName: string;

説明

DisplayName プロパティは，ユーザーに対して項目を表す文字列を表示するときに使います。たとえば，項目に関する例外を生成するときは，DisplayName を含むエラー文字列を形式設定して項目を参照するようにします。


TColumn.DropDownRows
TColumn.DropDownRows3062009

TColumn	参照

DropDownRows プロパティは，列のドロップダウンリストに表示される行数を指定します。

property  DropDownRows: Cardinal;

説明

DropDownRows プロパティは，列に関連付けられたドロップダウンリストに表示されるテキストの行数を指定します。このプロパティは，ButtonStyle が cbsAuto に設定されていて，列に参照項目または関連付けられている選択リストがある場合に使います。


TColumn.Field
TColumn.Field3062010

TColumn	参照

Field プロパティは，列によって表される TField インスタンスです。

property Field: TField;

説明

Field プロパティは，列に表示されるデータセット項目に対応した TField オブジェクトを指します。nil にもなり得ます。


TColumn.FieldName
TColumn.FieldName3062011

TColumn	参照

FieldName プロパティは，列によって表される項目の名前を指定します。

property FieldName: string;

説明

FieldName を設定すると Field プロパティが変更されて，FieldName は同じ名前のデータセット項目を指します。データセットに同じ名前の項目がない場合，Field は nil に設定されます。


TColumn.Font
TColumn.Font3062012

TColumn	参照

Font プロパティは，列にデータを表示するときに使うフォントを制御します。

property  Font: TFont;

説明

Font プロパティは，列に表示されるテキストの書体の属性を決める TFont オブジェクトを指します。


TColumn.Grid
TColumn.Grid3062013

TColumn	参照

Grid プロパティは，列があるグリッドを指定します。

property  Grid: TCustomDBGrid;

説明

Grid プロパティを使うと，列があるグリッドにアクセスできます。


TColumn.ImeMode
TColumn.ImeMode3062014

TColumn	参照

ImeMode プロパティは，列を編集するときの IME（かな漢字変換プログラム）の動作を決めます。

TImeMode = (imDisable, imClose, imOpen, imDontCare, imSAlpha, imAlpha, imHira, imSKata, imKata, imChinese, imSHanguel, imHanguel);

TImeMode = (imDisable, imClose, imOpen, imDontCare, imSAlpha, imAlpha, imHira, imSKata,

     imKata, imChinese, imSHanguel, imHanguel);

property ImeMode: TImeMode;

説明

ImeMode プロパティを設定すると，ユーザーが列を編集するときに IME がユーザーのキーストロークを処理する方法を設定できます。IME はアジア地域の言語の文字を処理するためのフロントエンド入力プロセッサです。IME はすべてのキーボード入力を受け取って，変換ウィンドウでアジア地域の言語の文字に変換し，変換した文字または文字列を Delphi アプリケーションに送ります。

ImeMode プロパティを使うと，列が求める入力に対して適切になるように，IME が実行する変換処理の種類を制御できます。たとえば，数値の入力のみを受け入れる列の場合は，変換処理は不要なので，ImeMode プロパティを imClose に設定します。

ImeMode プロパティには以下の値を指定できます。

値	意味

imDisable	IME を使用不可にする。簡体字中国語，伝統的中国語，ハングルの IME では無効

imClose	IME 変換ウィンドウを閉じる。ただし，IME はバックグラウンドで実行されている。ホットキーの組み合わせにより再度アクティブ化できる

imOpen	IME 変換ウィンドウを開く。変換モードは IME が前回使った変換モードになる

imDontCare	IME に関して何の処理もしない

imSAlpha	IME 変換ウィンドウを開き，変換モードを半角ローマ字入力を受け入れるように設定する

imAlpha	IME 変換ウィンドウを開き，変換モードを全角ローマ字入力を受け入れるように設定する

imHira	IME 変換ウィンドウを開き，変換モードを全角ひらがな入力を受け入れるように設定する。日本語の IME でのみ有効

imSKata	IME 変換ウィンドウを開き，変換モードを半角カタカナ入力を受け入れるように設定する。日本語の IME でのみ有効

imKata	IME 変換ウィンドウを開き，変換モードを全角カタカナ入力を受け入れるように設定する。日本語の IME でのみ有効

imChinese	IME 変換ウィンドウを開き，変換モードを全角漢字入力を受け入れるように設定する。中国語の IME でのみ有効

imSHanguel	IME 変換ウィンドウを開き，変換モードを半角ハングル文字入力を受け入れるように設定する。ハングルの IME でのみ有効

imHanguel	IME 変換ウィンドウを開き，変換モードを全角ハングル文字入力を受け入れるように設定する。ハングルの IME でのみ有効


TColumn.ImeName
TColumn.ImeName3062015

TColumn	参照

ImeName プロパティは，キーボード入力をアジア地域の言語の文字に変換するのに使う IME（かな漢字変換プログラム）を指定します。

TImeName = type string;

property ImeName: TImeName;

説明

ImeName プロパティを設定すると，ユーザーが列を編集するとき，キーストロークの変換にどの IME を使うかを指定できます。IME はアジア地域の言語の文字を処理するためのフロントエンド入力プロセッサです。IME はすべてのキーボード入力を受け取って，変換ウィンドウでアジア地域の言語の文字に変換し，変換した文字または文字列を Delphi アプリケーションに送ります。

ImeName プロパティには，Windows コントロールパネルでインストールされている IME のいずれかを指定する必要があります。プロパティインスペクタを使うと，現在システムにインストールされている IME のドロップダウンリストを表示できます。実行時にはアプリケーションは現在インストールされている IME のリストをグローバル Screen 変数から取得できます。

ImeName プロパティに使用できない IME を指定すると，アプリケーションの起動時にアクティブだった IME が使われます。例外は生成されません。


TColumn.PickList
TColumn.PickList3062016

TColumn	参照

PickList プロパティは，列に対してユーザーが選択できる値のリストを指定します。

property PickList: TStrings;

説明

PickList プロパティは TStrings オブジェクトを指します。ButtonStyle が cbsAuto に設定されている場合，TStrings の文字列は列に関連付けられたドロップダウンリストに表示されます。


TColumn.PopupMenu
TColumn.PopupMenu3062017

TColumn	参照

PopupMenu プロパティは，列に関連付けられているポップアップメニューを指定します。

property  PopupMenu: TPopupMenu

説明

PopupMenu プロパティに値を代入すると，ユーザーが列を右クリックしたときにポップアップメニューが表示されるようにすることができます。TPopupMenu の AutoPopup プロパティが True ならば，ポップアップメニューは自動的に表示されます。メニューの AutoPopup プロパティが False ならば，Popup メソッドの呼び出しを使ってポップアップメニューを表示します。


TColumn.ReadOnly
TColumn.ReadOnly3062018

TColumn	参照

ReadOnly プロパティは，列に表示されるデータを編集可能にするかどうかを指定します。

property ReadOnly: Boolean;

説明

ReadOnly プロパティを True に設定すると，列に表示されるデータをユーザーが実行時に編集することはできません。ReadOnly が False に設定されている場合（かつデータグリッドの Options プロパティに dgEditing フラグが設定されている場合），ユーザーはグリッドから直接データを編集できます。


TColumn.Title
TColumn.Title3062019

TColumn	参照

Title プロパティは，列のタイトルを表す TColumnTitle を指します。

property Title: TColumnTitle;

説明

Title プロパティは，列のタイトルを決める TColumnTitle オブジェクトを指します。FieldName を設定すると，FieldName の値がデフォルトの列のタイトル（TColumnTitle.Caption）となります。

データグリッドの Options プロパティに dgTitles フラグが設定されている場合，タイトル（TColumnTitle.Caption）は実行時にのみ表示されます。


TColumn.Width
TColumn.Width3062020

TColumn	参照

Width プロパティは，列の幅を示します。

property Width: Integer;

説明

Width プロパティは列の幅をピクセル単位で指定します。データグリッドの Options プロパティに dgColumnResize フラグが設定されている場合，ユーザーは実行時に列のサイズを変更できます。


TColumn メソッド3062021

TColumn	アルファベット順

TColumn

Assign

Create

DefaultAlignment

DefaultColor

DefaultFont

DefaultImeMode

DefaultImeName

DefaultReadOnly

DefaultWidth

Destroy

RestoreDefaults

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TColumn メソッド3062022

TColumn	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultAlignment

DefaultColor

DefaultFont

DefaultHandler

DefaultImeMode

DefaultImeName

DefaultReadOnly

DefaultWidth

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RestoreDefaults

SafeCallException


TColumn.Assign
TColumn.Assign3062023

TColumn	参照

Assign メソッドは，ソース列の内容を新しい列にコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドは，ソースオブジェクトと同じ FieldName，Title，DropDownRows，ButtonStyle，および PickList の値を使って新しい列を作成します。Color，Width，Font，Alignment，および ReadOnly が変更されたことを AssignedValues が示す場合には，これらのプロパティもコピーされます。


TColumn.Create
TColumn.Create3062024

TColumn	参照

Create メソッドは，データグリッド列を作成し，初期化します。

constructor Create(Collection: TCollection); override;

説明

Create メソッドは TDBGridColumns インスタンスを引数にとる必要があります。Create は，データグリッド列およびそのタイトル（TColumnTitle）とフォント（TFont）を作成します。


TColumn.DefaultAlignment
TColumn.DefaultAlignment3062025

TColumn	参照

DefaultAlignment メソッドは，列のデフォルトの位置合わせを返します。

function DefaultAlignment: TAlignment;

説明

DefaultAlignment メソッドは，列に関連付けられた TField の Alignment を返します。列に関連付けられたデータセット項目がない場合，DefaultAlignment は taLeftJustify を返します。


TColumn.DefaultColor
TColumn.DefaultColor3062026

TColumn	参照

DefaultColor メソッドは，列のデフォルトの背景色を返します。

function DefaultColor: TColor;

説明

DefaultColor メソッドは，列が属するデータグリッドの Color プロパティの値を返します。列に関連付けられたデータグリッドがない場合，DefaultColor は clWindow を返します。


TColumn.DefaultFont
TColumn.DefaultFont3062027

TColumn	参照

DefaultFont メソッドは，列に表示されるデータのデフォルトのフォントを返します。

function DefaultFont: TFont;

説明

DefaultFont メソッドは，列が属するデータグリッドの Font プロパティの値を返します。列に関連付けられたデータグリッドがない場合，DefaultFont は 列の Font プロパティの現在の値を返します。


TColumn.DefaultImeMode
TColumn.DefaultImeMode3062028

TColumn	参照

DefaultImeMode メソッドは，IME（かな漢字変換プログラム）のデフォルト動作を示します。

TImeMode = (imDisable, imClose, imOpen, imDontCare, imSAlpha, imAlpha, imHira, imSKata, imKata, imChinese, imSHanguel, imHanguel);

TImeMode = (imDisable, imClose, imOpen, imDontCare, imSAlpha, imAlpha, imHira, imSKata,

     imKata, imChinese, imSHanguel, imHanguel);

function  DefaultImeMode: TImeMode;

説明

DefaultImeMode メソッドは，列が所属しているデータグリッドの ImeMode プロパティを返します。列に関連付けられているデータグリッドがない場合は，DefaultImeMode は列の ImeMode プロパティの現在値を返します。


TColumn.DefaultImeName
TColumn.DefaultImeName3062029

TColumn	参照

DefaultImeName メソッドは，デフォルトの IME（かな漢字変換プログラム）の名前を返します。

TImeName = type string;

function  DefaultImeName: TImeName;

説明

DefaultImeName メソッドは，列が所属しているデータグリッドの ImeName プロパティを返します。列に関連付けられているデータグリッドがない場合は，DefaultImeName は列の ImeName プロパティの現在値を返します。


TColumn.DefaultReadOnly
TColumn.DefaultReadOnly3062030

TColumn	参照

DefaultReadOnly メソッドは，列の ReadOnly のデフォルト設定を返します。

function  DefaultReadOnly: Boolean;

説明

グリッドとグリッドのデータセットおよび項目の ReadOnly の状態を示します。


TColumn.DefaultWidth
TColumn.DefaultWidth3062031

TColumn	参照

DefaultWidth メソッドは，列のデフォルトの幅を返します。

function  DefaultWidth: Integer;

説明

DefaultWidth メソッドは以下の値を返します。

・	列に関連付けられたデータグリッドがない場合，DefaultWidth は 64 を返す

・	列に関連付けられたデータグリッドはあるが，Field プロパティが空の場合，DefaultWidth はデータグリッドのプロテクトプロパティ DefaultColWidth を返す。通常，この値は 64 である

・	列に関連付けられたデータ項目がある場合，DefaultWidth の値は列のフォントを使って TField オブジェクトの DisplayWidth プロパティから計算される

・	データグリッドの Options プロパティに dgTitles フラグが設定されている場合，DefaultWidth の値は列のタイトルキャプションが収まるように（必要に応じて）増加する


TColumn.Destroy
TColumn.Destroy3062032

TColumn	参照

Destroy メソッドは，列を破棄して，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

Destroy メソッドは，TColumn インスタンスとともにそのタイトル（TColumnTitle），フォント（TFont），および選択リスト（TStrings）を破棄します。


TColumn.RestoreDefaults
TColumn.RestoreDefaults3062033

TColumn	参照

RestoreDefaults メソッドは，列の設定をデフォルトに戻します。

procedure RestoreDefaults; virtual;

説明

RestoreDefaults メソッドは AssignedValues，ButtonStyle，Font，および PickList の各プロパティを再初期化して，選択リスト（TStrings）オブジェクトがあれば解放し，列のタイトル（TColumnTitle）で RestoreDefaults メソッドを呼び出します。Font プロパティが以前に変更されていた場合，このプロパティの現在の値は保存されます。


スコープ3062034

published

読み出し／書き込み

読み出し専用


継承3062035

TObject

TPersistent

TCollectionItem


TColumn 例3062036

TColumn


TComboBox
TComboBox3063001

継承	プロパティ	メソッド	イベント	参照	例

TComboBox コンポーネントは，編集ボックスとスクロール可能なドロップダウンリストを組み合わせたコントロールです。

ユニット

stdctrls

説明

TComboBox コンポーネントは，編集ボックスと，それに付属したスクロール可能なドロップダウンリストから構成されます。ドロップダウンリストから項目を選択したり，編集ボックスに項目を直接入力したりできます。


TComboBox プロパティ3063002

TComboBox	アルファベット順	凡例

TCustomComboBox からの継承

Canvas

DropDownCount

DroppedDown

ItemHeight

ItemIndex

Items

MaxLength

SelLength

SelStart

SelText

Sorted

Style

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Text

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TComboBox プロパティ3063003

TComboBox	オブジェクト順	凡例

Align

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

DropDownCount

DroppedDown

Enabled

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

ItemHeight

ItemIndex

Items

Left

MaxLength

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

SelLength

SelStart

SelText

ShowHint

Showing

Sorted

Style

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

Width

WindowProc


TComboBox イベント3063004

TComboBox	アルファベット順	凡例

TCustomComboBox からの継承

OnChange

OnDrawItem

OnDropDown

OnMeasureItem

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnStartDrag


TComboBox イベント3063005

TComboBox	オブジェクト順	凡例

OnChange

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnDrawItem

OnDropDown

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMeasureItem

OnStartDrag


TComboBox メソッド3063006

TComboBox	アルファベット順

TCustomComboBox からの継承

Clear

Create

Destroy

SelectAll

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterFace

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TComboBox メソッド3063007

TComboBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterFace

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


スコープ3063008

published

読み出し／書き込み

読み出し専用


スコープ3063009

published


継承3063010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomComboBox


TComClassManager
TComClassManager3064001

継承	メソッド	参照

TComClassManager は ComObj ユニットの中にある ComClassManager 変数のクラスの型です。

ユニット

comobj

説明

TComClassManager は，ComObj ユニット内で ComClassManager 変数として自動的にインスタンス化されます。ComClassManager は，COM サーバーが所有するクラスファクトリオブジェクトを管理するために使われます。

ComClassManager は，このユニットを格納しているモジュールにリンクしているすべてのサーバー用に，クラスファクトリオブジェクトへのポインタのリストを保持します。このリストは個々の COM サーバーが更新します。COM サーバーは，ファクトリオブジェクトが作成されるとリストにそれらを追加し，破棄されると削除します。ComClassManager は，関連付けられたサーバーに基づいたクラスファクトリを操作するメソッドを持っています。そのメソッドは，ファクトリを繰り返し処理したり，作成するクラスオブジェクトの型に基づいてファクトリを返したりします。


TComClassManager のメソッド3064002

TComClassManager	アルファベット順

TComClassManager

ForEachFactory

GetFactoryFromClass

GetFactoryFromClassID

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TComClassManager のメソッド3064003

TComClassManager	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

ForEachFactory

FreeInstance

Free

GetFactoryFromClassID

GetFactoryFromClass

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TComClassManager.ForEachFactory
TComClassManager.ForEachFactory3064004

TComClassManager	参照

ForEachFactory メソッドは，指定されたサーバーに関連付けられたファクトリを繰り返し処理します。

TFactoryProc = procedure(Factory: TComObjectFactory) of object;

procedure ForEachFactory(ComServer: TComServerObject; FactoryProc: TFactoryProc;

説明

ForEachFactory メソッドは，ComClassManager ファクトリリスト上のすべてのクラスファクトリに対するアクション（FactoryProc パラメータで指定される）を処理するために使われます。ComClassManager ファクトリリストは，ComServer パラメータで指定した ComServer が所有しています。

ForEachFactory は COM サーバーが内部的に使用し，以下の処理を行います。

・	関連付けられた COM サーバーがアンロードされると，ファクトリを破棄する

・	関連付けられた COM サーバーが初期化されると，ファクトリがクラスオブジェクトをシステムレジストリに記録するようにする

・	必要なとき，ファクトリにシステムレジストリを更新させる

TFactoryProc は，ForEachProperty の FactoryProc パラメータのメソッドポインタ型です。TFactoryProc は，パラメータとしてクラスファクトリを取るメソッドを定義します。


TComClassManager.GetFactoryFromClass
TComClassManager.GetFactoryFromClass3064005

TComClassManager	参照

GetFactoryFromClass メソッドは，指定された COM オブジェクトにクラスファクトリを返します。

function GetFactoryFromClass(ComClass: TClass): TComObjectFactory;

説明

GetFactoryFromClass メソッドは，Delphi によって内部的に使われ，指定された COM オブジェクトのインスタンスを作成するために正しいクラスファクトリを取得します。

GetFactoryFromClass は ComClass パラメータで指定された COM クラスに関連付けられたクラスファクトリを返します。ComClassManager が保守するリストの中に該当するクラスファクトリがない場合，EOleError 例外が生成され，指定された COM クラスが現在のリストに入っていないことを示します。


TComClassManager.GetFactoryFromClassID
TComClassManager.GetFactoryFromClassID3064006

TComClassManager	参照

GetFactoryFromClassID メソッドは，指定された COM クラス識別子に対するクラスファクトリを返します。

function GetFactoryFromClassID(const ClassID: TGUID): TComObjectFactory;

説明

GetFactoryFromClassID メソッドは，DllGetClassObject によって内部的に使われ，指定されたクラスオブジェクト（ClassID パラメータで指定される）に対し，対応するクラスファクトリオブジェクトの IClassFactory インターフェースへの参照を取得します。

GetFactoryFromClassID は，CassID パラメータで指定された COM クラスに関連付けられたクラスファクトリを返します。クラスが見つからない場合，GetFactoryFromClassID は nil を返します。


継承3064007

TObject


TComClassManager の例3064008

TComClassManager


TCommonDialog
TCommonDialog3065001

継承	プロパティ	メソッド	イベント	参照

TCommonDialog は，Windows のコモンダイアログボックスを表すすべてのコンポーネントの上位クラスです。

ユニット

dialogs

説明

TCommonDialog は Windows のコモンダイアログボックスを表す抽象クラスです。TCommonDialog の下位クラスは，ファイルの検索やオープン，フォントや色の設定，および印刷などのタスクを処理します。ダイアログは，実行時に Execute メソッドの呼び出しでアクティブ化されるまで表示されません。TFindDialog と TReplaceDialog を除いて，これらのダイアログはすべてモード付きです。

TCommonDialog の下位クラスは COMMDLG.DLL の関数呼び出しを 1 つ生成する非ビジュアルコンポーネントなので，ほかの Delphi コンポーネントほど簡単に変更することはできません。コモンダイアログの機能をカプセル化する新しいコンポーネントは TCommonDialog から派生します。その他のほとんどのダイアログボックスは TForm から派生します。


TCommonDialog プロパティ3065002

TCommonDialog	アルファベット順	凡例

TCommonDialog

Ctl3D

Handle

HelpContext

Template

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TCommonDialog プロパティ3065003

TCommonDialog	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Ctl3D

DesignInfo

Handle

HelpContext

Name

Owner

Tag

Template

VCLComObject


TCommonDialog.Ctl3D
TCommonDialog.Ctl3D3065004

TCommonDialog	参照

Ctl3D プロパティは，ダイアログを 3 次元で表示するかどうかを指定します。

property Ctl3D: Boolean default True;

説明

Ctl3D プロパティが True の場合，ダイアログボックスとその内部のコントロールは 3 次元で表示されます。Ctl3D が False の場合，ダイアログボックスとそのコントロールは 2 次元で表示されます。

注意

Windows NT 3.51 でダイアログを 3 次元で表示する場合は，CTL3D32.DLL を System32 ディレクトリにインストールしておく必要があります。


TCommonDialog.Handle
TCommonDialog.Handle3065005

TCommonDialog	参照

Handle プロパティは，ダイアログのウィンドウハンドルです。

property Handle: HWnd;

説明

Handle プロパティは，Execute メソッドが呼び出された後にダイアログのウィンドウハンドルへのアクセスを提供するプロパティで，OnShow および OnClose イベントハンドラ内で使われます。ダイアログが閉じた後，Handle は 0 にリセットされます。


TCommonDialog.HelpContext
TCommonDialog.HelpContext3065006

TCommonDialog	参照

HelpContext プロパティは，オンラインヘルプのコンテキスト番号を指定します。

property HelpContext: THelpContext default 0;

説明

HelpContext プロパティは，ユーザーがヘルプを要求したときに，どのヘルプ画面を表示するかを決める整数値を指定します。HelpContext がデフォルト値の 0 に設定されている場合，ダイアログは親のヘルプコンテキストを継承します。


TCommonDialog.Template
TCommonDialog.Template3065007

TCommonDialog	参照

Template プロパティは，ダイアログのカスタムテンプレートを指します。

property Template: PChar;

説明

Template プロパティは，現在の HInstance モジュール内にある Windows ダイアログのリソースを識別するリソース識別子（ヌルで終わる文字列または MAKEINTRESOURCE で作成される整数）を指します。Execute メソッドはこのリソースを使ってダイアログの外観をカスタマイズします。

たとえば，リソースファイル MYDLG.RES に 123 という整数識別子が指定されている場合，以下のコードで OpenDialog1 をカスタマイズできます。

{$R Mydlg.res}

OpenDialog1.Template:=MakeIntResource(123);

MYDLG.RES に DialogA という文字列識別子が指定されている場合，以下のコードで PrintDialog1 をカスタマイズできます。

{$R Mydlg.res}

PrintDialog1.Template:='DialogA';


TCommonDialog イベント3065008

TCommonDialog	アルファベット順	凡例

TCommonDialog

OnClose

OnShow


TCommonDialog イベント3065009

TCommonDialog	オブジェクト順	凡例

OnClose

OnShow


TCommonDialog.OnClose
TCommonDialog.OnClose3065010

TCommonDialog	参照

OnClose イベントは，ダイアログが閉じるときに発生します。

property OnClose: TNotifyEvent;

説明

OnClose イベントハンドラを記述すると，ダイアログが閉じるときに特別な処理を実行できます。


TCommonDialog.OnShow
TCommonDialog.OnShow3065011

TCommonDialog	参照

OnShow イベントは，ダイアログが開くときに発生します。

property OnShow: TNotifyEvent;

説明

OnShow イベントハンドラを記述すると，ダイアログが表示されるときに特別な処理を実行できます。


TCommonDialog メソッド3065012

TCommonDialog	アルファベット順	凡例

TCommonDialog

Create

Destroy

Execute

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCommonDialog メソッド3065013

TCommonDialog	オブジェクト順	凡例

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Execute

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TCommonDialog.Create
TCommonDialog.Create3065014

TCommonDialog	参照

Create メソッドは，TCommonDialog のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは継承されたコンストラクタメソッドを呼び出し，Ctl3D プロパティを True に初期化します。


TCommonDialog.Destroy
TCommonDialog.Destroy3065015

TCommonDialog	参照

Destroy メソッドは，TCommonDialog のインスタンスを破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはタイアログが破棄されていないことを確認してから Destroy メソッドを呼び出します。


TCommonDialog.Execute
TCommonDialog.Execute3065016

TCommonDialog

Execute メソッドは，ダイアログボックスを表示します。

function Execute: Boolean; virtual; abstract;

説明

TCommonDialog は抽象 Execute メソッドを提供し，下位クラスは実行時にこの抽象メソッドを使ってダイアログのインスタンスを生成します。通常 Execute は，ユーザーが選択を行って［OK］をクリックしたときに True を返し，何も選択せずにダイアログを閉じたときに False を返します。


スコープ3065017

protected

published

読み出し／書き込み

読み出し専用


スコープ3065018

protected


スコープ3065019

published


継承3065020

TObject

TPersistent

TComponent


TCommonDialog 例3065021

TCommonDialog


TComObjectFactory
TComObjectFactory3066001

継承	プロパティ	メソッド	参照

TComObjectFactory は，TComObject クラスをインスタンス化するのに使うクラスファクトリオブジェクトの型です。

ユニット

comobj

説明

TComObjectFactory は，IUknown，IClassFactory，IClassFactory2 の各インターフェースをサポートします。IClassFactory インターフェースはクラスオブジェクトによって実装されます。これらのクラスオブジェクトは，それぞれがインスタンス化するクラス用のクラス ID（CLSID）に関連付けられています。IClassFactory はそれぞれのオブジェクト定義に実装して，その型のオブジェクトを作成できるようにしなければなりません。IClassFactory2 インターフェースは，ライセンス付与用にサポートを必要とするクラスのためにクラスファクトリにより実装されます。

クラスファクトリを使うと，登録されたクラス ID（CLSID）が指定する COM クラスをインスタンス化できます。クラスファクトリオブジェクトは，クラスオブジェクトとその関連付けられたクラスのコードを保持する COM サーバーの担当により自動的に作成されなければなりません。クラスファクトリが作成されると，CLSID がクラスファクトリオブジェクトのコンストラクタへのパラメータで指定されます。この CLSID は，クラスファクトリがインスタンス作成を担当するオブジェクトの型を示します。

また，Windows API 関数の CoCreateClassObject を直接呼び出せば，クラスファクトリオブジェクトを外部的にインスタンス化できます。Windows API ラッパー関数の CreateComObject または CreateOleObject は，COM クラスをインスタンス化するためにも呼び出せます。このような関数はクラスファクトリを間接的に使ってクラスをインスタンス化します。ただし，CLSID を持つ複数のクラスインスタンスを作成している際には，必要なときに，クラスファクトリを使い，その IClassFactory インターフェースへのポインタを取得し，そのメソッドを使うほうがより効率的です。

クラスファクトリは，ComClassManager 変数としてインスタンス化されたグローバルクラスマネージャによりサーバーで管理されます。このクラスマネージャは，通常はクラスファクトリを所有する COM サーバーに従って，クラスファクトリを操作するためのクラスファクトリリストを管理します。

実装されるインターフェース

IUnknown，IClassfactory，IClassFactory2


TComObjectFactory のプロパティ3066002

TComObjectFactory	アルファベット順	凡例

TComObjectFactory

ClassID

ClassName

ComClass

ComServer

Description

ErrorIID

Instancing

LicString

ProgID

ShowErrors

SupportsLicensing


TComObjectFactory のプロパティ3066003

TComObjectFactory	オブジェクト順	凡例

ClassID

ClassName

ComClass

ComServer

Description

ErrorIID

Instancing

LicString

ProgID

ShowErrors

SupportsLicensing


TComObjectFactory.ClassID
TComObjectFactory.ClassID3066004

TComObjectFactory	参照

ClassID プロパティは，ファクトリの特定インスタンスがインスタンス化できる COM クラスのクラス ID（CLSID）です。

property ClassID: TGUID;

説明

ClassID プロパティは，ファクトリがこのファクトリインスタンス用にインスタンス化可能な COM クラスを識別できます。ほかのメソッドはこれを使って，このクラスを識別できます。

ClassID は，クラスファクトリコンストラクタで，コンストラクタに渡す CLSID に初期化されます。また，ClassID は，COM サーバーの初期化を呼び出したときに UpdateRegistry メソッドでも使います。


TComObjectFactory.ClassName
TComObjectFactory.ClassName3066005

TComObjectFactory	参照

ClassName プロパティは，クラスファクトリがインスタンス化するクラスの名前です。

property ClassName: string;

説明

ClassName プロパティは，クラスファクトリがインスタンス化する COM クラスを識別する名前です。

ClassName は，クラスファクトリコンストラクタで，コンストラクタに渡すクラス名に初期化されます。


TComObjectFactory.ComClass
TComObjectFactory.ComClass3066006

TComObjectFactory	参照

ComClass プロパティは，ファクトリがインスタンス化するクラス型です。

property ComClass: TClass;

説明

ComClass プロパティは，クラスマネージャの GetFactoryFromClass メソッドにより使われます。このメソッドは渡されるクラスを調べてサーバーについての各クラスファクトリの ComClass をチェックし，その型のオブジェクトを作成するクラスファクトリを返します。また，CreateComObject メソッドがこれを使うと，正しい COM クラスを作成できます。

ComClass は，クラスファクトリコンストラクタで，コンストラクタに渡す COM クラス型に初期化されます。


TComObjectFactory.ComServer
TComObjectFactory.ComServer3066007

TComObjectFactory	参照

ComServer プロパティは，クラスファクトリを所有する COM サーバーです。

property ComServer: TComServerObject;

説明

ComServer プロパティは，クラスファクトリオブジェクトを保持する COM サーバーを示します。クラスマネージャメソッドはこれを使って，どのサーバーが特定のファクトリを所有するかに基づいてそのファクトリについてのアクションを処理します。

クラスマネージャの ForEachFactory は，ComServer を使ってクラスマネージャのファクトリリストの各ファクトリのサーバー ComServer をチェックする汎用メソッドです。ForEachFactory は次に，その特定の COM サーバーの各ファクトリに対して，パラメータとしてそれに渡されるファクトリプロシージャを呼び出します。

また，ComServer を COM クラスの CreateFromFactory コンストラクタで使うと，COM サーバーの CountObject メソッドを呼び出せます。これは，クラスファクトリがそのクラス型をインスタンス化するときにサーバーのオブジェクトカウントをインクリメントします。

ComServer は，クラスファクトリコンストラクタで，そのコンストラクタに渡すサーバーに初期化されます。


TComObjectFactory.Description
TComObjectFactory.Description3066008

TComObjectFactory	参照

Description プロパティは，型ライブラリから取得される，クラスオブジェクトの記述です。

property Description: string;

説明

Description プロパティはクラスオブジェクトを記述するために，クラスファクトリの登録時に登録データベースで使います。

Description は，クラスファクトリコンストラクタで，コンストラクタに渡す Description パラメータに初期化されます。Description は型ライブラリから取り出されます。


TComObjectFactory.ErrorIID
TComObjectFactory.ErrorIID3066009

TComObjectFactory	参照

ErrorIID プロパティは，エラーが発生する CoClass のインターフェースを返します。これは通常，CoClass の主要インターフェースです。

property ErrorIID: TGUID;

説明

ErrorIID プロパティは，エラーが発生したインターフェースです。これは大半の CoClasses にとって，型ライブラリで示される，その CoClass の主要インターフェースになります。


TComObjectFactory.Instancing
TComObjectFactory.Instancing3066010

TComObjectFactory	参照

Instancing プロパティは，COM クラスの作成方法を示します。

TClassInstancing = (ciInternal, ciSingleInstance, ciMultiInstance);

property Instancing: TClassInstancing;

説明

Instancing プロパティは，ファクトリがインスタンス化するオブジェクトが COM サーバーモジュールに対して内部的に作成されるかどうか，あるいは 1 つのインスタンスまたは複数のインスタンスで作成されるかどうかを示します。

Instancing は，クラスファクトリコンストラクタで，コンストラクタに渡す Instancing パラメータに初期化されます。

TClassInstancing は Instancing プロパティの型です。以下に TClassInstancing 型の値を示します。

値	意味

ciInternal	COM オブジェクトは COM サーバーに内部的に作成される

ciSingleInstance	COM オブジェクトは 1 つのインスタンスで作成される

ciMultiInstance	COM オブジェクトは複数インスタンスの 1 つとして作成される


TComObjectFactory.LicString
TComObjectFactory.LicString3066011

TComObjectFactory

LicString プロパティは，オブジェクトについてのライセンス情報を保持する文字列です。

property LicString: WideString;

説明

LicString プロパティは，ユーザーがオブジェクトに対して開発用の有効なアクセス権限を付与されているかどうかを確認するのに使います。LicString は，オブジェクトをオプションでライセンス供与する開発者が指定する任意の文字列です。


TComObjectFactory.ProgID
TComObjectFactory.ProgID3066012

TComObjectFactory	参照

ProgID プロパティは，クラスファクトリの名前です。

property ProgID: string;

説明

ProgID プロパティは，クラスファクトリオブジェクトのベンダー，コンポーネント，バージョンを指定するプログラム ID です。

OLE コンテナに挿入できるオブジェクトクラスはすべて ProgID を持ちます。


TComObjectFactory.SupportsLicensing
TComObjectFactory.SupportsLicensing3066013

TComObjectFactory

SupportsLicensing プロパティは，インスタンス化されているオブジェクトがライセンス供与機能をサポートするかどうかを示します。

property SupportsLicensing: Boolean;

説明

SupportsLicensing プロパティは，ユーザーにオブジェクトへの有効なアクセス権限を付与するかどうかを指定できます。


TComObjectFactory のメソッド3066014

TComObjectFactory	アルファベット順

TComObjectFactory

Create

CreateComObject

Destroy

RegisterClassObject

UpdateRegistry

TObject からの継承

ClassInfo

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TComObjectFactory のメソッド3066015

TComObjectFactory	オブジェクト順

ClassInfo

ClassNameIs

ClassParent

ClassType

CleanupInstance

CreateComObject

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RegisterClassObject

SafeCallException

UpdateRegistry


TComObjectFactory.Create
TComObjectFactory.Create3066016

TComObjectFactory	参照

Create メソッドは，クラスファクトリオブジェクトをインスタンス化します。

constructor Create(ComServer: TComServerObject; ComClass: TComClass; const ClassID: TGUID; const ClassName, Description: string; Instancing: TClassInstancing);

説明

Create メソッドは通常，サーバーがロードされるときに，クラスファクトリをインスタンス化します。クラスファクトリをサーバーのロード時に自動的に使用可能にするように，クラスファクトリはその関連付けられたサーバーを含むユニットの initialization セクションでインスタンス化しなければなりません。

Create はクラスファクトリオブジェクトのメモリを割り当て，そのオブジェクトを ComClassManager の管理するクラスファクトリリストに追加します。次に，Create は渡された値を使って以下のプロパティを初期化します。

・	ComServer を ComServer パラメータに設定する

・	ComClass を ComClass パラメータに設定する

・	ClassID を ClassID パラメータに設定する

・	ClassName を ClassName パラメータに設定する

・	Description を Description パラメータに設定する

・	Instancing を Instancing パラメータに設定する

・	ErrorIID を IUnknown に設定する


TComObjectFactory.CreateComObject
TComObjectFactory.CreateComObject3066017

TComObjectFactory	参照

CreateComObject メソッドは，TComObject オブジェクトをインスタンス化します。

function CreateComObject(const Controller: IUnknown): TComObject; virtual;

説明

CreateComObject メソッドは，TComObjectFactory がクラスファクトリのクラス型をインスタンス化するメソッドです。CreateComObject は，TComObject クラスの CreateFromFactory コンストラクタを呼び出して COM オブジェクトを作成します。CreateComObject はそれ自体を Factory パラメータとして CreateFromFactory に渡します。

CreateComClass は，ComClass プロパティの値に基づいて COM オブジェクトを作成します。ComClass は，ほかのアプリケーションがオブジェクトインスタンスを要求する COM クラスを識別するために使うクラス ID（CLSID）です。


TComObjectFactory.Destroy
TComObjectFactory.Destroy3066018

TComObjectFactory	参照

Destroy メソッドは，クラスファクトリのインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで Destroy を直接呼び出さないでください。クラスファクトリは対応するサーバーがアンロードされたときに自動的に破棄されます。

注意

オブジェクトの破棄を扱うアプリケーションは Free を呼び出さなければなりません。Free はクラスファクトリオブジェクトが解放されていないことを確認してから Destroy を呼び出します。


TComObjectFactory.RegisterClassObject
TComObjectFactory.RegisterClassObject3066019

TComObjectFactory	参照

RegisterClassObject メソッドは，ファクトリオブジェクトに関連付けられた COM クラスを登録します。

procedure RegisterClassObject;

説明

RegisterClassObject メソッドは，EXE クラスオブジェクトを OLE に登録するので，ほかのアプリケーションはそれに接続できます。EXE オブジェクトアプリケーションは起動するとすぐに RegisterClassObject を呼び出さなければなりません。また，これを使って内部オブジェクトを登録し，同じ EXE やその EXE が使うほかのコード（DLL など）がそれを利用できるようにできます。

RegisterClassObject が成功しない場合，以下のエラーコードで EOleSysError が発生します。

値	意味

E_INVALIDARG	1 つまたは複数の引数が無効

E_OUTOFMEMORY	メモリが不十分

E_UNEXPECTED	予想外のエラーが発生した

CO_E_OBJISREG 	クラスがクラスオブジェクトテーブルに登録済みだった

EXE オブジェクトアプリケーションのみが RegisterClassObject を呼び出します。オブジェクトハンドラや DLL オブジェクトアプリケーションはこの関数を呼び出しません。それらはかわりに，DllGetClassObject 関数を実現してエクスポートしなければなりません。

起動時に，複数使用 EXE アプリケーションはクラスオブジェクトを（IClassFactory インターフェースをそれに設定して）作成し，クラスオブジェクトを登録するために RegisterClassObject を呼び出さなければなりません。異なる複数のクラスをサポートするオブジェクトアプリケーション（複数種類の埋め込み可能オブジェクトなど）は，それぞれに対して異なるクラスオブジェクトを割り当てて登録する必要があります。

同じクラスオブジェクトを重複して登録しても，それぞれ独立しているのでエラーは発生しません。2 つめ以降の各登録では，ユニークなキーを生じさせます。


TComObjectFactory.UpdateRegistry
TComObjectFactory.UpdateRegistry3066020

TComObjectFactory	参照

UpdateRegistry メソッドは，ファクトリが作成する COM オブジェクトを登録します。

procedure UpdateRegistry(Register: Boolean); virtual;

説明

UpdateRegistry メソッドは，EXE の実行時には EXE 用に呼び出され，サーバーを明確に登録または登録解除するためにルーチンが呼び出されるときには DLL または EXE 用に呼び出されます。


アクセス種別3066021

読み出し専用


継承3066022

TObject


TComObjectFactory の例3066023

TComObjectFactory


TComObject

Hierarchy	Properties	Methods	See also

TComObject is used as a base for creating simple COM classes, such as those used for creating Shell extensions and other simple COM objects.

Unit

comobj

Description

TComObject is a COM object that supports the IUnknown and ISupportErrorInfo interfaces. TComObject provides the implementation for simple COM objects that have:

�	A class identifier (CLSID) for external instantiation using a class factory.

�	Otional support for aggregation implemented through by the IUknown methods.

�	Support for the SafeCall calling convention and OLE exception-handling by implementing IProvideErrorInfo.

�	Support for the the IErrorInfo mechanism.

TComObject can be used as a base class for creating classes for COM objects that must have a class identifier (CLSID). CLSIDs are used to register the class in the database registry and to externally instantiate the class using class factory. The class factory for TComObject is TComObjectFactory. The class factory properties provide information about TComObject class, such as its name, description, CLSID, and so on. The TComObjectFactory methods are used to register the TComObject class in the registry and to instantiate it.

TComObject can be instantiated either as a single COM object, or as part of an aggregate. The IUnknown methods are implemented in TComObject to support aggregation by appropriately delegating to the controlling IUnknown interface when the instantiated COM object is the inner object of an aggregate. Consequently, for all interfaces that are implemented by the inner COM object, its reference count will not be directly affected when an interface reference is created.

TComObject supports the ISupportErrorInfo interface which allows OLE Automation controllers to query whether an error object will be available, and ensures that error information can be propagated correctly up the call chain. By implementing the ISupportErrorInfo interface method, InterfaceSupportsErrorInfo, TComObject supports the IErrorInfo mechanism, thereby providing support for OLE exception-handling and the safecall calling convention. The information available through the IErrorInfo interface is used for SafeCall error handling.

Using TComObject will not require the instantiated object to have a type library.

Implemented methods of ISupportErrorInfo

InterfaceSupportsErrorInfo method


TComObject properties

TComObject	Alphabetically	Legend

In TComObject

Controller

Factory

RefCount


TComObject properties

TComObject	By object	Legend

Controller

Factory

RefCount


TComObject.Controller

TComObject	See also

Controller is the controlling IUnknown that controls interfaces within an aggregate object.

property Controller: IUnknown;

Description

Controller is the controlling IUnknown interface for an the inner object in an aggregate. This means that the QueryInterface, AddRef and Release methods of all other interfaces, except IUnknown, which are implemented in the inner object, must delegate to the controlling IUnknown. Because of this the inner object�s reference count is not affected.

Controller is nil if the object is not part of an aggregate. If Controller is non-nil, the object is part of an aggregate for which the Controller is the control object.


TComObject.Factory

TComObject	See also

Factory is the class factory object for the TComObject class.

property Factory: TComObjectFactory;

Description

Factory is the class factory which is used to instantiate a TComObject.


TComObject.RefCount

TComObject	See also

RefCount is the number of references, to the COM object, that are currently in use.

property RefCount: Integer;

Description

RefCount is used to determine when the object can be destroyed. RefCount is the number of references to interfaces implemented by the COM object. When RefCount is zero, the object can be is destroyed.

RefCount is automatically incremented when references to interfaces implemented by the COM object are created, and is automatically decremented when those references are destroyed. RefCount is usually incremented by the IUnknown AddRef method and decremented by the IUnknown method, Release.

RefCount can be artifically incremented when a new object is created which may be passed as a function parameter. In this case, RefCount should not be zero, and should be incremented prior to the function call and decremented when the function returns. The CreateFromFactory method artifically increments and decrements RefCount for this reason.


TComObject methods

TComObject	Alphabetically

In TComObject

Create

CreateAggregated

CreateFromFactory

Destroy

Initialize

ObjAddRef

ObjQueryInterface

ObjRelease

SafeCallException

Derived from TObject

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TComObject methods

TComObject	By object

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

CreateAggregated

CreateFromFactory

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

Initialize

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ObjAddRef

ObjQueryInterface

ObjRelease

SafeCallException


TComObject.Create

TComObject	See also

Create instantiates a COM object that is not part of an aggregate.

constructor Create;

Description

Call Create to instantiate a COM object, that is not part of an aggregate, at runtime.

Create allocates memory for a COM object, and then directly calls the CreateFromFactory constructor, passing it nil as the Controller parameter to indicate that the COM object is not being created as part of an aggregate.


TComObject.CreateAggregated

TComObject	See also

CreateAggregated instantiates a COM object that is part of an aggregate.

constructor CreateAggregated(const Controller: IUnknown);

Description

Call CreateAggregated to instantiate a COM object that is part of an aggregate by passing it the IUnknown control object as the Controller parameter.

CreateAggregated allocates memory for a COM object and then calls the CreateFromFactory constructor. Because the newly instantiated COM object is part of an aggregate, CreateAggregated passes Controller to CreateFromFactory as its Controller parameter. Controller also becomes the value of the Controller property of the COM object.


TComObject.CreateFromFactory

TComObject	See also

CreateFromFactory instantiates a COM object and initializes its values.

constructor CreateFromFactory(Factory: TComObjectFactory; const Controller: IUnknown);

Description

Call Create to instantiate a COM object, that is not part of an aggregate, at runtime.

Create allocates memory for a COM object, and then initializes the following properties:

�	Sets RefCount to 1, as a means of artificial reference counting in the case that the newly created object has a zero reference count and is passed as a parameter.

�	Sets Factory to the Factory parameter, which is the instance of the class factory responsible for creating the object.

�	Sets Controller to the Controller parameter, which is either a control object, if the object is part of an aggregate, or nil if it is not.

�	Calls on the COM server to incredment the reference count of objects dependent on it.

�	Calls Initialize.

�	Decrements the RefCount that was artificially incremented.


TComObject.Destroy

TComObject	See also

Destroy is disposes of an instance of a COM object.

destructor Destroy; override;

Description

Do not call Destroy directly in an application. Instead, an application should call Free. Free verifies that the COM object has not already been freed before it calls Destroy.

Destroy checks to see if the Factory property is nil. If it is nil, then Destroy passes False to the CountObject method of the Factory object�s ComServer, allowing the DLL (server) to be unloaded if no more objects are dependent upon the server.


TComObject.Initialize

TComObject	See also

Initialize provides an interface to a method that does nothing.

procedure Initialize; virtual;

Description

Initialize currently does nothing. Descendent COM objects can override Initialize.


TComObject.ObjAddRef

TComObject

ObjAddRef is the implementation for the AddRef method of the IUnknown interface.

function ObjAddRef: Integer; virtual; stdcall;

Description

QueryInterface is used as the implementation of the IUnknown QueryInterface method when the COM object (TComObject) is not part of an aggregate.


TComObject.ObjQueryInterface

TComObject

ObjQueryInterface is the implementation for the QueryInterface method of the IUnknown interface.

function ObjQueryInterface(const IID: TGUID; out Obj): Integer; virtual; stdcall;

Description

QueryInterface queries whether the COM object supports a given interface specified by the IID parameter. QueryInterface is used as the implementation of the IUnknown QueryInterface method when the COM object (TComObject) is not part of an aggregate.


TComObject.ObjRelease

TComObject

ObjRelease is the implementation for the Release method of the IUnknown interface.

function ObjRelease: Integer; virtual; stdcall;

Description

QueryInterface is used as the implementation of the IUnknown QueryInterface method when the COM object (TComObject) is not part of an aggregate.


TComObject.SafeCallException

TComObject

SafeCallException is used for OLE exception handling.

function SafeCallException(ExceptObject: TObject; ExceptAddr: Pointer): HResult; override;

Description

SafeCallException prevents an exception from being raised to escape its scope. Any exceptions raised must also be handled within the method.

The implementation of a safecall method guarantees that no exceptions are raised by enclosing the statement part of the method in an implied try...except block.

Note

SafeCallException calls the global routine HandleSafeCallException, which provides a standard way of handling this behavior. Methods of a CoClass that supports OLE exception handling (that implements the ISupportErrorInfo interface) are affected by this function. If those CoClass methods use the safecall calling convention, they are modified to return an HRESULT. Procedures will return an HRESULT, and functions will pass their usual result value as the last (out) parameter, and will return an HRESULT instead. The method is enclosed in a try...finally block, afterwhich the HRESULT is returned, and the environment is set up so that the ISupportErrorInfo implementation will work correctly.


Accessibility

Read-only


Hierarchy

TObject


TComObject example

TComObject


TComponentFactory
TComponentFactory3068001

継承	プロパティ	メソッド

TComponentFactory は，インターフェースをサポートする Delphi コンポーネントのインスタンスを作成するためのクラスファクトリです。

ユニット

vclcom

説明

TComponentFactory はインターフェースを実装するコンポーネントクラスのインスタンスを作成します。TComponentFactory は IClassFactory インターフェースおよび IClassFactory2 インターフェースのサポートを継承します。

注意

これらのコンポーネントは，オートメーションオブジェクト（集号体）の格納オブジェクトとして実際に作成されます。


TComponentFactory のプロパティ3068002

TComponentFactory	アルファベット順	凡例

TAutoObjectFactory からの継承

DispIntfEntry

DispTypeInfo

TTypedComObject からの継承

ClassInfo

TComObjectFactory からの継承

ClassID

ClassName

ComClass

ComServer

Description

ErrorIID

Instancing

LicString

ProgID

ShowErrors

SupportsLicensing


TComponentFactory のプロパティ3068003

TComponentFactory	オブジェクト順	凡例

ClassID

ClassInfo

ClassName

ComClass

ComServer

Description

DispIntfEntry

DispTypeInfo

ErrorIID

Instancing

LicString

ProgID

ShowErrors

SupportsLicensing


TComponentFactory のメソッド3068004

TComponentFactory	アルファベット順

TComponentFactory

Create

TAutoObjectFactory からの継承

GetIntfEntry

TTypedComObjectFactory からの継承

GetInterfaceTypeInfo

UpdateRegistry

TComObjectFactory からの継承

CreateComObject

Destroy

RegisterClassObject

TObject からの継承

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TComponentFactory のメソッド3068005

TComponentFactory	オブジェクト順

ClassNameIs

ClassParent

ClassType

CleanupInstance

CreateComObject

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetInterfaceTypeInfo

GetIntfEntry

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RegisterClassObject

SafeCallException

UpdateRegistry


TComponentFactory.Create
TComponentFactory.Create3068006

TComponentFactory	参照

Create メソッドは，TComponentFactory オブジェクトのインスタンスをインスタンス化します。

constructor Create(ComServer: TComServerObject; ComponentClass: TComponentClass; const ClassID: TGUID; Instancing: TClassInstancing);

説明

Create メソッドは，TComponentFactory オブジェクト用にメモリを割り当ててから，継承された Create を呼び出し，同じ順序でパラメータを渡します。ComponentClass パラメータは，TAutoClass として AutoClass パラメータに渡されます。


アクセス種別3068007

読み出し専用


継承3068008

TObject

TComObjectFactory

TTypedComObjectFactory

TAutoObjectFactory


TComponentFactory の例3068009

TComponentFactory


TComServer
TComServer3069001

継承	プロパティ	メソッド	イベント	参照

ユニット

comserv

説明

TComServer は，ComServ ユニットで宣言およびインスタンス化される ComServer 変数のクラス型です。

TComServer は COM サーバー用に使うクラス型です。このサーバーは，COM または OLE クラス定義を保持するモジュールです。そのモジュールは，インプロセスサーバー（DLL）またはローカルサーバー（EXE）のいずれかです。

TComServer のプロパティは，そのタイプライブラリ，名前，ヘルプファイルなど，サーバーについての必要なすべての情報を保持します。また，サーバーのロードおよびアンロードの時期と方法を示します。

以下に，TComServer のメソッドの使用目的を示します。

・	そのプロパティのアクセサリ関数として

・	COM クラスおよび OLE クラスをそのクラス ID (CLSID) に基づいてインスタンス化することを目的に，関連付けられたクラスファクトリを作成するため

・	COM クラスおよび OLE クラスについての情報でレジストリデータベースを更新するため

TComServer は，ComServ ユニットで自動的にインスタンス化される ComServer 変数の型です。そして，COM オブジェクトのサーバーとして作成される各モジュールは，ComServer のそれ自身のインスタンスを持っています。

ComServer はクラスファクトリを管理するために，TComClassManager オブジェクトを使います。そして，そのオブジェクトは ComClassManager 変数として ComObj ユニットで自動的にインスタンス化されます。ComClassManager のメソッドへの呼び出しがこのクラスファクトリを主に使います。

注意

ComServ ユニットは，インプロセスサーバーがエクスポートしなければならないグローバルルーチンを宣言および実現します。このようなルーチンは，COM サーバーの登録，登録解除，アンロードを自動的に処理します。


TComServer のプロパティ3069002

TComServer	アルファベット順	凡例

TComServer

HelpFileName

IsInprocServer

ObjectCount

ServerFileName

ServerKey

ServerName

StartMode

TypeLib


TComServer のプロパティ3069003

TComServer	オブジェクト順	凡例

HelpFileName

IsInprocServer

ObjectCount

ServerFileName

ServerKey

ServerName

StartMode

TypeLib


TComServer.HelpFileName
TComServer.HelpFileName3069004

TComServer

HelpFileName プロパティは，モジュールに関連付けられたヘルプファイルの名前です。

property HelpFileName: string;

説明

HelpFileName プロパティは，COM サーバーに使うヘルプファイルの名前を検索できます。


TComServer.IsInprocServer
TComServer.IsInprocServer3069005

TComServer	参照

InProcServer プロパティは，com サーバーがインプロセスサーバーかどうかを示します。

property IsInprocServer: Boolean;

説明

InProcServer プロパティは，com サーバーがインプロセスサーバーかどうかを示します。つまり，サーバーがオブジェクトのコンテナと同じプロセス空間を実行しているかどうかを意味します。このプロパティの値は com サーバーのコンストラクタで設定し，IsLibrary 変数により指定します。

Delphi では，OLE オートメーションサーバーは DLL 内ですべてインプロセスサーバーで，アプリケーション内ではインプロセスサーバーではないと想定しています。


TComServer.ObjectCount
TComServer.ObjectCount3069006

TComServer	参照

ObjectCount プロパティは，ロード中のサーバーに依存しているオブジェクトの数を示します。

property ObjectCount: Integert;

説明

ObjectCount プロパティは，サーバーをアンロードできるときを示します。ObjectCount は，サーバーに現在依存しているオブジェクトの数を保持します。

CountObject メソッドは，新しいオブジェクトがクラスファクトリから作成されるときに ObjectCount プロパティをインクリメントし，オブジェクトが破棄されるときにそれをデクリメントします。

ObjectCount がゼロのとき，サーバーをアンロードできます。この時点で，OnLastRelease イベントハンドラ用に書いたコードは，最後のオブジェクトが解放されてからサーバーが閉じられるまでの間に，特殊なアクションを処理できます。


TComServer.ServerFileName
TComServer.ServerFileName3069007

TComServer	参照

ServerFileName プロパティは，COM サーバーの完全なパスとファイル名です。

property ServerFileName: string;

説明

ServerFileName プロパティは，COM サーバーのモジュール名を保持します。この名前には，モジュールのファイル名のパスと拡張子が含まれます。


TComServer.ServerKey
TComServer.ServerKey3069008

TComServer

ServerKey プロパティは，COM サーバーがインプロセスサーバーかどうか，あるいはローカルサーバーかどうかを示します。

property ServerKey: string;

説明

ServerKey プロパティは，サーバーが DLL のときに「InprocServer32」という文字列，サーバーが EXE のときに「LocalServer32」という文字列を保持します。


TComServer.ServerName
TComServer.ServerName3069009

TComServer	参照

ServerName プロパティはサーバーのファイル名です。

property ServerName: string;

説明

ServerName プロパティは，パスおよび拡張子を除いた，COM サーバーのファイル名を保持します。


TComServer.StartMode
TComServer.StartMode3069010

TComServer	参照

StartMode プロパティは，com サーバーが起動された理由を示します。

TStartMode = (smStandalone, smAutomation, smRegServer, smUnregServer);

property StartMode: TStartMode;

説明

StartMode プロパティは，スタンドアロン，対話型アプリケーション，埋め込みオブジェクトとして，あるいは登録または登録解除のためなど，com サーバーが起動された理由を示します。

TStartMode は StartMode プロパティの型で，OLE オートメーションサーバーを起動できる各種の理由を示します。

以下に，開始モードの値のそれぞれと，対応するコマンドラインオプションを示します。

開始モード	オプション	意味

smAutomation	embedding	オートメーションコントローラからの要求への応答として，アプリケーションは Windows により起動された

smRegServer	regserver	サーバーをシステムレジストリに追加するためだけに，アプリケーションが起動された

smStandalone	---	ユーザーがアプリケーションをスタンドアロンの対話型アプリケーションとして起動した

smUnregServer	unregserver	システムレジストリからサーバーを削除するためだけに，アプリケーションが起動された


TComServer.TypeLib
TComServer.TypeLib3069011

TComServer

TypeLib プロパティは COM サーバーに関連付けられたタイプライブラリです。

property TypeLib: ITypeLib;

説明

TypeLib プロパティは，COM サーバーのタイプライブラリにアクセスできます。TypeLib は，ITypeLib インターフェースへの参照です。


TComServer のイベント3069012

TComServer	アルファベット順

TComServer

OnLastRelease


TComServer のイベント3069013

TComServer	オブジェクト順

OnLastRelease


TComServer.OnLastRelease
TComServer.OnLastRelease3069014

TComServer	参照

OnLastRelease イベントは，サーバーを使った最後のオブジェクトが解放されたときに発生します。

TLastReleaseEvent = procedure(var Shutdown: Boolean) of object;

property OnLastRelease: TLastReleaseEvent;

説明

OnLastRelease を記述すると，サーバーを使った最後のオブジェクトが解放されてからサーバーが閉じる直前までに特定のアクションを処理できます。ShutDown は，サーバーをアンロードするかどうかを示します。

TLastReleaseEvent は OnLastRelease イベントの型です。Shutdown は，OnLastRelease イベントの処理後にサーバーが閉じるかどうかを示します。


TComServer のメソッド3069015

TComServer	アルファベット順

TComServer

Create

Destroy

Initialize

LoadTypeLib

SetServerName

UpdateRegistry

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TComServer のメソッド3069016

TComServer	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

Initialize

InitInstance

InstanceSize

LoadTypeLib

MethodAddress

MethodName

NewInstance

SafeCallException

SetServerName

UpdateRegistry


TComServer.Create
TComServer.Create3069017

TComServer	参照

Create メソッドは，COM サーバーオブジェクトを構築します。

constructor Create;

説明

Create メソッドを呼び出すと，実行時に COM サーバーをインスタンス化できます。

Create は COM サーバーオブジェクトのメモリを割り当て，その IsInprocServer プロパティと StartMode プロパティを初期化します。com サーバーオブジェクトを作成するためにコンストラクタを直接呼び出す必要はありません。グローバル変数 ComServer は ComServ ユニットで宣言され，initialization セクションでインスタンス化されます。


TComServer.Destroy
TComServer.Destroy3069018

TComServer	参照

Destroy メソッドは，COM サーバーオブジェクトのインスタンスを破棄します。

destructor Destroy; override;

説明

COM サーバーオブジェクトを破棄するのに，Free（または Destroy）を直接呼び出す必要はありません。グローバル変数 ComServer は ComServ ユニットで宣言され，initialization セクションと finalization セクションで自動的に作成および破棄されます。

Destroy は COM サーバーオブジェクトを破棄し，ComClassManger を呼び出して，それが管理するリストから，サーバーが所有するクラスファクトリのそれぞれを解放します。

注意

オブジェクトの破棄を扱うアプリケーションでは，かわりに必ず Free を呼び出さなければなりません。Free は，COM サーバーオブジェクトが解放されていないことを確認してからDestroy を呼び出します。


TComServer.Initialize
TComServer.Initialize3069019

TComServer	参照

Initialize メソッドは，レジストリを更新してクラスオブジェクトを登録します。

procedure Initialize;

説明

サーバーがシステムレジストリからサーバーを削除するためだけに起動されたのではない場合，Initialize はレジストリを更新します。次に，対話型のスタンドアロンアプリケーションとして，あるいはオートメーションコントローラの要求への応答としてサーバーが起動された場合，Initialize は，サーバーが所有する，各クラスファクトリを要求してそのクラスオブジェクトをシステムレジストリに登録します。


TComServer.LoadTypeLib
TComServer.LoadTypeLib3069020

TComServer	参照

LoadTypeLib メソッドは，サーバーのタイプライブラリをロードします。

procedure LoadTypeLib;

説明

LoadTypeLib は，サーバーのタイプライブラリをロードします。LoadTypeLib が呼び出されたときにタイプライブラリがロード済みでない場合，同時にタイプライブラリも登録します。

LoadTypeLib が成功しなかったときは，エラーコードを示す EOleSysError を発生させます。以下にエラーコードを示します。

エラーコード	意味

E_OUTOFMEMORY	メモリが不足

E_INVALIDARG	いくつかの引数が無効

TYPE_E_IOERROR	ファイルへの書き込みに失敗した

TYPE_E_INVALIDSTATE	タイプライブラリを開けなかった

TYPE_E_INVDATAREAD	ファイルからの読み込みに失敗した

TYPE_E_UNSUPFORMAT	タイプライブラリの形式が古い

TYPE_E_UNKNOWNLCID	LCID を OLE サポート DLL で見つけられなかった

TYPE_E_CANTLOADLIBRARY	タイプライブラリまたは DLL をロードできなかった

ほかの戻りコード	All FACILITY_STORAGE のエラーが返される場合がある


TComServer.SetServerName
TComServer.SetServerName3069021

TComServer	参照

SetServerName メソッドは，ServerName プロパティを設定します。

procedure SetServerName(const Name: string);

説明

SetServerName メソッドを呼び出すと，サーバーの名前を指定できます。サーバーが関連付けられたタイプライブラリを持つ（TypeLib プロパティが nil である）場合，サーバーの名前はタイプライブラリで指定された名前と一致しなければならないので，SetServerName は何もしません。


TComServer.UpdateRegistry
TComServer.UpdateRegistry3069022

TComServer	参照

UpdateRegistry メソッドは，COM サーバーで実現されたクラスに関する情報を登録します。

procedure UpdateRegistry(Register: Boolean);

説明

UpdateRegistry は，COM サーバーの現在のステータスを反映するようにレジストリを更新します。 したがって，UpdateRegistry は，COM サーバーがインスタンス化したクラスファクトリと関連付けられたタイプライブラリ情報および CLSID を登録または登録解除します。

サーバーを登録または登録解除するグローバル関数は UpdateRegistryを呼び出します。UpdateRegistry は Initialize メソッドでも呼び出されます。


アクセス種別3069023

読み出し専用


継承3069024

TObject

TComServerObject


TComServer の例3069025

TComServer


TComServerObject
TComServerObject3070001

継承	プロパティ	メソッド	参照

TComServerObject は TComServer の抽象基本クラスです。

ユニット

comobj

説明

TComServerObject は TComServer クラスの基本クラスとして使われます。メソッドはすべてプロテクトされた抽象メソッドです。TComServerObject は，Protected の抽象メソッドを導入し，導入されたメソッドは派生クラスの中でプロパティのアクセサ関数としてオーバーライドされます。これらのメソッドは TComServerObject クラスに実装されています。TComServerObject のプロパティはすべて読み出し専用です。

COM サーバーオブジェクトを使うには，プロジェクトに ComServ ユニットを入れます。このユニットは自動的に TComServer の下位クラスをインスタンス化し，オブジェクトを ComServ ユニット内の ComServer 変数に割り当てます。


TComServerObject のプロパティ3070002

TComServerObject	アルファベット順	凡例

TComServerObject

HelpFileName

ServerFileName

ServerKey

ServerName

TypeLib


TComServerObject のプロパティ3070003

TComServerObject	オブジェクト順	凡例

HelpFileName

ServerFileName

ServerKey

ServerName

TypeLib


TComServerObject.HelpFileName
TComServerObject.HelpFileName3070004

TComServerObject

HelpFileName プロパティは，モジュールに関連付けられたヘルプファイルの名前です。

property HelpFileName: string;

説明

HelpFileName プロパティの抽象アクセサメソッドは，派生クラスの中でオーバーライドされます。


TComServerObject.ServerFileName
TComServerObject.ServerFileName3070005

TComServerObject	参照

ServerFileName プロパティは，COM サーバーのフルパスとファイル名です。

property ServerFileName: string;

説明

ServerFileName プロパティの抽象アクセサメソッドは，派生クラスの中でオーバーライドされます。


TComServerObject.ServerKey
TComServerObject.ServerKey3070006

TComServerObject

ServerKey プロパティは，COM サーバーがインプロセスサーバーかどうか，あるいはローカルサーバーかどうかを示します。

property ServerKey: string;

説明

ServerKey プロパティの抽象アクセサメソッドは，派生クラスの中でオーバーライドされます。


TComServerObject.ServerName
TComServerObject.ServerName3070007

TComServerObject	参照

ServerName プロパティは，サーバーのファイル名です。

property ServerName: string;

説明

ServerName の抽象アクセサメソッドは，派生クラスの中でオーバーライドされます。


TComServerObject.TypeLib
TComServerObject.TypeLib3070008

TComServerObject	参照

TypeLib プロパティは，COM サーバーに関連付けられた型ライブラリです。

property TypeLib: ITypeLib;

説明

TypeLib プロパティの抽象アクセサメソッドは，派生クラスの中でオーバーライドされます。


TComServerObject のメソッド3070009

TComServerObject	アルファベット順

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TComServerObject のメソッド3070010

TComServerObject	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


アクセス種別3070011

読み出し専用


継承3070012

TObject


TComServerObject の例3070013

TComServerObject


TConnectionPoints
TConnectionPoints3071001

継承	プロパティ	メソッド

TConnectionPoints は接続ポイントのコンテナを実現するクラスです。

ユニット

axctrls

説明

TConnectionPoints は送信インタフェースの存在を示すオブジェクトの機能を提供するクラスです。

IConnectionPointContainer インタフェースは接続可能なオブジェクトで実現され，送信インタフェースの存在を示します。このインタフェースは，IEnumConnectionPointsIt インタフェースを備えた列挙子のサブオブジェクトへのアクセスを提供します。

さらに，このインタフェースは IConnectionPoint インタフェースを実現するすべての接続ポイントのサブオブジェクトへのアクセスも提供します。IConnectionPoint インタフェースは，IEnumConnections インタフェースを備えた列挙子のサブオブジェクトへのアクセスを提供します。

TConnectionPoints を使うと，以下へのアクセスを確保できます。

・	IEnumConnectionPoints インタフェースを備えた列挙子のサブオブジェクト。IEnumConnectionPoints インタフェースは各送信 IID ごとに接続ポイントを列挙する際に使用できる

・	送信 IID ごとに IConnectionPoint インタフェースを備えた接続ポイントのサブオブジェクト。クライアントは IConnectionPoint インタフェースを介して，接続可能なオブジェクトおよびクライアント自身のシンクを用いた補助ループを開始したり終了したりする。また，クライアントは IConnectionPoint インタフェースを使ってIEnumConnections インタフェースを備えた列挙子オブジェクトを取得し，検知した接続を列挙できる

実装されるインタフェース

IConnectionPointContainer


TConnectionPoints のプロパティ3071002

TConnectionPoints	アルファベット順	凡例

TAggregatedObject からの継承

Controller


TConnectionPoints のプロパティ3071003

TConnectionPoints	オブジェクト順	凡例

Controller


TConnectionPoints のメソッド3071004

TConnectionPoints	アルファベット順

TConnectionPoints

Create

CreateConnectionPoint

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TConnectionPoints のメソッド3071005

TConnectionPoints	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

CreateConnectionPoint

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TConnectionPoints.Create
TConnectionPoints.Create3071006

TConnectionPoints	参照

Create メソッドは，接続ポイントオブジェクトをインスタンス化します。

constructor Create(const Controller: IUnknown);

説明

Create メソッドは，自動的に呼び出されて接続ポイントオブジェクトをインスタンス化します。Create を直接呼び出す必要はありません。Create は他のオブジェクトが接続ポイントオブジェクトを作成するために内部的に使います。

Create は接続ポイントオブジェクトにメモリを割り当て，継承された Create を呼び出して集約内の未知のコントロールとして Controller を渡します。そして，格納する接続ポイントオブジェクトのリストを作成します。


TConnectionPoints.CreateConnectionPoint
TConnectionPoints.CreateConnectionPoint3071007

TConnectionPoints	参照

CreateConnectionPoint メソッドは，接続ポイントオブジェクトをインスタンス化します。

Type

TConnectionKind = (dkSingle, dkMulti);

TConnectEvent = procedure(const Sink: Iunknown; Connecting: Boolean) of object;

function CreateConnectionPoint(const IID: TGUID; Kind: TConnectionKind; OnConnect: TConnectEvent): ConnectionPoint;

説明

CreateConnectionPoint メソッドは，ActiveX コントロールが初期化されると自動的に呼び出されます。CreateConnectionPoint は接続ポイントオブジェクトを作成して返します。以下が接続ポイントのコンストラクタに渡されます。

・	接続ポイントのコンテナとして CreateConnectionPoint 自身

・	この接続ポイントで管理される送信インタフェースのインタフェース識別子または GUID としての IID

・	IConnectionPoint Advise メソッドで使われる接続イベントとしての OnConnect

・	TConnectEvent は作成される接続ポイントオブジェクトの OnConnect イベント用の手続きを指すポインタ。TConnectionKind はその接続ポイントに対して複数の接続が存在するかどうかを示す型


TConnectionPoints.Destroy
TConnectionPoints.Destroy3071008

TConnectionPoints

Destroy メソッドは，接続ポイントオブジェクトのインスタンスを破棄します。

destructor Destroy; override;

説明

Destroy メソッドは，自動的に呼び出されます。ユーザーは接続ポイントオブジェクトを破棄する必要はありません。Destroy はコンストラクタで作成された接続ポイントオブジェクトのリストを解放します。

注意

オブジェクトの破棄処理を必要とするアプリケーションでは，Destroy を直接呼び出すかわりに Free を呼び出してください。Free はオブジェクトが解放されていないことを確認してから Destroy を呼び出します。


アクセス種別3071009

読み出し専用


継承3071010

TObject

TAggregatedObject


TConnectionPoints の例3071011

TConnectionPoints


TConnectionPoint
TConnectionPoint3072001

継承	プロパティ	メソッド	参照

ユニット

axctrls

説明

TConnectionPoint は，接続ポイントコンテナに接続ポイントオブジェクトを作成するのに使われるクラスです。

TConnectionPoint は，IConnectionPoint インターフェースを実現するクラスです。TConnectionPoint を使うと，接続可能なオブジェクトに接続ポイントオブジェクトを作成できます。接続可能なオブジェクトは以下の機能をサポートしています。

・	イベントセットなどの送信インターフェース

・	送信インターフェースの IID を列挙する機能

・	送信 IID に対するオブジェクトへのリンクを接続したり解除したりする機能

・	特定の送信インターフェースに対して存在している接続を列挙する機能

実現される IConnectionPoint のメソッド

GetConnectionInterface，GetConnectionPointContainer，Advise，Unadvise，EnumConnections


TConnectionPoint のプロパティ3072002

TConnectionPoint	アルファベット順	凡例

TAggregatedObject からの継承

Controller


TConnectionPoint のプロパティ3072003

TConnectionPoint	オブジェクト順	凡例

Controller


TConnectionPoint のメソッド3072004

TConnectionPoint	アルファベット順

TConnectionPoint

Create

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TConnectionPoint のメソッド3072005

TConnectionPoint	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TConnectionPoint.Create
TConnectionPoint.Create3072006

TConnectionPoint	参照

Create メソッドは，接続ポイントオブジェクトをインスタンス化します。

type

TConnectionKind - (dkSingle, dkMulti);

TConnectEvent = procedure(const Sink: Iunknown; Connecting: Boolean) of object;

constructor Create(Container: TConnectionPoints; const IID: TGUID; OnConnect: TConnectEvent);

説明

Create メソッドは，接続ポイントコンテナの CreateConnectionPoint メソッドによって自動的に呼び出され，接続ポイントオブジェクトをインスタンス化します。これは，ActiveX コントロールが初期化されたときに発生します。

Create は接続ポイントオブジェクトにメモリを割り当てて，継承された Create を呼び出し，Container のコントロール IUnknown を渡します。Container は接続ポイントのコンテナオブジェクトです。Create は Container に接続ポイントオブジェクトを追加してから，以下の項目を設定します。

・	IID。IID は GUID として，つまりこの接続オブジェクトが管理する送信インターフェースのインターフェース識別子として使われる

・	IKind。そのポイントへの接続が単一か複数かどうかを示す

・	OnConnect。IConnectionPointAdvise メソッド内で接続イベントとして使われる

TConnectEvent は，接続ポイントの OnConnect イベントに使う手続きへのポインタです。TConnectionKind は，接続ポイント に複数の接続があるかどうかを示す型です。


TConnectionPoint.Destroy
TConnectionPoint.Destroy3072007

TConnectionPoint	参照

Destory メソッドは，接続ポイントオブジェクトの接続を破棄します。

destructor Destroy; override;

説明

接続ポイントオブジェクトを破棄する必要はありません。接続ポイントは自動的に破棄されます。接続ポイントのコンテナオブジェクトが nil でなければ，Destroy はコンテナオブジェクトからの接続オブジェクトの削除を要求します。

注意

オブジェクトの破棄を処理する必要があるアプリケーションの場合，アプリケーションで直接 Destroy を呼び出さないでください。かわりに Free を呼び出します。Free はオブジェクトが解放されていないことを確認してから Destroy メソッドを呼び出します。


アクセス種別3072008

読み出し専用


継承3072009

TObject

TAggregatedObject

TContainedObject


TConnectionPoint の例3072010

TConnectionPoint


TControl
TControl3073001

継承	プロパティ	メソッド	イベント	参照

TControl は，すべてのビジュアルコンポーネントの抽象基本クラスです。

ユニット

controls

説明

コントロールはビジュアルコンポーネントなので，実行時にユーザーが見たり操作したりできます。すべてのコントロールは，コントロールの表示に関係するプロパティ，メソッド，イベントを共通して持っています。たとえば，コントロールの位置，コントロールのウィンドウに関連付けられているカーソルや Hint などのプロパティ，コントロールをペイントまたは移動するメソッド，マウス動作に応答するイベントがあります。

TControl には，下位オブジェクトによって使用または Published に設定される多くの Protected プロパティおよび Protected メソッドがあります。


TControl プロパティ3073002

TControl	アルファベット順	凡例

TControl

Align

BoundsRect

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ControlState

ControlStyle

Cursor

DesktopFont

DragCursor

DragMode

Enabled

Font

Height

Hint

IsControl

Left

MouseCapture

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ScalingFlags

ShowHint

Text

Top

Visible

Width

WindowProc

WindowText

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TControl プロパティ3073003

TControl	オブジェクト順	凡例

Align

BoundsRect

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlState

ControlStyle

Cursor

DesignInfo

DesktopFont

DragCursor

DragMode

Enabled

Font

Height

Hint

IsControl

Left

MouseCapture

Name

Owner

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ScalingFlags

ShowHint

Tag

Text

Top

VCLComObject

Visible

Width

WindowProc

WindowText


TControl.Align
TControl.Align3073004

TControl	参照

Align プロパティは，コンテナ（親コントロール）内でコントロールを揃える方法を指定します。

TAlign = (alNone, alTop, alBottom, alLeft, alRight, alClient);

property Align: TAlign;

説明

Align プロパティは，フォーム，パネル，またはコントロールのコンテナになっているコンポーネントのサイズが変化しても，コントロールをフォームまたはパネルの上端，下端，左端，右端に位置合わせして，一定の場所にとどめておくことができます。

たとえば，ツールパレットとして各種のコントロールをパネルコンポーネントと組み合わせて使うには，Align プロパティを alLeft に変更すれば，ツールパレットが常にフォームの左側にあり，フォームのクライアント領域の高さと同じになるようにすることができます。

Align プロパティのデフォルト値は alTop で，コントロールはフォームまたはパネル内の配置された場所から動きません。コントロールを位置合わせするには，別の値を指定します。次の値を指定できます。

値	意味

alNone	フォームまたはパネル内の配置場所からコンポーネントを移動しない。これがデフォルト値である

alTop	フォームの最上部にコンポーネントを移動し，フォームの幅いっぱいまでサイズ変更する。コンポーネントの高さは変わらない

alBottom	フォームの最下部にコンポーネントを移動し，フォームの幅いっぱいまでサイズ変更する。コンポーネントの高さは変わらない

alLeft	フォームの左端にコンポーネントを移動し，フォームの高さいっぱいまでサイズ変更する。コンポーネントの幅は変わらない

alRight	フォームの右端にコンポーネントを移動し，フォームの高さいっぱいまでサイズ変更する。コンポーネントの幅は変わらない

alClient	コンポーネントをフォームのクライアント領域いっぱいになるまでサイズ変更する。別のコンポーネントがすでにクライアント領域の一部を占めている場合，残りのクライアント領域いっぱいまでコンポーネントをサイズ変更する

注意

Align プロパティを alClient に設定した場合，コントロールがクライアント領域いっぱいに広がって親コントロールはクリックでは選択できなくなるので注意してください。その場合には，フォーム上のコントロールを選択して〔Esc〕キーを押すか，オブジェクトインスペクタを使って親コントロール選択してください。

1 つの親コンポーネント内の多数の子コンポーネントの Align プロパティを同じ値にして，フォームまたはパネルの一方の端に積み重ねるように配置することもできます。子コントロールは Z オーダーに従って積み重ねられます。コントロールの位置を変更するには，Align プロパティを alNone に設定してからコントロールを目的の位置までドラッグします。


TControl.BoundsRect
TControl.BoundsRect3073005

TControl	参照

BoundsRect プロパティは，コントロールの外接長方形を親コントロールの座標系で表した値です。

TRect = record

  case Integer of

    0: (Left, Top, Right, Bottom: Integer);

    1: (TopLeft, BottomRight: TPoint);

end;

property BoundsRect: TRect;

説明

BoundsRect プロパティは，コントロールの四隅の位置をピクセル数で一度に取得できます。

たとえば，次の文は

R := Control.BoundsRect;

次のコードと同じです。

R.Left := Control.Left;

R.Top := Control.Top;

R.Right := Control.Left + Control.Width;

R.Bottom := Control.Top + Control.Height;

TRect 型は長方形を定義します。座標は上下左右の辺のピクセル位置を表す別々の 4 つの整数としてか，または左上隅と右下隅のピクセル位置を表す 2 つの点として指定されます。ピクセル座標系の原点は親ウィンドウの左上隅です。


TControl.Caption
TControl.Caption3073006

TControl	参照

Caption プロパティは，ユーザーがコントロールを識別できるようにするためのテキスト文字列を指定します。

TCaption = type string;

property Caption: TCaption;

説明

Caption プロパティを使うと，コントロールに識別のための文字列を関連付けることができます。

ほとんどのコントロールの場合，Caption はウィンドウタイトルであり，コントロールのラベルとして表示されます。

コンポーネントのラベルとなっている Caption 内の文字に下線を付けるには，文字の前にアンド記号（&）を指定します。このような文字をアクセラレータ文字といいます。〔Alt〕キーを押しながら下線付き文字を入力すると，そのコンポーネントを選択できます。アンド記号をキャプションに表示するには，アンド記号を 2 つ使います（&&）


TControl.ClientHeight
TControl.ClientHeight3073007

TControl	参照

ClientHeight プロパティは，コントロールのクライアント領域の高さをピクセル数で指定します。

property ClientHeight: Integer;

説明

ClientHeight プロパティは，コントロールのクライアント領域の高さを取得および設定できます。

TControl の場合，ClientHeight は Height と同じです。派生クラスの場合，ClientHeight プロパティが Height とは異なることもあります。たとえば，フォームの ClientHeight は，Height からタイトルバーとサイズ変更境界とスクロールバーの高さを引いた値になります。


TControl.ClientOrigin
TControl.ClientOrigin3073008

TControl	参照

ClientOrigin プロパティは，コントロールのクライアント領域の左上隅の画面座標（ピクセル単位）です。

TPoint = record

  X: Longint;

  Y: Longint;

end;

property ClientOrigin: TPoint;

説明

ClientOrigin プロパティは，コントロールのクライアント領域の左上隅の画面座標を取得できます。ClientOrigin は Point 型のレコードに左上隅を原点とした XY 座標を返します。X は水平方向の座標を表し，Y は垂直方向の座標を表します。

TWinControl ではなく TControl から派生したコントロールの画面座標は，コントロールの親の画面座標に Left および Top プロパティ値を加えた値になります。親コントロールのないコントロールで ClientOrigin プロパティを読み出すと，EInvalidOperation 例外が生成されます。


TControl.ClientRect
TControl.ClientRect3073009

TControl	参照

ClientRect プロパティは，コントロールのクライアント領域のサイズをピクセル数で返します。

TPoint = record

  X: Longint;

  Y: Longint;

end;

TRect = record

  case Integer of

    0: (Left, Top, Right, Bottom: Integer);

    1: (TopLeft, BottomRight: TPoint);

end;

property ClientRect: TRect;

説明

ClientRect プロパティは，コントロールのクライアント領域のサイズを調べるときに使います。ClientRect は，矩形領域の Top と Left フィールドを 0，Bottom と Right フィールドをコントロールの Height と Width とした値を返します。ClientRect は Rect(0, 0, ClientWidth, ClientHeight）と同じです。

Rect 型は長方形を定義します。座標は上下左右の辺のピクセル位置を表す別々の 4 つの整数としてか，または左上隅と右下隅のピクセル位置を表す 2 つの点として指定されます。


TControl.ClientWidth
TControl.ClientWidth3073010

TControl	参照

ClientWidth プロパティは，コントロールのクライアント領域の水平方向のサイズをピクセル数で指定します。

property ClientWidth: Integer;

説明

ClientWidth プロパティは，コントロールのクライアント領域の幅を取得および設定できます。ClientWidth は ClientRect.Right と同じになります。


TControl.Color
TControl.Color3073011

TControl	参照

Color プロパティは，コントロールの背景色を指定します。

property Color: TColor;

説明

Color プロパティは，コントロールの背景色を取得および設定できます。Color は RGB 値でも，Graphics ユニットで定義された定数のいずれでもかまいません。Color に RGB 値を指定した場合，下位の 3 バイトはそれぞれ青，緑，赤の RGB カラーの輝度を表します。

次の定義済み定数を指定できます。

値	意味

clBlack	黒色

clMaroon	栗色

clGreen	緑色

clOlive	黄緑色

clNavy	濃紺色

clPurple	紫色

clTeal	暗青緑色

clGray	灰色

clSilver	銀色

clRed	赤色

clLime	濃緑色

clBlue	青色

clFuchsia	赤紫色

clAqua	空色

clWhite	白色

clBackground	Windows のデスクトップの背景の現在の色

clActiveCaption	アクティブウィンドウのタイトルバーの現在の色

clInactiveCaption	アクティブでないウィンドウのタイトルバーの現在の色

clMenu	メニューの現在の背景色

clWindow	ウィンドウの現在の背景色

clWindowFrame	ウィンドウ枠の現在の色

clMenuText	メニュー上のテキストの現在の色

clWindowText	ウィンドウ内のテキストの現在の色

clCaptionText	アクティブウィンドウのタイトルバー上のテキストの現在の色

clActiveBorder	アクティブウィンドウの現在の境界色

clInactiveBorder	アクティブでないウィンドウの現在の境界色

clAppWorkSpace	アプリケーション作業領域の現在の色

clHighlight	選択したテキストの現在の背景色

clHightlightText	選択したテキストの現在の色

clBtnFace	ボタン面の現在の色

clBtnShadow	ボタンのシャドウキャストの現在の色

clGrayText	淡色表示されているテキストの現在の色

clBtnText	ボタンのテキストの現在の色

clInactiveCaptionText	アクティブでないウィンドウのタイトルバーのテキストの現在の色

clBtnHighlight	ボタンの強調表示の現在の色

cl3DDkShadow 	Windows 95 または NT 4.0 のみ。3 次元表示要素の暗い影

cl3DLight 	Windows 95 または NT 4.0 のみ。3 次元表示要素の明るい色（明るい面の縁用）

clInfoText 	Windows 95 または NT 4.0 のみ。ツールチップコントロールのテキストの色

clInfoBk 	Windows 95 または NT 4.0 のみ。ツールチップコントロールの背景色

このカラーリストの後半は Windows システムの色です。どの色が表示されるかは Windows にどのカラー体系を使っているかで異なります。Windows システムの色はコントロールパネルを使って変更できます。実際に表示される色はシステムによって異なります。たとえば，同じ clBtnFace を指定しても，ユーザーが使用しているカラー体系しだいで，灰色が表示される場合もあれば，褐色が表示される場合もあります。

注意

コントロールの ParentColor プロパティ が True ならば，コントロールの親の Color プロパティを変更するとコントロールの Color プロパティも自動的に変わります。コントロールの Color プロパティに値を指定すると，コントロールの ParentColor プロパティは自動的に False になります。


TControl.ControlState
TControl.ControlState3073012

TControl	参照

ControlState プロパティは，実行時にコントロールの現在の状態を示す値の集合を保持します。

type

  TControlState = set of (csLButtonDown, csClicked, csPalette, csReadingState,

    csAlignmentNeeded, csFocusing, csCreating);

property ControlState: TControlState;

説明

ControlState プロパティは，クリックされたか，位置合わせが必要かなどのコントロールに影響をするさまざまな状態を調べることができます。ControlState は，コントロールクラス全体としての属性ではなく，コントロールのインスタンスの変化する条件を表します。ControlState は以下のフラグの集合から構成されます。

フラグ	意味

csLButtonDown	左マウスボタンがクリックされたが，ボタンが押されたままの状態。これはすべてのマウスダウンイベントについて設定される

csClicked	csLButtonDown と同じだが ControlStyle に csClickEvents が入っている場合，つまりマウスダウンイベントがクリックとして解釈される場合にだけ設定される

csPalette	コントロールまたはその親によって WM_PALETTCHANGED メッセージが受け取られた

csReadingState	コントロールは自分の状態をストリームから読み出し中である

csAlignmentNeeded	コントロールは位置合わせが再び可能になった時点で自分自身を位置合わせし直す必要がある

csFocusing	アプリケーションはコントロールにフォーカスを与えるためのメッセージを処理中である。コントロールがフォーカスを受け取るとは保証されないが，再帰呼び出しは防止される

csCreating	コントロールまたはコントロールのオーナー（あるいはその両方）と下位コントロールを作成中である。このフラグはすべての作成が終わった時点でクリアされる

csPaintCopy	コントロールを複製中，つまりコントロールのコピーを作成中である。この状態が発生するためには，ControlStyle の csReplicatable がセットされている必要がある

ControlState 内のすべてのフラグはコントロール固有のフラグであり，すべてのコンポーネントに適用される ComponentState プロパティ内の状態フラグに追加されるフラグです。

ControlState を使うのは，主に TControl からコンポーネントを派生させるときです。


TControl.ControlStyle
TControl.ControlStyle3073013

TControl	参照

ControlStyle プロパティは，コントロールのスタイルの特定の属性を示す値の集合を保持します。

type

  TControlStyle = set of (csAcceptsControls, csCaptureMouse, csDesignInteractive, csFramed,

    csClickEvents, csSetCaption, csOpaque, csDoubleClicks, csFixedWidth, csFixedHeight,

    csNoDesignVisible, csReplicatable, csNoStdEvents, csDisplayDragImage, csReflector);

property ControlStyle: TControlStyle;

説明

ControlStyle プロパティは，コントロールがマウスイベントをキャプチャするかどうか，コントロールが固定サイズかどうかなどのコントロールの各種の属性を調べることができます。ControlStyle プロパティにはこれらの属性を示す一連のスタイルフラグが入っています。以下に各フラグの意味を示します。

フラグ	意味

csAcceptsControls	コントロールは設計時にそのコントロールの上へドロップされたコントロールの親になる

csCaptureMouse	マウスをクリックしたとき，コントロールはマウスイベントをキャプチャする

csDesignInteractive	コントロールは設計時に右マウスボタンクリックをコントロールを操作する左ボタンクリックにマップする

csClickEvents	コントロールはマウスクリックを受け取って応答できる

csFramed	コントロールは 3 次元の枠を持つ

csSetCaption	コントロールは別のキャプションが明示的に指定されていなければ，キャプションを Name プロパティに一致するよう変更する

csOpaque	コントロールはクライアント矩形領域いっぱいに描画される

csDoubleClicks	コントロールはダブルクリックメッセージを受け取って応答できる。あるいはダブルクリックをクリックへマップできる

csFixedWidth	コントロールの幅は変更またはスケーリングされない

csFixedHeight	コントロールの高さは変更またはスケーリングされない

csNoDesignVisible	設計時にコントロールは可視でない

csReplicatable	PaintTo メソッドを使ってコントロールのイメージを任意のキャンバスに描画できる

csNoStdEvents	マウス，キー，またはクリックイベントなどの標準イベントを無視する。この設定は，コードがこれらのイベントへの応答を必要としない場合に使用する。アプリケーションの実行速度が向上する

csDisplayDragImage	コントロールはコントロール上でマウスをドラッグしたときにイメージリストのイメージを表示できる。この設定は，コントロール上でのマウスのドラッグに対してコントロールがイメージリストを実現する場合に使用する

ControlStyle は通常，クラス全体を記述するので，すべてのインスタンスが影響を受けます。一般に，これらのフラグは同じ種類のコントロールのインスタンス間では同じであり，実行時にも変化しません。変化する条件は ControlState プロパティによって示されます。

TControl の Create メソッドは ControlStyle を初期化して csCaptureMouse，csClickEvents，csSetCaption，csDoubleClicks のいずれかの値に設定します。

ControlStyle を使うのは，主に TControl からコンポーネントを派生させるときです。


TControl.Cursor
TControl.Cursor3073014

TControl	参照

Cursor プロパティは，コントロールの対象領域上にマウスがあるときにマウスカーソルの表示に使うイメージです。

TCursor = -32768..32767;

property Cursor: TCursor;

説明

Cursor プロパティの値を変更すると，マウスポインタがコントロール上を通過しているときに，どのような操作が適切かをユーザーにフィードバックできます。

Cursor の値はグローバル変数 Screen によって保持されているカーソルのリスト内のカーソルのインデックスです。TScreen によって提供される組み込みのカーソルに加えて，アプリケーションはリストにカスタムカーソルを追加できます。TScreen によって提供される組み込みのカーソルの値を以下に示します。

値	イメージ	値	イメージ	値	イメージ

crDefault	crSizeNWSE	crAppStart

crNone	crSizeWE	crHelp

crArrow	crUpArrow	crMultiDrag

crCross	crHourGlass	crNo

crIBeam	crDrag	crSQLWait

crSize	crNoDrop	crHandPoint

crSizeNESW	crHSplit

crSizeNS	crVSplit

注意

カスタムカーソルを Cursors プロパティで利用できるようにする方法については TScreen オブジェクトの Cursors プロパティを参照してください。


TControl.DesktopFont
TControl.DesktopFont3073015

TControl	参照

DesktopFont プロパティは，コントロールがテキストを表示するときに Windows アイコンフォントを使うかどうかを指定します。

property DesktopFont: Boolean;

説明

DesktopFont プロパティを True に設定すると，コントロールが Font プロパティに Windows アイコンフォントを使うように指定できます。Windows アイコンフォントはグローバル Screen 変数の IconFont プロパティの値です。

DesktopFont が True ならば，コントロールの Font プロパティは，Windows アイコンフォントが変更されるたびに更新されます。このフォントはグローバル Screen 変数の IconFont プロパティを設定して，または他のプログラムのアクションによって変更できます。Font プロパティを Screen.IconFont に設定すると，コントロールはこのような方法で Windows アイコンフォントの変更に応答できなくなります。


TControl.DragCursor
TControl.DragCursor3073016

TControl	参照

DragCursor プロパティは，コントロールがドラッグされているときに表示されるマウスポインタを表すイメージを保持します。

TCursor = -32768..32767;

property DragCursor: TCursor;

説明

DragCursor プロパティは，コントロールがドラッグされているときに表示されるカーソルイメージを変更できます。DragCursor プロパティに指定できる値は，Cursor プロパティと同じです。Cursor プロパティを参照して下さい。

注意

カスタムカーソルを DragCursor プロパティで利用できるようにする方法については TScreen オブジェクトの Cursors プロパティを参照してください。


TControl.DragMode
TControl.DragMode3073017

TControl	参照

DragMode プロパティは，コントロールのドラッグアンドドロップの方法を決めます。

TDragMode = (dmManual, dmAutomatic);

property DragMode: TDragMode;

説明

DragMode プロパティは，ユーザーがいつコントロールをドラッグできるかを制御できます。実行時にドラッグアンドドロップ機能を無効にするには DragMode プロパティの値を dmManual に変更します。

次の値を指定できます。

値	意味

dmAutomatic	dmAutomatic を選択するとコントロールはいつでもドラッグできる。ユーザーはコントロールをクリックしドラッグするだけでよい

dmManual	dmManual を選択するとアプリケーションが BeginDrag メソッドを呼び出すまでコントロールをドラッグできない


TControl.Enabled
TControl.Enabled3073018

TControl	参照

Enabled プロパティは，コントロールがマウス，キーボード，タイマーのいずれかのイベントに応答するかどうかを制御します。

property Enabled: Boolean;

説明

Enabled プロパティは，ユーザーがコントロールを使えるかどうかを変更できます。コントロールを無効にするには，Enabled プロパティを False に設定します。応答しないように設定したコントロールは淡色表示されます。Enabled が False ならば，コントロールはマウスイベントとキーボードイベントを無視し，タイマーコントロールの場合は OnTimer イベントを無視します。

無効にしたコントロールを有効に戻すには，Enabled を True に設定し直します。コントロールは淡色表示されなくなり，ユーザーがそのコントロールを使用できるようになります。


TControl.Font
TControl.Font3073019

TControl	参照

Font プロパティは，コントロールに表示するテキストの属性を制御します。

property Font: TFont;

説明

新しいフォントに変更する場合は，新しい TFont オブジェクトを指定します。フォントの属性を変更する場合は，TFont オブジェクトの Color，Height，Name，Pitch，Size，Style 値を変更します。


TControl.Height
TControl.Height3073020

TControl	参照

Height プロパティは，コントロールの縦方向のサイズをピクセル数で示します。

property Height: Integer;

説明

Height プロパティは，コントロールの高さを取得または変更できます。


TControl.Hint
TControl.Hint3073021

TControl	参照

Hint プロパティは，マウスポインタがコントロール上を移動するときに表示されるテキスト文字列を保持します。

property Hint: string;

説明

Hint プロパティは，ヘルプヒントとしてヘルプテキストを表示したり，ステータスバーなどの特定の場所にヘルプテキストを表示したりすることができます。

ヘルプヒントは，マウスポインタをコントロールに移動し 1～2 秒停止したときにヘルプテキストを表示するボックスです。コントロールのヘルプヒントが現れるようにするには次のようにします。

1.	ヘルプヒントを表示する各コントロールの Hint プロパティを指定します。

2.	各コントロールの ShowHint プロパティを True に設定するか，またはすべてのコントロールの ParentShowHint プロパティを True に設定して，フォームの ShowHint プロパティを True に設定します。

3.	実行時にアプリケーションの ShowHint プロパティの値を True に設定します。

ヒントをステータスバーなどの場所に表示させたい場合は，アプリケーションの OnHint イベントハンドラを使います。マウスポインタがコントロール上で移動すると，アプリケーションの OnHint イベントが発生します。ステータスバーとして使用されるパネルコンポーネントのキャプションとしてヒントを表示するように OnHint イベントハンドラを記述します。

ヘルプヒントボックスと OnHint ハンドラに使うヒントを，2 つの値を | （縦線）で区切ってアプリケーションの Hint プロパティ値として指定できます。次の例を参照してください。

Edit1.Hint := 'Name|Enter Name in the edit box';

ヘルプヒントボックスには「Name」, ステータスバーには「Enter Name in the edit box」が表示されます。

値を 1 つだけ指定すると，アプリケーションのヘルプヒントと Hint プロパティの両方にその値が使われます。アプリケーションの ShowHint プロパティ が False ならばヘルプヒントを除いたヒントだけが表示されます。ただし，その場合でも OnHint イベントハンドラは呼び出されます。

コントロールの Hint 値を指定しなくても，その親コントロールに Hint 値を指定している場合は，コントロールはその ShowHint プロパティが True に設定されているかぎり親コントロールの Hint 値を使います。


TControl.IsControl
TControl.IsControl3073022

TControl	参照

IsControl プロパティは，フォームがフォーム特有のプロパティをストリームに保存するかどうかを指定します。

property IsControl: Boolean;

説明

IsControl プロパティは，フォームをデスクトップフォームとしてではなく複雑なコントロールとして使用できます。IsControl はフォームの保存方法に影響を及ぼします。IsControl が True ならば，フォーム特有のプロパティはフォームとともに保存されません。IsControl が False ならば，フォーム特有のプロパティは他のプロパティと同様に保存されます。

IsControl を使えばフォームデザイナを使って，パネルなどの複雑なコントロールを作成できます。そのためには，まずそれらのコントロールをフォームとして作成し，中に入れるコントロールを配置して名前を付けコードをイベントにアタッチします。フォームを保存した後でフォームをテキストとして編集し，テキストバージョンで IsControl を True に設定します。次にそのフォームをロードして保存するときには,コントロールとして使用するのに適切なフォームプロパティだけが保存され，TForm に特有なプロパティは保存されません。次に，フォームファイルをテキストとして編集し, コンポーネントフォームの型を TForm から TPanel などの型に変更します。


TControl.Left
TControl.Left3073023

TControl	参照

Left プロパティは，コンポーネントの左端の水平座標としてフォームに対する相対距離を表すピクセル数です。

property Left: Integer;

説明

Left プロパティは，コントロールの左端がどの位置から始まるかを判定したり，コントロールの左端の位置を変更したりすることができます。

コントロールが Tpanel などの他のコントロール内にある場合，Left プロパティと Top プロパティはその親コントロールに対する相対座標になります。コントロールがフォームに直接保持されている場合はフォームに対する相対座標になります。フォームの場合，Left プロパティは画面での相対座標をピクセル数で表します。


TControl.MouseCapture
TControl.MouseCapture3073024

TControl	参照

MouseCapture プロパティは，コントロールがマウスイベントをキャプチャしたかどうかを示します。

property MouseCapture: Boolean;

説明

MouseCapture プロパティは，コントロールがマウスイベントをキャプチャ（捕捉）したかどうかを判別できます。。コントロールがマウスをキャプチャすると，それ以後のすべてのマウスイベントはユーザーがマウスを解放するまでそのコントロール（キャプチャコントロールと呼ばれる）へ送られます。

コントロールがキャプチャコントロールになるのは，ユーザーがそのコントロールから項目をドラッグしたときです。また，コントロールの ControlStyle プロパティ内で csCaptureMouse フラグが設定されている場合も，ユーザーがそのコントロール上で左マウスボタンを押すと，そのコントロールはユーザーがボタンから指を離すまでの間キャプチャコントロールになります。


TControl.Name
TControl.Name3073025

TControl	参照

Name プロパティは，アプリケーションのコードで参照されるコントロールの名前を示します。

TComponentName: string;

property Name: TComponentName;

説明

Name プロパティは，コントロールに新しい名前を付けたり，コントロールの名前を調べたりすることができます。

デフォルトでは，IDE は Button1，Button2 などのように，コントロールの種類に番号を付けた名前を順番に割り当てます。このような名前をわかりやすい名前に変更すれば，アプリケーションのコードは読みやすくなります。Name は有効な Object Pascal 識別子でなければなりません。コントロールの Caption に変更を加えていない場合は，Caption が設定した新しい名前に変更されます。

注意

コンポーネント名は設計時にのみ変更できます。


TControl.Parent
TControl.Parent3073026

TControl	参照

Parent プロパティは，コントロールの親の名前を示し，コントロールの表示場所を指定します。

property Parent: TWinControl;

説明

Parent プロパティは，コントロールの親を判別したり，コントロールを別のコントロールの親に設定したりすることができます。新しいコントロールを作成する場合，新しいコントロールに Parent プロパティ値を割り当てなくてはなりません。通常，これは別のコントロールが入るように設計されたフォーム，パネル，グループボックスなどのコントロールです。コントロールの親を変更すると，コントロールは新しい親コントロール内に表示されるように移動されます。

コントロールの親はそのコントロールが入っているウィンドウコントロールです。コントロール（親）の中にコントロールが入っている場合，中のコントロールは親の子コントロールです。たとえば，アプリケーションでグループボックスに 3 つのラジオボタンが入っている場合，そのグループボックスは 3 つのラジオボタンの親であり，ラジオボタンはグループボックスの子コントロールです。

TControl で宣言される Parent プロパティと，TComponent で宣言される Owner プロパティとを混同しないでください。コントロールの Parent は常に視覚的にそのコントロールが入っているウィンドウコントロールです。コンポーネントの Owner はコンストラクタでパラメータとして渡されたコンポーネントで，そのコンポーネントを構成要素として使います。


TControl.ParentColor
TControl.ParentColor3073027

TControl	参照

ParentColor プロパティは，コントロールの色情報を探す場所を決めます。

property ParentColor: Boolean;

説明

コントロールが親コンポーネントと同じ色を使うにするには，ParentColor を True に設定します。たとえば，パネル上のリストボックスの ParentColor が True の場合，リストボックスはパネルと同じ色になります。ParentColor が False の場合，コントロールは自身の Color プロパティを使用します。

すべてのコントロールで ParentColor を True に設定すると，フォーム上のすべてのコントロールを同じ外観にできます。たとえば，フォーム上のすべてのコントロールの ParentColor が True の場合，フォームの背景色を灰色に変更すると，そのフォーム上のすべてのコントロールの背景も灰色になります。

特定のコントロールに異なる色を指定するには，求める色をそのコントロールの Color プロパティに割り当てれば ParentColor が自動的に False になります。


TControl.ParentFont
TControl.ParentFont3073028

TControl	参照

ParentFont プロパティは，コントロールのフォント情報を探す場所を決めます。

property ParentFont: Boolean;

説明

コントロールが親コンポーネントと同じフォントを使うにするには，ParentFont を True に設定します。たとえば，パネル上のリストボックスの ParentFont が True の場合，リストボックスはパネルと同じフォントを使用します。ParentFont が False の場合，コントロールは自身の Font プロパティを使用します。

すべてのコントロールで ParentFont を True に設定すると，フォーム上のすべてのコントロールを同じ外観にできます。たとえばフォーム内のすべてのコントロールの ParentFont を 12 ポイントの Courier に指定すると，フォーム上のすべてのコントロールがそのフォントを使用するようになります。

特定のコントロールに異なるフォントを指定するには，そのコントロールの Font プロパティを変更すれば ParentFont が自動的に False になります。

フォームの ParentFont が True ならば，そのフォームはアプリケーションの Font プロパティの値を使います。


TControl.ParentShowHint
TControl.ParentShowHint3073029

TControl	参照

ParentShowHint プロパティは，ヘルプヒントがコントロールの Hint プロパティの値として指定されている場合，そのヘルプヒントを表示するかどうかを決める根拠を示します。

property ParentShowHint: Boolean;

説明

ParentShowHint プロパティを使うと，フォーム上のすべてのコントロールが一様にヘルプヒントを表示するか，または一様に表示しないかのいずれかにすることができます。

ParentShowHint が True ならば，コントロールは親の ShowHint プロパティ値を使います。ParentShowHint が False ならば，コントロールは自身の ShowHint プロパティ値を使います。

一部のコントロールだけにヘルプヒントを付けたい場合は，ヘルプヒントを付けたいコントロールの ShowHint プロパティだけを True にすれば ParentShowHint が自動的に False になります。

注意

アプリケーションオブジェクトの ShowHint プロパティを使うとアプリケーション全体のすべてのヘルプヒントを使用可能にしたり使用不可にしたりできます。


TControl.PopupMenu
TControl.PopupMenu3073030

TControl	参照

PopupMenu プロパティは，コントロールに関連付けられているポップアップメニューを識別します。

property PopupMenu: TPopupMenu;

説明

PopupMenu プロパティに値を割り当てると，ユーザーがコントロールを選択してマウスの右ボタンをクリックしたときにポップアップメニューが表示されるようにすることができます。TPopupMenu の AutoPopup が True の場合は，ポップアップメニューは自動的に表示されます。TPopupMenu の AutoPopup が False の場合は，ポップアップメニューは Popup メソッドを呼び出して表示します。


TControl.ScalingFlags
TControl.ScalingFlags3073031

TControl	参照

ScalingFlags プロパティは，コントロールのどの属性がまだスケール変更されていないのかを表します。

TScalingFlags = set of (sfLeft, sfTop, sfWidth, sfHeight, sfFont);

property ScalingFlags: TScalingFlags;

説明

ScalingFlags プロパティは，継承フォームおよびそのコントロールをスケール変更するときに使う内部フラグの集合です。どうしても必要な場合を除いて，アプリケーションでこのフラグを使用しないようにします。

以下にフラグとその意味を示します。

フラグ	意味

sfLeft	コントロールの左端がまだスケール変更されていない

sfTop	コントロールの上端がまだスケール変更されていない

sfWidth	コントロールの幅がまだスケール変更されていない

sfHeight	コントロールの高さがまだスケール変更されていない

sfFont	コントロールのフォームがまだスケール変更されていない


TControl.ShowHint
TControl.ShowHint3073032

TControl	参照

ShowHint プロパティは，ユーザーがマウスポインタをコントロール上に短時間だけ置いたときに，そのコントロールのヘルプヒントを表示するかどうかを決めます。

property ShowHint: Boolean;

説明

ヘルプヒントは Hint プロパティの値であり，コントロールのすぐ下のボックスに表示されます。ShowHint プロパティを使うと，コントロールのヘルプヒントを表示するかどうかが決められます。

特定のコントロールでヘルプヒントが表示されるようにするには，アプリケーションの ShowHint を True に設定し，さらに次のいずれかのようにプロパティを設定する必要があります。

・	コントロール自身の ShowHint プロパティを True に設定する

・	コントロールの ParentShowHint プロパティを True に，コントロールの親の ShowHint プロパティを True にそれぞれ設定する

たとえば，グループボックスの中にチェックボックスがあるとします。グループボックスの ShowHint プロパティが True でチェックボックスの ParentShowHint プロパティも True の場合，チェックボックスの ShowHint プロパティが False であってもチェックボックスのヘルプヒントは表示されます。

ShowHint の値を True に変更すると，ParentShowHint プロパティは自動的に False に設定されます。


TControl.Text
TControl.Text3073033

TControl	参照

Text プロパティは，コントロールに関連付けられているテキスト文字列を保持します。

TCaption = type string;

property Text: TCaption;

説明

Text プロパティは，コントロールの Text を取得したり，Text 値に新しい文字列を指定したりすることができます。デフォルトでは，Text はコントロール名です。編集コントロールおよびメモコントロールの場合,Text 値はコントロール内に表示されます。コンボボックスの場合，Text 値はコンボボックスの編集コントロール部分の内容です。


TControl.Top
TControl.Top3073034

TControl	参照

Top プロパティは，ピクセル単位でコントロールの左上隅の，親またはコンテナコントロールに対する距離の Y 座標です。

property Top: Integer;

説明

Top プロパティは，コントロールの上端を調べたり，コントロールを垂直方向に配置し直したりすることができます。Top プロパティは，Left と同様で，そのコントロールのコンテナに対するコントロールの相対位置です。したがって，コントロールが TPanel に含まれている場合，Left プロパティと Top プロパティはパネルを基準にします。コントロールがフォームに直接含まれている場合はフォームを基準とします。フォームの場合，Top プロパティの値はピクセル単位で画面を基準にします。


TControl.Visible
TControl.Visible3073035

TControl	参照

Visible プロパティは，コンポーネントを画面上に表示するかどうかを決めます。

property Visible: Boolean;

説明

Visible プロパティは，実行時にコントロールを表示するかしないかを制御できます。Visible が True ならば，コントロールは表示されます。Visible が False ならば，コントロールは表示されません。

Show メソッドを呼び出すとコントロールの Visible プロパティが True になります。Hide メソッドを呼び出すとコントロールの Visible プロパティは False になります。


TControl.Width
TControl.Width3073036

TControl	参照

Width プロパティは，コントロールまたはフォームの水平サイズをピクセル単位で決めます。

property Width: Integer;

説明

Width プロパティを使うと，コントロールの幅を取得または変更できます。

注意

TabSheet コントロールの場合，実行時にこのプロパティを変更しても無効です。


TControl.WindowProc
TControl.WindowProc3073037

TControl	参照

WindowProc プロパティには，コントロールに送られたメッセージに応答するウィンドウプロシージャが入ります。

TWndMethod = procedure(var Message: TMessage) of object;

property WindowProc: TWndMethod;

説明

WindowProc プロパティを使うと，コントロールのウィンドウプロシージャを一時的に置換するか，またはサブクラス化することができます。下位クラス用にウィンドウプロシージャをカスタマイズしてコンポーネントを作成する場合は，かわりに WndProc メソッドをオーバーライドします。

WindowProc に新しい値を割り当てる前に，元の値を保存してください。WindowProc は最初に WndProc メソッドに設定されるので，それ以降に値が変更されていない場合は元の値を保存する必要はありません。WindowProc の新しい値として使われるプロシージャ内で，未処理のメッセージを WindowProc の値だった元のプロシージャに渡します。特殊なメッセージ処理をすべて完了した後で,WindowProc の値を元のプロシージャに戻します。


TControl.WindowText
TControl.WindowText3073038

TControl	参照

WindowText プロパティは，コントロールのテキスト文字列を保持します。

property WindowText: PChar;

説明

WindowText プロパティを使うと，コントロールに関連付けられている文字列を判別できます。WindowText を設定するとき，コントロールは新しい値を割り当てる前に，WindowText の以前の値に関連付けられているメモリを解放します。コントロールを破棄すると，WindowText に関連付けられているメモリはすべて解放されます。

デフォルトでは，WindowText は Text プロパティと同じ文字列です。TControl の下位オブジェクトは Text プロパティをオーバーライドして異なる値を実装できます。

編集ボックスの場合，WindowText はコントロールの内容です。コンボボックスの場合，WindowText は編集ボックス部分の内容です。ボタンの場合，WindowText はボタン名です。その他のコントロールの場合，WindowText はウィンドウタイトルです。


TControl イベント3073039

TControl	アルファベット順	凡例

TControl

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TControl イベント3073040

TControl	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TControl.OnClick
TControl.OnClick3073041

TControl	参照

OnClick イベントは，ユーザーがコントロールをクリックしたときに発生します。

TNotifyEvent = procedure (Sender: TObject) of object;

property OnClick: TNotifyEvent;

説明

OnClick イベントハンドラは，クリックイベントに応答するコードを記述できます。

通常，OnClick イベントはマウスポインタをコントロール上に置いて左マウスボタンを押して指を離したときに発生します。このイベントは次のときにも発生します。

・	グリッド，アウトライン，リスト，コンボボックスのいずれかの項目を選択するために矢印キーを押した

・	ボタンまたはチェックボックスにフォーカスがあるときに〔Space〕キーを押した

・	アクティブフォームに（Default プロパティで指定した）デフォルトボタンがあるときに〔Enter〕キーを押した

・	アクティブフォームに（Cancel プロパティで指定した）［キャンセル］ボタンがあるときに〔Esc〕キーを押した

・	ボタンまたはチェックボックスのアクセラレータキーを押した。たとえばチェックボックスの Caption プロパティの値が「&Bold」ならば実行時に B に下線が付き，そのチェックボックスの OnClick イベントはユーザーが〔Alt〕＋〔B〕キーを押したときに発生する

・	ラジオボタンの Checked プロパティが True に設定された

・	チェックボックスの Checked プロパティの値が変更された

・	メニュー項目の Click メソッドが呼び出された

フォームの場合，OnClick イベントはユーザーがフォームの空白領域または使用不可コンポーネントをクリックしたときに発生します。


TControl.OnDblClick
TControl.OnDblClick3073042

TControl	参照

OnDblClick イベントは，マウスポインタがコントロール上にある間にユーザーがマウスの左ボタンをダブルクリックしたときに発生します。

TNotifyEvent = procedure (Sender: TObject) of object;

property OnDblClick: TNotifyEvent;

説明

OnDblClick イベントハンドラは，ダブルクリックイベントに応答するコードを記述できます。


TControl.OnDragDrop
TControl.OnDragDrop3073043

TControl	参照

OnDragDrop イベントはユーザーがドラッグしているオブジェクトをドロップしたときに発生します。

TDragDropEvent = procedure(Sender, Source: TObject; X, Y: Integer) of object;

property OnDragDrop: TDragDropEvent;

説明

OnDragDrop イベントハンドラは，ユーザーがオブジェクトをドロップしたときに実行したい処理を指定できます。OnDragDrop イベントの Source パラメータはドロップされるオブジェクト，Sender はオブジェクトのドロップ先にあるコントロールです。X と Y のパラメータはコントロール上にあるマウスの座標です。


TControl.OnDragOver
TControl.OnDragOver3073044

TControl	参照

OnDragOver イベントはユーザーがコントロール上でオブジェクトをドラッグしたときに発生します。

TDragState = (dsDragEnter, dsDragLeave, dsDragMove);

TDragOverEvent = procedure(Sender, Source: TObject; X, Y: Integer; State: TDragState;

var Accept: Boolean) of object;

property OnDragOver: TDragOverEvent;

説明

OnDragOver イベントは，ユーザーがドロップするオブジェクトをそのコントロールが受け入れることを示すことができます。

OnDragOver イベントハンドラで，Accept パラメータを False に変更すると，ドラッグされたオブジェクトが受け入れられなくなります。Accept を True のままにしておくと，ユーザーがドラッグしたオブジェクトをコントロール上にドロップできます。

ユーザーがドラッグしたオブジェクトをドロップした場合にコントロールがそのオブジェクトを受け入れることを示すために，カーソルの形状が変わるようにするには，OnDragOver イベントの発生前にコントロールの DragCursor プロパティを変更します。

Source はドラッグされているオブジェクトで，Sender はコントロール自身，つまりドロップ先です。X と Y はピクセル単位の画面座標です。TDragState 型は他のコントロールに対してドラッグされるコントロールの状態を指定します。次の状態があります。

値	意味

dsDragEnter	マウスがコントロールに入った

dsDragMove	マウスがコントロール上で移動している

dsDragLeave	マウスがコントロールから離れた

注意

OnDragOver イベントハンドラ内では，Accept パラメータはデフォルトで True に設定されます。ただし，OnDragOver イベントハンドラがない場合は，Accept パラメータが False に変更されたときと同様に，コントロールはドラッグされたオブジェクトを受け入れません。


TControl.OnEndDrag
TControl.OnEndDrag3073045

TControl	参照

OnEndDrag イベントは，オブジェクトのドロップかドラッグの取り消しによってオブジェクトのドラッグが終了したときに発生します。

TEndDragEvent = procedure(Sender, Target: TObject; X, Y: Integer) of object;

property OnEndDrag: TEndDragEvent;

説明

OnEndDrag イベントハンドラは，ドラッグの停止時に実行したい特殊処理を指定できます。Sender はドラッグされているオブジェクト，Target は Sender のドラッグ先のオブジェクト，X と Y はピクセル単位の画面座標です。

OnEndDrag イベントは Sender によって受け取られます。ドラッグされたオブジェクトがドロップされ，コントロールによって受け入れられた場合，OnEndDrag イベントの Target パラメータはドロップを受け入れたオブジェクトを指します。オブジェクトが正しくドロップされなかった場合，Target の値は nil になります。


TControl.OnMouseDown
TControl.OnMouseDown3073046

TControl	参照

OnMouseDown イベントは，ユーザーがマウスポインタをコントロール上に置いてマウスボタンを押したときに発生します。

TMouseButton = (mbLeft, mbRight, mbMiddle);

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

TMouseEvent = procedure (Sender: TObject; Button: TMouseButton; Shift: TShiftState;

X, Y: Integer) of object;

property OnMouseDown: TMouseEvent;

説明

OnMouseDown イベントハンドラを使うと，マウスボタンを押した結果として何かの処理が実行されるようにすることができます。

OnMouseDown イベントハンドラは，左，右，中央のマウスボタンとシフトキー（およびそれらの組み合わせ）の状態に対して応答できます。シフトキーとは〔Shift〕，〔Ctrl〕,〔Alt〕キーの各キーです。X と Y は，Sender のクライアント領域内でのマウスポインタのピクセル座標です。


TControl.OnMouseMove
TControl.OnMouseMove3073047

TControl	参照

OnMouseMove イベントは，ユーザーがマウスポインタをコントロール上に置いてマウスポインタを移動したときに発生します。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

TMouseMoveEvent = procedure(Sender: TObject; Shift: TShiftState; X, Y: Integer) of object;

property OnMouseMove: TMouseMoveEvent;

説明

OnMouseMove イベントハンドラは，マウスポインタがコントロール内を移動したときに何かの処理が行われるようにすることができます。

OnMouseDown イベントハンドラの Shift パラメータを使えば，マウスボタンとシフトキー（およびそれらの組み合わせ）の状態に対して応答できます。シフトキーとは〔Shift〕，〔Ctrl〕，〔Alt〕キーの各キーです。X と Y は，Sender のクライアント領域内でのマウスポインタの新しい位置のピクセル座標です。


TControl.OnMouseUp
TControl.OnMouseUp3073048

TControl	参照

OnMouseUp イベントは，ユーザーがコンポーネント上にマウスポインタを置いて押したマウスボタンから指を離したときに発生します。

TMouseButton = (mbLeft, mbRight, mbMiddle);

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

TMouseEvent = procedure (Sender: TObject; Button: TMouseButton; Shift: TShiftState; X, Y: Integer) of object;

property OnMouseUp: TMouseEvent;

説明

OnMouseUp イベントハンドラを使うと，ユーザーがマウスボタンから指を離したときに特別の処理が実行されるようにすることができます。

OnMouseUp イベントハンドラは，左，右，中央のマウスボタンとシフトキー（およびそれらの組み合わせ）の状態に対して応答できます。シフトキーとは〔Shift〕，〔Ctrl〕,〔Alt〕キーの各キーです。X と Y は，Sender のクライアント領域内でのマウスポインタのピクセル座標です。


TControl.OnStartDrag
TControl.OnStartDrag3073049

TControl	参照

OnStartDrag イベントは，ユーザーがコントロール上でコントロールまたはコントロール内のオブジェクトを左クリックしてドラッグを開始したときに発生します。

TStartDragEvent = procedure (Sender: TObject; var DragObject: TDragObject) of object;

property OnStartDrag: TStartDragEvent;

説明

OnStartDrag イベントハンドラは，ユーザーがコントロールまたはコントロール内のオブジェクトのドラッグを開始したときに特別の処理が実行されるようにすることができます。Sender はコントロール自身，ドラッグされるコントロール，またはドラッグされるコントロールのコンテナになっているコントロールです。

OnStartDrag イベントハンドラは，TDragObject オブジェクトを作成して，DragObject パラメータにドラッグカーソル，または必要な場合はドラッグイメージリストを指定することができます。DragObject の場合，ドラッグ終了時に Free メソッドを呼び出す必要はありません。

OnStartDrag イベントハンドラが DragObject パラメータを nil に設定すると，TDragControlObject オブジェクトが自動的に作成され，そのコントロールのドラッグが開始されます。


TControl メソッド3073050

TControl	アルファベット順	凡例

TControl

BeginDrag

BringToFront

Changed

ChangeScale

Click

ClientToScreen

Create

DblClick

DefaultHandler

DefineProperties

Destroy

DoEndDrag

DoStartDrag

DragCanceled

DragDrop

Dragging

DragOver

EndDrag

GetClientOrigin

GetClientRect

GetDeviceContext

GetDragImages

GetPalette

GetParentComponent

GetPopupMenu

GetTextBuf

GetTextLen

HasParent

Hide

Invalidate

MouseDown

MouseMove

MouseUp

Notification

PaletteChanged

Perform

ReadState

Refresh

Repaint

ScreenToClient

SendCancelMode

SendToBack

SetBounds

SetDragMode

SetName

SetParent

SetParentComponent

SetTextBuf

SetZOrder

Show

Update

UpdateBoundsRect

VisibleChanging

WndProc

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TControl メソッド3073051

TControl	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Changed

ChangeScale

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Click

ClientToScreen

Create

DblClick

DefaultHandler

DefineProperties

Destroy

DestroyComponents

Destroying

Dispatch

DoEndDrag

DoStartDrag

DragCanceled

DragDrop

Dragging

DragOver

EndDrag

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetClientOrigin

GetClientRect

GetDeviceContext

GetDragImages

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetPalette

GetParentComponent

GetPopupMenu

GetTextBuf

GetTextLen

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Invalidate

MethodAddress

MethodName

MouseDown

MouseMove

MouseUp

NewInstance

Notification

PaletteChanged

Perform

ReadState

Refresh

RemoveComponent

Repaint

SafeCallException

ScreenToClient

SendCancelMode

SendToBack

SetBounds

SetDragMode

SetName

SetParent

SetParentComponent

SetTextBuf

SetZOrder

Show

Update

UpdateBoundsRect

VisibleChanging

WndProc


TControl.BeginDrag
TControl.BeginDrag3073052

TControl	参照

BeginDrag メソッドは，コントロールのドラッグを開始します。

procedure BeginDrag(Immediate: Boolean);

説明

BeginDrag メソッドを呼び出すと，ドラッグ操作の開始を制御できます。コントロールの DragMode プロパティが dmManual の場合，ドラッグを開始するには BeginDrag メソッドを呼び出さなくてはなりません。

Immediate パラメータが True ならばマウスポインタは DragCursor プロパティの値に変わりすぐにドラッグが始まります。Immediate が False ならばマウスポインタは DragCursor プロパティの値に変わらず，マウスポインタを少し（5 ピクセルほど）移動するとドラッグが始まります。つまり，ドラッグする前にコントロールでマウスクリックの受け付けができます。


TControl.BringToFront
TControl.BringToFront3073053

TControl	参照

BringToFront メソッドは，コントロールを親コントロール内のそれ以外のすべてのコントロールの前に移動します。

procedure BringToFront;

説明

BringToFront はフォームが見えるようにするのに便利です。フォーム内の重複しているコントロールを再度順序付けることもできます。

コントロールの重なる順序（Z オーダーといいます）はコントロールをフォームに配置した順番によって決まります。たとえば，ラベルとイメージを積み重ねてフォームに配置すると，最初に指定した方が下になります。ラベルとイメージはどちらも非ウィンドウコントロールなので，指定した順に「重なり」ます。下にあるオブジェクトに対して BringToFront メソッドを呼び出すと，そのオブジェクトが上に表示されます。

ウィンドウコントロールのスタック順も同じです。たとえばフォームにメモを指定してからチェックボックスを指定すると，チェックボックスの方が上になります。メモに対して BringToFront を呼び出すとメモが上になります。

ウィンドウコントロールと非ウィンドウコントロールを混ぜて重ねることはできません。たとえばフォームにメモ（ウィンドウコントロール）を入れてからラベル（非ウィンドウコントロール）をメモの上に入れると，ラベルはメモの後ろに隠れてしまいます。ウィンドウコントロールは必ず非ウィンドウコントロールの上に重なります。ラベルに対して BringToFront メソッドを呼び出してもメモの後ろに隠れたままです。


TControl.Changed
TControl.Changed3073054

TControl	参照

Changed メソッドは，コントロールに CM_CHANGED メッセージを送信します。

procedure Changed;

説明

Changed メソッドは，親オブジェクトのプロパティに影響を及ぼすコントロールのプロパティに対して変更を加えた後で呼び出します。Changed はコントロールに CM_CHANGED メッセージを送信します。コントロールがウィンドウコントロールの場合，このメッセージは必要な調整を行えるように親に渡されます。


TControl.ChangeScale
TControl.ChangeScale3073055

TControl	参照

ChangeScale メソッドは，コントロールの位置とサイズを指定した割合で変更します。

procedure ChangeScale(M, D: Integer); dynamic;

説明

ChangeScale メソッドは，スケール変更を実行できます。ChangeScale はコントロールの位置とサイズを変更します。したがって，ChangeScale ではコントロールの Top，Left，Width，Height プロパティも変更されます。

M および D パラメータはコントロールをスケール変更する際のパーセンテージを定義します。M パラメータは乗数で D パラメータは除数です。たとえばコントロールを元のサイズの 75％にしたければ M の値を 75，D の値を 100 として指定します（75/100）。M の値を 3，D の値を 4 に指定しても同じ結果が得られます（3/4）。どちらの分数も等しいのでコントロールは同じ量，つまり 75％にスケール変更されます。

コントロールを以前のサイズより 33％だけ大きくしたければ，M の値を 133，D の値を 100 に指定します（133/100）M の値を 4，D の値を 3 に指定しても分数 133/100 は 4/3 とほぼ等しいので同じ結果が得られます。

TControl から派生したコントロールは ChangeScale をオーバーライドする必要があります。たとえば，追加のフォントプロパティを定義するコントロールは，コントロールのすべてのフォントが一様にスケール変更されるように，M/D 比を使ってフォントの高さを変更する必要があります。同様に，クライアント領域を複数の表示領域に分割してそれらの領域にテキストを表示するコントロールは，フォントのサイズが変更されたら表示領域のサイズも変更されるように，ChangeScale をオーバーライドする必要があります。

注意

コントロールのサイズと座標は整数なので，それらを M/D 比を使ってスケール変更すると ある程度の切り捨てエラーが起こることがあります。繰り返し ChangeScale 呼び出すと，ある時点でそのコントロールは消滅してしまったり（切り捨てエラーによりコントロールが小さくなる場合），フォームからはみ出てしまったり（切り捨てエラーによりコントロールの位置が移動する場合）することがあります。コントロールを繰り返しスケール変更するときは，数回行ったら，フォームを破棄してロードし直すようにすれば，切り捨てエラーが累積することなく座標のスケール変更が行えます。


TControl.Click
TControl.Click3073056

TControl	参照

Click メソッドは，コントロールの OnClick イベントにアタッチされたイベントハンドラを呼び出します。

procedure Click; dynamic;

説明

TControl の中で定義されている Click メソッドは OnClick イベントにアタッチされたイベントハンドラを呼び出す以外は何もしません。このメソッドはコントロールの OnClick イベントのためのプロテクトメソッドです。Click をオーバーライドすれば，継承されたイベントハンドラ呼び出しのほかにも応答処理ができます。

コントロールは左ボタンマウスアップメッセージ（WM_LBUTTONUP）を受け取った場合，そのマウスアップがそれに対応するマウスダウンの近くで起きたならば Click を呼び出します。特定のコントロールの多くは，その他の状況，たとえばユーザーがボタンまたはメニュー項目のショートカットキーを入力したときなどにも Click を呼び出します。

クリックイベントが発生するすべての事例は OnClick イベントの説明の中に示してあります。


TControl.ClientToScreen
TControl.ClientToScreen3073057

TControl	参照

ClientToScreen メソッドは，点のクライアント領域座標をグローバルな画面座標に変換します。

TPoint = record

  X: Longint;

  Y: Longint;

end;

function ClientToScreen(const Point: TPoint): TPoint;

説明

ClientToScreen メソッドは，コントロールに対してローカルな座標で表されていた位置を，画面座標の対応する位置に変換できます。クライアント領域座標の（0，0）はコントロールのクライアント領域の左上隅に相当します。画面座標の（0，0）は画面の左上隅に相当します。

ClientToScreen と ScreenToClient メソッドを使うとコントロールの座標系を別のコントロールの座標系に変換できます。

P := TargetControl.ScreenToClient(SourceControl.ClientToScreen(P));

この例は P を SourceControl の座標から TargetControl の座標に変換します。


TControl.Create
TControl.Create3073058

TControl	参照

Create メソッドは，TControl のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，TControl のインスタンスを作成および初期化できます。

継承されたメソッドを呼び出した後で，Create は以下のプロパティを初期化します。

・	Color を clWindow に設定する

・	ControlStyle を csCaptureMouse，csClickEvents，csSetCaption，csDoubleClick のいずれかに設定する

・	DragCursor を crDrag に設定する

・	Enabled と Visible を True に設定する

・	IsControl を False に設定する

・	ParentColor，ParentFont，ParentShowHint を True に設定する

Create をオーバーライドするときは，必ず最初に継承された Create メソッドを呼び出してからコントロールを初期化します。Create メソッドをオーバーライドするときは，必ず override 指令を追加します。

コンポーネントの Create メソッドがリソースまたはメモリを割り当てた場合は，それらのリソースを解放するために Destroy メソッドもオーバーライドする必要があります。


TControl.DblClick
TControl.DblClick3073059

TControl	参照

DblClick メソッドは，コントロールの OnClick イベントにアタッチされたイベントハンドラを呼び出します。

procedure DblClick; dynamic;

説明

TControl から継承された DblClick メソッドは OnDblClick イベントにアタッチされたイベントハンドラを呼び出す以外は何もしません。DblClick メソッドはコントロールの OnDblClick イベントのためのプロテクトメソッドです。DblClick をオーバーライドすれば，継承されたイベントハンドラ呼び出しのほかにも応答処理ができます。

コントロールは Windows からの左ボタンダブルクリックメッセージ（WM_LBUTTONDBLCLK）への応答として DblClick メソッドを呼び出します。


TControl.DefaultHandler
TControl.DefaultHandler3073060

TControl	参照

DefaultHandler メソッドは，コントロールが特定のハンドラを持たないメッセージを処理します。

procedure DefaultHandler(var Message); override;

説明

DefaultHandler メソッドをオーバーライドすると，デフォルトのメッセージ処理機能を拡張できます。DefaultHandler は，コンポーネント開発者がコントロールへのメッセージを処理する最後の手続きです。最初の手続きは WndProc メソッドが提供します。Click など，個々のメッセージメソッドによっても別の手続きが提供されます。

DefaultHandler は，コントロールのテキストを制御するために Windows から送られるメッセージ（WM_GETTEXT，WM_SETTEXT，WM_GETTEXTLENGTH）を処理します。


TControl.DefineProperties
TControl.DefineProperties3073061

TControl	参照

DefineProperties メソッドは，IsControl プロテクトプロパティを永続的なものにして，フォームファイルなどのストリームとの間で IsControl の読み書きを行うためのメソッドを提供します。

procedure DefineProperties(Filer: TFiler); override;

説明

DefineProperties メソッドをオーバーライドすると，新しいプロパティを定義したり，非パブリッシュプロパティをパブリッシュに設定することができます。新しいプロパティを定義するには，Filer パラメータとして渡される TFiler オブジェクトの DefineBinaryProperty または DefineProperty メソッドを呼び出します。

注意

このメソッドをオーバーライドするときは，最初に継承する DefineProperties メソッド呼び出します。


TControl.Destroy
TControl.Destroy3073062

TControl	参照

Destroy メソッドは，TControl のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはコントロールが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

コントロールのオーナーを指定せずに Create メソッドを呼び出してコントロールのインスタンスを作成した場合，アプリケーションは直接コントロールを解放するだけでかまいません。

Destroy メソッドをオーバーライドすると，Create メソッドで割り当てられたメモリまたはリソースを解放できます。下位コントロールで Destroy メソッドを宣言するときには必ず override 指令を追加し，継承された Destroy を再宣言したメソッドの最後の文として呼び出します。

コントロールを作成すると Delphi は自動的にコンストラクタ呼び出しの例外処理を提供します。コンストラクタから例外が発生すると，デストラクタが呼び出されます。これは，部分的に構築されたインスタンスを破棄するためにデストラクタのコードを作成しておかなければならないことを意味します。データ項目の内容を破棄する前にすべてのデータ項目がゼロかどうかをチェックしてください。


TControl.DoEndDrag
TControl.DoEndDrag3073063

TControl	参照

DoEndDrag メソッドは，コントロールの OnEndDrag イベントのためのプロテクトメソッドです。

procedure DoEndDrag(Target:TObject); X, Y: Integer); dynamic;

説明

DoEndDrag メソッドは OnEndDrag イベントにアタッチされたイベントハンドラを呼び出す以外は何もしません。TControl から派生するコンポーネントを作成するときは，DoEndDrag をオーバーライドすれば，継承されたイベントハンドラ呼び出しのほかにも応答ができます。


TControl.DoStartDrag
TControl.DoStartDrag3073064

TControl	参照

DoStartDrag メソッドは，コントロールの OnStartDrag イベントのためのプロテクトメソッドです。

procedure DoStartDrag(var DragObject: TDragObject); dynamic;

説明

DoStartDrag メソッドは OnStartDrag イベントにアタッチされたイベントハンドラを呼び出す以外は何もしません。TControl から派生するコンポーネントを作成するときは，DoStartDrag をオーバーライドすれば，継承されたイベントハンドラ呼び出しのほかにも応答ができます。


TControl.DragCanceled
TControl.DragCanceled3073065

TControl	参照

DragCanceled メソッドは，ドラッグの取り消しに応答するメソッドにインターフェースを提供する以外は何もしません。

procedure DragCanceled; dynamic;

説明

TControl から派生するコンポーネントを作成するときは，DragCanceled をオーバーライドすれば，ドラッグ操作が取り消されたときに実行するコードを提供できます。


TControl.DragDrop
TControl.DragDrop3073066

TControl	参照

DragDrop メソッドは，OnDragDrop イベントハンドラが存在すれば，そのハンドラを呼び出します。

procedure DragDrop(Source: TObject; X, Y: Integer);

説明

TControl から派生するコンポーネントを作成するときは，DragDrop をオーバーライドすれば，OnDragDrop イベントハンドラが呼び出される前に実行するコードを追加できます。

DragDrop メソッドの Source パラメータは，ハンドラがドロップ先とみなすオブジェクトです。X および Y パラメータはオブジェクトのドロップ先とみなされる位置にあるマウスの座標です。


TControl.Dragging
TControl.Dragging3073067

TControl	参照

Dragging メソッドは，コントロールがドラッグ中かどうかを指定します。

function Dragging: Boolean;

説明

Dragging メソッドは，コントロールのドラッグ状態を取得できます。Dragging が True を返した場合は，コントロールはドラッグ中です。Dragging が False を返した場合は，コントロールはドラッグされていません。


TControl.DragOver
TControl.DragOver3073068

TControl	参照

DragOver メソッドは，OnDragOver イベントハンドラが存在すれば，そのハンドラを呼び出します。

TDragState = (dsDragEnter, dsDragLeave, dsDragMove);

procedure DragOver(Source: TObject; X, Y: Integer; State: TDragState;

var Accept: Boolean); dynamic;

説明

DragOver メソッドをオーバーライドすると，OnDragOver イベントハンドラが呼び出される前に実行するコードを追加することができます。

Accept パラメータを True に設定すると，ドラッグしたオブジェクトをそのコントロール上にドロップできることが示されます。Accept を False に設定すると，ドラッグしたオブジェクトをそのコントロール上にドロップできないことが示されます。

Source パラメータはドラッグ中のオブジェクトです。State パラメータの値には次の値があります。

値	意味

dsDragEnter	マウスがコントロールに入った

dsDragMove	マウスがコントロール上で移動している

dsDragLeave	マウスがコントロールから離れた


TControl.EndDrag
TControl.EndDrag3073069

TControl	参照

EndDrag メソッドは，実行中のコントロールのドラッグを停止します。

procedure EndDrag(Drop: Boolean);

説明

EndDrag メソッドは，BeginDrag メソッドの呼び出しで開始されたドラッグ操作を停止できます。

Drop パラメータが True ならば，ドラッグ中のコントロールはドロップされます。Drop パラメータが False ならば，コントロールはドロップされず，ドラッグ操作は取り消されます。


TControl.GetClientOrigin
TControl.GetClientOrigin3073070

TControl	参照

GetClientOrigin メソッドは，コントロールのクライアント領域の左上隅の画面座標を取得します。

function GetClientOrigin: TPoint; virtual;

説明

GetClientOrigin メソッドをオーバーライドすると，ClientOrigin の計算方法を変更できます。

GetClientOrigin メソッドは ClientOrigin プロパティ用のプロテクトメソッドです。GetClientOrigin はコントロールの Left 値と Top 値を親コントロールの ClientOrigin 座標に加算しています。


TControl.GetClientRect
TControl.GetClientRect3073071

TControl	参照

GetClientRect メソッドは，コントロールのクライアント領域を定義する四角形を返します。

TRect = record

  case Integer of

    0: (Left, Top, Right, Bottom: Integer);

    1: (TopLeft, BottomRight: TPoint);

end;

function GetClientRect: TRect; virtual;

説明

GetClientRect メソッドをオーバーライドすると，クライアント領域の計算方法を変更できます。

GetClientRect メソッドは ClientRect プロパティ用のプロテクトメソッドです。GetClientRect メソッドは，Top フィールドと Left フィールドをゼロに，Bottom フィールドと Right フィールドがコントロールの CleintHeight と ClientWidth にそれぞれ設定された長方形を返します。


TControl.GetDeviceContext
TControl.GetDeviceContext3073072

TControl	参照

GetDeviceContext メソッドは，コントロールのデバイスコンテキストを返します。

function GetDeviceContext(var WindowHandle: HWnd): HDC; virtual;

説明

GetDeviceContext メソッドを呼び出すと，デバイスコンテキストを取得できます。GetDeviceContext メソッドをオーバーライドすると，デバイスコンテキストの取得方法を変更できます。

WindowHandle パラメータでコントロールのウィンドウハンドルを渡します。GetDeviceContext は，親コントロールの GetDeviceContext から返されたデバイスコンテキストを返します。


TControl.GetDragImages
TControl.GetDragImages3073073

TControl	参照

GetDragImages メソッドは，ドラッグ中に表示されるイメージが入っているコントロールのイメージリストを返します。

function GetDragImages: TCustomImageList; virtual;

説明

GetDragImages メソッドをオーバーライドすると，コントロールにカスタムイメージリストを提供できます。TControl の GetDragImages メソッドは nil を返します。


TControl.GetPalette
TControl.GetPalette3073074

TControl	参照

GetPalette メソッドは，コントロールが使用するパレットのハンドルを返します。

function GetPalette: HPALETTE; dynamic;

説明

TControl の GetPalette メソッドはヌルハンドルを返します。このハンドルは，そのコントロールにはパレットがないことを示します。GetPalette メソッドをオーバーライドすると，パレットを使用する派生オブジェクトを作成できます。コントロールにパレットハンドルを作成するには，Windows API 関数の CreatePalette を呼び出します。GetPalette はそのコントロールのパレットハンドルを返します。

コントロールにパレットを指定すると，アプリケーションに，コントロールのパレットの実現が必要であることが通知され，そのパレットが使用するパレットとして指定されます。

GetPalette は，実行時の表示モードでカラーパレットのサポートが必要な場合（256 色モードなど）にだけ呼び出されます。


TControl.GetParentComponent
TControl.GetParentComponent3073075

TControl	参照

GetParentComponent メソッドは，コントロールの親コンポーネントを返します。.

function GetParentComponent: TComponent; override;

説明

GetParentComponent メソッドを呼び出すと，コントロールの親コンポーネントを調べることができます。GetParentComponent メソッドは，コントロールの Parent プロパティの Protected アクセスメソッドです。


TControl.GetPopupMenu
TControl.GetPopupMenu3073076

TControl	参照

GetPopupMenu メソッドは，コントロールに関連付けられているポップアップメニューです。

function GetPopupMenu: TPopupMenu; dynamic;

説明

GetPopupMenu メソッドを呼び出すと，コントロールに関連付けられているポップアップメニューを調べることができます。GetPopupMenu メソッドをオーバーライドすると，コントロールに関連付けられているポップアップメニューを変更したり，コントロールの状態に応じて異なるポップアップメニューを指定したりすることができます。

GetPopupMenu は Popup プロパティの値を返します。


TControl.GetTextBuf
TControl.GetTextBuf3073077

TControl	参照

GetTextBuf メソッドは，コントロールのテキストを取り出してバッファにコピーし，コピーした文字数を返します。

function GetTextBuf(Buffer: PChar; BufSize: Integer): Integer;

説明

GetTextBuf メソッドを呼び出すと，コントロールのテキストを固定サイズのバッファに取り出すことができます。コピーされるテキストが Text プロパティの値になります。GetTextBuf は実際にコピーした文字数を返します。この値は Text プロパティの長さと BufSize - 1 とのうちの少ないほうの値です。

テキスト全体を入れるのに必要なバッファの文字数を調べるには，GetTextBuf にバッファを割り当てる前に GetTextLen メソッドを呼び出します。

GetTextBuf は 16 ビットコードと互換性があります。下位互換性が問題にならなけらば Text プロパティを使います。


TControl.GetTextLen
TControl.GetTextLen3073078

TControl	参照

GetTextLen メソッドは，コントロールのテキスト長を返します。

function GetTextLen: Integer;

説明

GetTextLen メソッドを呼び出すと，コントロールのテキスト長を調べることができます。この値は GetTextBuf メソッドで使うテキストバッファに必要なサイズです。


TControl.HasParent
TControl.HasParent3073079

TControl	参照

HasParent メソッドは，コントロールに親が存在するかどうかを指定します。

function HasParent: Boolean; override;

説明

HasParent メソッドを使うと，コントロールに親が存在するかどうかを調べることができます。

コントロールの親はコントロールのストリームへの書き込みに責任を負います。デフォルトでは，コントロールの HasParent メソッドは False を返します。コントロールをストリームに書き込む親は，通常はコントロールが入っているフォームまたはパネルコントロールです。

注意

HasParent から True を返す子は，GetParentComponent メソッドと SetParentComponent メソッドも実装しなければなりません。


TControl.Hide
TControl.Hide3073080

TControl	参照

Hide メソッドは，コントロールを非表示にします。

procedure Hide;

説明

Hide メソッドを呼び出すと，コントロールを非表示にできます。Hide メソッドはコントロールの Visible プロパティを False に設定します。

隠されているコントロールは表示されませんが，そのプロパティの設定またはそのメソッドの呼び出しはできます。


TControl.Invalidate
TControl.Invalidate3073081

TControl	参照

Invalidate メソッドは，重要な Windows メッセージの処理の後で，コントロールの再描画を Windows に要求します。

procedure Invalidate; virtual;

説明

Invalidate メソッドは，コントロール全体を再描画する必要があるときに呼び出します。コントロール内の複数の領域を再描画する必要があるときは，Invalidate は再描画の重複によるちらつきを防ぐためにウィンドウ全体を一度で再描画します。コントロールが再描画される前に，繰り返し Invalidate を呼び出しても，パフォーマンスの低下はありません。


TControl.MouseDown
TControl.MouseDown3073082

TControl	参照

MouseDown メソッドは，OnMouseDown イベントハンドラが存在すれば，そのハンドラを呼び出します。

TMouseButton = (mbLeft, mbRight, mbMiddle);

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

procedure MouseDown(Button: TMouseButton; Shift: TShiftState; X, Y: Integer); dynamic;

説明

MouseDown メソッドをオーバーライドすれば，OnMouseDown イベントハンドラ呼び出しのほかにも応答処理が行えます。

Button パラメータはユーザーがどのマウスボタンを押したかを示します。Shift は，マウスボタンイベントを生成するマウスボタンをユーザーが押して放したときに押されていたシフトキー（〔Shift〕，〔Ctrl〕，〔Alt〕キー）を示します。X と Y は，Sender のクライアント領域内でのマウスポインタのピクセル座標です。

コントロールは Windows のいずれかのマウスダウンメッセージ（WM_LBUTTONDOWN，WM_MBUTTONDOWN，WM_RBUTTONDOWN）への応答として MouseDown を呼び出し，メッセージのパラメータをシフトキー状態と位置に解読し，それぞれ Shift，X，Y の各パラメータに渡します。Button パラメータの値はどの Windows メッセージがイベントを発生させたかによって異なります。


TControl.MouseMove
TControl.MouseMove3073083

TControl	参照

MouseMove メソッドは，OnMouseMove イベントにアタッチされたイベントハンドラを呼び出します。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

procedure MouseMove(Shift: TShiftState; X, Y: Integer); dynamic;

説明

MouseMove メソッドをオーバーライドすれば，OnMouseMove イベントハンドラ呼び出しのほかにも応答処理が行えます。

コントロールは Windows のマウス移動メッセージ（WM_MOUSEMOVE）への応答として MouseMove を呼び出し，メッセージのパラメータをシフトキー状態と位置に解読し，それぞれ Shift，X，Y の各パラメータに渡します。


TControl.MouseUp
TControl.MouseUp3073084

TControl	参照

MouseUp メソッドは，OnMouseUp イベントハンドラを呼び出します。

TMouseButton = (mbLeft, mbRight, mbMiddle);

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

procedure MouseUp(Button: TMouseButton; Shift: TShiftState; X, Y: Integer); dynamic;

説明

MouseUp メソッドをオーバーライドすれば，OnMouseUp イベントハンドラ呼び出しのほかにも応答処理が行えます。

コントロールは Windows のいずかのマウスアップメッセージ（WM_LBUTTONUP，WM_MBUTTONUP，WM_RBUTTONUP）への応答として MouseUp を呼び出し，メッセージのパラメータをシフトキー状態と位置に解読し，それぞれ Shift，X，Y の各パラメータに渡します。Button パラメータの値はどの Windows メッセージがイベントを発生させたかによって異なります。


TControl.Notification
TControl.Notification3073085

TControl	参照

Notification メソッドは，参照するポップアップメニューが破棄されたときに，TControl が Popupmenu プロパティを更新できるようにします。

type

  TOperation = (opInsert, opRemove);

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

Notification メソッドをオーバーライドすると，他のコンポーネントが破棄されようとしているか，または作成されたという通知に応答できます。他のシステムリソースに依存しているコントロールを更新すれば，削除されたオブジェクトへの参照がなくなります。たとえば，データベース対応オブジェクトは Notification メソッドをオーバーライドして，データソースが削除されたら，自身を更新する必要があります。

デフォルトの場合，コンポーネントに所有コンポーネントがあればその所有コンポーネントにも通知します。


TControl.PaletteChanged
TControl.PaletteChanged3073086

TControl	参照

PaletteChanged メソッドは，コントロールのパレットを実現することで，システムのパレットでの変更に応答します。

function PaletteChanged(Foreground: Boolean): Boolean; dynamic;

説明

PaletteChanged メソッドをオーバーライドすると，Windows からのシステムパレットの変更通知に対するコントロールの応答のしかたを変更できます。TControl はこのような通知に対する応答として，コントロールのパレット（存在する場合）を現在のデバイスコンテキストに実装しようとします。システムパレットの変更によってコントロールのパレットの実際の値が変更された場合，PaletteChanged は新しいパレットで再描画できるようにそのコントロールを無効にします。

Windows では，前景パレットでアクティブウィンドウをペイントし，背景パレットで他のウィンドウをペイントすることが強制されます。背景パレットはコントロールの論理パレットで指定される色とほぼ一致しますが，前景パレットの実装によって制限が加えられます。Windows で使用できる前景パレットは 1 つだけです。

PaletteChanged を使うと，システムパレットが変更されたときにコントロールは新たに自身のパレットを実現できます。ForeGround が True の場合，フォームはアクティブ化されており，コントロールは新しい前景パレットを指定しています。ForeGround が False の場合，別のアプリケーションまたはフォームが前景パレットを変更しており，利用可能なパレットを感知したコントロールは自身の論理パレットに最適な新しい背景パレットを実装する必要があります。

コントロールが現在のデバイスコンテキストに実装できる論理パレットを持たない場合，GetPalette は 0 のハンドルを返し，PaletteChanged は False を返します。これはパレットが実現されなかったことを示します。GetPalette が論理パレットへのハンドルを返した場合は，PaletteChanged は現在のデバイスコンテキストにこのパレットを実装し，True を返します。

注意

PaletteChanged は，実行時の画面モードでパレットのサポートが必要な場合（256 色モードなど）にだけ呼び出されます。True Color モードでは呼び出されません。


TControl.Perform
TControl.Perform3073087

TControl	参照

Perform メソッドを使うと，コントロールは指定した Windows メッセージを受け取ったのと同じように応答することができます。

function Perform(Msg: Cardinal; WParam, LParam: Longint): Longint;

説明

Perform メソッドを呼び出すと，Windows のメッセージキューを迂回して，メッセージをコントロールのウィンドウプロシージャへ直接送ることができます。

メッセージレコード（TMessage 型）には Msg パラメータで渡されたメッセージ ID, WParam と LParam で渡されたメッセージパラメータ，ゼロの結果フィールドが記入されます。Perform はこのメッセージレコードを WndProc メソッドへ渡して処理させます。


TControl.ReadState
TControl.ReadState3073088

TControl	参照

ReadState メソッドは，コントロールに，そのコントロールのプロパティにストリームから読み出した値が割り当てられるようにするための準備をさせます。

procedure ReadState(Reader: TReader); override;

説明

ReadState メソッドをオーバーライドすると，コントロールがプロパティの値をストリームから割り当てるために準備として行う処理を変更できます。たとえば，新しいインスタンスがストリームからロードされる前にコントロールは一時的な内部データ構造体またはオブジェクトを破棄する場合があります。ReadState メソッドをオーバーライドするときは，必ず継承されたメソッドを呼び出してください。

TControl.ReadState は TReader オブジェクトの Parent プロパティをコントロール自身の Parent プロパティに割り当ててから，継承された TComponent.ReadState メソッドを呼び出します。最後に ReadState は ParentFont，ParentColor，および ParentShowHint プロパティの値に基づいて Font，Color，および ShowHint プロパティを親コントロールと同期させます。


TControl.Refresh
TControl.Refresh3073089

TControl	参照

Refresh メソッドは，画面上にコントロールを再描画します。

procedure Refresh;

説明

Refresh メソッドを呼び出すと，速やかにコントロールを再描画できます。Refresh は Repaint メソッドを呼び出します。Refresh と Repaint メソッドとは互換性があります。


TControl.Repaint
TControl.Repaint3073090

TControl	参照

Repaint メソッドは，強制的に画面上にコントロールのイメージを再描画します。

procedure Repaint;

説明

Repaint メソッドを呼び出すと，強制的に画面上にコントロールのイメージを直ちに再描画することができます。ControlStyle プロパティに csOpaque が含まれている場合は，コントロールは自分自身を直接描画します。それ以外の場合は，Repaint メソッドは Invalidate メソッドを呼び出してから Update メソッドを呼び出します。そのため，コントロールの下の他のコントロールの可視部分も再描画されます。


TControl.ScreenToClient
TControl.ScreenToClient3073091

TControl	参照

ScreenToClient メソッドは，画面上の指定した点の画面座標をクライアント座標に変換します。

TPoint = record

  X: Longint;

  Y: Longint;

end;

function ScreenToClient(const Point: TPoint): TPoint;

説明

ScreenToClient メソッドを使うと，点の画面座標をローカルまたはクライアント領域の点の座標に変換できます。クライアント領域座標の（0，0）はコントロールのクライアント領域の左上隅に相当します。画面座標の（0，0）は画面の左上隅に相当します。

ClientToScreen と ScreenToClient メソッドを使うとコントロールの座標系を別のコントロールの座標系に変換できます。

P := TargetControl.ScreenToClient(SourceControl.ClientToScreen(P));

この例は P を SourceControl の座標から TargetControl の座標に変換します。


TControl.SendCancelMode
TControl.SendCancelMode3073092

TControl	参照

SendCancelMode メソッドは，コントロールのモード付き状態を取り消します。

procedure SendCancelMode(Sender: TControl);

説明

SendCancelMode メソッドを呼び出すと，コントロールのモード付き状態を取り消すことができます。VCL に実装されているさまざまなコントロールは，コントロールに応答しないと別のオブジェクトにアクセスできないモード付き状態をサポートしています。たとえば，ドロップダウンリストが表示されているときのコンボボックスのドロップダウン状態などです。このようなコントロールの場合，ドロップダウンリストを閉じるマウスクリックなどの特定のユーザーアクションにより，Windows メッセージをコントロールに送信してモード付き状態を終了します。

SendCancelMode メソッドを使うと，アプリケーションはユーザーアクションがないときに，あるいは新しいユーザーインターフェース応答を実装するために，コントロールのモード付き状態を終了できます。


TControl.SendToBack
TControl.SendToBack3073093

TControl	参照

SendToBack メソッドは，ウィンドウコントロールを親コンポーネントまたは親フォーム内で他のすべてのウィンドウコントロールの後ろに配置するか，非ウィンドウコントロールを親コンポーネントまたは親フォーム内で他のすべての非ウィンドウコントロールの後ろに配置します。

procedure SendToBack;

説明

SendToBack メソッドを使うと，コントロールまたはフォームの重なり合う順序を変更できます。

コントロールの重なる順序（Z オーダーといいます）はコントロールをフォームに配置した順番によって決まります。たとえば，ラベルとイメージを積み重ねてフォームに配置すると，最初に指定した方が下になります。ラベルとイメージはどちらも非ウィンドウコントロールなので，指定した順に「重なり」ます。上にあるオブジェクトに対して SendToBack メソッドを呼び出すと，そのオブジェクトが下になります。

ウィンドウコントロールのスタック順も同じです。たとえばフォームにメモを指定してからチェックボックスを指定すると，チェックボックスの方が上になります。チェックボックスに対して SendToBack を呼び出すとメモが上になります。

ウィンドウコントロールと非ウィンドウコントロールを混ぜて重ねることはできません。たとえばフォームにメモ（ウィンドウコントロール）を入れてからラベル（非ウィンドウコントロール）をメモの上に入れると，ラベルはメモの後ろに隠れてしまいます。ウィンドウコントロールは必ず非ウィンドウコントロールの上に重なります。メモに対して SendToBack メソッドを呼び出してもラベルはメモの後ろに隠れたままです。

コントロールにフォーカスがあるときに SendToBack メソッドを実行すると，そのコントロールのフォーカスは失われます。


TControl.SetBounds
TControl.SetBounds3073094

TControl	参照

SetBounds メソッドは，Left，Top，Width，Height プロパティを一度に設定します。

procedure SetBounds(ALeft, ATop, AWidth, AHeight: Integer); virtual;

説明

SetBounds メソッドを使うと，コンポーネントの境界プロパティを一度に変更できます。Left，Top，Width，Height プロパティを個別に設定しても同じ結果は得られますが，SetBounds では一度に複数の変更ができ，変更のたびにコントロールが再描画されることもありません。

ALeft，ATop，AWidth，AHeight パラメータの値として，それぞれ Left，Top，Width，Height 値を指定します。


TControl.SetDragMode
TControl.SetDragMode3073095

TControl	参照

SetDragMode メソッドは，コントロールのドラッグモードを設定します。

TDragMode = (dmManual, dmAutomatic);

procedure SetDragMode(Value: TDragMode); virtual;

説明

SetDragMode メソッドは DragMode プロパティ用の Protected メソッドです。SetDragMode メソッドをオーバーライドすると，DragMode プロパティの値が変更されたときに，追加コードを実行できます。


TControl.SetName
TControl.SetName3073096

TControl	参照

SetName メソッドは，コントロールの名前を設定します。

TComponentName = type string;

procedure SetName(const Value: TComponentName); override;

説明

SetName メソッドは Name プロパティの値を設定するための Protected メソッドです。SetName メソッドをオーバーライドすると，Name プロパティの値が変更されたときに，追加コードを実行できます。


TControl.SetParent
TControl.SetParent3073097

TControl	参照

SetParent メソッドは，コントロールの親を設定します。

procedure SetParent(AParent: TWinControl); virtual;

説明

SetParent メソッドを呼び出すと，指定したコントロールをコントロールの親にすることができます。SetParent メソッドは Parent プロパティ設定用の Protected メソッドです。SetParent メソッドをオーバーライドすると，Parent プロパティの値が変更されたときに，追加コードを実行できます。

親コントロールにするコントロールを AParent パラメータの値として指定します。

すでにコントロールに親があれば，SetParent は親の RemoveControl メソッドを呼び出すので，親のコントロールリストからそのコントロールが取り除かれます。AParent が非 nil ならば，SetParent はそのコントロールをコントロールリストへ追加するためにそのコントロールの InsertControl メソッドを呼び出します。

すべてのコントロールの Destroy メソッドはコンポーネントを廃棄する前に，コントロールを親のコントロールリストから取り除くために SetParent(nil) を呼び出します。


TControl.SetParentComponent
TControl.SetParentComponent3073098

TControl	参照

SetParentComponent メソッドは，コントロールの親を設定します。

procedure SetParentComponent(Value: TComponent); override;

説明

SetParentComponent メソッドは，指定したコンポーネントをコントロールの親にするために，ストリームシステムによって使われます。Value パラメータは，コントロールの親にするコンポーネントです。

SetParentComponent は，親に指定したコンポーネントがウィンドウコントロールの場合にだけ SetParent メソッドを呼び出します。


TControl.SetTextBuf
TControl.SetTextBuf3073099

TControl	参照

SetTextBuf メソッドは，コントロールのテキストを設定します。

procedure SetTextBuf(Buffer: PChar);

説明

SetTextBuf メソッドを呼び出すと，指定したバッファ内のテキストをコントロールのテキストとして設定できます。

テキストは Buffer パラメータが指すバッファ内のテキストに設定されます。Buffer が指すテキストはヌルで終了する文字列でなければなりません。SetTextBuf メソッドは WM_SETTEXT および CM_TEXTCHANGED メッセージを送信します。

注意

SetTextBuf メソッドは，下位互換性のために提供されています。コントロールのテキストの設定には，SetTextBuf メソッドのかわりに Text プロパティを使用します。


TControl.SetZOrder
TControl.SetZOrder3073100

TControl	参照

SetZOrder メソッドは，コントロールを親のコントロールリスト内で移動し，画面上の位置を変更します。

procedure SetZOrder(TopMost: Boolean); dynamic;

説明

SetZOrder メソッドを呼び出すと，コントロールの Z オーダーを変更できます。コントロールを最上位コントロールにするには，TopMost 値を True に設定します。最下位コントロールにするには TopMost 値を False に設定します。

順序の変更後，SetZOrder は再描画で新しい順序が確実に反映されるよう，コントロールを無効にします。

ウィンドウコントロールと非ウィンドウコントロールを混ぜて重ねることはできません。たとえばフォームにメモ（ウィンドウコントロール）を入れてからラベル（非ウィンドウコントロール）をメモの上に入れると，ラベルはメモの後ろに隠れてしまいます。ウィンドウコントロールは必ず非ウィンドウコントロールの上に重なります。ラベルに対して SetZOrder メソッドを呼び出してもメモの後ろに隠れたままです。


TControl.Show
TControl.Show3073101

TControl	参照

Show メソッドは，コントロールを可視にします。

procedure Show;

説明

Show メソッドは，隠れているコントロールを表示できます。

Show メソッドはコントロールの Visible プロパティを True に設定し，また親コントロールも可視にします。


TControl.Update
TControl.Update3073102

TControl	参照

Update メソッドは，保留中のペイントメッセージをただちに処理します。

procedure Update; virtual;

説明

Update メソッドを呼び出すと，時間のかかる可能性のある処理が発生しないうちに，強制的にコントロールのイメージを再描画することができます。Update を使えば，Windows のペイントメッセージを待つことなく，ユーザーにただちにフィードバックを提供できます。Update はコントロールを無効にすることはなく,すでに無効になっている領域を再描画させるだけです。コントロールも無効する必要がある場合には，Update ではなく Repaint を呼び出します。


TControl.UpdateBoundsRect
TControl.UpdateBoundsRect3073103

TControl	参照

UpdateBoundsRect メソッドは，コントロールの Left，Top，Width，Height の各プロパティを変更しますが，画面イメージは更新されません。

TRect = record

  case Integer of

    0: (Left, Top, Right, Bottom: Integer);

    1: (TopLeft, BottomRight: TPoint);

end;

procedure UpdateBoundsRect(const R: TRect);

説明

UpdateBoundsRect メソッドは Windows によって加えられた変更と同期をとるためにコントロールの内部で使われます。UpdateBoundsRect は R パラメータで渡された長方形に合わせてプロパティを変更します。


TControl.VisibleChanging
TControl.VisibleChanging3073104

TControl	参照

VisibleChanging メソッドは，コントロールが Visible プロパティの値を変更する直前に呼び出される Protected メソッドです。

procedure VisibleChanging; dynamic;

説明

VisibleChanging メソッドはコントロールの表示の切り替えに応答するために下位オブジェクトがオーバーライドを行うときのインターフェースを提供する以外は何もしません。たとえば，コントロールの表示が切り替えられない場合は，VisibleChanging をオーバーライドすると，切り替えを試みたときに，例外が生成されます。


TControl.WndProc
TControl.WndProc3073105

TControl	参照

WndProc メソッドは，コントロールに特定のメッセージ応答を提供します。

procedure WndProc(var Message: TMessage); virtual;

説明

WndProc メソッドをオーバーライドすると，コントロールの Windows メッセージハンドラを変更できます。WindowProc プロパティは WndProc に初期化されます。

WndProc メソッドは ControlStyle および DragMode プロパティで指定されるマウス動作を実現し，ControlState プロパティを更新します。未処理のメッセージがあればすべて Dispatch メソッドに渡します。

メッセージへの特殊な応答を提供するために WndProc をオーバイライドする場合は，未処理のメッセージをディスパッチするために最後に必ず継承された WndProc を呼び出してください。


スコープ3073106

protected

published

読み出し／書き込み

読み出し専用


スコープ3073107

protected


スコープ3073108

protected


継承3073109

TObject

TPersistent

TComponent


TControl 例3073110

TControl


TConversion
TConversion3074001

継承	メソッド	参照

TConversion は，書式付きテキストデータを変換します。変換は，ある記憶媒体に格納されているデータが，別のデータ形式を使っている記憶媒体にストリーム出力されるときに行われます。

ユニット

comctrls

説明

TConversion 自体は，変換を行いません。単に，ストリームの読み出しおよび書き込みをするだけです。TConversion の主な用途は，テキストストリームを別のデータ形式に変換する派生クラスによってオーバーライド可能な，インターフェースを提供することです。

TCustomRichEdit の派生クラスは，ANSI テキストまたは RTF 形式のテキストを含むファイルのテキストのストリーム処理に TConversion を使います。書式付きテキストエディットコントロールで異なる形式のファイルの読み出しおよび書き込みを行うには，その形式と RTF 形式の変換を行うクラスを TConversion から派生させます。書式付きテキスト編集コントロールで新しいクラスを使うには，RegisterConversionFormat メソッドを使ってクラスを登録するか，コントロールのデフォルトコンバータにします。


TConversion メソッド3074002

TConversion	アルファベット順

TConversion

ConvertReadStream

ConvertWriteStream

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TConversion メソッド3074003

TConversion	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ConvertReadStream

ConvertWriteStream

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TConversion.ConvertReadStream
TConversion.ConvertReadStream3074004

TConversion	参照

ConvertReadStream メソッドは，Stream から BufSize のバイトを読み出して，Buffer によってポイントされたメモリバッファに格納します。

function ConvertReadStream(Stream: TStream; Buffer: PChar; BufSize: Integer): Integer; virtual;

説明

テキストのデータ形式を変換するには，派生クラスのこのメソッドをオーバーライドして，バッファにあるテキストを変換します。TCustomRichEdit で使える派生クラスを作成するには，テキストを RTF 形式に変換します。

注意

ConvertReadStream では，ConvertWriteStream で行った変換を元に戻せなければなりません。


TConversion.ConvertWriteStream
TConversion.ConvertWriteStream3074005

TConversion	参照

ConvertWriteStream メソッドは，Buffer によってポイントされたメモリバッファから，BufSize のバイトを Stream に書き込みます。

function ConvertWriteStream(Stream: TStream; Buffer: PChar; BufSize: Integer): Integer; virtual;

説明

テキストのデータ形式を変換するには，派生クラスのこのメソッドをオーバーライドして，バッファにあるテキストを変換します。TCustomRichEdit で使える派生クラスを作成するには，テキストを RTF 形式に変換します。

注意

ConvertWriteStream では，ConvertReadStream で行った変換を元に戻せなければなりません。


継承3074006

TObject


TConversion 例3074007

TConversion


TCoolBar
TCoolBar3075001

継承	プロパティ	メソッド	イベント	参照

TCoolBar は TCoolBand オブジェクトのコンテナで，移動およびサイズ変更可能なバンド内にウィンドウコントロールのコレクションを表示します。

ユニット

comctrls

説明

TCoolBar には，別々に移動およびサイズ変更可能な子コントロールが入ります。各コントロールは Bands プロパティでリストされる TCoolBand オブジェクトが表す別々のバンド上に位置します。ユーザーは各バンドの左にあるサイズ変更グリップをドラッグして，コントロールの配置を表示することができます。

TCoolBar には，TLabel や TSpeedButton など，TWinControl から派生したものでないオブジェクトを入れることができます。ただし，サイズ変更可能なバンドに表示されるのは TWinControl の下位オブジェクトだけです。

注意

TCoolBar を使うにはバージョン 4.70 以降の COMCTL32.DLL が必要です。このファイルは，通常は WINDOWS\SYSTEM または WINDOWS\SYSTEM32 ディレクトリにあり，設計時と実行時のいずれにも必要です。TCoolBar を使うアプリケーションをアプリケーション化するときは，必ず COMCTL32.DLL をインストールしてください。

TCoolBar によって表されるコンポーネントは，リバーと呼ばれることもあります。


TCoolBar プロパティ3075002

TCoolBar	アルファベット順	凡例

TCoolBar

Align

AutoSize

BandBorderStyle

Bands

Bitmap

FixedOrder

FixedSize

Images

ShowText

Vertical

TToolWindow からの継承

BorderWidth

EdgeBorders

EdgeInner

EdgeOuter

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCoolBar プロパティ3075003

TCoolBar	オブジェクト順	凡例

Align

AutoSize

BandBorderStyle

Bands

Bitmap

BorderWidth

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

EdgeBorders

EdgeInner

EdgeOuter

Enabled

FixedOrder

FixedSize

Font

Handle

Height

HelpContext

Hint

Images

Left

Name

Owner

Parent

ParentColor

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

ShowText

TabOrder

TabStop

Tag

Top

VCLComObject

Vertical

Visible

Width

WindowProc


TCoolBar.Align
TCoolBar.Align3075004

TCoolBar	参照

Align プロパティは，TCoolBar コンポーネントの位置合わせを指定します。

property Align: TAlign;

説明

Align プロパティを alLeft または alRight に設定すると，自動的に Vertical プロパティが True に設定されます。Align プロパティを alTop，alBottom，alClient または alNone に設定すると，自動的に Vertical プロパティが False に設定されます。その他の点については，Align プロパティは継承プロパティのように動作します。


TCoolBar.AutoSize
TCoolBar.AutoSize3075005

TCoolBar	参照

AutoSize プロパティは，中に入れるバンドに合わせて TCoolBar が自動的にサイズ変更されるようにするかどうかを指定します。

property AutoSize: Boolean;

説明

AutoSize が True ならば，TCoolBar コンポーネントの幅または高さは中に入れるバンドのサイズと位置に合わせて変更されます。どちらの次元が調整されるかは Vertical プロパティで決まります。Vertical が True ならば，TCoolBar コンポーネントの幅が変更され，False ならば，高さが変更されます。


TCoolBar.BandBorderStyle
TCoolBar.BandBorderStyle3075006

TCoolBar

BandBorderStyle プロパティは，TCoolBar 内のバンドの境界のスタイルを指定します。

property BandBorderStyle: TBorderStyle;

説明

BandBorderStyle プロパティが bsSingle ならば，TCoolBar 内の各バンドの周囲に一重線が付きます。BandBorderStyle が bsNone ならば，バンドに境界線は付きません。


TCoolBar.Bands
TCoolBar.Bands3075007

TCoolBar	参照

Bands プロパティは，バンド（TCoolBands）のコレクションです。

property Bands: TCoolBands;

説明

Bands プロパティは TCoolBand オブジェクトのコレクションである TCoolBands を保持します。設計時には，バンドエディタを使ってバンドを追加，削除または変更できます。バンドエディタを起動するには，オブジェクトインスペクタで Bands プロパティを選択して，右側の Value 列内でダブルクリックするか，省略（...）ボタンをクリックします。

また，パレットから新しいウィンドウコントロールを追加しても，バンドを作成できます。TWinControl の派生オブジェクトが TCoolBar の子としてフォーム上に配置されると，そのオブジェクトに対して新しいバンドが作成されます。


TCoolBar.Bitmap
TCoolBar.Bitmap3075008

TCoolBar	参照

Bitmap プロパティは，TCoolBar 内のバンドの背後に表示されるイメージです。

property Bitmap: TBitmap;

説明

Bitmap プロパティは TBitmap オブジェクトを保持し，TCoolBar 内のバンドの背後に表示されるイメージを指定します。

デフォルトでは，Bitmap のイメージは，TCoolBar の左上隅に対する相対位置に配置され，クライアント領域を覆います。透過バンドはイメージが覆い隠されることなく表示されるようにします。この表示は TCoolBand の FixedBackground，Bitmap，ParentBitmap プロパティを設定して変更できます。


TCoolBar.FixedOrder
TCoolBar.FixedOrder3075009

TCoolBar	参照

FixedOrder プロパティは，ユーザーが TCoolBar 内のバンドを順序変更できるようにするかどうかを指定します。

property FixedOrder: Boolean;

説明

FixedOrder プロパティが True に設定されている場合，ユーザーはマウスを使ってバンドをドラッグしてバンドの位置を変更することができますが，バンドの順序は変更できません。バンドは，設計時にコレクションエディタから，またはプログラムコードでバンドの Index プロパティを変更して順序変更することができます。


TCoolBar.FixedSize
TCoolBar.FixedSize3075010

TCoolBar	参照

FixedSize プロパティは，バンドの高さを自動的に調整するかどうかを指定します。

property FixedHeight: Boolean;

説明

通常，Vertical プロパティと FixedSize プロパティとが両方とも False ならば，各 TCoolBand の高さは，リンクされている TWinControl の高さで決まります。バンドに TWinControl コンポーネントがリンクされていない場合はバンドの高さはバンド内のテキストによって決まります。FixedSize が True に設定されていれば，すべてのバンドが同じ高さになるようにサイズ変更されます。一番高い可視バンドの高さを増加させると，自動的に他のすべてのバンドの高さが増加します。

Vertical プロパティ True ならば，この依存関係は異なります。FixedSize が False ならば，各 TCoolBand の幅はリンクされている TWinControl の幅で決まります。FixedSize プロパティと Vertical プロパティとが両方とも True に設定されていれば，バンドは同じ幅を維持します。最も広い可視バンドの幅を増加させると，自動的に他のすべてのバンドの幅が増加します。


TCoolBar.Images
TCoolBar.Images3075011

TCoolBar	参照

Images プロパティは，TCoolBar 内のバンドで利用可能なイメージのリストです。

property Images: TImageList;

説明

Images プロパティは TCoolBar 内のバンドの左側に表示できるビットマップのリストです。


TCoolBar.ShowText
TCoolBar.ShowText3075012

TCoolBar	参照

ShowText プロパティは，バンド上にテキストを表示するかどうかを指定します。

property ShowText: Boolean;

説明

ShowText プロパティが True ならば，実行時に各 TCoolBand の Text 文字列がバンドに表示されます。ShowText プロパティが False ならば，表示されるのは，バンドにリンクされている TWinControl だけです。


TCoolBar.Vertical
TCoolBar.Vertical3075013

TCoolBar	参照

Vertical プロパティは，バンドを垂直に並べるか水平に並べるかを指定します。

property Vertical: Boolean;

説明

Vertical プロパティが False （デフォルト）ならば，TCoolBar 内のバンドは，水平方向，つまり左から右，上から下に並べられます。Vertical プロパティ True ならば，バンドは，垂直方向，つまり上から下，左から右に並べられます。


TCoolBar イベント3075014

TCoolBar	アルファベット順	凡例

TCoolBar

OnChange

OnResize

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TCoolBar イベント3075015

TCoolBar	オブジェクト順	凡例

OnChange

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnResize

OnStartDrag


TCoolBar.OnChange
TCoolBar.OnChange3075016

TCoolBar	参照

OnChange イベントは，バンドの位置またはサイズが変更されたときに発生します。

property OnChange: TNotifyEvent;

説明

OnChange イベントは，実行時に TCoolBand の Break，Index，または Width プロパティが変更されたときに発生します。OnChange イベントハンドラは，たとえば，Windows レジストリにバンドの位置およびサイズを記録するのに使うことができます。


TCoolBar.OnResize
TCoolBar.OnResize3075017

TCoolBar	参照

OnResize イベントは，TCoolBar がサイズ変更されたときに発生します。

property OnResize: TNotifyEvent;

説明

OnResize イベントは，実行時に TCoolBar 全体がサイズ変更されたときに発生します。


TCoolBar メソッド3075018

TCoolBar	アルファベット順

TCoolBar

Create

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCoolBar メソッド3075019

TCoolBar	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TCoolBar.Create
TCoolBar.Create3075020

TCoolBar	参照	例

Create メソッドは，TCoolBar のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは TCoolBar オブジェクトを生成し，そのプロパティを初期化します。COMCTL32.DLL が見つからない場合，Create は EComponentError 例外を生成します。


TCoolBar.Destroy
TCoolBar.Destroy3075021

TCoolBar	参照

Destroy メソッドは，TCoolBar のインスタンスを破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはコントロールが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。


スコープ3075022

published

読み出し／書き込み

読み出し専用


スコープ3075023

published


継承3075024

TObject

TPersistent

TComponent

TControl

TWinControl

TToolWindow


TCoolBar 例3075025

TCoolBar


TCoolBand
TCoolBand3076001

継承	プロパティ	メソッド	参照

ユニット

comctrls

説明

TCoolBand は TCoolBar 内のバンドを表します。

各 TCoolBar は，TCoolBands を使って TCoolBand オブジェクトのコレクションを保守します。


TCoolBand のプロパティ3076002

TCoolBand	アルファベット順	凡例

TCoolBand

Bitmap

BorderStyle

Break

Color

Control

FixedBackground

FixedSize

Height

HorizontalOnly

ImageIndex

MinHeight

MinWidth

ParentBitmap

ParentColor

Text

Visible

Width

TCollectionItem からの継承

Collection

DisplayName

ID

Index


TCoolBand のプロパティ3076003

TCoolBand	オブジェクト順	凡例

Bitmap

BorderStyle

Break

Collection

Color

Control

DisplayName

FixedBackground

FixedSize

Height

HorizontalOnly

ID

ImageIndex

Index

MinHeight

MinWidth

ParentBitmap

ParentColor

Text

Visible

Width


TCoolBand.Bitmap
TCoolBand.Bitmap3076004

TCoolBand	参照

Bitmap プロパティは，バンドに表示される背景イメージです。

property Bitmap: TBitmap;

説明

Bitmap プロパティは，バンドに表示する背景イメージを選択できます。イメージは連なって表示されるので，壁紙のようにバンドを覆います。

オブジェクトインスペクタで Bitmap プロパティを設定すると，自動的に ParentBitmap が False に設定されます。


TCoolBand.BorderStyle
TCoolBand.BorderStyle3076005

TCoolBand	参照

BorderStyle プロパティは，バンドの境界スタイルです。

property BorderStyle: TBorderStyle;

説明

BorderStyle プロパティを bsSingle（デフォルト）に設定すると，バンドに一重境界線が付きます。BorderStyle を bsNone に設定すると，バンドの周囲に境界線は付きません。


TCoolBand.Break
TCoolBand.Break3076006

TCoolBand

Break プロパティは，バンドに新しい線を開始させます。

property Break: Boolean;

説明

Break プロパティが True の場合（デフォルト），バンドは TCoolBar コントロールの左側から新しい線を開始します。Break が False の場合，バンドは前のバンドと同じ線を継続します。


TCoolBand.Color
TCoolBand.Color3076007

TCoolBand	参照

Color プロパティは，バンドの色です。

property Color: TColor;

説明

Color プロパティは，バンドの色を選択できます。オブジェクトインスペクタで Color を設定すると，自動的に ParentColor が False に設定されます。


TCoolBand.Control
TCoolBand.Control3076008

TCoolBand	例

Control プロパティは，バンドに表示するコントロールです。

property Control: TWinControl;

説明

Control プロパティは，バンドに表示するウィンドウコントロールを示します。Control の割り当てを解除すると，バンドにはコントロールが関連付けられていないことになります。


TCoolBand.FixedBackground
TCoolBand.FixedBackground3076009

TCoolBand	参照

FixedBackground プロパティは，バンド内で背景を位置合わせし直すかどうかを決めます。

property FixedBackground: Boolean;

説明

ParentBitmap プロパティが True の場合，バンドが表示する背景はバンドを所有する TCoolBar と同じになります。通常，FixedBackground プロパティが True の場合，その背景が TCoolBar 全体を覆います。FixedBackground を False に設定すると，背景は個々のバンド内で位置合わせしなおすので，TCoolBar の Bitmap イメージはバンドの左上隅を起点として配置されます。


TCoolBand.FixedSize
TCoolBand.FixedSize3076010

TCoolBand	参照

FixedSize プロパティは，実行時にバンドをサイズ変更できるかどうかを決めます。

property FixedSize: Boolean;

説明

FixedSize プロパティを True に設定すると，ユーザーがバンドをサイズ変更しなくて済みます。


TCoolBand.HorizontalOnly
TCoolBand.HorizontalOnly3076011

TCoolBand	参照

HorizontalOnly プロパティは，TCoolBar が垂直に配列された場合にバンドを表示するかどうかを決めます。

property HorizontalOnly: Boolean;

説明

TCoolBar の Vertical プロパティが True の場合，HorizontalOnly を True に設定するとバンドを非表示にできます。TCoolBar の Vertical プロパティが False の場合，HorizontalOnly は何の効果もありません。


TCoolBand.ImageIndex
TCoolBand.ImageIndex3076012

TCoolBand	参照

ImageIndex プロパティは，バンドに表示するイメージ（TCoolBar.Images のリストに入っているイメージ）を決めます。

property ImageIndex: Integer;

説明

TCoolBar  の Images プロパティには，TCoolBar 内のすべてのバンドの左側に表示可能なビットマップのリストが入っています。リストからビットマップを選択するには，バンドの ImageIndex プロパティに値を代入します。


TCoolBand.MinHeight
TCoolBand.MinHeight3076013

TCoolBand	参照

MinHeight プロパティは，バンドの最小の高さを決めます。

property MinHeight: Integer;

説明

MinHeight プロパティは，実行時にバンドの高さをどこまで小さくサイズ変更できるかを決めます。


TCoolBand.MinWidth
TCoolBand.MinWidth3076014

TCoolBand	参照

MinWidth プロパティは，バンドの最小の幅です。

property MinWidth: Integer;

説明

MinWidth プロパティは，実行時にバンドの幅をどこまで小さくサイズ変更できるかを決めます。


TCoolBand.ParentBitmap
TCoolBand.ParentBitmap3076015

TCoolBand	参照

ParentBitmap プロパティは，バンドがその親の TCoolBar の Bitmap イメージを使うかどうかを決めます。

property ParentBitmap: Boolean;

説明

ParentBitmap プロパティを True に設定すると，バンドは属している TCoolBar と同じ背景イメージを表示します（背景イメージは TCoolBar の Bitmap プロパティが決めます）。オブジェクトインスペクタでバンドの Bitmap プロパティを設定すると，自動的に ParentBitmap が False に設定されます。


TCoolBand.ParentColor
TCoolBand.ParentColor3076016

TCoolBand	参照

ParentColor プロパティは，バンドがその親の TCoolBar の色を使うかどうかを決めます。

property ParentColor: Boolean;

説明

ParentColor プロパティが True の場合，バンドの色はそのバンドを所有する TCoolBar と同じになります。オブジェクトインスペクタで Color プロパティを設定すると，自動的に ParentColor が False に設定されます。


TCoolBand.Text
TCoolBand.Text3076017

TCoolBand	参照

Text プロパティは，バンドに表示して Bands エディタ内でバンドを識別するテキスト文字列です。

property Text: string;

説明

Text プロパティに値を代入すると，バンドのウィンドウコントロールの左側でバンドの上に表示するテキストを作成できます。


TCoolBand.Visible
TCoolBand.Visible3076018

TCoolBand

Visible プロパティは，実行時にバンドを表示するかどうかを決めます。

property Visible: Boolean;

説明

Visible プロパティは，実行時にバンドの可視性を制御できます。Visible が True の場合にバンドはフォームに表示され，Visible が False の場合には表示されません。


TCoolBand.Width
TCoolBand.Width3076019

TCoolBand	参照

Width プロパティは，バンドの幅を示します。

property Width: Integer;

説明

Width プロパティは，バンドの幅をピクセル単位で示します。


TCoolBand のメソッド3076020

TCoolBand	アルファベット順

TCoolBand

Assign

Create

Destroy

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCoolBand のメソッド3076021

TCoolBand	オブジェクト順

Assign

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCoolBand.Assign
TCoolBand.Assign3076022

TCoolBand	参照

Assign メソッドは，バンドのプロパティを別のバンドにコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドは，ソースバンドの Text プロパティおよび Width プロパティを Assign が呼び出されたバンドにコピーします。


TCoolBand.Create
TCoolBand.Create3076023

TCoolBand

Create メソッドは，TCoolBand インスタンスを作成し，初期化します。

constructor Create(Collection: TCollection); override;

説明

Create メソッドは TCoolBand を生成し，そのプロパティを初期化します。


TCoolBand.Destroy
TCoolBand.Destroy3076024

TCoolBand	参照

Destroy メソッドは，TCoolBand を破棄しそのメモリを解放します。

destructor Destroy; override;

説明

アプリケーションで Destroy を直接呼び出さないでください。かわりに Free を呼び出します。Free はバンドが破棄済みでないことを確認してからのみ Destroy を呼び出します。


スコープ3076025

published

アクセス種別

読み出し専用


継承3076026

TObject

TPersistent

TCollectionItem


TCoolBand の例3076027

TCoolBand


TCoolBands
TCoolBands3077001

継承	プロパティ	メソッド	参照

TCoolBands は TCoolBand オブジェクトのコンテナです。

ユニット

comctrls

説明

各 TCoolBands は，TCoolBand オブジェクトのコレクションを TcoolBar に保持します。TCoolBands はその Items 配列で TCoolBand オブジェクトのインデックスを管理します。Count プロパティはコレクション内のバンド数を保持します。


TCoolBands のプロパティ3077002

TCoolBands	アルファベット順	凡例

TCoolBands

CoolBar

Items

Tcollection からの継承

Count

ItemClass


TCoolBands のプロパティ3077003

TCoolBands	オブジェクト順	凡例

CoolBar

Count

ItemClass

Items


TCoolBands.CoolBar
TCoolBands.CoolBar3077004

TCoolBands	参照

CoolBar プロパティは，TCoolBands を所有する TCoolBar コンポーネントです。

property CoolBar: TCoolBar;

説明

CoolBar プロパティは，TCoolBands が属する TCoolBar インスタンスを返します。


TCoolBands.Items
TCoolBands.Items3077005

TCoolBands	参照

Items プロパティは，TcoolBands 内のバンドのインデックスです。

property Items[Index: Integer]: TCoolBand; default;

説明

Index パラメータの値は，TcoolBand の Index プロパティに対応します。これは，TCoolBands コレクション内のバンドの位置を表します。


TCoolBands のメソッド3077006

TCoolBands	アルファベット順

TCoolBands

Add

Create

Tcollection からの継承

Assign

BeginUpdate

Clear

Destroy

EndUpdate

FindItemID

Tpersistent からの継承

GetNamePath

Tobject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCoolBands のメソッド3077007

TCoolBands	オブジェクト順

Add

Assign

BeginUpdate

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

EndUpdate

FieldAddress

FindItemID

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCoolBands.Create
TCoolBands.Create3077008

TCoolBands

Create メソッドは，TCoolBands インスタンスを作成して初期化します。

constructor Create(CoolBar: TCoolBar);

説明

Create メソッドは，TCoolBands インスタンスを生成してそのプロパティを初期化します。


 アクセス種別3077010

読み出し専用


継承3077011

TObject

TPersistent

TCollection


TCoolBands の例3077012

TCoolBands


TCustomPageProducer
TCustomPageProducer3078001

継承	プロパティ	メソッド	参照

TCustomPageProducer は，入力テンプレートに基づいて HTML コマンドの文字列を作成するオブジェクトの基本クラスです。

ユニット

httpapp

説明

TCustomPageProducer は，HTML テンプレートを HTML コマンドの文字列に変換するオブジェクトを定義するときの基本クラスとして使います。これらの HTML コマンドは Web ブラウザなどのクライアントアプリケーションで解釈されます。HTML テンプレートに含まれる HTML コマンドや HTML 透過タグは，ページ作成オブジェクトがカスタマイズした内容に置き換えられます。


TCustomPageProducer プロパティ3078002

TCustomPageProducer	アルファベット順	凡例

TCustomPageProducer

HTMLDoc

HTMLFile

TCustomContentProducer からの継承

Dispatcher

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TCustomPageProducer プロパティ3078003

TCustomPageProducer	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Dispatcher

HTMLDoc

HTMLFile

Name

Owner

Tag

VCLComObject


TCustomPageProducer.HTMLDoc
TCustomPageProducer.HTMLDoc3078004

TCustomPageProducer	参照

HTMLDoc プロパティは，ページ作成オブジェクトが Content メソッドで返す値を生成するために使う HTML テンプレートです。

property HTMLDoc: TStrings;

説明

HTMLDoc には，HTML テンプレートを構成する文字列セットを設定します。各文字列は 1 つまたは複数の HTML コマンドあるいは HTML 透過タグのシーケンスです。HTML 透過タグは以下の形式で表されます。

<#TagName Param1=Value1 Param2=Value2 ...>

左山かっこ（<）の直後にスペースを空けないでポンド記号（#）を指定します。ページ作成オブジェクトは，このポンド記号によって文字列が HTML 透過タグであることを認識します。ポンド記号の直後にはスペースを空けずにタグ名を指定します。ページ作成オブジェクトはタグ名に基づいて HTML 透過タグ全体を純粋な HTML コマンドに変換します。HTML 透過タグでは，タグ名の次に任意でパラメータを記述して，実行する変換の詳細を指定できます。各パラメータは ParamName=Value の形式をとり，パラメータ名，等号（=），および値の間にスペースは入りません。各パラメータはホワイトスペースで区切られます。

山かっこ（< >）を記述することで，#TagName の構造を認識しない HTML ブラウザに対してタグが透過，つまり無視されるようになります。

Content メソッドは HandleTag メソッドを呼び出して HTMLDoc 内の各 HTML 透過タグを変換することで，HTMLDoc を最終的な HTML 文字列に変換します。

注意

HTMLDoc を設定すると HTMLFile プロパティはクリアされます。


TCustomPageProducer.HTMLFile
TCustomPageProducer.HTMLFile3078005

TCustomPageProducer	参照

HTMLFile プロパティは，ページ作成オブジェクトが Content メソッドで返す値を生成するために使う HTML テンプレートがあるファイルの名前です。

TFileName = string;

property HTMLFile: TFileName;

説明

HTMLFile には，HTML テンプレートを含むファイルの名前を設定します。HTML テンプレートは HTML コマンドや HTML 透過タグのシーケンスです。HTML 透過タグは以下の形式で表されます。

<#TagName Param1=Value1 Param2=Value2 ...>

左山かっこ（<）の直後にスペースを空けないでポンド記号（#）を指定します。ページ作成オブジェクトは，このポンド記号によって文字列が HTML 透過タグであることを認識します。ポンド記号の直後にはスペースを空けずにタグ名を指定します。ページ作成オブジェクトはタグ名に基づいて HTML 透過タグ全体を純粋な HTML コマンドに変換します。HTML 透過タグでは，タグ名の次に任意でパラメータを記述して，実行する変換の詳細を指定できます。各パラメータは ParamName=Value の形式をとり，パラメータ名，等号（=），および値の間にスペースは入りません。各パラメータはホワイトスペースで区切られます。

山かっこ（< >）を記述することで，#TagName の構造を認識しない HTML ブラウザに対してタグが透過，つまり無視されるようになります。

Content メソッドは HandleTag メソッドを呼び出して HTMLFile 内の各 HTML 透過タグを変換することで，HTML テンプレートを最終的な HTML 文字列に変換します。

注意

HTMLFile を設定すると HTMLDoc プロパティはクリアされます。

注意

HTMLFile プロパティを使うページ作成オブジェクトがあるアプリケーションを配布する場合は，必ずアプリケーションと一緒にファイルを配布してください。また，HTMLFile の値にはユーザーのディスクで使用できないハードコードのパス名を指定しないでください。


TCustomPageProducer メソッド3078006

TCustomPageProducer	アルファベット順	凡例

TCustomPageProducer

Content

ContentFromStream

ContentFromString

Create

Destroy

HandleTag

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomPageProducer メソッド3078007

TCustomPageProducer	オブジェクト順	凡例

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Content

ContentFromStream

ContentFromString

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HandleTag

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TCustomPageProducer.Content
TCustomPageProducer.Content3078008

TCustomPageProducer	参照

Content メソッドは，HTML ページ作成オブジェクトが作成した HTML を返します。

function Content: string; override;

説明

Content を呼び出すと，HTML テンプレートを変換した結果生じる HTML コマンドを取得できます。Content は HTMLDoc または HTMLFile からテンプレートを読み出します。どちらのプロパティを読み出すかはどちらが設定されているかで決まります。Content は HTML テンプレート内の各 HTML 透過タグを，HandleTag メソッドが返すコードに置き換えます。


TCustomPageProducer.ContentFromStream
TCustomPageProducer.ContentFromStream3078009

TCustomPageProducer	参照

ContentFromStream メソッドは，ストリームから読み出された HTML テンプレートを変換した結果生じる HTML コードを返します。

function ContentFromStream(Stream: TStream): string; override;

説明

ContentFromStream を呼び出すと，ストリームから読み出した HTML テンプレートを変換できます。HTML テンプレートは HTML コマンドや HTML 透過タグのシーケンスです。ContentFromStream は，ストリームから読み出した HTML テンプレート内の各 HTML 透過タグを，HandleTag メソッドが返す文字列に置き換えます。


TCustomPageProducer.ContentFromString
TCustomPageProducer.ContentFromString3078010

TCustomPageProducer	参照

ContentFromString メソッドは，文字列 S を変換した結果生じる HTML コードを返します。

function ContentFromString(const S: string): string; override;

説明

ContentFromString を呼び出すと，HTML テンプレートで構成される文字列を変換できます。HTML テンプレートは HTML コマンドや HTML 透過タグのシーケンスです。ContentFromString は HTML テンプレート内の各 HTML 透過タグを，HandleTag メソッドが返す文字列に置き換えます。


TCustomPageProducer.Create
TCustomPageProducer.Create3078011

TCustomPageProducer	参照

Create メソッドは，TCustomPageProducer のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出すと，TCustomPageProducer のインスタンスを作成および初期化できます。継承コンストラクタを呼び出した後，Create は TStrings オブジェクトを割り当てて HTMLDoc プロパティを実現します。


TCustomPageProducer.Destroy
TCustomPageProducer.Destroy3078012

TCustomPageProducer	参照

Destroy メソッドは，TCustomPageProducer のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはページ作成オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy は HTMLDoc プロパティを実現する TStrings オブジェクトを解放してから，継承デストラクタを呼び出します。


TCustomPageProducer.HandleTag
TCustomPageProducer.HandleTag3078013

TCustomPageProducer	参照

HandleTag メソッドは，1 つの HTML 透過タグを，1 つまたは複数の HTML コマンドあるいは HTML 透過タグに変換します。

function HandleTag(const TagString: string; TagParams: TStrings): string; virtual;

説明

アプリケーションはこの Protected メソッドを直接呼び出すことはできません。HandleTag は，Content メソッド，ContentFromStream メソッド，または ContentFromString メソッドから呼び出され，HTML テンプレート内の HTML 透過タグを変換します。各 HTML 透過タグは以下の形式で表されます。

<#TagName Param1=Value1 Param2=Value2 ...>

左山かっこカッコ（<）の直後にスペースを空けないでポンド記号（#）を指定します。ポンド記号の直後にスペースを空けないでタグ名を指定します。HTML 透過タグでは，タグ名の次に任意でパラメータを記述して，実行する変換の詳細を指定できます。各パラメータは ParamName=Value の形式をとり，パラメータ名，等号（=），および値の間にスペースは入りません。各パラメータはホワイトスペースで区切られます。

TagString パラメータは HTML 透過タグのタグ名の部分からポンド記号を取り除いたものです。TagParams パラメータは HTML 透過タグのパラメータ部分です。HandleTag は HTML 透過タグからパラメータを取り除いて返します。Web ブラウザが結果の HTML を読む際には，HandleTag から返された文字列は無視されます。


スコープ3078014

protected

published

読み出し／書き込み

読み出し専用


スコープ3078015

protected


継承3078016

TObject

TPersistent

TComponent

TCustomContentProducer


TCustomPageProducer 例3078017

TCustomPageProducer


TCriticalSection
TCriticalSection3079001

継承	メソッド	参照

TCriticalSection オブジェクトはマルチスレッドアプリケーションで他のスレッドの実行を一時的にブロックし，シングルスレッドを実現します。

ユニット

syncobjs

説明

あるスレッドの処理が終了しないうちに別のスレッドを実行すると処理が中断する可能性がある場合，TCriticalSection を使うとその処理を保護できます。ただし，TCriticalSection はほかのスレッドの実行をすべてブロックするため，多用すると性能が著しく低下する場合があります。


TCriticalSection メソッド3079002

TCriticalSection	アルファベット順

TCriticalSection

Acquire

Create

Destroy

Enter

Leave

Release

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCriticalSection メソッド3079003

TCriticalSection	オブジェクト順

Acquire

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

Enter

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

Leave

MethodAddress

MethodName

NewInstance

Release

SafeCallException


TCriticalSection.Acquire
TCriticalSection.Acquire3079004

TCriticalSection	参照

Acquire メソッドはクリティカルセクションを呼び出し側のスレッドに関連付けます。

procedure Acquire; override;

説明

Acquire を呼び出すと，Release メソッドまたは Leave メソッドが呼び出されるまでほかのスレッドの実行をすべてブロックできます。Acquire は Enter メソッドと同じ処理を行います。


TCriticalSection.Create
TCriticalSection.Create3079005

TCriticalSection	参照

Create メソッドは，TCriticalSection のインスタンスを作成します。.

constructor Create;

説明

Create を呼び出すと，TCriticalSection のインスタンスを作成および初期化できます。TCriticalSection オブジェクトは，スレッド感知型コードを持つ単一のオブジェクトに対して作成したり，複数のスレッドに共有されるグローバルオブジェクトとして作成したりできます。


TCriticalSection.Destroy
TCriticalSection.Destroy3079006

TCriticalSection	参照

Destroy メソッドは，TCriticalSection のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TCriticalSection オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。


TCriticalSection.Enter
TCriticalSection.Enter3079007

TCriticalSection	参照

Enter メソッドは，呼び出し側のスレッドがスレッド感知型セクションに入るとほかのスレッドをブロックします。

procedure Enter;

説明

Enter を呼び出すと，Leave メソッドまたは Release メソッドが呼び出されるまでほかのスレッドの実行をすべてブロックできます。Enter は Acquire メソッドを呼び出して，クリティカルセクションを呼び出し側のスレッドに関連付けます。


TCriticalSection.Leave
TCriticalSection.Leave3079008

TCriticalSection	参照

Leave メソッドは，ブロックしていたほかのスレッドの実行を再開します。

procedure Leave;

説明

Leave メソッドは，コードのスレッド感知型セクションの最後で呼び出します。Leave を呼び出す場合は，必ずスレッド感知型セクションの最初で Enter または Acquire を呼び出してブロックと再開のメソッドを対応させなくてはなりません。Leave は Release を呼び出し，ブロックしていたほかのスレッドの実行を再開します。


TCriticalSection.Release
TCriticalSection.Release3079009

TCriticalSection	参照

Release メソッドは，ブロックしていたほかのスレッドの実行を再開します。

procedure Release; override;

説明

Release メソッドは，ほかのスレッドの実行をブロックする必要がなくなったときに呼び出します。Release を呼び出す場合は，ほかのスレッドの実行をブロックする Acquire または Enter を先に呼び出してブロックと再開のメソッドを対応させなくてはなりません。Release は Leave メソッドと同じ処理を行います。


継承3079010

TObject

TSynchroObject


TCriticalSection 例3079011

TCriticalSection


TCurrencyField
TCurrencyField3080001

継承	プロパティ	メソッド	イベント	参照

TCurrencyField オブジェクトは，データセット内の通貨値を含む項目を表します。

ユニット

db

説明

金額型項目は， (正または負の) 5.0 * 10-324 から 1.7 * 10308 の範囲内の値を 15 桁の精度で保持できます。

TCurrencyField オブジェクトは，その直接の上位オブジェクトである TFloatField とは，DataType プロパティが ftCurrency である点と，値の表示形式デフォルトが通貨形式である点が異なります。TFloatField オブジェクトの派生オブジェクトとして，TCurrencyField オブジェクトはデータベース内の浮動小数点型項目の値およびプロパティの管理に便利なプロパティ，メソッド，およびイベントを数多く用意しています。

TCurrencyField オブジェクトを Currency データ型と混同しないようにしてください。金額型項目では，値の保存および操作を Double 型データで行います。このデータ形式は，金額型項目の物理データベーステーブルによって使われる形式です。TBCDField クラスは，Currency データ型を使って値の保存および操作を行います。


TCurrencyField プロパティ3080002

TCurrencyField	アルファベット順	凡例

TCurrencyField

Currency

TFloatField からの継承

AsFloat

AsInteger

AsString

AsVariant

MaxValue

MinValue

Precision

Value

TNumericField からの継承

DisplayFormat

EditFormat

TField からの継承

Alignment

AsBoolean

AsCurrency

AsDateTime

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TCurrencyField プロパティ3080003

TCurrencyField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

Currency

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayFormat

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditFormat

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

MaxValue

MinValue

Name

NewValue

Offset

OldValue

Origin

Owner

Precision

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TCurrencyField イベント3080004

TCurrencyField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TCurrencyField イベント3080005

TCurrencyField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TCurrencyField メソッド3080006

TCurrencyField	アルファベット順

TCurrencyField

Create

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCurrencyField メソッド3080007

TCurrencyField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TCurrencyField.Create
TCurrencyField.Create3080008

TCurrencyField	参照

Create メソッドは，TCurrencyField のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，TCurrencyField オブジェクトのインスタンスを作成および初期化できます。継承コンストラクタを呼び出した後で，Create メソッドは DataType プロパティを ftCurrency に，Currency プロパティを True に設定します。

Create メソッドを直接呼び出す必要はほとんどありません。金額型項目オブジェクトはデータセット内のすべての金額型項目について自動的にインスタンス化されるからです。


スコープ3080009

published

読み出し／書き込み

読み出し専用


スコープ3080010

published


継承3080011

TObject

TPersistent

TComponent

TField

TNumericField

TFloatField


TCurrencyField 例3080012

TCurrencyField


TCustomServerSocket
TCustomServerSocket3081001

継承	プロパティ	メソッド	イベント	参照

TCustomServerSocket はすべてのサーバーソケットコンポーネントの基本クラスです。

ユニット

scktcomp

説明

TCustomServerSocket は TCP/IP サーバーの機能に固有の新しいプロパティとイベントを備えています。

TCustomServerSocket のインスタンスは作成しないでください。TCustomServerSocket は，他のマシンからの接続要求をリスニングするサーバーソケットオブジェクトを宣言するときに基本クラスとして使います。他のマシンからの接続の要求に応答するソケットを作成するには，TServerSocket を使います。


TCustomServerSocket プロパティ3081002

TCustomServerSocket	アルファベット順	凡例

TCustomServerSocket

ServerType

ThreadCacheSize

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TCustomServerSocket プロパティ3081003

TCustomServerSocket	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

ServerType

Tag

ThreadCacheSize

VCLComObject


TCustomServerSocket.ServerType
TCustomServerSocket.ServerType3081004

TCustomServerSocket	参照

ServerType プロパティは，サーバーソケットによって受け入れられる各接続を非ブロッキング接続にするかどうか，あるいは，自動的に接続ごとに別々の実行スレッドが与えられるようにするかどうかを指定します。

Type TServerType = (stNonBlocking, stThreadBlocking);

property ServerType: TServerType;

説明

ServerType プロパティを stThreadBlocking に設定すると，サーバーソケットによって受け入れられるソケット接続ごとに新しいスレッドを自動的に生成できます。ServerType が stThreadBlocking ならば，接続スレッドの実行は読み書きの間にすべての情報がその接続で転送されるまで延期されます。各接続用のスレッドはサーバーソケットが読み書きを行うことが必要になったときに OnClientRead または OnClientWrite イベントを生成します。

ServerType を stNonBlocking に設定すると，ソケット接続でのすべての読み書きを非同期的に処理できます。ServerType が stNonBlocking ならば，デフォルトですべてのクライアント接続は単一の実行スレッドで処理されます。OnClientRead または OnClientWrite イベントは，1 つの接続の相手側のクライアントソケットがその接続で情報を送受信しようとしたときに発生します。

読み書きをクライアントソケットと同期させる必要があるときには非ブロッキングソケットを使います。

注意

ServerType が stThreadBlocking ならば，OnClient... イベントハンドラのコードはスレッドセーフのコードであることが重要です。


TCustomServerSocket.ThreadCacheSize
TCustomServerSocket.ThreadCacheSize3081005

TCustomServerSocket	参照

ThreadCacheSize プロパティは，新しいクライアント接続で再使用できる最大スレッド数です。

property ThreadCacheSize: Integer;

説明

ServerType が stThreadBlocking ならば，サーバーソケットによって受け入れられる新しい接続ごとに独立した実行スレッドが与えられます。処理効率を向上させるために，サーバーソケットは，接続がクローズしたときにこれらのスレッドを解放しないで，キャッシュに格納します。このため，新しい接続は，接続が受け入れられるたびに新しいスレッドの作成をソケットサーバーに要求せずに，キャッシュからスレッドを再使用することができます。

ThreadCacheSize を設定すると，再使用のためにキャッシュされるスレッドの数を指定できます。ThreadCacheSize の最適値は，サーバーソケットが受け取るクライアントソケット要求の数と頻度によって異なります。ThreadCacheSize の値が小さすぎると，クライアント接続を受け入れるときに，サーバーソケットがスレッドを解放および作成するのに時間がかかってしまいます。ThreadCacheSize の値が大きすぎると，サーバーソケットが再使用されないスレッドのためにメモリをロックしてしまうことがあります。


TCustomServerSocket イベント3081006

TCustomServerSocket	アルファベット順	凡例

TCustomServerSocket

OnClientConnect

OnClientDisconnect

OnClientError

OnClientRead

OnClientWrite

OnGetSocket

OnGetThread

OnThreadEnd

OnThreadStart


TCustomServerSocket イベント3081007

TCustomServerSocket	オブジェクト順	凡例

OnClientConnect

OnClientDisconnect

OnClientError

OnClientRead

OnClientWrite

OnGetSocket

OnGetThread

OnThreadEnd

OnThreadStart


TCustomServerSocket.OnClientConnect
TCustomServerSocket.OnClientConnect3081008

TCustomServerSocket	参照

OnClientConnect イベントは，クライアントソケットがサーバーソケットによって受け入れられた接続を完了したときに発生します。

type TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnClientConnect: TSocketNotifyEvent;

説明

OnClientConnect イベントハンドラを記述すると，クライアントソケットがサーバーソケットへのソケット接続を完了したときに特定の処理が行われるようにすることができます。たとえば，ソケットは OnClientConnect イベントハンドラでその接続での読み書きを開始することもできます。

OnClientConnect が発生するまでのサーバーソケットイベントの順番は以下のとおりです。

1.	サーバーソケットがリスニングのためにオープンされる直前に OnListen イベントが発生する

2.	サーバーソケットはリスニングキューにクライアント要求を受け取る。サーバーソケットがそれらの要求の 1 つを受け入れ，新しいソケット接続の Windows ソケットハンドルを受け取る

3.	サーバーソケットが OnGetSocket イベントを生成し，Windows ソケットハンドルに渡す。新しい接続のサーバーエンドポイントの TServerClientWinSocket オブジェクトが OnGetSocket イベントハンドラで作成されない場合は，サーバーソケットがそのオブジェクトを作成する。TServerWinSocket オブジェクトは他のクライアントのリスニングを続行する

4.	新しい TServerClientWinSocket オブジェクトを使って，OnAccept イベントが発生する

5.	ServerType が stThreadBlocking で，キャッシュに利用可能なスレッドがない場合は，OnGetThread イベントが発生する。OnGetThread イベントハンドラがスレッドを作成しない場合は，サーバーソケットが TServerClientThread を作成する

6.	ServerType が stThreadBlocking の場合は，スレッドが実行を開始すると OnThreadStart イベントが発生する

7.	クライアントが TServerClientWinSocket オブジェクトへの接続を完了し，OnClientConnect イベントが発生する

Sender パラメータはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトです。Socket パラメータはクライアントソケットへの接続のサーバーエンドポイントを示す TServerClientWinSocket オブジェクトです。

注意

ServerType が stThreadBlocking の場合は，OnClientConnect イベントハンドラのすべてのコードがスレッドセーフのコードであることを確認してください。Sender パラメータの GetClientThread メソッドを使うと，スレッド固有の情報にアクセスできます。

注意

関連付けられている TServerWinSocket の OnClientConnect イベントハンドラを設定すると，TServerSocket の OnClientConnect イベントハンドラも設定されます。


TCustomServerSocket.OnClientDisconnect
TCustomServerSocket.OnClientDisconnect3081009

TCustomServerSocket	参照

OnClientDisconnect イベントは，クライアントソケットへの接続の 1 つをクローズしたときに発生します。

type TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnClientDisconnect: TSocketNotifyEvent;

説明

OnClientDisconnect イベントハンドラを記述すると，クライアントソケットへの接続を終了するときに特定の処理が行われるようにすることができます。クライアント接続が終了しても，サーバーソケットはクローズしません。サーバーソケットはオープンしたままで，リスニング接続でクライアント要求をリスニングします。

クライアント接続のサーバーエンドポイントを示す TServerClientWinSocket はOnClientDisconnect の後で解放されます。ServerType が stThreadBlocking の場合，OnClientDisconnect の後に OnThreadEnd イベントが発生します。

Sender パラメータはリスニング接続のサーバーエンドポイントを示す TServerWinClient オブジェクトです。Socket パラメータは終了するクライアントソケットとの接続のサーバーエンドポイントを示す TServerClientWinSocket オブジェクトです。

注意

ServerType が stThreadBlocking の場合は，OnClientDisconnect イベントハンドラ内のすべてのコードがスレッドセーフのコードであることを確認してください。Sender パラメータの GetClientThread メソッドを使うと，スレッド固有の情報にアクセスできます。

注意

関連付けられている TServerWinSocket の OnClientDisconnect イベントハンドラを設定すると，TServerSocket の OnClientDisconnect イベントハンドラも設定されます。


TCustomServerSocket.OnClientError
TCustomServerSocket.OnClientError3081010

TCustomServerSocket	参照

OnClientError イベントは，個々のクライアントソケットへのソケット接続の確立，使用，または終了で失敗が生じたときに発生します。

type

TErrorEvent = (eeGeneral, eeSend, eeReceive, eeConnect, eeDisconnect, eeAccept);

TSocketErrorEvent = procedure (Sender: TObject; Socket: TCustomWinSocket; ErrorEvent: TErrorEvent; var ErrorCode: Integer) of object;

property OnClientError: TSocketErrorEvent;

説明

OnClientError イベントハンドラを記述すると，クライアントソケットへの接続で発生したエラーに応答することができます。OnClientError イベントハンドラがエラー状況を正常に処理する場合，ErrorCode パラメータを 0 に設定すると ESocketError は生成されません。

Sender パラメータはリスニングソケットのサーバーエンドポイントを示す TServerWinClient オブジェクトです。Socket パラメータはエラーを起こしたクライアントソケットへの接続のサーバーエンドポイントを示す TServerClientWinSocket オブジェクトです。ErrorEvent パラメータはエラー発生時に Socket が何を行おうとしていたかを示します。ErrorCode パラメータは Windows ソケット API 呼び出しによって返されるエラーコードです。

注意

ServerType が stThreadBlocking の場合は，OnClientError イベントハンドラ内のすべてのコードがスレッドセーフのコードであることを確認してください。Sender パラメータの GetClientThread メソッドを使うと，スレッド固有の情報にアクセスできます。

注意

関連付けられている TServerWinSocket の OnClientError イベントハンドラを設定すると，TServerSocket の OnClientError イベントハンドラも設定されます。


TCustomServerSocket.OnClientRead
TCustomServerSocket.OnClientRead3081011

TCustomServerSocket	参照

OnClientRead イベントは，サーバーソケットがクライアントソケットから情報を読み出すことが必要になったときに発生します。

type TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnClientRead: TSocketNotifyEvent;

説明

OnClientRead イベントハンドラを記述すると，ソケット接続から読み出すことができます。ServerType プロパティが stThreadBlocking の場合，読み出し中に生じる問題が原因で実行スレッドが無期限にハングしないようにするには，TWinSocketStream オブジェクトを使います。それ以外の場合は，Socket パラメータのメソッドを使って実際の読み出しを実行します。

Sender パラメータはリスニング接続のサーバーエンドポイントを示す TServerWinClient オブジェクトです。Socket パラメータは情報を送信するクライアントソケットへの接続のサーバーエンドポイントを示す TServerClientWinSocket オブジェクトです。

注意

ServerType が stThreadBlocking の場合は，OnClientRead イベントハンドラ内のすべてのコードがスレッドセーフのコードであることを確認してください。Sender パラメータの GetClientThread メソッドを使うと，スレッド固有の情報にアクセスできます。


TCustomServerSocket.OnClientWrite
TCustomServerSocket.OnClientWrite3081012

TCustomServerSocket	参照

OnClientWrite イベントは，サーバーソケットがクライアントソケットに情報を書き込むことが必要になったときに発生します。

type TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnClientWrite: TSocketNotifyEvent;

説明

OnClientWrite イベントハンドラを記述すると，ソケット接続に情報を書き込むことができます。ServerType プロパティが stThreadBlocking の場合，書き込み中に生じる問題が原因で実行スレッドが無限ループ（デッドロック）しないようにするには，TWinSocketStream オブジェクトを使います。それ以外の場合は，Socket パラメータのメソッドを使って，実際の書き込みを実行します。

Sender パラメータはリスニング接続のサーバーエンドポイントを示す TServerWinClient オブジェクトです。Socket パラメータは情報を受信するクライアントソケットへの接続のサーバーエンドポイントを示す TServerClientWinSocket オブジェクトです。

注意

ServerType が stThreadBlocking の場合は，OnClientWrite イベントハンドラ内のすべてのコードがスレッドセーフのコードであることを確認してください。Sender パラメータの GetClientThread メソッドを使うと，スレッド固有の情報にアクセスできます。


TCustomServerSocket.OnGetSocket
TCustomServerSocket.OnGetSocket3081013

TCustomServerSocket	参照

OnGetSocket イベントは，クライアントソケットへの接続のサーバーエンドポイントを表すために，サーバーソケットが新しい TServerClientWinSocket オブジェクトを作成することが必要になったときに発生します。

type

TSocket = u_int;

TGetSocketEvent = procedure (Sender: TObject; Socket: TSocket; var ClientSocket: TServerClientWinSocket) of object;

property OnGetSocket: TGetSocketEvent;

説明

OnGetSocket イベントハンドラを記述すると，サーバーソケットコンポーネントが使う特殊な TServerClientWinSocket の下位オブジェクトを作成できます。ClientSocket パラメータに新しい TServerClientWinSocket オブジェクトを返します。Sender パラメータはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトです。


TCustomServerSocket.OnGetThread
TCustomServerSocket.OnGetThread3081014

TCustomServerSocket	参照

OnGetThread イベントは，クライアントソケットへの接続のために，サーバーソケットが新しい実行スレッドを作成することが必要になったときに発生します。

type TGetThreadEvent = procedure (Sender: TObject; ClientSocket: TServerClientWinSocket; var SocketThread: TServerClientThread) of object;

property OnGetThread: TGetThreadEvent;

説明

OnGetThread イベントハンドラを記述すると，クライアントソケットへの接続のための特殊な TServerClientThread の下位オブジェクトを作成することができます。SocketThread パラメータに新しい TServerClientThread オブジェクトを返します。Sender パラメータはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトです。ClientSocket パラメータは確立するクライアントソケットへの接続のサーバーエンドポイントを示す TServerClientWinSocket オブジェクトです。


TCustomServerSocket.OnThreadEnd
TCustomServerSocket.OnThreadEnd3081015

TCustomServerSocket	参照

OnThreadEnd イベントは，クライアントソケット接続が終了し，関連付けられているスレッドの実行が完了したときに発生します。

type TThreadNotifyEvent = procedure (Sender: TObject; Thread: TServerClientThread) of object;

property OnThreadEnd: TThreadNotifyEvent;

説明

OnThreadEnd イベントを記述すると，クライアント接続のスレッドの実行が完了したときに特定の処理が行われるようにすることができます。OnThreadEnd は OnClientDisconnect イベントの後に発生します。

Sender パラメータはリスニング接続のサーバーエンドポイントを示す TServerWinSocket です。Thread パラメータは終了するスレッドです。


TCustomServerSocket.OnThreadStart
TCustomServerSocket.OnThreadStart3081016

TCustomServerSocket	参照

OnThreadStart イベントは，クライアントソケットへの接続のための実行スレッドが開始されたときに発生します。

type TThreadNotifyEvent = procedure (Sender: TObject; Thread: TServerClientThread) of object;

property OnThreadStart: TThreadNotifyEvent;

説明

OnThreadStart イベントを記述すると，単一のクライアントソケットへの接続のための TServerClientThread を初期化できます。Sender パラメータはリスニング接続のサーバーエンドポイントを示す TServerWinSocket です。Thread パラメータは実行を開始するスレッドです。


TCustomServerSocket メソッド3081017

TCustomServerSocket	アルファベット順	凡例

TCustomServerSocket

Destroy

GetGetSocketEvent

GetGetThreadEvent

GetOnClientError

GetOnClientEvent

GetOnThreadEnd

GetOnThreadStart

GetServerType

GetThreadCacheSize

SetGetSocketEvent

SetGetThreadEvent

SetOnClientError

SetOnClientEvent

SetOnThreadEnd

SetOnThreadStart

SetServerType

SetThreadCacheSize

TCustomSocket からの継承

Close

Open

TComponent からの継承

Create

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomServerSocket メソッド3081018

TCustomServerSocket	オブジェクト順	凡例

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Close

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetGetSocketEvent

GetGetThreadEvent

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetOnClientError

GetOnClientEvent

GetOnThreadEnd

GetOnThreadStart

GetParentComponent

GetServerType

GetThreadCacheSize

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

Open

RemoveComponent

SafeCallException

SetGetSocketEvent

SetGetThreadEvent

SetOnClientError

SetOnClientEvent

SetOnThreadEnd

SetOnThreadStart

SetServerType

SetThreadCacheSize


TCustomServerSocket.Destroy
TCustomServerSocket.Destroy3081019

TCustomServerSocket	参照

Destroy メソッドは，TCustomServerSocket のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはサーバーソケットが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy はリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトを解放します。


TCustomServerSocket.GetGetSocketEvent
TCustomServerSocket.GetGetSocketEvent3081020

TCustomServerSocket	参照

GetGetSocketEvent メソッドは，OnGetSocket イベントハンドラを返します。

type TGetSocketEvent = procedure (Sender: TObject; Socket: TSocket; var ClientSocket: TServerClientWinSocket) of object;

function GetGetSocketEvent: TGetSocketEvent;

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。GetGetSocketEvent メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの OnGetSocket イベントハンドラを返します。


TCustomServerSocket.GetGetThreadEvent
TCustomServerSocket.GetGetThreadEvent3081021

TCustomServerSocket	参照

GetGetThreadEvent メソッドは，OnGetThread イベントハンドラを返します。

type TGetThreadEvent = procedure (Sender: TObject; ClientSocket: TServerClientWinSocket; var SocketThread: TServerClientThread) of object;

function GetGetThreadEvent: TGetThreadEvent;

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。GetGetThreadEvent メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの OnGetThread イベントハンドラを返します。


TCustomServerSocket.GetOnClientError
TCustomServerSocket.GetOnClientError3081022

TCustomServerSocket	参照

GetOnClientError メソッドは，OnClientError イベントハンドラを返します。

type

TErrorEvent = (eeGeneral, eeSend, eeReceive, eeConnect, eeDisconnect, eeAccept);

TSocketErrorEvent = procedure (Sender: TObject; Socket: TCustomWinSocket; ErrorEvent: TErrorEvent; var ErrorCode: Integer) of object;

function GetOnClientError: TSocketErrorEvent;

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。GetOnClientError メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの OnClientError イベントハンドラを返します。


TCustomServerSocket.GetOnClientEvent
TCustomServerSocket.GetOnClientEvent3081023

TCustomServerSocket	参照

GetOnClientEventメソッドは，OnClientEvent イベントハンドラを返します。

type TSocketEvent = (seLookup, seConnecting, seConnect, seDisconnect, seListen, seAccept, seWrite, seRead);

function GetOnClientEvent(Index: Integer): TSocketNotifyEvent;

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。GetOnClientEventメソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの OnClientEvent イベントハンドラを返します。


TCustomServerSocket.GetOnThreadEnd
TCustomServerSocket.GetOnThreadEnd3081024

TCustomServerSocket	参照

GetOnThreadEndメソッドは，OnThreadEnd イベントハンドラを返します。

type TThreadNotifyEvent = procedure (Sender: TObject; Thread: TServerClientThread) of object;

function GetOnThreadEnd: TThreadNotifyEvent;

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。GetOnThreadEndメソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの OnThreadEnd イベントハンドラを返します。


TCustomServerSocket.GetOnThreadStart
TCustomServerSocket.GetOnThreadStart3081025

TCustomServerSocket	参照

GetOnThreadStart メソッドは，OnThreadStart イベントハンドラを返します。

type TThreadNotifyEvent = procedure (Sender: TObject; Thread: TServerClientThread) of object;

function GetOnThreadStart: TThreadNotifyEvent;

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。GetOnThreadStart メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの OnThreadStart イベントハンドラを返します。


TCustomServerSocket.GetServerType
TCustomServerSocket.GetServerType3081026

TCustomServerSocket	参照

GetServerTypeメソッドは，ServerType プロパティを返します。

type TServerType = (stNonBlocking, stThreadBlocking);

function GetServerType: TServerType;

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。GetServerType メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの ServerType プロパティの値を返します。


TCustomServerSocket.GetThreadCacheSize
TCustomServerSocket.GetThreadCacheSize3081027

TCustomServerSocket	参照

GetThreadCacheSize メソッドは，ThreadCacheSize プロパティの値を返します。

function GetThreadCacheSize: Integer;

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。GetThreadCacheSize メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの ThreadCacheSize プロパティの値を返します。


TCustomServerSocket.SetGetSocketEvent
TCustomServerSocket.SetGetSocketEvent3081028

TCustomServerSocket	参照

SetGetSocketEvent メソッドは，OnGetSocket イベントハンドラを設定します。

type TGetSocketEvent = procedure (Sender: TObject; Socket: TSocket; var ClientSocket: TServerClientWinSocket) of object;

procedure SetGetSocketEvent(Value: TGetSocketEvent);

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。SetGetSocketEvent メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの OnGetSocket イベントハンドラを設定します。サーバーソケットオブジェクトは TServerWinSocket を使って OnGetSocket イベントを実現します。


TCustomServerSocket.SetGetThreadEvent
TCustomServerSocket.SetGetThreadEvent3081029

TCustomServerSocket	参照

SetGetThreadEvent メソッドは， OnGetThread イベントハンドラを設定します。

type TGetThreadEvent = procedure (Sender: TObject; ClientSocket: TServerClientWinSocket; var SocketThread: TServerClientThread) of object;

procedure SetGetThreadEvent(Value: TGetThreadEvent);

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。SetGetThreadEvent メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの OnGetThread イベントハンドラを設定します。サーバーソケットオブジェクトは TServerWinSocket を使って OnGetThread イベントを実現します。


TCustomServerSocket.SetOnClientError
TCustomServerSocket.SetOnClientError3081030

TCustomServerSocket	参照

SetOnClientError メソッドは，OnClientError イベントハンドラを設定します。

type

TErrorEvent = (eeGeneral, eeSend, eeReceive, eeConnect, eeDisconnect, eeAccept);

TSocketErrorEvent = procedure (Sender: TObject; Socket: TCustomWinSocket; ErrorEvent: TErrorEvent; var ErrorCode: Integer) of object;

procedure SetOnClientError(Value: TSocketErrorEvent);

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。SetOnClientError メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの OnClientError イベントハンドラを設定します。サーバーソケットオブジェクトは TServerWinSocket を使って OnClientError イベントを実現します。


TCustomServerSocket.SetOnClientEvent
TCustomServerSocket.SetOnClientEvent3081031

TCustomServerSocket	参照

SetOnClientEvent メソッドは，OnClientEvent イベントハンドラを設定します。

type TSocketEvent = (seLookup, seConnecting, seConnect, seDisconnect, seListen, seAccept, seWrite, seRead);

procedure SetOnClientEvent(Index: Integer; Value: TSocketNotifyEvent);

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。SetOnClientEvent メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの OnClientEvent イベントハンドラを設定します。サーバーソケットオブジェクトは TServerWinSocket を使って OnClientEvent イベントを実現します。


TCustomServerSocket.SetOnThreadEnd
TCustomServerSocket.SetOnThreadEnd3081032

TCustomServerSocket	参照

SetOnThreadEnd メソッドは，OnThreadEnd イベントハンドラを設定します。

type TThreadNotifyEvent = procedure (Sender: TObject; Thread: TServerClientThread) of object;

procedure SetOnThreadEnd(Value: TThreadNotifyEvent);

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。SetOnThreadEnd メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの OnThreadEnd イベントハンドラを設定します。サーバーソケットオブジェクトは TServerWinSocket を使って OnThreadEnd イベントを実現します。


TCustomServerSocket.SetOnThreadStart
TCustomServerSocket.SetOnThreadStart3081033

TCustomServerSocket	参照

SetOnThreadStart メソッドは，OnThreadStart イベントハンドラを設定します。

type TThreadNotifyEvent = procedure (Sender: TObject; Thread: TServerClientThread) of object;

procedure SetOnThreadStart(Value: TThreadNotifyEvent);

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。SetOnThreadStart メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの OnThreadEnd イベントハンドラを設定します。サーバーソケットオブジェクトは TServerWinSocket を使って OnThreadEnd イベントを実現します。


TCustomServerSocket.SetServerType
TCustomServerSocket.SetServerType3081034

TCustomServerSocket	参照

SetServerType メソッドは，ServerType プロパティを設定します。

type TServerType = (stNonBlocking, stThreadBlocking);

procedure SetServerType(Value: TServerType);

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。SetServerType メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの ServerType プロパティを設定します。サーバーソケットオブジェクトは TServerWinSocket を使って ServerType プロパティを実現します。


TCustomServerSocket.SetThreadCacheSize
TCustomServerSocket.SetThreadCacheSize3081035

TCustomServerSocket	参照

SetThreadCacheSize メソッドは，ThreadCacheSize プロパティを設定します。

function GetThreadCacheSize: Integer;

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。SetThreadCacheSize メソッドはリスニング接続のサーバーエンドポイントを示す TServerWinSocket オブジェクトの ThreadCacheSize プロパティを設定します。サーバーソケットオブジェクトは TServerWinSocket を使って ThreadCacheSize プロパティを実現します。


スコープ3081036

protected

published

読み出し／書き込み

読み出し専用


スコープ3081037

protected


スコープ3081038

protected


継承3081039

TObject

TPersistent

TComponent

TCustomSocket


TCustomServerSocket 例3081040

TCustomServerSocket


TCustomAdapter
TCustomAdapter3082001

継承	プロパティ	メソッド	参照

TFontAdapter および TPictureAdapter の上位クラスです。

ユニット

axctrls

説明

このクラスのオブジェクトを作成することはありません。かわりに，GetOleFont 手続きを呼び出して TFont と OLE フォントオブジェクトまたは GetOlePicture との結合を作成するか，TPicture と OLE 画像オブジェクトとの結合を作成します。


TCustomAdapter のプロパティ3082002

TCustomAdapter	アルファベット順	凡例

TInterfacedObject からの継承

RefCount


TCustomAdapter のプロパティ3082003

TCustomAdapter	オブジェクト順	凡例

RefCount


TCustomAdapter のメソッド3082004

TCustomAdapter	アルファベット順

TCustomAdapter

Create

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCustomAdapter のメソッド3082005

TCustomAdapter	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCustomAdapter.Create
TCustomAdapter.Create3082006

TCustomAdapter	参照

Create メソッドは，カスタムアダプタコントロールのインスタンスを構築します。

constructor Create;

説明

このクラスの下位オブジェクト（TFontAdapter や TPictureAdapter）以外はオブジェクトを作成しないでください。


TCustomAdapter.Destroy
TCustomAdapter.Destroy3082007

TCustomAdapter	参照

Destroy メソッドは，カスタムアダプタコントロールのデストラクタです。

destructor Destroy; override;

説明

Destroy メソッドは，Delphi ネイティブのオブジェクトを OLE オブジェクトから解放して結合を解除します。


アクセス種別3082008

読み出し専用


継承3082009

TObject

TInterfacedObject


TCustomAdapter の例3082010

TCustomAdapter


TCustomStaticText
TCustomStaticText3083001

継承	プロパティ	メソッド	参照

TCustomStaticText コンポーネント は TStaticText の抽象基本クラスです。

ユニット

stdctrls

説明

TCustomStaticText は，フォーム上にテキストを表示するウィンドウコントロールである TStaticText の基本クラスです。このコンポーネントは TLabel のように機能しますが，ウィンドウハンドルを持つ点が異なります。

TCustomStaticText はフォーカスを受け取ったり，他のコントロールを中に入れたりすることはできません。


TCustomStaticText プロパティ3083002

TCustomStaticText	アルファベット順	凡例

TCustomStaticText

Alignment

AutoSize

BorderStyle

FocusControl

ShowAccelChar

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomStaticText プロパティ3083003

TCustomStaticText	オブジェクト順	凡例

Align

Alignment

AutoSize

BorderStyle

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

FocusControl

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentWindow

ShowAccelChar

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TCustomStaticText.Alignment
TCustomStaticText.Alignment3083004

TCustomStaticText	参照

Alignment プロパティは，コンポーネント内でテキストを揃える方法を指定します。

property Alignment: TAlignment default taLeftJustify;

説明

Alignment プロパティは次の値を指定できます。

値	意味

taLeftJustify	テキストはコントロールの左端に揃えられる

taCenter	テキストはコントロールの中央に揃えられる

taRightJustify	テキストはコントロールの右端に揃えられる


TCustomStaticText.AutoSize
TCustomStaticText.Autosize3083005

TCustomStaticText	参照

Autosize プロパティは，テキストに合わせてコンポーネントのサイズを自動的に変更するかどうかを指定します。

property AutoSize: Boolean default True;

説明

Autosize プロパティが True ならば，実行時および設計時に，フォントサイズまたは Caption のテキストが変更されるたびに，コンポーネントのサイズが自動的に変更されます。


TCustomStaticText.BorderStyle
TCustomStaticText.BorderStyle3083006

TCustomStaticText

BorderStyle プロパティは，コントロールの境界の外観を指定します。

TStaticBorderStyle = (sbsNone, sbsSingle, sbsSunken);

property BorderStyle: TStaticBorderStyle default sbsNone;

説明

BorderStyle では次の値を指定できます。

値	意味

sbsNone	非可視境界

sbsSingle	一重境界線

sbsSunken	隆起した境界線


TCustomStaticText.FocusControl
TCustomStaticText.FocusControl3083007

TCustomStaticText	参照

FocusControl プロパティは，コンポーネントを別のウィンドウコントロールにリンクします。

property FocusControl: TWinControl;

説明

FocusControl プロパティは，TCustomStaticText のインスタンスを別のウィンドウコントロールにリンクできます。Caption のテキストにアクセラレータキーが含まれている場合，アクセラレータキーを押すと FocusControl で指定するコンポーネントがフォーカスを受け取ります。


TCustomStaticText.ShowAccelChar
TCustomStaticText.ShowAccelChar3083008

TCustomStaticText	参照

ShowAccelChar プロパティは，アクセラレータ文字を有効にします。

property ShowAccelChar: Boolean default True;

説明

ShowAccelChar プロパティが True ならば，コンポーネントの Caption テキスト中のアンド記号が下線として表示され，アンド記号の次の文字がアクセラレータキーになります。ShowAccelChar が False なら，アンド記号はアンド記号として表示されます。


TCustomStaticText メソッド3083009

TCustomStaticText	アルファベット順

TCustomStaticText

Create

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomStaticText メソッド3083010

TCustomStaticText	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TCustomStaticText.Create
TCustomStaticText.Create3083011

TCustomStaticText	参照

Create メソッドは，TCustomStaticText のインスタンスを作成し初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは継承コンストラクタメソッドを呼び出してから，ControlStyle に csCaptureMouse，csClickEvents，csSetCaption，csOpaque，csReplicatable，csDoubleClicks の各フラグを追加することで，TCustomStaticText のインスタンスを初期化します。また，Create メソッドは AutoSize および ShowAccelChar プロパティを True に設定します。


スコープ3083012

protected

published

読み出し／書き込み

読み出し専用


継承3083013

TObject

TPersistent

TComponent

TControl

TWinControl


TCustomStaticText 例3083014

TCustomStaticText


TControlScrollBar
TControlScrollBar3084001

継承	プロパティ	メソッド	参照

TControlScrollBar オブジェクトは水平スクロールバーと垂直スクロールバーを表示します。

ユニット

forms

説明

TForm と TScroolBox の HorzScrollBar プロパティと VertScrollBar プロパティは，TControlScrollBar オブジェクトを使ってスクロールバーを定義します。


TControlScrollBar プロパティ3084002

TControlScrollBar	アルファベット順	凡例

TControlScrollBar

Increment

Kind

Margin

Position

Range

ScrollPos

Tracking

Visible


TControlScrollBar プロパティ3084003

TControlScrollBar	オブジェクト順	凡例

Increment

Kind

Margin

Position

Range

ScrollPos

Tracking

Visible


TControlScrollBar.Increment
TControlScrollBar.Increment3084004

TControlScrollBar

Increment プロパティは，スクロールバー両端の小さな矢印をクリックしたとき表示がどれだけ移動するかを指定します。

TScrollBarInc = 1..32767;

property Increment: TScrollBarInc default 8;

説明

Increment プロパティを 1 に設定すると，1 クリックで位置数 1 つ分スクロールします。2 に設定すると，1 クリックで位置数 2 つ分移動します。


TControlScrollBar.Kind
TControlScrollBar.Kind3084005

TControlScrollBar

Kind プロパティは，スクロールバーが水平スクロールバーか垂直スクロールバーかを指定します。

property Kind: TScrollBarKind;

説明

以下に Kind の値を示します。

値	意味

sbHorizontal	水平スクロールバー

sbVertical	垂直スクロールバー


TControlScrollBar.Margin
TControlScrollBar.Margin3084006

TControlScrollBar	参照

Margin プロパティは，スクロールバーの表示条件を指定します。

property Margin: Word default 0;

説明

Margin プロパティは，各コントロールをフォームまたはスクロールボックスの端から最低どれだけ離さなければならないかをピクセル数で指定します。実行時，ビジュアルコンポーネントと，フォームの端またはスクロールボックスの端との距離が Margin ピクセルより小さくなり，かつ Visible が True に設定されていると，スクロールバーが表示されます。


TControlScrollBar.Position
TControlScrollBar.Position3084007

TControlScrollBar	参照

Position プロパティは，スクロールバー上のスクロールボックスの位置を表します。

property Position: Integer default 0;

説明

実行時，スクロールバーをスクロールするにしたがって，Position プロパティの値が変化します。


TControlScrollBar.Range
TControlScrollBar.Range3084008

TControlScrollBar	参照

Range プロパティは，フォームまたはスクロールボックスをどれだけ移動できるかを指定します。

property Range: Integer default 0;

説明

Range プロパティは，フォームまたはスクロールボックスの仮想サイズ（ピクセル単位）を表します。たとえば，フォームの水平スクロールバーの Range が 500，フォームの幅が 200 なら，スクロールバーの位置は 0～300 となります。

水平スクロールバーの Range がフォームまたはスクロールボックスの幅より小さい場合，水平スクロールバーは表示されません。垂直スクロールバーの Range がフォームまたはスクロールボックスの高さより小さい場合，垂直スクロールバーは表示されません。

Range の値は自動的に設定されますが，オブジェクトインスペクタまたはプログラムコード内でオーバーライドされます。


TControlScrollBar.ScrollPos
TControlScrollBar.ScrollPos3084009

TControlScrollBar	参照

ScrollPos プロパティは，Position プロパティの現在の値を示します。

property ScrollPos: Integer;

説明

ScrollPos プロパティは読み出し専用で，Position プロパティの現在の値を返します。


TControlScrollBar.Tracking
TControlScrollBar.Tracking3084010

TControlScrollBar

Tracking プロパティは，スクロールボックスを離す前にフォームまたはスクロールボックスがスクロールするかどうかを指定します。

property Tracking: Boolean default False;

説明

Tracking プロパティが True の場合，スクロールボックス内またはフォーム内のイメージはスクロールボックスとともにスクロールします。False の場合，スクロールボックスを離すまでスクロールしません。


TControlScrollBar.Visible
TControlScrollBar.Visible3084011

TControlScrollBar	参照

Visible プロパティは，スクロールバーを表示するかどうかを指定します。

property Visible: Boolean default True;

説明

Visible プロパティが True の場合，ビジュアルコンポーネントと，フォームまたはスクロールボックスの端との距離がMargin ピクセルより小さければスクロールバーが表示されます。


TControlScrollBar メソッド3084012

TControlScrollBar	アルファベット順

TControlScrollBar

Assign

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TControlScrollBar メソッド3084013

TControlScrollBar	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TControlScrollBar.Assign
TControlScrollBar.Assign3084014

TControlScrollBar	参照

Assign メソッドは，TControlScrollBar コンポーネントのインスタンスの内容を他のインスタンスにコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドは，ソースオブジェクトの Visible，Range，Position，および Increment の各プロパティを TControllScrollBar コンポーネントの他のインスタンスにコピーします。


スコープ3084015

published

読み出し／書き込み

読み出し専用


継承3084016

TObject

TPersistent


TControlScrollBar 例3084017

TControlScrollBar


TControlCanvas
TControlCanvas3085001

継承	プロパティ	メソッド	イベント	参照

TControlCanvas はコントロールに関連付けられた特殊なキャンバスオブジェクトです。

ユニット

controls

説明

TControlCanvas は，コントロールのイメージを表現するための描画領域として使います。編集コントロールやリストボックスなどの標準のウィンドウコントロールは Windows によって描画されるためキャンバスは不要です。

TControlCanvas は，キャンバスとしてさまざまなプロパティ，イベント，およびメソッドを提供し，豊かなイメージの作成を支援します。さらに TControlCanvas は，コントロールオブジェクトと対話したりコントロールに関連付けられたデバイスコンテキストを管理するためのプロパティやメソッドを提供しています。

TControlCanvas は，TGraphicControl および TCustomControl がそれぞれのイメージを描画するために使います。


TControlCanvas プロパティ3085002

TControlCanvas	アルファベット順	凡例

TControlCanvas

Control

TCanvas からの継承

Brush

ClipRect

CopyMode

Font

Handle

LockCount

Pen

PenPos

Pixels


TControlCanvas プロパティ3085003

TControlCanvas	オブジェクト順	凡例

Brush

ClipRect

Control

CopyMode

Font

Handle

LockCount

Pen

PenPos

Pixels


TControlCanvas.Control
TControlCanvas.Control3085004

TControlCanvas	参照

Control プロパティは，コントロールキャンバスオブジェクトに関連付けられたコントロールを指定します。

property Control: TControl;

説明

Control プロパティは，コントロールキャンバスオブジェクトに関連付けられたコントロールにアクセスできます。コントロールキャンバスを使う TControl の派生コンポーネントは，Control プロパティを設定して関連付けを行います。コントロールキャンバスオブジェクトは，Control プロパティを使って関連するコントロールから情報を取得します。


TControlCanvas イベント3085005

TControlCanvas	アルファベット順

TCanvas からの継承

OnChange

OnChanging


TControlCanvas イベント3085006

TControlCanvas	オブジェクト順

OnChange

OnChanging


TControlCanvas メソッド3085007

TControlCanvas	アルファベット順

TControlCanvas

Destroy

FreeHandle

TCanvas からの継承

Arc

BrushCopy

Chord

CopyRect

Create

Draw

DrawFocusRect

Ellipse

FillRect

FloodFill

FrameRect

LineTo

Lock

MoveTo

Pie

Polygon

Polyline

Rectangle

Refresh

RoundRect

StretchDraw

TextExtent

TextHeight

TextOut

TextRect

TextWidth

TryLock

Unlock

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TControlCanvas メソッド3085008

TControlCanvas	オブジェクト順

Arc

Assign

BrushCopy

Chord

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyRect

Create

DefaultHandler

Destroy

Dispatch

Draw

DrawFocusRect

Ellipse

FieldAddress

FillRect

FloodFill

FrameRect

Free

FreeHandle

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LineTo

Lock

MethodAddress

MethodName

MoveTo

NewInstance

Pie

Polygon

Polyline

Rectangle

Refresh

RoundRect

SafeCallException

StretchDraw

TextExtent

TextHeight

TextOut

TextRect

TextWidth

TryLock

Unlock


TControlCanvas.Destroy
TControlCanvas.Destroy3085009

TControlCanvas	参照

Destroy メソッドは，TControlCanvas のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TControlCanvas オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。TControlCanvas は，TControlCanvas が使うコントロールのデストラクタで解放されます。

Destroy は，オブジェクトに関連付けられたメモリを解放する前に，コントロールキャンバスが使うデバイスコンテキスト（HDC）に渡されたハンドルを解放します。


TControlCanvas.FreeHandle
TControlCanvas.FreeHandle3085010

TControlCanvas	参照

FreeHandle メソッドは，コントロールキャンバスが使うデバイスコンテキスト（HDC）に渡されたハンドルを解放します。

procedure FreeHandle;

説明

FreeHandle メソッドを呼び出すと，コントロールキャンバスが使う HDC を解放できます。FreeHandle は Handle プロパティを NULL に設定します。FreeHandle を呼び出すと，いずれかの描画メソッドが呼び出されたときに HDC が再び要求されます。

注意

Handle プロパティを NULL に設定しても HDC は解放されません。また，アプリケーション自体で FreeHandle を呼び出さずに HDC を解放する場合は，Handle プロパティを NULL に設定してください。


スコープ3085011

published

読み出し／書き込み

読み出し専用


継承3085013

TObject

TPersistent

TCanvas


TControlCanvas 例3085014

TControlCanvas


TCubeDim
TCubeDim3086001

継承	プロパティ	メソッド	参照

TCubeDim は，デシジョンキューブの次元マップ内のエントリを表します。

ユニット

mxstore

説明

TCubeDim を使うと，デシジョンキューブの管理する次元や集計についての情報を取得できます。デシジョンキューブは，デシジョンキューブ内の情報を集計する項目とそのような集計値を供給する項目を記述する，TCubeDim オブジェクトのコレクションを管理します。TCubeDim のプロパティは，デシジョンキューブの次元の表示名を変更するためや，デシジョンキューブによりキャッシュされる多次元配列の値の各次元を拡張または折りたたむために使うことができます。

TCubeDim は，デシジョンキューブがデータ範囲をその次元とともに値として保持することができるための，プロパティおよびメソッドを導入します。


TCubeDim のプロパティ3086002

TCubeDim	アルファベット順	凡例

TCubeDim

BinData

BinFormat

BinType

Loaded

StartValue

TDimensionItem からの継承

ActiveFlag

BaseName

DerivedFrom

DimensionType

Fieldname

FieldType

Format

Name

TCollectionItem からの継承

Collection

DisplayName

ID

Index


TCubeDim のプロパティ3086003

TCubeDim	オブジェクト順	凡例

ActiveFlag

BaseName

BinData

BinFormat

BinType

Collection

DerivedFrom

DimensionType

DisplayName

Fieldname

FieldType

Format

ID

Index

Loaded

Name

StartValue


TCubeDim.BinData
TCubeDim.BinData3086004

TCubeDim	参照

BinData は，ページ処理された次元の実装についての情報を表します。

property BinData: TBinData;

説明

BinData プロパティは使わないでください。これは，ページ処理（永久ドリル処理）された次元を管理するために内部的に使います。


TCubeDim.BinFormat
TCubeDim.BinFormat3086005

TCubeDim	参照

BinFormat プロパティは，範囲値を形式設定する方法を示します。

property BinFormat: string;

説明

BinFormat プロパティは，日付範囲のラベルを表示する方法を示すことができます。BinFormat 文字列を構成する形式指定子は，FormatDateTime ルーチンライブラリ関数のエントリ下で記述されます。


TCubeDim.BinType
TCubeDim.BinType3086006

TCubeDim	参照

BinType プロパティは，次元が表す項目の値をグループ化する方法を示します。

TBinType = ( binNone, binYear, binQuarter, binMonth, binSet, binCustom );

property BinType: TBinType;

説明

BinType プロパティは，次元に沿って表示される値を制限します。以下に BinType の取り得る値を示します。

値	意味

binNone	次元に沿ったすべての値が表示される

binYear	次元に沿った各セルが，同じ年の日付を表現するすべての項目値を表す

binQuarter	次元に沿った各セルが，同じ四半期の日付を表現するすべての項目値を表す

binMonth	次元に沿った各セルが，同じ月の日付を表現するすべての項目値を表す

binSet	次元がページ処理（永久ドリル処理）された状態。次元のドリルダウン値は変更できるが，次元を開いたり閉じたりはできない

binCustom	binCustom は現在使われていないが提供されており，これでコンポーネント作成者は他種の日付範囲をサポートできる

BinType が binYear，binQuarter，binMonth の場合，次元に沿った範囲の値を形式設定する方法を示すために BinFormat プロパティを使います。

BinType が binSet の場合，StartValue プロパティを使って次元に沿ったどの値をドリルダウン値として使うかを指定します。標準次元のドリルダウン値（デシジョンソースにより格納されるピボット状態の一部）とは異なり，ページ処理された次元のドリルダウン値はデシジョンキューブによりキャッシュされる唯一の値です。ページ処理された次元のドリルダウン値を変更すると，デシジョンキューブがそのキャッシュの再構築を実行します。ただし，この処理には非常に時間がかかります。

注意

BinType が binSet のときは，次元項目がデシジョンキューブ内で消費するメモリはかなり少なくて済みます。

注意

次元が日付または日付時刻項目を表していないときは，BinType を binYear，binQuarter，binMonth に設定しないでください。


TCubeDim.Loaded
TCubeDim.Loaded3086007

TCubeDim	参照

Loaded プロパティは，次元項目がデシジョンキューブにより現在キャッシュさているかどうかを示します。

property Loaded: Boolean;

説明

Loaded プロパティは，次元項目がデシジョンキューブを介して現在使用できるかどうかを判別します。ActiveType プロパティが diActive の場合，Loaded は常に True です。ActiveType の値が diInactive のときは，Loaded は常に False です。ActiveType の値が diAsNeeded の場合，次元項目がデシジョンソースで利用できるように，Loaded を使ってデシジョンキューブが次元項目をキャッシュ済みかどうかを判別できます。

Loaded が True のときは，次元項目はメモリを消費します。Loaded が False のときは，次元項目を使用できません。


TCubeDim.StartValue
TCubeDim.StartValue3086008

TCubeDim	参照

StartValue プロパティは，値を次元に沿ってグループ化する方法を指定します。

property StartValue: string;

説明

BinType プロパティが binYear，binQuarter，binMonth の場合，StartValue を次元の最初の範囲で最初の日付に設定します。BinType プロパティが binSet の場合，StartValue を次元のドリルダウン値に設定します。


TCubeDim のメソッド3086010

TCubeDim	アルファベット順

TCubeDim

GetBinValues

IsBinData

TDimensionItem からの継承

IsDimension

IsSummary

TCollectionItem からの継承

Create

Destroy

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCubeDim のメソッド3086011

TCubeDim	オブジェクト順

Assign

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetBinValues

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

IsBinData

IsDimension

IsSummary

MethodAddress

MethodName

NewInstance

SafeCallException


TCubeDim.GetBinValues
TCubeDim.GetBinValues3086012

TCubeDim	参照

GetBinValues メソッドは，次元に沿って 1 つの値で集計される値のセットを示します。

function GetBinValues(Value: Variant): Variant;

説明

GetBinValues メソッドを呼び出すと，BinType プロパティが binNone でないときに 1 つの次元メンバーの基礎をなす実際の値を指定できます。Value パラメータは，日付範囲またはページ処理された次元の 1 つの値を表す 1 つの次元メンバーです。Value の値を取得するには，デシジョンキューブまたはデシジョンソースの GetMemberAsVariant メソッドを呼び出します。

次元の BinType プロパティが binYear，binQuarter，binMonth の場合，GetBinValues は Value パラメータを含む範囲の開始値と終了値を返します。BinType プロパティが binSet の場合，GetBinValues は次元のドリル処理された 1 つの値を返します。


TCubeDim.IsBinData
TCubeDim.IsBinData3086013

TCubeDim	参照

IsBinData メソッドは，次元が各項目値のメンバーを保持するかどうかを示します。

function IsBinData: Boolean;

説明

IsBinData メソッドを呼び出すと，次元項目がデシジョンキューブの（値を日付範囲にグループ化したり，ページ処理された次元を表したりする）次元を表現するかどうかを判別できます。BinType プロパティの値が binNone でない場合，IsBinData は True を返します。


スコープ3086014

published

アクセス種別

読み出し専用


継承3086015

TObject

TPersistent

TCollectionItem

TDimensionItem


TCubeDim の例3086016

TCubeDim


TCubeDims

Hierarchy	Properties	Methods	See also

Unit

mxstore

Description

TCubeDims is a collection of TCubeDim objects.

Use TCubeDims as the dimension map of a crosstabulated data store. Each TCubeDim object maintained by TCubeDims corresponds to a field from the data set of the crosstabulated data store. Each TCubeDim object can be used as either a dimension (a field over which data is summarized), or a summary (a value summarized over the dimensions).

TCubeDims introduces new properties to handle dimension maps that include date ranges.


TCubeDims properties

TCubeDims	Alphabetically	Legend

In TCubeDims

IsDirty

Items

Derived from TDimensionItems

ActiveDimensionCount

ActiveSummaryCount

DimensionCount

SummaryCount

Derived from TCollection

Count

ItemClass


TCubeDims properties

TCubeDims	By object	Legend

ActiveDimensionCount

ActiveSummaryCount

Count

DimensionCount

IsDirty

ItemClass

Items

SummaryCount


TCubeDims.IsDirty

TCubeDims	See also

IsDirty indicates that the fields that correspond to the TCubeDim objects in the Items array have changed.

property IsDirty: Boolean;

Description

Read IsDirty to determine whether the information cached by the decision cube is valid. When any of the properties of the TCubeDim objects in the Items array change, IsDirty becomes True. When the value of IsDirty is read, IsDirty is reset to False.


TCubeDims.Items

TCubeDims	See also

Items is an indexed array of all dimension items maintained by the TCubeDims object.

property Items[Index: Integer]:TCubeDim default;

Description

Use Items to access individual dimensions or summaries maintained by the TCubeDims object. The first TCubeDim object has an Index of 0, the second has an Index of 1, and so on.

Each TCubeDim object in the Items array represents a field from the data set of a decision cube. Each item represents either a dimension (a field over which data is summarized), or a summary (a value summarized over the dimensions).

Items is the default property of TCubeDims. This means that the name of the Items property can be eliminated from code that uses the Items property. Thus, the line

DecisionCube1.DimensionMap.Items[0].Active := False;

could be written

DecisionCube1.DimensionMap[0].Active := False;

Note

Do not change the Items property. The set of items in the Items array is set automatically to represent the fields from the data set. The properties of individual TCubeDim objects within the Items array may be changed to specify whether they should be cached by the data store, the name to use when displaying them, and so on.


TCubeDims methods

TCubeDims	Alphabetically

Derived from TDimensionItems

Add

AddDerivedField

AlreadyExists

Assign

AverageFieldCheck

Create

Derived from TCollection

BeginUpdate

Clear

Destroy

EndUpdate

FindItemID

Derived from TPersistent

GetNamePath

Derived from TObject

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCubeDims methods

TCubeDims	By object

AddDerivedField

Add

AlreadyExists

Assign

AverageFieldCheck

BeginUpdate

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

EndUpdate

FieldAddress

FindItemID

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


Accessibility

Read-only


Hierarchy

TObject

TPersistent

TCollection

TDimensionItems


TCubeDims example

TCubeDims


TCustomWebDispatcher
TCustomWebDispatcher3088001

継承	プロパティ	メソッド	イベント	参照

TCustomWebDispatcher は Web デスパッチャオブジェクトの抽象基本クラスです。

ユニット

httpapp

説明

TCustomWebDispatcher から派生するオブジェクトを Web アプリケーションに追加すると，Web アプリケーションから HTTP 要求メッセージに応答できます。Web アプリケーションを作成すると，TCustomWebDispatcher の派生オブジェクトである TWebModule オブジェクトが自動的に組み込まれます。デフォルトの Web モジュールをそのまま使うか，TCustomWebDispatcher の派生オブジェクト（TWebDispatcher など）が入っている別のデータモジュールに置き換えてください。

TCustomWebDispatcher は HTTP 要求メッセージに対する応答を構築するアクション項目を管理します。TWebApplication オブジェクトが HTTP 要求メッセージを受け取ると，TCustomWebDispatcher はその要求を適切なアクション項目に渡してメッセージを処理します。

TCustomWebDispatcher は，TCustomContentProducer オブジェクトのために現在の HTTP メッセージに関する情報の追跡も行います。


TCustomWebDispatcher プロパティ3088002

TCustomWebDispatcher	アルファベット順	凡例

TCustomWebDispatcher

Action

Actions

Request

Response

TDataModule からの継承

DesignOffset

DesignSize

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TCustomWebDispatcher プロパティ3088003

TCustomWebDispatcher	オブジェクト順	凡例

Action

Actions

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

DesignOffset

DesignSize

Name

Owner

Request

Response

Tag

VCLComObject


TCustomWebDispatcher.Action
TCustomWebDispatcher.Action3088004

TCustomWebDispatcher	参照

Action プロパティは，TCustomWebDispatcher オブジェクトが管理している各アクション項目にインデックスを使ってアクセスできるようにします。

property Action[Index: Integer]: TWebActionItem;

説明

Action プロパティは，Actions コレクションのすべてのアクションを繰り返し処理することができます。インデックスは，0 が最初のアクション項目のインデックス，1 が 2 番目のアクション項目のインデックスといった具合に付けられます。名前を使って各アクションにアクセスする場合は ActionByName メソッドを使ってください。


TCustomWebDispatcher.Actions
TCustomWebDispatcher.Actions3088005

TCustomWebDispatcher	参照

Actions プロパティは，TCustomWebDispatcher オブジェクトが管理するアクション項目のコレクションです。

property Actions: TWebActionItems;

説明

TWebActionsItems のメソッドを使うと，ディスパッチャ用にアクション項目を追加したり，ディスパッチャが管理するアクション項目のセットをクリアしたり，アクション項目の属性にアクセスしたりできます。


TCustomWebDispatcher.Request
TCustomWebDispatcher.Request3088006

TCustomWebDispatcher	参照

Request プロパティは，現在ディスパッチャが処理している TWebRequest オブジェクトです。

property Request: TWebRequest;

説明

Request プロパティは，現在の HTTP 要求メッセージについての情報を取得できます。ディスパッチャはこの TWebRequest オブジェクトとアクション項目を照合し，アクション項目の OnAction イベントハンドラを呼び出して HTTP 要求メッセージに対する応答を生成および送信します。多くの場合，OnAction イベントハンドラは TCustomContentProducer の下位オブジェクトを使って要求メッセージに対する応答処理の生成を支援します。これらのコンテンツ作成オブジェクトは Request プロパティを使って HTTP 応答の内容を正しく作成できます。


TCustomWebDispatcher.Response
TCustomWebDispatcher.Response3088007

TCustomWebDispatcher	参照

Response プロパティは，現在ディスパッチャが処理している HTTP メッセージの TWebResponse オブジェクトです。

property Response: TWebResponse;

説明

Response は，現在の HTTP 要求メッセージに対して新しく作成される応答の情報を取得できます。ディスパッチャは，Request プロパティで指定された要求オブジェクトとアクション項目を照合します。次に，アクション項目の OnAction イベントハンドラを呼び出して，Response プロパティで指定された TWebResponse オブジェクトに情報を提供します。多くの場合，OnAction イベントハンドラは TCustomContentProducer の下位オブジェクトを使って応答処理の生成を支援します。これらのコンテンツ作成オブジェクトは Response を使って，新しく作成中の応答の状態を判断できます。


TCustomWebDispatcher イベント3088008

TCustomWebDispatcher	アルファベット順	凡例

TCustomWebDispatcher

AfterDispatch

BeforeDispatch

TDataModule からの継承

OnCreate

OnDestroy


TCustomWebDispatcher イベント3088009

TCustomWebDispatcher	オブジェクト順	凡例

AfterDispatch

BeforeDispatch

OnCreate

OnDestroy


TCustomWebDispatcher.AfterDispatch
TCustomWebDispatcher.AfterDispatch3088010

TCustomWebDispatcher	参照

AfterDispatch イベントは，アクション項目が HTTP 応答メッセージをすべて設定してから，まだ送信していないときに発生します。

THTTPMethodEvent = procedure (Sender: TObject; Request: TWebRequest;

    Response: TWebResponse; var Handled: Boolean) of object;

property AfterDispatch: THTTPMethodEvent;

説明

AfterDispatch イベントハンドラを記述すると，Web クライアントに HTTP 応答メッセージを送信する前にメッセージ内容の最終チェックを行うことができます。AfterDispatch イベントハンドラは応答処理をそのまま保持したり，変更や送信を行ったり，Web アプリケーションが応答を送信しないように Handled パラメータを False に変更したりできます。

AfterDispatch イベントは，応答が処理されなかったことをすべてのアクション項目が示す場合や，いずれかのアクション項目から応答が返された場合には発生しません。


TCustomWebDispatcher.BeforeDispatch
TCustomWebDispatcher.BeforeDispatch3088011

TCustomWebDispatcher	参照

BeforeDispatch イベントは，ディスパッチャが HTTP 要求メッセージとアクション項目を照合する前に発生します。

THTTPMethodEvent = procedure (Sender: TObject; Request: TWebRequest;

    Response: TWebResponse; var Handled: Boolean) of object;

property BeforeDispatch: THTTPMethodEvent;

説明

BeforeDispatch イベントハンドラを記述すると，すべての HTTP 要求メッセージの前処理を行うことができます。BeforeDispatch イベントハンドラは，応答に適したアクション項目を使用可能/使用不可にしたり，応答オブジェクトの設定を始めたり，ほかに必要な前処理を行ったりできます。

BeforeDispatch イベントハンドラは応答オブジェクトの設定を完了した後，ディスパッチャがどのアクション項目にも要求を送らないように，Handled パラメータを True に変更しなければなりません。BeforeDespatch イベントハンドラが応答メッセージを送信する場合は，Handled パラメータが False のままでも，ディスパッチャはアクション項目に要求を渡しません。

BeforeDispatch イベントハンドラが Handled パラメータを True に設定しているにもかかわらず応答を返さない場合，Web ディスパッチャは AfterDispatch イベントを生成します。


TCustomWebDispatcher メソッド3088012

TCustomWebDispatcher	アルファベット順	凡例

TCustomWebDispatcher

ActionByName

Create

Destroy

DispatchAction

DoAfterDispatch

DoBeforeDispatch

Notification

TDataModule からの継承

CreateNew

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomWebDispatcher メソッド3088013

TCustomWebDispatcher	オブジェクト順	凡例

ActionByName

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateNew

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DispatchAction

DoAfterDispatch

DoBeforeDispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

Notification

RemoveComponent

SafeCallException


TCustomWebDispatcher.ActionByName
TCustomWebDispatcher.ActionByName3088014

TCustomWebDispatcher	参照

ActionByName メソッドは，AName パラメータで指定されるアクション項目を返します。

function ActionByName(const AName: string): TWebActionItem;

説明

アクション項目の名前がわかっているときに ActionByName を呼び出すと，個々のアクション項目にアクセスできます。アクション項目のプロパティを変更すると，アクション項目はほかの HTTP 要求メッセージを処理したり，OnAction イベントハンドラを呼び出して HTTP 要求メッセージに応答したりできます。


TCustomWebDispatcher.Create
TCustomWebDispatcher.Create3088015

TCustomWebDispatcher	参照

Create メソッドは，TCustomWebDispatcher のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

アプリケーションでは TCustomWebDispatcher のコンストラクタを呼び出さないでください。Web アプリケーションには Web モジュールが自動的に組み込まれます。Web モジュールを別のデータモデルに置き換える場合は，設計時に Web ディスパッチャを新しいデータモジュールに追加しなければなりません。設計時に配置されたオブジェクトは自動的に作成されます。Web モジュール内や，すでに Web ディスパッチャが存在しているデータモジュール内で，アプリケーションがディスパッチャオブジェクトを作成しようとすると例外が発生します。

Create は TWebActionItems オブジェクトを作成し，ディスパッチャによって管理されるアクション項目を保持できるようにします。Web ディスパッチャが別のデータモジュールに組み込まれている場合，Create はそのデータモジュール内のコンテンツ作成オブジェクトに自身への参照を追加します。

Web ディスパッチャが実行時に作成されると，Create は OnCreate イベントを生成します。


TCustomWebDispatcher.Destroy
TCustomWebDispatcher.Destroy3088016

TCustomWebDispatcher	参照

Destroy メソッドは，TCustomWebDispatcher のインスタンスを解放します。

destructor Destroy; override;

説明

アプリケーションで直接 TCustomWebDispatcher を破棄しないでください。ディスパッチャはサーバーアプリケーションが終了したとき自動的に解放されます。

Destroy は，アクション項目のコレクションを保持していた TWebActionItems オブジェクトを解放します。


TCustomWebDispatcher.DispatchAction
TCustomWebDispatcher.DispatchAction3088017

TCustomWebDispatcher	参照

DispatchAction メソッドは，HTTP 要求メッセージが処理されるまで Actions 内のアクション項目に要求メッセージを渡します。

function DispatchAction(Request: TWebRequest; Response: TWebResponse): Boolean;

説明

Web アプリケーションは HTTP 要求メッセージを受け取ったときに DispatchAction メソッドを呼び出すので，ディスパッチャは応答を生成するアクション項目に要求をディスパッチできます。

DispatchAction は，Request パラメータで表される HTTP 要求メッセージを処理するアクション項目を探す前に BeforeDispatch イベントを生成します。BeforeDispatch イベントハンドラがアクションを処理する場合，ディスパッチャはどのアクション項目にも要求メッセージを渡しません。

BeforeDispatch イベントハンドラがないか，BeforeDispatch イベントハンドラが要求を処理しない場合，DispatchAction は要求の MethodType および PathInfo と Actions プロパティ内の各アクション項目の MethodType および PathInfo プロパティを照合します。アクション項目が要求の MethodType および PathInfo と一致した場合，DispatchAction は OnAction イベントハンドラを呼び出します。

OnAction イベントハンドラは要求に対する応答処理を完了させることができます。また，要求が完全に処理されていないことを示して，別のアクション項目でその要求の処理を完了させることもできます。OnAction イベントハンドラが要求を完了しないと，DispatchAction は Actions プロパティ内のアクション項目を調べ，一致する項目が見つかったときに OnAction イベントハンドラを呼び出すという処理を繰り返します。

すべてのアクション項目が調べられたにもかかわらず要求が完全に処理されない場合，DispatchAction はデフォルトのアクション項目の OnAction イベントハンドラを呼び出します。

BeforeDispatch イベントハンドラまたはアクション項目が要求を処理した場合，DispatchAction は AfterDispatch イベントを生成します。BeforeDispatch イベントまたはアクション項目がすでに応答を返している場合には，AfterDispatch イベントは発生しません。

DispatchAction は論理値を返して，Web アプリケーションが未送信の応答メッセージを送信すべきかどうかを示します。アクション項目がアクションを処理し，AfterDispatch イベントハンドラが Handled パラメータを False に変更しなかった場合には，DispatchAction は True を返します。


TCustomWebDispatcher.DoAfterDispatch
TCustomWebDispatcher.DoAfterDispatch3088018

TCustomWebDispatcher	参照

DoAfterDispatch メソッドは，AfterDispatch イベントを生成し，Web アプリケーションが応答を返せるかどうかを示す値を返します。

function DoAfterDispatch(Request: TWebRequest; Response: TWebResponse): Boolean;

説明

アプリケーションは DoAfterDispatch を呼び出すことはできません。DispatchAction メソッドは，対応するアクション項目に HTTP 要求メッセージを送ってから DoAfterDispatch を呼び出します。アクション項目または BeforeDispatch イベントハンドラが HTTP 要求メッセージを処理しなかった場合，DispatchAction メソッドは DoAfterDispatch を呼び出しません。また，メッセージがすでに Web クライアントに返されていた場合にも，DoAfterDispatch は呼び出されません。

AfterDispatch イベントハンドラが応答を返さないよう指示している場合，DoAfterDispatch は False を返し，Web アプリケーションは応答メッセージを返さずに接続を切断します。それ以外の場合，DoAfterDispatch は True を返し，AfterDispatch イベントハンドラが応答メッセージを返していなければ，Web アプリケーションがそのメッセージを返します。


TCustomWebDispatcher.DoBeforeDispatch
TCustomWebDispatcher.DoBeforeDispatch3088019

TCustomWebDispatcher	参照

DoBeforeDispatch メソッドは BeforeDispatch イベントを生成し，ディスパッチャが要求を処理するアクション項目を探すべきかどうかを示す値を返します。

function DoBeforeDispatch(Request: TWebRequest; Response: TWebResponse): Boolean;

説明

アプリケーションは DoBeforeDispatch を呼び出すことはできません。DispatchAction メソッドは，HTTP 要求メッセージとアクション項目を照合する前に DoBeforeDispatch を呼び出します。

BeforeDispatch イベントハンドラが要求メッセージを処理したことを示している場合，DoBeforeDispatch は True を返し，DispatchAction メソッドはどのアクション項目にも要求メッセージを渡しません。それ以外の場合，DoBeforeDispatch は False を返し，BefoereDispatch イベントハンドラが応答メッセージを返していなければ，DispatchAction メソッドは要求メッセージを処理するアクション項目を探し続けます。

DoBeforeDispatch が True を返したにもかかわらず応答が返らなかった場合，DispatchAction は AfterDispatch イベントを生成します。


TCustomWebDispatcher.Notification
TCustomWebDispatcher.Notification3088020

TCustomWebDispatcher	参照

Notification メソッドは，継承メソッドをオーバーライドして，アプリケーションに追加された TCustomContentProducer オブジェクトにディスパッチャを導入します。

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

Notification は，TCustomContentProducer オブジェクトがアプリケーションに追加されるときに Dispatcher プロパティを設定することで，すべての TCustomContentProducer オブジェクトがディスパッチャにアクセスできることを保証します。


スコープ3088021

published

読み出し／書き込み

読み出し専用


スコープ3088022

protected


スコープ3088023

protected

published


継承3088024

TObject

TPersistent

TComponent

TDataModule


TCustomWebDispatcher 例3088025

TCustomWebDispatcher


TCustomContentProducer
TCustomContentProducer3089001

継承	プロパティ	メソッド	参照

TCustomContentProducer は，送信する HTTP 応答メッセージの内容となる文字列を作成するすべてのオブジェクトの基本クラスです。

ユニット

httpapp

説明

TCustomContentProducer は，クラスを定義して HTTP 応答メッセージの内容を作成するときの基本クラスとして使います。通常は，コンテンツ作成オブジェクトが HTML コマンドの文字列を解釈します。ただし，TCustomContentProducer の下位クラスを定義して有効な MIME 型を作成することもできます。


TCustomContentProducer プロパティ3089002

TCustomContentProducer	アルファベット順	凡例

TCustomContentProducer

Dispatcher

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TCustomContentProducer プロパティ3089003

TCustomContentProducer	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Dispatcher

Name

Owner

Tag

VCLComObject


TCustomContentProducer.Dispatcher
TCustomContentProducer.Dispatcher3089004

TCustomContentProducer	参照

Dispatcher プロパティは，TCustomContentProducer オブジェクトを組み込んだ Web サーバーアプリケーションのディスパッチャです。

property Dispatcher: TCustomWebDispatcher;

説明

Dispatcher を使うとディスパッチャにアクセスできます。ディスパッチャのプロパティは，現在処理されている HTTP メッセージの TWebRequest オブジェクトおよび TWebResponse オブジェクトにアクセスする方法を提供します。これらのオブジェクトを使うと，コンテンツ作成オブジェクトが生成している応答文字列を用いるメッセージについて詳細な情報を取得できます。


TCustomContentProducer メソッド3089005

TCustomContentProducer	アルファベット順	凡例

TCustomContentProducer

Content

ContentFromStream

ContentFromString

Notification

TComponent からの継承

Create

Destroy

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomContentProducer メソッド3089006

TCustomContentProducer	オブジェクト順	凡例

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Content

ContentFromStream

ContentFromString

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

Notification

RemoveComponent

SafeCallException


TCustomContentProducer.Content
TCustomContentProducer.Content3089007

TCustomContentProducer	参照

Content メソッドは，コンテンツ作成オブジェクトが作成した内容を返します。

function Content: string; virtual;

説明

Content を呼び出すと，HTTP 応答メッセージで使う内容を取り出すことができます。TCustomContentProducer は空の文字列を返しますが，TCustomContentProducer の派生オブジェクトは，それぞれが作成する内容の値を返します。この内容は有効な MIME 型の場合もありますが，通常は HTML コマンドの文字列です。


TCustomContentProducer.ContentFromStream
TCustomContentProducer.ContentFromStream3089008

TCustomContentProducer	参照

ContentFromStream メソッドは，ストリームから読み出された入力情報に応じて，コンテンツ作成オブジェクトが作成する内容を返します。

function ContentFromStream(Stream: TStream): string; virtual;

説明

ContentFromStream を呼び出すと，Stream パラメータが提供する情報に基づいて，コンテンツ作成オブジェクトが作成する内容を取り出すことができます。TCustomContentProducer は Stream パラメータを無視し，Content メソッドが作成する値を返します。

TCustomContentProducer の派生オブジェクトはこのメソッドをオーバーライドして，ストリームに渡された入力情報を独自の方法で解釈します。


TCustomContentProducer.ContentFromString
TCustomContentProducer.ContentFromString3089009

TCustomContentProducer	参照

ContentFromString メソッドは，入力文字列に応じて，コンテンツ作成オブジェクトが作成する内容を返します。

function ContentFromString(const S: string): string; virtual;

説明

ContentFromString を呼び出すと，S パラメータが提供する情報に基づいて，コンテンツ作成オブジェクトが作成する内容を取り出すことができます。TCustomContentProducer はこの文字列を無視し，Content メソッドが作成する値を返します。

TCustomContentProducer の下位オブジェクトは，このメソッドをオーバーライドして入力文字列を独自の方法で解釈します。


TCustomContentProducer.Notification
TCustomContentProducer.Notification3089010

TCustomContentProducer	参照

Notification メソッドは，継承メソッドをオーバーライドして，ディスパッチャが破棄されるというメッセージに応答します。

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

Notification は継承メソッドを呼び出した後，この呼び出しの原因がディスパッチャの破棄にあるかどうかを調べます。ディスパッチャの破棄が原因の場合，Dispatcher プロパティは nil に設定されます。


スコープ3089011

published

読み出し／書き込み

読み出し専用


スコープ3089012

protected


継承3089013

TObject

TPersistent

TComponent


TCustomContentProducer 例3089014

TCustomContentProducer


TCustomCheckBox
TCustomCheckBox3090001

継承	プロパティ	メソッド	参照

TCustomCheckBox コンポーネントは，すべてのチェックボックスコンポーネントの上位オブジェクトです。

ユニット

stdctrls

説明

TCustomCheckBox コンポーネントは，TCheckBox や TDBCheckBox を含むチェックボックスコンポーネントの上位にある抽象クラスです。各チェックボックスには，選択（チェック）したり，選択を解除（チェックをはずす）したりできるオプションがあります。


TCustomCheckBox プロパティ3090002

TCustomCheckBox	アルファベット順	凡例

TCustomCheckBox

Alignment

AllowGrayed

Checked

State

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomCheckBox プロパティ3090003

TCustomCheckBox	オブジェクト順	凡例

Align

Alignment

AllowGrayed

BoundsRect

Brush

Checked

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentWindow

ShowHint

Showing

State

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TCustomCheckBox.Alignment
TCustomCheckBox.Alignment3090004

TCustomCheckBox

Alignment プロパティは，チェックボックスのキャプションの位置を決定します。

property Alignment: TLeftRight;

説明

Alignment プロパティが taRightJustify の場合，キャプションはチェックボックスの右側に表示されます。taLeftJustify の場合は左側に表示されます。


TCustomCheckBox.AllowGrayed
TCustomCheckBox.AllowGrayed3090005

TCustomCheckBox	参照

AllowGrayed プロパティは，チェックボックスを淡色表示にできるかどうかを指定します。

property AllowGrayed: Boolean;

説明

AllowGrayed プロパティが True の場合，チェックボックスはチェック，非チェック，淡色表示の 3 つの状態を持つことができます。False の場合は，チェック，非チェックの 2 つの状態しか持てません。


TCustomCheckBox.Checked
TCustomCheckBox.Checked3090006

TCustomCheckBox	参照

Checked プロパティは，チェックボックスの状態を取得，設定します。

property Checked: Boolean;

説明

Checked プロパティが True の場合，チェックボックス内にチェックマークが表示され（State = cbChecked），オプションが選択されていることを表します。False の場合，チェックボックスはチェックされていない（State = cbUnchecked）か，淡色表示（State = cbGrayed）状態にあります。


TCustomCheckBox.State
TCustomCheckBox.State3090007

TCustomCheckBox	参照

State プロパティは，チェックボックスがチェック，非チェック，淡色表示のいずれの状態にあるかを指定します。

type TCheckBoxState = (cbUnchecked, cbChecked, cbGrayed);

property State: TCheckBoxState;

説明

以下に State の値を示します。

値	意味

cbUnchecked	チェックボックスがチェックされていない。オプションが選択されていないことを示す

cbChecked	チェックボックスがチェックされている。オプションが選択されていることを示す

cbGrayed	チェックボックスが淡色表示されている。一般に，オプションの一部が選択されていることを示す


TCustomCheckBox メソッド3090008

TCustomCheckBox	アルファベット順	凡例

TCustomCheckBox

Create

CreateParams

CreateWindowHandle

CreateWnd

Toggle

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Click

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomCheckBox メソッド3090009

TCustomCheckBox	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Click

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParams

CreateParented

CreateWindowHandle

CreateWnd

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Toggle

Update

UpdateControlState


Click

Click メソッドは，OnClick イベントを生成します。

procedure Click; override;

説明

Protected の Click メソッドは，チェックボックスをクリックすると自動的に呼び出されます。OnClick イベントの生成に加え，親のコントロールウィンドウにメッセージを送信して，チェックボックスの状態が変更されたことを通知します。


TCustomCheckBox.Create
TCustomCheckBox.Create3090011

TCustomCheckBox

Create メソッドは，TCustomCheckBox インスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にチェックボックスを作成できます。設計時にフォーム上に配置されたチェックボックスに対しては，Create メソッドは自動的に呼び出されます。


TCustomCheckBox.CreateParams
TCustomCheckBox.CreateParams3090012

TCustomCheckBox	参照

CreateParams メソッドは，ウィンドウ作成パラメータレコードを初期化します。

procedure CreateParams(var Params: TCreateParams); override;

説明

CreateParams メソッドは継承メソッドを呼び出してから，チェックボックス個々の変更を行います。


TCustomCheckBox.CreateWindowHandle
TCustomCheckBox.CreateWindowHandle3090013

TCustomCheckBox	参照

CreateWindowHandle メソッドは，チェックボックスのウィンドウハンドルを作成します。

procedure CreateWindowHandle(const Params: TCreateParams); override;

説明

CreateWindowHandle メソッドは，Windows NT システムが必要とする特別な処理をいくつか実行してから継承メソッドを呼び出します。


TCustomCheckBox.CreateWnd
TCustomCheckBox.CreateWnd3090014

TCustomCheckBox	参照

CreateWnd メソッドは，チェックボックスに対応する Windows コントロールを作成します。

procedure CreateWnd; override;

説明

CreateWnd メソッドは継承メソッドを呼び出してから，コントロールのチェック状態を BM_SETCHECK メッセージを送ってコントロールのチェック状態を設定します。


TCustomCheckBox.Toggle
TCustomCheckBox.Toggle3090015

TCustomCheckBox	参照

Toggle メソッドは，チェックボックスの状態を変更します。

procedure Toggle; virtual;

説明

Toggle メソッドは，プログラム内からチェックボックスを選択したり選択を解除したりするのに使います。チェックボックスの有効な状態の間で，チェック状態から未チェック状態や淡色表示状態へ，あるいはチェック状態から未チェック状態へなどの切り替えを行います。


スコープ3090016

protected

published

読み出し／書き込み

読み出し専用


スコープ3090017

protected


継承3090018

TObject

TPersistent

TComponent

TControl

TWinControl

TButtonControl


TCustomCheckBox 例3090019

TCustomCheckBox


TCustomComboBox
TCustomComboBox3091001

継承	プロパティ	メソッド	イベント	参照

TCustomComboBox コンポーネントはコンボボックスコンポーネントの基本クラスです。

ユニット

stdctrls

説明

TCustomComboBox コンポーネントは，専用の Windows コンボボックスを表すコントロールを定義するときに基本クラスとして使います。コンボボックスはスクロール可能なリストを持つ編集ボックスで，そのドロップダウンリストから項目を選択したり，編集ボックスに項目を直接入力したりできます。

TCustomComboBox のインスタンスを作成しないでください。コンボボックスをフォームに配置するには, TComboBox などの TCustomComboBox の派生オブジェクトを使います。


TCustomComboBox プロパティ3091002

TCustomComboBox	アルファベット順	凡例

TCustomComboBox

Canvas

DropDownCount

DroppedDown

EditHandle

ItemHeight

ItemIndex

Items

ListHandle

MaxLength

SelLength

SelStart

SelText

Sorted

Style

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ParentColor

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomComboBox プロパティ3091003

TCustomComboBox	オブジェクト順	凡例

Align

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

DropDownCount

DroppedDown

EditHandle

Enabled

Handle

Height

HelpContext

Hint

ItemHeight

ItemIndex

Items

Left

ListHandle

MaxLength

Name

Owner

Parent

ParentColor

ParentWindow

SelLength

SelStart

SelText

ShowHint

Showing

Sorted

Style

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TCustomComboBox.Canvas
TCustomComboBox.Canvas3091004

TCustomComboBox	参照

Canvas プロパティは，オーナー描画コンボボックスの描画面にアクセスできます。

property Canvas: TCanvas;

説明

Canvas プロパティは，OnDrawItem イベントハンドラを実装するときに描画表面として使います。


TCustomComboBox.DropDownCount
TCustomComboBox.DropDownCount3091005

TCustomComboBox	参照

DropDownCount プロパティは，ドロップダウンリストに表示する項目の最大数です。

property DropDownCount: Integer;

説明

デフォルトでは，ドロップダウンリストはユーザーがスクロールしなくても 8 項目を表示できる長さです。ドロップダウンリストの長さを変更するには，DropDownCount に値を指定します。

DropDownCount の値が Items プロパティ内の項目の数よりも大きい場合，ドロップダウンリストの長さは項目に合わせて調整されます。DropDownCount の値が Items プロパティ内の項目よりも小さい場合，ドロップダウンリストはスクロールバーを表示します。

注意

DropDownCount は Style の値が csSimple でない場合にのみ有効です。


TCustomComboBox.DroppedDown
TCustomComboBox.DroppedDown3091006

TCustomComboBox	参照

DroppedDown プロパティは，ドロップダウンリストが現在表示されているかどうかを示します。

property DroppedDown: Boolean;

説明

DroppedDown プロパティは，ドロップダウンリストが表示されているかどうかを取得できます。 DroppedDown を設定するとリストを開いたり閉じたりできます。ドロップダウンリストが開いていれば True で閉じていれば False です。

注意

DroppedDown は Style の値が csSimple でない場合にのみ有効です。


TCustomComboBox.EditHandle
TCustomComboBox.EditHandle3091007

TCustomComboBox	参照

EditHandle プロパティは，コンボボックスの編集領域のウィンドウハンドルです。

property EditHandle: HWnd;

説明

EditHandleプロパティは，コンボボックスの編集領域で使うウィンドウのハンドルを必要とする Windows API 呼び出しに使用できます。


TCustomComboBox.ItemHeight
TCustomComboBox.ItemHeight3091008

TCustomComboBox	参照

ItemHeight プロパティは，ドロップダウンリストの項目の高さをピクセル単位で示します。

property ItemHeight: Integer;

説明

ItemHeight プロパティは，Style が csOwnerDrawFixed に設定されている場合にリストに入っている項目を描画するために必要な高さを指定できます。Style が csOwnerDrawVariable の場合，ItemHeight はリストの項目を描画するためのデフォルトの高さです。Style が csOwnerDrawVariable の場合，ItemHeight は OnMeasureItem イベントハンドラによってオーバーライドされます。Style がそれ以外の値に設定されている場合，ItemHeight プロパティは無効です。


TCustomComboBox.ItemIndex
TCustomComboBox.ItemIndex3091009

TCustomComboBox	参照

ItemIndex プロパティは，ドロップダウンリスト内の選択された項目を示します。

property ItemIndex: Integer;

説明

ItemIndex プロパティは，コンボボックスの値になっているリスト内の項目を特定できます。この値はコンボボックスの編集ボックスで表示されます。リスト内の最初の項目のインデックスは 0 で，2 番目の項目のインデックスは 1 です。項目が選択されていなければ ItemIndex の値は -1 です。

ItemIndex を設定するとリストからプログラムで項目を選択できます。


TCustomComboBox.Items
TCustomComboBox.Items3091010

TCustomComboBox	参照

Items プロパティは，コンボボックスのドロップダウンリストの項目（文字列）リストです。

property Items: TStrings;

説明

Items プロパティは，コンボボックスリストに表示する項目のリストにアクセスできます。Items の値となっている TString オブジェクトのプロパティおよびメソッドを使うと，リストの内容またはリスト内の項目に関連付けられたオブジェクトを変更できます。

注意

Items プロパティを設定すると，TString オブジェクトの値が Items オブジェクトに代入されます。Items の現在の値である TString オブジェクトは置き換えません。


TCustomComboBox.ListHandle
TCustomComboBox.ListHandle3091011

TCustomComboBox	参照

ListHandle プロパティは，コンボボックスのリスト領域のウィンドウハンドルです。

property ListHandle: HWnd;

説明

ListHandle プロパティは，コンボボックスの編集領域で使うウィンドウのハンドルを必要とする Windows API 呼び出しに使用できます。


TCustomComboBox.MaxLength
TCustomComboBox.MaxLength3091012

TCustomComboBox	参照

MaxLength プロパティは，ユーザーがコンボボックスの編集領域に入力できるテキストの最大文字数（バイト単位）です。

property MaxLength: Integer;

説明

MaxLength プロパティは，ユーザーがコンボボックスに入力できる文字列の長さを制限できます。MaxLength はリスト内で使える文字列の長さには影響しません。MaxLenth が 0 の場合，入力する文字数は制限されません。


TCustomComboBox.SelLength
TCustomComboBox.SelLength3091013

TCustomComboBox	参照

SetLength プロパティは，コンボボックスの編集領域で範囲選択されているテキストの長さ（バイト数）です。

property SelLength: Integer;

説明

コンボボックスの編集領域で選択されているテキストは，SelStart プロパティで指定された文字で始まる長さ SelLength の文字列です。選択状態のテキストはコンボボックスの編集領域で強調表示されます。

編集領域でテキスト部分を選択するには，SelStart プロパティをカーソル位置に設定してから SelLength を選択する文字数に設定します。SelText プロパティは選択された部分文字列です。

注意

コンボボックスがアクティブなコントロールでない場合，選択したテキストは強調表示されません。


TCustomComboBox.SelStart
TCustomComboBox.SelStart3091014

TCustomComboBox	参照

SelStart プロパティは，編集ボックス内で選択された最初の文字の位置をバイト単位で指定します。

property SelStart: Integer;

説明

SelStart プロパティは，を読み出すと Text プロパティのどこから選択されているかを調べられます。最初の文字位置は 0，次が 1 と数えます。SelLength が 0 の場合，SelStart はカーソル位置です。

SelStart を設定するとコンボボックスの編集領域でカーソルを位置付けられます。SelStart を 0 に設定するとカーソルは最初の文字の前に位置付けられ，SelStart を 1 に設定するとカーソルは 2 番目の文字の前に位置付けられます。

注意

SelStart を設定すると SelLength プロパティが 0 に変わります。SelStart と SelLength を使って編集領域のテキスト部分をプログラムで選択する場合は，SelLength を設定する前に SelStart を設定してください。


TCustomComboBox.SelText
TCustomComboBox.SelText3091015

TCustomComboBox	参照

SelText プロパティは，編集領域内の選択された文字群を表します。

property SelText: string;

説明

SelText プロパティは，コンボボックスの編集領域で選択されたテキストを取得できます。コンボボックスがアクティブなコントロールの場合，SelText は強調表示されます。SelText を設定すると現在選択されている文字列を別の部分文字列と置換できます。 SelText に文字を代入したときに選択表示されているテキストがないと，SelText文字列は現在のカーソル位置に挿入されます。


TCustomComboBox.Sorted
TCustomComboBox.Sorted3091016

TCustomComboBox	参照

Sorted プロパティは，コンボボックスのリスト部分をアルファベット順にソートするかどうかを指定します。

property Sorted: Boolean;

説明

Sorted プロパティを True に設定するとリスト内の項目をアルファベット順位ソートできます。Sorted が True の場合，Items に追加された項目はソートされた順序に従って正しい位置に挿入されます。Sorted を True に設定するとリストの項目の元の順序は失われます。Sorted を False に設定し直しても元の順序は復元されず，コンボボックス内で項目がソートされなくなるだけです。


TCustomComboBox.Style
TCustomComboBox.Style3091017

TCustomComboBox	参照

Style プロパティは，コンボボックスの表示スタイルを指定します。

TComboBoxStyle = (csDropDown, csSimple, csDropDownList, csOwnerDrawFixed,

   csOwnerDrawVariable);

property Style: TComboBoxStyle;

説明

Style を設定するとコンボボックスのリストと編集領域の表示方法を指定できます。以下に Style の値を示します。

値	意味

csDropDown	テキストが編集可能な編集ボックス付きのドロップダウンリストを作成する。すべての項目は同じ高さの文字列である

csSimple	下方に決まったリスト（リストボックス）がある編集ボックスを作成する。リストの長さはコンボボックスの Height で指定する

csDropDownList	編集ボックスがないドロップダウンリストを作成する。テキストを編集できない。項目はすべて同じ高さの文字列である

csOwnerDrawFixed	テキスト編集ボックスオーナー描画のドロップダウンリストを作成する。リスト内の項目はすべて ItemHeight プロパティで指定された高さを持つ

csOwnerDrawVariable	テキスト編集ボックスオーナー描画のドロップダウンリストを作成する。リスト内の項目の高さはさまざまである

Style が csOwnerDrawFixed または csOwnerDrawVariable の場合，リスト内の項目を描画するときに OnDrawItem イベントが発生します。Style が csOwnerDrawVariable の場合，OnMeasureItem イベントも発生します。


TCustomComboBox イベント3091018

TCustomComboBox	アルファベット順	凡例

TCustomComboBox

OnChange

OnDrawItem

OnDropDown

OnMeasureItem


TCustomComboBox イベント3091019

TCustomComboBox	オブジェクト順	凡例

OnChange

OnDrawItem

OnDropDown

OnMeasureItem


TCustomComboBox.OnChange
TCustomComboBox.OnChange3091020

TCustomComboBox	参照

OnChange イベントは，編集領域に表示されたテキストが変更されると発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラを記述すると，ユーザーが編集領域のテキストを編集したか，リストの項目を選択した直後に特定のアクションを実行できます。


TCustomComboBox.OnDrawItem
TCustomComboBox.OnDrawItem3091021

TCustomComboBox	参照

OnDrawItem イベントは，オーナー描画コンボボックス内の項目を表示する必要があるとき発生します。

TOwnerDrawState = set of (odSelected, odGrayed, odDisabled, odChecked odFocused);

TDrawItemEvent = procedure(Control: TWinControl; Index: Integer Rect: TRect;

   State: TOwnerDrawState) of object;

property OnDrawItem: TDrawItemEvent;

説明

OnDrawItem イベントハンドラを記述するとオーナー描画コンボボックスのドロップダウンリストを描画できます。OnDrawItem イベントハンドラを使うとリスト項目にグラフィック要素を追加したり，リスト項目のテキストをグラフィックスと入れ替えたりできます。OnDrawItem  イベントは 4 つのパラメータを OnDrawItem イベントハンドラに渡します。

・	Control:項目の入っているコンボボックスへの参照。

・	Index:Items プロパティ内での項目のインデックス。

・	Rect:長方形の描画領域。

・	State:項目の状態。以下の値をとります。

値	意味

odSelected	項目が選択されている

odGrayed	項目が淡色表示されている

odDisabled	項目が現在，使用不可である

odChecked	項目がチェックされている

odFocused	項目に現在入力フォーカスがある

Rect パラメータで指定された座標を使って Canvas に項目を描画します。OnDrawItem イベントは，Style プロパティが csOwnerDrawFixed か csOwnerDrawVariable の場合にのみ発生します。

OnDrawItem イベントが記述されていない場合，コンボボックスは現在のブラシを使って Rect パラメータを埋めて，Index パラメータで指定された項目のテキスト値を書き込みます。


TCustomComboBox.OnDropDown
TCustomComboBox.OnDropDown3091022

TCustomComboBox	参照

OnDropDown イベントは，コントロール右端の矢印がクリックされてドロップダウンリストが開いたときに発生します。

property OnDropDown: TNotifyEvent;

説明

ドロップダウンリストがアクティブになったときに，特別の処理を行う場合 OnDropDown イベントハンドラを記述します。


TCustomComboBox.OnMeasureItem
TCustomComboBox.OnMeasureItem3091023

TCustomComboBox	参照

OnMeasureItem イベントは，csOwnerDrawVariable コンボボックス内の項目を再表示しなければならないとき発生します。

TMeasureItemEvent = procedure(Control: TWinControl; Index: Integer; var Height: Integer)

   of object;

property OnMeasureItem: TMeasureItemEvent;

説明

Style プロパティが csOwnerDrawVariable のとき，OnDrawItem イベントの発生の前に OnMeasureItem イベントが発生します。ドロップダウンリスト内の項目を描画するのに必要な高さをピクセル単位で指定するには OnMeasureItem イベントハンドラを作成します。

OnMeasureItem イベントは OnMeasureItem ハンドラに以下の 3 つのパラメータを渡します。

・	Control:項目が入っているコンボボックスへの参照

・	Index:Items プロパティ内での項目のインデックス

・	Height:項目のデフォルトの高さ（ピクセル数）

OnMeasureItem ハンドラは最後のパラメータである Height を適当な値に再設定できます。


TCustomComboBox メソッド3091024

TCustomComboBox	アルファベット順	凡例

TCustomComboBox

Change

Clear

ComboWndProc

Create

CreateParams

CreateWnd

Destroy

DestroyWnd

DrawItem

DropDown

MeasureItem

SelectAll

SetStyle

WndProc

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterFace

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomComboBox メソッド3091025

TCustomComboBox	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

Change

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClientToScreen

ComboWndProc

ContainsControl

ControlAtPos

Create

CreateParams

CreateParented

CreateWnd

DefaultHandler

Destroy

DestroyComponents

Destroying

DestroyWnd

DisableAlign

Dispatch

DragDrop

Dragging

DrawItem

DropDown

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterFace

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MeasureItem

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetStyle

SetTextBuf

Show

Update

UpdateControlState

WndProc


TCustomComboBox.Change
TCustomComboBox.Change3091026

TCustomComboBox	参照

Change メソッドは，OnChange イベントを発生させます。

procedure Change; dynamic;

説明

Change メソッドは OnChange イベントのプロテクトメソッドです。Change メソッドをオーバーライドするとテキストが変更されたときに追加処理を実行したり，OnChange イベントの発生を抑制したりできます。

注意

Change メソッドをオーバーライドするときは，継承された Change メソッドまたは継承された Changed メソッドを呼び出します。


TCustomComboBox.Clear
TCustomComboBox.Clear3091027

TCustomComboBox	参照

Clearメソッドは，編集ボックスの全テキスト，および Items リストの全項目を削除します。

procedure Clear;

説明

Clear メソッドを呼び出すと実行時にコンボボックスを空にできます。


TCustomComboBox.ComboWndProc
TCustomComboBox.ComboWndProc3091028

TCustomComboBox	参照

ComboWndProc メソッドは，コンボボックス宛のメッセージを処理します。

procedure ComboWndProc(var Message: TMessage; ComboWnd: HWnd; ComboProc: Pointer); virtual;

説明

ComboWndProc メソッドは，コンボボックスの編集領域またはリスト部分のウィンドウに送られた Windows メッセージを受け取る最初の手続きです。Message パラメータはウィンドウのメッセージ引数です。ComboWnd パラメータは編集領域またはリストのウィンドウハンドルです。ComboProc パラメータはメッセージを受け取ったウィンドウのデフォルトウィンドウ手続きへのポインタです。ComboWndProc はフォーカスイベント，マウスイベント，およびキー入力に対するデフォルトの応答を行います。

ComboWndProc メソッドをオーバーライドすると，Windows メッセージに対するコンボボックスの応答方法を変更できます。ComboWndProc メソッドをオーバーライドする場合，必ず未処理のメッセージを処理するために継承されたメソッドを最後に呼び出してください。


TCustomComboBox.Create
TCustomComboBox.Create3091029

TCustomComboBox	参照

Create メソッドは，TCustomComboBox インスタンスを作成し初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出すと，実行時にコンボボックスを生成できます。設計時にドームに配置されたコンボボックスは自動的に作成されます。

継承されたコンストラクタの呼び出し後，Create は次のプロパティを初期化します。

・	ControlStyle を [csCaptureMouse, csSetCaption, csDoubleClicks, csFixedHeight, csReflector] に初期化する

・	DropDownCount を 8 に，ItemHeight を 16 に初期化する

・	Height を 25 に，Width を 145 に初期化する

・	ParentColor を False に初期化する

・	Style を csDropDown に初期化する

・	TabStop を True に初期化する

ただし，フォームにコンポーネントを貼り付けると，ParentFont の設定を受けて再設定されるプロパティがあります。


TCustomComboBox.CreateParams
TCustomComboBox.CreateParams3091030

TCustomComboBox	参照

CreateParams メソッドは，ウインドウ作成パラメータレコードを初期化します。

procedure CreateParams(var Params: TCreateParams); override;

説明

CreateWnd メソッドは CreateParams メソッドを呼び出して，コンボボックスにウィンドウを作成するのに使うパラメータを初期化します。CreateParams は Style プロパティを実装するために継承されたメソッドをオーバーライドします。


TCustomComboBox.CreateWnd
TCustomComboBox.CreateWnd3091031

TCustomComboBox	参照

CreateWnd メソッドは，コンボボックスに対応する Windows コントロールを作成します。

procedure CreateWnd; override;

説明

CreateWnd メソッドは継承された CreateWnd メソッドを呼び出してから，コンボボックス特有のパラメータを初期化します。


TCustomComboBox.Destroy
TCustomComboBox.Destroy3091032

TCustomComboBox	参照

Destroy メソッドは，コンボボックスを破棄し割り当てていたメモリを解放します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに Free メソッドを呼び出してください。Free はコンボボックスが解放済みでないことを確認してからのみ Destroy を呼び出します。


TCustomComboBox.DestroyWnd
TCustomComboBox.DestroyWnd3091033

TCustomComboBox	参照

DestroyWnd メソッドは，コンボボックスを表す Windows コントロールを破棄します。

procedure DestroyWnd; override;

説明

DestroyWnd メソッドは Items リストの内容を保存してから，継承された DestroyWnd メソッドを呼び出します。保存されたリストはウィンドウを再作成する場合に使います。


TCustomComboBox.DrawItem
TCustomComboBox.DrawItem3091034

TCustomComboBox	参照

DrawItem メソッドは，OnDrawItem イベントを発生させます。

procedure DrawItem(Index: Integer; Rect: TRect; State: TOwnerDrawState); virtual;

説明

Style プロパティが csOwnerDrawFixed または csOwnerDrawVariable の場合，リスト内の項目を描画する必要があるときに必ず DrawItem が呼び出されます。OnDrawItem イベントが割り当てられている場合，DrawItem は OnDrawItem イベントを発生させて，Index，Rect，および State の 3 つのパラメータをイベントハンドラに渡します。それ以外の場合，OnDrawItem は Rect に渡された長方形領域を埋めて，インデックス付けされた項目に関連付けられたすべてのテキストを描画します。このとき State パラメータは無視されます。

DrawItem をオーバーライドするとクラス固有の描画コードをリスト内の項目に提供できます。


TCustomComboBox.DropDown
TCustomComboBox.DropDown3091035

TCustomComboBox	参照

DropDown メソッドは，OnDropDown イベントを発生させます。

procedure DropDown; dynamic;

説明

DropDown メソッドは OnDropDown イベントの Protected メソッドです。他の処理を追加したり，OnDropDown イベントを抑制したりするには，DropDown メソッドをオーバーライドします。


TCustomComboBox.MeasureItem
TCustomComboBox.MeasureItem3091036

TCustomComboBox	参照

MeasureItem メソッドは，OnMeasureItem イベントを発生させます。

procedure MeasureItem(Index: Integer; var Height: Integer); virtual;

説明

MeasureItemメソッドは OnMeasureItem イベントの Protected メソッドです。MeasureItem をオーバーライドすると，Style が csOwnerDrawVariable の場合にリストの項目のサイズを指定する固有のコードを提供できます。


TCustomComboBox.SelectAll
TCustomComboBox.SelectAll3091037

TCustomComboBox	参照

SelectAll メソッドは，編集ボックス内のテキストブロック全体を選択します。

procedure SelectAll;

説明

SelectAll メソッドは編集ボックス内のテキスト全体を選択します。テキストの一部だけを選択するには，SelStart プロパティと SelLength プロパティを使います。


TCustomComboBox.SetStyle
TCustomComboBox.SetStyle3091038

TCustomComboBox	参照

SetStyle メソッドは，Style プロパティと ControlStyle プロパティを設定します。

procedure SetStyle(Value: TComboBoxStyle); virtual;

説明

SetStyle メソッドは Style プロパティの Protected メソッドです。SetStyle をオーバーライドすると Style プロパティの実装を変更できます。


TCustomComboBox.WndProc
TCustomComboBox.WndProc3091039

TCustomComboBox	参照

WndProc メソッドは，コンボボックス宛のメッセージを受け取り，その内容に応じた処理を行います。

procedure WndProc(var Message: TMessage); override;

説明

WndProc はコンボボックスに送られた Windows メッセージを最初に受け取るメソッドです。コンボボックスの子ウィンドウ（編集領域とリスト部分）に送られたメッセージは ComboWndProc メソッドに送られます。WndProc は Windows のコントロールパネルで定義されたシステムカラーの変更についてのメッセージを処理し，〔Enter〕キーか〔Esc〕キーを押したときにドロップダウンリストを閉じます。それ以外のメッセージはすべて Dispatch に送られてデフォルト処理されます。


スコープ3091040

protected

published

読み出し／書き込み

読み出し専用


スコープ3091041

protected


スコープ3091042

protected


継承3091043

TObject

TPersistent

TComponent

TControl

TWinControl


TCustomComboBox 例3091044

TCustomComboBox


TCustomControl
TCustomControl3092001

継承	プロパティ	メソッド	参照

TCustomControl コンポーネントは基本的な抽象クラスです。このクラスからは，複雑なビジュアルイメージを描画するために Canvas のサポートを要求するウィンドウコントロールが派生します。

ユニット

controls

説明

標準のウィンドウコントロールは Windows の一部なので，それ自体を表示する手段をすでに備えています。したがって，ボタンやチェックボックスのコンポーネントは直接 TWinControl を継承します。標準の Windows コンポーネントに対応しない独自のウィンドウコントロールを作成する場合は，ウィンドウコントロールを直接 TWinControl から派生させるのではなく，TCustomControl から派生させます。TCustomControl では，描画面を管理する Canvas プロパティや，呼び出すと WM_PAINT メッセージに応答する仮想 Paint メソッドが提供されるので，独自のコントロールを簡単に描画できます。

入力フォーカスを受け取る必要のないカスタムコントロールを作成する場合は，カスタムコントロールを TCustomControl から派生させるのではなく TGraphicControl から派生させて，ウィンドウコントロールの状態に関連付けられたオーバーヘッドを生成しないようにします。ウィンドウコントロールのペイントは，グラフィックコントロールのペイントより時間がかかります。


TCustomControl プロパティ3092002

TCustomControl	アルファベット順	凡例

TCustomControl

Canvas

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomControl プロパティ3092003

TCustomControl	オブジェクト順	凡例

Align

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentWindow

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TCustomControl.Canvas
TCustomControl.Canvas3092004

TCustomControl	参照

Canvas プロパティは，描画するコントロールの描画面を提供する TCanvas オブジェクトです。

property Canvas: TCanvas;

説明

TCanvas オブジェクトのプロパティを使うと，コントロールの表面を描画したりペイントしたりできます。Canvas は Windows のデバイスコンテキストをカプセル化して，描画やペイントに必要なすべてのツールおよびメソッドを提供します。

Canvas は，通常は TCustomControl から派生するオブジェクトにおいて public として再宣言される Protected プロパティです。


TCustomControl メソッド3092005

TCustomControl	アルファベット順	凡例

TCustomControl

Create

Destroy

Paint

PaintWindow

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomControl メソッド3092006

TCustomControl	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Paint

PaintTo

PaintWindow

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TCustomControl.Create
TCustomControl.Create3092007

TCustomControl	参照

Create メソッドは，TCustomControl のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にカスタムコントロールをインスタンス化できます。設計時にフォーム上に配置されたオブジェクトは自動的に作成されます。

Create メソッドは継承コンストラクタを呼び出した後，カスタムコントロールのキャンバスを作成します。

ほとんどの種類のコントロールは，Create をオーバーライドして固有のプロパティを初期化します。Create メソッドをオーバーライドするときは必ず継承された Create メソッドを最初に呼び出し，それからコンポーネントを初期化します。


TCustomControl.Destroy
TCustomControl.Destroy3092008

TCustomControl	参照

Destroy メソッドは，TCustomControl のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはインスタンスが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy を使うと，Create メソッドに割り当てていたメモリやリソースを解放できます。Destroy メソッドを下位のコントロール型で宣言するときは，常に override を宣言に追加して，継承された Destroy をオーバーライドしたメソッドの最後の文で呼び出します。


TCustomControl.Paint
TCustomControl.Paint3092009

TCustomControl	参照

Paint メソッドは，カスタムコントロールのイメージを描画します。

procedure Paint; virtual;

説明

TCustomControl の Paint メソッドは，WM_PAINT メッセージに応答するメソッドに対するインターフェースを提供するだけです。PaintWindow メソッドが Canvas にデバイスコンテキストへのハンドルを提供した後，Paint は PaintWindow によって呼び出されます。カスタムコントロールを作成するときは，常に Paint をオーバーライドしてコントロールのイメージを描画します。


TCustomControl.PaintWindow
TCustomControl.PaintWindow3092010

TCustomControl	参照

PaintWindow メソッドは，キャンバスにデバイスコンテキストを提供しPaint メソッドを呼び出してコントロールのイメージを描画します。

procedure PaintWindow( DC: HDC); override;

説明

カスタムコントロールが WM_PAINT メッセージを受け取ると，PaintWindow メソッドが自動的に呼び出されます。PaintWindow はキャンバスに Windows のデバイスコンテキストを提供して Paint メソッドを呼び出し，最後にデバイスコンテキストを削除します。PaintWindow をオーバーライドすると，WN_PAINT メッセージに対して追加の応答を提供できます。コントロールのイメージを描画するには，かわりに Paint メソッドをオーバーライドします。


スコープ3092011

protected

published

読み出し／書き込み

読み出し専用


スコープ3092012

protected


継承3092013

TObject

TPersistent

TComponent

TControl

TWinControl


TCustomControl 例3092014

TCustomControl


TCustomDBGrid
TCustomDBGrid3093001

継承	プロパティ	メソッド	イベント	参照

TCustomDBGrid コンポーネントは，データセットの各レコードをテーブル形式で表示するグリッドコントロールの抽象基本クラスです。

ユニット

dbgrids

説明

TCustomDBGrid コンポーネントは，TCusomGrid コンポーネントの機能を拡張してデータセットの各項目を表示するため，新しいプロパティ，イベント，およびメソッドを導入しています。実行時，ユーザーは TDBNavigator オブジェクトを使って TCustomDBGrid オブジェクトを操作できます。

TCustomDBGrid のインスタンスを作成しないでください。TCustomDBGrid は，データセットの情報を表示するグリッドオブジェクトを宣言するときに基本クラスとして使ってください。TCustomDBGrid のプロパティとメソッドは，下位クラスが継承する基本動作を提供するだけでなく，各コンポーネントがオーバーライドしてカスタマイズできる動作も提供します。


TCustomDBGrid プロパティ3093002

TCustomDBGrid	アルファベット順	凡例

TCustomDBGrid

Columns

DataLink

DataSource

DefaultDrawing

FieldCount

Fields

IndicatorOffset

LayoutLock

Options

ReadOnly

SelectedField

SelectedIndex

SelectedRows

TitleFont

UpdateLock

TCustomGrid からの継承

EditorMode

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ParentColor

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomDBGrid プロパティ3093003

TCustomDBGrid	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DataLink

DataSource

DefaultDrawing

DesignInfo

EditorMode

Enabled

FieldCount

Fields

Handle

Height

HelpContext

Hint

IndicatorOffset

LayoutLock

Left

Name

Options

Owner

Parent

ParentColor

ParentWindow

ReadOnly

SelectedField

SelectedIndex

SelectedRows

ShowHint

Showing

TabOrder

TabStop

Tag

TitleFont

Top

UpdateLock

VCLComObject

Visible

Width

WindowProc


TCustomDBGrid.Columns
TCustomDBGrid.Columns3093004

TCustomDBGrid	参照

Columns プロパティは，TCustomDBGrid オブジェクト各列の表示属性と項目バインディングを表します。

property Columns: TDBGridColumns;

説明

Columns プロパティは，データベース対応グリッド内各列の項目バインディングおよび表示属性の読み出しと設定に使います。このプロパティはインデックス付きの TColumn オブジェクトコレクションです。TColumn オブジェクトのプロパティを使って，データベース対応グリッド内の各列の表示属性と項目バインディングを指定します。項目バインディングで，DataSource プロパティによって指定されたデータセット内の項目を指定します。

Columns プロパティは，設計時に列エディタで設定したり，実行時にプログラムで設定したりできます。


TCustomDBGrid.DataLink
TCustomDBGrid.DataLink3093005

TCustomDBGrid	参照

データベース対応グリッドは，DataLink プロパティを使ってデータソースとのリンク状態を管理し，データイベントの発生に対応します。

property DataLink: TGridDataLink;

説明

アプリケーションで DataLink プロパティを使う必要はありません。このプロパティはプロテクトメソッドとしてエクスポーズされているので，コンポーネントの作成者は TGridDataLink の派生オブジェクトを使うデータグリッドを作ることによって，さまざまなデータイベントに応答できるようになります。

DataLink プロパティを使って TCustomDBGrid は以下の処理を行います。

・	Columns によって指定される項目バインディングをデータセット内の項目を使って解決する

・	項目の値の変化に応答する

・	レコードの最新性の変化に応答する

・	データセットの編集状態の変化に応答する

・	未登録の編集データを追跡し，適切に破棄または登録する


TCustomDBGrid.DataSource
TCustomDBGrid.DataSource3093006

TCustomDBGrid	参照

DataSource プロパティは，データベース対応グリッドとデータセットとのリンク関係を指定します。

property DataSource: TDataSource;

説明

DataSource プロパティには，データベース対応グリッドがデータを取り出すデータセットにリンクした TDataSource オブジェクトを設定します。データセット対応グリッドは，DataSource を使うことによって，同じデータソースを使う他のデータベース対応オブジェクトとのレコードの最新性を維持しながら，データセットからの読み込み，データセットへの書き込み，データセットのナビゲートができるようになります。


TCustomDBGrid.DefaultDrawing
TCustomDBGrid.DefaultDrawing3093007

TCustomDBGrid	参照

DefaultDrawing プロパティは，データベース対応グリッド内の各セルが自動的に描画されるのか，アプリケーションがカスタマイズした描画手段を OnDrawColumnCell イベントを使って提供するのかを指定します。

property DefaultDrawing: Boolean;

説明

DefaultDrawing を True に設定すると，データベース対応グリッドはセルを自動的に描画します。カスタマイズした描画手段が OnDrawColumnCell イベントハンドラまたは OndrawDataCell イベントハンドラ内で提供されている場合， DefaultDrawing を False に設定するとデフォルト描画がオフになります。

DefaultDrawing が True のとき，データベース対応グリッドは Fields 配列の適切なエントリからセル用のデータを取り出してセルに書き込みます。次に，セルにフォーカスがある場合，またはセルが選択されていて Options プロパティに dgAlwaysShowSelection が含まれている場合は，長方形のフォーカス領域を描画します。

DefaultDrawing が False のとき，データベース対応グリッドはセル上に適当な背景色を描画し，TColumn オブジェクトが示すブラシとフォントをセットアップします。ただし，項目の値はセルに書き込まれず，長方形のフォーカス領域も描画されません。


TCustomDBGrid.FieldCount
TCustomDBGrid.FieldCount3093008

TCustomDBGrid	参照

FieldCount プロパティは，グリッド内に表示される項目（列）の数を表します。

property FieldCount: Integer;

説明

FieldCount プロパティを使えば，Fields プロパティで表される項目コンポーネントすべてを処理できます。このプロパティの値は，元のデータセット内の項目数と異なることがあります。それは，グリッドには計算項目が含まれることがあり，またデータセット内のすべての項目が必ずしもグリッド内に表示されるわけではないからです。設計時には列エディタを使って，個々の項目を削除したり，計算項目を追加したりできます。

FieldCount プロパティの値は，実行時には列の数と同じになります。設計時にはグリッドに空の列が含まれることがあります。


TCustomDBGrid.Fields
TCustomDBGrid.Fields3093009

TCustomDBGrid	参照

Fields プロパティは，データベース対応グリッドの各列に対応するインデックス付き項目コンポーネント配列を表します。

property Fields[Index: Integer]: TField;

説明

Fields プロパティは，グリッド内の特定の列に対応するデータセット内の項目コンポーネントに直接アクセスできます。たとえば，最初のデータ列に対応する項目には Index 0 で，次のデータ列に対応する項目は Index 1 でそれぞれアクセスできます。Index の範囲は 0～FieldCount - 1 です。

グリッド内の最初の列が最初のデータ列ではない場合があります。Options にdgIndicator が含まれている場合，グリッド内の最初の列は現在行インジケータを含むスクロールしない列となるからです。

Fields プロパティ内の個々の項目コンポーネントを使えば，現在のレコードの項目値，その必要な表示幅，項目を表示または編集するときに描画される文字列などの情報を得ることができます。また項目コンポーネントを使えば，セル内でエディタを使わなくてもデータセットに値を直接書き込めます。

注意

グリッド内の列が計算項目の場合，データセット内には対応する項目コンポーネントはありません。Index パラメータが計算項目を含む列を指していると，Fields プロパティは nil を返します。計算項目の項目コンポーネントを取得するには GetColFields メソッドを使います。


TCustomDBGrid.IndicatorOffset
TCustomDBGrid.IndicatorOffset3093010

TCustomDBGrid	参照

IndicatorOffset プロパティは，データベース対応グリッド内でデータを含んでいる最初の列を指すインデックスです。

property IndicatorOffset: Byte;

説明

IndicatorOffset プロパティは，Columns プロパティにおける列の位置と，データベース対応グリッド上に描画された列の位置とを変換する場合に使います。Options プロパティに dgIndicator が含まれている場合，IndicatorOffset は 1 になります。グリッドの最初の列が現在行インジケータとして使われるからです。すべての列がデータを含んでいる場合，IndicatorOffset は 0 になります。


TCustomDBGrid.LayoutLock
TCustomDBGrid.LayoutLock3093011

TCustomDBGrid	参照

LayoutLock プロパティは，EndLayout メソッドや CancelLayout メソッドを呼び出さずに BeginLayout メソッドを呼び出した回数を表します。

property LayoutLock: Byte;

説明

LayoutLock プロパティで，列バインディングがいつ変わったかがわかります。列幅または列バインディングが変わるたび，あるいはデータソース内の項目が変わるたびに，BeginLayout メソッドが呼び出されます。BeginLayout メソッドは，LayoutLock をインクリメントしながら列バインディングが変更中であることを示します。列バインディングの変更が終了すると，EndLayout メソッドが呼び出されます。このメソッドは LayoutLock をデクリメントします。LayoutLock が 0 に戻ると，データベース対応グリッドはすべての変更が終わったとみなし，Fields プロパティと Columns プロパティを更新します。


TCustomDBGrid.Options
TCustomDBGrid.Options3093012

TCustomDBGrid	参照

Options プロパティは，データベース対応グリッドの色々な表示プロパティおよび動作プロパティを指定します。

TDBGridOption = (dgEditing, dgAlwaysShowEditor, dgTitles, dgIndicator, dgColumnResize, dgColLines, dgRowLines, dgTabs, dgRowSelect,dgAlwaysShowSelection, dgConfirmDelete, dgCancelOnExit, dgMultiSelect);

  TDBGridOptions = set of TDBGridOption;

property Options: TDBGridOptions;

説明

Options プロパティにはデータベース対応グリッドの必要なプロパティを設定します。以下の値を組み合わせて指定します。

値	意味

dgEditing	グリッドを使ってデータを編集できる。Options に dgRowSelect が設定されている場合，dgEditing は無視される

dgAlwaysShowEditor	グリッドは常に編集モード。セル内容を編集する前に〔Enter〕キーまたは〔F2〕キーを押す必要がない。Options に dgEditing も設定されていない場合，dgAlwaysShowEditor は無効である。Options に dgRowSelect が設定されていると，dgAlwaysShowEditor は無視される

dgTitles	グリッドの列の最上部にタイトルが表示される

dgIndicator	最初の列に小さいポインタが表示され，現在の行を示す

dgColumnResize	項目にバインドされた列はサイズ変更または移動ができる

dgColLins	グリッドの列間に線が表示される

dgRowLines	グリッドの行間に線が表示される

dgTabs	〔Tab〕キーおよび〔Shift〕+〔Tab〕キーを使って，グリッド内を移動できる

dgRowSelect	個々のセルだけでなく行全体を選択できる。Options に dgRowSelect が設定されていれば，dgEditing と dgAlwaysShowEditor は無視される

dgAlwaysShowSelection	グリッドにフォーカスがないときでも，選択されたセルはフォーカス矩形を表示する

dgConfirmDelete	〔Ctrl〕＋〔Del〕キーを押してグリッド内の行を削除しようとするとメッセージボックスが表示され，削除の確認を求められる

dgCancelOnExit	挿入レコードに何も変更を加えずグリッドを抜けると，挿入レコードはデータセットに登録されない。これによって，空のレコードを誤って登録することを防ぐことができる

dgMultiSelect	グリッド内の複数の行を一度に選択できる


TCustomDBGrid.ReadOnly
TCustomDBGrid.ReadOnly3093013

TCustomDBGrid	参照

ReadOnly プロパティは，グリッドが表示専用か，またはグリッドを使ってデータを編集できるのかを指定します。

property ReadOnly: Boolean;

説明

ReadOnly プロパティを True に設定すると，データセット内のデータは変更できません。False に設定すると，グリッドを使ってデータを編集できます。

ReadOnly が True の場合，〔Ins〕キーを使って新しい行をグリッドに挿入することも〔↓〕キーを使って行をグリッドの末尾に追加することもできません。


TCustomDBGrid.SelectedField
TCustomDBGrid.SelectedField3093014

TCustomDBGrid	参照

SelectedField プロパティは，グリッド内で現在選択されているセルの項目コンポーネントを表します。

property SelectedField: TField;

説明

SelectedField プロパティを設定すると，フォーカスはグリッド内の特定の項目に移動します。SelectedField プロパティで，現在選択されているセルの項目コンポーネントにアクセスできます。現在選択されているセルがない場合，SelectedField の値は nil になります。たとえば，行全体が選択されているときは nil になります。


TCustomDBGrid.SelectedIndex
TCustomDBGrid.SelectedIndex3093015

TCustomDBGrid	参照

SelectedIndex プロパティは，Columns 配列内で現在選択されている列のインデックスを表します。

property SelectedIndex: Integer;

説明

SelectedIndex プロパティを設定すると，フォーカスはグリッド内の指定された位置の列に移動します。SelectedIndex プロパティは，グリッド内のどの列にフォーカスがあるかがわかります。0 は最初の列，1 は次の列です。現在選択されている列がない場合，SelectedIndex は -1 となります。

Options プロパティに dgIndicator が設定されている場合，SelectedIndex で示される列のインデックスは，グリッド内に実際に存在する列のインデックスとは異なります。

選択されている列の項目コンポーネントにアクセスするには SelectedField プロパティを使います。


TCustomDBGrid.SelectedRows
TCustomDBGrid.SelectedRows3093016

TCustomDBGrid	参照

SelectedRows プロパティは，データセット内の全レコードに対するブックマークの集合で，グリッド内の選択されている各行に対応します。

property SelectedRows: TBookmarkList;

説明

SelectedRows から返される TBookmarkList オブジェクトのプロパティとメソッドを使って，以下の処理を行います。

・	グリッド内の選択されている行の数を知る

・	データセット内の現在のレコードが選択されているかどうかを知る

・	データセット内の特定のレコードが選択されているかどうかを知る

・	データセットから選択されているすべての行を削除する

SelectedRows が有効になるのは，Options プロパティに dgRowSelect が設定されているときだけです。Options プロパティに dgMultiSelect が設定されていない場合，SelectedRows は 1 行しか表せません。


TCustomDBGrid.TitleFont
TCustomDBGrid.TitleFont3093017

TCustomDBGrid	参照

TitleFont プロパティは，グリッド内の列見出しを描画するときに使用するフォントを表します。

property TitleFont: TFont;

説明

列見出しを描画するときに使うフォントを変更するには TitleFont を設定します。このプロパティが有効なのは，Options プロパティに dgTitles が設定されているときだけです。


TCustomDBGrid.UpdateLock
TCustomDBGrid.UpdateLock3093018

TCustomDBGrid	参照

UpdateLock プロパティは，対応する EndUpdate メソッドの呼び出しが行われなかった BeginUpdate メソッドの呼び出し回数を表します。

property UpdateLock: Byte;

説明

UpdateLock プロパティを設定することで，グリッド内のデータが変化している間はグリッドはセルを再描画しません。グリッド内に描画されているデータに影響を与える変化が発生すると，BeginUpdate メソッドが呼び出されます。BeginUpdate は，UpdateLock プロパティをインクリメントし，グリッドの内容が変更中であることを示します。グリッド内のデータの変更が終了すると EndUpdate メソッドが呼び出されます。EndUpdate は UpdateLock プロパティをデクリメントします。

UpdateLock が 0 に戻ると，データベース対応グリッドはセルを再描画できるようになります。UpdateLock が 0 より大きい間は，グリッドは再描画を延期します。グリッドのサイズが変わったときやデータがスクロールされたときに UpdateLock がグリッドのちらつきを防ぎます。


TCustomDBGrid イベント3093019

TCustomDBGrid	アルファベット順	凡例

TCustomDBGrid

OnCellClick

OnColEnter

OnColExit

OnColumnMoved

OnDrawColumnCell

OnDrawDataCell

OnEditButtonClick

OnTitleClick


TCustomDBGrid イベント3093020

TCustomDBGrid	オブジェクト順	凡例

OnCellClick

OnColEnter

OnColExit

OnColumnMoved

OnDrawColumnCell

OnDrawDataCell

OnEditButtonClick

OnTitleClick


TCustomDBGrid.OnCellClick
TCustomDBGrid.OnCellClick3093021

TCustomDBGrid	参照

OnCellClick イベントは，グリッドのセルでマウスボタンが離されたとき発生します。

type TDBGridClickEvent = procedure (Column: TColumn) of object;

property OnCellClick: TDBGridClickEvent;

説明

グリッドのセルがクリックされたとき，ある決まったアクションをとるために，OnCellClick イベントハンドラを作成します。Column パラメータは，マウスの左ボタンが離されたときにマウスが存在していた列を表す TColumn オブジェクトを示します。

マウスボタンが離されると，OnCellClick イベントが発生します。マウスボタンが押されたときにあるアクションをとるには OnColEnter イベントを使います。

OnCellClick イベントは，行または列のサイズ変更後にマウスボタンが離されたとき，またはセルが編集されているときには発生しません。


TCustomDBGrid.OnColEnter
TCustomDBGrid.OnColEnter3093022

TCustomDBGrid	参照

OnColEnter イベントは，フォーカスがグリッド内の新しいセルに移ったときに発生します。

type TNotifyEvent = procedure(Sender: TObject) of object;

property OnColEnter: TNotifyEvent;

説明

新しいセルが選択されたとき特定のアクションをとるために OnColEnter イベントハンドラを作成します。フォーカスが新しいセルに移るのは以下の場合です。

・	キーボードを使ってセルに移動した。たとえば〔Tab〕キーまたは〔Home〕キーを押したとき

・	セル内でマウスボタンをクリックしたとき

・	SelectedField プロパティまたは SelectedIndex プロパティが設定されたとき

SelectedField プロパティまたは SelectedIndex プロパティで，どのセルが選択されたかがわかります。


TCustomDBGrid.OnColExit
TCustomDBGrid.OnColExit3093023

TCustomDBGrid	参照

OnColExit イベントは，グリッド内のセルが入力フォーカスを失う直前に発生します。

type TNotifyEvent = procedure(Sender: TObject) of object;

property OnColExit: TNotifyEvent;

説明

グリッド内のセルが入力フォーカスを失う直前に特定のアクションをとるために OnColExit イベントハンドラが呼び出されます。たとえばユーザーがセルを移動するときに，ユーザーが他のレコードに移動するのを待たずに，OnColExit イベントハンドラでそれまでの編集内容を元のデータセットに登録できます。

セルがフォーカスを失うのは以下の場合です。

・	キーボードを使ってセルの外に移動した。たとえば〔Tab〕キーまたは〔Home〕キーを押したとき

・	他のセルでマウスボタンをクリックしたとき

・	SelectedField プロパティまたは SelectedIndex プロパティが設定されたとき

グリッド内の選択されたセルが変化したとき，まず OnColExit イベントが発生します。次に，SelectedField と SelectedIndex が更新されます。最後に，OnColEnter イベントが発生します。こうして，OnColExit イベントハンドラでは，SelectedField プロパティまたは SelectedIndex プロパティによって，この後どの列がフォーカスを失うかがわかります。


TCustomDBGrid.OnColumnMoved
TCustomDBGrid.OnColumnMoved3093024

TCustomDBGrid	参照

OnColumnMoved イベントは，ユーザーがマウスを使って列を移動したときに発生します。

type TMovedEvent = procedure (Sender: TObject; FromIndex, ToIndex: Longint) of object;

property OnColumnMoved: TMovedEvent;

説明

グリッド内の列が移動した直後に特定のアクションをとるために OnColumnMoved イベントハンドラを作成します。FromIndex パラメータは，移動の前に Columns 配列内で占めていた位置を示し，ToIndex パラメータは現在の位置を示します。

OnColumnMoved イベントは，Options プロパティに dgColumnResize が入っているときしか発生しません。


TCustomDBGrid.OnDrawColumnCell
TCustomDBGrid.OnDrawColumnCell3093025

TCustomDBGrid	参照

OnDrawColumnCell イベントは，グリッドがセルを描画しなければならないときに発生します。

type

 TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

 TDrawColumnCellEvent = procedure (Sender: TObject; const Rect: TRect; DataCol: Integer; Column: TColumn; State: TGridDrawState) of object;

property OnDrawColumnCell: TDrawColumnCellEvent;

説明

セルデータにカスタマイズされた描画方法を提供するために OnDrawColumnCell イベントハンドラを作成します。Canvas プロパティのメソッドを使ってセルに描画します。Rect パラメータでセルのキャンバス上の位置を，DataCol パラメータで列の Columns 配列におけるインデックスを，Column パラメータでセルの表示属性と項目バインディングを表す TColumn オブジェクトをそれぞれ示します。さらに，State パラメータで，セルに入力フォーカスがあるか，セルが選択されているか，およびセルが列ヘッダーなどの固定（データ以外）セルかを示します。

OnDrawColumnCell イベントハンドラは，DefaultDrawColumnCell メソッドを呼び出して，セルにデータを書き込むようグリッドに指示することができます。また，DefaultDrawColumnCell メソッドを強化して，選択状態とフォーカスを視覚的に示すことができます。このハンドラがセルテキストを描画するのに DefaultDrawColumnCell メソッドを利用しないのであれば，GetFieldValue メソッドでセルテキストを取得してください。

DefaultDrawing プロパティが True の場合，OnDrawColumnCell イベント発生前にデータはすでにセルに描画されており，また OnDrawColumnCell イベント発生後には選択されたセルに長方形のフォーカス領域が描画されます。

注意

Columns の State プロパティが csDefault の場合，OnDrawDataCell イベントの後に OnDrawColumnCell イベントが発生します。OnDrawDataCell は旧式のイベントで，下位互換性を保つために用意されています。OnDrawDataCell イベントハンドラと OnDrawColumnCell イベントハンドラの両方を設定してはいけません。


TCustomDBGrid.OnDrawDataCell
TCustomDBGrid.OnDrawDataCell3093026

TCustomDBGrid	参照

OnDrawDataCell イベントは，Columns の State プロパティが csDefault で，グリッドがセルを描画しなければならないときに発生します。

type

TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

TDrawDataCellEvent = procedure (Sender: TObject; const Rect: TRect; Field: TField; State: TGridDrawState) of object;

property OnDrawDataCell: TDrawDataCellEvent;

説明

この OnDrawDataCell イベントハンドラを作成しないでください。このイベントハンドラは旧式であり，下位互換性を保つために用意されています。かわりに OnDrawColumnCell イベントハンドラを作成してください。


TCustomDBGrid.OnEditButtonClick
TCustomDBGrid.OnEditButtonClick3093027

TCustomDBGrid	参照

OnEditButtonClick イベントは，グリッド列内の省略記号ボタンが押されたとき発生します。

type TNotifyEvent = procedure(Sender: TObject) of object;

property OnEditButtonClick: TNotifyEvent;

説明

OnEditButtonClick イベントハンドラは，グリッドセル内の省略記号ボタンが押されたとき適切なリストまたはダイアログを表示するために作成します。このイベントハンドラは，リストやダイアログに対するユーザーの応答を基に項目の値を設定します。値を設定しなければならない TField コンポーネントにアクセスするには，SelectedField プロパティを使ってください。


TCustomDBGrid.OnTitleClick
TCustomDBGrid.OnTitleClick3093028

TCustomDBGrid	参照

OnTitleClick イベントは，列ヘッダーでマウスボタンが離されたとき発生します。

type TDBGridClickEvent = procedure (Column: TColumn) of object;

property OnTitleClick: TDBGridClickEvent;

説明

OnTitleClick イベントハンドラは，列ヘッダーがクリックされたときに特定のアクションをとるために作成します。Column パラメータは，マウスの左ボタンが離されたときにマウスが存在していた列を表す TColumn オブジェクトを示します。


TCustomDBGrid メソッド3093029

TCustomDBGrid	アルファベット順	凡例

TCustomDBGrid

AcquireLayoutLock

BeginLayout

BeginUpdate

CancelLayout

CanEditAcceptKey

CanEditModify

CanEditShow

CellClick

ColEnter

ColExit

ColumnMoved

ColWidthsChanged

Create

CreateColumns

CreateEditor

CreateWnd

DataToRawColumn

DefaultDrawColumnCell

DefaultDrawDataCell

DefaultHandler

DeferLayout

DefineFieldMap

Destroy

DrawCell

DrawColumnCell

DrawDataCell

EditButtonClick

EndLayout

EndUpdate

GetColField

GetEditLimit

GetEditMask

GetEditText

GetFieldValue

HighlightCell

KeyDown

KeyPress

LayoutChanged

LinkActive

Loaded

MouseDown

MouseUp

Notification

RawToDataColumn

Scroll

SetColumnAttributes

SetEditText

StoreColumns

TimedScroll

TitleClick

ValidFieldIndex

TCustomGrid からの継承

MouseCoord

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomDBGrid メソッド3093030

TCustomDBGrid	オブジェクト順	凡例

AcquireLayoutLock

Assign

BeginDrag

BeginLayout

BeginUpdate

BringToFront

Broadcast

CancelLayout

CanEditAcceptKey

CanEditModify

CanEditShow

CanFocus

CellClick

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ColEnter

ColExit

ColumnMoved

ColWidthsChanged

ContainsControl

ControlAtPos

Create

CreateColumns

CreateEditor

CreateParented

CreateWnd

DataToRawColumn

DefaultDrawColumnCell

DefaultDrawDataCell

DefaultHandler

DeferLayout

DefineFieldMap

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

DrawCell

DrawColumnCell

DrawDataCell

EditButtonClick

EnableAlign

EndDrag

EndLayout

EndUpdate

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetColField

GetEditLimit

GetEditMask

GetEditText

GetFieldValue

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

HighlightCell

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

KeyDown

KeyPress

LayoutChanged

LinkActive

Loaded

MethodAddress

MethodName

MouseCoord

MouseDown

MouseUp

NewInstance

Notification

PaintTo

Perform

RawToDataColumn

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

Scroll

ScrollBy

SendToBack

SetBounds

SetColumnAttributes

SetEditText

SetFocus

SetTextBuf

Show

StoreColumns

TimedScroll

TitleClick

Update

UpdateControlState

ValidFieldIndex


TCustomDBGrid.AcquireLayoutLock
TCustomDBGrid.AcquireLayoutLock3093031

TCustomDBGrid	参照

AcquireLayoutLock メソッドは，テーブルが現在，フォーマット変更中でない場合，BeginLayout を呼び出します。

function  AcquireLayoutLock: Boolean;

説明

アプリケーションでこのプロテクトメソッドを呼び出すことはできません。AcquireLayoutLock は，データセット内の項目が変わったとき，または Columns プロパティが変わったときに，Columns を再計算する前に呼び出されます。このメソッドは，テーブルのレイアウトがまだ行われていない場合に True を返しますが，これは Columns を計算しなければならないことを意味します。AcquireLayoutLock を使えば，Columns の計算中に発生する変更がさらに計算を必要とすることによって，計算が無限に繰り返されることがないようにできます。


TCustomDBGrid.BeginLayout
TCustomDBGrid.BeginLayout3093032

TCustomDBGrid	参照

BeginLayout メソッドは，データセット内の列バインディングまたは項目が変わったときに LayoutLock プロパティをインクリメントします。

procedure BeginLayout;

説明

アプリケーションでこのプロテクトメソッドを呼び出すことはできません。BeginLayout メソッドは，データベース対応グリッドが Columns プロパティあるいは Columns プロパティ内の個々の TColumns オブジェクトを変更する前に内部的に呼び出されます。変更が終了したら，データベース対応グリッドは EndLayout メソッドを呼び出します。変更に対する応答処理を取り消すか延期しなければならない場合，そのグリッドは CancelLayout を呼び出します。

BeingLayout メソッドを呼び出すと，LayoutLock プロパティがインクリメントされます。EndLayout または CancelLayout を呼び出すと，LayoutLock プロパティがデクリメントされます。EndLayout の呼び出しの中で LayoutLock が 0 に戻った場合，Fields プロパティが更新されて，Columns プロパティのバインディング，およびデータセット内の利用可能な項目の両方と一致します。次に，Columns プロパティも更新され，Fields プロパティと一致します。その結果，Columns プロパティは，指定された列バインディング，およびデータセット内の利用可能な項目の両方と一致することになります。


TCustomDBGrid.BeginUpdate
TCustomDBGrid.BeginUpdate3093033

TCustomDBGrid	参照

BeginUpdate メソッドは，グリッド内のデータが変わったときに UpdateLock プロパティをインクリメントします。

procedure BeginUpdate;

説明

アプリケーションでこのプロテクトメソッドを呼び出すことはできません。BeginUpdate メソッドは，データベース対応グリッドがグリッド内に描画されているデータに影響するような変更を行う前に内部的に呼び出されます。変更が終了するとデータベース対応グリッドは EndUpdate を呼び出し，そこで UpdateLock プロパティのデクリメントが行われます。

UpdateLock が 0 より大きい間，グリッドはセルを再描画しません。BeginUpdate と EndUpdate は，グリッドのサイズが変わったとき，またはデータがスクロールされているとき，グリッドがちらつかないようにします。


TCustomDBGrid.CancelLayout
TCustomDBGrid.CancelLayout3093034

TCustomDBGrid	参照

CancelLayout メソッドは LayoutLock プロパティをデクリメントします。

procedure CancelLayout;

説明

アプリケーションでこのプロテクトメソッドを呼び出すことはできません。CancelLayout メソッドは，データベース対応グリッドが Columns プロパティの再計算を延期するときに内部的に呼び出されます。

BeingLayout メソッドを呼び出すと，LayoutLock プロパティがインクリメントされます。EndLayout メソッドまたは CancelLayout メソッドを呼び出すと，LayoutLock プロパティがデクリメントされます。CancelLayout を呼び出したときに LayoutLock が 0 に戻ったら，Columns プロパティは更新されません。DeferLayout メソッドは，LayoutLock をデクリメントして適当な時間まで Columns の再計算が行われないようにするため，CancelLayout を呼び出します。


TCustomDBGrid.CanEditAcceptKey
TCustomDBGrid.CanEditAcceptKey3093035

TCustomDBGrid	参照

CanEditAcceptKey メソッドは，Key パラメータを現在のセルに入力できるかどうかを示します。

function  CanEditAcceptKey(Key: Char): Boolean; override;

説明

データベース対応グリッドは，内部的に CanEditAcceptKey メソッドを呼び出して，ユーザーが入力したキーが現在のセルの項目として有効かどうかを調べます。CanEditAcceptKey メソッドは，入力フォーカスを持つ列に対応する項目コンポーネントの IsValidChar メソッドを呼び出します。

CanEditAcceptKey メソッドが行うキーボード入力の有効性確認は綿密なものではありません。セル内の値をデータセットのレコードに書き込むときはもっと細かいチェックが行われます。細かいチェックは編集マスクを使って行われます。


TCustomDBGrid.CanEditModify
TCustomDBGrid.CanEditModify3093036

TCustomDBGrid	参照

CanEditModify メソッドは，グリッドの現在の列を編集できるかどうかを示します。

function  CanEditModify: Boolean; override;

説明

データベース対応グリッドは，現在のセルを編集できるかどうかを調べるために内部的に CanEditmodify メソッドを呼び出します。CanEditModify は，現在の列の項目が編集できるときは True を，編集できないときは False を返します。データセットが編集モードでない場合は，CanEditModify はデータセットを編集モードに設定しようとします。

注意

CanEditModify メソッドは，現在の項目が BLOB 項目のときは False を返します。BLOB 項目はクリップボードまたはストリーミングを使わないと編集できません。


TCustomDBGrid.CanEditShow
TCustomDBGrid.CanEditShow3093037

TCustomDBGrid	参照

CanEditShow メソッドは，セルを編集するためにインプレース編集コントロールを作成できるかどうかを示します。

function CanEditShow: Boolean; override;

説明

TCustomDBGrid は継承メソッドをオーバーライドして，グリッドのレイアウトの再計算中はインプレース編集コントロールが起動しないようにします。

グリッドコントロールは，セルを編集するためのインプレースエディタを作成する前に CanEditShow を内部で呼び出します。CanEditModify 呼び出しによって項目が編集可能の場合， CanEditShow が呼び出されます。


TCustomDBGrid.CellClick
TCustomDBGrid.CellClick3093038

TCustomDBGrid	参照

CellClick メソッドは，OnCellClick イベントハンドラを呼び出します。

procedure CellClick(Column: TColumn); dynamic;

説明

アプリケーションで直接 CellClick を呼び出すことはできません。CellClick はプロテクトメソッドとしてエクスポーズされているので，派生オブジェクトは，さまざまなイベント発生に応答して OnCellClick イベントハンドラを呼び出したり，グリッドのセル内でマウスボタンが離されたときに応答方法を変更したりできます。


TCustomDBGrid.ColEnter
TCustomDBGrid.ColEnter3093039

TCustomDBGrid	参照

ColEnter メソッドは，OnColEnter イベントハンドラを呼び出します。

procedure ColEnter; dynamic;

説明

アプリケーションで直接 ColEnter を呼び出すことはできません。ColEnter はプロテクトメソッドとしてエクスポーズされているので，派生オブジェクトは，さまざまなイベント発生に応答して OnCellEnter イベントハンドラを呼び出したり，グリッド内のセルが選択されたときに応答方法を変更したりできます。


TCustomDBGrid.ColExit
TCustomDBGrid.ColExit3093040

TCustomDBGrid	参照

ColExit メソッドは，OnColExit イベントハンドラを呼び出します。

procedure ColExit; dynamic;

説明

アプリケーションで直接 ColExit を呼び出すことはできません。ColExit はプロテクトメソッドとしてエクスポーズされているので，派生オブジェクトは，さまざまなイベント発生に応答して OnColExit イベントハンドラを呼び出したり，グリッド内のセルからフォーカスが失われたときに応答方法を変更したりできます。


TCustomDBGrid.ColumnMoved
TCustomDBGrid.ColumnMoved3093041

TCustomDBGrid	参照

ColumnMoved メソッドは，OnColumnMoved イベントハンドラを呼び出します。

procedure ColumnMoved(FromIndex, ToIndex: Longint); override;

説明

アプリケーションで直接 ColumnMoved を呼び出すことはできません。ColumnMoved はプロテクトメソッドとしてエクスポーズされているので，派生オブジェクトは，さまざまなイベント発生に応答して OnColumnMoved イベントハンドラを呼び出したり，グリッド内の列が移動した後に応答方法を変更したりできます。


TCustomDBGrid.ColWidthsChanged
TCustomDBGrid.ColWidthsChanged3093042

TCustomDBGrid	参照

ColWidthsChanged メソッドは，列のサイズが変更されたときに Columns プロパティ内の列幅を更新します。

procedure ColWidthsChanged; override;

説明

アプリケーションで直接 ColWidthsChanged を呼び出すことはできません。ColWidthsChanged は，グリッド内の列のサイズが変更されたときに自動的に呼び出されます。ColWidthsChanged は，継承メソッドをオーバーライドして，Columns プロパティ内の列幅を更新します。


TCustomDBGrid.Create
TCustomDBGrid.Create3093043

TCustomDBGrid	参照

Create メソッドは，TCustomDBGrid のインスタンスを作成し初期化します。

constructor Create(AOwner: TComponent); override;

説明

TCustomDBGrid の派生オブジェクトで Create メソッドを呼び出すと，実行時にデータベース対応グリッドが作成されます。設計時にフォーム上に配置されたデータベース対応グリッドは，実行時に自動的に作成されることになります。

Create メソッドは継承コンストラクタを呼び出した後，データベース対応グリッドが使うヘルパーオブジェクトを作成し，以下の設定を行います。

・	Color を clWindow に，ParentColor を False に設定する

・	DefaultDrawing を True に設定する

・	Options に [dgEditing，dgTitles，dgIndicator，dgColumnResize，dgColLines，dgRowLines，dgTabs，dgConfirmDelete，dgCancelOnExit] を設定する


TCustomDBGrid.CreateColumns
TCustomDBGrid.CreateColumns3093044

TCustomDBGrid	参照

CreateColumns メソッドは，グリッドの列デスクリプタを格納する TDBGdidColumns オブジェクトを作成します。

function  CreateColumns: TDBGridColumns; dynamic;

説明

アプリケーションでこのメソッドを呼び出すことはできません。このメソッドはプロテクトメソッドとしてエクスポーズされているので，コンポーネント作成者は TDBGridColumns の派生オブジェクトにデータベース対応グリッドの列デスクリプタを管理させることができ，また DBGrids ユニット内のヘルパーオブジェクトはグリッドの列デスクリプタ群を作成することができます。


TCustomDBGrid.CreateEditor
TCustomDBGrid.CreateEditor3093045

TCustomDBGrid	参照

CreateEditor メソッドは，グリッドのセルを編集できるインプレースエディタを作成します。

function CreateEditor: TInplaceEdit; override;

説明

CreateEditor メソッドは，継承メソッドをオーバーライドして，TInplaceEdit のデータベース対応の派生オブジェクトを作成します。


TCustomDBGrid.CreateWnd
TCustomDBGrid.CreateWnd3093046

TCustomDBGrid	参照

CreateWnd メソッドは，データベース対応グリッドを表示するためのウィンドウを作成します。

procedure CreateWnd; override;

説明

CreateWnd メソッドはウィンドウ作成後，表示とデータソースとの関係をセットアップするために継承メソッドをオーバーライドします。


TCustomDBGrid.DataToRawColumn
TCustomDBGrid.DataToRawColumn3093047

TCustomDBGrid	参照

DataToRawColumn メソッドは，Columns プロパティ内の列インデックスを表示上の対応する列のインデックスに変換します。

function  DataToRawColumn(ACol: Integer): Integer;

説明

アプリケーションでこのプロテクトメソッドを呼び出すことはできません。DataToRawColumn は内部的に呼び出され，データベース対応グリッドが行インジケータを含む列の有無に対処できるようにします。


TCustomDBGrid.DefaultDrawColumnCell
TCustomDBGrid.DefaultDrawColumnCell3093048

TCustomDBGrid	参照

DefaultDrawColumnCell メソッドは，列セルにテキストを描画します。

type TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

procedure DefaultDrawColumnCell(const Rect: TRect; DataCol: Integer; Column: TColumn; State: TGridDrawState);

説明

DefaultDrawColumnCell メソッドを OnDrawColumnCell イベントハンドラからを呼び出すと，項目のテキスト表現を探し，それをセルに書き込むことができます。DefaultDrawColumnCell は，DefaultDrawing プロパティが True のときにグリッドが描画するのと同じ処理を行います。ただし，セル上に長方形のフォーカス領域を描画することはありません。

Rect パラメータはキャンバス上のセルの位置を指定します。DataCol パラメータは Columns 配列における列のインデックスです。Column パラメータはセルの表示属性と項目バインディングを表す TColumn オブジェクトです。State パラメータは，セルに入力フォーカスがあるか，セルが選択されているか，およびセルが列ヘッダーのような固定（データ以外）セルであるかを指定します。


TCustomDBGrid.DefaultDrawDataCell
TCustomDBGrid.DefaultDrawDataCell3093049

TCustomDBGrid	参照

DefaultDrawDataCell メソッドは列セルにテキストを描画します。

type TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

procedure DefaultDrawDataCell(const Rect: TRect; Field: TField; State: TGridDrawState);

説明

DefaultDrawDataCell メソッドを OnDrawDataCell イベントハンドラからを呼び出すと，項目のテキスト表現を探し，セルに書き込むことができます。DefaultDrawing プロパティが True のときにグリッドが行う描画とは違って，DefaultDrawDataCell は，列デスクリプタではなく項目コンポーネントからテキストの位置合わせ情報を取り出し，またセル上に長方形のフォーカス領域を描画しません。

Rect パラメータはキャンバス上のセルの位置を，Fields パラメータはセルのデータおよび位置合わせ情報を与える項目コンポーネントを指定します。State パラメータは，セルに入力フォーカスがあるか，セルが選択されているか，およびセルが列ヘッダーのような固定（データ以外）セルであるかを指定します。


TCustomDBGrid.DefaultHandler
TCustomDBGrid.DefaultHandler3093050

TCustomDBGrid	参照

DefaultHandler プロパティは，列を右クリックしたときにポップアップメニューを表示します。

procedure DefaultHandler(var Msg); override;

説明

DefaultHandler は，グリッドに送られる Windows メッセージを受け取る最後のメソッドです。継承されたメソッドを呼び出してメッセージを処理させた後で，DefaultHandler は，Msg パラメータが右マウスボタンが列で離されてポップアップメニューが表示されたことを示しているかどうかを調べます。 AutoPopup プロパティが True に設定されていて列にポップアップメニューがある場合，DefaultHandler はそのポップアップメニューを表示します。

DefaultHandler をオーバーライドするときは，未処理のメッセージを処理させるために継承されたメソッドを呼び出してください。


TCustomDBGrid.DeferLayout
TCustomDBGrid.DeferLayout3093051

TCustomDBGrid	参照

DeferLayout プロパティは， LayoutLock プロパティをデクリメントしてから，適切な時間に新しいレイアウトシーケンスを発生させるメッセージをグリッドに送ります。

procedure DeferLayout;

説明

アプリケーションでこのプロテクトメソッドを呼び出すことはできません。データベース対応グリッドは DeferLayout を内部的に呼び出して，データセットの変更後に列をすぐに再計算するのが適当でない場合に，Columns プロパティの再計算を延期することができます。

DeferLayout は，データセット内の変化に対応してインクリメントしてきた LayoutLock プロパティを CancelLayout を呼び出して，デクリメントします。次に，後でまたレイアウトシーケンスを発生させるメッセージをグリッドに送ります。グリッドはメッセージを受け取ると BeginLayout を呼び出してから，今が Columns の計算を進める適当な時間かどうかに応じて EndLayout または DeferLayout のいずれかを呼び出します。


TCustomDBGrid.DefineFieldMap
TCustomDBGrid.DefineFieldMap3093052

TCustomDBGrid	参照

DefineFieldMap は，Columns プロパティおよびデータソースから Fields 配列を構築します。

procedure DefineFieldMap; virtual;

説明

アプリケーションでこのプロテクトメソッドを呼び出すことはできません。DefineFieldMap は，Fields 配列を再構築して，Columns プロパティ内の列に対応するデータソース項目の内容を反映するようにします。アプリケーションでは，DefineFieldMap を呼び出した後，Columns プロパティを更新して，Fields 配列内の項目コンポーネントを使用できるようにしなければなりません。その結果，Columns プロパティはデータセットの変化を反映するようになります。


TCustomDBGrid.Destroy
TCustomDBGrid.Destroy3093054

TCustomDBGrid	参照

Destroy メソッドは，TCustomDBGrid オブジェクトのインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出してください。Free メソッドはデータベース対応グリッドがまだ解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。Destroy メソッドはグリッドが使用したすべてのヘルパーオブジェクトを解放します。


TCustomDBGrid.DrawCell
TCustomDBGrid.DrawCell3093055

TCustomDBGrid	参照

DrawCell メソッドは，ACol および ARow パラメータによって指定されるセルを描画します。

type TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

procedure DrawCell(ACol, ARow: Longint; ARect: TRect; AState: TGridDrawState); override;

説明

DrawCell メソッドは，グリッド内でセルを描画するとき Columns プロパティを使えるように，継承メソッドをオーバーライドします。

DrawCell メソッドはフォントとブラシをセットアップし，セルの背景をペイントします。DefaultDrawing プロパティが True の場合，データを取り出して ARect パラメータが指す位置に書き込みます。次に，DefaultDrawing が True，False いずれであっても，OnDrawDataCell イベントと OnDrawColumnCell イベントを発生します。最後に，DefaultDrawing が True で，セルにフォーカスがあるかそのセルが選択されていて，なおかつ Options に dgAlwaysShowSelection が含まれている場合，セルの周囲に長方形のフォーカス領域を描画します。


TCustomDBGrid.DrawColumnCell
TCustomDBGrid.DrawColumnCell3093056

TCustomDBGrid	参照

DrawColumnCell メソッドは，OnDrawColumnCell イベントハンドラを呼び出します。

type TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

procedure DrawColumnCell(const Rect: TRect; DataCol: Integer; Column: TColumn; State: TGridDrawState); dynamic;

説明

アプリケーションでは直接 DrawColumnCell メソッドを呼び出すことはできません。DrawColumnCell はプロテクトメソッドとしてエクスポーズされているので，派生メソッドが OnDrawColumnCell イベントハンドラを呼び出すか，あるいは DrawColumnCell をオーバーライドしてイベントをブロックすることができます。


TCustomDBGrid.DrawDataCell
TCustomDBGrid.DrawDataCell3093057

TCustomDBGrid	参照

DrawDataCell は，OnDrawDataCell イベントハンドラを呼び出します。

type TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

procedure DrawDataCell(const Rect: TRect; Field: TField; State: TGridDrawState); dynamic;

説明

アプリケーションでは直接 DrawDataCell を呼び出すことはできません。DrawDataCell はプロテクトメソッドとしてエクスポーズされているので，その派生メソッドは OnDrawDataCell イベントハンドラを呼び出すか，あるいは DrawDataCell をオーバーライドしてイベントをブロックすることができます。


TCustomDBGrid.EditButtonClick
TCustomDBGrid.EditButtonClick3093058

TCustomDBGrid	参照

EditButtonClick メソッドは OnEditButtonClick イベントハンドラを呼び出します。

procedure EditButtonClick; dynamic;

説明

アプリケーションでは直接 EditButtonCLick を呼び出すことはできません。EditButtonClick はプロテクトメソッドとしてエクスポーズされているので，その派生メソッドは OnEditButtonClick イベントハンドラを呼び出すか，あるいは EditBUttonClick をオーバーライドしてイベントをブロックすることができます。


TCustomDBGrid.EndLayout
TCustomDBGrid.EndLayout3093059

TCustomDBGrid	参照

EndLayout メソッドは，LayoutLock プロパティをデクリメントし，これが 0 になったら Columns プロパティを再計算します。

procedure EndLayout;

説明

アプリケーションではこのプロテクトメソッドを呼び出すことはできません。データベース対応グリッドは，Columns プロパティまたはデータセットが変わった後で内部的に EndLayout を呼び出します。Columns プロパティが変更される前，あるいはデータセットの変化通知を受け取ったときに BeginLayout がインクリメントしてきた Layout プロパティを EndLayout は，デクリメントします。

LayoutLock が 0 に戻ったら，EndLayout は Fields プロパティを更新して，Columns プロパティのバインディングと，データセット内の利用可能な項目の両方とが一致するようにします。次に Columns プロパティを更新して，Fields プロパティと一致するようにします。その結果 Columns プロパティは，指定された列のバインディング，およびデータセット内の利用可能な項目の両方と必ず一致することになります。


TCustomDBGrid.EndUpdate
TCustomDBGrid.EndUpdate3093060

TCustomDBGrid	参照

EndUpdate メソッドは，UpdateLock プロパティをデクリメントします。

procedure EndUpdate;

説明

アプリケーションでこのプロテクトメソッドを呼び出すことはできません。データベース対応グリッドは，グリッド内で描画されているデータに影響を与える変更を行った後で EndUpdate を内部的に呼び出します。EndUpdate は，UpdateLock プロパティを，変更開始時の BeginUpdate メソッドが呼び出されたときの状態に戻します。

UpdateLock プロパティが 0 より大きい間，グリッドはセルを再描画しません。0 に戻ると，再び描画できるようになります。BeginUpdate と EndUpdate によって，グリッドのサイズが変わったりデータがスクロールされたりしたときにグリッドがちらつくことがなくなります。


TCustomDBGrid.GetColField
TCustomDBGrid.GetColField3093061

TCustomDBGrid	参照

GetColField メソッドは，指定された列のバインディングを表す項目コンポーネントを返します。

function  GetColField(DataCol: Integer): TField;

説明

GetColField メソッドを呼び出すと，列の項目コンポーネントを取得できます。DataCol パラメータは，Columns プロパティにおける列のインデックスを示します。最初の列が 0，次の列が 1 となります。

Fields プロパティと違って，GetColField メソッドはデータセット内の項目にはない列，つまり計算項目などの列の項目コンポーネントを返します。


TCustomDBGrid.GetEditLimit
TCustomDBGrid.GetEditLimit3093062

TCustomDBGrid	参照

GetEditLimit メソッドは，文字項目を表すセルに入力できる文字数を指定します。

function  GetEditLimit: Integer; override;

説明

インプレースエディタは，GetEditLimit メソッドを呼び出して，ユーザーがセルに入力する文字数を制限しなければならないかどうかを調べます。このメソッドは，指定されたセルが文字列項目でないときはアプリケーションに何の制限も与えません。


TCustomDBGrid.GetEditMask
TCustomDBGrid.GetEditMask3093063

TCustomDBGrid	参照

GetEditMask メソッドは，項目または指定されたセル項目の入力マスクを返します。

function  GetEditMask(ACol, ARow: Longint): string; override;

説明

インプレースエディタは，GetEditMask メソッドを呼び出して，指定されたセルの項目バインディングに関する入力マスクを取得します。GetEditMask は，Columns 配列から項目コンポーネントの EditMask プロパティを返します。

ACol パラメータと ARow パラメータは，グリッド内のセルの行／列インデックスを示します。ACol パラメータは，Options プロパティに dgIndicator が含まれている場合，Columns 配列における列インデックスと同じではありません。


TCustomDBGrid.GetEditText
TCustomDBGrid.GetEditText3093064

TCustomDBGrid	参照

GetEditText メソッドは，指定されたセルの値を編集形式で返します。

function GetEditText(ACol, ARow: Longint): string; override;

説明

インプレースエディタは，GetEditText メソッドを呼び出して，指定したセルのテキストを取得します。GetEditText は，Columns 配列からセルの項目コンポーネントを見つけ，その値を編集形式で返します。

ACol パラメータと ARow パラメータは，グリッドにおけるセルの行/列インデックスを示します。ACol パラメータは純粋な列インデックスで，Options プロパティに dgIndicator が設定されている場合，Columns 配列における列インデックスとは異なります。

注意

GetEditText が返す文字列は，その形式が編集用と表示用で異なる場合，GetFieldValue メソッドが返す文字列とは異なる場合があります。


TCustomDBGrid.GetFieldValue
TCustomDBGrid.GetFieldValue3093065

TCustomDBGrid	参照

GetFieldValue メソッドは，指定されたセルの値を表示形式で返します。

function GetFieldValue(ACol: Integer): string;

説明

GetFieldValue を呼び出すと，セル内で表示しなければならないテキストを取得できます。たとえば OnDrawColumnCell イベントハンドラは，特別な形式で描画するテキストを得るために，DefaultDrawColumnCell ではなく GetFieldValue を呼び出します。

ACol パラメータは Columns 配列における列のインデックスです。Options プロパティが dgIndicator を含んでいる場合，このインデックスは物理的に表示される列のインデックスとは異なります。


TCustomDBGrid.HighlightCell
TCustomDBGrid.HighlightCell3093066

TCustomDBGrid	参照

HighlightCell メソッドは，DataCol パラメータと DataRow パラメータによって示されたセルを描画するとき，強調表示すべきかどうかを指定します。

type TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

function  HighlightCell(DataCol, DataRow: Integer; const Value: string; AState: TGridDrawState): Boolean; virtual;

説明

アプリケーションでこのプロテクトメソッドを呼び出すことはできません。HighlightCell は，指定されたセルを強調表示しなければならないかどうかを DrawCell メソッドが判断するときに内部的に呼び出されます。セルにフォーカスがあって選択されており，かつ Options に dgAlwaysShowSelection が設定されている場合，あるいはセルが選択された行にあって Options に dgRowSelect が設定されている場合，HighlightCell は True を返します。


TCustomDBGrid.KeyDown
TCustomDBGrid.KeyDown3093067

TCustomDBGrid	参照

KeyDown メソッドは，キーが押されたときの処理を指定します。

procedure KeyDown(var Key: Word; Shift: TShiftState); override;

説明

アプリケーションでこのプロテクトメソッドを呼び出すことはできません。KeyDown は，ユーザーがあるキーを押したときに，KeyPress メソッドが呼ばれる前に自動的に呼び出されます。

KeyDown メソッドは，OnKeyDown イベントを生成し，以下のようにキーストロークに対応します。

キーストローク	応答

〔↑〕	前の行に移動する。Options に dgRowSelect が設定されている場合，前の行を選択する

〔Ctrl〕+〔↑〕	グリッド内の最初の行に移動する。選択されている行はすべて選択を解除される

〔↓〕	次の行に移動する。Options に dgRowSelect が設定されている場合，次の行を選択する

〔Ctrl〕+〔↓〕	グリッド内の最後の行に移動する。選択されている行はすべて選択を解除される

〔PageUp〕	表示されているレコード数だけグリッド内を上に移動する。選択されている行はすべて選択を解除される

〔Ctrl〕+〔PageUp〕	グリッド内の最初の行に移動する。選択されている行はすべて選択を解除される

〔PageDown〕	表示されているレコード数だけグリッド内を下に移動する。選択されている行はすべて選択を解除される

〔←〕	左に 1 列移動する。Options に dgRowSelect が設定されている場合，前の行に移動するが選択はしない

〔Ctrl〕+〔←〕	現在の行内で最初の列に移動する

〔→〕	右に 1 列移動する。Options にdgRowSelect が設定されている場合，次の行に移動するが選択はしない

〔Ctrl〕+〔→〕	現在の行内で最後の列に移動する

〔Home〕	現在の行の最初の列に移動する。Options に dgRowSelect が設定されている場合，またはグリッドに 1 列しかない場合，データセット内の最初のレコードに移動する。選択されている行はすべて選択を解除される

〔Ctrl〕+〔Home〕	データセット内の最初のレコードに移動する。選択されている行はすべて選択を解除される

〔End〕	現在の行の最後の列に移動する。Options に degRowSelect が設定されている場合，またはグリッドに 1 列しかない場合，データセット内の最後のレコードに移動する。選択されている行はすべて選択を解除される

〔Ctrl〕+〔End〕	データセット内の最後の行に移動する。選択されている行はすべて選択を解除される

〔Tab〕	グリッド内の次のセルに移動する

〔Shift〕+〔Tab〕	グリッド内の前のセルに移動する

〔Ctrl〕+〔Del〕	現在，選択されているものを削除する

〔Ins〕	現在の行の上に新しい行を挿入し，そこに移動する。選択されている行はすべて選択を解除される

〔Esc〕	登録されていない編集をすべて取り消す。選択されている行はすべて選択を解除される

〔F2〕	グリッドを編集モードに設定する


TCustomDBGrid.KeyPress
TCustomDBGrid.KeyPress3093068

TCustomDBGrid	参照

KeyPress メソッドは，〔Enter〕キーが押されたときに編集データをデータベースに登録するため，継承メソッドをオーバーライドします。

procedure KeyPress(var Key: Char); override;

説明

あるキーが押されると，まず KeyDown メソッドが呼び出され，次に KeyPress メソッドが呼び出されます。最後にキーが離されたとき KeyUp メソッドが呼び出されます。KeyPress は，編集が保留されているデータをデータベースに登録し，継承された Keypress メソッドを呼び出します。


TCustomDBGrid.LayoutChanged
TCustomDBGrid.LayoutChanged3093069

TCustomDBGrid	参照

LayoutChanged メソッドは，Columns プロパティを再計算します。

procedure LayoutChanged; virtual;

説明

アプリケーションではこのプロテクトメソッドを呼び出すことはできません。LayoutChanged は，列のレイアウトに影響する変更があったときに自動的に呼び出されます。以下に変更の種類を示します。

・	データセット内の項目の変更

・	レイアウトに変更を与える Options プロパティの変更

・	TitleFont プロパティの変更

LayoutChanged メソッドは，AcquireLayoutLock を呼び出して Columns プロパティの変更を開始します。LayoutChanged の呼び出しが再帰的でないことを AcquireLayoutLock が示した場合は，LayoutChange は EndLayout を呼び出して Columns プロパティの計算を始めます。


TCustomDBGrid.LinkActive
TCustomDBGrid.LinkActive3093070

TCustomDBGrid	参照

LinkActive メソッドは，Columns プロパティ，およびグリッドの垂直スクロールバーを再計算します。

procedure LinkActive(Value: Boolean); virtual;

説明

アプリケーションでこのプロテクトメソッドを呼び出すことはできません。LinkActive は，データセットを開いたとき自動的に呼び出されます。LinkActive は，LayoutChanged を呼び出して Columns プロパティを再計算し，次に垂直スクロールバーを調整してデータセット内のデータを表示します。


TCustomDBGrid.Loaded
TCustomDBGrid.Loaded3093071

TCustomDBGrid	参照

Loaded メソッドは，データグリッドおよびその子コンポーネントがロードされたとき Columns プロパティをセットアップします。

procedure Loaded; override;

説明

アプリケーションでこのプロテクトメソッドを呼び出すことはできません。Loaded は，グリッドのすべての部分がロードされた後でグリッドのレイアウトを決めるため，継承メソッドをオーバーライドします。


TCustomDBGrid.MouseDown
TCustomDBGrid.MouseDown3093072

TCustomDBGrid	参照

MouseDown メソッドは，ユーザーがマウスをクリックしたときの処理を指定します。

procedure MouseDown(Button: TMouseButton; Shift: TShiftState; X, Y: Integer); override;

説明

MouseDown メソッドは，ユーザーがマウスボタンを押したとき自動的に呼び出されます。マウスがグリッドの行/列サイズ変更領域で押された場合に，MouseDown は編集が保留されているデータを登録し，サイズ変更を行なう継承メソッドを呼び出します。Options に dgRowSelect が含まれていると，クリックされた行を選択するか，あるいは〔Ctrl〕キーが押されていれば選択状態を切り替えます。マウスがデータセル内でクリックされた場合，MouseDown はグリッドを編集モードに設定しようとします。


TCustomDBGrid.MouseUp
TCustomDBGrid.MouseUp3093073

TCustomDBGrid	参照

MouseUp メソッドは，ユーザーがマウスボタンを離したときの処理を指定します。

procedure MouseUp(Button: TMouseButton; Shift: TShiftState; X, Y: Integer); override;

説明

MouseUp メソッドは，ユーザーがマウスボタンを離したときに自動的に呼び出されます。MouseUp は継承メソッドを呼び出した後，マウスがあったセルを特定し，マウスの位置に応じて OnTitleClick イベントまたは OnCellClick イベントを生成します。


TCustomDBGrid.Notification
TCustomDBGrid.Notification3093074

TCustomDBGrid	参照

Notification メソッドは，子コンポーネントのどれかが破棄されたときにグリッドを調整します。

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

Notification は，継承メソッドを呼び出してから以下の処理を行います。

・	ポップアップメニューをチェックして列のどれかが破棄されているかどうかを調べ，破棄されていれば列オブジェクトの PopupMenu プロパティをリセットする

・	データソースが破棄されているかどうかをチェックし，破棄されていれば DataSource プロパティを nil に設定する

・	列の項目コンポーネントが破棄されているかどうかをチェックし，破棄されていればレイアウトから列を削除する


TCustomDBGrid.RawToDataColumn
TCustomDBGrid.RawToDataColumn3093075

TCustomDBGrid	参照

RawToDataColumn メソッドは，表示されている列のインデックスを Columns プロパティ内の対応するインデックスに変換します。

function  RawToDataColumn(ACol: Integer): Integer;

説明

アプリケーションではこのプロテクトメソッドを呼び出すことはできません。RawToDataColumn は，データベース対応グリッドが行インジケータを含む列の有無に合わせて調整するために内部的に使用されます。


TCustomDBGrid.Scroll
TCustomDBGrid.Scroll3093076

TCustomDBGrid	参照

Scroll メソッドは，レコード位置が新しくなったのに対応してグリッドのイメージを更新します。

procedure Scroll(Distance: Integer); virtual;

説明

Scroll メソッドは，データセット内の現在のレコードに変更があったとき呼び出されます。Scroll はグリッドのイメージを更新し必要ならスクロールも行います。


TCustomDBGrid.SetColumnAttributes
TCustomDBGrid.SetColumnAttributes3093077

TCustomDBGrid	参照

SetColumnAttributes メソッドは，列の幅を設定し，編集できないセルへのタブ移動ができないようにします。

procedure SetColumnAttributes; virtual;

説明

アプリケーションではこのプロテクトメソッドを呼び出すことはできません。SetColumnAttributes は，Columns プロパティを再計算するときに自動的に呼び出され，列の幅を調整してユーザーが編集可能な項目にしかタブ移動できないようにします。


TCustomDBGrid.SetEditText
TCustomDBGrid.SetEditText3093078

TCustomDBGrid	参照

SetEditText メソッドは現在のセルデータの値を更新します。

procedure SetEditText(ACol, ARow: Longint; const Value: string); override;

説明

現在のセルに新しい値を格納できるように，インプレースエディタが SetEditText を呼び出します。ユーザーが新しいセルに移動するか〔Esc〕キーを押すまで，グリッドはこの値を保存しておきます。ユーザーが新しいセルに移動したら，この値はデータセット内のレコードに書き込まれます。ユーザーが〔Esc〕キーを押すと値は棄てられます。


TCustomDBGrid.StoreColumns
TCustomDBGrid.StoreColumns3093079

TCustomDBGrid	参照

StoreColumns メソッドは，グリッドを保存するときに列も格納するのか，または各列を動的に生成するのかを指定します。

function  StoreColumns: Boolean;

説明

StoreColumns メソッドは，State プロパティに csCustomized が設定されているときしか列を保存しません。State プロパティで，データセットの項目から列を動的に生成するか，あるいはプログラムまたは列エディタを使って列を指定するかを示します。


TCustomDBGrid.TimedScroll
TCustomDBGrid.TimedScroll3093080

TCustomDBGrid	参照

TimedScroll メソッドは，マウスがデータセル外にドラッグされたときに現在のレコードを移動します。

type TGridScrollDirection = set of (sdLeft, sdRight, sdUp, sdDown);

procedure TimedScroll(Direction: TGridScrollDirection); override;

説明

TimedScroll メソッドは，Direction パラメータに sdUp が設定されている場合に，グリッド内の最初の表示レコードにデータセットを移動します。sdDown が設定されている場合，グリッド内の最後の表示レコードにデータセットを移動します。移動後に継承メソッドを呼び出してイメージを更新します。


TCustomDBGrid.TitleClick
TCustomDBGrid.TitleClick3093081

TCustomDBGrid	参照

TitleClick メソッドは，OnTitleClick イベントハンドラを呼び出します。

procedure TitleClick(Column: TColumn); dynamic;

説明

アプリケーションで直接 TitleClick メソッドを呼び出すことはできません。TitleClick はプロテクトメソッドとしてエクスポーズされているので，派生メソッドで OnTitleClick イベントハンドラを呼び出すか，あるいは TitleClick イベントをオーバーライドして OnTitleClick イベントをブロックすることができます。


TCustomDBGrid.ValidFieldIndex
TCustomDBGrid.ValidFieldIndex3093082

TCustomDBGrid	参照

ValidFieldIndex は，列配列のインデックスがデータセット内の有効な項目を指しているかどうかを示します。

function ValidFieldIndex(FieldIndex: Integer): Boolean;

説明

ValidFieldIndex を呼び出すと，指定した列がデータセット内の項目を表示しているかどうかがわかります。ValidFieldIndex は，指定した列がデータセット内の項目であるときは True を返します。指定した列が計算項目であるか，または未定義項目であるときは False を返します。


スコープ3093083

protected

published

読み出し／書き込み

読み出し専用


スコープ3093084

protected


スコープ3093085

protected


継承3093086

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomGrid


TCustomDBGrid 例3093087

TCustomDBGrid


TCustomEdit
TCustomEdit3094001

継承	プロパティ	メソッド	イベント	参照

TCustomEdit オブジェクトは編集ボックスコントロールおよびメモコントロールを派生させる抽象クラスです。

ユニット

stdctrls

説明

TCustomEdit は以下の機能を提供するメソッドおよびプロパティを提供し，テキスト編集に使うすべてのコンポーネントに共通する基本的な動作をカプセル化します。

・	テキスト編集の基本機能。たとえばテキストの選択，選択したテキストの変更，および大文字小文字の変更など

・	テキストの内容の変更を処理する機能

・	読み出し専用またはパスワードによる実際の値の隠蔽といったテキストへのアクセス制御

TCustomEdit のインスタンスは作成しないでください。TCustomEdit はユーザーにテキストの入力および変更を許可するコントロールオブジェクトの宣言で使う基本クラスとして使います。 TCustomEdit のプロパティおよびメソッドが提供する基本機能には下位クラスで継承するものやコンポーネントがオーバーライドして動作をカスタマイズできるものがあります。


TCustomEdit プロパティ3094002

TCustomEdit	アルファベット順	凡例

TCustomEdit

AutoSelect

AutoSize

BorderStyle

CharCase

HideSelection

MaxLength

Modified

OEMConvert

PasswordChar

ReadOnly

SelLength

SelStart

SelText

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ParentColor

ShowHint

Text

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomEdit プロパティ3094003

TCustomEdit	オブジェクト順	凡例

Align

AutoSelect

AutoSize

BorderStyle

BoundsRect

Brush

CharCase

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

HideSelection

Hint

Left

MaxLength

Modified

Name

OEMConvert

Owner

Parent

ParentColor

ParentWindow

PasswordChar

ReadOnly

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

Width

WindowProc


TCustomEdit.AutoSelect
TCustomEdit.AutoSelect3094004

TCustomEdit	参照

AutoSelect プロパティは，編集コントロールがフォーカスを得たときにコントロールのすべてのテキストを自動的に選択するかどうかを決定します。

property AutoSelect: Boolean;

説明

編集コントロールがフォーカスを得たときにすべてのテキストを選択するには AutoSelect を True にします。AutoSelect は単一行の編集コントロールにのみ適用できます。

編集コントロールの内容が追加されるよりも置換される場合の方が多いと思われるときに AutoSelect を使います。


TCustomEdit.AutoSize
TCustomEdit.AutoSize3094005

TCustomEdit	参照

AutoSize プロパティは，テキストに合わせて編集コントロールの高さを自動的に変更するかどうかを決定します。

property AutoSize: Boolean;

説明

AutoSize はクライアント領域の高さをテキストに合わせるように編集コントロールのサイズを調整するのに使います。AutoSize が False であれば，編集コントロールの高さは固定です。AutoSize が True であれば，フォントや境界線のスタイル変更のようにコントロールの高さに影響する変更が発生したときにコントロールのサイズが再調節されます。

注意

AutoSize は編集コントロールの高さのみを調整します。AutoSize が True の場合でも，テキストの幅が編集コントロールよりも大きくなった場合はテキスト表示が切れてしまうことがあります。


TCustomEdit.BorderStyle
TCustomEdit.BorderStyle3094006

TCustomEdit	参照

BorderStyle プロパティは，編集コントロールがクライアント領域の周囲に単一線の境界をもつかどうかを決定します。

property BorderStyle: TBorderStyle;

説明

BorderStyleプロパティは，編集コントロールのクライアント領域の見かけを変更することができます。BorderStyle の値は bsSingle または bsNone です。BorderSyle が bsSingle の場合，編集コントロールは周囲に単一線の境界を持ちます。BorderStyle が bsNone の場合，境界はありません。

注意

BorderStyle と Ctl3D プロパティを使うと異なった視覚効果を作ることができます。2 つのプロパティのさまざまな組み合わせを試みて目的の外観を得ることができます。


TCustomEdit.CharCase
TCustomEdit.CharCase3094007

TCustomEdit	参照

CharCase プロパティは，編集コントロール内のテキストの大文字と小文字を決定します。

property CharCase: TEditCharCase;

説明

CharCaseプロパティは，編集コントロールの内容を大文字または小文字に変換します。以下に CharCase の値を示します。

値	意味

ecLowerCase	テキストを小文字に変換する

ecNormal	テキストは大文字と小文字のどちらでもよい

ecUpperCase	テキストを大文字に変換する

CharCase が ecLowerCase または ecUpperCase である場合，ユーザーが編集コントロールに入力する時点で文字の大文字と小文字が変換されます。CharCase プロパティを ecLowerCase または ecUpperCase に変更すると，テキストの表示だけでなく実際のデータも変更されます。大文字と小文字を区別する情報は失われるため，CharCase を ecNormal に戻しても復旧はできません。


TCustomEdit.HideSelection
TCustomEdit.HideSelection3094008

TCustomEdit	参照

HideSelection プロパティは，フォーカスが他のコントロールに移動した場合でもテキストが範囲選択された状態の表示を続けるかどうかを決定します。

property HideSelection: Boolean;

説明

HideSelection プロパティを False に設定すると編集コントロールがフォーカスを持たない状態でもテキストが選択されたときと同じ長方形領域を描画したままにします。HideSelection を True に設定すると編集コントロールがフォーカスを持っている場合にのみ選択された長方形領域を描画します。HideSelection は選択の実際の値には無関係で，その視覚的な表示にのみ影響します。常に HideSelection を False にしておくと編集コントロールの多いフォームが見づらくなる場合があります。


TCustomEdit.MaxLength
TCustomEdit.MaxLength3094009

TCustomEdit	参照

MaxLength プロパティは，ユーザーが編集コントロールに入力できる文字の最大長を指定します。

property MaxLength: Integer;

説明

MaxLength プロパティは，編集コントロールに入力できる文字の長さをバイト単位で指定します。値を 0 に設定すると，長さに制限はなくなります。MaxLength は単一行の編集コントロールにのみ適用されます。

編集コントロールのテキストが固定長バッファにコピーされることがありえる場合に，MaxLength を使ってテキストの長さを制限するとよいでしょう。

注意

MaxLength を設定しても既存のテキストの長さを切りつめることはできず，単に MaxLength に指定された文字数以上の入力が禁止されるだけです。


TCustomEdit.Modified
TCustomEdit.Modified3094010

TCustomEdit	参照

Modified プロパティは，ユーザーが編集コントロールのテキストを編集したかどうかを示します。

property Modified: Boolean;

説明

Modified プロパティは，編集コントロールの Text が変更されたかどうかを調べます。Text プロパティをプログラムで直接変更する場合，Modified プロパティも True に設定しなければなりません。


TCustomEdit.OEMConvert
TCustomEdit.OEMConvert3094011

TCustomEdit	参照

OEMConvert プロパティは，編集コントロールに入力された文字を ANSI から OEM に変換して再び ANSI に戻すかどうかを決定します。

property OEMConvert: Boolean;

説明

編集コントロールに入力された文字が確実に OEM 文字セットに変更されるようにするには，OEMconvert を True に設定します。これにより，すべての文字が入力時に ANSI から OEM に変換されてその後で ANSI に戻されます。テキストを OEM 文字列にマップする必要がない場合は OEMconvert を False に設定すれば変換のオーバーヘッドを回避できます。


TCustomEdit.PasswordChar
TCustomEdit.PasswordChar3094012

TCustomEdit	参照

PasswordChar プロパティは，入力された実際の文字の代わりに表示する文字を設定します。

property PasswordChar: Char;

説明

PasswordChar プロパティは，入力された文字の代わりに別の文字を表示する編集コントロールを作ります。PasswordChar をヌル文字（ANSI 文字コードではゼロ）に設定すると，編集コントロールはテキストをそのまま表示します。PasswordChar がヌル文字以外の場合は，編集コントロールは入力された文字の代わりに PasswordChar の文字を表示します。PasswordChar は編集コントロールの表示のみに影響します。Text プロパティの値は入力された実際の文字を示します。


TCustomEdit.ReadOnly
TCustomEdit.ReadOnly3094013

TCustomEdit	参照

ReadOnly プロパティは，ユーザーが編集コントロールのテキストを変更できるかどうかを決定します。

property ReadOnly: Boolean;

説明

編集コントロールを表示のみに制限するには ReadOnly プロパティを True に設定します。編集コントロールでの編集を可能にするには ReadOnly を False に設定します。

ReadOnly を True に設定するとテキストの変更はできなくなりますが，テキストの選択はできます。選択されたテキストをアプリケーションによって操作したり，クリップボードにコピーしたりすることができます。


TCustomEdit.SelLength
TCustomEdit.SelLength3094014

TCustomEdit	参照

SelLength プロパティは，選択されている文字の数です。

property SelLength: Integer;

説明

SelLength プロパティは，選択されているテキストの長さをバイト数で調べます。SelLength を設定すると，選択の内容をSelStart から始まり，SelLength の長さの文字列に変更できます。

注意

SelLength の値を SelStart が示す文字からテキストの最後までの文字数よりも大きく設定すると SelStart からテキストの最後までのすべての文字が選択されます。SelLength の値を利用できる文字数よりも大きく設定した後に SelLength を参照すると，設定した値ではなく実際に選択されている文字の長さが返されます。


TCustomEdit.SelStart
TCustomEdit.SelStart3094015

TCustomEdit	参照

SelStart プロパティは，テキスト選択の先頭文字の位置です。

property SelStart: Integer;

説明

SelStart プロパティは，範囲選択されている文字列の開始位置を調べます。編集コントロールの先頭位置は 0 です。選択されているテキストがない場合，SelStart はカーソル位置を示します。SelStart を設定すると現在の選択範囲はクリアされ，指定した文字の直前にカーソルを置くことができます。

特定の範囲のテキストを選択するには，まず SelStart を設定してカーソル位置を決め，SelLength を使って選択範囲を指定します。


TCustomEdit.SelText
TCustomEdit.SelText3094016

TCustomEdit	参照

SelText プロパティは，編集コントロールのテキストの選択部分です。

property SelText: string;

説明

SelText プロパティは,現在選択されているテキストです。SelText を設定すると選択したテキストを新しいテキストで置き換えることができます。範囲選択されていない編集コントロールに SelText を設定すると，カーソル位置に新しい文字列を挿入できます。


TCustomEdit イベント3094017

TCustomEdit	アルファベット順	凡例

TCustomEdit

OnChange


TCustomEdit イベント3094018

TCustomEdit	オブジェクト順	凡例

OnChange


TCustomEdit.OnChange
TCustomEdit.OnChange3094019

TCustomEdit	参照

OnChange イベントは，編集コントロールのテキストに変更が加えられたときに発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラは，編集コントロールのテキストが変更されたときに指定された動作をします。実際に変更が行われたかを知るには Modified プロパティを使います。このイベントが発生した時点で編集コントロールの Text プロパティはすでに更新されています。このイベントを使用して，編集コントロールにユーザーが入力した変更に反応することができます。


TCustomEdit メソッド3094020

TCustomEdit	アルファベット順	凡例

TCustomEdit

Change

Clear

ClearSelection

CopyToClipboard

Create

CreateParams

CreateWnd

CutToClipboard

DestroyWnd

DoSetMaxLength

GetSelLength

GetSelStart

GetSelText

GetSelTextBuf

PasteFromClipboard

SelectAll

SetSelLength

SetSelStart

SetSelTextBuf

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomEdit メソッド3094021

TCustomEdit	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

Change

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClearSelection

ClientToScreen

ContainsControl

ControlAtPos

CopyToClipboard

Create

CreateParams

CreateParented

CreateWnd

CutToClipboard

DefaultHandler

Destroy

DestroyComponents

Destroying

DestroyWnd

DisableAlign

Dispatch

DoSetMaxLength

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetSelLength

GetSelStart

GetSelText

GetSelTextBuf

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

PasteFromClipboard

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetSelLength

SetSelStart

SetSelTextBuf

SetTextBuf

Show

Update

UpdateControlState


TCustomEdit.Change
TCustomEdit.Change3094022

TCustomEdit	参照

Change メソッドは，Text プロパティへの変更に反応して OnChange イベントハンドラが割り当てられていればそれを呼び出します。

procedure Change; dynamic;

説明

アプリケーションから Change メソッドを直接呼び出してはいけません。Change メソッドは Windows イベントによって自動的に呼び出されます。Text プロパティが変更されたときに OnChange イベントハンドラを呼び出す以外の反応を派生クラスが実行できるように Change は Protected メソッドとして定義されています。Change メソッドをオーバーライドする派生クラスは，必ず派生メソッドを呼び出さねばなりません。


TCustomEdit.Clear
TCustomEdit.Clear3094023

TCustomEdit	参照

Clear メソッドは，編集コントロールからテキストをすべて削除します。

procedure Clear; virtual;

説明

Clear は Text プロパティを空の文字列と置き換えます。Clear は選択されたテキストだけでなく，すべてのテキストを削除します。選択されているテキストのみを削除するには ClearSelection を使います。


TCustomEdit.ClearSelection
TCustomEdit.ClearSelection3094024

TCustomEdit	参照

ClearSelection メソッドは，選択されたテキストを編集コントロールから削除します。

procedure ClearSelection;

説明

ClearSelection を呼び出すと選択されたテキストを編集コントロールから削除できます。テキストが選択されていなければ，ClearSelection は何もしません。テキストすべてが選択されている場合，ClearSelection は Clear メソッドと同様にすべてのテキストを削除します。

注意

ClearSelection の呼び出しは編集コントロールに WM_CLEAR メッセージを送るのと同じ動作をします。


TCustomEdit.CopyToClipboard
TCustomEdit.CopyToClipboard3094025

TCustomEdit	参照

CopyToClipboard メソッドは，編集コントロールの選択されたテキストをクリップボードに CF_TEXT のフォーマットでコピーします。

procedure CopyToClipboard;

説明

CopyToClipboard を呼び出すと選択したテキストでクリップボードの内容を置き換えることができます。テキストが選択されていない場合 CopyToClipbard はクリップボードの内容を消去せず，何もしません。

注意

CopyToClipboard の呼び出しは編集コントロールに WM_COPY メッセージを送るのと同じ動作をします。


TCustomEdit.Create
TCustomEdit.Create3094026

TCustomEdit	参照

Create メソッドは，TCustomEdit のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出して TCustomEdit のインスタンスを初期化します。

継承されたコンストラクタを呼び出した後で，TCustomEdit は次の初期化をします。

・	AutoSelect は True

・	AutoSize は True

・	BorderStyle は bsSingle

・	ControlStyle は [csClickEvents, csDoubleClicks, csFixedHeight, csSetCaption]

・	Height および Width はそれぞれ 25 と 121

・	HideSelection は True

・	ParentColor は False

・	TabStop は True

Create メソッドをオーバーライドする派生オブジェクトはさらに初期化をする前に継承された Create を呼び出さなければなりません。


TCustomEdit.CreateParams
TCustomEdit.CreateParams3094027

TCustomEdit	参照

CreateParams メソッドは，Params パラメータで渡されるウィンドウ作成パラメータレコードを初期化します。

type

  TCreateParams = record

    Caption: PChar;

    Style: Longint;

    ExStyle: Longint;

    X, Y: Integer;

    Width, Height: Integer;

    WndParent: HWND;

    Param: Pointer

    WindowClass: TWndClass;

    WinClassName: array[0..63] of Char;

  end;

procedure CreateParams(var Params: TCreateParams); override;

説明

CreateWnd メソッドは CreateParams を呼び出して CreateWindowHandle に渡すパラメータを初期化します。TCustomEdit は BorderStyle，HideSelections，PasswordChar，および ReadOnly の各プロパティの現在の値を反映するスクロール可能な単一行の編集コントロールを指定する継承されたメソッドをオーバーライドします。


TCustomEdit.CreateWnd
TCustomEdit.CreateWnd3094028

TCustomEdit	参照

CreateWnd メソッドは，編集コントロールに対応する Windows コントロールを作成します。

procedure CreateWnd; override;

説明

CreateWnd メソッドは編集コントロールが作成されたときと，編集コントロールへの変更によってウィンドウの再作成が必要な場合に呼び出されます。継承されたメソッドを呼び出した後で，CreateWnd は 新しく作成されたウィンドウメッセージを送って MaxLength および PasswordChar プロパティを補います。


TCustomEdit.CutToClipboard
TCustomEdit.CutToClipboard3094029

TCustomEdit	参照

CutToClipboard メソッドは，編集コントロールで選択されたテキストを CF_TEXT フォーマットでクリップボードにコピーしてから選択範囲を削除します。

procedure CutToClipboard;

説明

CutToClipboard は選択されているテキストでクリップボードの内容を置き換え，選択したテキストを消去します。テキストが選択されていなければ CutToClipboard は何もしません。


TCustomEdit.DestroyWnd
TCustomEdit.DestroyWnd3094030

TCustomEdit	参照

DestroyWnd メソッドは，編集コントロールに対応する Windows コントロールを破棄します。

procedure DestroyWnd; override;

説明

ウィンドウを破棄する前に，DestroyWnd は破棄したウィンドウの再作成に必要なプロパティをすべてコピーとして保存します。


TCustomEdit.DoSetMaxLength
TCustomEdit.DoSetMaxLength3094031

TCustomEdit	参照

DoSetMaxLength メソッドは，MaxLength プロパティを設定します。

procedure DoSetMaxLength(Value: Integer); virtual;

説明

DoSetMaxLength メソッドは MaxLength プロパティにアクセスする関数です。DoSetMaxLength は Protected メソッドとして定義されているので，TCustomEdit の下位オブジェクトは MaxLength プロパティの実現方法をカスタマイズできます。

DoSetMaxLength は編集コントロールのウィンドウに EM_LIMITTEXT メッセージを送ります。


TCustomEdit.GetSelLength
TCustomEdit.GetSelLength3094032

TCustomEdit	参照

GetSelLength メソッドは，SelLength プロパティを返します。

function GetSelLength: Integer; virtual;

説明

GetSelLength メソッドは SelLength プロパティにアクセスする関数です。GetSelLength は Protected メソッドとして定義されているので，TCustomEdit の派生オブジェクトは SelLength プロパティの実装をカスタマイズできます。

GetSelLength は編集コントロールのウィンドウに EM_GETSEL メッセージを送り，開始位置と終了位置の間の長さを返します。


TCustomEdit.GetSelStart
TCustomEdit.GetSelStart3094033

TCustomEdit	参照

GetSelStart メソッドは，SelStart プロパティを返します。

function GetSelStart: Integer; virtual;

説明

GetSelStart メソッドは SelStart プロパティにアクセスするメソッドです。GetSelStart は Protected メソッドとして定義されているので，TCustomEdit の派生オブジェクトは SelStart プロパティの実装をカスタマイズできます。

GetSelLength は編集コントロールのウィンドウに EM_GETSEL メッセージを送り，開始位置を返します。


TCustomEdit.GetSelText
TCustomEdit.GetSelText3094034

TCustomEdit	参照

GetSelText メソッドは，SelText プロパティを返します。

function GetSelText: string; virtual;

説明

GetSelText は SelText プロパティにアクセスするメソッドです。GetSelText は Protected メソッドとして定義されているので，TCustomEdit の派生オブジェクトは SelText プロパティの実装をカスタマイズできます。


TCustomEdit.GetSelTextBuf
TCustomEdit.GetSelTextBuf3094035

TCustomEdit	参照

GetSelTextBuf メソッドは，選択されたテキストをバッファにコピーしてからその文字数を返します。

function GetSelTextBuf(Buffer: PChar; BufSize: Integer): Integer; virtual;

説明

GetSelTextBuf メソッドは，選択されたテキストを文字バッファへコピーできます。選択範囲がなければ，バッファは空の文字列を受け取ります。選択に（BufSize - 1）より多く文字がある場合は，最初の（BufSize - 1）バイト分のみがコピーされます。GetSelTextBuf は実際にバッファにコピーされたバイト数を返します。


TCustomEdit.PasteFromClipboard
TCustomEdit.PasteFromClipboard3094036

TCustomEdit	参照

PasteFromClipboard メソッドは，クリップボードの内容を編集コントロールにコピーして，現在の選択範囲を置き換えます。

procedure PasteFromClipboard;

説明

PasteFromClipboard メソッドは，選択されているテキストをクリップボードの内容で置き換えるか，テキストが選択されていなければ，クリップボードの内容をカーソル位置に挿入します。クリップボードが空の場合，またはクリップボードに CF_TEXT のフォーマットのデータがない場合は，PasteFromClipbard は何もしません。

注意

PasteFromClipboard の呼び出しは，編集コントロールに WM_PASTE メッセージを送るのと同じ動作をします。


TCustomEdit.SelectAll
TCustomEdit.SelectAll3094037

TCustomEdit	参照

SelectAll メソッドは，編集コントロール中のテキストをすべて選択します。

procedure SelectAll;

説明

SelectAll メソッドは編集コントロールのテキストをすべて選択します。一部のテキストのみを選択するには SelStart および SelLength プロパティを使います。


TCustomEdit.SetSelLength
TCustomEdit.SetSelLength3094038

TCustomEdit	参照

SetSelLength メソッドは，SelLength プロパティを設定します。

procedure SetSelLength(Value: Integer); virtual;

説明

SetSelLength メソッドは SelLength プロパティにアクセスするメソッドです。SetSelLength は Protected メソッドとして定義されているので，TCustomEdit の派生オブジェクトは SelLength プロパティの実装をカスタマイズできます。

SetSelLength は編集コントロールのウィンドウに EM_SETSEL メッセージを送り，SelStart で始まり SelStart + Value で終わる選択範囲を指定します。


TCustomEdit.SetSelStart
TCustomEdit.SetSelStart3094039

TCustomEdit	参照

SetSelStart メソッドは，SelStart プロパティを返します。

procedure SetSelStart(Value: Integer); virtual;

説明

SetSelStart メソッドは SelStart プロパティにアクセスするメソッドです。SetSelStart は Protected メソッドとして定義されているので，TCustomEdit の派生オブジェクトは SelStart プロパティの実装をカスタマイズできます。

SetSelLength は編集コントロールのウィンドウに EM_SETSEL メッセージを送り，Value で指定される位置にカーソルを移動します。


TCustomEdit.SetSelTextBuf
TCustomEdit.SetSelTextBuf3094040

TCustomEdit	参照

SetSelTextBuf メソッドは，選択されているテキストをヌルで終わる文字列で置き換えます。

procedure SetSelTextBuf(Buffer: PChar);

説明

SetSelTextBuf メソッドは現在の選択範囲を Buffer が指すヌルで終わる文字列で置き換えます。テキストが選択されていなければ，Buffer の内容がカーソル位置に挿入されます。SetSelTextBuf は SelText プロパティと同様の機能を持ちますが，引数には文字列ではなく PChar をとる点が異なります。


スコープ3094041

protected

published

読み出し／書き込み

読み出し専用


スコープ3094042

protected


スコープ3094043

protected


継承3094044

TObject

TPersistent

TComponent

TControl

TWinControl


TCustomEdit 例3094045

TCustomEdit


TCustomForm
TCustomForm3095001

継承	プロパティ	メソッド	イベント	参照

TCustomForm コンポーネントはアプリケーションフォームの派生元となる抽象基本クラスです。

ユニット

forms

説明

カスタムウィンドウを作成するには，TCustomForm から派生させます。TCustomForm の派生オブジェクトには，TButton，TCheckBox，TComboBox オブジェクトなど，他のオブジェクトを入れることができます。


TCustomForm プロパティ3095002

TCustomForm	アルファベット順	凡例

TCustomForm

Active

ActiveControl

ActiveMDIChild

ActiveOleControl

BorderIcons

BorderStyle

Canvas

ClientHandle

ClientHeight

ClientRect

ClientWidth

Designer

DropTarget

FormStyle

HelpFile

Icon

KeyPreview

MDIChildCount

MDIChildren

Menu

ModalResult

ObjectMenuItem

OleFormObject

Parent

PixelsPerInch

Position

PrintScale

Scaled

TileMode

Visible

WindowMenu

WindowState

TScrollingWinControl からの継承

AutoScroll

HorzScrollBar

VertScrollBar

TWinControl からの継承

Brush

ClientOrigin

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

Color

ControlState

ControlStyle

Cursor

Enabled

Font

Height

Hint

Left

Name

ParentFont

PopupMenu

ShowHint

Top

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomForm プロパティ3095003

TCustomForm	オブジェクト順	凡例

Active

ActiveControl

ActiveMDIChild

ActiveOleControl

Align

AutoScroll

BorderIcons

BorderStyle

BoundsRect

Brush

Canvas

Caption

ClientHandle

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

Designer

DesignInfo

DropTarget

Enabled

Font

FormStyle

Handle

Height

HelpContext

HelpFile

Hint

HorzScrollBar

Icon

KeyPreview

Left

MDIChildCount

MDIChildren

Menu

ModalResult

Name

ObjectMenuItem

OleFormObject

Owner

Parent

ParentFont

ParentWindow

PixelsPerInch

PopupMenu

Position

PrintScale

Scaled

ShowHint

Showing

TabOrder

TabStop

Tag

TileMode

Top

VCLComObject

VertScrollBar

Visible

Width

WindowMenu

WindowProc

WindowState


TCustomForm.Active
TCustomForm.Active3095004

TCustomForm	参照

Active プロパティは，フォームにフォーカスがあるかどうかを示します。

property Active: Boolean;

説明

Active プロパティは，フォームにフォーカスがあるかどうかを判定できます。

Active が True ならば，フォームにフォーカスがあります。Active が False ならば，フォームにフォーカスがありません。


TCustomForm.ActiveControl
TCustomForm.ActiveControl3095005

TCustomForm	参照

ActiveControl プロパティは，フォーム上でフォーカスがあるコントロールを示します。

property ActiveControl: TWinControl;

説明

ActiveControl プロパティは，フォーム上でフォーカスがあるコントロールを取得または設定できます。

フォームにフォーカスがない場合は，フォームがフォーカスを受け取ったときにフォーカスを受け取ることになるフォーム上のコントロールを示します。

注意

フォーカスが別のコントロールに移ると，OnExit イベントが発生する前に ActiveControl の値が更新されます。

アプリケーション内で一度にフォーカスを持つことのできるのは 1 つのコントロールだけです。


TCustomForm.ActiveMDIChild
TCustomForm.ActiveMDIChild3095006

TCustomForm	参照

ActiveMDIChild プロパティは，フォーカスがある MDI 子フォームを示します。

property ActiveMDIChild: TForm;

説明

ActiveMDIChild プロパティは，フォーカスを持つ MDI 子フォームを取得できます。

フォームが MDI 親フォームでない，つまり，フォームの FormStyle プロパティが fsMDIForm でない場合，ActiveMDIChild は nil を返します。


TCustomForm.ActiveOleControl
TCustomForm.ActiveOleControl3095007

TCustomForm	参照

ActiveOLEControl プロパティは，フォーム上のフォーカスの変更に応答する OLE コントロールを示します。

property ActiveOLEControl: TWinControl;

説明

ActiveOLEControl プロパティは，フォーム上のフォーカスの変更に応答する OLE コントロールを取得または設定できます。

ActiveOLEControl が nil でない場合，指定した OLE コントロールのユーザーインタフェースは，フォーカスがないときは非アクティブ化されます。また，フォームがフォーカスを受け取ったり失ったりすると，指定した OLE コントロールのドキュメントウィンドウがそれぞれアクティブ化，非アクティブ化されます。


TCustomForm.BorderIcons
TCustomForm.BorderIcons3095008

TCustomForm	参照

BorderIcons プロパティは，フォームのタイトルバーに表示するアイコンを指定します。

property BorderIcons: TBorderIcons;

説明

BorderIcons プロパティは，フォームのタイトルバーに表示するアイコンを取得または設定できます。BorderIcons には，次の TBorderIcons 値を指定できます。

値	意味

biSystemMenu	コントロールメニュー（システムメニューともいう）をフォームに表示する

biMinimize	アイコン化ボタンをフォームに表示する

biMaximize	最大表示ボタンをフォームに表示する

biHelp	BorderStyle が bsDialog の場合，または biMinimize と biMaximize が除外された場合，フォームのタイトルバーには疑問符が表示され，クリックするとカーソルが crHelp に変更される。そうでない場合は非表示になる

BorderIcons プロパティと BorderStyle プロパティと組み合わせの一部は互いに排他的です。たとえば，BorderIcons で biMax，biMin  を指定し，BorderStyle で bsDialog を指定することはできません。


TCustomForm.BorderStyle
TCustomForm.BorderStyle3095009

TCustomForm	参照

BorderStyle プロパティは，フォーム境界の体裁と動作を指定します。

property BorderStyle: TFormBorderStyle;

説明

BorderStyle プロパティは，フォーム境界の体裁と動作を取得または設定できます。BorderStyle には，次の TFormBorderStyle 値を指定できます。

値	意味

bsDialog	サイズ変更不可; 標準のダイアログボックス境界

bsSingle	サイズ変更不可; 一重境界線

bsNone	サイズ変更不可; 可視境界線なし

bsSizeable	標準のサイズ変更可能境界

bsToolWindow	bsSingle と同じだがキャプションが小さい

bsSizeToolWin	bsSizeable と同じだがキャプションが小さい

注意

MDI 子フォームの境界スタイルを bsDialog または bsNone に変更しても無効です。


TCustomForm.Canvas
TCustomForm.Canvas3095010

TCustomForm	参照

Canvas プロパティは，アプリケーションの描画領域です。

property Canvas: TCanvas;

説明

Canvas プロパティで，アプリケーションの描画領域を取得できます。


TCustomForm.ClientHandle
TCustomForm.ClientHandle3095011

TCustomForm	参照

ClientHandle プロパティは，フォームの MDI の内部クライアントウィンドウのハンドル（HWND）です。

property ClientHandle: HWND;

説明

ClientHandle プロパティは，フォームの MDI の内部クライアントウィンドウのハンドルを取得します。

ClientHandle プロパティが有効なのは FormStyle プロパティが fsMDIForm に設定されている MDI 親フォームだけです。


TCustomForm.ClientHeight
TCustomForm.ClientHeight3095012

TCustomForm	参照

ClientHeight プロパティは，フォーム上のクライアント領域の高さをピクセル数で指定します。

property ClientHeight: Integer;

説明

ClientHeight プロパティは，フォーム上のクライアント領域の高さをピクセル数で取得または設定できます。クライアント領域はフォームの境界の内側の使用可能領域です。


TCustomForm.ClientWidth
TCustomForm.ClientWidth3095014

TCustomForm	参照

ClientWidth プロパティは，フォーム上のクライアント領域の幅をピクセル数で指定します。

property ClientWidth: Integer;

説明

ClientWidth プロパティは，フォーム上のクライアント領域の幅をピクセル数で取得または設定できます。クライアント領域はフォームの境界の内側の使用可能領域です。


TCustomForm.Designer
TCustomForm.Designer3095015

TCustomForm	参照

Designer プロパティは，フォームのデザイナです。

property Designer: TDesigner;

説明

Designer プロパティはフォームデザイナによって内部的に使われます。このプロパティには値を指定しないでください。値の指定はフォームデザイナによって自動的に行われます。このプロパティを使うことが必要になるのは，プロパティエディタやコンポーネントエディタなど，フォームデザイナでの使用のために一部のクラスを設計する場合だけです。


TCustomForm.DropTarget
TCustomForm.DropTarget3095016

TCustomForm	参照

DropTarget プロパティは，フォームがドラッグアンドドロップ操作のターゲットであるかどうかを論理値で指定します。

property DropTarget: Boolean;

説明

DropTarget プロパティは，フォームがドラッグアンドドロップ操作のターゲットであるかどうかを取得または設定できます。


TCustomForm.FormStyle
TCustomForm.FormStyle3095017

TCustomForm	参照

FormStyle プロパティは，フォームのスタイルを指定します。

property FormStyle: TFormStyle;

説明

FormStyle プロパティは，フォームのスタイルを取得または設定できます。FormStyle には，次の TFormStyle 値を組み合わせて指定できます。

値	意味

fsNormal	フォームは MDI 親ウィンドウでも MDI 子ウィンドウでもない

fsMDIChild	フォームは MDI 子ウィンドウである

fsMDIForm	フォームは MDI 親ウィンドウである

fsStayOnTop	このフォームは，デスクトップの一番上，およびプロジェクトの他のフォーム（FormStyle が fsStayOnTop に設定されているフォームを除いた他のフォーム）の上にくる

注意

実行時に FormStyle の値を変更することはお勧めできません。

フォームが MDI アプリケーションのメインフォームの場合，FormStyle プロパティを fsMDIForm に設定しなければなりません。


TCustomForm.HelpFile
TCustomForm.HelpFile3095018

TCustomForm	参照

HelpFile プロパティは，アプリケーションがヘルプを表示するのに使うファイルの名前を指定します。

property HelpFile: string;

説明

HelpFile プロパティは Windows ヘルプシステムで使うヘルプファイルを持つフォームで使います。Windows は HelpFile プロパティで指定したファイルを表示します。


TCustomForm.Icon
TCustomForm.Icon3095019

TCustomForm

Icon プロパティは，フォームを最小化したときに表示されるアイコンを示します。

property Icon: TIcon;

説明

Icon プロパティは，フォーム用のアイコンを提供します。Icon プロパティが設定されていないと，Windows は，フォームが最小化されたときに，デフォルトのアイコンを提供します。


TCustomForm.KeyPreview
TCustomForm.KeyPreview3095020

TCustomForm	参照

KeyPreview プロパティは，キーボードイベントがアクティブコントロールで発生する前にフォームで発生するかどうかを論理値で指定します。

property KeyPreview: Boolean;

説明

KeyPreview プロパティが True の場合，キーボードイベントはアクティブコントロール（ActiveControl プロパティで指定）で発生する前にフォームで発生します。

Tab，BackTab，矢印キーなどの移動キーはキーボードイベントを発生させないので KeyPreview は無効です。

KeyPreview が False の場合，キーボードイベントはアクティブコントロールで発生します。

KeyPreview のデフォルト値は False です。


TCustomForm.MDIChildCount
TCustomForm.MDIChildCount3095021

TCustomForm	参照

MDIChildCount プロパティは，開いている MDI 子フォームの数を示します。

property MDIChildCount: Integer;

説明

MDIChildCount プロパティは，開いている MDI 子フォームの数を取得できます。

MDIChildCount プロパティが有効なのは FormStyle プロパティが fsMDIForm に設定されている MDI 親フォームだけです。


TCustomForm.MDIChildren
TCustomForm.MDIChildren3095022

TCustomForm	参照

MDIChildren プロパティは，MDI 子フォームの配列です。

property MDIChildren[I: Integer]: TForm;

説明

MDIChildren プロパティは，子フォームにアクセスできます。

I パラメータはアクセスする子フォームのインデックスを指定します。一番最後に作成した MDI 子フォームのインデックス番号が常に 0 になり，一番最初に作成した MDI 子フォームのインデックス番号が常に MDIChildCount - 1 になります。MDIChildren 配列の順序はMDI 子フォーム作成順序の逆になります。

MDIChildren プロパティが有効なのは FormStyle プロパティが fsMDIForm に設定されている MDI 親フォームだけです。


TCustomForm.Menu
TCustomForm.Menu3095023

TCustomForm	参照

Menu プロパティは，フォームのメインメニューです。

property Menu: TMainMenu;

説明

Menu プロパティは，フォームのメインメニューを取得または設定できます。

Menu は，設計時に最初にフォームに追加された TMainMenu コンポーネントに設定されます。


TCustomForm.ModalResult
TCustomForm.ModalResult3095024

TCustomForm	参照

ModalResult プロパティは，モード付きで表示されているフォームを閉じた時の値を示します（0 以外の値の場合）。

property ModalResult: TModalResult;

説明

ModalResult プロパティは，モード付きで表示されているフォームを閉じることができます。

ModalResult のデフォルト値は 0 です。ModalResult を 0 以外の値に設定すると，モード付きフォームを閉じることができます。ModalResult に割り当てた値はモード付きフォームを表示するのに使った ShowModal 関数呼び出しの戻り値になります。このプロパティは TButton オブジェクトなど，一部のコンポーネントによって自動的に変更されます。詳細は，「TButton.ModalResult」を参照してください。

ModalResult には次の TModalResult 値を指定できます。

定数	値

mrNone	0

mrOk	idOK

mrCancel	idCancel

mrAbort	idAbort

mrRetry	idRetry

mrIgnore	idIgnore

mrYes	idYes

mrNo	idNo

mrAll	mrNo + 1


TCustomForm.ObjectMenuItem
TCustomForm.ObjectMenuItem3095025

TCustomForm	参照

ObjectMenuItem プロパティは，OLE オブジェクトの選択に応答する OLE オブジェクトメニュー項目です。

property ObjectMenuItem: TMenuItem;

説明

ObjectMenuItem プロパティは，フォーム上の OLE オブジェクトを選択または選択解除したときにそれぞれ有効または無効になるメニュー項目を取得または設定できます。

OLE オブジェクトメニュー項目は，Activate，Convert などの標準 OLE コマンドのかわりとして使用できます。それらのコマンドは OLE サーバーによって実現されます。


TCustomForm.OleFormObject
TCustomForm.OleFormObject3095026

TCustomForm	参照

OleFormObject プロパティは，フォームがインプレース OLE オブジェクトのフレームであることを示します。

property OleFormObject: TOleFormObject;

説明

OleFormObject プロパティは，フォームがインプレース OLE オブジェクトのフレームとして使われているときに，サイズ変更および破棄通知をやり取りするのに使います。


TCustomForm.PixelsPerInch
TCustomForm.PixelsPerInch3095028

TCustomForm	参照

PixelsPerInch プロパティは，フォーム設計時に使われたシステムのシステムフォントの比率を示す値です。

property PixelsPerInch: Integer;

説明

PixelsPerInch プロパティを実行時に使うと，現在の画面解像度に対するフォームのスケーリングを変更できます。PixelsPerInch のデフォルト値を変更すると，どの画面解像度でもフォームが同じ比率になるようにはならなくなります。

PixelsPerInch は，設計時にフォームを保存するときに自動的に設定されます。オブジェクトインスペクタを使って PixelsPerInch 値を変更できますが，結果はアプリケーションを実行するまで見られません。

フォームの Scaled プロパティも True に設定しなくてはならず，そうしないと PixelsPerInch 値を変更しても効果がありません。


TCustomForm.Position
TCustomForm.Position3095029

TCustomForm	参照

Position プロパティは，フォームのサイズと配置を表す値です。

property Position: TPosition;

説明

Position プロパティは，フォームのサイズと配置を取得または設定できます。Position には，次の TPosition 値を指定できます。

値	意味

poDesigned	フォームは設計時と同じ画面上の位置，高さ，幅で表示される

poDefault	フォームは Windows が決める画面上の位置，高さ，幅で表示される。フォームはアプリケーションを複数起動するたびに少しずつ右下へ移動する。画面の解像度に関係なくフォームの右側は常に画面の右端に近く，フォームの下端は常に画面の下端に近くなる

poDefaultPosOnly	フォームは設計時にフォームを作成したサイズで表示されるが，画面上の位置は Windows が選択する。フォームはアプリケーションを複数起動するたびに少しずつ右下へ移動する。同じサイズのまま全体が画面上に表示されるようにフォームをそれ以上右下へ移動できなくなると，画面の左上隅にフォームが表示される

poDefaultSizeOnly	フォームは設計時の位置に表示されるが，サイズは Windows が選択する。画面の解像度に関係なくフォームの右側は常に画面の右端に近く，フォームの下端は常に画面の下端に近くなる

poScreenCenter	フォームは設計時のサイズで表示されるが，画面の中央に配置される


TCustomForm.PrintScale
TCustomForm.PrintScale3095030

TCustomForm	参照

PrintScale プロパティは，フォームの印刷時の比率を示します。

property PrintScale: TPrintScale;

説明

PrintScale プロパティは，フォームの印刷時の比率を取得または設定できます。PrintScale には次の TPrintScale 値を指定できます。

値	意味

poNone	画面に表示されたフォームをプリンタの解像度で印刷する

poProportional	フォームは画面上のサイズと同じサイズになるように印刷される（WYSIWYG）。フォームイメージは，印刷されるイメージが画面上に見えるサイズと同じになるように拡大/縮小される

poPrintToFit	フォームは同じ画面比率を使うが，印刷ページにちょうど収まるサイズで印刷される


TCustomForm.Scaled
TCustomForm.Scaled3095031

TCustomForm	参照

Scaled プロパティは，フォームサイズを PixelsPerInch プロパティの値に基づいて変更するかどうかを決める論理値です。

property Scaled: Boolean;

説明

Scaled プロパティが True で PixelsPerInch の値が現在のシステム設定と異なる場合，フォームは新しいサイズにスケール変更されます。Scaled が False の場合は，スケール変更はされません。


TCustomForm.TileMode
TCustomForm.TileMode3095032

TCustomForm	参照

TileMode プロパティは，Tile メソッドが呼び出されたときに MDI 子フォームがどのように配列されるかを決める値です。

property TileMode: TTileMode;

説明

TileMode には次の TTileMode 値を指定できます。

値	意味

tbHorizontal	各フォームは親フォームの幅の方向に広がる

tbVertical	各フォームは親フォームの高さの方向に広がる

TileMode プロパティが有効なのは FormStyle プロパティが fsMDIChild に設定されている MDI 子フォームだけです。


TCustomForm.Visible
TCustomForm.Visible3095033

TCustomForm	参照

Visible プロパティは，フォームを画面上に表示するかどうかを決める論理値です。

property Visible: Boolean;

説明

Visible プロパティは，フォームが画面上に表示されるかどうかを取得または設定できます。

Visible が True ならば，フォームが表示されます（他のフォームに隠れていない場合）。Visible が False ならば，フォームは表示されません。

Show または ShowModal メソッドを呼び出すと，Visible を True に設定してフォームを他のフォームの前面に表示できます。


TCustomForm.WindowMenu
TCustomForm.WindowMenu3095034

TCustomForm	参照

WindowMenu プロパティは，MDI 親フォームの［ウィンドウ(W)］メニューです。

property WindowMenu: TMenuItem;

説明

WindowMenu プロパティは，MDI 親フォームの［ウィンドウ(W)］メニューを取得または設定できます。［ウィンドウ(W)］メニューは MDI アプリケーションでの標準メニューです。［ウィンドウ(W)］メニューには，［重ねて表示(C)］，［アイコンの整列(A)］，［並べて表示(T)］など，ユーザーがアプリケーションのウィンドウを管理できるようにするコマンドがあります。

また，［ウィンドウ(W)］メニューの下部にはアプリケーションで現在開いている子ウィンドウが示されます。ユーザーがメニューからウィンドウの 1 つを選択すると，選択したウィンドウがアプリケーションでのアクティブウィンドウになります。

このメニューは一般に［ウィンドウ(W)］メニューと呼ばれますが，どのような名前にもできます。ただし，その名前はメニューバーに表示される既存のメニュー項目のどれかでなくてはなりません。開いている子フォームの名前は，実行時に自動的にそのメニューに入ります。

WindowMenu プロパティが有効なのは FormStyle プロパティが fsMDIForm に設定されている MDI 親フォームだけです。


TCustomForm.WindowState
TCustomForm.WindowState3095035

TCustomForm	参照

WindowState プロパティは，画面へのフォームの表示のしかたを表す値です。

property WindowState: TWindowState;

説明

WindowState プロパティは，フォームをアイコン化して表示するか，最大化して表示するか，通常の状態で表示するかを取得または設定できます。

WindowStateには次の TWindowState 値を指定できます。

値	意味

wsNormal	フォームは最大化もアイコン化もされない状態で表示される

wsMinimized	フォームはアイコン化される

wsMaximized	フォームは最大化される


TCustomForm イベント3095036

TCustomForm	アルファベット順	凡例

TCustomForm

OnActivate

OnClose

OnCloseQuery

OnCreate

OnDeactivate

OnDestroy

OnHelp

OnHide

OnPaint

OnResize

OnShow

TWinControl からの継承

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnMouseDown

OnMouseMove

OnMouseUp


TCustomForm イベント3095037

TCustomForm	オブジェクト順	凡例

OnActivate

OnClick

OnClose

OnCloseQuery

OnCreate

OnDblClick

OnDeactivate

OnDestroy

OnDragDrop

OnDragOver

OnHelp

OnHide

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnPaint

OnResize

OnShow


TCustomForm.OnActivate
TCustomForm.OnActivate3095038

TCustomForm	参照

フォームの OnActivate イベントは，フォームがアクティブになったときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnActivate: TNotifyEvent;

説明

OnActivate イベントハンドラを記述すると，フォームがフォーカスを受け取ったときに特別な処理が実行されるようにすることができます。フォームはフォーカスがきたとき（たとえばユーザーがそのフォームをクリックしたとき）にアクティブになります。

MDI 子ウィンドウ（FormStyle プロパティの値が fsMDIChild のフォーム）の場合，OnActivate はフォーカスが子から別の子に移ったときにだけ発生します。フォーカスが非 MDI 子ウィンドウから MDI 子ウィンドウに移った場合，MDI 親フォームについて OnActivate イベントが発生します。

注意

フォームでなくアプリケーション（TApplication）の OnActivate イベントは，Windows が制御を別のアプリケーションからそのアプリケーションへ切り替えたときに発生します。


TCustomForm.OnClose
TCustomForm.OnClose3095039

TCustomForm	参照

OnClose イベントは，フォームを閉じたときに発生します。

TCloseEvent = procedure(Sender: TObject; var Action: TCloseAction) of object;

property OnClose: TCloseEvent;

説明

OnClose イベントハンドラを記述すると，フォームを閉じたときに特別な処理が実行されるようにすることができます。OnClose イベントはフォームを閉じようとしたときに呼び出されるイベントハンドラを指定します。たとえば，データ入力フォームを閉じる前にフォーム内のすべての項目に有効な内容が入っているかどうかをテストするハンドラを OnClose で指定できます。

フォームは Close メソッドによって，またはユーザーがフォームのシステムメニューで［閉じる(C)］を選択したときに閉じます。

TCloseEvent は，フォームを閉じようとしたときに発生するイベントで呼び出されるメソッドへのポインタです。Action パラメータの値はフォームを実際に閉じるどうかを決めます。Action には次の値があります。

値	意味

caNone	フォームを閉じることができないので何も起きない

caHide	フォームは閉じないで単に隠される。アプリケーションは隠れたフォームに引き続きアクセスできる

caFree	フォームは閉じ，そのフォームに割り当てたすべてのメモリが解放される

caMinimize	フォームは閉じないでアイコン化される。MDI 子フォームの場合はこれがデフォルトである

フォームが MDI 子フォームで，BorderIcons プロパティが biMinimize ならば，Action のデフォルト値は caMinimize です。MDI 子フォームにこの設定がない場合は，Action のデフォルト値は，ユーザーがフォームを閉じようとする前に何も起きないことを示す caNone です。

フォームが SDI 子フォームならば，Action のデフォルト値は caHide です。

フォームを閉じて，OnClose イベントでフォームを解放するには，Action を caFree に設定します。

例

次のコードはユーザーがフォームを閉じようとしたときにメッセージダイアログボックスを表示します。ユーザーが［はい(Y)］ボタンをクリックすればフォームは閉じ，それ以外ではフォームは開いたまま残ります。

procedure TForm1.FormClose(Sender: TObject; var Action: TCloseAction);

begin

  if MessageDlg('Close application ?', mtConfirmation,

    [mbYes, mbNo], 0) = mrYes then

    Action := caFree

  else

    Action := caNone;

end;


TCustomForm.OnCloseQuery
TCustomForm.OnCloseQuery3095040

TCustomForm	参照

OnCloseQuery イベントは，フォームを閉じるアクションが起きるとき（Close メソッドが呼び出されたとき，またはユーザーがフォームのシステムメニューで［閉じる(C)］を選択したとき）に発生します。

TCloseQueryEvent = procedure(Sender: TObject; var CanClose: Boolean) of object;

property OnCloseQuery: TCloseQueryEvent;

説明

OnCloseQuery イベントハンドラを記述すると，どのような状態のときにフォームを閉じることができるかを指定できます。OnCloseQuery イベントハンドラにはフォームのクローズが可能かどうかを決める論理型変数 CanClose が入っています。この変数のデフォルト値は True です。

OnCloseQuery イベントハンドラを使うと，フォームをすぐに閉じるかどうかをユーザーに確認できます。たとえばこのハンドラを使って，フォームを閉じる前にファイルを保存するようユーザーに求めるメッセージボックスを表示できます。

TCloseQueryEvent は，フォームを閉じることが可能かどうかを決めるメソッドへのポインタの型です。CanClose パラメータの値によって，フォームを閉じることが可能かどうかが決まります。

例

次のコードでユーザーがフォームを閉じようとした場合，ユーザーにフォームを閉じてもよいかどうかを尋ねるメッセージダイアログが表示されます。ユーザーが［OK］ボタンを選択するとフォームは閉じます。ユーザーが［キャンセル］を選択するとフォームは閉じません。

procedure TForm1.FormCloseQuery(Sender: TObject; var CanClose: Boolean);

begin

  if MessageDlg('Close the form?', mtConfirmation,

    [mbOk, mbCancel], 0) = mrCancel then

     CanClose := False;

end;


TCustomForm.OnCreate
TCustomForm.OnCreate3095041

TCustomForm	参照

OnCreate イベントは，フォームを作成したときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnCreate: TNotifyEvent;

説明

OnCreate イベントハンドラを記述すると，フォームが作成され，TCustomForm のコンストラクタによって呼び出されたときに特別な処理を実行することができます。イベントハンドラを実装，あるいは TCustomForm のコンストラクタのオーバーライドのいずれかを行う必要がありますが，両方を行ってはなりません。OnCreate イベントで作成されたオブジェクトは OnDestroy イベントで解放する必要があります。

フォームが作成されるとき，Visible プロパティが True であればイベントが以下の順序で発生します。

・	OnCreate

・	OnShow

・	OnActivate

・	OnPaint


TCustomForm.OnDeactivate
TCustomForm.OnDeactivate3095042

TCustomForm	参照

OnDeactivate イベントは，フォームがフォーカスを失ったときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnDeactivate: TNotifyEvent;

説明

OnDeactivate イベントハンドラを記述すると，アクティブフォームが同じアプリケーション内の別のフォームに代わったときに特別な処理を実行することができます。別のアプリケーションがアクティブ化されたときは，このイベントは呼び出されません。別のアプリケーションがアクティブになっているかどうかを判定するには，TApplication オブジェクトの OnDeactivate イベントを使います。


TCustomForm.OnDestroy
TCustomForm.OnDestroy3095043

TCustomForm	参照

OnDestroy イベントは，フォームが破棄されたときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnDestroy: TNotifyEvent;

説明

OnDestroy イベントハンドラを記述すると，フォームが破棄されたときに特別な処理が実行されるようにすることができます。このイベントの実現と，クラスのデストラクタのオーバーライドのいずれかを行う必要がありますが，両方を行ってはなりません。このイベントは OnCreate イベントで作成されたすべてのオブジェクトを破棄します。


TCustomForm.OnHelp
TCustomForm.OnHelp3095044

TCustomForm	参照

OnHelp イベントは，フォームがヘルプ要求を受け取ったときに発生します。

THelpEvent = function (Command: Word; Data: Longint;   var CallHelp: Boolean): Boolean of      object;

property OnHelp: THelpEvent;

説明

OnHelp イベントハンドラを記述すると，ヘルプが要求されたときに特別な処理を実行することができます。


TCustomForm.OnHide
TCustomForm.OnHide3095045

TCustomForm	参照

OnHide イベントは，フォームが画面から隠されるとき（フォームの Visible プロパティが False に設定されたとき）に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnHide: TNotifyEvent;

説明

OnHide イベントハンドラを記述すると，フォームが画面から隠されるとき（フォームの Visible プロパティが False に設定されたとき）に特別な処理を実行することができます。


TCustomForm.OnPaint
TCustomForm.OnPaint3095046

TCustomForm	参照

OnPaint イベントは，フォームが再描画されたときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnPaint: TNotifyEvent;

説明

OnPaint イベントハンドラを記述すると，フォームが再描画されたときに特別な処理を実行することができます。フォームの特別なペイント処理にはこのイベントを使います。OnPaint イベントの外でフォームの Canvas プロパティを使った場合，OnPaint イベントによって消され，上書きされます。

例

次のコードは OnPaint イベントハンドラの中で背景ビットマップをメインフォームのキャンバス上にロードするユニットの例です。

unit Unit1;

interface

uses

  SysUtils, WinTypes, WinProcs, Messages, Classes, Graphics, Controls, Forms, Dialogs;

type

  TForm1 = class(TForm)

    procedure FormPaint(Sender: TObject);

    procedure FormCreate(Sender: TObject);

  private

    TheGraphic: TBitmap; { この宣言をグラフィック用に追加 }

  public

    { Public 宣言 }

  end;

var

  Form1: TForm1;

implementation

{$R *.DFM}

procedure TForm1.FormPaint(Sender: TObject); { OnPaint イベントハンドラ}

begin

  Form1.Canvas.Draw(0, 0, TheGraphic); { グラフィックをキャンバスに描画 }

end;

procedure TForm1.FormCreate(Sender: TObject); { OnCreate イベントハンドラ }

begin

  TheGraphic := TBitmap.Create; { ビットマップオブジェクトを作成 }

  TheGraphic.LoadFromFile('C:\APP\BKGRND.BMP'); { ビットマップをロード}

end;

end.


TCustomForm.OnResize
TCustomForm.OnResize3095047

TCustomForm	参照

OnResize イベントは，フォームをサイズ変更したときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnResize: TNotifyEvent;

説明

OnResize イベントハンドラを記述すると，フォームをサイズ変更したときに特別な処理を実行することができます。


TCustomForm.OnShow
TCustomForm.OnShow3095048

TCustomForm	参照

OnShow イベントは，フォームが表示されたとき（フォームの Visible プロパティが True に設定されたとき）に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnShow: TNotifyEvent;

説明

OnShow イベントハンドラを記述すると，フォームが表示されたとき（フォームの Visible プロパティが True に設定されたとき）に特別な処理を実行することができます。


TCustomForm メソッド3095049

TCustomForm	アルファベット順	凡例

TCustomForm

Activate

ActiveChanged

ChangeScale

Close

CloseQuery

Create

CreateNew

CreateParams

CreateWindowHandle

CreateWnd

Deactivate

DefaultHandler

DefineProperties

DefocusControl

Destroy

DestroyWindowHandle

DoHide

DoShow

FocusControl

GetChildren

GetClientRect

GetFormImage

Hide

Loaded

Notification

Paint

PaintWindow

PaletteChanged

Print

ReadState

Release

Resize

SendCancelMode

SetChildOrder

SetFocus

SetFocusedControl

SetParent

Show

ShowModal

ValidateRename

VisibleChanging

WantChildKey

WndProc

TScrollingWinControl からの継承

DisableAutoRange

EnableAutoRange

ScrollInView

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomForm メソッド3095050

TCustomForm	オブジェクト順	凡例

Activate

ActiveChanged

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ChangeScale

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Close

CloseQuery

ContainsControl

ControlAtPos

Create

CreateNew

CreateParams

CreateParented

CreateWindowHandle

CreateWnd

Deactivate

DefaultHandler

DefineProperties

DefocusControl

Destroy

DestroyComponents

Destroying

DestroyWindowHandle

DisableAlign

DisableAutoRange

Dispatch

DoHide

DoShow

DragDrop

Dragging

EnableAlign

EnableAutoRange

EndDrag

FieldAddress

FindComponent

FocusControl

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetChildren

GetClientRect

GetFormImage

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

Loaded

MethodAddress

MethodName

NewInstance

Notification

Paint

PaintTo

PaintWindow

PaletteChanged

Perform

Print

ReadState

Realign

Refresh

Release

RemoveComponent

RemoveControl

Repaint

Resize

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

ScrollInView

SendCancelMode

SendToBack

SetBounds

SetChildOrder

SetFocus

SetFocusedControl

SetParent

SetTextBuf

Show

ShowModal

Update

UpdateControlState

ValidateRename

VisibleChanging

WantChildKey

WndProc


TCustomForm.Activate
TCustomForm.Activate3095051

TCustomForm	参照

Activate メソッドは,

フォームコンポーネントの OnActivate イベント用の Protected メソッドです。

procedure Activate; dynamic;

説明

フォームコンポーネントは，CM_ACTIVATE メッセージを受け取ると Activate を呼び出します。CM_ACTIVATE メッセージは，アプリケーション内でアクティブウィンドウが変更されたため，またはアプリケーションがアクティブになったためにフォームにフォーカスが移ったときに送られます。

デフォルトの設定では，Activate メソッドはユーザーが OnActivate イベントにアタッチされたイベントハンドラを呼び出します。


TCustomForm.ActiveChanged
TCustomForm.ActiveChanged3095052

TCustomForm	参照

ActiveChanged メソッドは，フォーム上のアクティブコントロールが変更されたときに呼び出されます。

procedure ActiveChanged; dynamic;

説明

TCustomForm の下位オブジェクトでこのメソッドを実装すると，フォーム上のアクティブコントロールが変更されたときに特定のアクションを実行できます。


TCustomForm.ChangeScale
TCustomForm.ChangeScale3095053

TCustomForm	参照

ChangeScale メソッドは，コントロールの位置とサイズを M/D の割合で変更し，必要に応じてクライアント領域とフォントサイズを調整します。

procedure ChangeScale(M, D: Integer); override;

説明

ScaleBy メソッドはスケール変更を実行するために ChangeScale を呼び出します。TWinControl はコントロールをスケール変更する前に，そのコントロールの子コントロールをスケール変更するために ChangeScale をオーバーライドします。


TCustomForm.Close
TCustomForm.Close3095054

TCustomForm	参照

Close メソッドは，フォームを閉じます。

procedure Close;

説明

Close メソッドは，フォームを閉じることができます。

Close メソッドはフォームを閉じることができるかどうか判断するため最初に CloseQuery メソッドを呼び出します。CloseQuery が False ならばクローズ処理は強制終了します。CloseQuery が True ならば OnClose イベントが発生します。

注意

アプリケーションのメインフォームが閉じると，アプリケーションは終了します。


TCustomForm.CloseQuery
TCustomForm.CloseQuery3095055

TCustomForm	参照

CloseQuery メソッドは，フォームを閉じることができるかどうかを示す論理値を返します。

function CloseQuery: Boolean;

説明

CloseQuery メソッドは，フォームを閉じることができるかどうかを判定できます。フォームを閉じることができれば，CloseQuery は True を返します。できなければ，CloseQuery は False を返します。

MDI 親フォームの場合，CloseQuery は戻り値を判定するためにそのフォームの MDI 子フォームの CloseQuery メソッドを呼び出します。


TCustomForm.Create
TCustomForm.Create3095056

TCustomForm	参照

Create メソッドは，新しい TForm オブジェクトまたは TForm から派生したオブジェクトを作成し初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは，新しい TForm オブジェクトまたは TForm から派生したオブジェクトを作成および初期化できます。AOwner は TForm オブジェクトのオーナーです。

TForm から派生したオブジェクトの場合，Create は CreateNew メソッドを呼び出し，CreateNew に AOwner を渡してから初期化を実行します。


TCustomForm.CreateNew
TCustomForm.CreateNew3095057

TCustomForm	参照

CreateNew メソッドは，新しい TForm オブジェクトを作成し，初期化します。

constructor CreateNew(AOwner: TComponent); override;

説明

CreateNew メソッドは，新しい TForm オブジェクトを作成および初期化できます。

CreateNew は Create メソッドによって呼び出されます。AOwner は TForm オブジェクトのオーナーです。

CreateNew は以下の処理を実行します。

・	TScrollingWinControl.Create メソッドを呼び出して，その Create に AOwner を渡す

・	Left，Top，Width，Height プロパティを，それぞれ，0，0，320，240 に設定する

・	WindowState プロパティを wsNormal に，Visible プロパティを False に，Ctrl3d プロパティを True に，BorderIcons プロパティを [biSystemMenu, biMinimize, biMaximize]に，BorderStyle プロパティを bsSizeable に設定する

・	Icon および Canvas プロパティにメモリを割り当てる

・	Icon.OnChange イベントを IconChanged に設定する

・	TControl.ControlStyle プロパティを [csAcceptsControls, csCaptureMouse, csClickEvents, csSetCaption, csDoubleClicks] に設定する

・	Canvas.Control プロパティを Self に設定する

・	PixelsPerInch プロパティを Screen.PixelsPerInch プロパティの値に，PrintScale プロパティを poProportional に設定する

・	Self を渡して Screen.AddForm メソッドを呼び出す

CreateNew メソッドは，同じフォームのクラスのオブジェクトが必要で，関連付けられている .DFM ファイルを初期化に使いたくないときに Create メソッドのかわりに使います。この場合，ほとんどのフォームはコントロールが .DFM ファイルから作成されることを前提に記述されるので，予期できない結果が起こることもあります。


TCustomForm.CreateParams
TCustomForm.CreateParams3095058

TCustomForm	参照

CreateParams メソッドは，Params パラメータで渡されたウィンドウ作成用パラメータの内容を初期化します。

procedure CreateParams(var Params: TCreateParams); override;

説明

CreateWnd メソッドは CreateWindowHandle へ渡すパラメータを初期化するために CreateParams を呼び出します。TCustomForm は CreateParams をオーバーライドしてフォームに固有の形状を指定します。CreateParams をオーバーライドする場合は，最初に継承メソッドを呼び出します。フォームクラスのコンテキストではこのメソッドをオーバーライドする必要はありません。

CreateParams 型は Windows にウィンドウハンドルを作成するよう指示するときに必要な情報を入れておくデータ構造体です。TCreateParams レコードの各フィールドは CreateWindowEx API 関数を呼び出すためのパラメータになります。

TWinControl は，Params パラメータのすべてのフォールドを汎用の基本値に設定して CreateParams を実現します。

type

  TCreateParams = record

     Caption: PChar;

     Style: Longint;

     ExStyle: Longint;

     X, Y: Integer;

     Width, Height: Integer;

     WndParent: HWND;

     Param: Pointer

     WindowClass: TWndClass;

     WinClassName: array[0..63] of Char;

  end;


TCustomForm.CreateWindowHandle
TCustomForm.CreateWindowHandle3095059

TCustomForm	参照

CreateWindowHandle メソッドは，フォームのウィンドウハンドルを作成します。

procedure CreateWindowHandle(const Params: TCreateParams); override;

説明

CreateWindowHandle メソッドはフォームのウィンドウハンドルを作成するために呼び出されます。CreateWindowHandle は Params パラメータで渡されるレコードからパラメータを渡して CreateWindowEx API 関数を呼び出してウィンドウハンドルを作成します。CreateWindowHandle はウィンドウクラスから CS_HREDRAW および CS_VREDRAW クラススタイルを削除します。

TCreateParams 型は Windows にウィンドウハンドルを作成するよう指示するときに必要な情報を入れておくデータ構造体です。

type

  TCreateParams = record

     Caption: PChar;

     Style: Longint;

     ExStyle: Longint;

     X, Y: Integer;

     Width, Height: Integer;

     WndParent: HWND;

     Param: Pointer

     WindowClass: TWndClass;

     WinClassName: array[0..63] of Char;

  end;


TCustomForm.CreateWnd
TCustomForm.CreateWnd3095060

TCustomForm	参照

CreateWnd メソッドは，フォームに対応する Windows コントロールを作成します。

procedure CreateWnd; override;

説明

CreateWnd メソッドはフォームが作成されたとき，およびフォームの変更によりウィンドウの再作成が必要になったときに呼び出されます。CreateWnd は最初に継承する CreateWnd を呼び出してから，新たに作成された Windows イベントの通知を要求するウィンドウメッセージを送り，ウィンドウが再作成されるのなら，フォームをメモリストリームからロードし直します。CreateWnd は内部的に使用されるものなので，オーバーライドする必要はありません。


TCustomForm.Deactivate
TCustomForm.Deactivate3095061

TCustomForm	参照

Deactivate メソッドは，フォームコンポーネントの OnDeactivate イベント用のプロテクトメソッドです。

procedure Deactivate; dynamic;

説明

フォームコンポーネントは，CM_DEACTIVATE メッセージを受け取ると Deactivate を呼び出します。CM_DEACTIVATE メッセージは，アプリケーション内でアクティブウィンドウが変更されたため，またはアプリケーションがアクティブになったためにフォームにフォーカスが移ったときに送られます。

デフォルトでは，Deactivate メソッドはユーザーが OnDeactivate イベントにアタッチしたイベントハンドラを呼び出します。


TCustomForm.DefaultHandler
TCustomForm.DefaultHandler3095062

TCustomForm	参照

DefaultHandler メソッドは，フォームが自分で完全に処理しないすべてのメッセージにメッセージ処理を提供します。

procedure DefaultHandler(var Message); override;

説明

DefaultHandler はフォームのデフォルトのメッセージ処理を変更したいときにオーバーライドします。メッセージはメッセージメソッドの作成を通じて処理できるので，DefaultHandler のオーバーライドが必要になることはありません。詳細は『Object Pascal 言語リファレンス』を参照してください。

メッセージ処理メソッドで inherited を呼び出した場合，処理対象メッセージのハンドラが上位オブジェクトで指定されていないと，上位オブジェクトの DefaultHandler メソッドが呼び出されます。


TCustomForm.DefineProperties
TCustomForm.DefineProperties3095063

TCustomForm	参照

DefineProperties メソッドは，フォームファイルなどのストリームにフォームの非パブリッシュデータを格納するメソッドを指定します。

procedure DefineProperties(Filer: TFiler); override;

説明

DefineProperties メソッドは継承するメソッドを呼び出し，PixelsPerInch および TextHeight プロパティの場合はファイラオブジェクトの DefineProperty メソッドを呼び出します。TForm の下位オブジェクトは DefineProperties メソッドをオーバーライドすることでプロパティ以外のデータの読み出しと書き込みのメソッドも指定できます。


TCustomForm.DefocusControl
TCustomForm.DefocusControl3095064

TCustomForm	参照

DefocusControl メソッドは，フォーム上のコントロールからフォーカスを解除します。

procedure DefocusControl(Control: TWinControl; Removing: Boolean);

説明

DefocusControl メソッドを使うと，フォーム上のコントロールからフォーカスを解除できます。このメソッドは VCL によって内部的に使われます。

Control はフォーカスを解除するコントロールです。Control がフォームのアクティブコントロールの場合，フォームの ActiveControl プロパティが nil に設定されます

Removing は，コントロールの親にフォーカスを設定するかどうかを指定する論理値です。


TCustomForm.Destroy
TCustomForm.Destroy3095065

TCustomForm	参照

Destroy メソッドは，メモリからフォームを削除します。

destructor Destroy; override;

説明

Destroy メソッドは呼び出さないでください。かわりに Release メソッドを呼び出します。Release メソッドは CM_RELEASE メッセージを自身に送り，CM_RELEASE のハンドラが Free メソッドを呼び出します。

Destroy は以下の処理を実行します。

・	Canvas，Icon，Menu プロパティに関連付けられているオブジェクトを解放する

・	OleFormObject プロパティに関連付けられているオブジェクトの OnDestroy イベントハンドラを呼び出す（OleFormObject プロパティが nil でない場合）

・	プライベートオブジェクトに関連付けられているメモリを解放する

・	TScrollingWinControl.Destroy メソッドを呼び出す


TCustomForm.DestroyWindowHandle
TCustomForm.DestroyWindowHandle3095066

TCustomForm	参照

DestroyWindowHandle メソッドは，CreateWindowHandle メソッドで作成されたウィンドウハンドルを破棄するために Windows API 関数の DestroyWindow を呼び出します。

procedure DestroyWindowHandle; override;

説明

Destroy メソッドはフォームを破棄する前に，フォームに関連付けられているウィンドウハンドルを破棄するために DestroyWindowHandle を呼び出します。DestroyWnd メソッドも DestroyWindowHandle を呼び出します。


TCustomForm.DoHide
TCustomForm.DoHide3095067

TCustomForm	参照

DoHide メソッドは，フォームコンポーネントの OnHide イベント用の Protected メソッドです。

procedure DoHide; dynamic;

説明

フォームコンポーネントは，CM_SHOWINGCHANGED メッセージを受け取ると DoHide を呼び出します。CM_SHOWINGCHANGED メッセージは，アプリケーションでフォームが表示されるか非表示にされたときに送られます。

デフォルトでは，DoHide メソッドはユーザーが OnHide イベントにアタッチしたイベントハンドラを呼び出します。


TCustomForm.DoShow
TCustomForm.DoShow3095068

TCustomForm	参照

DoShow メソッドは，フォームコンポーネントの OnShow イベント用の Protected メソッドです。

procedure DoShow; dynamic;

説明

フォームコンポーネントは，CM_SHOWINGCHANGED メッセージを受け取ると DoShow を呼び出します。CM_SHOWINGCHANGED メッセージは，アプリケーションでフォームが表示されるか非表示にされたときに送られます。

デフォルトでは，DoShow メソッドはユーザーが OnShow イベントにアタッチしたイベントハンドラを呼び出します。


TCustomForm.FocusControl
TCustomForm.FocusControl3095069

TCustomForm	参照

FocusControl メソッドは，フォーム上のコントロールにフォーカスを設定します。

procedure FocusControl(Control: TWinControl);

説明

FocusControl メソッドは，フォーム上のコントロールのフォーカスを設定できます。

Control はフォーカスを設定するコントロールをカプセル化する TWinControl オブジェクトです。FocusControl は ActiveControl プロパティを設定します。


TCustomForm.GetChildren
TCustomForm.GetChildren3095070

TCustomForm	参照

GetChildren メソッドは，フォームの「子」コンポーネント（GetParentComponent メソッドでそのフォームを返すコンポーネント）を返します。

procedure GetChildren(Proc: TGetChildProc; Root: TComponent); override;

説明

デフォルトでは，GetChildren は子を返しません。各子項目ごとに，GetChildren は  Proc で渡されたメソッドを呼び出す必要があります。子項目は作成順，つまりフォームファイルに保存されている順番で返されます。

注意

GetChildren は，Delphi 1.0 の WriteComponents メソッドに置き換わるメソッドです。GetChildren は，フォームの継承をサポートしています。


TCustomForm.GetClientRect
TCustomForm.GetClientRect3095071

TCustomForm	参照

GetClientRect メソッドは ClientRect プロパティ用の Protected アクセスメソッドです。

function GetClientRect: TRect; override;

説明

GetClientRect メソッドは，フォームのフレーム内の長方形を定義する長方形を返します。


TCustomForm.GetFormImage
TCustomForm.GetFormImage3095072

TCustomForm	参照

GetFormImage メソッドは，出力した場合に表示されるとおりのフォームのビットマップを返します。

function GetFormImage: TBitmap;

説明

GetFormImage メソッドは，フォームのビットマップを取得できます。


TCustomForm.Hide
TCustomForm.Hide3095073

TCustomForm	参照

Hide メソッドは，フォームを非表示にします。

procedure Hide;

説明

Hide メソッドは Visible プロパティを False に設定します。


TCustomForm.Loaded
TCustomForm.Loaded3095074

TCustomForm	参照

Loaded メソッドは，ActiveControl プロパティが割り当てられていれば，フォーカスを ActiveControl に設定します。

procedure Loaded; override;

説明

最初に継承する TComponent.Loaded メソッドを呼び出し，フォームの ActiveControl プロパティが割り当てられていれば，フォーカスを ActiveControl に設定します。


TCustomForm.Notification
TCustomForm.Notification3095075

TCustomForm	参照

Notification メソッドは，フォームに AComponent で指定するコンポーネントを Operation で指定するとおりに挿入または削除することを通知します。

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

デフォルトの場合，フォームに所有コンポーネントがあればその所有コンポーネントにも通知します。

フォームはコンポーネントの挿入か削除のどちらの通知かに基づいて動作を変えられます。特にフォームに他のコンポーネントへの参照を含むオブジェクトフィールドまたはプロパティがある場合，コンポーネントを削除する通知かどうか確認し，削除であれば必要に応じて参照を無効にできます。


TCustomForm.Paint
TCustomForm.Paint3095076

TCustomForm	参照

Paint メソッドは，フォームの OnPaint イベントに関連付けられているメソッドを呼び出します。

procedure Paint; dynamic;

説明

Paint メソッドをオーバーライドすると，フォームの描画方法を変更できます。


TCustomForm.PaintWindow
TCustomForm.PaintWindow3095077

TCustomForm	参照

PaintWindow メソッドは，フォームの内容を再描画します。

procedure PaintWindow(DC: HDC); override;

説明

PaintWindow メソッドは WM_PAINT メッセージをフォームの DefaultHandler メッセージへ送ります。メッセージレコードの WParam フィールドは DC で渡された値に，その他のパラメータフィールドと結果フィールドはゼロに設定されます。


TCustomForm.PaletteChanged
TCustomForm.PaletteChanged3095078

TCustomForm	参照

PaletteChanged メソッドは，システムのパレットでの変更に応答するために，コントロールのパレットを GetPalette から返されたとおりに実現します。

function PaletteChanged(Foreground: Boolean): Boolean; override;

説明

PaletteChanged のデフォルト動作を変更する必要はまったくありません。Foreground パラメータはパレットを実現するときに，このコントロールのパレットを前景と背景のどちらにあるものとして処理しなくてはならないかを示します。

PaletteChanged の戻り値はコントロールが実際にパレットを実現したかどうかを示し，GetPalette が有効なパレットを返した場合にだけ True を返します。


TCustomForm.Print
TCustomForm.Print3095079

TCustomForm	参照

Print メソッドは，フォームを印刷します。

procedure Print;

説明

Print メソッドは，フォームを印刷できます。


TCustomForm.ReadState
TCustomForm.ReadState3095080

TCustomForm	参照

ReadState メソッドは，Reader で指定するリーダーオブジェクトからフォームのパブリッシュプロパティ，ストアドデータ，所有コンポーネントの値を読み出します。

procedure ReadState(Reader: TReader); override;

説明

ReadState メソッドは Reader で指定するリーダーオブジェクトからフォームのパブリッシュプロパティ，ストアドデータ，所有コンポーネントの値を読み出します。


TCustomForm.Release
TCustomForm.Release3095081

TCustomForm	参照

Release メソッドは，フォームを破棄し，関連付けられているメモリを解放します。

procedure Release;

説明

Release メソッドは，フォームを破棄し，関連付けられているメモリを解放できます。

Release は Free メソッドによく似ていますが，フォームのすべてのイベントハンドラおよびフォーム上のコンポーネントのイベントハンドラが実行を終了するまでフォームを破棄しない点が異なります。フォームのイベントハンドラでは Free の代わりに Release を使う必要があります。そうしないと，アクセス違反例外が生成されることがあります。


TCustomForm.Resize
TCustomForm.Resize3095082

TCustomForm	参照

Resize メソッドは，スクロールボックス，フォーム，パネルの OnResize イベント用のプロテクトメソッドです。

procedure Resize; dynamic;

説明

フォームはフォームのサイズが変更されたことを示す WM_SIZE メッセージを受け取ると Resize を呼び出します。

デフォルトでは，Resize は OnResize イベントにアタッチされたイベントハンドラを呼び出す以外は何もしません。Resize をオーバーライドすれば，継承されたイベントハンドラ呼び出しのほかにも応答ができます。


TCustomForm.SendCancelMode
TCustomForm.SendCancelMode3095083

TCustomForm	参照

SendCancelMode メソッドは，フォームのモードを取り消します。

procedure SendCancelMode(Sender: TControl);

説明

SendCancelMode メソッドは，マウスキャプチャを解放し，フォームでのスクロールバー入力およびメニュー処理を取り消すことができます。


TCustomForm.SetChildOrder
TCustomForm.SetChildOrder3095084

TCustomForm	参照

SetChildOrder メソッドは，GetChildren を呼び出したときに Child が表示される順序を変更します。

procedure SetChildOrder(Child: TComponent; Order: Integer); override;

説明

Child は，リストオブジェクト内の項目のように移動します。以前に子の古い位置で下にあった項目が上へ移動し，新しい位置で下になる項目が下へ移動します。


TCustomForm.SetFocus
TCustomForm.SetFocus3095085

TCustomForm	参照

SetFocus メソッドは，フォームにフォーカスを設定します。

procedure SetFocus;

説明

SetFocus メソッドは，フォームにフォーカスを設定できます。SetFocus はアクティブコントロールがあればそのコントロールの SetFocus メソッドを呼び出します。フォームにフォーカスがあるかどうかを調べるには，Active プロパティを使います。


TCustomForm.SetFocusedControl
TCustomForm.SetFocusedControl3095086

TCustomForm	参照

SetFocusedControl メソッドは，フォーム上のコントロールにフォーカスを設定します。

function SetFocusedControl(Control: TWinControl): Boolean;

説明

SetFocusedControl メソッドは，フォーム上のコントロールにフォーカスを設定します。


TCustomForm.SetParent
TCustomForm.SetParent3095087

TCustomForm	参照

SetParent メソッドは，フォームのコントロールリストにコントロールを追加するためにコントロールの InsertControl メソッドを呼び出します。

procedure SetParent(AParent: TWinControl); override;

説明

SetParent メソッドは，フォームのコントロールリストへの AParent の追加が有効ならば，継承する SetParent メソッドを呼び出します。


TCustomForm.Show
TCustomForm.Show3095088

TCustomForm	参照

Show メソッドは，フォームを表示します。

procedure Show;

説明

Show メソッドを使うと，フォームの Visible プロパティを True に設定し，そのフォームを画面の最前面に表示できます。


TCustomForm.ShowModal
TCustomForm.ShowModal3095089

TCustomForm	参照

ShowModal メソッドは，フォームをモード付きフォームとして表示します。

function ShowModal: Integer;

説明

ShowModal メソッドは，フォームをモード付きフォームとして表示できます。モード付きフォームでは，フォームを閉じなければアプリケーションの実行を続けることはできません。

モード付きフォームを閉じるには，ModalResult プロパティを 0 以外の値に設定します。

ShowModal はフォームの ModalResult プロパティを返します。


TCustomForm.ValidateRename
TCustomForm.ValidateRename3095090

TCustomForm	参照

ValidateRename メソッドは，フォームが所有コンポーネントの名前を変更できるかどうかを示します。

procedure ValidateRename(AComponent: TComponent; const CurName, NewName: string); override;

説明

ValidateRename メソッドは AComponent で指定する所有コンポーネントを現在の名前（CurName）から NewName で指定する文字列に変更できるかどうか調べます。AComponent が nil の場合と NewName の名前が Components リストのコンポーネントの名前としてすでに存在する場合，ValidateRename は EComponentError 例外を生成します。


TCustomForm.VisibleChanging
TCustomForm.VisibleChanging3095091

TCustomForm	参照

VisibleChanging メソッドは，フォームが Visible プロパティの値を変更する直前に呼び出されるプロテクトメソッドです。

procedure VisibleChanging; override;

説明

フォームが何らかの理由で可視状態を変更できない場合は例外が生成されます。


TCustomForm.WantChildKey
 TCustomForm.WantChildKey3095092

TCustomForm

WantChildKey メソッドは，コントロールが自分の所有するコントロールに対するキーボード入力を処理するかどうかを示します。

function WantChildKey(Child: TControl; var Message: TMessage): Boolean; virtual;

説明

WantChildKey メソッドは，フォームが所有するコントロールがキーボード入力を受信すると，そのコントロールによって呼び出されます。WantChildKey が True を返した場合は，そのコントロールではそれ以降のキーボード入力に対しては何も処理しません。その代わり，親フォームにキーボード入力に対する処理を委任します。デフォルトでは，WantChildKey は常に False を返します。すなわち，WantChildKey は，ActiveX 機能を実装するために TActiveForm でオーバーライドされます。


TCustomForm.WndProc
TCustomForm.WndProc3095093

TCustomForm	参照

WndProc メソッドは，フォームに特定のメッセージ応答を提供します。Delphi フォームの場合，WndProc がメッセージを受け取る最初のメソッドです。

procedure WndProc(var Message: TMessage); override;

説明

WndProc メソッドは継承する WndProc メソッドを呼び出します。WndProc は，VCL と Windows との同期を保つのに必要な一部のウィンドウのアクティブ化，フォーカス，位置メッセージの処理を実行します。WndProc をオーバーライドすると，コントロールの Windows メッセージへの応答のしかたを変更できます。


スコープ3095094

protected

published

読み出し／書き込み

読み出し専用


スコープ3095095

protected


スコープ3095096

protected


継承3095097

TObject

TPersistent

TComponent

TControl

TWinControl

TScrollingWinControl


TCustomForm 例3095098

TCustomForm


TCustomGroupBox
TCustomGroupBox3096001

継承	プロパティ	メソッド	参照

TCustomGroupBox は，すべてのグループボックスコンポーネントの基本となる抽象クラスです。

ユニット

stdctrls

説明

グループボックスはビジュアルコンポーネントであり，ラジオボタンなどの関連するコントロールの組み合わせを格納するコンテナとして機能します。グループボックスには他のグループボックスを入れることもできます。TCustomGroupBox は，TGroupBox，TRadioGroup，および TDBRadioGroup を含むすべてのグループボックスコンポーネントが派生する抽象クラスです。

TCustomGroupBox は，TCustomControl から継承するメソッドだけでなく AlignControls メソッド（TWinControl から継承）もオーバーライドして，グループボックス内のコンポーネントの配置を行います。さらに，TCustomGroupBox は Paint および Create メソッドもオーバーライドします。


TCustomGroupBox プロパティ3096002

TCustomGroupBox	アルファベット順	凡例

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowsProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomGroupBox プロパティ3096003

TCustomGroupBox	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentWindow

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowsProc


TCustomGroupBox メソッド3096004

TCustomGroupBox	アルファベット順	凡例

TCustomGroupBox

Create

Paint

TCustomControl からの継承

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomGroupBox メソッド3096005

TCustomGroupBox	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Paint

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TCustomGroupBox.Create
TCustomGroupBox.Create3096006

TCustomGroupBox	参照

Create メソッドは，TCustomGroupBox インスタンスを作成し初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create は継承したコンストラクタメソッドを呼び出した後，csAcceptsControls，csCaptureMouse，csClickEvents，csSetCaption，csDoubleClicks，および csReplicatable の各フラグをオンにして ControlStyle プロパティを初期化します。さらに Create は，Width および Height プロパティをそれぞれ 185 および 105 ピクセルに設定します。


TCustomGroupBox.Paint
TCustomGroupBox.Paint3096007

TCustomGroupBox	参照

Paint メソッドは，画面に表示されるグループボックスのイメージを描画します。

procedure Paint; override;

説明

Paint メソッドは，Windows の RECT 構造を作成してその周囲に境界線を描き，Windows の DrawText 関数を呼び出してキャプションを記述します。Ctl3D（TWinControl から継承されるプロテクトプロパティ）が True に設定されている場合，Paint は境界線を 3 次元表示で描画します。


スコープ3096008

published

読み出し／書き込み

読み出し専用


スコープ3096009

protected


継承3096010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl


TCustomGroupBox 例3096011

TCustomGroupBox


TCustomGrid
TCustomGrid3097001

継承	プロパティ	メソッド	参照

TCustomGrid コンポーネントは，2 次元グリッドに情報を与えるコンポーネントすべての抽象基本型です。

ユニット

grids

説明

TCustomGrid コンポーネントは，テーブル形式で情報を表すコンポーネントを定義するとき抽象クラスとして使います。このコンポーネントは，マウスアクションやユーザー編集に対する処理など，グリッドの外観と動作を制御するプロパティとメソッドを備えます。

TCustomGrid コンポーネントのインスタンスを作成しないでください。TCustomGrid の下位オブジェクトをインスタンス化することでフォームにグリッドコントロールを配置してください。テーブルグリッドにテキスト以外のオブジェクトを配置するときには TDrawGrid オブジェクトを使います。テキストを配置する場合にそのテキストがデータセットの項目値を表している場合は TDBGrid オブジェクトを使ってください。


TCustomGrid プロパティ3097002

TCustomGrid	アルファベット順	凡例

TCustomGrid

BorderStyle

Col

ColCount

ColWidths

DefaultColWidth

DefaultDrawing

DefaultRowHeight

EditorMode

FixedColor

FixedCols

FixedRows

GridHeight

GridLineWidth

GridWidth

HitTest

InplaceEditor

LeftCol

Options

Row

RowCount

RowHeights

ScrollBars

Selection

TabStops

TopRow

VisibleColCount

VisibleRowCount

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomGrid プロパティ3097003

TCustomGrid	オブジェクト順	凡例

Align

BorderStyle

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Col

ColCount

Color

ColWidths

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DefaultColWidth

DefaultDrawing

DefaultRowHeight

DesignInfo

EditorMode

Enabled

FixedColor

FixedCols

FixedRows

GridHeight

GridLineWidth

GridWidth

Handle

Height

HelpContext

Hint

HitTest

InplaceEditor

Left

LeftCol

Name

Options

Owner

Parent

ParentWindow

Row

RowCount

RowHeights

ScrollBars

Selection

ShowHint

Showing

TabOrder

TabStop

TabStops

Tag

Top

TopRow

VCLComObject

Visible

VisibleColCount

VisibleRowCount

Width

WindowProc


TCustomGrid.BorderStyle
TCustomGrid.BorderStyle3097004

TCustomGrid	参照

BorderStyle プロパティは，グリッドの周囲に一重線の境界線を描画するかどうかを指定します。

property BorderStyle: TBorderStyle;

説明

BorderStyle プロパティを beSingle に設定すると，グリッドイメージの周囲に一重線の境界線が追加描画されます。bsNone に設定すると境界線は削除されます。

BorderStyle プロパティの視覚的効果は，Ctrl3D プロパティの値によって変わります。BordeStyle と Ctrl3D の色々な組み合わせて目的の外観にしてください。


TCustomGrid.Col
TCustomGrid.Col3097005

TCustomGrid	参照

Col プロパティは，選択されたセルを含む列のインデックスです。

property Col: Longint;

説明

実行時に Col プロパティで，グリッドの現在のインデックスを表します。このプロパティを設定すると，フォーカスは新しく選択された列の現在の行にあるセルに移動します。第 1 列がインデックス 0，第 2 列が 1 です。

グリッド内の選択されたセルの位置は，Col プロパティと Row プロパティを読み込んで列と行のインデックスを取得すればわかります。フォーカスがグリッドに移動すると，選択されたセルに入力フォーカスが移ります。


TCustomGrid.ColCount
TCustomGrid.ColCount3097006

TCustomGrid	参照

ColCount プロパティは，グリッド内の列の数を表します。

property ColCount: Longint;

説明

ColCount プロパティは，ColWidths プロパティのインデックス配列のエントリ数です。グリッドの右側にある列を削除したり，そこに列を追加したりするには ColCount を設定します。ColCount の値には，グリッド左側の固定列すべてと，グリッド本体のスクロール可能な列が含まれます。


TCustomGrid.ColWidths
TCustomGrid.ColWidths3097007

TCustomGrid	参照

ColWidths プロパティは，グリッド内の列すべての幅（ピクセル単位）を示すインデックス配列です。

property ColWidths[Index: Longint]: Integer;

説明

ColWidths プロパティは，Index パラメータで指定された列の各セルの幅がわかります。インデックス 0 は最初の列を示します。実行時にこのプロパティを設定すると，個々の列の幅が変わります。

列の幅が，マウスでサイズ変更するか，ColWidth プロパティを使う方法で明示的に設定されていない場合，列の幅は DefaultColWidth となります。

Colwidth 配列内のエントリ数を知るには ColCount プロパティを使います。


TCustomGrid.DefaultColWidth
TCustomGrid.DefaultColWidth3097008

TCustomGrid	参照

DefaultColWidth プロパティは，明示的にサイズ変更されていないすべての列の幅（ピクセル単位）を示します。

property DefaultRowHeight: Integer;

説明

DefaultColWidth プロパティを設定すると，すべての列の幅が変わります。このプロパティが設定されると，マウスを使うか，ColWidth プロパティを設定してサイズを変更した列にも DefaultColWidth の幅が設定されます。

ColCount プロパティを使って新しい列がグリッドに追加されるときは，DefaultColWidth 幅の列が作られます。


TCustomGrid.DefaultDrawing
TCustomGrid.DefaultDrawing3097009

TCustomGrid	参照

DefaultDrawing プロパティは，グリッドを描画するときにセルを描画するかどうかを指定します。

property DefaultDrawing: Boolean;

説明

DefaultDrawing プロパティを True に設定すると，グリッド内のセルも自動的に描画されます。このとき，背景色，固定セル上の 3 次元効果，および選択されたセル周囲の長方形のフォーカス領域も追加描画されます。このプロパティを False に設定すると，グリッド描画時にセルの描画は行われません。

DefaultDrawing が False のときにセルを描画するには DrawCell メソッドを使わなければなりません。TCustomGrid コンポーネントでは，DrawCell メソッドが抽象メソッドです。TCustomGrid の下位オブジェクトは，DrawCell メソッドを使って，独自のカスタマイズされた描画コードを与えたり，OnDrawCell イベントを生成したりします。


TCustomGrid.DefaultRowHeight
TCustomGrid.DefaultRowHeight3097010

TCustomGrid	参照

DefaultRowHeight プロパティは，明示的にサイズ変更されていないすべての行の高さ（ピクセル単位）を指定します。

property DefaultColWidth: Integer;

説明

DefaultRowHeight プロパティを設定すると，すべての行のサイズが変わります。DefaultRowHeight が設定されると，マウスを使ったり RowHeights プロパティを設定したりしてサイズが変更されている行も DefaultRowHeight の高さに設定されます。

新しい行が RowCount プロパティを使ってグリッドに追加されるときは，DefaultRowHeight の高さの行が作られます。


TCustomGrid.EditorMode
TCustomGrid.EditorMode3097011

TCustomGrid	参照

EditorMode プロパティは，現在のセルを編集できるかどうかを指定します。

property EditorMode: Boolean;

説明

EditorMode プロパティを実行時に True に設定すると，グリッドが編集モードに設定されます。このプロパティが True のときにはセルを編集することができます。〔F2〕キーが押されると，EditorMode プロパティは True に設定されます。〔Enter〕キーが押されると，EditorMode プロパティの値は True と False との間で交互に切り替わります。

注意

Options プロパティに goEditing が含まれていない場合，または goAlwaysShowEnter が含まれている場合，EditorMode プロパティは無効となります。


TCustomGrid.FixedColor
TCustomGrid.FixedColor3097012

TCustomGrid	参照

FixedColor プロパティは，グリッド内の固定行と固定列の背景色を示します。

property FixedColor: TColor;

説明

FixedColor プロパティで，グリッド内のスクロールしないセルの色を指定できます。スクロール領域の色は Color プロパティで指定します。

このプロパティに設定できる値は Color プロパティの項で示しています。


TCustomGrid.FixedCols
TCustomGrid.FixedCols3097013

TCustomGrid	参照

FixedCols プロパティは，グリッド内の左側にあるスクロールできない列の数を示します。

property FixedCols: Integer;

説明

FixedCols プロパティで，スクロールしない列を設定できます。スクロールしない列はグリッド内の左側にあり，他の列がスクロールしているときでも常に表示されています。このスクロールしない列を使って，行タイトルや行番号を表示したり，ユーザーが設定できるスクロール外観を作ったりできます。

スクロールしない列はスクロールする列とは外観が違います。つまり，スクロールしない列は他とは異なる背景色で描画され，Ctrl3D プロパティが True のとき，そのセルは浮き上がった 3 次元の外観となります。

注意

グリッドには 1 つ以上のスクロールする列がなければなりません。Fixedcols プロパティには ColCount - 1 より大きい値を設定しないでください。


TCustomGrid.FixedRows
TCustomGrid.FixedRows3097014

TCustomGrid	参照

FixedRows プロパティは，グリッド内の最上部にあるスクロールできない行の数を示します。

property FixedRows: Integer;

説明

FixedRows プロパティで，スクロールしない行を設定できます。スクロールしない行はグリッド内の最上部にあり，他の行がスクロールしているときでも常に表示されています。このスクロールしない行を使って，列タイトルや列番号を表示します。

スクロールしない行はスクロールする行とは外観が違います。スクロールしない行は他とは異なる背景色で描画され，Ctrl3D プロパティが True のとき，そのセルは浮き上がった 3 次元の外観となります。

注意

グリッドには 1 つ以上のスクロールする行がなければなりません。FixedRows プロパティには RowCount - 1 より大きい値を設定しないでください。


TCustomGrid.GridHeight
TCustomGrid.GridHeight3097015

TCustomGrid	参照

GridHeight プロパティは，グリッドの高さ（ピクセル単位）を示します。

property GridHeight: Integer;

説明

GridHeight プロパティで，グリッドのサイズがわかります。GridHeight の値が ClientHeight の値よりも小さい場合，グリッドのすべての行が一度にコントロールに表示され，グリッドの下側に空き領域が生まれます。グリッドの高さが大きすぎてコントロール内に表示しきれないときは，GridHeight の値は ClientHeight と同じで，スクロールしないとグリッドの全部を見ることはできません。


TCustomGrid.GridLineWidth
TCustomGrid.GridLineWidth3097016

TCustomGrid	参照

GridLineWidth プロパティは，セルとセルとを分ける線の幅（ピクセル単位）を示します。

property GridLineWidth: Integer;

説明

GridLineWidth プロパティを設定すると，グリッドの各セルを分ける線を太さを指定できます。GridLineWidth プロパティが 0 の場合，セルを分ける線は描画されません。

Options プロパティに goFixedHorzLine，goFixedVertLine，goHorzLine，goVertLine のいずれも含まれていない場合，GridLineWidth プロパティは無効になります。

注意

GridLineWidth プロパティが 0 であっても，Ctrl3D プロパティが True であれば，固定行および固定列の各セルは，はっきりと見分けられます。しかし，Ctrl3D を False に設定すると，固定領域の各セルを区別していた浮き上がり効果がなくなります。

注意

ひずみが現れることがあるので，Windows 95 上で実行するアプリケーションでは 3 ピクセルより大きな値を指定することはお勧めしません。


TCustomGrid.GridWidth
TCustomGrid.GridWidth3097017

TCustomGrid	参照

GridWidth プロパティは，グリッドの幅（ピクセル単位）を示します。

property GridWidth: Integer;

説明

GridWidth プロパティでグリッドのサイズがわかります。GridWidth の値が ClientWidth の値よりも小さい場合，グリッドのすべての列が一度にコントロールに表示され，グリッドの右側に空き領域が生まれます。グリッドの幅が大きすぎてコントロール内に表示しきれないときは，GridWidth の値は ClientWidth と同じで，スクロールしないとグリッドの全部を見ることはできません。


TCustomGrid.HitTest
TCustomGrid.HitTest3097018

TCustomGrid	参照

HitTest プロパティは，マウスカーソルの現在の位置を示します。

property HitTest: TPoint;

説明

マウスがグリッド上にあるとき，またはグリッドがマウスをキャプチャしたとき，HitTest プロパティで，マウスの位置がわかります。ユーザーが行や列を移動していたり，行や列のサイズを変更していたりする場合，あるいはマウスである範囲のセルを選択している場合，HitTest はグリッドコントロールのクライアント領域の外を示すことがあります。HitTest は，グリッドの左上隅を（0, 0）とする座標系におけるマウスカーソルの位置を示しています。

値	意味

HTBORDER	マウスはグリッドコントロールの境界上にある

HTCLIENT	マウスはグリッドコントロールのクライアント領域にある

HTHSCROLL	マウスは水平スクロールバー上にある

HTTRANSPARENT	マウスは他のコントロールにおおわれたグリッドにある

HTVSCROLL	マウスは垂直スクロールバー上にある


TCustomGrid.InplaceEditor
TCustomGrid.InplaceEditor3097019

TCustomGrid	参照

InplaceEditor プロパティは，選択されたセルの内容をユーザーが編集できるようにするためにグリッドが使う編集コントロールです。

property InplaceEditor: TInplaceEdit;

説明

InplaceEditor プロパティは，グリッドが編集モードにあるときに，選択されたセルの最上部にある編集コントロールに直接アクセスできるようにします。このエディタは，グリッドが最初に編集モードに設定されたときに生成され，グリッドが破棄されるまで破棄されません。選択されたセルが変更されるとグリッドはこのエディタを移動します。グリッドは，編集モードを抜けるとき，このエディタのウィンドウを隠します。


TCustomGrid.LeftCol
TCustomGrid.LeftCol3097020

TCustomGrid	参照

LeftCol プロパティは，グリッド内のスクロール可能な列のうち最初に表示されている列の番号を示します。

property LeftCol: Longint;

説明

LeftCol プロパティで，スクロール可能領域の列で最初に表示されている列の番号を取得できます。このプロパティを設定すると，グリッド内の列がスクロールされ，インデックス LeftCol が示す列が固定列の後ろの最初の列になります。


TCustomGrid.Options
TCustomGrid.Options3097021

TCustomGrid	参照

Options プロパティは，グリッドのさまざまな表示プロパティと動作プロパティを指定します。

TGridOption = (goFixedVertLine, goFixedHorzLine, goVertLine, goHorzLine,

    goRangeSelect, goDrawFocusSelected, goRowSizing, goColSizing, goRowMoving,

    goColMoving, goEditing, goTabs, goRowSelect, goAlwaysShowEditor, goThumbTracking);

  TGridOptions = set of TGridOption;

property Options: TGridOptions;

説明

Options にはグリッドに指定するプロパティを設定します。Options は以下の値の集合です。

値	意味

goFixedVertLine	固定（スクロールしない）列を分ける垂直線が描画される

goFixedHorzLine	固定（スクロールしない）行を分ける水平線が描画される

goVertLine	スクロール可能な列を分ける垂直線が描画される

goHorzLine	スクロール可能な行を分ける水平線が描画される

goRangeSelect	各セルの範囲を一度に選択できる。Options に goEditing が含まれている場合，goRangeSelect は無視される

goDrawFocusSelected	入力フォーカスのない選択されたセルとまったく同様に，入力フォーカスのあるセルは特別な強調表示色で描画される。Options に goDrawFocusSelecteed が含まれていない場合，入力フォーカスのあるセルは，特殊な背景色ではなくフォーカス矩形で見分けられる

goRowSizing	スクロール可能な行は個別にサイズを変更できる

goColSizing	スクロール可能な列は個別にサイズを変更できる

goRowMoving	スクロール可能な行はマウスで移動できる

goColMoving	スクロール可能な列はマウスで移動できる

goEditing	セルの内容を編集できる。Options に goEditing が含まれている場合，goRangeSelect は無効

goTabs	〔Tab〕キーおよび〔Shift〕+〔Tab〕キーを使って各セル間を移動できる

goRowSelect	個々のセルではなく行全体を選択する。Options に goRowSelect が含まれている場合，goAlwaysShowEditor は無効

goAlwaysShowEditor	グリッドは編集モードにロックされる。編集モードにするのに〔Enter〕キーまたは〔F2〕キーを押す必要はない。Options に goEditing が含まれていない場合，goAlwaysShowEditor は無効。goRowSelect が含まれている場合，goAlwaysShowEditor は無効

goThumbTracking	スクロールボックスをドラッグ中，グリッドイメージが更新される。goThumbTracking が含まれていない場合，新しい場所でスクロールボックスを離すまでイメージは更新されない


TCustomGrid.Row
TCustomGrid.Row3097022

TCustomGrid	参照

Row プロパティは，選択されたセルを含む行のインデックスを示します。

property Row: Longint;

説明

実行時に Row プロパティによって，どの行が現在の行かがわかります。Row を設定すると，新しい行にある現在の列のセルにフォーカスが移動します。最初の行がインデックス 0 で，次の行がインデックス 1 となります。

選択されたセルの位置は，Row プロパティと Col プロパティを読み込んで行と列のインデックスを取得することでわかります。フォーカスがグリッドに移動すると，選択されたセルに入力フォーカスが移ります。


TCustomGrid.RowCount
TCustomGrid.RowCount3097023

TCustomGrid	参照

RowCount プロパティは，グリッド内の行の数を示します。

property RowCount: Longint;

説明

RowCount プロパティの値で，RowHeights 配列内のエントリ数がわかります。このプロパティを設定すると，グリッド下部の行を追加したり削除したりできます。このプロパティの値には，グリッド上部の固定行すべてと，グリッド本体のスクロール可能な行が含まれます。


TCustomGrid.RowHeights
TCustomGrid.RowHeights3097024

TCustomGrid	参照

RowHeights プロパティは，グリッド内の行すべての高さ（ピクセル単位）からなるインデックス配列を表します。

property RowHeights[Index: Longint]: Integer;

説明

RowHeights プロパティは，Index パラメータで指定された行の各セルの幅がわかります。インデックス 0 は最初の列を示します。実行時にこのプロパティを設定すると，個々の行の高さが変わります。

行の高さが，マウスでサイズ変更するか，RowHeights プロパティを使うかして明示的に設定されていない場合，行の高さは DefaultRowHeight となります。

RowHeights 配列内のエントリ数を知るには，RowCount プロパティを使ってください。


TCustomGrid.ScrollBars
TCustomGrid.ScrollBars3097025

TCustomGrid	参照

ScrollBars プロパティは，グリッドに水平スクロールバーまたは垂直スクロールバーを含めるかどうかを指定します。

TScrollStyle = (ssNone, ssHorizontal, ssVertical, ssBoth);

property ScrollBars: TScrollStyle;

説明

ScrollBars プロパティで，グリッドの水平スクロールバーまたは垂直スクロールバーを指定します。以下の値のいずれかを設定できます。

値	意味

ssNone	グリッドにスクロールバーがない

ssHorizontal	グリッドの下端にスクロールバーがある

ssVertical	グリッドの右端にスクロールバーがある

ssBoth	グリッドの下端と右端の両方にスクロールバーがある

注意

すべてのセルの幅が ClientWidth に一致していれば，ScrollBars プロパティが ssHorizontal か ssBoth であっても水平スクロールバーは表示されません。すべてのセルの高さが ClientHeight にあっていれば，ScrollBars プロパティが ssVertical か ssBoth であっても垂直スクロールバーは表示されません。


TCustomGrid.Selection
TCustomGrid.Selection3097026

TCustomGrid	参照

Selection プロパティは，現在選択されている領域の境界を指定します。

TGridRect = record

    case Integer of

      0: (Left, Top, Right, Bottom: Longint);

      1: (TopLeft, BottomRight: TGridCoord);

  end;

property Selection: TGridRect;

説明

セルの範囲を選択するには，Selection プロパティを設定します。選択されるのは，グリッド内の第 1 列，第 1 行，最終列，最終行，あるいは選択された領域にある左上および右下セルの行列座標です。

Options に goRangeSelect が含まれているときは，複数のセルを指定することしかできません。


TCustomGrid.TabStops
TCustomGrid.TabStops3097027

TCustomGrid	参照

TabStops プロパティは，指定された列にタブ移動できるかどうかを示す論理値のインデックス配列です。

property TabStops[Index: Longint]: Boolean;

説明

TabStops プロパティを False に設定すると，Index パラメータで指定された列をタブ順から削除します。グリッド内の最初の列はインデックス 0 で示されます。

注意

Options プロパティに goTabs が含まれていないと，TabStops が True であってもどの列にもタブ移動できません。


TCustomGrid.TopRow
TCustomGrid.TopRow3097028

TCustomGrid	参照

TopRow プロパティは，表示されているスクロール可能な行のうち最初の行のインデックスを示します。

property TopRow: Longint;

説明

TopRow プロパティで，表示されているスクロール可能な行のうち最初の行のインデックスが取得できます。インデックス TopRow の行が固定行の後にくる最初の行になるようにスクロールするには TopRow を設定してください。


TCustomGrid.VisibleColCount
TCustomGrid.VisibleColCount3097029

TCustomGrid	参照

VisibleColCount プロパティは，グリッド内に表示される列の数を示します。

property VisibleColCount: Integer;

説明

VisibleColCount プロパティで，全体が表示されていてスクロール可能な列の数がわかります。このプロパティには，FixedCols プロパティでカウントされる固定列は入りません。また，グリッドの右端にその一部分しか表示されていない列も入りません。


TCustomGrid.VisibleRowCount
TCustomGrid.VisibleRowCount3097030

TCustomGrid	参照

VisibleRowCount プロパティは，グリッド内に表示される行の数を示します。

property VisibleColCount: Integer;

説明

VisibleRowCount プロパティで，全体が表示されていてスクロール可能な行の数がわかります。このプロパティには，FixedRows プロパティでカウントされる固定行は入りません。また，グリッド下部にその一部分が表示される行も入りません。


TCustomGrid メソッド3097031

TCustomGrid	アルファベット順	凡例

TCustomGrid

AdjustSize

BoxRect

CanEditAcceptKey

CanEditModify

CanEditShow

CanGridAcceptKey

CellRect

ColumnMoved

ColWidthsChanged

Create

CreateEditor

CreateParams

DefineProperties

DeleteColumn

DeleteRow

Destroy

DoExit

DrawCell

GetEditLimit

GetEditMask

GetEditText

GetGridHeight

GetGridWidth

HideEditor

InvalidateCell

InvalidateCol

InvalidateEditor

InvalidateRow

KeyDown

KeyPress

MouseCoord

MouseDown

MouseMove

MouseUp

MoveColRow

MoveColumn

MoveRow

Paint

RowHeightsChanged

RowMoved

ScrollData

SelectCell

SetEditText

ShowEditor

ShowEditorChar

SizeChanged

Sizing

TimedScroll

TopLeftChanged

UpdateDesigner

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomGrid メソッド3097032

TCustomGrid	オブジェクト順	凡例

AdjustSize

Assign

BeginDrag

BoxRect

BringToFront

Broadcast

CanEditAcceptKey

CanEditModify

CanEditShow

CanFocus

CanGridAcceptKey

CellRect

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ColumnMoved

ColWidthsChanged

ContainsControl

ControlAtPos

Create

CreateEditor

CreateParams

CreateParented

DefaultHandler

DefineProperties

DeleteColumn

DeleteRow

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DoExit

DragDrop

Dragging

DrawCell

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetEditLimit

GetEditMask

GetEditText

GetGridHeight

GetGridWidth

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

HideEditor

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

InvalidateCell

InvalidateCol

InvalidateEditor

InvalidateRow

KeyDown

KeyPress

MethodAddress

MethodName

MouseCoord

MouseDown

MouseMove

MouseUp

MoveColRow

MoveColumn

MoveRow

NewInstance

Paint

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

RowHeightsChanged

RowMoved

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

ScrollData

SelectCell

SendToBack

SetBounds

SetEditText

SetFocus

SetTextBuf

Show

ShowEditor

ShowEditorChar

SizeChanged

Sizing

TimedScroll

TopLeftChanged

Update

UpdateControlState

UpdateDesigner


TCustomGrid.AdjustSize
TCustomGrid.AdjustSize3097033

TCustomGrid	参照

AdjustSize メソッドは，グリッドから行または列を追加または削除します。

procedure AdjustSize(Index, Amount: Longint; Rows: Boolean); dynamic;

説明

ユーザーがマウスを使って行または列のサイズを変更したとき，Grid コンポーネントは，AdjustSize メソッドを内部的に呼び出して行または列の番号を調整します。Index パラメータは挿入または削除を開始する行または列のインデックスです。Amount パラメータは挿入（Amount > 0）または削除（Amount < 0）する行または列の番号です。Rows パラメータは，行または列が変わるかどうかを示す論理値です。


TCustomGrid.BoxRect
TCustomGrid.BoxRect3097034

TCustomGrid	参照

BoxRect メソッドは，指定されたセル集合の画面座標値を返します。

function BoxRect(ALeft, ATop, ARight, ABottom: Longint): TRect;

説明

BoxRect メソッドを呼び出すと，インデックス ALeft～ARight の列間およびインデックス ATop～ABottom の行間にあるセルの画面座標値（ピクセル単位）が得られます。画面上に見えないセルの座標値は最終矩形には含まれません。


TCustomGrid.CanEditAcceptKey
TCustomGrid.CanEditAcceptKey3097035

TCustomGrid	参照

CanEditAcceptKey メソッドは，Key パラメータが現在のセルに入力できるデータであるかどうかを示します。

function CanEditAcceptKey(Key: Char): Boolean; dynamic;

説明

ユーザーがセルの内容を編集している間，CanEditAcceptKey メソッドはキーボード入力の有効性を単純な方法で判断します。TCustomGrid の CanEditAcceptKey メソッドは常に True を返します。TCustomGrid から派生するオブジェクトは，無効な文字を排除するために CanEditAcceptKey メソッドをオーバーライドします。

編集マスクを使えば，より詳細な有効性の確認ができます。


TCustomGrid.CanEditModify
TCustomGrid.CanEditModify3097036

TCustomGrid	参照

CanEditModify メソッドは，現在のセルが編集可能かどうかを示します。

function CanEditModify: Boolean; dynamic;

説明

グリッドコンポーネントは，CanEditModigy メソッドを内部的に使用して，現在のセルが編集可能かどうかを判断します。このメソッドは，インプレースエディタが編集を禁止していない限り True を返します。


TCustomGrid.CanEditShow
TCustomGrid.CanEditShow3097037

TCustomGrid	参照

CanEditShow メソッドは，グリッドを編集するインプレース編集コントロールを作成できるかどうかを示します。

function  CanEditShow: Boolean; dynamic;

説明

グリッドコントロールは，内部的に CanEditSHow メソッドを呼び出してからセルを編集するエディタを作成します。このメソッドが呼び出されるのは，グリッドが CanEditModify メソッドを呼んで項目が編集可能であると判断した後です。

CanEditShow メソッドは，Options プロパティでグリッドが編集可能と指定されていない場合，または行選択が可能と指定されている場合は False を返します。Options プロパティでグリッドが編集モードにロックされると指定している場合，またはグリッドに入力フォーカスがある場合，CanEditShow は True を返します。グリッドが編集モードにロックされておらず，グリッドに入力フォーカスがない場合は False を返します。


TCustomGrid.CanGridAcceptKey
TCustomGrid.CanGridAcceptKey3097038

TCustomGrid	参照

CanGridAcceptKey メソッドは，指定されたキー入力にグリッドが応答すべきかどうかを示します。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

function CanGridAcceptKey(Key: Word; Shift: TShiftState): Boolean; dynamic;

説明

グリッドコントロールは，最初にキーが押されたとき，CanGridAcceptKey メソッドを内部的に呼び出して，キー組み合わせの有効性を判断します。TCustomGrid コンポーネントの CanGridAcceptKey メソッドは常に True を返します。TCustomGrid の下位オブジェクトはこのメソッドをオーバーライドして，それによって間違ったキー入力や，グリッドの Options またはモードに違反するアクションを示すキー入力を排除します。


TCustomGrid.CellRect
TCustomGrid.CellRect3097039

TCustomGrid	参照

CellRect メソッドは，セルの画面座標値を返します。

function CellRect(ACol, ARow: Longint): TRect;

説明

CellRect メソッドを呼び出すと，ACol および ARow パラメータでそれぞれ指定された列内と行内にあるセルの境界（ピクセル単位）を取得できます。ACol と ARow が 0 の場合，左上のセルが指定されたことになります。

指定されたセルが表示されていない場合，CellRect は空の長方形を返します。


TCustomGrid.ColumnMoved
TCustomGrid.ColumnMoved3097040

TCustomGrid	参照

ColumnMoved メソッドは，列の位置が変化したとき応答するメソッドとのインターフェースを提供します。

procedure ColumnMoved(FromIndex, ToIndex: Longint); dynamic;

説明

ColumnMoved メソッドは，列が移動した直後に呼び出されます。FromIndex パラメータは列の移動前のインデックスで，ToIndex パラメータは移動後のインデックスです。TCustomGrid コンポーネントの ColumnMoved メソッドは何も行いません。TCustomGrid から派生するオブジェクトはこのメソッドをオーバーライドして，内部調整や OnColumnMoved イベントの生成を行います。


TCustomGrid.ColWidthsChanged
TCustomGrid.ColWidthsChanged3097041

TCustomGrid	参照

ColWidthsChanged は，列幅が変化したとき応答するメソッドです。

procedure ColWidthsChanged; dynamic;

説明

ColWidthsChanged メソッドは列幅が変化した直後に呼び出されます。この変化の原因には，ColWidths プロパティの設定，DefaultColWidth プロパティの設定，列の移動，マウスによる列のサイズ変更などがあります。

ColWidthsChanged は，スクロールバーを調整したり，インプレースエディタの位置を調整したりすることで，列の新しいサイズや位置に対応します。


TCustomGrid.Create
TCustomGrid.Create3097042

TCustomGrid	参照

Create メソッドは，TCustomGrid のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

TCustomGrid コンポーネントのインスタンスを直接作成しないでください。TCustomGrid はグリッドコントロールの抽象基本クラスです。TCustomGrid の下位オブジェクトの Create メソッドを呼び出して，実行時にグリッドコントロールを作成してください。設計時にフォーム上に配置されたグリッドは自動的に作成されます。

継承コンストラクタを呼び出した後，Create メソッドは以下の処理を行います。

・	BorderStyle プロパティを bsSingle に初期化する

・	ColCount プロパティと RowCount プロパティをともに 5 に初期化する

・	Color プロパティを clWindow に，FixedColor プロパティを clBtnFace に初期化する

・	ControlStyle プロパティを [csCaptureMouse, csOpaque, csDoubleClicks, csFramed] に初期化する

・	DefaultColWidth プロパティを 64 に，DefaultRowHeight プロパティを 24 に初期化する

・	DefaultDrawing プロパティを True に設定する

・	EditorMode プロパティを False に初期化する

・	FixedCols プロパティと FixedRows プロパティをともに 1 に初期化する

・	GridLineWidth プロパティを 1 に初期化する

・	Options プロパティを [goFixedVertLine, goFixedHorzLine, goVertLine, goHorzLine, goRangeSelect] に初期化する

・	ParentColor プロパティを False に初期化する

・	ScrollBars プロパティを ssBoth に初期化する

・	TabStop プロパティを True に初期化する


TCustomGrid.CreateEditor
TCustomGrid.CreateEditor3097043

TCustomGrid	参照

CreateEditor メソッドは，インプレースエディタコントロールを作成します。

function CreateEditor: TInplaceEdit; virtual;

説明

グリッドコントロールは，グリッドが最初に編集モードに入ったとき内部的に CreateEditor メソッドを呼び出します。CreateEditor は Protected メソッドとして定義されているので，TCustomGrid コンポーネントの派生オブジェクトは，TInplaceEdit の特別な派生メソッドを使ってセルを編集します。


TCustomGrid.CreateParams
TCustomGrid.CreateParams3097044

TCustomGrid	参照

CreateParams メソッドは，Params パラメータで与えられたウィンドウ作成パラメータレコードを初期化します。

type

  TCreateParams = record

    Caption: PChar;

    Style: Longint;

    ExStyle: Longint;

    X, Y: Integer;

    Width, Height: Integer;

    WndParent: HWND;

    Param: Pointer

    WindowClass: TWndClass;

    WinClassName: array[0..63] of Char;

  end;

procedure CreateParams(var Params: TCreateParams); override;

説明

CreateWnd メソッドは内部的に呼び出され，このコントロールを実装するウィンドウのプロパティを指定します。TCreateParams 型は，Windows にウィンドウハンドルを作らせるのに必要な情報を持つデータ構造です。TCreateParams レコードの各項目は，CreateWindowEx API 関数を呼び出す際のパラメータとなります。

継承メソッドを呼び出した後，CreateParams メソッドは，グリッドにダブルクリックメッセージを受け取るように指示するため，また Ctrl3D，ScrollBars，BorderStyle 各プロパティの値を設定するために Params の値を調整します。


TCustomGrid.DefineProperties
TCustomGrid.DefineProperties3097045

TCustomGrid	参照

DefineProperties メソッドは，グリッドに保存されている値に ColWidths プロパティと RowHeights プロパティを追加します。

procedure DefineProperties(Filer: TFiler); override;

説明

DefineProperties メソッドは継承メソッドをオーバーライドし，ColWidths プロパティと RowHeigths プロパティがデフォルトの幅および高さとは異なる値であれば，それらのプロパティの値をグリッドに保存します。


TCustomGrid.DeleteColumn
TCustomGrid.DeleteColumn3097046

TCustomGrid	参照

DeleteColumn メソッドは，インデックス ACol の列をグリッドから削除します。

procedure DeleteColumn(ACol: Longint);

説明

DeleteColumn メソッドを呼び出すと，グリッドの途中の列が削除されます。グリッドの最後の列を削除するには，ColCount プロパティを設定してください。


TCustomGrid.DeleteRow
TCustomGrid.DeleteRow3097047

TCustomGrid	参照

DeleteRow メソッドは，インデックス ARow の行をグリッドから削除します。

procedure DeleteRow(ARow: Longint);

説明

DeleteRow メソッドを呼び出すと，グリッドの途中の行が削除されます。グリッドの最後の行を削除するには，RowCount プロパティを設定してください。


TCustomGrid.Destroy
TCustomGrid.Destroy3097048

TCustomGrid	参照

Destroy メソッドは，TCustomGrid のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドはグリッドがまだ解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。


TCustomGrid.DoExit
TCustomGrid.DoExit3097049

TCustomGrid	参照

DoExit メソッドは，フォーム内の他のコントロールに選択が移ったときにインプレースエディタを隠します。

procedure DoExit; override;

説明

OnExit イベントを生成する継承メソッドを呼び出した後，DoExit メソッドは，Options に goAlwaysShowEditor が含まれていなければインプレースエディタを隠します。


TCustomGrid.DrawCell
TCustomGrid.DrawCell3097050

TCustomGrid	参照

DrawCell メソッドは，セルの内容を描画するメソッドの抽象プロトタイプです。

TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

procedure DrawCell(ACol, ARow: Longint; ARect: TRect; AState: TGridDrawState); virtual;

    abstract;

説明

TCustomGrid コンポーネントの派生オブジェクトは DrawCell メソッドを作成し，そのメソッドでセル内容の描画や OnDrawCell イベントの生成を行います。DefaultDrawing プロパティが True の場合，セルの背景を描画してから DrwaCell メソッドを呼び出します。次いで DrawCell メソッドを実行してから，固定セルに 3D 効果を付加し，フォーカスのあるセルの周囲に長方形を描画します。

ACol パラメータと ARow パラメータは，描画するセルの列/行インデックスです。ARect パラメータは，キャンバス座標系におけるセルの境界線を指定します。AState パラメータは，セルが選択されているか，セルに入力フォーカスがあるか，グリッドのスクロールしない固定部分にセルがあるか，を指定します。


TCustomGrid.GetEditLimit
TCustomGrid.GetEditLimit3097051

TCustomGrid	参照

GetEditLimit メソッドは，セルに入力できる文字数を制限するメソッドとのインターフェースを提供します。

function GetEditLimit: Integer; dynamic;

説明

GetEditLimit メソッドは，セルに入力できる文字数を制限しなければならないかどうかを判断するためにインプレースエディタが呼び出すメソッドです。GetEditLimit は制限を設定していません。TCsutomGrid コンポーネントの下位オブジェクトは GetEditLimit をオーバーライドして，特定のセルのテキスト長に制限を加えます。


TCustomGrid.GetEditMask
TCustomGrid.GetEditMask3097052

TCustomGrid	参照

GetEditMask メソッドは，指定されたセルの入力マスクを返すメソッドとのインターフェースを提供します。

function  GetEditMask(ACol, ARow: Longint): string; dynamic;

説明

インプレースエディタは GetEditMask メソッドを呼び出して，そのメソッドにおいて ACol および ARow パラメータによって指定されたセルの入力マスクを取得します。入力マスクがないことを示すには，空の文字列を返すようにします。TCustomGrid コンポーネントの派生オブジェクトはこのメソッドをオーバーライドして，入力マスクを与えたり，OnGetEditMask イベントを生成したりします。


TCustomGrid.GetEditText
TCustomGrid.GetEditText3097053

TCustomGrid	参照

GetEditText メソッドは，指定されたセルの値を編集形式で返します。

function  GetEditText(ACol, ARow: Longint): string; dynamic;

説明

インプレースエディタは GetEditText メソッドを呼び出して，指定されたセルのテキストを取得します。 TCustomGrid コンポーネントの派生オブジェクトは GetEditText をオーバーライドして，ACol パラメータと ARow パラメータで指定されたセルの文字列を返します。


TCustomGrid.GetGridHeight
TCustomGrid.GetGridHeight3097054

TCustomGrid	参照

GetGridHeight メソッドは，GridHeight プロパティ用の Protected メソッドです。

function GetGridHeight: Integer;

説明

GetGridHeight メソッドは，行の高さ，セパレータ幅，コントロールサイズを基に GridHeight プロパティの値を計算します。


TCustomGrid.GetGridWidth
TCustomGrid.GetGridWidth3097055

TCustomGrid	参照

GetGridWidth メソッドは，GridWidth プロパティ用の Protected メソッドです。

function GetGridWidth: Integer;

説明

GetGridWidth メソッドは，列幅，セパレータ幅，コントロールサイズを基に GridWidth プロパティの値を計算します。


TCustomGrid.HideEditor
TCustomGrid.HideEditor3097056

TCustomGrid	参照

HideEditor メソッドは，使用されていないインプレースエディタを隠します。

procedure HideEditor;

説明

HideEditor メソッドは，グリッドが編集モードを抜けたときにグリッドコントロールによって呼び出されます。このメソッドはインプレースエディタのウィンドウを隠します。


TCustomGrid.InvalidateCell
TCustomGrid.InvalidateCell3097057

TCustomGrid	参照

InvalidateCell メソッドは，セルが占める領域を無効にして，次の Windows 描画メッセージで再描画されるようにします。

procedure InvalidateCell(ACol, ARow: Longint);

説明

InvalidateCell メソッドは，セルの内容が変化したとき呼び出され，セルを再描画するようにします。ACol パラメータはセルの列インデックス，ARow パラメータは行インデックスです。


TCustomGrid.InvalidateCol
TCustomGrid.InvalidateCol3097058

TCustomGrid	参照

InvalidateCol メソッドは，列が占める領域を無効にして，次の Windows 描画メッセージで再描画されるようにします。

procedure InvalidateCol(ACol: Longint);

説明

InvalidateCol メソッドは列の内容が変化したとき呼び出され，列が占める領域を再描画するようにします。ACol パラメータは列インデックスです。


TCustomGrid.InvalidateEditor
TCustomGrid.InvalidateEditor3097059

TCustomGrid	参照

InvalidateEditor メソッドは，インプレースエディタが自分を再描画し，必要であれば新しい場所に移動するようにします。

procedure InvalidateEditor;

説明

InvalidateEditor メソッドは，グリッドが編集モードにある間，選択されたセルが変化したときに呼び出されます。


TCustomGrid.InvalidateRow
TCustomGrid.InvalidateRow3097060

TCustomGrid	参照

InvalidateRow メソッドは，行が占めている領域を無効にして，次の Windows 描画メッセージで再描画されるようにします。

procedure InvalidateRow(ARow: Longint);

説明

行が変化したとき，Invalidate メソッドを呼び出して，その行が占める領域を再描画するようにします。ARow パラメータは行インデックスです。


TCustomGrid.KeyDown
TCustomGrid.KeyDown3097061

TCustomGrid	参照

KeyDown メソッドは，キーが押されたときの特定の処理を指定します。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

procedure KeyDown(var Key: Word; Shift: TShiftState); override;

説明

OnKeyDown イベント発生後，KeyDown メソッドは，CanGridAcceptKey メソッドを呼び出して問題のあるキー組み合わせを排除します。KeyDown メソッドは，キー組み合わせの変化に応じて適当なセルに移動します。また，〔F2〕キーが押されると EditorMode プロパティを True に設定します。


TCustomGrid.KeyPress
TCustomGrid.KeyPress3097062

TCustomGrid	参照

KeyPress メソッドは，キーが押されたときの特別の処理を指定します。

procedure KeyPress(var Key: Char); override;

説明

OnKeyPress イベント発生後，KeyPress メソッドは〔Enter〕キーが押されると EditorMode プロパティの値を交互に切り替えます。KeyPress が呼び出されるのは，KeyDown メソッドの後で，かつキーが離される前です。


TCustomGrid.MouseCoord
TCustomGrid.MouseCoord3097063

TCustomGrid	参照

MouseCoord メソッドは，画面座標値によって指定された点を含むセルの行/列インデックスを返します。

TGridCoord = record

    X: Longint;

    Y: Longint;

  end;

function MouseCoord(X, Y: Integer): TGridCoord;

説明

MouseCoord を呼び出すと，指定された画面座標値を含むセルの行/列がわかります。通常，マウスの下にあるセルの位置がわかります。


TCustomGrid.MouseDown
TCustomGrid.MouseDown3097064

TCustomGrid	参照

MouseDown メソッドは，マウスボタンが離されたときの特定の処理を指定します。

procedure MouseDown(Button: TMouseButton; Shift: TShiftState; X, Y: Integer); override;

説明

MouseDown メソッドは，マウスクリックを受け取ったセルに選択を移動できるようにするためエディタウィンドウを隠します。行や列の移動またはサイズ変更を開始できるホット領域にマウスがあると，MouseDown は移動処理やサイズ変更処理を開始し，カーソルを変えることによって現在処理中であることを視覚的に示します。エディタウィンドウが隠れている場合，エディタウィンドウは処理後の新しい場所に表示されます。最後に OnMouseDown イベントを生成します。


TCustomGrid.MouseMove
TCustomGrid.MouseMove3097065

TCustomGrid	参照

MouseMove メソッドは，マウスが移動されたときの特定の処理を指定します。

procedure MouseMove(Shift: TShiftState; X, Y: Integer); override;

説明

グリッドが行や列を移動またはサイズ変更している場合，あるいはマウスを使ってある範囲のセルを選択している場合，MouseMove メソッドはマウス移動の変化量を計算し，現在処理中であることを視覚的に示します。最後に OnMouseMove イベントを生成します。


TCustomGrid.MouseUp
TCustomGrid.MouseUp3097066

TCustomGrid	参照

MouseUp メソッドは，マウスボタンが離されたときの特定の処理を指定します。

procedure MouseUp(Button: TMouseButton; Shift: TShiftState; X, Y: Integer); override;

説明

MouseUp メソッドは，行や列に対する移動処理やサイズ変更処理を完了します。あるいはユーザーがマウスを使ってある範囲のセルを選択しているのであれば，MouseUp はその選択処理を完了します。最後に，このメソッドは OnMouseUp イベントを生成します。


TCustomGrid.MoveColRow
TCustomGrid.MoveColRow3097067

TCustomGrid	参照

MoveColRow メソッドは，ACol パラメータと ARow パラメータで指定されたセルを選択します。

procedure MoveColRow(ACol, ARow: Longint; MoveAnchor, Show: Boolean);

説明

グリッドコントロールは，選択された 1 つまたは複数のセルを変更するとき，内部的に MoveColRow メソッドを呼び出します。MoveColRow は指定されたセルを選択しますが，そのセルがそれまで選択されていたかどうかは考慮しません。

ACol パラメータと ARow パラメータは，選択するセルの列インデックスと行インデックスを示します。MoveAnchor パラメータは，新しいセルが，選択された領域の左上隅になるかどうかを指定します。複数セルの選択領域を拡張したとき MoveColRow メソッドを呼ばない場合，MoveAnchor は True となります。Show パラメータは，MoveRow メソッドの処理によって，新しく選択されるセルが表示されるかどうかを指定します。


TCustomGrid.MoveColumn
TCustomGrid.MoveColumn3097068

TCustomGrid	参照

MoveColumn メソッドは，列を新しい位置に移動します。

procedure MoveColumn(FromIndex, ToIndex: Longint);

説明

MoveColumn メソッドを呼び出すと，FromIndex パラメータで指定された列が ToIndex パラメータで指定された位置に移動します。


TCustomGrid.MoveRow
TCustomGrid.MoveRow3097069

TCustomGrid	参照

MoveRow メソッドは，行を新しい位置に移動します。

procedure MoveRow(FromIndex, ToIndex: Longint);

説明

MoveRow メソッドを呼び出すと，FromIndex パラメータで指定された行が ToIndex パラメータで指定された位置に移動します。


TCustomGrid.Paint
TCustomGrid.Paint3097070

TCustomGrid	参照

Paint メソッドは，グリッドコントロールのイメージを描画します。

procedure Paint; override;

説明

Paint メソッドは，グリッドが Windows 描画メッセージを受け取ったとき呼び出されます。このメソッドはグリッドを描画し，次いで各セルの内容を描画するときに DrawCell メソッドを呼び出します。DefaultDrawing が False の場合，Paint メソッドはセルの背景を描画せず，固定セルに浮き上がった 3 次元効果を与え，さらに選択されたセルにフォーカスがあるときは周囲に長方形を描画します。


TCustomGrid.RowHeightsChanged
TCustomGrid.RowHeightsChanged3097071

TCustomGrid	参照

RowHeightsChanged メソッドは，行の高さが変化したときに応答します。

procedure RowHeightsChanged; dynamic;

説明

RowHeightsChanged メソッドは，行の高さが変化した直後に内部的に呼び出されます。この変化の原因には，RowHeigths プロパティの設定，DefaultRowHeight プロジェクトの設定，行の移動，マウスによる行のサイズ変更などがあります。

RowHeightsChanged メソッドは，スクロールバーを調整したり，インプレースエディタの位置を調整したりすることで，行の新しいサイズや位置に対応します。


TCustomGrid.RowMoved
TCustomGrid.RowMoved3097072

TCustomGrid	参照

RowMoved メソッドは，行の位置が変わったときに応答するメソッドとのインターフェースをとります。

procedure RowMoved(FromIndex, ToIndex: Longint); dynamic;

説明

RowMoved メソッドは，行の位置が変化した直後に内部的に呼び出されます。FromIndex パラメータは変化前のインデックスで，ToIndex パラメータは変化後のインデックスです。TCustomGrid コンポーネントの RowMove メソッドは何も行いません。TCustomGrid コンポーネントから派生するオブジェクトは RowMoved をオーバーライドして，内部調整や OnRowMoved イベントの生成を行います。


TCustomGrid.ScrollData
TCustomGrid.ScrollData3097073

TCustomGrid	参照

ScrollData メソッドは，セルのイメージをスクロールします。

procedure ScrollData(DX, DY: Integer);

説明

グリッドコントロールは，固定されていない行や列がスクロールしたときに内部的に ScrollData メソッドを呼び出します。ScrollData はグリッドのイメージを更新します。


TCustomGrid.SelectCell
TCustomGrid.SelectCell3097074

TCustomGrid	参照

SelectCell メソッドは，指定されたセルを選択できるかどうかを示します。

function SelectCell(ACol, ARow: Longint): Boolean; virtual;

説明

グリッドコントロールは SelectCell メソッドを内部的に呼び出してから，ACol パラメータと ARow パラメータで指定されたセルを選択しようとします。ACol と ARow はセルの列インデックスと行インデックスで，最初の列がインデックス 0，最上部の行がインデックス 0 となります。

TCustomGrid コンポーネントの SelectedCell メソッドは常に True を返し，指定されたセルは選択できることになります。TCustomGrid コンポーネントから派生するオブジェクトはこのメソッドをオーバーライドして，セル内に表示された情報のプロパティをチェックしたり，OnSelectCell イベントを生成したりします。


TCustomGrid.SetEditText
TCustomGrid.SetEditText3097075

TCustomGrid	参照

SetEditText メソッドは，セルのテキストを更新するメソッドとのインターフェースを提供します。

procedure SetEditText(ACol, ARow: Longint; const Value: string); dynamic;

説明

SetEditText メソッドは，グリッドが現在のセルに新しい値を格納できるようにインプレースエディタから呼び出されます。TCustomGrid コンポーネントの SetEditText メソッドは何も処理しません。TCustomGrid コンポーネントから派生するオブジェクトはこのメソッドをオーバーライドして，セルの値の内部表現を更新したり，OnSetEditText イベントを生成したりします。


TCustomGrid.ShowEditor
TCustomGrid.ShowEditor3097076

TCustomGrid	参照

ShowEditor メソッドは，グリッドが編集モードに入ったときインプレースエディタを表示します。

procedure ShowEditor;

説明

グリッドコントロールは，グリッドが編集モードに入ったとき ShowEditor メソッドを呼び出します。このメソッドは現在選択されているセルの上にインプレースエディタのウィンドウを表示します。まだインプレースエディタが存在しないときは ShowEditor が作成します。


TCustomGrid.ShowEditorChar
TCustomGrid.ShowEditorChar3097077

TCustomGrid	参照

ShowEditorChar メソッドは，インプレースエディタを表示し，与えられた文字をテキストに設定します。

procedure ShowEditorChar(Ch: Char);

説明

グリッドコントロールは，ユーザーが文字をセルに入力したが，まだエディタが表示されていないとき，ShowEditorChar メソッドを呼び出します。このメソッドは，現在選択されているセルの上にインプレースエディタのウィンドウを表示し，テキストプロパティに文字 Ch を設定します。インプレースエディタがまだ存在しないときは ShowEditorChar が作成します。


TCustomGrid.SizeChanged
TCustomGrid.SizeChanged3097078

TCustomGrid	参照

SizeChanged メソッドは，グリッドのサイズ変更に応答します。

procedure SizeChanged(OldColCount, OldRowCount: Longint); dynamic;

説明

SizeChanged メソッドは，グリッド内の行や列の数の変化に対応するメソッドとインターフェースをとります。TCustomGrid コンポーネントの SizeChanged メソッドは何も行いません。TCustomGrid から派生するオブジェクトはこのメソッドをオーバーライドして内部調整やイベントの生成を行います。


TCustomGrid.Sizing
TCustomGrid.Sizing3097079

TCustomGrid	参照

Sizing メソッドは，指定された座標値がグラフのサイズ変更ホットゾーンにあるかどうかを示します。

function Sizing(X, Y: Integer): Boolean;

説明

グリッドコントロールは，ユーザーが行や列のサイズを変更しようとしているかどうかを知るために，Sizing メソッドを内部的に呼び出してマウスクリックの位置を調べます。


TCustomGrid.TimedScroll
TCustomGrid.TimedScroll3097080

TCustomGrid	参照

TimedScroll メソッドは，グリッドがスクロールした方向にマウスがドラッグされたとき，移動，サイズ変更，または選択の処理をスクロール可能な領域の外にまで拡張して行います。

TGridScrollDirection = set of (sdLeft, sdRight, sdUp, sdDown);

procedure TimedScroll(Direction: TGridScrollDirection); dynamic;

説明

TimedScroll メソッドは，ユーザーがマウスを使ってスクロール可能なセル外へのドラッグを続けている間，一定の時間をおいて呼び出されます。ユーザーがマウスを使って行や列の移動，サイズ変更，または複数セル領域の選択を行っているのでない場合は，このメソッドは何も行いません。このメソッドは，スクロールのせいで隠れてしまった部分も処理できるようにセルをスクロールします。


TCustomGrid.TopLeftChanged
TCustomGrid.TopLeftChanged3097081

TCustomGrid	参照

TopLeftChanged メソッドは，グリッドがスクロールしたときインプレースエディタの位置を更新します。

procedure TopLeftChanged; dynamic;

説明

グリッドコントロールは，LeftCol プロパティまたは TopRow プロパティが変化するたびに TopLeftChanged メソッドを内部的に呼び出します。

TCustomGrid コンポーネントから派生するオブジェクトは TopLeftChanged をオーバーライドして，追加調整や OnTopLeftChange イベントの生成を行います。


TCustomGrid.UpdateDesigner
TCustomGrid.UpdateDesigner3097082

TCustomGrid	参照

UpdateDesigner メソッドは，行と列が移動したり，そのサイズが変わったとき，それを設計者に通知します。

procedure UpdateDesigner;

説明

設計時にデザイナは，グリッドが変化したときにその内容を保存するかどうかをユーザーに確認できるように，自動的にプロパティを追跡します。マウスを使った行と列の移動やサイズ変更にはこれは適用されません。変更が加えられた場合，UpdateDesigner メソッドは，グリッドのプロパティが変化したこと，およびその変化を保存すべきであることをデザイナに通知してこの問題を解決します。


スコープ3097083

protected

published

読み出し／書き込み

読み出し専用


スコープ3097084

protected


継承3097085

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl


TCustomGrid 例3097086

TCustomGrid


TCustomHotKey
TCustomHotKey3098001

継承	プロパティ	メソッド

TCustomHotKey は，Windows ホットキーコモンコントロールのラッパーであるホットキーオブジェクトの抽象基本クラス型です。

ユニット

comctrls

説明

動作をカプセル化する抽象クラスです。ホットキーオブジェクトは，ユーザーが実行するキーストロークの組み合わせをホットキーにリンクすることですばやく実行できます。TCustomHotKey は以下の処理を行うプロパティを導入します。

・	動作を実行するキーストロークにホットキーを関連付ける

・	設計時にキーの組み合わせを選択する

・	特定の修飾キーを無効にする

実行時にキーの組み合わせを変更するには，〔Alt〕キー，〔Ctrl〕キー，〔Shift〕キーのいずれか 1 つまたはいくつかを同時に押したまま，文字または数字のキーを押します。変更後，ホットキープロパティをメニュー項目などのショートカットプロパティに割り当てることができます。

TCustomHotKey から派生するホットキークラスは TCustomHotKey の基本機能を継承します。独自のホットキーオブジェクトを作成したい場合は，TCustomHotKey を基本クラスとして使って，特殊なホットキーオブジェクトを派生させます。


TCustomHotKey プロパティ3098002

TCustomHotKey	アルファベット順	凡例

TCustomHotKey

AutoSize

HotKey

InvalidKeys

Modifiers

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomHotKey プロパティ3098003

TCustomHotKey	オブジェクト順	凡例

Align

AutoSize

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

HotKey

InvalidKeys

Left

Modifiers

Name

Owner

Parent

ParentWindow

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TCustomHotKey.AutoSize
TCustomHotKey.AutoSize3098004

TCustomHotKey

AutoSize プロパティは，フォントサイズに合わせてホットキーの高さを自動的に変更するかどうかを指定します。

property AutoSize: Boolean;

説明

AutoSize プロパティは，ホットキーコントロール上にフォントを完全に表示できます。AutoSize が True ならば，ホットキー内に入力されたキーの組み合わせを表示できるようにホットキーの高さが変更されます。AutoSize が False ならば，フォントが変更されてもホットキーの高さは変更されません。デフォルト値は True です。


TCustomHotKey.HotKey
TCustomHotKey.HotKey3098005

TCustomHotKey	参照

HotKey プロパティは，ホットキーコントロールの現在のキーの組み合わせを保持します。

TShortCut = Low(Word) .. High(Word);

property HotKey: TShortCut;

説明

HotKey プロパティを使うと，ホットキーに関連付けられているキーの組み合わせを設定または変更できます。〔Alt〕+〔A〕キーがデフォルトです。HotKey プロパティの値を変更するには，このプロパティを直接編集するか，Modifiers プロパティの値を設定します。実行時にホットキーにフォーカスが設定された状態でユーザーが有効なキーの組み合わせを押すと，HotKey プロパティは再設定されます。


TCustomHotKey.InvalidKeys
TCustomHotKey.InvalidKeys3098006

TCustomHotKey	参照

InvalidKeys プロパティは，ユーザーが 1 つまたは複数の修飾キーを無効とみなすよう指定できます。

THKInvalidKey = (hcNone, hcShift, hcCtrl, hcAlt, hcShiftCtrl, hcShiftAlt, hcCtrlAlt, hcShiftCtrlAlt);

THKInvalidKeys = set of THKInvalidKey;

property InvalidKeys: THKInvalidKeys;

説明

InvalidKeys プロパティは，どの修飾キーを無効にするかを選択できます。このプロパティを設定する場合は Modifiers プロパティでデフォルトの修飾子も指定しなければなりません。無効なキーを選択すると，そのキーのかわりにデフォルト修飾子が表示されます。

THKInvalidKey は InvalidKeys プロパティの型です。次の値があります。

値	意味

hcNone	修飾解除キーは無効である

hcShift	〔Shift〕キーは修飾子として無効である

hcCtrl	〔Ctrl〕キーは修飾子として無効である

hcAlt	〔Alt〕キーは修飾子として無効である

hcShiftCtrl	〔Shift〕+〔Ctrl〕のキーの組み合わせは修飾子として無効である

hcShiftAlt	〔Shift〕+〔Alt〕のキーの組み合わせは修飾子として無効である

hcCtrlAlt	〔Ctrl〕+〔Alt〕のキーの組み合わせは修飾子として無効である

hcShiftCtrlAlt	〔Shift〕+〔Ctrl〕+〔Alt〕のキーの組み合わせは修飾子として無効である

デフォルト値は hcNone と hcShift です。


TCustomHotKey.Modifiers
TCustomHotKey.Modifiers3098007

TCustomHotKey

Modifiers プロパティは，非修飾キーと組み合わせて使う 1 つまたは複数のキーを指定します。

THKModifier = (hkShift, hkCtrl, hkAlt, hkExt);

THKModifiers = set of THKModifier;

property Modifiers: THKModifiers;

説明

Modifiers プロパティは，〔Ctrl〕，〔Alt〕，〔Shift〕キーなどの修飾キーをホットキーに選択できます。次の値があります。

値	意味

hkShift	〔Shift〕キーを修飾キーとして使う

hkCtrl	〔Ctrl〕キーを修飾キーとして使う

hkAlt	〔Alt〕キーを修飾キーとして使う

hkExt	〔Extra〕キーを修飾キーとして使う

デフォルト値は hkAlt です。

修飾キーはそれ以外のキー，たとえば文字キーやファンクションキー，矢印キーなどと組み合わせて使います。複数の修飾キーを使ってもかまいません。


TCustomHotKey メソッド3098008

TCustomHotKey	アルファベット順

TCustomHotKey

Create

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomHotKey メソッド3098009

TCustomHotKey	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TCustomHotKey.Create
TCustomHotKey.Create3098010

TCustomHotKey	参照

Create メソッドは，ホットキーコントロールをインスタンス化します。

constructor Create (AOwner:TComponent); override;

説明

Create メソッドを呼び出すと，実行時にホットキーコントロールをインスタンス化できます。設計時に作成したホットキーコントロールの場合，Create は自動的に呼び出されます。

Create メソッドはホットキーコントロールにメモリを割り当て，継承された Create メソッドを呼び出します。その後，Width および Height プロパティにデフォルト値を設定し，以下のプロパティを初期化します。

・	TabStop は True

・	ParentColor は False

・	AutoSize は True

・	InvalidKeys は hcNone と hcShift

・	Modifiers は [hkAlt]

・	HotKey は 'Alt+A'


スコープ3098011

protected

published

読み出し／書き込み

読み出し専用


継承3098012

TObject

TPersistent

TComponent

TControl

TWinControl


TCustomHotKey 例3098013

TCustomHotKey


TCustomImageList
TCustomImageList3099001

継承	プロパティ	メソッド	イベント	参照

TCustomImageList は同じサイズのイメージのコレクションを提供する抽象クラスです。それぞれのイメージはインデックスで参照できます。

ユニット

controls

説明

イメージリストは，アイコンまたはビットマップの大きなセットを効果的に管理するのに使います。イメージリスト内のすべてのイメージは，画面デバイスフォーマットで 1 つの大きなビットマップに格納されます。イメージリストには，画像を透過に描画する（アイコンスタイル）のに使用するマスクを含むモノクロのビットマップがあることもあります。


TCustomImageList プロパティ3099002

TCustomImageList	アルファベット順	凡例

TCustomImageList

AllocBy

BkColor

BlendColor

Count

DragCursor

Dragging

DrawingStyle

Handle

Height

ImageType

Masked

ShareImages

Width

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TCustomImageList プロパティ3099003

TCustomImageList	オブジェクト順	凡例

AllocBy

BkColor

BlendColor

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Count

DesignInfo

DragCursor

Dragging

DrawingStyle

Handle

Height

ImageType

Masked

Name

Owner

ShareImages

Tag

VCLComObject

Width


TCustomImageList.AllocBy
TCustomImageList.AllocBy3099004

TCustomImageList	参照

AllocBy プロパティは，新しいイメージを収容するための収容領域サイズを変更するときに，イメージリストのイメージ数をいくつ増やすかを設定します。

property AllocBy: Integer;

説明

AllocBy メソッドは，サイズを変更したイメージリストに追加できる新しいイメージの数を指定できます。


TCustomImageList.BkColor
TCustomImageList.BkColor3099005

TCustomImageList	参照

BkColor プロパティは，イメージを描画するときに使う背景色を決めます。

property BkColor: TColor;

説明

BKColor に clNone を指定すると，背景色がなくなります。つまり，イメージは透過に描画されます。BKColor に clDefault を指定すると，描画時にイメージリストの背景色が使われます。


TCustomImageList.BlendColor
TCustomImageList.BlendColor3099006

TCustomImageList	参照

BlendColor プロパティは，イメージを描画するときに使う前景色を決めます。

property BlendColor: TColor;

説明

clNone を指定すると，色は混合されません。clDefault を指定すると，前景色にはシステムの強調表示の色が使われます。


TCustomImageList.Count
TCustomImageList.Count3099007

TCustomImageList	参照

Count プロパティは，イメージリスト内のイメージの数を返します。

property Count: Integer;

説明

Count プロパティは，イメージリスト内を循環するときに利用できます。


TCustomImageList.DragCursor
TCustomImageList.DragCursor3099008

TCustomImageList	参照

DragCursor プロパティは，イメージリストに関連付けられている現在のドラッグカーソルを指定します。

property DragCursor: TCursor;

説明

DragCursor プロパティは，イメージリスト内のイメージをドラッグしたときに表示されるドラッグカーソルを指定できます。イメージをドラッグするとき，指定したイメージ（一般にマウスカーソルイメージ）を現在のドラッグカーソルに結び付けて新しいドラッグイメージが作成されます。


TCustomImageList.Dragging
TCustomImageList.Dragging3099009

TCustomImageList	参照

Dragging プロパティは，イメージリスト内のイメージがドラッグ中かどうかを取得できます。

property Dragging: Boolean;

説明

Dragging プロパティが True ならば，イメージリスト内のイメージはドラッグ中です。Dragging が False ならば，イメージはドラッグされていません。


TCustomImageList.DrawingStyle
TCustomImageList.DrawingStyle3099010

TCustomImageList	参照

DrawingStyle プロパティは，イメージリストがイメージを描画するときに使うスタイルを指定します。

TDrawingStyle = (dsFocus, dsSelected, dsNormal, dsTransparent);

property DrawingStyle: TDrawingStyle;

説明

DrawingStyle プロパティは，イメージの表示方法を指定できます。指定できる値は次のとおりです。

値	意味

dsFocused	システム強調表示色の 25% を混ぜ合わせてイメージを描画する。これはマスクを含むイメージリストにだけ影響する

dsSelected	システム強調表示色の 50% を混ぜ合わせてイメージを描画する。これはマスクを含むイメージリストにだけ影響する

dsNormal	BkColor プロパティに指定した色を使ってイメージを描画する。BkColor が clNone の場合，イメージはマスクを使って透過に描画される

dsTransparent	BkColor の設定に関係なく，マスクを使って描画する


TCustomImageList.Handle
TCustomImageList.Handle3099011

TCustomImageList	参照

Handle プロパティは，イメージリストのハンドルを指定します。

property Handle;

説明

Handle プロパティは，Windows が管理するイメージリストオブジェクトハンドルを必要とする Windows API 関数を呼び出すとき，そのハンドルにアクセスできます。


TCustomImageList.Height
TCustomImageList.Height3099012

TCustomImageList	参照

Height プロパティは，イメージリスト内のイメージの高さを指定します。

property Height: Integer;

説明

Height プロパティは，イメージリストに追加する前にイメージの高さを指定できます。この値を変更すると，イメージリストのイメージはクリアされます。


TCustomImageList.ImageType
TCustomImageList.ImageType3099013

TCustomImageList	参照

ImageType プロパティは，描画のときにイメージリストがイメージを使うのか，それとも関連したマスクイメージを使うのかを決めます。

property ImageType: TImageType;

説明

ImageType プロパティは，イメージの表示方法を制御できます。次の値があります。

値	意味

itImage	イメージを描画する

itMask	マスクイメージを描画する


TCustomImageList.Masked
TCustomImageList.Masked3099014

TCustomImageList	参照

Masked プロパティは，イメージリストに透過イメージ入れるか，透過イメージ以外のイメージを入れるかを決めます。

property Masked: Boolean;

説明

Masked プロパティを True に設定すると，イメージに透過領域が含まれるようになります。


TCustomImageList.ShareImages
TCustomImageList.ShareImages3099015

TCustomImageList	参照

ShareImages プロパティは，イメージリストが破棄されるときにイメージリストがそのハンドルを破棄するかどうかを決めます。

property ShareImages: Boolean;

説明

ShareImages プロパティを False に設定すると，イメージのハンドルはイメージリストが破棄されるときに解放されます。


TCustomImageList.Width
TCustomImageList.Width3099016

TCustomImageList	参照

Width プロパティは，イメージリスト内のイメージの幅を設定します。

property Width: Integer;

説明

Width プロパティは，イメージリストに追加する前にイメージの幅を指定できます。この値を変えるとイメージリストがクリアされます。


TCustomImageList イベント3099017

TCustomImageList	アルファベット順	凡例

TCustomImageList

OnChange


TCustomImageList イベント3099018

TCustomImageList	オブジェクト順	凡例

OnChange


TCustomImageList.OnChange
TCustomImageList.OnChange3099019

TCustomImageList	参照

OnChange イベントは，イメージリストを変更したときに呼び出されます。

property OnChange: TNotifyEvent;

説明

OnChange イベントは，イメージリストを変更したときになんらかのコードが実行されるようにすることができます。RegisterChanges メソッドで登録したオブジェクトにも通知される点に注意してください。


TCustomImageList メソッド3099020

TCustomImageList	アルファベット順	凡例

TCustomImageList

Add

AddIcon

AddImages

AddMasked

Assign

BeginDrag

Change

Clear

Create

CreateSize

DefineProperties

Delete

Destroy

DragLock

DragMove

DragUnlock

Draw

DrawOverlay

EndDrag

FileLoad

GetBitmap

GetHotSpot

GetIcon

GetImageBitmap

GetImages

GetInstRes

GetMaskBitmap

GetResource

HandleAllocated

HandleNeeded

HideDragImage

Initialize

Insert

InsertIcon

InsertMasked

Move

Overlay

RegisterChanges

Replace

ReplaceIcon

ReplaceMasked

ResInstLoad

ResourceLoad

SetDragImage

ShowDragImage

UnRegisterChanges

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomImageList メソッド3099021

TCustomImageList	オブジェクト順	凡例

Add

AddIcon

AddImages

AddMasked

Assign

BeginDrag

Change

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

CreateSize

DefaultHandler

DefineProperties

Delete

Destroy

DestroyComponents

Destroying

Dispatch

DragLock

DragMove

DragUnlock

Draw

DrawOverlay

EndDrag

FieldAddress

FileLoad

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetBitmap

GetHotSpot

GetIcon

GetImageBitmap

GetImages

GetInstRes

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetMaskBitmap

GetNamePath

GetParentComponent

GetResource

HandleAllocated

HandleNeeded

HasParent

HideDragImage

InheritsFrom

Initialize

InitInstance

Insert

InsertComponent

InsertIcon

InsertMasked

InstanceSize

MethodAddress

MethodName

Move

NewInstance

Overlay

RegisterChanges

RemoveComponent

Replace

ReplaceIcon

ReplaceMasked

ResInstLoad

ResourceLoad

SafeCallException

SetDragImage

ShowDragImage

UnRegisterChanges


TCustomImageList.Add
TCustomImageList.Add3099022

TCustomImageList	参照

Add メソッドは，イメージとそのマスクをイメージリストオブジェクトに追加します。Add は追加したイメージのインデックスを返します。

function Add(Image, Mask: TBitmap): Integer;

説明

Add メソッドは，イメージとそのマスクをイメージリストに追加できます。イメージリストの Masked プロパティが False の場合は，2 つめのビットマップハンドルは無視されます。このハンドルは nil に設定することもできます。成功すると，Add は -1 を返します。失敗すると 0 を返します。


TCustomImageList.AddIcon
TCustomImageList.AddIcon3099023

TCustomImageList	参照

AddIcon メソッドは，Image で指定したアイコンをイメージリストオブジェクトに追加します。AddIcon は追加したイメージのインデックスを返します。

function AddIcon(Image: TIcon): Integer;

説明

AddIcon メソッドは，イメージリストにアイコンを追加できます。失敗すると，AddIcon は -1 を返します。成功すると 0 を返します。


TCustomImageList.AddImages
TCustomImageList.AddImages3099024

TCustomImageList	参照

AddImages メソッドは，Value で指定した別のイメージリストのイメージをイメージリストオブジェクトに追加します。

procedure AddImages(Value: TCustomImageList);

説明

AddImages メソッドは，別のイメージリストのイメージを追加できます。失敗すると，AddImages は -1 を返します。成功すると 0 を返します。


TCustomImageList.AddMasked
TCustomImageList.AddMasked3099025

TCustomImageList	参照

AddMasked メソッドは，どの色を透過色とみなすかを MaskColor に指定して，イメージをイメージリストに追加します。

function AddMasked(Image: TBitmap; MaskColor: TColor): Integer;

説明

AddMasked は Add と似ていますが，マスクビットマップが指定されない点が異なります。かわりに，マスクを自動生成するためにシステムがイメージビットマップに結び付けた色が指定されます。指定した色のイメージビットマップ内の各ピクセルは黒に変更され，マスク内の対応するビットは 1 に設定されます。その結果として，指定した色に一致するイメージ内の各ピクセルは，イメージが描画されるときに透過になります。失敗すると，AddMasked は -1 を返します。成功すると 0 を返します。


TCustomImageList.Assign
TCustomImageList.Assign3099026

TCustomImageList	参照

Assign メソッドは，イメージリストの情報を別のイメージリストにコピーします。

procedure Assign(Source: TPersistent);

説明

Source が TImageList オブジェクトの場合，Assign は現在のイメージ情報を破棄し，Source の情報に置き換えます。Source がそれ以外のオブジェクト型の場合，Assign はそのオブジェクトが継承したメソッドを呼び出します。別のオブジェクトの情報をコピーするには，このメソッドを使います。


TCustomImageList.BeginDrag
TCustomImageList.BeginDrag3099027

TCustomImageList	参照

BeginDrag メソッドは，イメージのドラッグを開始します。

function BeginDrag(Window: HWND; X, Y: Integer): Boolean;

説明

BeginDrag メソッドは，SetDragImage で指定したイメージの，イメージの左上隅からの相対距離を示す X，Y 座標へのドラッグを開始します。Window はイメージリストのハンドルです。イメージのドラッグの開始が成功すると，BeginDrag は True を返します。


TCustomImageList.Change
TCustomImageList.Change3099028

TCustomImageList	参照

Change メソッドは，イメージリストと RegisterChanges で登録されているオブジェクトにイメージリスト内の変更を通知します。

procedure change;

説明

Change メソッドは，変更を通知するようにイメージリストとイメージリストに登録されているオブジェクトの OnChange イベントを発生できます。


TCustomImageList.Clear
TCustomImageList.Clear3099029

TCustomImageList	参照

Clear メソッドは，イメージリストからすべてのイメージを削除します。

procedure Clear;

説明

Clear メソッドは，イメージリストのすべてのイメージを削除します。イメージリストから 1 つのイメージを削除する場合は Delete メソッドを使います。


TCustomImageList.Create
TCustomImageList.Create3099030

TCustomImageList	参照

Create コンストラクタは，空のイメージリストを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create コンストラクタは，デフォルトの画像サイズ（16×16 ピクセル）で，AOwner で指定したコンポーネントの子コンポーネントとしてイメージリストを作成します。


TCustomImageList.CreateSize
TCustomImageList.CreateSize3099031

TCustomImageList	参照

CreateSize コンストラクタは，指定したサイズで TImageList オブジェクトを作成します。

constructor CreateSize(AWidth, AHeight: Integer);

説明

CreateSize コンストラクタは，デフォルトの 16×16 ピクセル以外のイメージサイズでイメージリストオブジェクトを作成します。イメージリストの初期値は AHeight パラメータと AWidth パラメータで指定します。Width プロパティと Height プロパティを使ってイメージリストを作成した後で，高さと幅を変更できます。


TCustomImageList.DefineProperties
TCustomImageList.DefineProperties3099032

TCustomImageList	参照

DefineProperties メソッドは，継承した DefineProperties メソッドを呼び出し，ファイラによって格納されるビットマップデータを定義します。

procedure DefineProperties(Filer: TFiler)override;

説明

DefineProperties メソッドは継承した DefineProperties メソッドを呼び出し，また TFiler.DefineBinaryProperty メソッドを呼び出します。このメソッドはファイラオブジェクトが格納するバイナリデータを定義します。


TCustomImageList.Delete
TCustomImageList.Delete3099033

TCustomImageList	参照

Delete メソッドは，イメージリストから特定のイメージを削除します。

procedure Delete(Index: Integer);

説明

Delete メソッドは，Index で指定したイメージリスト内のイメージを削除します。Clear メソッドは，イメージリスト内のすべてのイメージを削除する場合に使用します。


TCustomImageList.Destroy
TCustomImageList.Destroy3099034

TCustomImageList	参照

Destroy メソッドは，イメージリストを破棄し，割り当てていたメモリを解放します。

destructor Destroy;

説明

Destroy メソッドは，Free を呼び出す前に，まず UnRegisterChanges を呼び出して，イメージリストが変更されたときに通知を受け取るように登録されているオブジェクトの登録を解除し，イメージリストに関連付けられているすべての TChangeLink および TBitMap オブジェクトを解放します。

Destroy を呼び出す必要はほとんどありません。Delphi で設計したオブジェクトは必要に応じて自動的に作成および破棄されます。イメージリストを Create メソッドか CreateSize メソッドを呼び出して作成した場合は，Free を呼び出してメモリを解放し，オブジェクトを破棄する必要があります。Free メソッドは ポインタが nil かどうか確認してから Destroy メソッドを呼び出します。


TCustomImageList.DragLock
TCustomImageList.DragLock3099035

TCustomImageList	参照

DragLock メソッドは，ウィンドウがドラッグモードのとき，ドラッグイメージを Window ハンドルに関連付け，パラメータ XPos と YPos で指定した位置にドラッグイメージを描画します。正常に終了した場合は True を返します。

function DragLock(Window: HWND; XPos, YPos: Integer): Boolean;

説明

DragLock メソッドを呼び出すと，特定のウィンドウをドラッグするときにイメージリスト内のイメージをドラッグイメージとして使用できます。


TCustomImageList.DragMove
TCustomImageList.DragMove3099036

TCustomImageList	参照

DragMove メソッドは，SetDragImage で設定したドラッグイメージを X と Y で指定した新しい位置まで移動します。ただし，X と Y はそのドラッグイメージに現在関連付けられているウィンドウ内の座標で，そのウィンドウはドラッグモードでなければなりません。正常に終了した場合は True を返します。

function DragMove(X, Y: Integer): Boolean;

説明

DragMove メソッドを呼び出すと，ドラッグアンドドロップ操作中にドラッグ中のイメージを移動できます。


TCustomImageList.DragUnlock
TCustomImageList.DragUnlock3099037

TCustomImageList	参照

DragUnlock メソッドは，ドラッグイメージとウィンドウとの関連付けを解除します。

procedure DragUnlock;

説明

DragUnlock メソッドは，特定のウィンドウのドラッグイメージが不要になったときに使います。


TCustomImageList.Draw
TCustomImageList.Draw3099038

TCustomImageList	参照

Draw メソッドは，指定した Canvas の位置（X，Y）に Index パラメータで指定したイメージを描画します。イメージは DrawingStyle プロパティに設定したスタイルに従って描画されます。

procedure Draw(Canvas: TCanvas; X, Y, Index: Integer);

説明

Draw メソッドは，イメージを描画します。

例

次のコードは各ヘッダーセクションを描画し，タイトル用のテキストと ImageList1 に格納されているアイコンを追加します。イメージリストにはヘッダーセクションと同じ数のアイコンが入っていなければなりません。

procedure TForm1.HeaderControl1DrawSection(HeaderControl: THeaderControl;

  Section: THeaderSection; const Rect: TRect; Pressed: Boolean);

begin

  with HeaderControl1.Canvas do

  begin

    Brush.Color := clRed;

    FillRect(Rect);

    Font.Color := clYellow;

    TextOut(Rect.left + 30, Rect.top + 2, 'Header Control');

    ImageList1.Draw(HeaderControl1.Canvas,Rect.Left,Rect.Top,Section.Index);

  end;

end;


TCustomImageList.DrawOverlay
TCustomImageList.DrawOverlay3099039

TCustomImageList	参照

DrawOverlay メソッドは，指定した Canvas にイメージとオーバーレイを描画します。

procedure DrawOverlay(Canvas: TCanvas; X, Y: Integer; ImageIndex: Integer; Overlay: TOverlay);

説明

オーバーレイマスクは，別のイメージの上に透過的に描画されるイメージです。どのようなイメージでもオーバーレイマスクとして使用できます。イメージの上にオーバーレイマスクを描画するには，オーバーレイマスクのインデックスを指定して DrawOverlay メソッドを使います。オーバーレイとしてイメージを使えるようにするには，最初にイメージに Overlay メソッドを呼び出さなければなりません。


TCustomImageList.EndDrag
TCustomImageList.EndDrag3099040

TCustomImageList	参照

EndDrag メソッドは，ドラッグ動作を中止します。成功すると，EndDrag は True を返します。

function EndDrag: Boolean;

説明

BeginDrag を呼び出した後で EndDrag でドラッグ動作を中止できます。


TCustomImageList.FileLoad
TCustomImageList.FileLoad3099041

TCustomImageList	参照

FileLoad メソッドは，TResType 型のファイルをイメージリストの中にロードします。MaskColor を使ってファイル内のイメージの透過色を設定します。Name はロードするファイルを指定します。

function FileLoad(ResType: TResType; Name: string; MaskColor: TColor): Boolean;

説明

FileLoad メソッドは，ビットマップ，カーソル，またはアイコンファイルをイメージリスト内にロードします。成功すると，FileLoad は True を返します。


TCustomImageList.GetBitmap
TCustomImageList.GetBitmap3099042

TCustomImageList	参照

GetBitmap メソッドは，Image パラメータに Index パラメータで指定したイメージをビットマップとして返します。

procedure GetBitmap(Index: Integer; Image: TBitmap);

説明

GetBitmap メソッドは，イメージリスト内のイメージをビットマップオブジェクトとして取得します。


TCustomImageList.GetHotSpot
TCustomImageList.GetHotSpot3099043

TCustomImageList	参照

GetHotSpot メソッドは，現在のドラッグイメージに関連付けられているホットスポットを返します。

function GetHotSpot: TPoint;

説明

GetHotSpot メソッドは，現在のドラッグイメージのホットスポットの位置を取得します。


TCustomImageList.GetIcon
TCustomImageList.GetIcon3099044

TCustomImageList	参照

GetIcon メソッドは，Index で指定したイメージを，Image パラメータにアイコンとして返します。

procedure GetIcon(Index: Integer; Image: TIcon);

説明

GetIcon メソッドは，イメージリスト内の特定のイメージをアイコンとして取得します。


TCustomImageList.GetImageBitmap
TCustomImageList.GetImageBitmap3099046

TCustomImageList	参照

GetImageBitmap メソッドは，イメージリスト内のすべてのイメージが入っているビットマップへのハンドルを返します。

function GetImageBitmap: HBITMAP;

説明

GetImageBitmap メソッドは，イメージリスト内のすべてのイメージが入っているビットマップを取得します。失敗すると，GetImageBitmap は 0 を返します。


TCustomImageList.GetImages
TCustomImageList.GetImages3099047

TCustomImageList	参照

GetImages メソッドは，Index パラメータで指定したイメージとマスクを Image パラメータおよび Mask パラメータにビットマップとして返します。

procedure GetImages(Index: Integer; Image, Mask: TBitmap);

説明

GetImages メソッドは，イメージとそのマスクをビットマップとして取得します。


TCustomImageList.GetInstRes
TCustomImageList.GetInstRes3099045

TCustomImageList	参照

GetInstRes メソッドは，指定したビットマップ，カーソルまたはアイコンリソースをイメージリストの中にロードします。

function GetInstRes(Instance:THandle; ResType: TResType; Name: string; Width: Integer; LoadFlags: TLoadResources; MaskColor: TColor):

説明

GetInstRes メソッドは，Name で指定したビットマップ，カーソルまたはアイコンリソースをイメージリストの中にロードします。

注意

パッケージ内からリソースをロードするのには，GetInstRes メソッドを呼び出す必要があります。パッケージ内では，GetResouce メソッドはエラーを返します。

ResTypes はイメージリストにロードするグラフィックリソースの種類（rtBitmap，rtCursor，rtIcon）を指定します。MaskColor は，ファイルのイメージに透明色を設定するのに使います。LoadFlags はイメージのロード方法を指定します。以下の値を組み合わせて指定できます。

値	意味

lrNone	特定のリソースフラグなし

lrDefaultColor	ディスプレイの色形式を使う

lrDefaultSize	GetResource への Width パラメータが 0 ならば Height と Width にシステムメトリックスを使う。Width パラメータが 0 でこのオプションをカーソルとアイコン用に指定しなかった場合，リソースの幅と高さが使われる

lrFromFile	指定したファイルからリソースをロードする

lrMap3DColors	イメージの灰色の陰影を 3 次元ウィンドウカラーに置き換える

lrTransparent	リソースの第 1 ピクセルのカラーテーブルエントリをデフォルトのウィンドウカラー（COLOR_WINDOW）で置き換える。これはカラーテーブルを持つイメージだけに適用される

lrMonoChrome	リソースをモノクロとしてロードする


TCustomImageList.GetMaskBitmap
TCustomImageList.GetMaskBitmap3099048

TCustomImageList	参照

GetMaskBitmap メソッドは，イメージリスト内にあるイメージのすべてのマスクが入っているビットマップへのハンドルを返します。

function GetMaskBitmap: HBITMAP;

説明

GetMaskBitmap は，イメージリスト内にあるすべてのマスクが入っているビットマップを取得します。失敗すると，GetMaskBitmap は 0 を返します。


TCustomImageList.GetResource
TCustomImageList.GetResource3099049

TCustomImageList	参照

GetResource メソッドは，指定したビットマップ，カーソル，またはアイコンリソースをイメージリストの中へロードします。

TLoadResource = (lrDefaultColor, lrDefaultSize, lrFromFile, lrMap3DColors, lrTransparent, lrMonoChrome);

TLoadResources = Set of TLoadResource;

function GetResource(ResType: TResType; Name: string; Width: Integer; LoadFlags: TLoadResources; MaskColor: TColor): Boolean;

説明

GetResource メソッドは，Name で指定したビットマップ，カーソル，またはアイコンリソースをイメージリストの中へロードします。

注意

パッケージ内では，GetResouce メソッドはエラーを返します。パッケージ内からリソースをロードするには，GetInstRes メソッドを呼び出す必要があります。

ResTypes はイメージリストにロードするグラフィックリソースの種類（rtBitmap，rtCursor，rtIcon）を指定します。MaskColor は，ファイルのイメージに透明色を設定するのに使います。LoadFlags はイメージのロード方法を指定します。以下の値を組み合わせて指定できます。

値	意味

lrNone 	リソースフラグなし

lrDefaultColor	ディスプレイの色形式を使う

lrDefaultSize	GetResource への Width パラメータが 0 ならば Height と Width にシステムメトリックスを使う。Width パラメータが 0 でこのオプションをカーソルとアイコン用に指定しなかった場合，リソースの幅と高さが使われる

lrFromFile	指定したファイルからリソースをロードする

lrMap3DColors	イメージの灰色の陰影を 3 次元ウィンドウカラーに置き換える

lrTransparent	リソースの第 1 ピクセルのカラーテーブルエントリをデフォルトのウィンドウカラー（COLOR_WINDOW）で置き換える。これはカラーテーブルを持つイメージだけに適用される

lrMonoChrome	リソースをモノクロとしてロードする


TCustomImageList.HandleAllocated
TCustomImageList.HandleAllocated3099050

TCustomImageList	参照

HandleAllocated メソッドは，コントロールのウィンドウハンドルが存在するならば True を返します。ウィンドウハンドルが存在しなければ False を返します。

function HandleAllocated: Boolean;

説明

HandleAllocated メソッドは，コントロールのハンドルが存在するかどうかを判定できます。HandleAllocated は，ハンドルがまだ存在していない場合はハンドルを作成しません。コントロールの Handle プロパティを直接呼び出すと，ハンドルが存在していなければ自動的にハンドルが作成されます。


TCustomImageList.HandleNeeded
TCustomImageList.HandleNeeded3099051

TCustomImageList	参照

HandleNeeded メソッドは，イメージリストにイメージリストハンドルがなければハンドルを作成します。

procedure HandleNeeded;

説明

HandleNeeded メソッドは，イメージリストにイメージリストハンドルがなければハンドルを作成します。このメソッドは，イメージリストのハンドルプロパティにアクセスすると自動的に呼び出されます。


TCustomImageList.HideDragImage
TCustomImageList.HideDragImage3099052

TCustomImageList	参照

HideDragImage メソッドは，現在のドラッグイメージが以前に表示されていた場合，そのイメージを隠します。

procedure HideDragImage;

説明

HideDragImage メソッドは，現在のドラッグイメージを隠します。


TCustomImageList.Initialize
TCustomImageList.Initialize3099053

TCustomImageList	参照

Initialize メソッドは，イメージリストの多数のプロパティをデフォルト値に設定し，イメージリストに内部で使用されるオブジェクトのインスタンスを作成します。

procedure Initialize;

説明

Initialize はイメージリストの Create および CreateSize コンストラクタから呼び出されます。


TCustomImageList.Insert
TCustomImageList.Insert3099054

TCustomImageList	参照

Insert メソッドは，ビットマップとそのマスクをイメージリスト内の Index で指定したイメージの後に挿入します。

procedure Insert(Index: Integer; Image, Mask: TBitmap);

説明

Insert メソッドは，ビットマップとそのマスクをイメージリストに挿入します。


TCustomImageList.InsertIcon
TCustomImageList.InsertIcon3099055

TCustomImageList	参照

InsertIcon メソッドは，イメージリスト内の Index + 1 の位置にアイコンを挿入します。

procedure InsertIcon(Index: Integer; Image: TIcon);

説明

InsertIcon メソッドは，アイコンをイメージリストに挿入します。


TCustomImageList.InsertMasked
TCustomImageList.InsertMasked3099056

TCustomImageList	参照

InsertMasked メソッドは，Index + 1 の位置にビットマップを挿入し，MaskColor パラメータで指定した透過色からマスクイメージを作成します。

procedure InsertMasked(Index: Integer; Image: TBitmap; MaskColor: TColor);

説明

InsertMasked メソッドは，マスクイメージをイメージリストに挿入します。


TCustomImageList.Move
TCustomImageList.Move3099057

TCustomImageList	参照

Move メソッドは，イメージリスト内の CurIndex で指定したイメージをイメージリスト内の NewIndex で指定した別の位置まで移動します。

procedure Move(CurIndex, NewIndex: Integer);

説明

Move メソッドは，イメージをイメージリスト内の別の位置に移動します。


TCustomImageList.Overlay
TCustomImageList.Overlay3099058

TCustomImageList	参照

Overlay メソッドは，イメージのインデックスを，オーバーレイマスクとして使うイメージのリストに追加します。リストに追加できるインデックスの数は 4 つまでです。

TOverlay = 0..3;

function Overlay(ImageIndex: Integer; Overlay: TOverlay): Boolean;

説明

オーバーレイマスクは，別のイメージの上に透過的に描画されるイメージです。どのようなイメージでもオーバーレイマスクとして使用できます。イメージの上にオーバーレイマスクを描画するには，オーバーレイマスクのインデックスを指定して DrawOverlay メソッドを使います。成功すると，Overlay は True を返します。


TCustomImageList.RegisterChanges
TCustomImageList.RegisterChanges3099059

TCustomImageList	参照

RegisterChanges メソッドは，イメージリストに変更があったときに通知を受け取るオブジェクトを登録します。

procedure RegisterChanges(Value: TChangeLink);

説明

RegisterChanges メソッドは，イメージリストに変更があったときにオブジェクトに通知されるように設定します。TChangeLink の OnChange イベントは ImageList に変更があったときに必ず呼び出されます。

変更を通知する各オブジェクトに対して変更リンクオブジェクトを作成します。オブジェクトを登録するには，Value パラメータとしてオブジェクトの変更リンクオブジェクトを渡して RegisterChanges を呼び出します。イメージリストが変更されると，登録されているすべての変更リンクオブジェクトの OnChange イベントが発生します。OnChange イベントハンドラに割り当てられているコードがあれば実行されます。


TCustomImageList.Replace
TCustomImageList.Replace3099060

TCustomImageList	参照

Replace メソッドは，イメージリスト内のイメージを新しいイメージとマスクに置き換えます。

procedure Replace(Index: Integer; Image, Mask: TBitmap);

説明

Replace メソッドは，イメージリスト内の Index 位置にあるイメージを新しい Image のイメージと Mask のオーバーレイマスクに置き換えます。


TCustomImageList.ReplaceIcon
TCustomImageList.ReplaceIcon3099061

TCustomImageList	参照

ReplaceIcon メソッドは，イメージリスト内のイメージを新しいアイコンに置き換えます。

procedure ReplaceIcon(Index: Integer; Image: TIcon);

説明

ReplaceIcon メソッドは，イメージリスト内の Index 位置にある Image を新しいアイコンに置き換えます。


TCustomImageList.ReplaceMasked
TCustomImageList.ReplaceMasked3099062

TCustomImageList	参照

ReplaceMasked メソッドは，イメージリスト内のイメージを新しいイメージとマスクに置き換えます。

procedure ReplaceMasked(Index: Integer; NewImage: TBitmap; MaskColor: TColor);

説明

ReplaceMasked メソッドは，イメージリスト内の Index 位置にあるイメージを，新しいイメージと MaskColor を使って作成した透過マスクに置き換えます。


TCustomImageList.ResInstLoad
TCustomImageList.ResInstLoad3099063

TCustomImageList	参照

ResInstLoad メソッドは，リソースをイメージリストの中にロードします。

function ResInstLoad(Instance: THandle; ResType: TResType; Name: string; MaskColor: TColor): Boolean;

説明

ResInstLoad メソッドは，TResType 型のリソースをイメージリストの中にロードできます。MaskColor は結果のイメージ用にマスクを作成するために使います。パッケージ内からリソースをロードするのには，ResouceLoad メソッドのかわりに ResInstLoad メソッドを使う必要があります。


TCustomImageList.ResourceLoad
TCustomImageList.ResourceLoad3099064

TCustomImageList	参照

ResourceLoad メソッドは，リソースをイメージリストの中にロードします。

function ResourceLoad(ResType: TResType; Name: string; MaskColor: TColor): Boolean;

説明

ResourceLoad メソッドは，TResType 型のリソースをイメージリストの中にロードできます。MaskColor は結果のイメージ用にマスクを作成するために使います。

注意

パッケージ内では，ResouceLoad メソッドはエラーを返します。パッケージ内からリソースをロードするのには，ResInstLoad メソッドを使う必要があります。


TCustomImageList.SetDragImage
TCustomImageList.SetDragImage3099065

TCustomImageList	参照

SetDragImage メソッドは，イメージリスト内のイメージがドラッグアンドドロップで表示されるように設定します。

function SetDragImage(Index, HotSpotX, HotSpotY: Integer): Boolean;

説明

SetDragImage メソッドは，ドラッグアンドドロップでそのイメージリストが使用されるときにイメージリスト内の Index で指定したイメージが表示されるように設定します。イメージのホットスポットは HotSpotX と HotSpotY で指定します。


TCustomImageList.ShowDragImage
TCustomImageList.ShowDragImage3099066

TCustomImageList	参照

ShowDragImage メソッドは，現在のドラッグイメージが非表示になっている場合に，そのイメージを表示します。

procedure ShowDragImage;

説明

ShowDragImage メソッドは，現在のドラッグイメージが非表示になっている場合に，そのイメージを表示します。


TCustomImageList.UnRegisterChanges
TCustomImageList.UnRegisterChanges3099067

TCustomImageList	参照

UnRegisterChanges メソッドは，イメージリストに変更があったときに通知するオブジェクトのリストからオブジェクトを削除します。

procedure UnRegisterChanges(Value: TChangeLink);

説明

UnRegisterChanges メソッドは，TChangeLink オブジェクトを登録解除します。登録を解除したオブジェクトは，イメージリストに変更があっても通知を受け取らなくなります。


スコープ3099068

protected

published

読み出し／書き込み

読み出し専用


スコープ3099069

protected


スコープ3099070

protected


継承3099071

TObject

TPersistent

TComponent


TCustomImageList 例3099072

TCustomImageList


TCustomLabel
TCustomLabel3100001

継承	プロパティ	メソッド	参照

TCustomLabel コンポーネントは，フォーム上にテキストを表示する非ウィンドウコントロールの基本クラスです。

ユニット

stdctrls

説明

TCustomLabel は，ユーザーによる編集ができないテキストを表示するオブジェクトを定義するときの基本クラスとして使います。このオブジェクトは，テキストの外観を制御するいくつかの新しいプロパティとメソッドを提供します。TCustomLabel は TWinControl の下位オブジェクトではないので，自身のウィンドウがなく，キーボードから入力を直接受け取ることはできません。テキストを表示することに加えて，キーボードからの直接入力に応答するオブジェクトを定義するには，TCustomStaticText を基本クラスとして使います。

TCustomLabel のインスタンスは作成しないでください。フォーム上にラベルを配置するには，TLabel オブジェクトを使います。


TCustomLabel プロパティ3100002

TCustomLabel	アルファベット順	凡例

TCustomLabel

Alignment

AutoSize

FocusControl

Layout

ShowAccelChar

Transparent

WordWrap

TGraphicControl からの継承

Canvas

TControl からの継承

Align

BoundsRect

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomLabel プロパティ3100003

TCustomLabel	オブジェクト順	凡例

Align

Alignment

AutoSize

BoundsRect

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

FocusControl

Height

Hint

Layout

Left

Name

Owner

Parent

ShowAccelChar

ShowHint

Tag

Top

Transparent

VCLComObject

Visible

Width

WindowProc

WordWrap


TCustomLabel.Alignment
TCustomLabel.Alignment3100004

TCustomLabel	参照

Alignment プロパティは，ラベル内でのテキストの横方向の配置を制御します。

TAlignment = (taLeftJustify, taRightJustify, taCenter);

 property Alignment: TAlignment;

説明

Alignment プロパティを設定すると，ラベルコントロールの ClientRect 内でラベルのテキストを揃える方法を指定できます。Alignment では次の値を指定できます。

値	意味

taLeftJustify	テキストはラベルの左端に揃えられる

taRightJustify	テキストはラベルの右端に揃えられる

taCenter	テキストはラベル内の横方向の中央に揃えられる

WordWrap プロパティが True で，ラベルのテキストが複数行に渡っている場合は，Alignment プロパティの効果がより鮮明になります。


TCustomLabel.AutoSize
TCustomLabel.AutoSize3100005

TCustomLabel	参照

AutoSize プロパティは，テキストに合わせてラベルのサイズを自動的に変更するかどうかを指定します。

property AutoSize: Boolean;

説明

AutoSize を使うと，現在の高さと幅のテキストがクライアント領域に収まるようにラベルのサイズを自動的に調整できます。AutoSize が False の場合，ラベルのサイズは固定値になります。AutoSize が True の場合，テキストを変更するたびにラベルのサイズが再調整されます。また，Font プロパティを変更したときにもラベルのサイズは再調整されます。

WordWrap が True の場合，ラベルの幅は固定値になります。このとき，AutoSize も True の場合には，テキストを変更するとラベルの高さだけが変更されます。AutoSize が True で WordWrap が False の場合，ラベルの高さはフォントによって決定され，テキストを変更するとラベルの幅だけが変更されます。


TCustomLabel.FocusControl
TCustomLabel.FocusControl3100006

TCustomLabel	参照

FocusControl プロパティは，ラベルに関連付けられたウィンドウコントロールです。

property FocusControl: TWinControl;

説明

FocusControl には，ユーザーがラベルで指定されるアクセラレータキーを押したときにフォーカスを受け取るウィンドウコントロールを設定します。アクセラレータキーを指定するには，ラベルテキストの文字の前にアンド記号（&）を追加して，ShowAccelChar プロパティを True に設定します。


TCustomLabel.Layout
TCustomLabel.Layout3100007

TCustomLabel	参照

Layout プロパティは，ラベル内でのテキストの縦方向の配置を指定します。

TTextLayout = (tlTop, tlCenter, tlBottom);

property Layout: TTextLayout;

説明

Layout プロパティを設定すると，ラベルコントロールの ClientRect 内でラベルのテキストを揃える方法を指定できます。Layout では次の値を指定できます。

値	意味

tlTop	テキストはラベルの上端に表示される

tlCenter	テキストはラベル内の縦方向の中央に表示される

tlBottom	テキストはラベルの下端に表示される


TCustomLabel.ShowAccelChar
TCustomLabel.ShowAccelChar3100008

TCustomLabel	参照

ShowAccelChar プロパティは，ラベルテキスト内にあるアンド記号（&）の表示方法を決めます。

property ShowAccelChar: Boolean;

説明

ShowAccelChar を True に設定すると，ラベル内にアクセラレータキーを表す下線付きの文字が表示されます。ShowAccelChar が True の場合，アンド記号（&）の右側の文字が下線付きで表示されます。FocusControl プロパティが設定されている場合，ユーザーがこの下線付きの文字を入力すると，FocusControl プロパティで指定されるウィンドウコントロールが入力フォーカス受け取ります。ShowAccelChar が True のときにアンド記号を表示するには，2 個のアンド記号（&&）を使って，1 個のアンド記号を表示することを指定します。

ShowAccelChar を False に設定すると，ラベルテキスト内のアンド記号はそのままアンド記号として表示されます。ShowAccelChar が False の場合，FocusControl プロパティの値は使用されません。


TCustomLabel.Transparent
TCustomLabel.Transparent3100009

TCustomLabel	参照

Transparent プロパティは，フォーム上でラベルの下にあるコントロールがラベルから透けて見えるようにするかどうかを指定します。

property Transparent: Boolean;

説明

Transparent プロパティを True に設定すると，ラベルによってフォーム上のほかのコントロールが隠れることはありません。たとえば，ラベルを使ってグラフィックにテキストを追加した場合，Transparent を True に設定すると，ラベルは独立したオブジェクトとしては表示されません。

背景が透過になるようにテキストを書き込むと，Transparent が False のときにテキストを書き込む場合より時間がかかります。また，複雑なイメージを処理する場合，ラベルがイメージを隠していないときは，ラベルの背景色をその下にあるオブジェクトと一致させ，Transparent をFalse に設定することで処理効率を改善できます。


TCustomLabel.WordWrap
TCustomLabel.WordWrap3100010

TCustomLabel	参照

WordWrap プロパティは，ラベルテキストがラベルの幅より長い場合にテキストを改行するかどうかを指定します。

property WordWrap: Boolean;

説明

WordWrap を True に設定すると，ラベルに複数行のテキストを表示できます。WordWrap が True の場合，ラベルコントロールの幅より長いテキストは右マージンで改行され，折り返されたテキストは 2 行目以降に移行します。

WordWrap を False に設定すると，ラベルテキストは 1 行だけで表示されます。WordWrap が False の場合，ラベルの幅を越えたテキストは切り捨てられます。


TCustomLabel メソッド3100011

TCustomLabel	アルファベット順	凡例

TCustomLabel

Create

GetLabelText

Notification

Paint

SetAutoSize

TGraphicControl からの継承

Destroy

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Invalidate

Perform

Refresh

Repaint

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomLabel メソッド3100012

TCustomLabel	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DragDrop

Dragging

EndDrag

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetLabelText

GetNamePath

GetParentComponent

GetTextBuf

GetTextLen

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Notification

Paint

Perform

Refresh

RemoveComponent

Repaint

SafeCallException

ScreenToClient

SendToBack

SetAutoSize

SetBounds

SetTextBuf

Show

Update


TCustomLabel.Create
TCustomLabel.Create3100013

TCustomLabel	参照

Create メソッドは，TCustomLabel のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出すと，実行時に TCustomLabel のインスタンスを作成できます。設計時にフォーム上に配置されたラベルは自動的に作成されます。

Create メソッドは継承コンストラクタを呼び出した後，次のプロパティを初期化します。

・	AutoSize は True

・	ShowAccelChar は True

・	ControlStyle は [csOpaque，csReplicatable]


TCustomLabel.GetLabelText
TCustomLabel.GetLabelText3100014

TCustomLabel	参照

GetLabelText メソッドは，Caption プロパティの値を返します。

function GetLabelText: string; virtual;

説明

GetLabelText を呼び出すと，ラベルのテキストとして表示される文字列を取得できます。GetLabelText はプロテクトメソッドとして定義されているので，派生オブジェクトはこのメソッドをオーバーライドして Caption プロパティの値以外のテキストを表示できます。


TCustomLabel.Notification
TCustomLabel.Notification3100016

TCustomLabel	参照

Notification メソッドは，FocusControl プロパティが参照するウィンドウコントロールが破棄されたときにこのプロパティを更新します。

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

Notification は，コンポーネントが作成または破棄されると自動的に呼び出されます。Notification は継承されたメソッドを呼び出した後，FocusControl プロパティで指定されるウィンドウコントロールが破棄されようとしているかどうかを確認します。ウィンドウコントロールの破棄が進んでいる場合，Notification は FocusControl プロパティを nil に設定します。


TCustomLabel.Paint
TCustomLabel.Paint3100017

TCustomLabel	参照

Paint メソッドはラベルのイメージを描画します。

procedure Paint; override;

説明

Paint は，ラベルがその親から WM_PAINT メッセージを受け取ると自動的に呼び出されます。Paint は，GetLabelText メソッドによって返されるテキストを書き込みます。


TCustomLabel.SetAutoSize
TCustomLabel.SetAutoSize3100018

TCustomLabel	参照

SetAutoSize メソッドは AutoSize プロパティを設定します。

procedure SetAutoSize(Value: Boolean); virtual;

説明

SetAutoSize は AutoSize プロパティ用のアクセスメソッドです。SetAutoSize はプロテクトメソッドとして定義されているため，下位オブジェクトはこのメソッドをオーバーライドして AutoSize プロパティの実現方法を変更できます。


スコープ3100019

protected

published

読み出し／書き込み

読み出し専用


スコープ3100020

protected


継承3100021

TObject

TPersistent

TComponent

TControl

TGraphicControl


TCustomLabel 例3100022

TCustomLabel


TCustomListBox
TCustomListBox3101001

継承	プロパティ	メソッド	イベント	参照

TCustomListBox は，Windows リストボックスコントロールのラッパーであるリストボックスオブジェクトの抽象基本クラス型です。

ユニット

stdctrls

説明

TCustomListBox は，Delphi のすべてのリストボックスコントロールに共通な動作をカプセル化した抽象クラスです。リストボックスオブジェクトは，ユーザーが 1 つまたは複数の項目を選択できるスクロール可能なリストを表示します。リストボックスコントロールを使うと，ユーザーが選択できる項目を，リスト内の項目に制限することができます。項目は，設計時または実行時に追加することもできます。

リストボックスのラッパーとして，TCustomListBox は次のような処理を行うメソッドを実装しています。

・	リスト内の項目の表示，ソート，選択，操作，問い合わせ

・	アイコンやビットマップなどのグラフィックイメージを表示できる，オーナー描画スタイルリストボックスの作成

・	複数列および複数選択リストの作成

TCustomListBox は，デフォルトでは項目をテキスト文字列として表示する標準リストボックスです。これらの項目は TStrings オブジェクトに格納され，TStrings オブジェクトのオブジェクトを使って，文字列の追加，挿入，削除を行います。次のコードは，リストボックスへの新しい文字列の追加の例です。

MyListBox.Items.Add(�New item�);

TCustomListBox の派生オブジェクトであるリストボックスは，TCustomListBoxの基本的な機能を継承します。また，一部の派生オブジェクトは，特殊な機能を持ち，ファイル，ディレクトリ，ドライブまたはデータベース情報へ簡単にアクセスおよびリストできます。

コンボボックスは，編集コントロールと，リストの選択ドロップダウンスタイルを持つリストボックスです。コンボボックスを使うと，ユーザーが編集ボックス内に選択内容を入力でき，またリストをドロップダウンさせることによりフォーム上のスペースを節約することもできます。

マトリクスまたは展開可能なツリー構造を必要とする項目のリストの場合は，アウトライン，リストビュー，またはツリービューを使います。これらのコントロールを使うと，項目をグループ化して，列見出しの下や，展開および収縮が可能な行に表示することができます。

注意

カスタマイズされたリストボックスオブジェクトを作成したい場合は，特殊なリストボックスオブジェクトを派生させるための基本クラスとして TCustomListBox を利用できます。


TCustomListBox プロパティ3101002

TCustomListBox	アルファベット順	凡例

TCustomListBox

BorderStyle

Canvas

Columns

ExtendedSelect

IntegralHeight

ItemHeight

ItemIndex

Items

MultiSelect

SelCount

Selected

Sorted

Style

TabWidth

TopIndex

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomListBox プロパティ3101003

TCustomListBox	オブジェクト順	凡例

Align

BorderStyle

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

ExtendedSelect

Handle

Height

HelpContext

Hint

IntegralHeight

ItemHeight

ItemIndex

Items

Left

MultiSelect

Name

Owner

Parent

ParentWindow

SelCount

Selected

ShowHint

Showing

Sorted

Style

TabOrder

TabStop

TabWidth

Tag

Top

TopIndex

VCLComObject

Visible

Width

WindowProc


TCustomListBox.BorderStyle
TCustomListBox.BorderStyle3101004

TCustomListBox	参照

BorderStyle プロパティは，リストボックスに境界を付けるかどうかを指定します。

type TBorderStyle = bsNone..bsSingle;

property BorderStyle: TBorderStyle;

説明

BorderStyle プロパティを使うと，リストボックスコントロールの外側の境界線の外観を変更できます。リストボックスには，一重の境界か非可視境界を付けることができます。BorderStyle プロパティの型である TBorderStyle には，次の値を指定できます。

値	意味

bsNone	非可視境界

bsSingle	一重境界線


TCustomListBox.Canvas
TCustomListBox.Canvas3101005

TCustomListBox	参照

Canvas プロパティは，オーナー描画リストボックスの OnDrawItem イベントのハンドラを実現するときに使用する描画面へのアクセスを提供します。

property Canvas: TCanvas;

説明

Canvas プロパティは，リストボックス項目の描画を制御するアプリケーション，つまりオーナー描画リストボックスに対してのみ意味を持ちます。Canvas プロパティは，リストボックス内の項目として使用できるグラフィックイメージを描画するのに使用します。

デフォルトでは，TControlCanvas オブジェクトはリストボックスコンストラクタでCanvas プロパティに対して作成されます。キャンバスを使用するオーナー描画リストボックスを作成するには，Style プロパティを適切な値に設定する必要があります。

例

次のコードは ListBox1 の Items リストの Objects プロパティに格納されたグラフィックを描画します。このコードは ListBox1 の OnDrawItem イベントハンドラにアタッチされていなくてはなりません。

procedure TForm1.ListBox1DrawItem(Control: TWinControl; Index: Integer;

Rect: TRect; State: TOwnerDrawState);

var

SourceRect: TRect;

begin

SourceRect.Top := 0;

SourceRect.Left := 0;

SourceRect.Bottom := TBitmap(ListBox1.Items.Objects[Index]).Height;

SourceRect.Right := TBitmap(ListBox1.Items.Objects[Index]).Width;

ListBox1.Canvas.CopyRect(Rect, TBitmap(ListBox1.Items.Objects[Index]).Canvas, SourceRect);

end;


TCustomListBox.Columns
TCustomListBox.Columns3101006

TCustomListBox	参照

Columns プロパティは，複数列リストボックス内の，スクロールしなくても表示できる列数を指定します。

property Columns: Integer;

説明

Columns プロパティを使うと，複数列リストボックス内で，水平スクロールバーを使用せずに表示できる列数を指定できます。

複数列リストボックスには，隠れている列を表示するのにユーザーが使う水平スクロールバーが付いています。Columns のデフォルト値は 0 で，この場合，リストボックスは複数列にはなりません。つまり，ユーザーは垂直方向にのみスクロールできます。

Columns に 1 以上の値を設定した場合は，項目が複数の列に表示され，水平スクロールバーで水平方向にスクロールできるようになります。Columns プロパティは，リストボックスを水平方向にスクロールすることなく表示される列数を指定します。

各列の幅は Width プロパティ と Columns で指定した列数によって異なります。


TCustomListBox.ExtendedSelect
TCustomListBox.ExtendedSelect3101007

TCustomListBox	参照

ExtendedSelect プロパティは，リストボックスで項目を範囲で選択できるかどうかを指定します。

property ExtendedSelect: Boolean;

説明

ExtendedSelect プロパティは MultiSelect プロパティと連動します。MultiSelect が True で ExtendedSelect が True ならば，ユーザーは項目を 1 つ選択してから〔Shift〕キーを押して別の項目を選択することで 2 つの項目の間のすべての項目を選択できます。2 番目の項目を選択中に〔Shift〕キーまたは〔Ctrl〕キーを押していないと，最初に選択した項目は選択解除されます。つまり連続していない複数の項目を選択するには〔Ctrl〕キーを使い，項目を連続範囲で選択するには〔Shift〕キーを使わなくてはなりません。

ExtendedSelect が False で MultiSelect が True ならば，〔Shift〕キーまたは〔Ctrl〕キーを使わずに複数の項目を選択できますが，1 回の操作で複数項目を選択することはできません。

MultiSelect が False ならば，リストボックスで一度に 1 つの項目しか選択できないので，ExtendedSelect の設定は無効です。


TCustomListBox.IntegralHeight
TCustomListBox.IntegralHeight3101008

TCustomListBox	参照

IntegralHeight プロパティは，リストボックスに項目の一部だけを表示するかどうかを指定します。

property IntegralHeight: Boolean;

説明

IntegralHeight プロパティはリストボックス自身の高さを制御します。

IntegralHeight が True で Style プロパティが lsOwnerDrawFixed ならば，リストボックスの高さは常に ItemHeight プロパティの値の倍数になります。この場合リストボックス内の項目が部分的に表示されることはありません。

IntegralHeight が False ならば，リストボックスの高さはどのような値にも設定できますが，リストの最後の項目は完全に表示されないことがあります。

リストボックスの Style プロパティ値が lbOwerDrawVariable ならば，IntegralHeight プロパティを True に設定しても無効です。


TCustomListBox.ItemHeight
TCustomListBox.ItemHeight3101009

TCustomListBox	参照

ItemHeight プロパティは，オーナー描画リストボックス内の項目の高さをピクセル数で指定します。

property ItemHeight: Integer;

説明

ItemHeight プロパティを使うと，Style プロパティが lsOwnerDrawFixed であればリストボックスの項目の高さを制御できます。また，ItemHeight プロパティはリストボックスの高さにも影響します。IntegralHeight プロパティ が True ならば，リストボックスの高さは常に ItemHeight 値の増分になります。

Style プロパティが lsStandard または lsOwnerDrawVariable ならば，ItemHeight 値は無視されます。


TCustomListBox.ItemIndex
TCustomListBox.ItemIndex3101010

TCustomListBox	参照

ItemIndex プロパティは，リストボックスの項目リスト内で選択した項目の順番を表す数です。

property ItemIndex: Integer;

説明

ItemIndex プロパティを使うと，実行時に項目を選択できます。ItemIndex の値を選択する項目のインデックスに設定します。リストボックス内の最初の項目の ItemIndex 値は 0 です。項目を選択しないと値は -1 です。MultiSelect が True の場合を除きデフォルト値は -1 です。

MultiSelect プロパティが True ならば，ユーザーはリストボックスで複数の項目を選択できます。この場合，ItemIndex 値はフォーカスを持つ選択項目のインデックスになります。MultiSelect が True ならば，ItemIndex のデフォルト値は 0 です。


TCustomListBox.Items
TCustomListBox.Items3101011

TCustomListBox	参照

Items プロパティには，リストボックスに表示する文字列が含まれます。

property Items: TStrings;

説明

Items プロパティを使うと，項目の追加，挿入，削除，移動ができます。デフォルトでは，リストボックス内の項目は TStrings 型のオブジェクトです。TString 型のメソッドまたはプロパティにアクセスし，リスト内の項目に操作を加えます。たとえば，次のコードは，項目として編集ボックスの文字列をリストボックスに追加します。

  ListBox1.Items.Add(Edit1.Text);


TCustomListBox.MultiSelect
TCustomListBox.MultiSelect3101012

TCustomListBox	参照

MultiSelect プロパティは，リストボックスで一度に複数の要素を選択できるかどうかを指定します。

property MultiSelect: Boolean;

説明

MultiSelect プロパティが True ならば，ユーザーは複数の項目を選択できます。MultiSelect が False ならばリストボックスで項目を複数選択することはできません。

MultiSelect では，ユーザーは連続していない複数の項目を選択できますが，ExtendedSelect プロパティのように 1 回の操作で項目を範囲で選択することはできません。

MultiSelect が True の場合に複数の項目を選択したときは，Selected の項目のインデックスを示す ItemIndex プロパティの値はフォーカスがある選択項目のインデックスになります。


TCustomListBox.SelCount
TCustomListBox.SelCount3101013

TCustomListBox	参照

SelCount プロパティは，複数選択が可能のとき，リストボックス内で選択された項目の数を報告します。

property SelCount: Integer;

説明

SelCount プロパティは読み出し専用のプロパティです。SelCount プロパティを使うと，MultiSelect プロパティの値が True のとき，リストボックス内で選択された項目の数を調べることができます。

MultiSelect プロパティが False ならば，SelCount の値は常に -1 です。


TCustomListBox.Selected
TCustomListBox.Selected3101014

TCustomListBox	参照

Selected プロパティは，特定の項目がリストボックス内で選択されたかどうかを判別します。

property Selected[Index: Integer]: Boolean;

説明

Selected プロパティを使うと，リストボックス内の特定の項目の状態を問い合わせることができます。 Index パラメータに指定した項目がリストボックス内で選択されていれば，Selected プロパティの値は True です。選択されていなければ False です。

Index パラメータはその項目のリストボックス内の位置で，最初の項目の Index 値は 0 です。

項目はユーザーが強調表示させたときに選択されます。リストボックス内で複数の項目をユーザーが選択できるようにしたい場合は MultiSelect プロパティを True に設定します。その場合，Selected の項目はフォーカスのある項目になります。


TCustomListBox.Sorted
TCustomListBox.Sorted3101015

TCustomListBox	参照

Sorted プロパティは，リストボックスの中の項目をソートするかどうかを示します。

property Sorted: Boolean;

説明

Sorted プロパティを True に設定すると，項目はソートされます。Sorted が Falseなら，項目はソートされません。Sorted が True のときに項目を追加または挿入すると，それらの項目は自動的にソートされて配置されます。


TCustomListBox.Style
TCustomListBox.Style3101016

TCustomListBox	参照

Style プロパティは，リストボックスが標準リストボックスであるか，オーナー描画リストボックスであるかを決めます。

TListBoxStyle = (lbStandard, lbOwnerDrawFixed, lbOwnerDrawVariable);

property Style: TListBoxStyle;

説明

Style プロパティを使うと，リストボックスが，テキスト文字列を表示する標準リストボックスであるか，グラフィックイメージの描画が可能なオーナー描画リストボックスであるかを指定できます。Style プロパティのデフォルト値は lbStandard で，リストボックスは各項目を文字列として表示します。

オーナー描画リストボックスでは，標準的な方法とは異なる方法で項目を表示できます。その場合，ユーザーはコードを記述する必要があります。オーナー描画リストボックスを作成するには，Style の値を lbOwnerDrawFixed または lbOwnerDrawVariable に設定します。Style プロパティの TListBoxStyle 型には次の値を指定できます。

値	意味

lbStandard	すべての項目を同じ高さの文字列にする

lbOwnerDrawFixed	リストボックス内の項目を ItemHeight プロパティで指定した高さにする

lbOwnerDrawVariable	リストボックス内の項目を可変の高さにできる

オーナー描画リストボックスではリスト内の個々の項目のイメージを描画する方法についてアプリケーションが情報を必要とするため，さらに多くのプログラミングが必要になります。

1 つの項目が lbOwnerDrawFixed リストボックスに表示されるたびに，OnDrawItem イベントが発生します。OnDrawItem 用のイベントハンドラは指定された項目を描画します。ItemHeight プロパティはそれぞれの項目の高さを決めます。

1 つの項目が lbOwnerDrawVariable リストボックスに表示されるたびに，2 つのイベントが発生します。最初のイベントは OnMeasureItem イベントです。OnMeasureItem ハンドラ用のコードは個々の項目の高さを設定できます。その後，OnDrawItem イベントが発生します。OnDrawItem ハンドラ用のコードは個々の項目を OnMeasureItem ハンドラで指定されたサイズでリストボックス内に描画します。


TCustomListBox.TabWidth
TCustomListBox.TabWidth3101017

TCustomListBox

TabWidth プロパティは，リストボックス内のタブのサイズを指定します。

property TabWidth: Integer;

説明

TabWidth プロパティを設定すると，リストボックスの文字列で表示される各タブ文字用に表示されるダイアログベース単位の数を制御できます。

TabWidth がデフォルト値の 0 に設定されていると，デフォルトで Windows によって指定される幅に設定されます。この幅は 2 ダイアログベース単位です。


TCustomListBox.TopIndex
TCustomListBox.TopIndex3101018

TCustomListBox	参照

TopIndex プロパティは，リストボックスの最上部に表示される項目のインデックス番号です。

property TopIndex: Integer;

説明

TopIndex プロパティを使うと，リストボックスの最上部に表示される 1 番目の項目を判別または設定できます。TopIndex プロパティを使えば，たとえば，リスト内で先頭項目を別の項目に変更できます。

例

次のコードはフォームの文字列リストを含むリストボックス，ボタン，編集ボックスを使います。ユーザーがアプリケーションを実行し，そのボタンをクリックすると，リストの 3 番目の項目が先頭項目になり，その項目のインデックス値が編集ボックスに表示されます。表示されるインデックス値は 2 で，リストの 3 番目の項目を表します（リストの先頭の項目のインデックス値は 0 です）。

procedure TForm1.FormCreate(Sender: TObject);

var

Number: Integer;

begin

for Number := 1 to 20 do

ListBox1.Items.Add('Item ' + IntToStr(Number));

end;

procedure TForm1.Button1Click(Sender: TObject);

begin

ListBox1.TopIndex := 2;

Edit1.Text := IntToStr(ListBox1.TopIndex);

end;


TCustomListBox イベント3101019

TCustomListBox	アルファベット順	凡例

TCustomListBox

OnDrawItem

OnMeasureItem


TCustomListBox イベント3101020

TCustomListBox	オブジェクト順	凡例

OnDrawItem

OnMeasureItem


TCustomListBox.OnDrawItem
TCustomListBox.OnDrawItem3101021

TCustomListBox	参照

OnDrawItem イベントは，オーナー描画リストボックスの中にある項目を再表示する必要があるときに発生します。

type

TOwnerDrawState = set of (odSelected, odGrayed, odDisabled, odChecked, odFocused);

TDrawItemEvent = procedure(Control: TWinControl; Index: Integer; Rect: TRect; State: TOwnerDrawState) of object;

property OnDrawItem: TDrawItemEvent;

説明

OnDrawItem イベントを使うと，Style 値が lbOwnerDrawFixed または lbOwnerDrawVariable のリストボックス内の項目を描画するイベントハンドラを記述できます。OnDrawItem イベントは，リストボックスで項目の表示が必要になるたびに発生します。OnDrawItem イベントが発生するのは，オーナー描画リストボックスの場合だけです。

OnDrawItem は TDrawItemEvent 型で，描画する項目を記述する次の 4 つのパラメータをハンドラに渡します。

・	Control には，項目が入っているコントロールへの参照を指定する

・	Index はそのコントロール内の項目のインデックスを指定する

・	Rect は描画範囲を示す長方形を指定する

・	State は項目の状態（選択されているか，フォーカスがあるかなど）を指定する

項目を囲む長方形のサイズは，Style が IbOwnerDrawFixed ならば ItemHeight プロパティによって，lbOwnerDrawVariable ならば OnMeasureItem イベントに対する応答によって決まります。

Index パラメータはリストボックス内での項目の位置です。

Rect は項目が描画されるリストボックス内の領域です。Rect パラメータはコントロールキャンバス内での項目の正しい位置を自動的に提供します。

State はリストボックスの項目の現在の状態です。TOwnerDrawState 型は State パラメータにとりうる値を定義します。以下の値を指定できます。

値	意味

odSelected	項目は選択されている

odDisabled	リストボックス全体が使用不可になっている

odFocused	現在，項目にフォーカスがある

例

OnDrawItem イベントの典型的なハンドラを次に示します。このコードでは lbOwnerDrawFixed スタイルを持つリストボックスは個々の文字列の左側にビットマップを描画します。

procedure TForm1.ListBox1DrawItem(Control: TWinControl; Index: Integer;

Rect:TRect;State: TOwnerDrawState);

var

Bitmap: TBitmap;	{ 項目のビットマップ用の一時変数 }

Offset: Integer;	{ テキストのオフセット幅 }

begin

with (Control as TListBox).Canvas do	{ コントロールキャンバス上に描画 }

begin

FillRect(Rect);	{ 長方形をクリア }

Offset := 2;	{ デフォルトのオフセットを指定 }

Bitmap := TBitmap((Control as TListBox).Items.Objects[Index]);
{ この項目のビットマップを取得 }

if Bitmap <> nil then

begin

BrushCopy(Bounds(Rect.Left + 2, Rect.Top, Bitmap.Width,
Bitmap.Height),

Bitmap, Bounds(0, 0, Bitmap.Width, Bitmap.Height), clRed);
{ビットマップを描画 }

Offset := Bitmap.width + 6;	{ ビットマップとテキストの間に 4 ピクセルを
  追加 }

end;

TextOut(Rect.Left + Offset, Rect.Top, (Control as TListBox).Items[Index])	{ テキストを表示 }

end;

end;


TCustomListBox.OnMeasureItem
TCustomListBox.OnMeasureItem3101022

TCustomListBox	参照

OnMeasureItem イベントは，Style プロパティが IbOwnerDrawVariable に設定されているオーナー描画リストボックスに項目を再表示する必要があるときに発生します。

type TMeasureItemEvent = procedure(Control: TWinControl; Index: Integer; var Height: Integer) of object;

property OnMeasureItem: TMeasureItemEvent;

説明

OnMeasureItem イベントを使うと，Style プロパティの値が lbOwnerDrawVariable のリストボックス内の項目の寸法を取得するイベントハンドラを記述できます。

OnMeasureItem は TMeasureItemEvent 型で，寸法を取得する項目を記述する次の 3 つのパラメータがあります。

・	Control は項目が入っているコントロールを指定する

・	Index はコントロール内での項目のインデックスを指定する

・	Height は項目の高さを指定する

Index パラメータはリストボックス内での項目の位置を指定します。

Height パラメータは，コントロール内での指定した項目のピクセル単位の高さです。Height パラメータは var パラメータであり，初期には項目のデフォルトの高さが入っているか，項目のテキストをそのコントロールのフォントで表示した場合の高さが入っています。ハンドラは Height を項目内に表示されるグラフィックイメージの高さなど，項目の内容に適した値に設定できます。

OnMeasureItem イベントが発生した後，OnDrawItem イベントが発生し，取得した寸法で項目が描画されます。

例

OnMeasureItem イベントの典型的なハンドラを次に示します。このコードは可変オーナー描画リストボックスがすでに各文字列に関連したビットマップを持っていると想定しています。このコードでは，項目の高さは関連ビットマップの高さがデフォルトの高さより大きければそのビットマップの高さに設定されます。

procedure TForm1.ListBox1MeasureItem(Control: TWinControl; Index: Integer;

var Height: Integer);

var

Bitmap: TBitmap;

begin

with Control as TListBox do

begin

Bitmap := TBitmap(Items.Objects[Index]);

if Bitmap <> nil then

if Bitmap.Height > Height then Height := Bitmap.Height;

end;

end;


TCustomListBox メソッド3101023

TCustomListBox	アルファベット順	凡例

TCustomListBox

Clear

Create

CreateParams

CreateWnd

DeleteString

Destroy

DestroyWnd

DragCanceled

DrawItem

GetItemData

ItemAtPos

ItemRect

MeasureItem

ResetContent

SetItemData

WndProc

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParrented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomListBox メソッド3101024

TCustomListBox	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParams

CreateParrented

CreateWnd

DefaultHandler

DeleteString

Destroy

DestroyComponents

Destroying

DestroyWnd

DisableAlign

Dispatch

DragCanceled

DragDrop

Dragging

DrawItem

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetItemData

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

ItemAtPos

ItemRect

MeasureItem

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

ResetContent

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetItemData

SetTextBuf

Show

Update

UpdateControlState

WndProc


TCustomListBox.Clear
TCustomListBox.Clear3101025

TCustomListBox	参照

Clear メソッドは，リストボックスのすべての項目を削除します。

procedure Clear;

説明

Clear メソッドを呼び出すと，リストボックスのすべての項目を一度に削除できます。

標準リストボックスの項目はデフォルトでは TStrings 型ですが，Clear メソッドでは，項目の型を参照することなく，すべての項目を削除できます。たとえば，リストボックスの Clear メソッドを使用するコードは，

  ListBox1.Clear;

と記述するだけです（次のコードより簡単です）。

  ListBox1.Items.Clear;

上のコードだけで，項目オブジェクトの Clear メソッドが呼び出されて項目が削除されます。


TCustomListBox.Create
TCustomListBox.Create3101026

TCustomListBox	参照

Create メソッドは，リストボックスコントロールをインスタンス化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にリストボックスコントロールをインスタンス化できます。設計時に作成したリストボックスの場合，Create は自動的に呼び出されます。

Create はリストボックスコントロールにメモリを割り当て，継承された Create メソッドを呼び出してから，以下の処理を実行します。

・	Width，Height，ItemHeight プロパティの値を初期化する

・	ParentColor を Falseに，TabStop および ExtendedSelect を True に設定する

・	リストボックスの ControlStyle を設定する

・	BorderStyle プロパティを bsSingle に設定する

・	Canvas プロパティに TControlCanvas オブジェクトを作成する

・	Items プロパティに TStrings 型のオブジェクトを作成する


TCustomListBox.CreateParams
TCustomListBox.CreateParams3101027

TCustomListBox	参照

CreateParams メソッドは，Params パラメータで渡されたウィンドウ作成用パラメータの内容を初期化します。

type

  TCreateParams = record

    Caption: PChar;

    Style: Longint;

    ExStyle: Longint;

    X, Y: Integer;

    Width, Height: Integer;

    WndParent: HWND;

    Param: Pointer

    WindowClass: TWndClass;

    WinClassName: array[0..63] of Char;

  end;

procedure CreateParams(var Params: TCreateParams); virtual;

説明

CreateParams メソッドは，リストボックスコントロールの作成時に Params パラメータを使って CreateWindowHandle に情報を渡すのに使用します。リストボックスの CreateWnd メソッドは，CreateWindowHandle（TWinControl から派生する Protected メソッド）の呼び出しでこの情報を渡すための継承 CreateWnd メソッドを呼び出します。

TCustomListBox は CreateParams をオーバーライドしてウィンドウの表示をカスタマイズします。TCustomListBox は，リストボックスを作成するために，リストボックスの Columns，ExtendedSelect，IntegralHeight，MultiSelect，Sorted，および Style の各プロパティの情報を使用し，WS_HSCROLL，WS_VSCROLL，LBS_HASSTRINGS，および LBS_NOTIFY の各 Windows スタイルを設定します。

CreateParams をオーバーライドする場合は，最初に継承メソッドを呼び出してデフォルト値を設定し，その後で必要な調整を加えるようにします。

TCreateParams は CreateParams の Params パラメータの型で，ウィンドウハンドルの作成に関する情報を入れておくデータ構造体です。CreateWindowHandle は，CreateWindowEx API 関数を呼び出すためのパラメータになる TCreateParams レコードの各フィールドを処理します。


TCustomListBox.CreateWnd
TCustomListBox.CreateWnd3101028

TCustomListBox	参照

CreateWnd メソッドは，リストボックスコンポーネントに対応する Windows コントロールを作成します。

procedure CreateWnd; virtual;

説明

CreateWnd メソッドは CreateHandle（TWinControl から派生するプロテクトメソッド）によって自動的に呼び出されます。CreateWnd は継承された CreateWnd を呼び出し，この CreateWnd は 2 つのメソッドを呼び出して次の処理を行います。

・	CreateParams を呼び出してウィンドウ作成用パラメータを初期化する

・	CreateWindowHandle を呼び出してコントロールへのウィンドウハンドルを作成する

さらに TCustomListBox.CreateWnd はリストボックスの位置，タブ，項目，列をセットアップします。


TCustomListBox.DeleteString
TCustomListBox.DeleteString3101029

TCustomListBox

DeleteString メソッドは，リストボックスから文字列を削除します。

procedure DeleteString(Index: Integer); dynamic;

説明

DeleteString メソッドは，Index パラメータで指定した文字列をリストボックスコントロールから削除します。


TCustomListBox.Destroy
TCustomListBox.Destroy3101030

TCustomListBox	参照

Destroy メソッドは，リストボックスコントロールのインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはリストボックスオブジェクトが解放されていないことを確認してから Destroy メソッドを呼び出します。

Destroy は Canvas および Items プロパティのオブジェクトに関連付けられていたメモリを解放してから，継承された Destroy を呼び出してリストボックスオブジェクトを破棄します。


TCustomListBox.DestroyWnd
TCustomListBox.DestroyWnd3101031

TCustomListBox	参照

DestroyWnd メソッドは，リストボックスの文字列リスト内の Items を保存してから，継承された DestroyWnd を呼び出します。

procedure DestroyWnd; virtual;

説明

DestroyWnd メソッドは，リストボックスの Items プロパティのテキスト文字列項目を，作成する TStringList オブジェクトの内部記憶域に保存してから，継承された DestroyWnd を呼び出してウィンドウコントロールのウィンドウハンドルを破棄し，関連付けられているデバイスコンテキストを解放します。


TCustomListBox.DragCanceled
TCustomListBox.DragCanceled3101032

TCustomListBox	参照

DragCanceled メソッドは，ドラッグアンドドロップ処理をキャンセルしたというマウスメッセージを送信します。

procedure DragCanceled; dynamic;

説明

DragCanceled メソッドは，開始されたドラッグアンドドロップ処理がキャンセルされたときに呼び出されます。処理をキャンセルするには，項目をその項目を受け入れないコンポーネントの上でドロップするか，ドラッグ中に〔Esc〕を押します。

Delphi は OnEndDrag イベントを呼び出す前に DragCanceled メソッドを呼び出します。


TCustomListBox.DrawItem
TCustomListBox.DrawItem3101033

TCustomListBox	参照

DrawItem メソッドは，オーナー描画リストボックスの OnDrawItem イベント用のメソッドです。

TPoint = record

  X: Longint;

  Y: Longint;

end;

TRect = record

  case Integer of

    0: (Left, Top, Right, Bottom: Integer);

    1: (TopLeft, BottomRight: TPoint);

end;

TOwnerDrawState = set of (odSelected, odGrayed, odDisabled, odChecked, odFocused);

procedure DrawItem(Index: Integer; Rect: TRect; State: TOwnerDrawState); virtual;

説明

DrawItem メソッドは，オーナー描画リストボックスの外観が変わるたびに呼び出されます。リストボックスはリストボックス内の表示項目ごとに DrawItem を呼び出し，Index パラメータに項目のインデックスを渡します。

デフォルトでは，リストボックスの DrawItem メソッドは，そのコンポーネントの OnDrawItem イベントにアタッチされたイベントハンドラを呼び出します。イベントハンドラがアタッチされていない場合，DrawItem は Rect で渡された長方形を塗りつぶし，インデックスの項目に関連付けられているテキストを描画します。State パラメータはアタッチされたイベントハンドラに渡されますが，デフォルトでは無視されます。


TCustomListBox.GetItemData
TCustomListBox.GetItemData3101034

TCustomListBox	参照

GetItemData メソッドは，リストボックス内の指定した項目に関連付けられている 32 ビット値を返します。

function GetItemData(Index: Integer): LongInt; dynamic;

説明

GetItemData メソッドは，リストボックス内の特定の項目に関連付けられているデータを取り出すのに使います。この値はそのリストボックスの項目として表示できます。


TCustomListBox.ItemAtPos
TCustomListBox.ItemAtPos3101035

TCustomListBox	参照

ItemAtPos メソッドは，リストボックス上の座標によって示された点の項目のインデックスを返します。

function ItemAtPos(Pos: TPoint; Existing: Boolean): Integer;

説明

ItemAtPos メソッドを使うと，コントロール内の特定の点に項目が存在するかどうかを検出できます。

Pos パラメータはウィンドウ座標でのコントロール内の点です。Pos がリストボックス内の最後の項目を越えた場合，Existing 変数の値が戻り値を決めます。Existing を True に設定すると，ItemAtPos は -1 を返し，その点に項目が存在しないことを示します。Existing を False に設定すると，ItemAtPos はリストボックス内の最後の項目のインデックスに 1 を加えた値を返します。


TCustomListBox.ItemRect
TCustomListBox.ItemRect3101036

TCustomListBox	参照

ItemRect メソッドは，Item パラメータで指定する項目を囲む長方形を返します。

TPoint = record

  X: Longint;

  Y: Longint;

end;

TRect = record

  case Integer of

    0: (Left, Top, Right, Bottom: Integer);

    1: (TopLeft, BottomRight: TPoint);

end;

function ItemRect(Item: Integer): TRect;

説明

ItemRect を使うと，リストボックス内の特定の項目の座標を取得できます。ItemRect は，たとえば，ItemAtPos メソッドによって内部的に使用されます。

Item パラメータは，位置を問い合わせたい項目の ItemIndex です。


TCustomListBox.MeasureItem
TCustomListBox.MeasureItem3101037

TCustomListBox	参照

MeasureItem メソッドは，オーナー描画リストボックスコンポーネントの OnMeasureItem イベント用のメソッドです。

procedure MeasureItem(Index: Integer; var Height: Integer); virtual;

説明

MeasureItem メソッドは可変（Style が csOwnerDrawVariable に設定されている）オーナー描画リストボックスの外観が変わるたびに呼び出されます。

項目を描画する前に，可変オーナー描画リストボックスは表示項目ごとに MeasureItem を呼び出し，寸法を取得するインデックスと項目のデフォルトの高さを渡します。Height は var パラメータなので，MeasureItem では各項目の高さを必要に応じて増減できます。

デフォルトでは，MeasureItem メソッドは OnMeasureItem イベントにアタッチされたイベントハンドラを呼び出す以外は何もしません。MeasureItem をオーバーライドすれば，デフォルトの処理を変更したり，機能を追加したりすることができます。


TCustomListBox.ResetContent
TCustomListBox.ResetContent3101038

TCustomListBox	参照

ResetContent メソッドは，リストボックスからすべての項目を削除します。

procedure ResetContent; dynamic;

説明

ResetContent メソッドは，リストボックスから項目を削除するのに使います。ResetContent メソッドは，Clear メソッドで使われます。


TCustomListBox.SetItemData
TCustomListBox.SetItemData3101039

TCustomListBox	参照

SetItemData メソッドは，リストボックス内の指定した項目に関連付けられている 32 ビット値を設定します。

procedure SetItemData(Index: Integer; AData: LongInt); dynamic;

説明

SetItemData メソッドは，リストボックス内の特定の項目に関連付けられているデータを設定するのに使います。この値はそのリストボックスの項目として表示できます。


TCustomListBox.WndProc
TCustomListBox.WndProc3101040

TCustomListBox	参照

WndProc メソッドは，継承されたメソッドを呼び出す前に，オートドラッグに追加動作を提供します。

TMessage = record

  Msg: Word;

  case Integer of

    0: (

      WParam: Word;

      LParam: Longint;

      Result: Longint);

    1: (

      WParamLo: Byte;

      WParamHi: Byte;

      LParamLo: Word;

      LParamHi: Word;

      ResultLo: Word;

      ResultHi: Word);

end;

procedure WndProc(var Message: TMessage); virtual;

説明

WndProc は，継承された WndProc をオーバーライドして，リストボックスにオートドラッグモードの処理を許可するメッセージに対処することができます。。次に，継承された WndProc を呼び出して，他のすべてのメッセージを処理します。

WndProc メソッドをオーバーライドする場合，最後に他のメッセージをディスパッチするために，必ず継承された WndProc を呼び出してください。


スコープ3101041

protected

published

読み出し／書き込み

読み出し専用


スコープ3101042

protected


スコープ3101043

protected


継承3101044

TObject

TPersistent

TComponent

TControl

TWinControl


TCustomListBox 例3101045

TCustomListBox


TCustomListView
TCustomListView3102001

継承	プロパティ	メソッド	イベント	参照

TCustomListView コンポーネントは，TListView コンポーネントを含めたすべてのリストビューコンポーネントの抽象クラスです。

ユニット

comctrls

説明

TCustomListView は項目のリストを表示するコントロールを定義するときに基本クラスとして使います。TCustomListView を使うと，項目リストを列に列ヘッダーおよび子項目を付けて表示したり，垂直または水平に表示したりすることが可能で，大きなアイコンまたは小さなアイコンを付けて表示することもできます。

TCustomListView のインスタンスを作成しないでください。リストビューをフォームに配置するには，TListView などの TCustomListView の派生オブジェクトを使います。


TCustomListView プロパティ3102002

TCustomListView	アルファベット順	凡例

TCustomListView

AllocBy

BorderStyle

BoundingRect

CheckBoxes

Column

ColumnClick

Columns

DropTarget

GridLines

HideSelection

HotTrack

IconOptions

ItemFocused

Items

LargeImages

MultiSelect

ReadOnly

RowSelect

SelCount

Selected

ShowColumnHeaders

SmallImages

SortType

StateImages

TopItem

ViewOrigin

ViewStyle

VisibleRowCount

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomListView プロパティ3102003

TCustomListView	オブジェクト順	凡例

Align

AllocBy

BorderStyle

BoundingRect

BoundsRect

Brush

CheckBoxes

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Column

ColumnClick

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

DropTarget

Enabled

GridLines

Handle

Height

HelpContext

HideSelection

Hint

HotTrack

IconOptions

ItemFocused

Items

LargeImages

Left

MultiSelect

Name

Owner

Parent

ParentWindow

ReadOnly

RowSelect

SelCount

Selected

ShowColumnHeaders

ShowHint

Showing

SmallImages

SortType

StateImages

TabOrder

TabStop

Tag

Top

TopItem

VCLComObject

ViewOrigin

ViewStyle

Visible

VisibleRowCount

Width

WindowProc


TCustomListView.AllocBy
TCustomListView.AllocBy3102004

TCustomListView	参照

AllocBy プロパティは，リストビューがメモリに保存できる項目数を示します。

property AllocBy: Integer;

説明

リソースビューに多数の項目を追加する前に，AllocBy プロパティをリスト内の総項目数に設定します。AllocBy プロパティは，項目を追加するときに，リストビューがビット単位ではなくブロック単位で項目にメモリを割り当てることができます。


TCustomListView.BorderStyle
TCustomListView.BorderStyle3102005

TCustomListView	参照

BorderStyle プロパティは，リストビューに一重境界線を付けるかどうかを指定します。

property BorderStyle: TBorderStyle;

説明

BorderStyle プロパティは，フォームに表示するリストビューコントロールの鮮明度を変えられます。BorderStyle プロパティは bsSingle か bsNone を指定できます。BorderSyle が bsSingle の場合，リストビューは一重境界線を付けて表示されます。BorderStyle が bsNone の場合は境界線が付きません。

注意

BorderStyle は別の表示効果を作成するために Ctl3D プロパティ関連します。この 2 つのプロパティを組み合わせて必要な外観を設定してください。


TCustomListView.BoundingRect
TCustomListView.BoundingRect3102006

TCustomListView	参照

BoundingRect プロパティは，リストビュー内の項目の境界矩形です。

property BoundingRect: TRect;

説明

BoundingRect プロパティは，リストビュー内の全項目を囲む長方形の画面座標を取得できます。また，アプリケーションがコントロールのサイズを調整して項目に合うようにしたり，マウスが項目の領域を越えたかどうかを判別したりできます。

注意

BoundingRect プロパティを設定するには，リストビューの ViewStyle プロパティが vsIcon または vsSmallIcon でなければなりません。


TCustomListView.CheckBoxes
TCustomListView.CheckBoxes3102007

TCustomListView	参照

CheckBoxes プロパティは，リストビューでチェックボックスが項目の横に表示するかどうか指定します。

property Checkboxes: Boolean;

説明

CheckBoxes プロパティを True に設定すると， ViewStyle が vsList または vsReport の場合にチェックボックスをリスト項目の横に表示できます。リストの各行が 1 つのチェックボックスを表示します。


TCustomListView.Column
TCustomListView.Column3102008

TCustomListView	参照

Column プロパティは，Index パラメータで指定された列を説明します。

property Column[Index: Integer]: TListColumn;

説明

Column プロパティは，レポートスタイルのリストビューで列の列属性を保持する TListColumn オブジェクトにアクセスできます。Index パラメータは Columns プロパティ配列内での列のインデックスです。

注意

Column は ViewStyle プロパティの値が vsReport の場合にのみ有効です。


TCustomListView.ColumnClick
TCustomListView.ColumnClick3102009

TCustomListView	参照

ColumnClick プロパティは，列ヘッダーがボタンと同様に動作するかどうかを指定します。

property ColumnClick: Boolean;

説明

ColumnClick プロパティは，ユーザーが列ヘッダーでクリックした場合に OnColumnClick イベントが発生するかどうかを指定します。ColumnClick が True の場合，列ヘッダーでマウスクリックしたときに OnColumnClick イベントが発生します。ColumnClick が False の場合，OnColumnClick イベントは発生しません。

注意

列クリックが動作するには，列ヘッダーが表示されていなければなりません。列ヘッダーを表示するには，ShowColumnHeaders プロパティを True に，ViewStyle プロパティを vsReport に設定します。


TCustomListView.Columns
TCustomListView.Columns3102010

TCustomListView	参照

Columns プロパティは，リストビュー内の列のプロパティを説明します。

property Columns: TListColumns;

説明

Columns プロパティは，リストビュー内の列を追加または削除したり，列の表示プロパティを編集したりできます。設計時に Columns プロパティを設定する場合，［リストビューのカラム設定］ダイアログが表示されます。このダイアログを使うと，列を追加または編集したり，個々の列の表示プロパティを変更したりできます。Columns プロパティでアクセスする TListColumn オブジェクトの Caption，Alignment，および Width の 3 つのプロパティを実行時に使うと，列ヘッダーの外観を変更できます。

注意

列を表示するには，ViewStyle プロパティを vsReport に，ShowColumnHeaders プロパティを True に設定します。


TCustomListView.DropTarget
TCustomListView.DropTarget3102011

TCustomListView	参照

DropTarget プロパティは，リスト内のどの項目がドラッグアンドドロップ操作のターゲットになるかを指定します。

property DropTarget: TListItem;

説明

DropTarget プロパティは，リスト内のどの項目がドラッグアンドドロップ操作のターゲットかを調べられます。DropTarget を設定すると，リストの特定の項目がドラッグ項目をドロップするターゲットになるかどうかを変更できます。

注意

DropTarget は，ドロップするターゲットとしてユーザーに表示される項目だけを示します。アプリケーションは項目のドラッグアンドドロップ動作を実装しなければなりません。


TCustomListView.GridLines
TCustomListView.GridLines3102012

TCustomListView	参照

GridLines プロパティは，リスト内の項目の区切り線を付けるかどうかを決めます。

property GridLines: Boolean;

説明

GridLines プロパティを True に設定するとリストビューの項目を区切る線が追加されます。GridLines の値は ViewStyle が vsList または vsReport の場合にのみ有効です。


TCustomListView.HideSelection
TCustomListView.HideSelection3102013

TCustomListView	参照

HideSelection プロパティは，フォーカスを他のコントロールに移動したときにどの項目が選択されているかを，リストビューが示すかどうかを決めます。

property HideSelection: Boolean;

説明

HideSelection プロパティを False に設定すると，リストビューにフォーカスがないときでもリスト内のどの項目が選択されているかを示せます。HideSelection プロパティを True に設定すると，リストビューにフォーカスがあるときにのみ選択した項目が示されます。HideSelection プロパティは選択されていることを示すだけで，実際の値には影響しません。HideSelection を常に False に設定しておくと，リストビューが多いフォームの表示が煩雑になることがあります。


TCustomListView.HotTrack
TCustomListView.HotTrack3102014

TCustomListView	参照

HotTrack プロパティは，マウスがリストの項目上を通過したときに項目を強調表示するかどうかを指定します。

property HotTrack: Boolean;

説明

HotTrack プロパティを True に設定すると，マウスがどの項目の上を通過したかを，リストビューが示すことができます。HotTrack が False の場合，リストビュー項目の色はマウスが項目の上を通過しても変わりません。


TCustomListView.IconOptions
TCustomListView.IconOptions3102015

TCustomListView	参照

IconOptions プロパティは，リストビューに表示されるアイコンの配列方法を決めます。

property IconOptions: TIconOptions;

説明

IconOptions プロパティの値になっている TIconOptions オブジェクトのプロパティを設定すると，リストビューに表示されるアイコンの配列方法を指定できます。このオプションがコントロールに効果を持つには，リストビューの ViewStyle は vsIcon または vsSmallIcons でなければなりません。


TCustomListView.ItemFocused
TCustomListView.ItemFocused3102016

TCustomListView	参照

ItemFocused プロパティは，リストビューに項目がある場合に，どの項目にフォーカスがあるかを調べます。

property ItemFocused: TListItem;

説明

ItemFocused プロパティは，リストビューに項目があった場合，ユーザーがどの項目を編集できるかを調べられます。 ItemFocused を設定するとリスト内の項目にフォーカスを設定できます。フォーカスのある項目は標準の長方形のフォーカス領域で囲まれます。どの項目にもフォーカスがない場合，ItemFocused プロパティは nil を返します。フォーカスを持てる項目は 1 つだけです。


TCustomListView.Items
TCustomListView.Items3102017

TCustomListView	参照

Items プロパティは，リストビューに表示される項目のリストを格納します。

property Items: TListItems;

説明

Items プロパティは，リスト内の項目を表す TListItem オブジェクトに直接アクセスできます。設計時にこのプロパティを設定すると，［リストビュー項目の設定］ダイアログが表示されます。このダイアログを使うと，項目または子項目を追加，削除したり，それらの表示プロパティの編集したりできます。実行時に各項目の Caption，ImageIndex および StateIndex プロパティを使うとリスト項目の外観を変更できます。


TCustomListView.LargeImages
TCustomListView.LargeImages3102018

TCustomListView	参照

LargeImages プロパティは，ViewStyle プロパティが vsIcon のとき，リスト内の項目に表示するアイコンイメージのリストを提供します。

property LargeImages: TImageList;

説明

LargeImages プロパティを設定すると，ViewStyle が vsIcon のときにリスト内の項目の横に表示するビットマップを指定できます。Items リストの各項目は，ImageIndex プロパティを設定してこのイメージリストに入っているビットマップと関連付けることができます。


TCustomListView.MultiSelect
TCustomListView.MultiSelect3102019

TCustomListView	参照

MultiSelect プロパティは，一度に複数のリスト項目を選択できるかどうかを指定します。

property MultiSelect: Boolean;

説明

MultiSelect プロパティを設定すると，一度に複数の項目をリストから選択できるかどうかを指定できます。MultiSelect が True ならば一度に複数の項目を選択でき，False ならば一度に 1 つの項目しか選択できません。


TCustomListView.ReadOnly
TCustomListView.ReadOnly3102020

TCustomListView	参照

ReadOnly プロパティは，コントロールの内容を変更できるかどうかを指定します。

property ReadOnly: Boolean;

説明

ReadOnly プロパティは，データを入力するのにリストビューを使うかどうかを指定できます。ReadOnly が True の場合，リストビューが表示する値は編集できません。ReadOnly が False ならば，ユーザーは内容を変更できます。ReadOnly が False の場合，ユーザーがリスト項目の編集または終了したときにそれぞれ OnEditing イベントと OnEdited イベントが発生します。


TCustomListView.RowSelect
TCustomListView.RowSelect3102021

TCustomListView	参照

RowSelect プロパティは，リストビューの 1 行全体を選択できるかどうかを決めます。

property RowSelect: Boolean;

説明

RowSelect プロパティを True に設定すると，ViewStyle プロパティが vsReport のときに行全体を選択できます。複数の行を選択できるようにするには，MultiSelect プロパティを使います。


TCustomListView.SelCount
TCustomListView.SelCount3102022

TCustomListView	参照

SelCount プロパティは，リストビュー内の選択されている項目の数を示します。

property SelCount: Integer;

説明

SelCount プロパティは，現在選択されている項目の数を調べられます。SelCount が 1 の場合，Selected プロパティを使うと選択されている項目にアクセスできます。SelCount が 1 より大きい場合に選択されている項目の位置付けるには，Selected プロパティで指定された項目から始めてリスト項目の Selected プロパティを調べます。

注意

SelCount が 1 を超えるのは MultiSelect プロパティが True の場合だけです。


TCustomListView.Selected
TCustomListView.Selected3102023

TCustomListView	参照

Selected プロパティは，リストビュー内の最初に選択されている項目を返します。

property Selected: TListItem;

説明

Selected プロパティは，リストで選択されている最初の項目のプロパティにアクセスできます。SelCount が 0 ならば，Selected は nil です。SelCount が 1 より大きい場合，次に選択されている項目は GetNextItem メソッドで見つかった項目の Selected プロパティを調べることで位置を特定できます。

Selected プロパティを設定するとリスト内の項目を選択できます。MultiSelect が True の場合，Selected を設定すると項目を選択されている項目に追加できます。MultiSelect が False の場合，Selected を設定すると選択されている項目が変わります。Selected を nil に設定するとリスト内のすべての項目が削除されます。

項目を選択すると，OnChanging イベントと OnChange イベントが発生します。


TCustomListView.ShowColumnHeaders
TCustomListView.ShowColumnHeaders3102024

TCustomListView	参照

ShowColumnHeaders プロパティは，列ヘッダーを表示するかどうかを指定します。

property ShowColumnHeaders: Boolean;

説明

ShowColumnHeaders プロパティを設定すると，リストビュー内の列に列ヘッダーを表示するかどうかを指定できます。列ヘッダーとは，リストビューの列の項目カテゴリを示すキャプションが付いたパネルです。列ヘッダーは，リストビューで補足情報を提供する下位項目の列にラベルを付けるとき，役に立ちます。Coluns プロパティを使うとヘッダーを作成，追加できます。

注意

リストビューの列を使うには ViewStyle プロパティを vsReport に設定しなければなりません。


TCustomListView.SmallImages
TCustomListView.SmallImages3102025

TCustomListView	参照

SmallImages プロパティは，ViewStyle が vsIcon でない場合に各項目に表示するアイコンイメージのリストを提供します。

property SmallImages: TImageList;

説明

SmallImages を設定すると，ViewStyle が vsSmallIcon，vsList，または vsReport のときにリストの項目の隣に表示するアイコンを指定できます。Items リストの各項目は，ImageIndex プロパティを設定することでイメージリストに入っているアイコンと関連付けることができます。


TCustomListView.SortType
TCustomListView.SortType3102026

TCustomListView	参照

SortType プロパティは，リストの項目を自動的にソートするかどうか，およびソートの方法を指定します。

TSortType = (stNone, stData, stText, stBoth);

property SortType: TSortType;

説明

SortType を設定するとリストに入っている項目の順序を指定できます。SortType が stNone でない場合，Items プロパティのリスト項目は自動的にソートされます。リストビューをいったんソートすると元の順序は失われます。つまり，SortType の設定を stNone に戻しても項目の元の順序を復元できません。以下に SortType の指定値を示します。

値	意味

stNone	ソートしない

stData	TListItem オブジェクトの Data プロパティに基づいてソートする。Data 値を比較するために OnCompare イベントハンドラを指定しなければならない

stText	TListItem オブジェクトの Caption プロパティに基づいてソートする。

stBoth	TListItem オブジェクトの Data プロパティと Caption プロパティに基づいてソートする。Data 値は OnCompare イベントハンドラが指定されていない限り無視される


TCustomListView.StateImages
TCustomListView.StateImages3102027

TCustomListView	参照

StateImages プロパティは，リストビューの各項目の隣に表示する追加のアイコンのイメージリストを提供します。

property StateImages: TImageList;

説明

StateImages を設定するとリストの内の項目の隣に表示するアイコンを指定できます。 Items リストの各項目は，StateIndex プロパティを設定することでイメージリストに入っているアイコンと関連付けることができます。


TCustomListView.TopItem
TCustomListView.TopItem3102028

TCustomListView	参照

TopItem プロパティは，リストビューの一番上に表示される項目を返します。

property TopItem: TListItem;

説明

TopItem を読み出すと，リストビューで表示される最初の項目を調べられます。TopItem はスクロールされていた位置を反映します。

TopItem は ViewStyle が vsReport または vsList の場合にのみ実現されます。vsIcon ビュースタイルと vsSmallIcon ビュースタイルの場合，ViewOrigin プロパティを使うとスクロール位置を指定できます。


TCustomListView.ViewOrigin
TCustomListView.ViewOrigin3102029

TCustomListView	参照

ViewOrigin プロパティは，リストビューコントロールの表示領域に相対して左上隅の座標を返します。

property ViewOrigin: TPoint;

説明

ViewOrigin プロパティは，リストイメージの論理起点を調べられます。リストビューがスクロールされていない場合は ViewOrigin は(0,0)です。それ以外は X 座標を使って水平スクロール位置のピクセル数を調べ，Y 座標を使って垂直スクロール位置のピクセル数を調べます。

ViewOrigin は ViewStyle が vsIcon または vsSmallIcon の場合にのみ実現されます。vsReport または vsList の場合は TopItem プロパティを使います。


TCustomListView.ViewStyle
TCustomListView.ViewStyle3102030

TCustomListView	参照

ViewStyle プロパティは，リストビュー内の項目の表示方法を決めます。

property ViewStyle: TViewStyle;

説明

ViewStyle を設定するとリストビューの項目の表示方法を制御できます。項目は移動可能なアイコンかテキスト行として表示できます。以下に ViewStyle の指定値を示します。

値	意味

vsIcon	各項目を下にラベルの付いたフルサイズのアイコンとして表示する。ユーザーはリストビューウィンドウの任意の位置に項目をドラッグできる

vsSmallIcon	各項目を右側にラベルの付いた小さいアイコンとして表示する。ユーザーは任意の位置に項目をドラッグできる

vsList	各項目を右側にラベルの付いた小さいアイコンとして表示する。項目は列形式で並び，任意の位置にドラッグすることはできない

vsReport	各項目に 1 行を割り当て，列形式で情報を配置する。一番左の列に小さいアイコンとラベルを表示し，それに続く列にアプリケーションで指定した下位項目を入れる。ShowColumnHeaders が False でなければ各列にはヘッダーが付く


TCustomListView.VisibleRowCount
TCustomListView.VisibleRowCount3102031

TCustomListView	参照

VisibleRowCount プロパティは，リストビューの表示領域で縦に入る項目の数を返します。

property VisibleRowCount: Integer;

説明

VisibleRowCountプロパティは，ViewStyle プロパティが vsList または vsReport の場合にリストビューの表示領域に表示される 1 列に入る項目数を調べられます。カウントされるのは表示される項目だけです。VisibleRowCount が列に入っている項目の総数よりも小さい場合，TopItem プロパティを使うとリストビューをスクロールするかどうかを指定できます。


TCustomListView イベント3102032

TCustomListView	アルファベット順	凡例

TCustomListView

OnChange

OnChanging

OnColumnClick

OnCompare

OnDeletion

OnEdited

OnEditing

OnInsert


TCustomListView イベント3102033

TCustomListView	オブジェクト順	凡例

OnChange

OnChanging

OnColumnClick

OnCompare

OnDeletion

OnEdited

OnEditing

OnInsert


TCustomListView.OnChange
TCustomListView.OnChange3102034

TCustomListView	参照

OnChange イベントは，リストの項目が変わった直後に発生します。

TItemChange = (ctText, ctImage, ctState);

TLVChangeEvent = procedure(Sender: TObject; Item: TListItem; Change: TItemChange)

   of object;

property OnChange: TLVChangeEvent;

説明

OnChange イベントハンドラを記述すると，リスト内の項目の変化に応答できます。OnChange イベントハンドラによって，リストが正常に変化したときに応答処理できるようになります。

Item パラメータは変更された項目のリストです。Change パラメータはその変更の型を示します。Change は，項目の Caption プロパティが変更された場合に ctText です。項目の ImageIndex プロパティが変更された場合またはリストビューでイメージリストが変更された場合に，Change は ctImage です。Cut，Focused，または Selected のいずれかのプロパティが変更された場合，Change は ctState です。


TCustomListView.OnChanging
TCustomListView.OnChanging3102035

TCustomListView	参照

OnChanging イベントは，リストの項目を変更しようとしたときに発生します。

TItemChange = (ctText, ctImage, ctState);

TLVChangingEvent = procedure(Sender: TObject; Item: TListItem; Change: TItemChange;

   var AllowChange: Boolean) of object;

property OnChanging: TLVChangingEvent;

説明

OnChanging イベントハンドラを記述すると，リスト内の項目に対する変更を条件付きで無限できます。AllowChange パラメータを False に設定すると変更を防ぎます。Item パラメータは変更しようとするリスト項目です。Change パラメータはその変更の型を示します。

Change は，項目の Caption プロパティを変更しようとする場合に ctText です。項目の ImageIndex プロパティを変更しようとする場合には，Change は ctImage です。Cut，Focused，または Selected のいずれかのプロパティを変更しようとする場合，Change は ctState です。


TCustomListView.OnColumnClick
TCustomListView.OnColumnClick3102036

TCustomListView	参照

OnColumnClick イベントは，リストビュー内の列ヘッダーをクリックしたときに発生します。

TLVColumnClickEvent = procedure(Sender: TObject; Column: TListColumn) of object;

property OnColumnClick: TLVColumnClickEvent;

説明

OnColumnClick イベントハンドラを記述すると，ViewStyle が vsReport の場合に列ヘッダーでマウスをクリックしたときに応答できます。Column パラメータは，クリックされた列を説明する Columns プロパティの TListColumn オブジェクトです。

OnColumnClick が発生するのは，ViewStyle が vsReport に，ShowColumnHeaders が True に，ColumnClick が True に設定されている場合だけです。


TCustomListView.OnCompare
TCustomListView.OnCompare3102037

TCustomListView	参照

OnCompare イベントは，リストのソート中に 2 つの項目を比較するかどうかを指定します。

TLVCompareEvent = procedure(Sender: TObject; Item1, Item2: TListItem; Data: Integer;

   var Compare: Integer) of object;

property OnCompare: TLVCompareEvent;

説明

OnCompare イベントハンドラを記述するとリストをソートできます。OnCompare イベントハンドラが呼び出されるのは，SortType プロパティが stData または stBoth の場合，AlphaSort メソッドが呼び出された場合， SortProc パラメータを指定しないで CustomSort メソッドが呼び出された場合のいずれかです。

OnCompare イベントハンドラは Item1 と Item2 として渡されたリスト項目を比較します。Item1 がソート順で Item2 と同じならば，Compare パラメータを 0 に設定します。Item1 が Item2 よりも小さい場合，Compare パラメータを 0 より小さな値に設定します。Item1 が Item2 よりも大きい場合，Compare パラメータを 0 よりも大きな値に設定します。SortType が stData または stBoth でソートしたリストビューのソート順を維持するためにイベントハンドラが呼び出された場合，Data パラメータは 0 です。同様に，AlphaSort メソッドに応答して OnCompare が発生した場合にも Data パラメータは 0 です。OnCompare が CustomSort メソッドに応答して発生した場合，Data パラメータは CustomSort の LParam パラメータの値です。


TCustomListView.OnDeletion
TCustomListView.OnDeletion3102038

TCustomListView	参照

OnDeletion イベントは，リストビュー内の項目が削除されようとしたときに発生します。

TLVDeletedEvent = procedure(Sender: TObject; Item: TListItem) of object;

property OnDeletion: TLVDeletedEvent;

説明

OnDeletion イベントハンドラを記述すると，リスト内の項目が削除されようとしたときに応答できます。Item パラメータは削除されようとしている Item プロパティの TListItem オブジェクトです。


TCustomListView.OnEdited
TCustomListView.OnEdited3102039

TCustomListView	参照

OnEdited イベントは，項目の Caption プロパティを編集した直後に発生します。

TLVEditedEvent = procedure(Sender: TObject; Item: TListItem; var S: string) of object;

property OnEdited: TLVEditedEvent;

説明

OnEdited イベントハンドラを記述すると，ユーザーがリスト項目のテキストの編集を終えたときに特定のアクションを実行できます。OnEdited イベントハンドラは，ユーザーが入力した値に応答したり，リスト項目の Caption プロパティに代入された値を変更したりできます。たとえば，OnEdited イベントハンドラでユーザーが入力した文字列が有効かどうかを確認して，その値が有効な場合にのみ Caption プロパティの変更を許可します。

Item パラメータは編集直後のリスト項目です。S パラメータはユーザーが項目の Caption プロパティに入力した新しい値です。ユーザーが入力した値をオーバーライドするために S パラメータの値を変更します。OnEdited が発生したときには項目の Caption プロパティはまだ変更されていないので，S を Caption の元の値と比較することができます。

このイベントは ReadOnly が False の場合にのみ発生します。


TCustomListView.OnEditing
TCustomListView.OnEditing3102040

TCustomListView	参照

OnEditing イベントは，リスト項目の Caption プロパティの編集が始まるときに発生します。

TLVEditingEvent = procedure(Sender: TObject; Item: TListItem; var AllowEdit: Boolean)

    of object;

property OnEditing: TLVEditingEvent;

説明

OnEditing イベントハンドラを記述すると，ユーザーがリスト項目の Caption プロパティを編集する直前に特定のアクションを実行できます。ListItem パラメータで指定された項目を編集できないようにするにば，AllowEdit パラメータを False に設定します。

このイベントは，コンポーネントの ReadOnly プロパティが False のときだけ発生します。


TCustomListView.OnInsert
TCustomListView.OnInsert3102041

TCustomListView	参照

OnInsert イベントは，リストビューに新しい項目が挿入された直後に発生します。

TLVDeletedEvent = procedure(Sender: TObject; Item: TListItem) of object;

property OnInsert: TLVDeletedEvent;

説明

OnInsert イベントハンドラを記述すると，項目がリストに追加されたときに応答できます。Item パラメータは Items プロパティに追加された TListItem オブジェクトです。


TCustomListView メソッド3102042

TCustomListView	アルファベット順	凡例

TCustomListView

AlphaSort

Arrange

CanChange

CanEdit

Change

ColClick

ColumnsShowing

Create

CreateListItem

CreateParams

CreateWnd

CustomSort

Delete

Destroy

DestroyWnd

DoEndDrag

DoStartDrag

Edit

FindCaption

FindData

GetDragImages

GetItemAt

GetItemIndex

GetNearestItem

GetNextItem

GetSearchString

InsertItem

IsEditing

Notification

Scroll

StringWidth

UpdateColumn

UpdateColumns

UpdateItems

WndProc

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomListView メソッド3102043

TCustomListView	オブジェクト順	凡例

AlphaSort

Arrange

Assign

BeginDrag

BringToFront

Broadcast

CanChange

CanEdit

CanFocus

Change

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ColClick

ColumnsShowing

ContainsControl

ControlAtPos

Create

CreateListItem

CreateParams

CreateParented

CreateWnd

CustomSort

DefaultHandler

Delete

Destroy

DestroyComponents

Destroying

DestroyWnd

DisableAlign

Dispatch

DoEndDrag

DoStartDrag

DragDrop

Dragging

Edit

EnableAlign

EndDrag

FieldAddress

FindCaption

FindComponent

FindData

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetDragImages

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetItemAt

GetItemIndex

GetNamePath

GetNearestItem

GetNextItem

GetParentComponent

GetSearchString

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InsertItem

InstanceSize

Invalidate

IsEditing

MethodAddress

MethodName

NewInstance

Notification

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

Scroll

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

StringWidth

Update

UpdateColumn

UpdateColumns

UpdateControlState

UpdateItems

WndProc


TCustomListView.AlphaSort
TCustomListView.AlphaSort3102044

TCustomListView	参照

AlphaSort メソッドは，リストビュー内の項目をソートします。

function AlphaSort: Boolean;

説明

AlphaSortは，SortType プロパティが stNone でない場合に項目をソートできます。OnCompare イベントハンドラが割り当てられている場合，AlphaSort はそのイベントハンドラを使ってソート順を定義します。それ以外の場合，AlphaSort はアルファベットの昇順で全リスト項目をソートします。成功するとメソッドは True を返します。


TCustomListView.Arrange
TCustomListView.Arrange3102045

TCustomListView	参照

Arrange メソッドは，ViewStyle プロパティが vsIcon か vsSmallIcon であるリストビューの全アイコンを，指定された方法で配置します。

TListArrangement = (arAlignBottom, arAlignLeft, arAlignRight, arAlignTop, arDefault,

   arSnapToGrid);

procedure Arrange(Code: TListArrangement);

説明

Arrange メソッドは，ViewStyle プロパティが vsIcon か vsSmallIcon の場合にアイコンを整列できます。Code パラメータはアイコンの配置方法を指定します。Code パラメータの指定値は以下のとおりです。

値	意味

arAlignBottom	項目をウィンドウの下端に合わせる

arAlignLeft	項目をウィンドウの左端に合わせる

arAlignRight	項目をウィンドウの右端に合わせる

arAlignTop	項目をウィンドウの上端に合わせる

arDefault	ウィンドウが作成されている場合にリストビューに関連付けられた位置合わせスタイルに従って項目を合わせる。TCustomListView の場合，ウィンドウの上端に合わせる

arSnapToGrid	一番近いグリッド位置に全アイコンをスナップする


TCustomListView.CanChange
TCustomListView.CanChange3102046

TCustomListView	参照

CanChange メソッドは，リスト項目プロパティを変更できるかどうかを指定します。

function CanChange(Item: TListItem; Change: Integer): Boolean; dynamic;

説明

CanChange メソッドは，Item パラメータで指定された項目を変更しようとすると自動的に呼び出されます。Change パラメータは，変更の型を指定する Windows 定義の定数です。CanChange は OnChanging イベントを発生させて，その変更を許可するかどうかを決めます。CanChange は変更可能な場合に True を返し，そうでない場合は False を返します。 OnChanging イベントハンドラが存在しない場合，CanChange は常に True を返します。

CanChange をオーバーライドすると，変更処理を続行するのか OnChanging イベントをブロックするのかを決めるための方法を追加できます。


TCustomListView.CanEdit
TCustomListView.CanEdit3102047

TCustomListView	参照

CanEdit メソッドは，リスト項目のテキストを変更できるかどうかを指定します。

function CanEdit(Item: TListItem): Boolean; dynamic;

説明

CanEdit メソッドは，Item パラメータで指定したリスト項目のテキストを編集しようとすると自動的に呼び出されます。CanEdit は，その項目の変更を許可するかどうかを決めるために OnEditing イベントを発生させます。CanEdit は変更が許可される場合には True を返します。項目の編集をブロックする場合は CanEdit は False を返します。 OnEditing イベントハンドラが記述されていない場合，CanEdit は常に True を返します。

CanEdit をオーバーライドすると，項目の編集を許可するのか，OnEditing イベントをブロックするのかを決めるための論理を追加できます。


TCustomListView.Change
TCustomListView.Change3102048

TCustomListView	参照

Change メソッドは，OnChange イベントを発生させます。

procedure Change(Item: TListItem; Change: Integer); dynamic;

説明

Change メソッドは Item パラメータで指定された項目のプロパティが変わった後に自動的に呼び出されます。Change パラメータは発生した変更の型を指定する Windows 定義の定数です。

Change をオーバーライドすると，項目を変更するときや OnChange イベントをブロックするときに別の処理を実行できます。


TCustomListView.ColClick
TCustomListView.ColClick3102049

TCustomListView	参照

ColClick メソッドは，OnColumnClick イベントを発生させます。

procedure ColClick(Column: TListColumn); dynamic;

説明

ColClick メソッドは，ColumnClick プロパティと ShowColumnHeaders プロパティが True で ViewStyle プロパティが vsReport の場合にユーザーが列ヘッダーをクリックすると自動的に呼び出されます。ColClick をオーバーライドすると，ユーザーが列ヘッダーをクリックしたときや OnColumnClick イベントを条件付きでブロックするための追加の処理を実行できます。


TCustomListView.ColumnsShowing
TCustomListView.ColumnsShowing3102050

TCustomListView	参照

ColumnsShowing メソッドは，ViewStyle プロパティが vsReport かどうかを示します。

function ColumnsShowing: Boolean;

説明

ColumnsShowing を呼び出すとリストビューが項目を列に表示するかどうかを調べられます。ColumnsShowing は ViewStyle が vsReport の場合に True を返し，それ以外の場合には False を返します。


TCustomListView.Create
TCustomListView.Create3102051

TCustomListView	参照

Create メソッドは，TCustomListView のインスタンスを作成し初期化します。

constructor Create(AOwner: TListItems);

説明

Create メソッドを呼び出すと実行時にリストビューをインスタンス化できます。設計時にフォームに配置されたリストビューコントロールは自動的に作成されます。

継承されたコンストラクタの呼び出し後，Create は次のプロパティを初期化します。

・	BorderStyle を bsSingle に初期化する

・	ColumnClick と ShowColumnHeaders を True に初期化する

・	ControlStyle を [csClickEvents, csDoubleClick, csDisplayDragImage, csSetCaption] に初期化する

・	Height を 150 に，Width を 250 に初期化する

・	HideSelection を True に初期化する

・	TabStop を True に初期化する

・	ViewStyle を vsIcon に初期化する


TCustomListView.CreateListItem
TCustomListView.CreateListItem3102052

TCustomListView	参照

CreateListItem メソッドは，Items プロパティで指定されたコレクションのリスト項目を作成します。

function CreateListItem: TListItem; virtual;

説明

CreateListItem メソッドを呼び出すと Items コレクションに追加される TListItem オブジェクトを作成できます。CreateListItem はリスト項目を作成しますがコレクションに挿入はしません。


TCustomListView.CreateParams
TCustomListView.CreateParams3102053

TCustomListView	参照

CreateParams メソッドは，Params パラメータで渡されたウィンドウ作成パラメータレコードを初期化します。

procedure CreateParams(var Params: TCreateParams); override;

説明

CreateParams メソッドは，リストビューがウィンドウを作成する必要がある場合に，ウィンドウ作成パラメータを初期化するために自動的に呼び出されます。CreateParams は，リストビューコントロールのプロパティを設定するリストビューウィンドウを指定するために継承されたメソッドをオーバーライドします。

CreateParams メソッドをオーバーライドする場合，必ず継承されたメソッドを呼び出してから Params パラメータの値を変更してください。


TCustomListView.CreateWnd
TCustomListView.CreateWnd3102054

TCustomListView	参照

CreateWnd メソッドは，リストビューに使うウィンドを作成します。

procedure CreateWnd; override;

説明

CreateWnd メソッドは，CreateParams パラメータで指定されたパラメータ値に基づいてリストビューのウィンドウを作成します。次に，CreateWnd は新しいウィンドウにメッセージを送り，リストビューオブジェクトの現在のプロパティの設定をウィンドウに反映させます。


TCustomListView.CustomSort
TCustomListView.CustomSort3102055

TCustomListView	参照

CustomSort メソッドは，指定された順序付け関数を使ってリストの項目をソートします。

TLVCompare = function(lParam1, lParam2, lParamSort: Integer): Integer stdcall;

function CustomSort(SortProc: TLVCompare; lParam: Longint): Boolean;

説明

CustomSort メソッドを呼び出すと，SortProc パラメータで定義された順序付け関数を使ってリストの項目をソートできます。SortProc パラメータは，lParam1 と lParam2 として渡されたリスト項目を比較する順序付け関数を指定します。順序付け関数は lParam1 と lParam2 を比較して整数を返します。戻り値は，lParam1 が lParam2 と同じ場合は 0，lParam1 が lParam2 より大きい場合は正の値，lParam1 が lParam2 より小さい場合は負の値となります。CustomSort の lParam パラメータは順序付け関数に 3 番目のパラメータとして渡されるオプションの値です。

SortProc パラメータが nil の場合，CustomSort は OnCompare イベントを発生させるリスト項目を比較します。この比較によって，OnCompare イベントハンドラは lParam パラメータの値に基づいて別の順序基準（昇順と降順など）を提供できます。

順序付け関数を指定せず OnCompare イベントハンドラも設定しない場合，CustomSort はCaption の値に基づいて項目をアルファベット順でソートします。

CustomSort はリストのソートに成功すると True を返します。


TCustomListView.Delete
TCustomListView.Delete3102056

TCustomListView	参照

Delete メソッドは，リストビューから項目を削除して，割り当てられていたメモリを解放します。

procedure Delete(Item: TListItem); dynamic;

説明

Delete メソッドを呼び出すとリストビューから項目を削除できます。 Delete は OnDeletion イベントを発生させてからリスト項目を解放します。


TCustomListView.Destroy
TCustomListView.Destroy3102057

TCustomListView	参照

Destroy メソッドは，TCustomListView のインスタンスを破棄します。

destructor Destroy; override;

説明

直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出してください。Free メソッドは，リスト項目がまだ解放されていないことを確認してから Destroy メソッドを呼び出します。


TCustomListView.DestroyWnd
TCustomListView.DestroyWnd3102058

TCustomListView	参照

DestroyWnd メソッドは，リストビューのウィンドウハンドルで参照するウィンドウを破棄します。

procedure DestroyWnd; override;

説明

ウィンドウを破棄する前に，DestroyWnd はリストビューのコピーを内部記憶領域に保存します。次に，継承されたメソッドがすべてのデバイスコンテキストを解放してからウィンドウを破棄します。


TCustomListView.DoEndDrag
TCustomListView.DoEndDrag3102059

TCustomListView	参照

DoEndDrag メソッドは，OnEndDrag イベントを発生させます。

procedure DoEndDrag(Target: TObject; X, Y: Integer); override;

説明

OnEndDrag イベントを発生させてから，DoEndDrag はどの項目がドロップターゲットになるかをトラッキングするのに使った内部変数を消去します。


TCustomListView.DoStartDrag
TCustomListView.DoStartDrag3102060

TCustomListView	参照

DoStartDrag メソッドは，OnStartDrag イベントを発生させ，ドロップターゲットのトラッキングを開始します。

procedure DoStartDrag(var DragObject: TDragObject); override;

説明

DoStartDrag メソッドは，ユーザーがマウスでリスト項目をドラッグし始めると自動的に呼び出されます。OnStartDrag イベントを発生させた後，DoStartDrag はドラッグイメージを生成し，ドロップターゲットの位置を計算し始めます。


TCustomListView.Edit
TCustomListView.Edit3102061

TCustomListView	参照

Edit メソッドはユーザーがリスト項目の編集を終えた後にリスト項目の Caption プロパティを設定します。

procedure Edit(const Item: TLVItem); dynamic;

説明

Edit は，ユーザーがリスト項目のラベル編集を終えると自動的に呼び出されます。Edit は Windows のリスト項目から新しく編集された値を取得して，OnEdited イベントを発生させます。 ユーザーが指定した値を OnEdited イベントハンドラが変更してから，Edit はそのリスト項目の Caption プロパティを設定します。


TCustomListView.FindCaption
TCustomListView.FindCaption3102062

TCustomListView	参照

FindCaption メソッドは，指定されたキャプションのリストビュー項目がある場合にそれを返します。

function FindCaption(StartIndex: Integer; Value: string; Partial, Inclusive, Wrap: Boolean): TListItem;

説明

FindCaption メソッドを呼び出すと，Value パラメータで指定した文字列でラベル付けされたリストビュー項目を検索できます。Inclusive パラメータが True の場合，StartIndex で指定したリスト項目から検索が始まります。それ以外の場合，検索は次の項目から開始されます。Wrap パラメータが True の場合，一致する項目が見つからなければ先頭に戻って検索が続行されます。FindCaption は，Value に等しい Caption プロパティを持つ最初の項目を返します。Partial パラメータが True の場合，Caption が部分文字列 Value で始まっていれば検出されます。Partial パラメータが False の場合，Caption は Value と正確に一致しなければなりません。一致する項目が見つからない場合，FindCaption は nil を返します。


TCustomListView.FindData
TCustomListView.FindData3102063

TCustomListView	参照

FindData メソッドは，指定されたデータと関連付けられたリストビュー項目がある場合にそれを返します。

function FindData(StartIndex: Integer; Value: Pointer; Inclusive, Wrap: Boolean): TListItem;

説明

FindData メソッドを呼び出すと，Value パラメータと等しい Data プロパティを持つリストビュー項目を検索できます。Inclusive パラメータが True の場合，StartIndex で指定されたリスト項目から検索が始まります。それ以外の場合，検索は次の項目から開始されます。Wrap パラメータが True の場合，一致する項目が見つからなければ先頭に戻って検索が続行されます。FindData はValue パラメータに等しい Data プロパティを持つ最初の項目を返します。一致する項目が見つからない場合，FindData は nil を返します。


TCustomListView.GetDragImages
TCustomListView.GetDragImages3102064

TCustomListView	参照

GetDragImages メソッドは，リスト項目がドラッグされているときのカーソルのイメージを返します。

function GetDragImages: TCustomImageList; override;

説明

GetDragImages メソッドは，ユーザーがマウスボタンを押しながらドラッグしたときのドラッグイメージのリストを取得するのに自動的に呼び出されます。リスト項目のドラッグ中に，GetDragImages はリスト項目をドラッグし始めたときに作成されたドラッグイメージリストを返します。リスト項目上をドラッグしなかった場合，GetDragImages は nil を返します。


TCustomListView.GetItemAt
TCustomListView.GetItemAt3102065

TCustomListView	参照

GetItemAt メソッドは，指定された位置のリスト項目を返します。

function GetItemAt(X, Y: Integer): TListItem;

説明

GetItemAt メソッドを呼び出すと，X パラメータと Y パラメータで指定された位置のリスト項目の TListItem オブジェクトを取得できます。 X パラメータと Y パラメータは，リストビューの左上隅を原点とした位置の座標をピクセル単位で指定します。指定した位置にリスト項目がなかった場合，GetItemAt は nil を返します。


TCustomListView.GetItemIndex
TCustomListView.GetItemIndex3102066

TCustomListView	参照

GetItemIndex メソッドは，指定された項目の Items プロパティ配列でのインデックスを返します。

function GetItemIndex(Value: TListItem): Integer;

説明

GetItemIndex メソッドを呼び出すとリスト項目の位置を調べられます。0 ならば最初の項目を示し，1 ならば 2 番目の項目を示します。Value プロパティで指定された項目がリストビューに入っていない場合，GetItemIndex は -1 を返します。


TCustomListView.GetNearestItem
TCustomListView.GetNearestItem3102067

TCustomListView	参照

GetNearestItem メソッドは，特定の方向で指定されたポイントに一番近い項目を返します。

function GetNearestItem(Point: TPoint; Direction: TSearchDirection): TListItem;

説明

GetNearestItem メソッドを呼び出すと，リストビューの左上隅を原点としたピクセル単位の座標で指定された位置からリスト項目を検索できます。GetNearestItem は Point パラメータで指定した位置から検索を始めて，最初の項目を見つけるまで Direction パラメータで指定された方向に検索を続行します。

以下に Direction パラメータの指定値を示します。

値	意味

sdLeft	GetNearestItem は指定したポイントの左側を検索する

sdRight	GetNearestItem は指定したポイントの右側を検索する

sdAbove	GetNearestItem は指定したポイントの上側を検索する

sdBelow	GetNearestItem は指定したポイントの下側を検索する

sdAll	GetNearestItem は任意の方向で一番近い項目を返す

項目が見つからない場合，GetNearestItem は nil を返します。


TCustomListView.GetNextItem
TCustomListView.GetNextItem3102068

TCustomListView	参照

GetNextItem メソッドは，指定した方向で StartItem の次のリスト項目を返します。

function GetNextItem(StartItem: TListItem; Direction: TSearchDirection; States: TItemStates)

   : TListItem;

説明

GetNextItem メソッドを呼び出すと，Direction パラメータで指定された方向で StartItem の次のリスト項目を検索できます。States パラメータで指定された状態の項目だけが対象になります。以下に Direction パラメータの指定値を示します。

値	意味

sdLeft	GetNextItem は指定した項目の左側を検索する

sdRight	GetNextItem は指定した項目の右側を検索する

sdAbove	GetNextItem は指定した項目の上側を検索する

sdBelow	GetNextItem は指定した項目の下側を検索する

sdAll	GetNextItem は Items プロパティに表示される項目の順に検索する

以下に State パラメータの指定値を示します。

値	意味

isNone	デフォルト状態の項目だけを返す

isCut	切り取り/貼り付けの処理状態にある項目だけを返す

isDropHilited	ドラッグアンドドロップのターゲットして強調表示された項目だけを返す

isFocused	ItemFocused プロパティの値を返す

isSelected	選択された項目だけを返す


TCustomListView.GetSearchString
TCustomListView.GetSearchString3102069

TCustomListView	参照

GetSearchString メソッドは，リストビューコントロールをインクリメンタルサーチし，一致した文字列を返します。

function GetSearchString: string;

説明

GetSearchString メソッドを呼び出すと，リストビューに入力フォーカスがあるときユーザーが入力した文字シーケンスを取得できます。ユーザーが 1 文字入力するたびに，リストビューはその文字を検索文字列に追加し，一致する項目を検索します。ユーザーの入力する 1 文字ごとに 1 秒未満のタイムアウト時間が設定されます。ユーザーが次の文字を入力する前にタイムアウト時間となった場合，インクリメンタルサーチ文字列はリセットされます。一致する項目が見つかるとその項目が選択され，必要であればその項目が表示されるまでスクロールが実行されます。


TCustomListView.InsertItem
TCustomListView.InsertItem3102070

TCustomListView	参照

InsertItem メソッドは，OnInsert イベントを生成します。

InsertItem generates an OnInsert event.

procedure InsertItem(Item: TListItem); dynamic;

説明

InsertItem メソッドは，Items プロパティリストに新しい項目が追加されると，リストビューオブジェクトによって内部的に呼び出されます。InserItem メソッドをオーバーライドすることにより，新しい項目が追加されたときに，OnInsert イベントに加えて派生クラスで特定の処理を行えます。または，OnInsert イベントの発生を回避できます。


TCustomListView.IsEditing
TCustomListView.IsEditing3102071

TCustomListView	参照

IsEditing メソッドは，リストビュー内で 1 つでも項目が編集中であれば True を返します。

function IsEditing: Boolean;

説明

IsEditing メソッドを呼び出すと，ユーザーがリスト内の項目のキャプションを編集中かどうかを調べられます。


TCustomListView.Notification
TCustomListView.Notification3102072

TCustomListView	参照

Notification メソッドは，イメージリストが解放された場合にイメージプロパティを更新して nil に設定します。

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

継承されたメソッドの呼び出し後，Notification メソッドは LargeImages，SmallImages，または StateImages のいずれかのプロパティで指定されたイメージリストが破棄されようとしているかどうかを調べます。破棄されようとしている場合，Notification は適当なプロパティを nil に設定します。


TCustomListView.Scroll
TCustomListView.Scroll3102073

TCustomListView	参照

Scroll メソッドは，リストビューの内容を指定された量だけスクロールします。

procedure Scroll(DX, DY: Integer);

説明

Scroll メソッドを呼び出すと，DX ピクセルだけ水平に，DY ピクセルだけ垂直にリストビューコントロールの内容をスクロールできます。


TCustomListView.StringWidth
TCustomListView.StringWidth3102074

TCustomListView	参照

StringWidth メソッドは，リストビューの現在のフォントをもとに文字列の幅を返します。

function StringWidth(S: string): Integer;

説明

StringWidth メソッドを呼び出すと，指定されたリストビューの現在のフォントを使う文字列を表示するのに必要な領域をピクセル単位で調べられます。


TCustomListView.UpdateColumn
TCustomListView.UpdateColumn3102075

TCustomListView	参照

UpdateColumn メソッドは，リストビューコントロールの Index パラメータで指定された列を更新します。

procedure UpdateColumn(Index: Integer);

説明

UpdateColumn メソッドは，リストビュー内の列の表示プロパティが変わると自動的に呼び出されます。UpdateColumn は，Columns プロパティの Index パラメータでインデックス付けされた TListColumn オブジェクトのプロパティに合うように列のイメージを調整します。

UpdateColumn は ColumnsShowing が False を返す場合には無効です。


TCustomListView.UpdateColumns
TCustomListView.UpdateColumns3102076

TCustomListView	参照

UpdateColumns メソッドは，リストビューコントロールに，すべての列のイメージを更新させます。

procedure UpdateColumns;

説明

UpdateColumns メソッドはリストビューの列のプロパティが変わると自動的に呼び出されます。UpdateColumn は，Columns プロパティに入っている TListColumn オブジェクトに対応するプロパティに合うようにすべての列のイメージを調整します。

UpdateColumns は ColumnShowing が False を返す場合には無効です。


TCustomListView.UpdateItems
TCustomListView.UpdateItems3102077

TCustomListView	参照

UpdateItems メソッドは，FirstIndex から LastIndex までの範囲の項目を再描画します。

procedure UpdateItems(FirstIndex, LastIndex: Integer);

説明

指定した範囲のリスト項目の表示イメージに影響する変更を行った後に呼び出します。


TCustomListView.WndProc
TCustomListView.WndProc3102078

TCustomListView	参照

WndProc メソッドは，リストビューに特定のメッセージ応答を提供します。

procedure WndProc(var Message: TMessage); override;

説明

WndProc メソッドは，項目の交信中にリストビューが再描画しないように継承されたメソッドをオーバーライドします。


スコープ3102079

protected

published

読み出し／書き込み

読み出し専用


スコープ3102080

protected


スコープ3102081

protected


継承3102082

TObject

TPersistent

TComponent

TControl

TWinControl


TCustomListView 例3102083

TCustomListView


TCustomMaskEdit
TCustomMaskEdit3103001

継承	プロパティ	メソッド	参照

TCustomMaskEdit はコントロールに入力されたテキストの有効性を調べるマスクを提供する編集コントロールが使う抽象基本型です。

ユニット

mask

説明

TCustomMaskEdit は，編集マスクを使って有効性を調べるように TCustomEdit の機能を拡張する新しいプロパティおよびメソッドを提供します。TCustomMaskEdit のマスク機能を利用するには TMaskEdit オブジェクトを使います。入力を調べる必要がなければ TEdit オブジェクトを使います。

TCustomMaskEdit のインスタンスは作成しないでください。TCustomMaskEdit はマスク編集コントロールを実現するコントロールオブジェクトを宣言する際の基本クラスとして使います。 TCustomMaskEdit のプロパティおよびメソッドは下位クラスが継承する動作，およびコンポーネントがオーバーライドしてカスタマイズできる動作を提供します。


TCustomMaskEdit プロパティ3103002

TCustomMaskEdit	アルファベット順	凡例

TCustomMaskEdit

EditMask

EditText

IsMasked

MaskState

MaxLength

Text

TCustomEdit からの継承

Modified

SelLength

SelStart

SelText

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomMaskEdit プロパティ3103003

TCustomMaskEdit	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

EditMask

EditText

Enabled

Handle

Height

HelpContext

Hint

IsMasked

Left

MaskState

MaxLength

Modified

Name

Owner

Parent

ParentWindow

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

Width

WindowProc


TCustomMaskEdit.EditMask
TCustomMaskEdit.EditMask3103004

TCustomMaskEdit	参照

EditMask プロパティは，マスク編集コントロールで有効なテキストを表すマスクです。

property EditMask: string;

説明

EditMask プロパティは，マスク編集コントロールにユーザーが入力できる文字を有効な文字および属性に制限できます。無効な文字をユーザーが入力しようとしても，編集コントロールは文字を受け付けません。文字の検査は ValidateEdit メソッドを使って 1 文字ずつ行われます。

マスクはセミコロンで区切られた 3 つの項目からなります。マスクの 1 つめの部分がマスク自身です。2 つめの部分にはマスクのリテラル文字もデータの一部として保存するかどうかを決める文字が入ります。3 つめの部分はマスクに入力できない文字を表すために使われます。

以下にマスクの 1 番目の項目で使われる特殊文字を示します。

文字	意味

!	! があれば，先頭部分の空白がデータに表れない。! がなければ，末尾部分の空白がデータに表れない

>	> があれば，マスク内または < までのすべての後続文字が大文字で表される

<	< があれば，マスク内または > までのすべての後続文字が小文字で表される

< >	 < > の2文字がいっしょにあれば，大文字と小文字は区別されず，入力するとおりにデータが構成される

\	\ に続く1文字はリテラル文字である。マスクで使う特殊文字をデータとして使う

L	この文字の位置には英字を1字だけ指定しなくてはならない。A～Z，a～zのいずれかを指定できる

l	この文字の位置には英字を1字だけ指定できるが指定しなくてもよい

A	この文字の位置には英数字を1字だけ指定しなくてはならない。A～Z，a～z，0～9のいずれかを指定できる

a	この文字の位置には英数字を1字だけ指定できるが指定しなくてもよい

C	この文字の位置には1文字だけ指定しなくてはならない

c	この文字の位置には1文字だけ指定できるが指定しなくてもよい

0	この文字の位置には数字を1字だけ指定しなくてはならない

9	この文字の位置には数字を1字だけ指定できるが指定しなくてもよい

#	この文字の位置には数字，正符号，負符号のいずれかを1字指定できるが指定しなくてもよい

:	時刻表示の時，分，秒を区切るのに使う。システムのコントロールパネルユーティリティの各国対応設定で時，分，秒を異なる文字で区切っている場合はその文字を使う

/	/ は日付の月，日，年を区切るのに使う。システムのコントロールパネルユーティリティの各国対応設定で月，日，年を異なる文字で区切っている場合はその文字を使う

;	; はマスクを区切るのに使う

_	_ は編集ボックスに自動的に空白を挿入する。フィールドに文字を入力するとカーソルは空白文字をスキップする。EditMaskプロパティエディタを使っている場合，空白を表す文字を変更できる。プログラムによってこの値を変更することもできる。次の表を参照

上記以外の任意の文字をリテラル文字としてマスクの 1 番目の部分に使うことができます。リテラル文字は編集コントロールにおいて正確に一致しなければなりません。リテラル文字は自動的に挿入され，編集時のカーソルはそれらをスキップします。特殊マスク文字も前にバックスラッシュ (\) を付ければリテラル文字として使うことができます。

マスクの 2 番目の項目はマスクからのリテラル文字が編集コントロールで使われるテキストに含まれるかどうかを示す 1 文字です。たとえば，市外局番を含む電話番号のマスクは次に示す文字列になります。

(000)_000-0000;0;*

1 番目の項目の 0 は編集コントロールで使われる Text プロパティが 10 桁の数字から構成され，編集コントロールに表示される電話番号を構成する 14 個の文字ではないことを示します。

2 番目の項目の 0 はリテラル文字を含んではならないことを示し，それ以外の文字が項目に使われている場合はリテラル文字を含むべきであることを示します。リテラル文字が必要かどうかを示す文字は EditMask プロパティエディタで変更するか，または MaskNoSave 型定数を変更することでプログラムで変更することができます。

マスクの 3 番目の項目は編集コントロールにおいて空白 (入力のない文字) として表示される文字です。デフォルトでは，これはリテラル空白を表す文字と同じです。これら 2 種類の文字は編集ウィンドウでは同様に表示されます。しかし，ユーザーがマスク編集コントロールのテキストを編集するときには，カーソルは空白文字を順に選択し，スペース文字をスキップします。

EditMask を空の文字列に設定するとマスクが削除されます。

注意

マルチバイトの文字セット（日本語の Shift-JIS など）を扱う場合，特殊なマスク文字はそれぞれ 1 バイトを表します。L，l，A，a，C，c などの指定子を使って 2 バイト文字を指定するには，マスク文字も重ねて指定しなくてはなりません。たとえば，LL は 2 つの 1 バイトアルファベット文字または 1 つの 2 バイト文字を表します。


TCustomMaskEdit.EditText
TCustomMaskEdit.EditText3103005

TCustomMaskEdit	参照

EditText プロパティは，マスク編集コントロールのウィンドウに表示されるテキストです。

property EditText: string;

説明

EditText プロパティは EditMask を使ってフォーマットされた編集コントロールで使われるテキストの値です。最初に，EditText は文字の入力がない場所を空白文字で埋めます。文字が入力されると，EditText の空白文字はユーザーが入力した値と置き換えられます。

テキストにリテラルマスク文字が含まれている場合，空白文字のかわりの文字がなければ， EditText と Text の値は同じです。

注意

EditText は実行時にのみ適用できます。


TCustomMaskEdit.IsMasked
TCustomMaskEdit.IsMasked3103006

TCustomMaskEdit	参照

IsMasked プロパティは，編集コントロールにマスクが存在するかどうかを示します。

property IsMasked: Boolean;

説明

IsMasked プロパティは，EditMask プロパティが設定されているかどうかを示します。IsMasked が True であれば，コントロールはマスクを持ち，入力は実行時に検証されます。IsMasked が False であれば，コントロールは実行時にも編集を制限しません。


TCustomMaskEdit.MaskState
TCustomMaskEdit.MaskState3103007

TCustomMaskEdit	参照

MaskState プロパティは，マスクがどのように適用されているかを示します。

TMaskedState = set of (msMasked, msReEnter, msDBSetText);

property MaskState: TMaskedState;

説明

MaskState プロパティはマスクが現在どのように適用されているかに応じて適切な動作を決定するように内部で使用されます。MaskState には以下の値があります。

値	意味

msMasked	マスクが割り当てられている。MaskState は IsMasked が True のときに msMasked をオンにする

msReEnter	無効な文字が拒否されたので次の文字は有効な代替文字でなければならない

msDBSetText	テキストはデータベース項目のものなので検証してはならない

MaskState は派生クラスがプロパティおよびメソッドを実装する際にこの情報を使用および管理できるように，Protected プロパティとして定義されています。


TCustomMaskEdit.MaxLength
TCustomMaskEdit.MaxLength3103008

TCustomMaskEdit	参照

MaxLength プロパティは，編集コントロールに表示できる文字数を指定します。

property MaxLength: Integer;

説明

MaxLength プロパティは EditText プロパティの長さです。MaxLength を設定して EditMask がないときに編集コントロールに表示される文字の長さをバイト数で制限します。EditMask がある場合，MaxLength はマスク自身によって示され，変更されることはありません。EditText は入力のない文字ごとに空白文字を含めることで，すべてのオプションセクションの前後をパディングして，オプションセクションの長さを一定にします。


TCustomMaskEdit.Text
TCustomMaskEdit.Text3103009

TCustomMaskEdit	参照

Text プロパティは，マスクが適用される以前からマスク編集コントロールにあるテキストです。

property Text: string;

説明

Text プロパティは，マスクによってフォーマットされる前のテキストの値を決定します。リテラル文字を削除するようにマスクで指定している場合，マスクがスペース文字を含む場合，またはユーザーが入力していない文字をマスクが含む場合には，Text はマスク編集コントロールで表示されている EditText とは異なります。Text は空白文字を含まず，スペース文字はカンマ ( , ) で置換されず，マスク中のリテラル文字は削除するようにマスクで指定されていれば削除されます。

Text を設定するとき，テキストの値はマスクを使ってフォーマットされ，その結果得られる EditText がウィンドウの更新に使用されます。

マスクがない場合，Text は編集コントロールに表示されるテキストです。


TCustomMaskEdit メソッド3103010

TCustomMaskEdit	アルファベット順	凡例

TCustomMaskEdit

CheckCursor

Clear

Create

EditCanModify

GetFirstEditChar

GetLastEditChar

GetMaxChars

GetNextEditChar

GetPriorEditChar

GetSel

GetTextLen

KeyDown

KeyPress

KeyUp

ReformatText

Reset

SetCursor

SetSel

ValidateEdit

ValidateError

TCustomEdit からの継承

ClearSelection

CopyToClipboard

CutToClipboard

GetSelTextBuf

PasteFromClipboard

SelectAll

SetSelTextBuf

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomMaskEdit メソッド3103011

TCustomMaskEdit	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

CheckCursor

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClearSelection

ClientToScreen

ContainsControl

ControlAtPos

CopyToClipboard

Create

CreateParented

CutToClipboard

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EditCanModify

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetFirstEditChar

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetLastEditChar

GetMaxChars

GetNamePath

GetNextEditChar

GetParentComponent

GetPriorEditChar

GetSel

GetSelTextBuf

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

KeyDown

KeyPress

KeyUp

MethodAddress

MethodName

NewInstance

PaintTo

PasteFromClipboard

Perform

Realign

ReformatText

Refresh

RemoveComponent

RemoveControl

Repaint

Reset

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetCursor

SetFocus

SetSel

SetSelTextBuf

SetTextBuf

Show

Update

UpdateControlState

ValidateEdit

ValidateError


TCustomMaskEdit.CheckCursor
TCustomMaskEdit.CheckCursor3103012

TCustomMaskEdit	参照

CheckCursor メソッドは，カーソルを最も近くの編集可能な文字に移動して，何も選択されていなければその文字を選択します。

procedure CheckCursor;

説明

CheckCursor メソッドを呼び出すとカーソルの位置が変更されるたびに呼び出されます。これにより，少なくとも 1 文字が常に選択されるようにします。マスク編集コントロールの編集はマスクに含まれる空白文字の置換なので，置換の対象となる範囲が常に存在しなければなりません。選択はマスクに含まれる 1 つまたは複数の非リテラル文字と対応し，マスクは空白であるかユーザーが再入力できる文字を含みます。


TCustomMaskEdit.Clear
TCustomMaskEdit.Clear3103013

TCustomMaskEdit	参照

Clear メソッドは，Text プロパティを空の文字列にします。

procedure Clear;

説明

Clear メソッドを呼び出すと，マスク編集コントロールに入力されたテキストをすべて削除できます。Clear は Text の値を空の文字列に設定します。EditMask をクリアすることはありません。編集コントロールにマスクがある場合，EditText は空にならず，すべての非リテラル文字が空白文字と置き換えられます。


TCustomMaskEdit.Create
TCustomMaskEdit.Create3103014

TCustomMaskEdit	参照

Create メソッドは，TCustomMaskEdit のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと TCustomMaskEdit オブジェクトをインスタンス化できます。Create は継承されたコンストラクタを呼び出した後で MaskState と空白代替文字を初期化します。


TCustomMaskEdit.EditCanModify
TCustomMaskEdit.EditCanModify3103015

TCustomMaskEdit	参照

EditCanModify メソッドは，ユーザーに Text の編集を許可します。

function EditCanModify: Boolean; virtual;

説明

TCustomMaskEdit によって定義された EditCanModify メソッドは常に True を返し，Text を編集できるようにします。 EditCanModify の主な用途は False を返すことで Text への変更を条件的に拒否できるメソッドへのインターフェースを提供することです。


TCustomMaskEdit.GetFirstEditChar
TCustomMaskEdit.GetFirstEditChar3103016

TCustomMaskEdit	参照

GetFirstEditChar メソッドは，最初の非リテラル文字の EditMask プロパティにおけるインデックス値を返します。

function GetFirstEditChar: Integer;

説明

GetFirstEditChar メソッドを呼び出すと，ユーザーが EditText を変更できる EditMask の先頭位置を見つけることができます。マスクがなければ，GetFirstEditChar はゼロを返します。

GetFirstEditChar は EditText のすべての非リテラル文字をプログラムで処理するための始点として使います。EditText の編集できる文字列をループして調べるには GetNextEditChar を使い，すべての非リテラル文字が処理されたかどうかを調べるには GetLastEditChar を使います。


TCustomMaskEdit.GetLastEditChar
TCustomMaskEdit.GetLastEditChar3103017

TCustomMaskEdit	参照

GetLastEditChar メソッドは，最後の非リテラル文字の EditMask におけるインデックス値を返します。

function GetLastEditChar: Integer;

説明

GetLastEditChar メソッドを呼び出すと，ユーザーが EditText を変更できる EditMask の末尾位置を見つけることができます。マスクがなければ，GetLastEditChar はテキストの長さを返します。


TCustomMaskEdit.GetMaxChars
TCustomMaskEdit.GetMaxChars3103018

TCustomMaskEdit	参照

GetMaxChars メソッドは，EditText の長さをバイト数で返します。

function GetMaxChars: Integer;

説明

マスクがある場合，GetMaxChars メソッドはすべての空白文字を含む EditText の長さを返します。これは，マスク編集コントロールでの編集では非リテラル文字を置き換えるので，MaxLength と同じです。マスクがない場合，GetMaxChars はウィンドウ内のテキストの長さを返します。この場合，GetMaxChars が返す値は編集コントロールに入力できる最大文字長（バイト数）である MaxLength よりも小さくなるでしょう。


TCustomMaskEdit.GetNextEditChar
TCustomMaskEdit.GetNextEditChar3103019

TCustomMaskEdit	参照

GetNextEditChar メソッドは，Offset 以降の非リテラル文字の最初のインデックス値を返します。

function GetNextEditChar(Offset: Integer): Integer;

説明

GetNextEditChar メソッドを呼び出すと，ユーザーが EditText を変更できる Offset 以降の EditMask の先頭位置を見つけることができます。Offset 以降に非リテラル文字がない場合，GetNextEditChar は MaxLength を返します。

GetNextEditChar を使って EditText 内の編集可能な文字を調べます。GetFirstEditChar の戻り値から始め，GetLastEditChar を使って，非リテラル文字の処理がすべて終了したかどうかを調べます。


TCustomMaskEdit.GetPriorEditChar
TCustomMaskEdit.GetPriorEditChar3103020

TCustomMaskEdit	参照

GetPriorEditChar メソッドは，Offset 以前の非リテラル文字の最初のインデックス値を返します。

function GetPriorEditChar(Offset: Integer): Integer;

説明

GetPriorEditChar メソッドを呼び出すと，Offset 以前の EditMask の先頭位置を見つけることができます。その位置で，ユーザーは EditText を変更できます。Offset 以前に非リテラル文字がない場合，GetPriorEditChar は Offset に続く最初の編集可能な文字を返します。


TCustomMaskEdit.GetSel
TCustomMaskEdit.GetSel3103021

TCustomMaskEdit	参照

GetSel メソッドは，EditText プロパティにおける現在の選択の終点を返します。

procedure GetSel(var SelStart: Integer; var SelStop: Integer);

説明

GetSel メソッドを呼び出すと，先頭文字のインデックスが 0 である EditText で選択された文字の先頭と末尾のインデックス値を取得できます。マスクがリテラル文字を含む場合，必ずしもすべての文字が編集可能である必要はありません。マスクがある場合，結果として得られるインデックス値を Text プロパティには使わないでください。EditText は Text にはない空白文字あるいは非リテラル文字を含んでいる場合があるからです。

選択したテキストをプログラムを変更するには，GetNextEditChar を使って SelStart から SelStop までの選択範囲にある編集可能な文字を一巡します。


TCustomMaskEdit.GetTextLen
TCustomMaskEdit.GetTextLen3103022

TCustomMaskEdit	参照

GetTextLen メソッドは，テキストの長さをバイト数で返します。

function GetTextLen: Integer;

説明

GetTextLen メソッドを呼び出すと，マスク編集コントロールの基本となるテキストの長さを調べることができます。基本テキストはまだマスクによって表示用にフォーマットされていません。また，コントロールのウィンドウに表示される EditText とは異なる場合があります。


TCustomMaskEdit.KeyDown
TCustomMaskEdit.KeyDown3103023

TCustomMaskEdit	参照

KeyDown メソッドは，プロセスナビゲーションキーおよび〔Del〕キーを処理する継承 KeyDown メソッドをオーバーライドします。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

procedure KeyDown(var Key: Word; Shift: TShiftState); override;

説明

KeyDown メソッドは継承された KeyDown メソッドを呼び出した後，マスク編集コントロール内のカーソル移動でカーソルが編集可能な文字の上に位置し，カーソル位置の文字を削除すると非リテラル文字が空白文字と置き換えられるようにします。派生オブジェクトでこのメソッドをオーバーライドすると，ユーザーがキーを押したときの処理をさらに変更することができます。


TCustomMaskEdit.KeyPress
TCustomMaskEdit.KeyPress3103024

TCustomMaskEdit	参照

KeyPress メソッドは〔Esc〕キーおよび〔Enter〕キーを処理する継承メソッドをオーバーライドします。

procedure KeyPress(var Key: Char); override;

説明

KeyPress メソッドは継承されたメソッドを呼び出した後で，〔Esc〕キーに対しては Reset メソッドを，〔Enter〕キーに対しては ValidateEdit メソッドを呼び出します。派生クラスでこのメソッドをオーバーライドすると，ユーザーが特定のキーを押したときの処理をさらに補うことができます。


TCustomMaskEdit.KeyUp
TCustomMaskEdit.KeyUp3103025

TCustomMaskEdit	参照

KeyUp メソッドは〔Ctrl〕＋〔←〕キーおよび〔Ctrl〕＋〔→〕キーを処理する継承メソッドを オーバーライドします。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

procedure KeyUp(var Key: Word; Shift: TShiftState); override;

説明

KeyUp メソッドは継承されたメソッドを呼び出した後で，〔Ctrl〕＋〔←〕キーおよび〔Ctrl〕＋〔→〕キーを使った選択が編集ウィンドウの編集可能なセクションで終わるようにします。派生クラスでこのメソッドをオーバーライドすると，ユーザーがキーを放したときの処理をさらに変更することができます。


TCustomMaskEdit.ReformatText
TCustomMaskEdit.ReformatText3103026

TCustomMaskEdit	参照

ReformatText メソッドは，基本となるテキストに NewMask のマスクを適用し，マスクの内部情報を更新します。

procedure ReformatText(const NewMask: string);

説明

ReformatText メソッドは実行時に EditMask プロパティを設定するための多くの作業を行います。しかし，MaskState プロパティやカーソル位置を扱えないので，ReformatText を EditMask プロパティの代わりに使うことはできません。


TCustomMaskEdit.Reset
TCustomMaskEdit.Reset3103027

TCustomMaskEdit	参照

Reset メソッドは，EditText の値を編集コントロールがフォーカスを失ったときのものに戻します。

procedure Reset; virtual;

説明

Reset メソッドはマスク編集コントロールに対する最新の編集を元に戻します。EditText の値はコントロールが最後にフォーカスを失ったときのものに戻り，フォーカスを再び得た時の値には戻りません。このため，編集コントロールがフォーカスを持っていない間に EditText にプログラムで加えられた変更も破棄されます。


TCustomMaskEdit.SetCursor
TCustomMaskEdit.SetCursor3103028

TCustomMaskEdit	参照

SetCursor メソッドは，カーソルを Pos 以前の最初の編集可能な文字に移動し，その文字を選択します。

procedure SetCursor(Pos: Integer);

説明

SetCursor メソッドは EditText のカーソルが編集可能な文字の上に常にあるようにカーソル位置を制御します。また，少なくとも 1 文字が常に選択されているようにします。マスク編集コントロールの編集ではマスクにある空白文字を置換するので，置換の対象が常に選択されていなければなりません。選択は マスク内の 1 つまたは複数の非リテラル文字に対応し，空白であるかユーザーが再入力できる文字を含んでいます。


TCustomMaskEdit.SetSel
TCustomMaskEdit.SetSel3103029

TCustomMaskEdit	参照

SetSel メソッドは，EditText プロパティの文字を SelStart から SelStop まで選択します。

procedure SetSel(SelStart: Integer; SelStop: Integer);

説明

SetSel メソッドは文字が編集可能であるかどうかに関係なく EditText の指定された範囲の文字を選択します。SelStart が SelStop と等しい場合は，SetSel はカーソルを SelStart 文字に置きます。SetSel を使うときには，ユーザーが置換する選択範囲を指定できるようにカーソルを編集可能な部分に残しておきます。

SetSel は SelText プロパティやクリップボードへのコピーによってキャプチャできる編集不可能な文字を選択するのに使えます。選択範囲をキャプチャしたら，CheckCursor を呼び出してカーソルを編集可能な位置に戻します。


TCustomMaskEdit.ValidateEdit
TCustomMaskEdit.ValidateEdit3103030

TCustomMaskEdit	参照

ValidateEdit メソッドは，現在のマスクと照合して EditText プロパティの検証を試みます。

procedure ValidateEdit;

説明

ValidateEdit メソッドはキー入力があったときとユーザーがマスク編集フィールドを出るときに EditText プロパティの検証を試みます。EditText が EditMask の指定と一致しない場合，ValidateEdit は ValidateError を呼び出して例外を生成し，EditMask と EditText の不一致が発生している場所の先頭位置にカーソルを戻します。


TCustomMaskEdit.ValidateError
TCustomMaskEdit.ValidateError3103031

TCustomMaskEdit	参照

ValidateError メソッドは，ビープ音を鳴らして EDBEditError 例外を生成します。

procedure ValidateError;

説明

ValidateEdit メソッドは EditMask と EditText が一致しないときに ValidateError メソッドを呼び出します。


スコープ3103032

protected

published

読み出し／書き込み

読み出し専用


スコープ3103033

protected


継承3103034

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomEdit


TCustomMaskEdit 例3103035

TCustomMaskEdit


TCustomMemo
TCustomMemo3104001

継承	プロパティ	メソッド	参照

TCustomMemo はメモコンポーネントの抽象基本型です。メモコンポーネントは TMemo および TDBMemo を含む複数行の編集コントロールです。

ユニット

stdctrls

説明

TCustomMemo は新しいプロパティおよびメソッドを追加し，TCustomEdit の機能を拡張して複数行の編集ボックスを扱えるようにしています。

TCustomMemo のインスタンスを作成しないでください。TCustomMemo は複数行の編集コントロールを実現するコントロールオブジェクトを宣言するときの基本クラスとして使います。TCustomMemo のプロパティおよびメソッドは派生クラスが継承する基本動作とともにコンポーネントがオーバーライドして動作をカスタマイズできる機能も提供します。


TCustomMemo プロパティ3104002

TCustomMemo	アルファベット順	凡例

TCustomMemo

Alignment

Lines

ScrollBars

WantReturns

WantTabs

WordWrap

TCustomEdit からの継承

Modified

SelLength

SelStart

SelText

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Text

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomMemo プロパティ3104003

TCustomMemo	オブジェクト順	凡例

Align

Alignment

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

Left

Lines

Modified

Name

Owner

Parent

ParentWindow

ScrollBars

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

WantReturns

WantTabs

Width

WindowProc

WordWrap


TCustomMemo.Alignment
TCustomMemo.Alignment3104004

TCustomMemo	参照	例

Alignment プロパティは，編集コントロール内のテキストを揃える方法を指定します。

property Alignment: TAlignment;

説明

Alignment プロパティは，編集コントロールでテキストがフォーマットされる方法を変更します。以下に Alignment の値を示します。

値	意味

taLeftJustify	テキストをコントロールの左端に揃える

taCenter	テキストをコントロールの横方向に中央揃えする

taRightJustify	テキストをコントロールの右端に揃える


TCustomMemo.Lines
TCustomMemo.Lines3104005

TCustomMemo	参照

Lines プロパティは，編集コントロールの内容を示します。

property Lines: TStrings;

説明

Lines プロパティは，編集コントロールのテキストを行単位で操作できます。Lines は TStrings オブジェクトなので，TStrings のメソッドを使って行のカウント，新しい行の追加，行の削除，あるいは新しいテキストによる行置換といった操作を行うことができます。

すべてのテキストを一度に扱うには，Text プロパティを使います。テキストを 1 行ずつ扱う場合は，Lines プロパティの方が便利です。


TCustomMemo.ScrollBars
TCustomMemo.ScrollBars3104006

TCustomMemo	参照

ScrollBars プロパティは，編集コントロールがスクロールバーを持つかどうかを決定します。

property ScrollBars: TScrollStyle;

説明

ScrollBars プロパティは，複数行編集コントロールに水平または垂直スクロールバーを付けるかどうかを制御します。以下に ScrollBars の値を示します。

値	意味

ssNone	スクロールバーなし

ssHorizontal	下端にスクロールバーを 1 つ付ける

ssVertical	右端にスクロールバーを 1 つ付ける

ssBoth	下端と右端の両方にスクロールバーを付ける


TCustomMemo.WantReturns
TCustomMemo.WantReturns3104007

TCustomMemo	参照

WantReturns プロパティは，ユーザーがテキストに改行文字を挿入できるかどうかを決定します。

property WantReturns: Boolean;

説明

WantReturns を True に設定するとユーザーがテキストに改行文字を入力できるようになります。WantReturns を False に設定するとフォームで改行文字を扱うようになります。

たとえば，デフォルトボタン（［OK］ボタンなど）とメモコントロールが配置されているフォームでは，WantReturns が False の場合，〔Enter〕キーを押すとデフォルトボタンが選択されます。WantReturns が True の場合，〔Enter〕キーを押すとテキストに改行文字が挿入されます。

注意

WantReturns が False の場合でも，〔Ctrl〕+〔Enter〕キーを押せばテキストに改行文字を挿入できます。


TCustomMemo.WantTabs
TCustomMemo.WantTabs3104008

TCustomMemo	参照

WantTabs プロパティは，ユーザーがテキストにタブを挿入できるかどうかを決めます。

property WantTabs: Boolean;

説明

WantTabs プロパティを True に設定するとユーザーがテキストにタブを挿入できるようになります。WantTabs を False に設定すると〔Tab〕キーを押すことでフォームの次のコントロールを選択できるようになります。

注意

WantTabs が True の場合，ユーザーは〔Tab〕キーを使って編集コントロールに入ることはできますが，コントロールから出ることができません。


TCustomMemo.WordWrap
TCustomMemo.WordWrap3104009

TCustomMemo	参照

WordWrap プロパティは，テキストが右マージンで折り返すようにソフトウェア的な改行を挿入するかどうかを決めます。

property WordWrap: Boolean;

説明

WordWrap を True に設定すると編集コントロールのテキストを右マージンで折り返してクライアント領域に収まるようにします。テキストの折り返しは外観のみであり，明示的に〔Enter〕キーが押された場合とは異なり，テキストに改行文字が挿入されるわけではありません。WordWrap を False に設定すると，編集コントロールは明示的に〔Enter〕が入力された場合にのみ改行文字を挿入します。

注意

WordWrap が True の場合，水平スクロールバーは使えません。


TCustomMemo メソッド3104010

TCustomMemo	アルファベット順	凡例

TCustomMemo

Create

CreateParams

CreateWindowHandle

Destroy

KeyPress

Loaded

SetAlignment

SetLines

SetScrollBars

SetWordWrap

TCustomEdit からの継承

Clear

ClearSelection

CopyToClipboard

CutToClipboard

GetSelTextBuf

PasteFromClipboard

SelectAll

SetSelTextBuf

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomMemo メソッド3104011

TCustomMemo	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClearSelection

ClientToScreen

ContainsControl

ControlAtPos

CopyToClipboard

Create

CreateParams

CreateParented

CreateWindowHandle

CutToClipboard

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetSelTextBuf

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

KeyPress

Loaded

MethodAddress

MethodName

NewInstance

PaintTo

PasteFromClipboard

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetAlignment

SetBounds

SetFocus

SetLines

SetScrollBars

SetSelTextBuf

SetTextBuf

SetWordWrap

Show

Update

UpdateControlState


TCustomMemo.Create
TCustomMemo.Create3104012

TCustomMemo	参照

Create メソッドは，TCustomMemo のインスタンスを作成および初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出して TCustomMemo オブジェクトをインスタンス化します。継承されたコンストラクタを呼び出した後で，Create はプロパティをいくつか調整してコントロールの初期値を以下のように設定します。

・	AutoSelect は True

・	AutoSize は False

・	BorderStyle は bsSingle

・	ControlStyle は [csClickEvents, csDoubleClicks, csFixedHeight, csSetCaption]

・	Height および Width はそれぞれ 89 と 188

・	HideSelection は True

・	ParentColor は False

・	TabStop は True

・	WantReturns は True

・	WordWrap は True

Create メソッドをオーバーライドする派生オブジェクトはさらに初期化をする前に継承された Create を呼び出さなくてはなりません。


TCustomMemo.CreateParams
TCustomMemo.CreateParams3104013

TCustomMemo	参照

CreateParams メソッドは，Params パラメータで渡されるウィンドウ作成パラメータを初期化します。

type

  TCreateParams = record

    Caption: PChar;

    Style: Longint;

    ExStyle: Longint;

    X, Y: Integer;

    Width, Height: Integer;

    WndParent: HWND;

    Param: Pointer

    WindowClass: TWndClass;

    WinClassName: array[0..63] of Char;

  end;

procedure CreateParams(var Params: TCreateParams); override;

説明

CreateWnd メソッドは，CreateParams を呼び出して CreateWindowHandle に渡すパラメータを初期化します。TCustomEdit はスクロール可能な複数行編集コントロールを指定する継承されたメソッドをオーバーライドします。Params パラメータは継承されたメソッドが指定する BorderStyle，HideSelections，PasswordChar，および ReadOnly プロパティのほかに，Alignment， ScrollBars，および WordWrap の各プロパティの現在の値も反映するように更新されます。


TCustomMemo.CreateWindowHandle
TCustomMemo.CreateWindowHandle3104014

TCustomMemo	参照

CreateWindowHandle メソッドは，編集コントロールのウィンドウハンドルを作成します。

type

  TCreateParams = record

    Caption: PChar;

    Style: Longint;

    ExStyle: Longint;

    X, Y: Integer;

    Width, Height: Integer;

    WndParent: HWND;

    Param: Pointer

    WindowClass: TWndClass;

    WinClassName: array[0..63] of Char;

  end;

procedure CreateWindowHandle(const Params: TCreateParams); override

説明

CreateWindowHandle は継承されたメソッドをオーバーライドして Params のCaption をウィンドウのキャプションとしてではなく初期テキストとして解釈します。


TCustomMemo.Destroy
TCustomMemo.Destroy3104015

TCustomMemo	参照

Destroy メソッドは，TCustomMemo のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TCustomMemo オブジェクトがまだ解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy は Lines プロパティを実現する TStrings オブジェクトを解放してから継承されたデストラクタを呼び出します。


TCustomMemo.KeyPress
TCustomMemo.KeyPress3104016

TCustomMemo	参照

KeyPress メソッドは，デフォルトメソッドをオーバーライドして WantReturn が False のときにはテキストに改行文字が入力されないようにします。

procedure KeyPress(var Key: Char); override;

説明

継承された KeyPress を呼び出した後で，OnKeyPress イベントハンドラが呼び出され，KeyPress は WantReturns が False のときに改行文字を破棄します。


TCustomMemo.Loaded
TCustomMemo.Loaded3104017

TCustomMemo	参照

Loaded メソッドは，Modified プロパティを初期化して False にします。

procedure Loaded; override;

説明

Loaded メソッドはストリームからコントロールを読み込んだ後で Modified プロパティを False に設定します。派生クラスは Loaded メソッドをオーバーライドしてコントロールがストリームからロードされた後の初期化を行うことができます。


TCustomMemo.SetAlignment
TCustomMemo.SetAlignment3104018

TCustomMemo	参照

SetAlignment メソッドは，Alignment プロパティを設定します。

procedure SetAlignment(Value: TAlignment);

説明

SetAlignment メソッドは派生クラスが Alignment プロパティをカスタマイズできるように Protected メソッドとして定義されています。


TCustomMemo.SetLines
TCustomMemo.SetLines3104019

TCustomMemo	参照

SetLines メソッドは，Lines プロパティを設定します。

procedure SetLines(Value: TStrings);

説明

SetLines メソッドは派生クラスが Lines プロパティをカスタマイズできるように Protected メソッドとして定義されています。


TCustomMemo.SetScrollBars
TCustomMemo.SetScrollBars3104020

TCustomMemo	参照

SetScrollBars メソッドは，ScrollBars プロパティを設定します。

procedure SetScrollBars(Value: TScrollStyle);

説明

SetScrollBars メソッドは派生クラスが ScrollBars プロパティをカスタマイズできるように Protected メソッドとして定義されています。


TCustomMemo.SetWordWrap
TCustomMemo.SetWordWrap3104021

TCustomMemo	参照

SetWordWrap メソッドは，WordWrap プロパティを設定します。

procedure SetWordWrap(Value: Boolean);

説明

SetWordWrap は派生クラスが WordWrap プロパティをカスタマイズできるように Protected メソッドとして定義されています。


スコープ3104022

protected

published

読み出し／書き込み

読み出し専用


スコープ3104023

protected


継承3104024

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomEdit


TCustomMemo 例3104025

TCustomMemo


TCustomMemoryStream
TCustomMemoryStream3105001

継承	プロパティ	メソッド	参照

TCustomMemoryStream オブジェクトは，メモリストリームの共通の上位オブジェクトとして使われる抽象基本クラスです。

ユニット

classes

説明

TCustomMemoryStream オブジェクトは，メモリに格納されているデータを転送できるストリームオブジェクトを定義するときに基本クラスとして使います。メモリストリームは，アクセスが容易でない媒体に格納されているデータの入出力アクセスに便利です。メモリストリームを作成すると，データは内部メモリバッファに移されます。メモリストリーム内でデータに処理を加えた後で，メモリストリームを破棄してデータを実際に記憶媒体に書き込むことができます。

TCustomMemoryStream はインスタンス化しないでください。TCustomMemoryStream のインスタンスは，すべてのメモリストリームに共通な動作を実現する抽象クラスです。メモリストリームのインスタンスを使うときは，TMemoryStream や TResourceStream などの TCustomMemoryStream の下位オブジェクトを使用します。


TCustomMemoryStream プロパティ3105002

TCustomMemoryStream	アルファベット順	凡例

TCustomMemoryStream

Memory

TStream からの継承

Position

Size


TCustomMemoryStream プロパティ3105003

TCustomMemoryStream	オブジェクト順	凡例

Memory

Position

Size


TCustomMemoryStream.Memory
TCustomMemoryStream.Memory3105004

TCustomMemoryStream	参照

Memory プロパティは，メモリストリームに割り当てたメモリプールに直接アクセスできるようにします。

property Memory: Pointer;

説明

Memory プロパティを呼び出すと，ストリームに割り当てたメモリにアクセスできます。ストリームに割り当てたメモリには，メモリストリームとして転送するデータが格納されています。Size プロパティは Memory に割り当てられたバイト数で，Position プロパティは Memory 内での現在位置を示します。

注意

Memory は読み出し専用のプロパティです。Memory プロパティを使ってメモリの内容を変更することはできますが，ストリームが使用する実際のメモリを設定するには，TCustomMemoryStream の下位オブジェクトで，SetPointer メソッドを呼び出してポインタをメモリバッファに割り当てる必要があります。


TCustomMemoryStream メソッド3105005

TCustomMemoryStream	アルファベット順	凡例

TCustomMemoryStream

Read

SaveToFile

SaveToStream

Seek

SetPointer

TStream からの継承

CopyFrom

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

Write

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCustomMemoryStream メソッド3105006

TCustomMemoryStream	オブジェクト順	凡例

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyFrom

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Read

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

SafeCallException

SaveToFile

SaveToStream

Seek

SetPointer

Write

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes


TCustomMemoryStream.Read
TCustomMemoryStream.Read3105007

TCustomMemoryStream	参照

Read メソッドは，メモリストリームから Count で指定するバイト数を Buffer に読み出し，ストリームの現在位置を読み出したバイト数だけ進めます。

function Read(var Buffer; Count: Longint): Longint; override;

説明

Read メソッドを呼び出すと，メモリストリームの内容をバッファに読み出すことができます。Read メソッドは Memory 内の現在位置から Count で指定するバイト数を読み出します。Count で指定するバイト数がメモリバッファの最後を超えている場合は，Read メソッドは関連付けられたメモリバッファの最後のデータまでを転送するだけです。Read メソッドは実際に Buffer に転送したバイト数を返し，その分だけ現在位置を進めます。戻り値が Count 値より少ない場合，ストリームの最後まで読み出したことを意味しています。

メモリストリームのデータを読み出す他のメソッド（ReadBuffer，ReadComponent）は，実際に読み出しを行うために Read メソッドを呼び出します。

注意

Read メソッドは Count を上限とみなします。これに対して ReadBuffer メソッドは，Count で指定するバイト数を読み出せない場合は例外を生成します。


TCustomMemoryStream.SaveToFile
TCustomMemoryStream.SaveToFile3105008

TCustomMemoryStream	参照

SaveToFile メソッドは，メモリストリームの全内容を指定した名前のファイルに書き込みます。

procedure SaveToFile(const FileName: string);

説明

SaveToFile メソッドを呼び出すと，Memory の内容をファイルに書き込むことができます。SaveToFile メソッドを使えば，アプリケーションはファイルストリームオブジェクトの作成と解放を明示的に行う必要なしに，メモリストリームの内容を書き出すことができます。指定したファイルを作成または開くことができない場合，SaveToFile メソッドは EFCreateError 例外を生成します。


TCustomMemoryStream.SaveToStream
TCustomMemoryStream.SaveToStream3105009

TCustomMemoryStream	参照

SaveToStream メソッドは，メモリストリームの全内容を Stream で指定するストリームオブジェクトに書き込みます。

procedure SaveToStream(Stream: TStream);

説明

SaveToStream メソッドを呼び出すと，メモリに格納されているデータを別の記憶媒体にコピーできます。SaveToStream メソッドは Memory の全内容を，パラメータとして渡したストリーム内の現在位置から，指定したストリームオブジェクトに書き込みます。

Stream パラメータに TFileStream オブジェクトを指定したときは，SaveToStream メソッドは SaveToFile メソッドとほぼ同じように動作します。ただし，SaveToStream メソッドは，ターゲットストリーム内の現在位置に書き込みを行います。したがって，SaveToStream メソッドは，たとえば Memory の内容をファイルストリームに追加するのに使用できますが，SaveToFile メソッドはファイルの内容を Memory の内容に置き換えるのに使用できます。

メモリストリームの全内容がターゲットストリームに書き込めない場合，SaveToStream メソッドは EWriteError 例外を生成します。


TCustomMemoryStream.Seek
TCustomMemoryStream.Seek3105010

TCustomMemoryStream	参照

Seek メソッドは，ストリームの現在位置を Origin で指定する原点から Offset で指定するバイト数だけ移動します。

function Seek(Offset: Longint; Origin: Word): Longint; override;

説明

Seek メソッドを呼び出すと，メモリストリーム内の現在位置を，指定したオフセットだけ移動できます。Seek メソッドを使えば，アプリケーションは，メモリストリームと関連付けられている Memory 内の特定の位置に読み書きを行えます。

Offset が負の数ならば，指定した原点から後方に移動します。次の表に Origin の値とその位置を示します。

値	意味

soFromBeginning	Offset は Memory の始めから。Offset の位置まで移動する。Offset >= 0

soFromCurrent	Offset は現在位置から。Position + Offset の位置まで移動する

soFromEnd	Offset は Memory の終わりから。Offset <= 0（メモリバッファの終わりより前のバイト数を指定するため）

Seek メソッドは新しい Position プロパティ値を返します。

注意

Seek メソッドは，Offset に指定した値についてエラーチェックを行いません。Seek メソッドを呼び出すときは，現在位置を 0 未満（Memory の先頭より前）または Size 値以上（メモリバッファの終わりより後）の位置に移動することになるオフセットは指定しないでください。


TCustomMemoryStream.SetPointer
TCustomMemoryStream.SetPointer3105011

TCustomMemoryStream	参照

SetPointer メソッドは，メモリストリームに関連付けられているメモリバッファを切り替えます。

procedure SetPointer(Ptr: Pointer; Size: Longint);

説明

SetPointer メソッドを呼び出すと，内部メモリバッファの Memory を，Ptr で渡す値に設定できます。Size は Ptr が指すバイト数です。

TCustomMemoryStream の下位オブジェクトでは，SetPointer メソッドを使って，メモリストリームをメモリストリーム用のデータを保持するメモリバッファに関連付ける必要があります。

注意

SetPointer メソッドは，メモリバッファを割り当て直す際，（もしある場合）既存の Memory 値を解放しません。TCustomMemoryStream の下位オブジェクトで SetPointer メソッドを使ってストリームのメモリプールを再割り当てする場合は，Memory プロパティが示すメモリを解放してから，SetPointer メソッドを呼び出してメモリバッファを割り当てる必要があります。


読み出し／書き込み3105012

読み出し専用


スコープ3105013

protected


継承3105014

TObject

TStream


TCustomMemoryStream 例3105015

TCustomMemoryStream


TCustomPanel
TCustomPanel3106001

継承	プロパティ	メソッド	イベント	参照

TCustomPanel コンポーネントは，Delphi のすべてのパネルコンポーネントの抽象基本クラスです。

ユニット

extctrls

説明

TCustomPanel は，構成要素として他のコントロールが含まれるオブジェクトを定義するときに基本クラスとして使います。パネルコンポーネントは，他のコントロールを中に入れてグループ化することができるコントロールです。

Align プロパティを使ってパネルをフォームと位置合わせすると，フォームのサイズを変更したときでもフォームに対して同一の相対位置が維持されます。たとえば，ユーザーがフォームの形やサイズを変えても，パネルが常にフォームの最上部に置かれるように位置合わせすることができます。このため，パネルはツールバーやステータスバーのように動作するコンポーネントを実装するのに便利です。たとえば，ツールバーやツールパレットを作成するには，コマンドを実行したりモードを設定したりするスピードボタンをパネルに追加します。


TCustomPanel プロパティ3106002

TCustomPanel	アルファベット順	凡例

TCustomPanel

Alignment

BevelInner

BevelOuter

BevelWidth

BorderStyle

BorderWidth

FullRepaint

Locked

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ParentColor

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomPanel プロパティ3106003

TCustomPanel	オブジェクト順	凡例

Align

Alignment

BevelInner

BevelOuter

BevelWidth

BorderStyle

BorderWidth

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

FullRepaint

Handle

Height

HelpContext

Hint

Left

Locked

Name

Owner

Parent

ParentColor

ParentWindow

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TCustomPanel.Alignment
TCustomPanel.Alignment3106004

TCustomPanel	参照

Alignment プロパティは，パネル内でどのようにキャプションを揃えるかを指定します。

TAlignment = (taLeftJustify, taRightJustify, taCenter);

property Alignment: TAlingment;

説明

Alignment プロパティを使うと，パネルのキャプションがパネルの左端，右端または中央のいずれかに揃えるように指定できます。

以下の値を指定できます。

値	意味

taLeftJustify	テキストをパネルの左端で揃える

taCenter	テキストをパネルの横方向に中央揃えする

taRightJustify	テキストをパネルの右端で揃える


TCustomPanel.BevelInner
TCustomPanel.BevelInner3106005

TCustomPanel	参照

BevelInner プロパティは，パネルの内部ベベルのスタイルを指定します。

TPanelBevel = (bvNone, bvLowered, bvRaised);

property BevelInner: TPanelBevel;

説明

BevelInner プロパティを使うと，パネルに指定した 3 次元のベベルの外観を与えることができます。パネルコンポーネントには 2 つのベベルがあります。外部ベベルはコントロール境界の隣に描画され，内部ベベルは BorderWidth プロパティで指定したピクセル数だけ外部ベベルより内側に描画されます。ベベルが描画される場合，ベベルの幅は BevelWidth プロパティになります。

BevelInner プロパティはパネルコンポーネントの内部ベベルのスタイルを指定します。次の値を指定できます。

値	意味

bvNone	内側ベベルなし

bvLowered	内側ベベルを陥没させる

bvRaised	内部ベベルを隆起させる


TCustomPanel.BevelOuter
TCustomPanel.BevelOuter3106006

TCustomPanel	参照

BevelOuter プロパティはパネルの外部ベベルのスタイルを指定します。

TPanelBevel = (bvNone, bvLowered, bvRaised);

property BevelInner: TPanelBevel;

説明

BevelOuter プロパティを使うと，パネルに目的の 3 次元のベベルの外観を与えることができます。パネルコンポーネントには 2 つのベベルがあります。外部ベベルはコントロール境界の隣に描画され，内部ベベルは BorderWidth プロパティで指定したピクセル数だけ離れて外部ベベルより内側に描画されます。外部ベベルの幅は BevelWidth プロパティでピクセル数で指定します。

次の値を指定できます。

値	意味

bvNone	外部ベベルなし

bvLowered	外部ベベルを陥没させる

bvRaised	外側ベベルを隆起させる


TCustomPanel.BevelWidth
TCustomPanel.BevelWidth3106007

TCustomPanel	参照

BevelWidth プロパティは，パネルの内部ベベルと外部ベベルの幅をピクセル数で指定します。

TBevelWidth = 1..MaxInt;

property BevelWidth: TBevelWidth;

説明

BevelWidth プロパティを使うと，内部ベベルまたは外部ベベルの幅を指定できます。BevelWidth プロパティと BorderWidth プロパティとを混同しないようにしてください。BevelWidth プロパティはベベルの幅で，BorderWidth プロパティは内部ベベルと外部ベベルとの間の間隔です。

BevelInner プロパティと BevelOuter プロパティがともに bvNone の場合，BevelWidth は無効です。両方のベベルを除去するには，BevelWidth を 0 に設定するのではなく，BevelInner プロパティと BevelOuter プロパティを bvNone に設定します。その方が描画の際のオーバーヘッドが小さくなります。


TCustomPanel.BorderStyle
TCustomPanel.BorderStyle3106008

TCustomPanel	参照

BorderStyle プロパティは，パネルコントロールの周囲に描く線のスタイルを指定できます。

property BorderStyle: TBorderStyle;

説明

BorderStyle プロパティを使うと，パネルの周囲に一重線を描くかどうかを指定できます。次の値を指定できます。

値	意味

bsNone	非可視境界

bsSingle	一重境界線

パネルの周囲に描かれる線とパネルの BorderWidth とを混同しないようにしてください。BorderWidth プロパティは外部ベベルと内部ベベルとの間の距離です。


TCustomPanel.BorderWidth
TCustomPanel.BorderWidth3106009

TCustomPanel	参照

BorderWidth プロパティは，外部ベベルと内部ベベルとの間の距離をピクセル数で指定します。

TBorderWidth: 0..MaxInt;

property BorderWidth: TBorderWidth;

説明

BorderWidth プロパティを使うと，パネルの周囲の境界線の幅を指定できます。値が 0 の場合，境界線は表示されません。

パネルの境界線は外部ベベルと内部ベベルとの間の領域です。境界線は，内部ベベルが隆起しているか，陥没している場合に見えるだけですが，BevelInner が bvNone の場合でも，パネル内でのキャプションの位置に影響します。Alignment プロパティが taCenter でない場合，Caption は境界線の内側の端に揃えられます。この端は，BevelInner が bvNone の場合は外部ベベルからBorderWidth で指定されるピクセル数分だけ内側で，それ以外の場合は内部ベベルの内側の端になります。

パネルの境界線と，パネルの周囲に描かれる線とを混同しないようにしてください。パネルの周囲に描かれる線は BorderStyle プロパティで指定します。


TCustomPanel.FullRepaint
TCustomPanel.FullRepaint3106010

TCustomPanel	参照

FullRepaint プロパティは，カスタムパネルが WM_SIZE メッセージを受け取ったときに Invalidate メソッドが呼び出されるかどうかを指定します。

property FullRepaint: Boolean;

説明

パネルのサイズが変更されたときにパネルとパネル内のすべてのコントロールが再ペイントされるようにするには，FullRepaint プロパティを True に設定します。FullRepaint が False の場合，パネルとパネル内のコントロールは再描画されません。


TCustomPanel.Locked
TCustomPanel.Locked3106011

TCustomPanel	参照

Locked プロパティは，ツールバーとして使用中のパネルが OLE サーバーによって供給されるツールバーで置き換えられるかどうかを指定します。

property Locked: Boolean;

説明

TOleContainer コンポーネントでツールバーとしてパネルを使用するときは，Locked プロパティを False に設定します。Locked プロパティが True でなければ，TOleContainer に揃ったパネルはいずれも置き換え可能なツールバーとみなされます。パネルが OLE サーバーのツールバーで置き換えられないようにするには，パネルの Locked プロパティを True に設定します。

注意

OLE アプリケーションのツールバーは，フォームの側面のいずれかに揃ったパネル（つまり，その Align プロパティが alTop，alBottom，alLeft，alRight のいずれかに設定された状態）になければなりません。


TCustomPanel イベント3106012

TCustomPanel	アルファベット順	凡例

TCustomPanel

OnResize


TCustomPanel イベント3106013

TCustomPanel	オブジェクト順	凡例

OnResize


TCustomPanel.OnResize
TCustomPanel.OnResize3106014

TCustomPanel	参照

OnResize イベントはアプリケーションの実行中にパネルのサイズを変更したときに発生します。

TNotifyEvent = procedure (Sender: TObject) of object;

property OnResize: TNotifyEvent;

説明

OnResize イベントハンドラを記述すると，パネルのサイズ変更時に何かを実行されるようにすることができます。たとえば，パネルのサイズを変更したときに，パネルの子コントロールの位置が変更されるようにすることができます。


TCustomPanel メソッド3106015

TCustomPanel	アルファベット順	凡例

TCustomPanel

AlignControls

Create

CreateParams

Paint

Resize

TCustomControl からの継承

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomPanel メソッド3106016

TCustomPanel	オブジェクト順	凡例

AlignControls

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParams

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Paint

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

Resize

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TCustomPanel.AlignControls
TCustomPanel.AlignControls3106017

TCustomPanel	参照

AlignControls メソッドは，パネル内のすべてのコントロールの位置を合わせます。

procedure AlignControls(AControl: TControl; var Rect: TRect); override;

説明

AlignControls メソッドを使うと，一度にパネル内のすべてのコントロールの位置を合わせることができます。コントロールの位置合わせを行いたい領域を Rect パラメータの値として指定します。

AlignControls は個々の子コントロールの Align プロパティを使って子コントロールの位置合わせの方法を決めます。AControl パラメータとして渡されるコントロールは，他の同様に位置合わせされるコントロールより優先されます。AControl パラメータは nil でもかまいません。


TCustomPanel.Create
TCustomPanel.Create3106018

TCustomPanel	参照

Create メソッドは，TCustomPanel のインスタンスを作成し初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にパネルをインスタンス化できます。設計時にフォームに配置されたパネルは自動的に作成されます。

Create メソッドは，継承するコンストラクタを呼び出した後で，以下のプロパティを初期化します。

・	Alignment を taCenter に設定する

・	BevelOuter を bvRaised に，BevelWidth を 1 に設定する

・	BorderStyle を bsNone に設定する

・	Color を BtnFace に設定する

・	ControlStyle を [csAcceptsControls, csCaptureMouse, csClickEvents, csOpaque, csSetCaption, csDoubleClick, cdReplicatable]

・	FullRepaint を True に設定する

�	Height を 41 に，Width を 185 に設定する


TCustomPanel.CreateParams
TCustomPanel.CreateParams3106019

TCustomPanel	参照

CreateParams メソッドは，Params パラメータで渡されたウィンドウ作成用パラメータの内容を初期化します。

procedure CreateParams(var Params: TCreateParams); override;

説明

CreateParams メソッドは，パネル用のウィンドウの作成が必要になるたびに，ウィンドウ作成パラメータを初期化するために自動的に呼び出されます。CreateParams は継承するメソッドをオーバーライドして BorderStyle プロパティを実装します。


TCustomPanel.Paint
TCustomPanel.Paint3106020

TCustomPanel	参照

Paint メソッドは，パネルのイメージを描画します。

procedure Paint; override;

説明

Paint メソッドをオーバーライドすると，パネルの描画方法を変更できます。カスタムパネルの Paint メソッドは，パネルのベベルを描画し，パネルのブラシとフォントを設定し，パネルの内部を塗りつぶしてから，Windows API 関数 DrawText を呼び出して Caption を描画します。


TCustomPanel.Resize
TCustomPanel.Resize3106021

TCustomPanel	参照

Resize メソッドは，OnResize イベント用の Protected メソッドです。

procedure Resize; dynamic;

説明

カスタムコントロールは，コントロールまたはフォームのサイズが変更されたことを示す WM_SIZE メッセージを受け取ると Resize メソッドを呼び出します。Resize をオーバーライドすれば，OnResize イベントハンドラ呼び出しのほかにも応答ができます。

パネルの FullRepaint プロパティが Trueの場合，Resize はパネルを無効にしてから，OnResize イベントにメソッドが割り当てられていればそのメソッドを呼び出します。


スコープ3106022

protected

published

読み出し／書き込み

読み出し専用


スコープ3106023

protected


スコープ3106024

protected


継承

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl


TCustomPanel 例3106026

TCustomPanel


TCustomProvider
TCustomProvider3107001

継承	プロパティ	メソッド	イベント

多層データベースアプリケーションでアプリケーションサーバー用にカスタマイズされたデータ提供オブジェクトを派生させるための，抽象的な仮想基本クラスを提供します。

ユニット

provider

説明

TCustomProvider を使うと，ボーランドデータベースエンジン（BDE）を経由せずに多層データベースアプリケーションでアプリケーションサーバー用にカスタマイズされたデータプロバイダオブジェクトを派生させることができます。TCustomProvider のすべてのプロバイダオブジェクトに求められる基本動作は抽象メソッド宣言や後で派生されるオブジェクトでオーバーライドされ，仮想宣言で定義します。

一般に，TCustomProvider から派生したプロバイダは，クライアント上の TClientDataSet オブジェクトとアプリケーションサーバー上のデータセットオブジェクトとの間の中間リンクです。プロバイダはサーバーデータセットからのデータをパッケージし，1 つまたは複数の転送可能ブロックにしてクライアントデータセットに渡します。

クライアントデータセットはブロック化されたデータを受け取り，そのデータを再構築して，ユーザーアクセス用のローカルな，データのメモリ内コピーを作成します。ユーザーアクセスが完了すると，クライアントデータセットは変更があったデータをパッケージし直して，更新をアプリケーションサーバー上のプロバイダに送ります。プロバイダは更新をリモートデータベースサーバーに適用します。

TProvider は TCustomProvider から派生した BDE 有効プロバイダの一例です。

説明

TClientDataSet オブジェクト，TProvider オブジェクト


TCustomProvider プロパティ3107002

TCustomProvider	アルファベット順	凡例

TCustomProvider

Constraints

Data

Provider

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TCustomProvider プロパティ3107003

TCustomProvider	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Constraints

Data

DesignInfo

Name

Owner

Provider

Tag

VCLComObject


TCustomProvider.Constraints
TCustomProvider.Constraints3107004

TCustomProvider

Constraints プロパティは，クライアントのデータ要求に対してデータベース制約が適用されるかどうかを制御します。

property Constraints: WordBool;

説明

Constraints プロパティを設定すると，クライアントのデータ要求に対して，データベースアプリケーションサーバーのデータセットコンポーネントの基になっている 1 つまたは複数のデータベーステーブルに定義されている制約が適用されるかどうかを指定できます。Constraints が True（デフォルト）ならば，制約が適用されます。制約を無効にするには，Constraints を False に設定します。


TCustomProvider.Data
TCustomProvider.Data3107005

TCustomProvider	参照

Data プロパティは，プロバイダによって作成されたデータパケットを返します。

property Data: OleVariant;

説明

Data プロパティは，すべてのレコードが入ったデータパケットを作成するのに使う読み出し専用のプロパティです。TCustomProvider で実現されるときは，Data はパラメータを -1 に設定して GetRecords メソッドを呼び出します。GetRecords は null を返します。

「TCustomProvider から派生するオブジェクトは Data を取り出し，設定するメソッドを再定義する必要があります。」


TCustomProvider.Provider
TCustomProvider.Provider3107006

TCustomProvider

Provider プロパティは，プロバイダコンポーネントが実装するプロバイダインターフェースを指します。

property Provider: IProvider;

説明

Provider プロパティは，プロバイダコンポーネントがクライアントデータセットと通信するために実装するプロバイダインターフェースを指す，読み出し専用のプロパティです。


TCustomProvider イベント3107007

TCustomProvider	アルファベット順	凡例

TCustomProvider

OnDataRequest


TCustomProvider イベント3107008

TCustomProvider	オブジェクト順	凡例

OnDataRequest


TCustomProvider.OnDataRequest
TCustomProvider.OnDataRequest3107009

TCustomProvider	参照

OnDataRequest イベントは，プロバイダが自分の DataRequest メソッドを呼び出したときに発生します。

type

TDataRequestEvent = function(Sender: TObject; Input : OleVariant) : OleVariant of object;

property OnDataRequest: TDataRequestEvent;

説明

OnDataRequest イベントハンドラを記述すると，独自のデータ処理を行うことができます。アプリケーションは，プロバイダデータで作業するのにこのイベントハンドラを使う必要はありません。

OnDataRequest イベントハンドラを提供していないアプリケーションの場合，DataRequest メソッドを呼び出すと null が返されます。


TCustomProvider メソッド3107010

TCustomProvider	アルファベット順	凡例

TCustomProvider

ApplyUpdates

Create

DataRequest

Destroy

GetMetaData

GetMetaData

GetProvider

GetRecords

Get_Data

Reset

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomProvider メソッド3107011

TCustomProvider	オブジェクト順	凡例

ApplyUpdates

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DataRequest

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetMetaData

GetMetaData

GetNamePath

GetParentComponent

GetProvider

GetRecords

Get_Data

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

Reset

SafeCallException


TCustomProvider.ApplyUpdates
TCustomProvider.ApplyUpdates3107012

TCustomProvider

ApplyUpdates メソッドは，クライアントデータセットからリモートデータベースサーバーに接続されているデータセットが受け取った更新を適用する抽象仮想メソッドの宣言です。

function ApplyUpdates(Delta: OleVarant; MaxErrors: Integer; out ErrorCount: Integer);
OleVariant; virtual; abstract;

説明

ApplyUpdates メソッドは TCustomProvider では実装されず宣言されるだけです。

派生プロバイダコンポーネントで ApplyUpdates メソッドを実装すると，アプリケーションサーバーがクライアントの更新をリモートデータベースサーバーに書き込めるようになります。Delta は，データベースに書き込まれる，更新，挿入，削除されたレコードが入ったバリアントです。MaxErrors は更新処理が中止されるまでに許される最大エラー数を示します。ErrorCount は更新処理中に発生した実際のエラー数を示します。

ApplyUpdates は，データベースに適用できなかったすべてのレコードが入ったバリアントをデータパケットで返します。


TCustomProvider.DataRequest
TCustomProvider.DataRequest3107013

TCustomProvider	参照

DataRequest メソッドは，プロバイダのOnDataRequest イベントハンドラを呼び出します。

function DataRequest(Input: OleVariant): OleVariant;

説明

OnDataRequest イベントハンドラを記述し，DataRequest 関数を呼び出すと，実行時にそのイベントハンドラを呼び出すことができます。この関数とこの関数が発生させるイベントにより，アプリケーションはデータ要求に応答して独自の処理を実行できるようになります。

注意

アプリケーションコードは明示的に DataRequest を呼び出す必要があります。Delphi は DataRequest を呼び出しません。


TCustomProvider.Destroy
TCustomProvider.Destroy3107014

TCustomProvider	参照

Destroy メソッドは，プロバイダオブジェクトのインスタンスを解放します。

destructor Destroy;

説明

直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはオブジェクトが解放されていないことを確認してから Destroy メソッドを呼び出します。Destroy メソッドは，TCustomProvider オブジェクトに関連付けられているすべての IProvider オブジェクトを解放し，継承された Destroy メソッドを呼び出します。


TCustomProvider.Get_Data
TCustomProvider.Get_Data3107015

TCustomProvider	参照

Get_Data メソッドは，クライアント要求に応答してプロバイダのデータセットソースからレコードを取り出します。

function Get_Data: OleVariant; virtual;

説明

Get_Data メソッドを呼び出すと，クライアント要求に応答してデータを取り出すことができます。Get_Data メソッドはプロバイダのデータセットから一度にすべてのレコードを取り出します。プロバイダはデータセットソースからデータを取り出してデータパケットに構築し，そのパケットをクライアントにバリアントとして渡します。

Get_Data メソッドは，パラメータを -1 に設定して GetRecords メソッドを呼び出します。


TCustomProvider.GetMetaData
TCustomProvider.GetMetaData3107016

TCustomProvider	参照

GetMetaData メソッドは，データセットのメタデータが入ったデータパケットを取り出します。

function GetMetaData: variant;

説明

GetMetaData メソッドを呼び出すと，データセットのメタデータレコードを取り出すことができます。GetMetaData は，パラメータを -1 に設定して GetRecords メソッドを呼び出します。

説明

Get_Data メソッド，GetRecords メソッド


TCustomProvider.GetProvider
TCustomProvider.GetProvider3107017

TCustomProvider

GetProvider メソッドは，プロバイダに新しいプロバイダインターフェースオブジェクトを作成します。

function GetProvider: IProvider;

説明

GetProvider メソッドを呼び出すと，プロバイダコンポーネントに新しいプロバイダインターフェース（IProvider）を作成できます。GetProvider を呼び出すたびに，新しいプロバイダインターフェースが作成され，プロバイダコンポーネントによって保持される IProvider インターフェースの内部リストに追加されます。


TCustomProvider.GetRecords
TCustomProvider.GetRecords3107018

TCustomProvider	参照

GetRecords メソッドは，プロバイダのデータセットからデータを取り出します。

function GetRecords(Count: Integer; out RecsOut: Integer); OleVariant; virtual;

説明

派生プロバイダコンポーネントで GetRecords メソッドをオーバーライドすると，アプリケーションがプロバイダのデータセットから指定した数のレコードを取り出せるようになります。Count は取り出すレコードの数または種類を示します。Count が -1 の場合は，すべてのレコードが取り出されます。Count が 0 の場合は，メタデータレコードのみが取り出されます。Count が 0 より大きい場合は，指定した数のレコードだけが取り出されます。RecsOut は実際に取り出したレコード数を示します。レコードはバリアントのデータパケットとして返されます。

クライアントアプリケーションはプロバイダの GetRecords メソッドを呼び出してデータセットから利用可能なすべてのレコードの部分集合を取り出します。GetRecords は，非常に大きなデータセットを扱うときや，blob 項目があるデータセットを使うときに特に便利です。

TCustomProvider で実現されるときは，GetRecords は常に NULL を返します。

説明

DataRequest メソッド，Get_Data メソッド，GetMetaData メソッド


TCustomProvider.Reset
TCustomProvider.Reset3107019

TCustomProvider	参照

Reset メソッドは，レコードの取り出しをデータセットの先頭から再開するための仮想メソッドを実装します。

procedure Reset(MetaData: Boolean); virtual;

説明

派生プロバイダコンポーネントで Reset メソッドをオーバーライドすると，アプリケーションが GetRecords の繰り返し呼び出しを使って連続するレコードのブロックを取り出した後でデータセットの先頭からレコードの取り出しを開始できるようになります。それ以外の場合は，それぞれの取り出し処理は，以前の GetRecords 呼び出しで取り出された最後のレコードの次のレコードで開始されます。

MetaData は，次のレコード取り出しの呼び出しでメタデータが返されるかどうかを示します。MetaData が True なら，次の取り出しでメタデータが返されます。False ならば，データのみが返されます。

TCustomProvider で実現されるときは，Reset は何も行いません。

説明

GetRecords メソッド


スコープ3107020

protected

published

読み出し／書き込み

読み出し専用


スコープ3107021

protected


スコープ3107022

protected


継承3107023

TObject

TPersistent

TComponent


TCustomProvider 例3107024

TCustomProvider


TCustomRadioGroup
TCustomRadioGroup3108001

継承	プロパティ	メソッド	参照

TCustomRadioGroup はラジオグループコンポーネントの基本となるクラスです。

ユニット

extctrls

説明

ラジオグループは 1 つのグループボックス内のラジオボタンのコレクションです。TCustomRadioGroup は，ラジオグループコンポーネント（TRadioGroup や TDBRadioGroup など）の派生元となるクラスです。

同一のコントロールコンポーネント内に直接入っているラジオボタンは「グループ化されている」といいます。ユーザーが 1 つのラジオボタンにチェックマークを付けると，グループ内の他のラジオボタンのチェックマークはすべてはずれます。したがって，1 つのフォーム上に 2 つのラジオボタンがあるときは，それぞれが別々のコンテナ（グループボックスなど）に配置されている場合にのみ，同時にチェックマークを付けることができます。


TCustomRadioGroup プロパティ3108002

TCustomRadioGroup	アルファベット順	凡例

TCustomRadioGroup

Columns

ItemIndex

Items

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomRadioGroup プロパティ3108003

TCustomRadioGroup	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

ItemIndex

Items

Left

Name

Owner

Parent

ParentWindow

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TCustomRadioGroup.Columns
TCustomRadioGroup.Columns3108004

TCustomRadioGroup

Columns プロパティは，ラジオグループ内の列数を指定します。

property Columns: Integer

説明

Columns プロパティはラジオグループ内の列数を指定します。指定できる値は 1～16 までです。デフォルト値は 1 で，その場合ラジオボタンは縦 1 列に並べられます。


TCustomRadioGroup.ItemIndex
TCustomRadioGroup.ItemIndex3108005

TCustomRadioGroup

ItemIndex プロパティは，現在グループ内のどのラジオボタンが選択されているかを示します。

property ItemIndex: Integer

説明

ItemIndex プロパティは Items リストの選択されているラジオボタンの番号を保持します（最初のボタンの番号は 0）。ItemIndex の値は，実行時にユーザーがラジオボタンを選択するたびに変化します。アプリケーションの起動時にいずれかのボタンが選択されているようにするには，設計時に ItemIndex でそのボタンを指定します。起動時にどのボタンも選択されていないようにするには，ItemIndex をデフォルト値の -1 にしておきます。


TCustomRadioGroup.Items
TCustomRadioGroup.Items3108006

TCustomRadioGroup	参照

Items プロパティは，ラジオグループ内のラジオボタンのリストを保持します。

property Items: TStrings

説明

Items プロパティは，グループ内のラジオボタンのキャプションをリストする TStrings オブジェクトを保持します。TCustomRadioGroup の下位オブジェクトの TRadioGroup および TDBRadioGroup では（Items プロパティはパブリッシュに設定される），オブジェクトインスペクタで Items リストを編集してラジオボタンを追加または削除できます。

注意

ラジオグループオブジェクト内の項目は TCustomRadioGroup によって生成される特殊な TRadioButton のインスタンスです。別々に作成した TRadioButton インスタンスは，同じラジオグループに入れることはできません。


TCustomRadioGroup メソッド3108007

TCustomRadioGroup	アルファベット順	凡例

TCustomRadioGroup

CanModify

Create

Destroy

GetChildren

ReadState

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreatedParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomRadioGroup メソッド3108008

TCustomRadioGroup	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

CanModify

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreatedParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetChildren

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

ReadState

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TCustomRadioGroup.CanModify
TCustomRadioGroup.CanModify3108009

TCustomRadioGroup	参照

CanModify メソッドは，ユーザーがグループ内の別のラジオボタンを選択できるかどうかを決めます。

function CanModify: Boolean; virtual;

説明

イベントハンドラは，CanModify を呼び出して，ユーザーがグループ内の別のラジオボタンを選択できるかどうかを確認します。TCustomRadioGroup での定義ではこのメソッドは常に True を返しますが，ユーザーによる変更を許可しない場合には False を返すようにオーバーライドすることもできます。


TCustomRadioGroup.Create
TCustomRadioGroup.Create3108010

TCustomRadioGroup	参照

Create メソッドは，TCustomRadioGroup インスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは継承されたコンストラクタメソッドを呼び出して，TCustomRadioGroup のプロパティを初期化します。Create メソッドは ControlStyle プロパティの csSetCaption および csDoubleClicks フラグを設定します。


TCustomRadioGroup.Destroy
TCustomRadioGroup.Destroy3108011

TCustomRadioGroup

Destroy メソッドは，TCustomRadioGroup インスタンスとそのラジオボタンを破棄します。

destructor Destroy; override;

説明

Destroy メソッドは，グループ内の各項目に割り当てられているメモリを解放してから，継承デストラクタメソッドを呼び出します。


TCustomRadioGroup.GetChildren
TCustomRadioGroup.GetChildren3108012

TCustomRadioGroup	参照

GetChildren メソッドは，TCustomRadioGroup の GetChildren メソッドは使用できません。

procedure GetChildren(Proc: TGetChildProc; Root: TComponent); override;

説明

TCustomRadioGroup は TWinControl をオーバーライドして GetChildren メソッドを無効にします。


TCustomRadioGroup.ReadState
TCustomRadioGroup.ReadState3108013

TCustomRadioGroup	参照

ReadState メソッドは，ストリームからラジオグループのデータを読み出します。

procedure ReadState(Reader: TReader); override;

説明

ReadState メソッドは，継承した ReadState メソッドを呼び出して，ラジオグループのパブリッシュプロパティと他に格納されているデータをリーダーオブジェクトに読み出してから，グループ内のボタンを再描画します。


スコープ3108014

protected

published

読み出し／書き込み

読み出し専用


スコープ3108015

protected


継承3108016

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomGroupBox


TCustomRadioGroup 例3108017

TCustomRadioGroup


TCustomRemoteServer
TCustomRemoteServer3109001

継承	プロパティ	メソッド	イベント	参照

TCustomRemoteServer は，多層アプリケーションの一部であるクライアントアプリケーションでのリモートサーバー接続のための基本クラスです。

ユニット

dbclient

説明

TCustomRemoteServer は，開発者が多層データベースアプリケーションの一部であるクライアントアプリケーションのためのリモートサーバー接続オブジェクトを派生できる基本クラスオブジェクトです。TCustomRemoteServer から派生したリモートサーバーオブジェクトは，クライアントアプリケーションとアプリケーションサーバーとの間の接続を確立します。

アプリケーションで TCustomRemoteServer オブジェクトをインスタンス化しないでください。かわりに，TRemoteServer オブジェクトを使って接続を確立するか，または，TCustomRemoteServer から独自のカスタム接続オブジェクトを派生させるようにしてください。


TCustomRemoteServer プロパティ3109002

TCustomRemoteServer	アルファベット順	凡例

TCustomRemoteServer

ClientDataSets

Connected

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TCustomRemoteServer プロパティ3109003

TCustomRemoteServer	オブジェクト順	凡例

ClientDataSets

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Connected

DesignInfo

Name

Owner

Tag

VCLComObject


TCustomRemoteServer.ClientDataSets
TCustomRemoteServer.ClientDataSets3109004

TCustomRemoteServer	参照

ClientDataSets プロパティは，リモートサーバーに関連付けられているクライアントデータセットをリストします。

property ClientDataSets: TList;

説明

ClientDataSets プロパティは，プロバイダオブジェクトへのリンクを確立するためにこのリモートサーバーコンポーネントの接続を使っている TClientDataSet コンポーネントのリストを調べることができます。


TCustomRemoteServer.Connected
TCustomRemoteServer.Connected3109005

TCustomRemoteServer	参照

Connected プロパティは，リモートサーバーオブジェクトがリモートアプリケーションサーバーに接続されているかどうかを示します。

property Connected: Boolean;

説明

Connected プロパティは，リモートサーバーオブジェクトの現在の接続ステータスを取得または設定することができます。Connected の現在の値を呼び出す GetConnected メソッドは常に False を返すので，デフォルトでは，Connected は False です。

TCustomRemoteServer から独自のリモートサーバーオブジェクトを派生させる場合は，接続が確立されたら True を返すように GetConnected メソッドをオーバーライドし，DoConnect および DoDisconnect メソッドをオーバーライドする必要があります。


TCustomRemoteServer イベント3109006

TCustomRemoteServer	アルファベット順	凡例

TCustomRemoteServer

AfterConnect

AfterDisconnect

BeforeConnect

BeforeDisconnect


TCustomRemoteServer イベント3109007

TCustomRemoteServer	オブジェクト順	凡例

AfterConnect

AfterDisconnect

BeforeConnect

BeforeDisconnect


TCustomRemoteServer.AfterConnect
TCustomRemoteServer.AfterConnect3109008

TCustomRemoteServer	参照

AfterConnect イベントは，リモートサーバーがアプリケーションサーバーとの接続を確立した後に発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property AfterConnect: TNotifyEvent;

説明

AfterConnect イベントハンドラを記述すると，リモートサーバーがアプリケーションサーバーへの接続を確立した後で，アプリケーション特有のアクションが行われるようにすることができます。


TCustomRemoteServer.AfterDisconnect
TCustomRemoteServer.AfterDisconnect3109009

TCustomRemoteServer	参照

AfterDisconnect イベントは，リモートサーバーがアプリケーションサーバーへの接続を解除した後に発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property AfterDisconnect: TNotifyEvent;

説明

AfterDisconnect イベントハンドラを記述すると，リモートサーバーがアプリケーションサーバーへの接続を解除した後で，アプリケーション特有のアクションが行われるようにすることができます。


TCustomRemoteServer.BeforeConnect
TCustomRemoteServer.BeforeConnect3109010

TCustomRemoteServer	参照

BeforeConnect イベントは，リモートサーバーがアプリケーションサーバーとの接続を確立する前に発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property BeforeConnect: TNotifyEvent;

説明

BeforeConnect イベントハンドラを記述すると，リモートサーバーがアプリケーションサーバーへの接続を確立する前に，アプリケーション特有のアクションが行われるようにすることができます。


TCustomRemoteServer.BeforeDisconnect
TCustomRemoteServer.BeforeDisconnect3109011

TCustomRemoteServer	参照

BeforeDisconnect イベントは，リモートサーバーがアプリケーションサーバーへの接続を解除する前に発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property AfterDisconnect: TNotifyEvent;

説明

BeforeDisconnect イベントハンドラを記述すると，リモートサーバーがアプリケーションサーバーへの接続を解除する前に，アプリケーション特有のアクションが行われるようにすることができます。


TCustomRemoteServer メソッド3109012

TCustomRemoteServer	アルファベット順	凡例

TCustomRemoteServer

AddDataSet

Create

Destroy

DoConnect

DoDisconnect

GetConnected

GetProvider

GetProviderNames

Loaded

RemoveDataSet

SetConnected

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomRemoteServer メソッド3109013

TCustomRemoteServer	オブジェクト順	凡例

AddDataSet

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DoConnect

DoDisconnect

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetConnected

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetProvider

GetProviderNames

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Loaded

MethodAddress

MethodName

NewInstance

RemoveComponent

RemoveDataSet

SafeCallException

SetConnected


TCustomRemoteServer.AddDataSet
TCustomRemoteServer.AddDataSet3109014

TCustomRemoteServer	参照

AddDataSet メソッドは，サーバー接続にリストアップされているクライアントデータセットにクライアントデータセットを追加します。

procedure AddDataSet(DataSet: TClientDataSet);

説明

AddDataSet メソッドは，リモートサーバーがアプリケーションサーバーに接続できるクライアントデータセットのリストに，指定したクライアントデータセットを追加します。


TCustomRemoteServer.Create
TCustomRemoteServer.Create3109015

TCustomRemoteServer	参照

Create メソッドは，リモートサーバーコンポーネントをインスタンス化します。

constructor Create(AOwner: TComponent);

説明

Create メソッドはリモートサーバーコンポーネントをインスタンス化します。Create メソッドは継承するコンストラクタを呼び出し，このリモートサーバーのインスタンスを使うクライアントデータセットの名前の格納用に空のリストを作成します。


TCustomRemoteServer.Destroy
TCustomRemoteServer.Destroy3109016

TCustomRemoteServer	参照

Destroy メソッドは，このリモートサーバーコンポーネントのインスタンスを解放します。

destructor Destroy;

説明

直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはコンポーネントが解放されていないことを確認してから Destroy メソッドを呼び出します。Destroy メソッドはアプリケーションサーバーへの接続を解除し，コンポーネントのクライアントデータセットのリストを解放し，継承するデストラクタを呼び出します。


TCustomRemoteServer.DoConnect
TCustomRemoteServer.DoConnect3109017

TCustomRemoteServer	参照

DoConnect メソッドは，アプリケーションサーバーへの接続を確立するための仮想手続きです。

procedure DoConnect; virtual

説明

カスタムリモートサーバーコンポーネントを派生させる場合は，リモートサーバーコンポーネントから，プロバイダインターフェースを通じてデータを仲介するアプリケーションサーバーへの接続を確立するために DoConnect メソッドを実装する必要があります。TCustomRemoteServer で実現したときは，DoConnect は空の手続きです。

ActiveX を使った DoConnect の実装例，およびデュアルインターフェースの詳細は，TRemoteServer のソースコードを参照してください。


TCustomRemoteServer.DoDisconnect
TCustomRemoteServer.DoDisconnect3109018

TCustomRemoteServer	参照

DoDisconnect メソッドは，アプリケーションサーバーへの接続を解除するための仮想手続きです。

procedure DoDisonnect; virtual

説明

カスタムリモートサーバーコンポーネントを派生させる場合は，リモートサーバーコンポーネントと，プロバイダインターフェースを通じてデータを仲介するアプリケーションサーバーとの接続を解除するために DoDisconnect メソッドを実現する必要があります。TCustomRemoteServer で実現したときは，DoDisconnect は空の手続きです。


TCustomRemoteServer.GetConnected
TCustomRemoteServer.GetConnected3109019

TCustomRemoteServer	参照

GetConnected メソッドは，Connected プロパティのための読み出しメソッドとして機能するための仮想関数です。

function GetConnected: Boolean;

説明

TCustomRemoteServer からカスタムリモートサーバーオブジェクトを派生させる場合は，この関数をオーバーライドして，Connected プロパティの現在の値を読み出す必要があります。TCustomRemoteServer で定義したときは，GetConnected は常に False を返します。


TCustomRemoteServer.GetProvider
TCustomRemoteServer.GetProvider3109020

TCustomRemoteServer	参照

GetProvider メソッドは，アプリケーションサーバー上のプロバイダオブジェクトによって確立された IProvider インターフェースへのポインタを返す抽象仮想関数です。このインターフェースは，後でクライアントデータセットがデータ交換のためにプロバイダオブジェクトと直接通信するのに使われます。

function GetProvider (const ProviderName: string): IProvider; virtual;

説明

TCustomRemoteServer からカスタムリモートサーバーオブジェクトを派生させる場合は，この関数を実装して，クライアントアプリケーションがアプリケーションサーバーに接続するときにアプリケーションサーバーによって確立される IProvider インターフェースを返すようにする必要があります。IProvider インターフェースは，クライアントデータセットが，サーバーにデータを要求したり，更新をサーバーに送信してリモートデータベースサーバーに適用したりするのに使います。


TCustomRemoteServer.GetProviderNames
TCustomRemoteServer.GetProviderNames3109021

TCustomRemoteServer	参照

GetProviderNames メソッドは，アプリケーションサーバーから，利用可能なすべてのプロバイダオブジェクトのリストをリモートサーバーによって作成および保持されているリストへ取り出すための仮想手続きです。

procedure GetProviderNames(List: TStrings); virtual;

説明

TCustomRemoteServer からカスタムリモートサーバーオブジェクトを派生させる場合は，この手続きを実装して，クライアントアプリケーションがアプリケーションサーバーに接続するときにアプリケーションサーバーによって確立される利用可能なすべての IProvider インターフェースのリストを返すようにする必要があります。インターフェースは，このリモートサーバーを使うクライアントデータセットで利用可能になります。

TCustomRemoteServer で実装したときは，GetProviderNames は空の手続きです。


TCustomRemoteServer.Loaded
TCustomRemoteServer.Loaded3109022

TCustomRemoteServer	参照

Loaded メソッドは，フォームのロード時に，リモートサーバーコンポーネントがアプリケーションサーバーへ接続するための準備を行います。

procedure Loaded;

説明

アプリケーションは Loaded メソッドを呼び出す必要はありません。この手続きは Delphi によって自動的に呼び出されます。Loaded メソッドは，アプリケーションのロード時に，リモートサーバーコンポーネントがアプリケーションサーバーへ接続するための準備を行います。


TCustomRemoteServer.RemoveDataSet
TCustomRemoteServer.RemoveDataSet3109023

TCustomRemoteServer	参照

RemoveDataSet メソッドは，サーバー接続に知られているクライアントデータセットからクライアントデータセットを削除します。

procedure RemoveDataSet(DataSet: TClientDataSet);

説明

RemoveDataSet メソッドは，このリモートサーバーのアプリケーションサーバーへの接続を使えるクライアントデータセットのリストから，指定したクライアントデータセットを削除します。この手続きはクライアントデータセットオブジェクトによって自動的に呼び出されます。


TCustomRemoteServer.SetConnected
TCustomRemoteServer.SetConnected3109024

TCustomRemoteServer	参照

SetConnected メソッドは，クライアントアプリケーションとリモートアプリケーションサーバーとの間の接続を確立または解除します。

procedure SetConnected (Value: Boolean);

説明

SetConnected メソッドを呼び出すと，リモートサーバーからアプリケーションサーバーへの接続を確立または解除できます。Value が True ならば，SetConnected は BeforeConnect イベントハンドラを呼び出し，接続を確立して，AfterConnect イベントハンドラを呼び出します。Value が False ならば，SetConnected は BeforeDisconnect イベントハンドラを呼び出し，接続を解除して，AfterDisconnect イベントハンドラを呼び出します。


スコープ3109025

protected

published

読み出し／書き込み

読み出し専用


スコープ3109026

protected


スコープ3109027

protected


継承3109028

TObject

TPersistent

TComponent


TCustomRemoteServer 例3109029

TCustomRemoteServer


TCustomRichEdit
TCustomRichEdit3110001

継承	プロパティ	メソッド	イベント	参照

TCustomRichEdit オブジェクトは，TRichEdit のような書式付き編集コントロールが使う抽象基本型です。

ユニット

comctrls

説明

TCustomRichEdit オブジェクトは新しいプロパティおよびメソッドを追加して，書式付きテキストを扱えるように TCustomMemo の機能を拡張します。

TCustomRichEdit のインスタンスは作成しないでください。編集コントロールに書式付きテキストを扱う機能を追加するコントロールオブジェクトを宣言するには，TCustomRichEdit を基本型として使用します。TCustomRichEdit のプロパティおよびメソッドが提供する動作には，下位クラスで継承できるものや，コンポーネントでオーバーライドしてカスタマイズ可能なものがあります。


TCustomRichEdit プロパティ3110002

TCustomRichEdit	アルファベット順	凡例

TCustomRichEdit

DefAttributes

DefaultConverter

HideScrollBars

HideSelection

Lines

PageRect

Paragraph

PlainText

SelAttributes

TCustomEdit からの継承

Modified

SelLength

SelStart

SelText

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Text

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomRichEdit プロパティ3110003

TCustomRichEdit	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DefAttributes

DefaultConverter

DesignInfo

Enabled

Handle

Height

HelpContext

HideScrollBars

HideSelection

Hint

Left

Lines

Modified

Name

Owner

PageRect

Paragraph

Parent

ParentWindow

PlainText

SelAttributes

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

Width

WindowProc


TCustomRichEdit.DefAttributes
TCustomRichEdit.DefAttributes3110004

TCustomRichEdit	参照

DefAttributes プロパティは，書式付き編集コントロールのデフォルトフォントの書式を示す TTextAttributes 型オブジェクトです。

property DefAttributes: TTextAttributes;

説明

DefAttributes プロパティは，書式付き編集コントロールに新しくテキストを挿入する際のデフォルトフォント属性を指定します。このフォント属性が，特別な属性を適用していない状態のテキストの書式です。テキストの一部に特別な属性を設定すると，そのテキスト以降のテキストの属性はデフォルトの属性とはみなされません。これは，その属性が DefAttributes と同じ場合でも変わりません。

たとえば，書式付き編集コントロールに属性が設定されていなければ，入力されるテキストはすべてデフォルト属性になります。このとき，テキストの中央の部分を選択して特別な属性を適用すると (フォント変更など)，テキストはデフォルト属性のままの部分，特別な属性が適用された部分，そしてデフォルト属性と同じ設定でありながらデフォルト属性とはみなされなくなった部分の 3 つの部分に別れます。この状態で DefAttributes プロパティを変更すると，変更はデフォルト属性の部分にだけ反映されます。

テキストを新規に挿入する場合は，新しいテキストのフォント属性はカーソル位置のフォント属性と同じになり，選択した範囲に上書きで入力する場合は，選択されているテキストのフォント属性と同じになります。デフォルト属性のテキストに挿入されるテキストは，必ずデフォルト属性になります。

注意

DefAttributes は実行時のみのプロパティです。


TCustomRichEdit.DefaultConverter
TCustomRichEdit.DefaultConverter3110005

TCustomRichEdit	参照

DefaultConverter プロパティは，登録されていない拡張子を持つファイルを処理するときにネイティブなファイル形式と書式付きテキストコントロールの内部形式との変換に使われる TConversion オブジェクトの実クラスです。

type

TConversionClass = class of TConversion;

property DefaultConverter: TConversionClass;

説明

DefaultConverter プロパティは，登録されていない拡張子を持つファイルのテキスト入出力ストリームを処理する際の変換形式を指定できます。DefaultConverter が設定されていない場合，TCustomRichEdit は TConversion を使いますが，TConversion は実際には変換を行いません。TCustomRichEdit はテキスト属性を RTF 形式にエンコードします。そのため，認識されない拡張子のファイルは変換されず，テキスト形式または RTF 形式のサブセットのファイルに適した処理となります。

RTF 以外の書式付きテキストをエンコードするファイルの入出力ストリーム処理をサポートするには，そうしたファイルが使う拡張子とともに変換形式を登録します。DefaultConverter は，認識されない拡張子のファイルに適用される変換方法を変更する場合にのみ使用してください。

注意

ファイルに含まれるテキストの入出力ストリーム処理には，Lines プロパティを使います。


TCustomRichEdit.HideScrollBars
TCustomRichEdit.HideScrollBars3110006

TCustomRichEdit	参照	例

HideScrollBars プロパティは，不要なときにスクロールバーを隠すかどうかを決定します。

property HideScrollBars;

説明

HideScrollBars プロパティは，編集ウィンドウにすべてのテキストを表示できるときにスクロールバーを隠すかどうかを指定できます。HideScrollBars を False に設定すると，書式付き編集コントロールの内容にかかわらずスクロールバーが常に表示されます。

ScrollBars プロパティが ssNone (TRichEdit のデフォルト) のときは，HideScrollBars は処理を行いません。


TCustomRichEdit.HideSelection
TCustomRichEdit.HideSelection3110007

TCustomRichEdit	参照	例

HideSelection プロパティは，フォーカスが他のコントロールに移動した場合でもテキストが範囲選択された状態の表示を続けるかどうかを決定します。

property HideSelection: Boolean;

説明

HideSelection プロパティを False に設定すると編集コントロールがフォーカスを持たない状態でもテキストが選択されたときと同じ長方形領域を描画したままにします。HideSelection を True に設定すると編集コントロールがフォーカスを持っている場合にのみ選択された長方形領域を描画します。HideSelection は選択の実際の値には無関係で，その視覚的な表示にのみ影響します。常に HideSelection を False にしておくと編集コントロールの多いフォームが見づらくなる場合があります。


TCustomRichEdit.Lines
TCustomRichEdit.Lines3110008

TCustomRichEdit	参照	例

Lines プロパティは書式付きテキスト編集コントロールのテキストを行単位で保持します。

property Lines: TStrings;

説明

Lines プロパティは，書式付きテキスト編集コントロールのテキストを行単位で操作できます。Lines は TStrings オブジェクトなので，Lines でテキストの行数を数えたり，行の追加，削除，または置換といった操作をするには TStrings のメソッドを使うとよいでしょう。

テキストを文字単位で扱うには Text プロパティを使います。Lines プロパティはテキストを行単位で扱う処理に適しています。


TCustomRichEdit.PageRect
TCustomRichEdit.PageRect3110009

TCustomRichEdit	参照

PageRect プロパティは，書式付きテキスト編集コントロールの内容を印刷する際の論理ページのサイズを twip 単位で指定します。

property PageRect: TRect;

説明

PageRect プロパティは，印刷する書式付きテキスト編集コントロールの内容をフォーマットする際の論理ページサイズを指定できます。サイズは twip (1 ポイントの 1/20) 単位で指定します。


TCustomRichEdit.Paragraph
TCustomRichEdit.Paragraph3110010

TCustomRichEdit	参照	例

Paragraph プロパティは，現在のパラグラフの書式設定情報を指定します。

property Paragraph: TParaAttributes;

説明

Paragraph プロパティは，書式付き編集コントロールがパラグラフの書式設定情報を指定するのに使う TParaAttributes オブジェクトを取得できます。TParaAttributes オブジェクトを使って，現在のパラグラフの書式設定情報の読み取りおよび書き出しを行います。パラグラフの書式設定情報には，位置揃え，インデント，番号付け，およびタブの設定も含まれます。

Paragraph は読み出し専用のプロパティです。TCustomRichEdit オブジェクトには TParaAttributes オブジェクトが 1 つしかなく，しかもオブジェクトを追加することはできないからです。しかし，現在のパラグラフの属性は TParaAttributes オブジェクトのプロパティを使えば変更できます。属性を個別に設定したり，Paragraph.Assign を使って既存の TParaAttributes オブジェクトと同じ値に設定したりできます。

現在のパラグラフとは，選択されているテキストを含むパラグラフのことです。テキストが選択されていない場合は，カーソルがあるパラグラフが現在のパラグラフになります。

注意

Paragraph は実行時のみのプロパティです。


TCustomRichEdit.PlainText
TCustomRichEdit.PlainText3110011

TCustomRichEdit	参照	例

PlainText プロパティは，ファイルのテキストストリームの入出力処理において書式付き編集コントロールがテキストを単なるテキストとして扱うか，書式付きテキストとして扱うかを制御します。

property PlainText: Boolean;

説明

コントロールに含まれる書式付きテキストをテキストファイルに書き込むには，PlainText を True に設定します。こうするとファイルにエンコードされている書式情報が無視されるようになります。ファイルにエンコードされている書式情報をそのままファイルに保存する場合は PlainText を False に設定します。

ファイルの書式付きテキストの属性が RTF 形式以外でエンコードされている場合は，たとえ PlainText が True の場合でも，別の変換形式をサポートする変換ルーチンを DefaultHConverter に設定する必要があります。

注意

書式付き編集コントロールは，ストリーム処理自体はサポートしていません。ファイルからのストリーム入出力処理には Lines プロパティを使います。


TCustomRichEdit.SelAttributes
TCustomRichEdit.SelAttributes3110012

TCustomRichEdit	参照	例

SelAttributes プロパティは，書式付き編集コントロールで選択されているテキストの属性を示す TTextAttributes 型オブジェクトです。

property SelAttributes: TTextAttributes;

説明

SelAttributes プロパティは，現在選択されているテキストについて同じフォントの部分を探したり，同じフォントに設定したりできます。SelAttributes は TTextAttributes 型オブジェクトであり，フォント，色，サイズ，スタイル，および間隔といった書式を指定します。現在選択しているテキストの書式の 1 つを変更するには，SelAttributes で属性を設定します。現在選択しているテキストの書式をすべて変更するには，SelAttributes プロパティを，属性が設定されている TTextAttributes オブジェクトと同じにします。テキストを選択していない場合，SelAttributes はカーソル位置のテキストの書式を表します。

テキストを新規に挿入するときには，SelAttributes のフォント属性が適用されます。

注意

SelAttributes は実行時のみのプロパティです。


SelLength

SelLength プロパティは，選択された文字の数です。

property SelLength: Integer;

説明

SelLength プロパティは，選択したテキストの長さ（文字数）が取得できます。SelLength を設定すると，SelStart から始まる SelLength 分の文字で構成される選択範囲を指定できます。

注意

SelStart からテキストの末尾までの文字数より大きい値を SelLength に設定すると，SelStart からテキストの末尾までのすべての文字が選択されます。使用可能な文字数より大きい値を SelLength に設定した直後にこのプロパティを読み出すと，設定した値ではなく，実際に選択された文字数が返されます。


SelStart

SelStart プロパティは，テキスト内で最初に選択した文字の位置です。

property SelStart: Integer;

説明

SelStart プロパティは，最初に選択した文字の位置が取得できます（0 が最初の文字を示します）。テキストが選択されていない場合，SelStart はカーソルの位置を示します。SelStart を設定すると，現在の選択を解除して，指定した文字の直前にカーソルを移動できます。

テキスト内の特定の範囲を選択するには，SelStart を設定してカーソルを置いてから，SelLength を設定して選択範囲を広げます。


SelText

SelText プロパティは編集コントロールのテキストの選択部分です。

property SelText: string;

説明

SelText プロパティは，選択したテキストの値が取得できます。このプロパティを設定すると，選択したテキストを新しい文字列に置き換えることができます。テキストは選択されていないが，編集コントロールにフォーカスがあるという場合は，SelText を設定してカーソル位置でテキストに新しい文字列を挿入してください。


TCustomRichEdit イベント3110016

TCustomRichEdit	アルファベット順	凡例

TCustomRichEdit

OnProtectChange

OnResizeRequest

OnSaveClipboard

OnSelectionChange


TCustomRichEdit イベント3110017

TCustomRichEdit	オブジェクト順	凡例

OnProtectChange

OnResizeRequest

OnSaveClipboard

OnSelectionChange


TCustomRichEdit.OnProtectChange
TCustomRichEdit.OnProtectChange3110018

TCustomRichEdit	参照

OnProtectChange イベントは，プロテクト属性が設定されているテキストを変更しようとすると発生します。

type TRichEditProtectChange =

procedure(Sender: TObject; StartPos, EndPos: Integer; var AllowChange: Boolean) of object;

property OnProtectChange: TRichEditProtectChange;

説明

OnProtectChange のイベントハンドラを記述すると，プロテクト属性のテキストを変更できるようになります。StartPos パラメータと EndPos パラメータは変更が適用されるテキストの範囲の始点と終点を示し，テキストの 1 文字目を 0 とします。保護されているテキストを変更できるようにするには，AllowChange を True に設定します。

選択したテキストのプロテクト属性を設定または解除するには，目的のテキストを選択し，書式付き編集コントロールの SelAttributes プロパティの Protected プロパティを使います。デフォルトでテキストにプロテクト属性を設定するには，書式付き編集オブジェクトの DefAttributes プロパティの Protected プロパティを使います。


TCustomRichEdit.OnResizeRequest
TCustomRichEdit.OnResizeRequest3110019

TCustomRichEdit	参照

OnResizeRequest イベントは，テキストがコントロールのウィンドウからはみ出したときに発生します。

type

TRichEditResizeEvent = procedure(Sender: TObject; Rect: TRect) of object;

property OnResizeRequest: TRichEditResizeEvent;

説明

OnResizeRequest のイベントハンドラを記述すると，テキストの変更による編集コントロールのサイズ変更の通知を処理できます。Rect パラメータは，テキスト全体を表示するのに必要なウィンドウのサイズを画面座標で表します。


TCustomRichEdit.OnSaveClipboard
TCustomRichEdit.OnSaveClipboard3110020

TCustomRichEdit	参照

OnSaveClipboard イベントは，クリップボードに情報が格納されている編集コントロールのウィンドウを破棄しようとすると発生します。

type TRichEditSaveClipboard =

 procedure(Sender: TObject!ALink(TObject_Object,1); NumObjects, NumChars: Integer!ALink(Integer_Type,1); var SaveClipboard: Boolean!ALink) of object;

property OnSaveClipboard: TRichEditSaveClipboard;

説明

OnSaveClipboard のイベントハンドラを記述すると，編集コントロールのウィンドウを破棄する際に，編集コントロールの情報がクリップボードに格納されているという通知を処理できます。NumObjects パラメータはクリップボードにあるオブジェクトの番号を示し，NumChars はクリップボードにある文字の数を示します。編集コントロールの情報をクリップボードから消去するには，SaveClipboard を False に設定します。


TCustomRichEdit.OnSelectionChange
TCustomRichEdit.OnSelectionChange3110021

TCustomRichEdit	参照	例

OnSelectionChange イベントは，現在の選択範囲が変更されたときに発生します。.

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnSelectionChange: TNotifyEvent;

説明

OnSelectionChange のイベントハンドラを記述すると，テキストの選択範囲の変更を処理できます。選択範囲の変更は，ユーザーがマウスやキーボードを使って選択範囲を変更したり，SelText プロパティで選択範囲を変更したときに発生します。また，Lines プロパティを使うと選択範囲の一部を変更できます。


TCustomRichEdit メソッド3110022

TCustomRichEdit	アルファベット順	凡例

TCustomRichEdit

Create

CreateParams

CreateWnd

Destroy

DestroyWnd

DoSetMaxLength

FindText

GetSelLength

GetSelStart

GetSelText

Print

RegisterConversionFormat

RequestSize

SelectionChange

SetSelLength

SetSelStart

TCustomEdit からの継承

Clear

ClearSelection

CopyToClipboard

CutToClipboard

GetSelTextBuf

PasteFromClipboard

SelectAll

SetSelTextBuf

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomRichEdit メソッド3110023

TCustomRichEdit	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClearSelection

ClientToScreen

ContainsControl

ControlAtPos

CopyToClipboard

Create

CreateParams

CreateParented

CreateWnd

CutToClipboard

DefaultHandler

Destroy

DestroyComponents

Destroying

DestroyWnd

DisableAlign

Dispatch

DoSetMaxLength

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

FindText

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetSelLength

GetSelStart

GetSelText

GetSelTextBuf

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

PasteFromClipboard

Perform

Print

Realign

Refresh

RegisterConversionFormat

RemoveComponent

RemoveControl

Repaint

RequestSize

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SelectionChange

SendToBack

SetBounds

SetFocus

SetSelLength

SetSelStart

SetSelTextBuf

SetTextBuf

Show

Update

UpdateControlState


Clear

Clear メソッドは，書式付き編集コントロールからすべてのテキストを削除します。

procedure Clear; override;

説明

Clear メソッドは，Text プロパティを空の文字列に置き換えることができ，選択されているテキストだけではなくすべてのテキストを削除します。選択したテキストだけを削除するには，ClearSelection を使います。


TCustomRichEdit.Create
TCustomRichEdit.Create3110025

TCustomRichEdit	参照	例

Create メソッドは，TCustomRichEdit のインスタンスを作成します。

constructor Create(AOwner: TComponent!ALink(TComponent_Object,1)); override;

説明

Create メソッドを呼び出すと，実行時に TCustomRichEdit のインスタンスを作成できます。設計時に TCustomRichEdit オブジェクトをフォームに配置した場合は，Create が自動的に呼び出されます。

Create は継承されたコンストラクタをオーバーライドして，テキストの書式属性を管理するヘルパーオブジェクトを割り当てます。


TCustomRichEdit.CreateParams
TCustomRichEdit.CreateParams3110026

TCustomRichEdit	参照

CreateParams メソッドは，Params パラメータで渡されたウィンドウ作成パラメータレコードを初期化します。

type

  TCreateParams = record

    Caption: PChar;

    Style: Longint;

    ExStyle: Longint;

    X, Y: Integer;

    Width, Height: Integer;

    WndParent: HWND;

    Param: Pointer

    WindowClass: TWndClass;

    WinClassName: array[0..63] of Char;

  end;

procedure CreateParams(var Params: TCreateParams); override;

説明

CreateWnd メソッドは CreateParams メソッドを呼び出して，CreateWindowHandle に渡すパラメータを初期化します。TCustomRichEdit は継承されたメソッドをオーバーライドして Windows の書式付き編集コントロールを指定します。


TCustomRichEdit.CreateWnd
TCustomRichEdit.CreateWnd3110027

TCustomRichEdit	参照

CreateWnd メソッドは，編集コントロールに対応する Windows コントロールを作成します。

procedure CreateWnd; override;

説明

CreateWnd メソッドは書式付き編集コントロールが作成されたときと，書式付き編集コントロールへの変更によってウィンドウの再作成が必要になったときに呼び出されます。始めに CreateWnd は継承された CreateWnd を呼び出し，次に新しく作成したウィンドウメッセージを Windows イベントの要求通知に送り，ウィンドウが再び作成される場合にはメモリストリームから書式付きテキストを再ロードします。


TCustomRichEdit.Destroy
TCustomRichEdit.Destroy3110028

TCustomRichEdit	参照

Destroy メソッドは，TCustomRichEdit のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで 直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TCustomRichEdit オブジェクトが解放されていないことを確認した場合に限り Destroy メソッドを呼び出します。

Destroy メソッドは継承されたメソッドをオーバーライドして書式付きテキストを管理するために割り当てられたヘルパーオブジェクトをすべて破棄してから，継承されたデストラクタを呼び出します。


TCustomRichEdit.DestroyWnd
TCustomRichEdit.DestroyWnd3110029

TCustomRichEdit	参照

DestroyWnd メソッドは，書式付き編集コントロールのウィンドウハンドルを破棄します。

procedure DestroyWnd; override;

説明

ウィンドウハンドルを破棄する前に，DestroyWnd メソッドはコントロールのテキストをメモリストリームに保存し，すべてのデバイスコンテキストを解放して，最後に DestroyWindowHandle メソッドを呼び出します。


TCustomRichEdit.DoSetMaxLength
TCustomRichEdit.DoSetMaxLength3110030

TCustomRichEdit	参照

DoSetMaxLength メソッドは，MaxLength プロパティを設定します。

procedure DoSetMaxLength(Value: Integer); override;

説明

DoSetMaxLength メソッドは継承メソッドをオーバーライドして，書式付き編集ウィンドウの MaxLength プロパティを実装します。また，DoSetMaxLength は書式付き編集コントロールのウィンドウに EM_EXLIMITTEXT メッセージを送ります。


TCustomRichEdit.FindText
TCustomRichEdit.FindText3110031

TCustomRichEdit	参照	例

FindText メソッドは，テキストの指定された範囲でターゲット文字列を検索します。

type

TSearchType = (stWholeWord, stMatchCase);

TSearchTypes = set of TSearchType;

function FindText(const SearchStr: string; StartPos, Length: Integer; Options: TSearchTypes):

Integer;

説明

FindText メソッドは，書式付き編集コントロール内のテキストから文字列を検索できます。検索は StartPos で示される位置から始まり，0 で示す位置が最初の文字になります。Options で，完全に一致する文字列のみの検索，および大文字と小文字を区別する検索を指定できます。コントロールのテキストをプログラムで検索するには制御コードを処理しなければなりませんが， FindText を使えばそのような作業を避けることができます。


TCustomRichEdit.GetSelLength
TCustomRichEdit.GetSelLength3110032

TCustomRichEdit	参照

GetSelLength メソッドは，SelLength プロパティを返します。

function GetSelLength: Integer; override;

説明

GetSelLength メソッドは継承メソッドをオーバーライドして，書式付き編集ウィンドウの SelLength プロパティを実装します。また，GetSelLength は編集コントロールのウィンドウに EM_EXGETSEL メッセージを送り，開始位置と終了位置の間の長さを返します。


TCustomRichEdit.GetSelStart
TCustomRichEdit.GetSelStart3110033

TCustomRichEdit	参照

GetSelStart メソッドは，SelStart プロパティを返します。

function GetSelStart: Integer; override;

説明

GetSelStart メソッドは継承メソッドをオーバーライドして，書式付き編集ウィンドウの SelStart プロパティを実装します。GetSelLength は編集コントロールのウィンドウに EM_EXGETSEL メッセージを送り，開始位置を返します。


TCustomRichEdit.GetSelText
TCustomRichEdit.GetSelText3110034

TCustomRichEdit	参照

GetSelText メソッドは，SelText プロパティを返します。

function GetSelText: string; override;

説明

GetSelText メソッドは継承メソッドをオーバーライドして，書式付き編集ウィンドウの SelText プロパティを実装します。また，GetSelText は書式付き編集コントロールのウィンドウに EM_GETSELTEXT メッセージを送ります。


GetSelTextBuf

GetSelTextBuf メソッドは，選択されたテキストをバッファにコピーしてからその文字数を返します。

function GetSelTextBuf(Buffer: PChar; BufSize: Integer): Integer; override;

説明

GetSelTextBuf メソッドは，選択されたテキストを文字バッファにコピーできます。選択がなければ，バッファは空の文字列を受け取ります。選択に（BufSize - 1）より多く文字がある場合は，最初の（BufSize - 1）バイト分のみがコピーされます。GetSelTextBuf は実際にバッファにコピーされたバイト数を返します。


TCustomRichEdit.Print
TCustomRichEdit.Print3110036

TCustomRichEdit	参照	例

Print メソッドは，書式付き編集コントロールの内容をフォーマットして印刷します。

procedure Print(const Caption: string);

説明

Print メソッドは，書式付き編集コントロールの内容を印刷できます。Caption パラメータには印刷出力に表示するタイトルを指定します。


TCustomRichEdit.RegisterConversionFormat
TCustomRichEdit.RegisterConversionFormat3110037

TCustomRichEdit	参照

RegisterConversionFormat メソッドは，TConversion オブジェクトでネイティブなファイル形式と RTF 形式との変換を行う場合にファイルの拡張子と TConversion オブジェクトの関連付けを登録します。

TConversionClass = class of TConversion;

class procedure RegisterConversionFormat(const AExtension: string; AConversionClass: TConversionClass);

説明

書式付き編集コントロールはテキスト属性を RTF 形式にエンコードします。他の形式にテキスト属性がエンコードされているファイルを読み書きするには，変換コンバータが必要になります。このコンバータは TConversion の派生オブジェクトで，テキストのストリーム入出力処理でネイティブなファイル形式と RTF 形式の変換を行います。RegisterConversionFormat メソッドはファイルの拡張子と派生オブジェクトの関連付けを設定して，特定の拡張子を持つファイルと書式付き編集コントロール間のストリーム処理に際して，適切な派生オブジェクトを呼び出せるようにします。

注意

ファイルのテキストのストリーム入出力処理には Lines プロパティを使います。


TCustomRichEdit.RequestSize
TCustomRichEdit.RequestSize3110038

TCustomRichEdit	参照

RequestSize メソッドは，書式付きテキスト編集コントロールのウィンドウのテキストがウィンドウのサイズより大きくなったり小さくなったりしたときにウィンドウから送られるメッセージを処理します。

procedure RequestSize(const Rect: TRect); virtual;

説明

RequestSize メソッドは OnResizeRequest イベントハンドラを呼び出すだけです。RequestSize は，派生クラスが当面のウィンドウサイズ変更に関する Windows メッセージの処理を変更できるように，Protected メソッドとして定義されています。RequestSize をオーバーライドするときには，OnResizeRequest イベントハンドラの呼び出しを指定します。


TCustomRichEdit.SelectionChange
TCustomRichEdit.SelectionChange3110039

TCustomRichEdit	参照

SelectionChange メソッドは，選択範囲が変更された編集コントロールのウィンドウからのメッセージを処理します。

procedure SelectionChange; dynamic;

説明

SelectionChange メソッドは OnSelectionChange イベントハンドラを呼び出すだけです。SelectionChange は，派生クラスが選択範囲の変更に関する Windows メッセージの処理を変更できるように，Protected メソッドとして定義されています。SelectionChange をオーバーライドするときには，OnSelectionChange イベントハンドラの呼び出しを指定します。


TCustomRichEdit.SetSelLength
TCustomRichEdit.SetSelLength3110040

TCustomRichEdit	参照

SetSelLength メソッドは，SelLength プロパティを設定します。

procedure SetSelLength(Value: Integer); override;

説明

SetSelLength メソッドは継承メソッドをオーバーライドして，書式付き編集ウィンドウの SelLength プロパティを実装します。また，SetSelLength は編集コントロールのウィンドウに EM_EXSETSEL メッセージを送り，SelStart で始まり SelStart + Value で終わる選択範囲を指定します。


TCustomRichEdit.SetSelStart
TCustomRichEdit.SetSelStart3110041

TCustomRichEdit	参照

SetSelStart メソッドは，SelStart プロパティを返します。

procedure SetSelStart(Value: Integer); override;

説明

SetSelStart メソッドは継承メソッドをオーバーライドして，書式付き編集ウィンドウの SelStart プロパティを実装します。SetSelLength は編集コントロールのウィンドウに EM_EXSETSEL メッセージを送り，Value で指定される位置にカーソルを移動します。


スコープ3110042

protected

published

読み出し／書き込み

読み出し専用


スコープ3110043

protected


スコープ3110044

protected


継承3110045

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomEdit

TCustomMemo


TCustomRichEdit 例3110046

TCustomRichEdit


TCustomSocket
TCustomSocket3111001

継承	プロパティ	メソッド	イベント	参照

TCustomSocket オブジェクトは，すべてのソケットコンポーネントの抽象基本クラスです。

ユニット

scktcomp

説明

TCustomSocket オブジェクトは，アプリケーションが Windows ソケットを使用できるようにするためのプロパティ，イベント，メソッドを導入します。Windows ソケットは，アプリケーションが他のマシンと接続して情報を読み書きすることを可能にする通信プロトコルのセットをカプセル化します。Windows ソケットは TCP/IP プロトコルに基づく接続を提供します。また，Windows ソケットでは，Xerox Network System（XNS），Digital DECnet プロトコル，または Novell IPX/SPX ファミリーを使用する接続も可能です。ソケットは，実際のネットワークソフトウェアに関係なく，アプリケーションが他のマシンへの接続を確立することを可能にします。

TCustomSocket のインスタンスは作成しないでください。TCustomSocket は，他のマシンへの接続を提供するソケットオブジェクトを宣言するときに基本クラスとして使います。TCustomSocket の下位オブジェクトを使うと，他のマシンと通信する機能をアプリケーションに追加できます。別のマシンとの接続を開始するソケットを作成するには TClientSocket を使います。他のマシンからの接続の要求に応答するソケットを作成するには TServerSocket を使います。


TCustomSocket プロパティ3111002

TCustomSocket	アルファベット順	凡例

TCustomSocket

Active

Address

Host

Port

Service

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TCustomSocket プロパティ3111003

TCustomSocket	オブジェクト順	凡例

Active

Address

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Host

Name

Owner

Port

Service

Tag

VCLComObject


TCustomSocket.Active
TCustomSocket.Active3111004

TCustomSocket	参照

Active プロパティは，TCustomSocket によって示されているソケット接続がオープンしていて，他のマシンとの接続に利用可能かどうかを示します。

property Active: Boolean;

説明

Active プロパティは，ソケット接続の使用または変更を試みる前に，接続がオープンしていて用意が整っているかどうかを判別できます。クライアントソケットの場合は，Active プロパティを設定すると，別のマシンへのソケット接続がオープンまたはシャットダウンされます。サーバーソケットの場合は，Active プロパティを設定すると，ソケットをクライアント要求に利用できるようにするリスニング接続がオープンまたはシャットダウンされます。

設計時に Active を True に設定しておくと，アプリケーションの実行開始時にソケットによって接続がオープンされるようにすることができます。実行時には，接続をオープンまたはクローズするには，Open または Close メソッドを使います。


TCustomSocket.Address
TCustomSocket.Address3111005

TCustomSocket	参照

Address プロパティは，サーバーシステムの IP アドレスです。

property Address: string;

説明

Address プロパティは，次のような標準のインターネットドット区切り表記の 4 つの数値（4 バイト値）からなる文字列です。

123.197.1.2

クライアントソケットの場合，Address プロパティはソケットの接続先のサーバーの IP アドレスに設定します。接続がオープンしたときに，Address の値はその接続にバインドされます。

ソケットが Host プロパティを指定している場合，接続のためのアドレスは Address の値からではなく，Host に関連付けられている IP アドレスが使われます。IP アドレスを使ってサーバーシステムを指定するほうが，サーバーシステムを見つけるためにソケットがホスト名に関連付けられている IP アドレスを探す必要がない分だけ処理が速くなります。

1 つのサーバーシステムが複数の IP アドレスをサポートする場合があります。

注意

接続のオープン中に Address を変更しようとすると，ESocketError 例外が生成されます。


TCustomSocket.Host
TCustomSocket.Host3111006

TCustomSocket	参照

Host プロパティは，サーバーシステムの IP アドレスのエリアスです。

property Host: string;

説明

Host プロパティは，次のような，特定のシステムのドメイン名とサービスからなる文字列です。

http://www.wSite.Com

クライアントソケットの場合，Host はクライアントソケットが接続を確立する相手となるシステムに設定します。ソケットは接続をオープンするときに Host の値を使ってサーバーソケットの IP アドレスを調べます。

一部のサーバーは，特定のホスト名に関連付けられているシステムまたは IP アドレスを変更します。ホスト名を使用すると，クライアントソケットは，IP アドレスが変更された場合でも，そのホスト名によって表される抽象サイトを見つけることができます。

Host プロパティを設定した場合は，サーバーのアドレスを調べる際，Host プロパティが Address プロパティより優先されます。

注意

接続のオープン中に Host を変更しようとすると，ESocketError 例外が生成されます。


TCustomSocket.Port
TCustomSocket.Port3111007

TCustomSocket	参照

Port プロパティは，サーバーソケット接続を識別する ID 番号です

property Port: Integer;

説明

Port プロパティは，Host または Address プロパティによって識別される 1 つのシステムが，同時に複数の接続のホストとなることができるようになります。Port の値の多くは，規約により，ftp または http などの特定のサービスに関連付けられています。

サーバーソケットの場合，Port はサーバーソケットがクライアント要求のリスニングを行う接続の ID です。通常，サーバーソケットは Port の値をクライアントが接続を開始するのに使用できる定義済みの値に設定します。

クライアントソケットの場合，Port は目的のサーバー接続の ID です。通常，Port の値はクライアントがサーバーアプリケーションで使用しようとするサービスに関連付けます。

注意

接続のオープン中に Port を変更しようとすると，ESocketError 例外が生成されます。


TCustomSocket.Service
TCustomSocket.Service3111008

TCustomSocket	参照

Service プロパティは，ソケット接続を使って行われるサービスの名前です。

property Service: string;

説明

Service プロパティは，接続の使い方を識別できます。Windows では，ftp，http，finger，time など，多くの標準サービス名が提供されています。サーバーは，SERVICES ファイルで追加サービスとそのサービスに関連付けるポートを指定できます。詳細は，Microsoft の Windows ソケットのマニュアルを参照してください。

一部のポート番号は，特定のサービスの値用に予約されています。したがって，Service を使えば，ソケット接続で使うサーバーの Port を指定するための方法が得られます。サーバーソケットの場合，Port ではなく Service を使用することにより，サーバーが適切なポートで TCP/IP 要求をリスニングすることが保証されます。

注意

接続のオープン中に Service を変更しようとすると，ESocketError 例外が生成されます。


TCustomSocket イベント3111009

TCustomSocket	アルファベット順	凡例

TCustomSocket

OnAccept

OnConnect

OnConnecting

OnDisconnect

OnError

OnListen

OnLookup

OnRead

OnWrite


TCustomSocket イベント3111010

TCustomSocket	オブジェクト順	凡例

OnAccept

OnConnect

OnConnecting

OnDisconnect

OnError

OnListen

OnLookup

OnRead

OnWrite


TCustomSocket.OnAccept
TCustomSocket.OnAccept3111011

TCustomSocket	参照

OnAccept イベントは，クライアントソケットへの接続が受け入れられた直後にサーバーソケットで発生します。

type TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnAccept: TSocketNotifyEvent;

説明

サーバーソケットに OnAccept イベントハンドラを記述すると，クライアントソケットへの接続が受け入れられた後に特定の処理が実行されるようにすることができます。接続のサーバーエンドポイントで使われるローカルポートおよび IP アドレスについての情報はこの時点で初めて利用可能になります。ポート番号（および IP アドレス）はリスニングソケットのポート番号（および IP アドレス）とは異なる値になります。

サーバーソケットはリスニングのためにソケット接続をオープンし，クライアント要求を保持するためのキューを作成します。そのキューからの要求がサーバーソケットによって受け入れられた後に，OnAccept イベントが発生します。サーバーソケットがその接続を受け入れた後に，クライアントソケットは接続を完了し，クライアントソケットで OnConnect イベントが発生します。

Sender パラメータは接続を受け入れるサーバーソケットコンポーネントです。Socket パラメータは確立するクライアントソケットへの接続のサーバーエンドポイントを示す TCustomWinSocket オブジェクトです。


TCustomSocket.OnConnect
TCustomSocket.OnConnect3111012

TCustomSocket	参照

OnConnect イベントは，サーバーへの接続がオープンされた直後にクライアントソケットで発生します。

type TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnConnect: TSocketNotifyEvent;

説明

クライアントソケットに OnConnect イベントハンドラを記述すると，サーバーソケットへの接続が確立された後に特定の処理が実行されるようにすることができます。サービスによっては，この時点でソケットがその接続での読み書きを開始することもあります。

クライアントソケットが接続をオープンするとき，以下のイベントが発生します。

1.	サーバーソケットを見つけようとする前に OnLookup イベントが発生する

2.	Windows ソケットがセットアップされ，イベント通知のために初期化される

3.	サーバーソケットが見つけられた後に OnConnecting イベントが発生する

4.	接続要求がサーバーによって受け入れられ，クライアントソケットによって完了される

5.	接続が確立されたら OnConnect イベントが発生する

Sender パラメータは接続を開始するクライアントソケットコンポーネントです。Socket パラメータは新たに確立される接続のクライアントエンドポイントを示す TCustomWinSocket オブジェクトです。


TCustomSocket.OnConnecting
TCustomSocket.OnConnecting3111013

TCustomSocket	参照

OnConnecting イベントは，サーバーソケットが見つけられた後で，接続が確立される前に，クライアントソケットで発生します。

type TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnConnecting: TSocketNotifyEvent;

説明

クライアントソケットに OnConnecting イベントハンドラを記述すると，サーバーソケットへの接続が確立される直前に特定の処理が実行されるようにすることができます。確立する接続のサーバーエンドポイントの実際のポートおよび IP アドレスはこの時点で初めて取得できるようになります。

クライアントソケットが接続をオープンするとき，次のイベントが発生します。

1.	サーバーソケットを見つけようとする前に OnLookup イベントが発生する

2.	Windows ソケットがセットアップされ，イベント通知のために初期化される

3.	サーバーソケットが見つけられた後に OnConnecting イベントが発生する

4.	接続要求がサーバーによって受け入れられ，クライアントソケットによって完了される

5.	接続が確立されたら OnConnect イベントが発生する

Sender パラメータは接続を開始するクライアントソケットコンポーネントです。Socket パラメータは確立する接続のサーバーエンドポイントを示す TCustomWinSocket オブジェクトです。


TCustomSocket.OnDisconnect
TCustomSocket.OnDisconnect3111014

TCustomSocket	参照

OnDisconnect イベントは，クライアントソケットがサーバーソケットへの接続をクローズする直前に発生します。

type TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnDisconnect: TSocketNotifyEvent;

説明

OnDisconnect イベントハンドラを記述すると，サーバーソケットへの接続が終了されようとするときに特定の処理が実行されるようにすることができます。OnDisconnect は，Active プロパティの値が False に設定された後で，接続が実際にクローズされる前に発生します。

Sender パラメータはクライアントソケットコンポーネントです。Socket パラメータは終了する接続のクライアントエンドポイントを示す TCustomWinSocket オブジェクトです。


TCustomSocket.OnError
TCustomSocket.OnError3111015

TCustomSocket	参照

OnError イベントは，ソケットが接続の確立，使用，またはシャットダウンに失敗したときに発生します。

TErrorEvent = (eeGeneral, eeSend, eeReceive, eeConnect, eeDisconnect, eeAccept);

TSocketErrorEvent = procedure (Sender: TObject; Socket: TCustomWinSocket;

    ErrorEvent: TErrorEvent; var ErrorCode: Integer) of object;

property OnError: TSocketErrorEvent;

説明

OnError イベントハンドラを記述すると，ソケット接続で起こるエラーに応答できます。OnError イベントハンドラがエラー状況を正常に処理する場合，ErrorCode パラメータを 0 に設定すると ESocketError は生成されません。

Sender パラメータはソケットコンポーネントです。Socket パラメータはエラーを起こした接続のローカルエンドポイントを示す TCustomWinSocket オブジェクトです。ErrorEvent パラメータは，エラー発生時に Socket が何を行おうとしていたかを示します。ErrorCode パラメータは，Windows ソケット API 呼び出しによって返されるエラーコードです。


TCustomSocket.OnListen
TCustomSocket.OnListen3111016

TCustomSocket	参照

OnListen イベントは，サーバーソケットがリスニングのためにオープンされる直前に発生します。

type TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnListen: TSocketNotifyEvent;

説明

サーバーソケットに OnListen イベントハンドラを記述すると，ソケットがリスニングのためにオープンされる直前に特定の処理が実行されるようにすることができます。OnListen は，Address および Port がソケット接続にバインドされた後で，接続がオープンされる前に発生します。この時点以降は，ソケットがリスニングのためにオープンされる前にソケットエンドポイントに変更を加えることができなくなります。ソケットを変更する Windows API 呼び出しでは，Socket パラメータの SocketHandle プロパティを使用します。

サーバーソケットはリスニングのためにソケット接続をオープンし，クライアント要求を保持するためのキューを作成します。クライアントソケットへの接続はそのキューからの要求が受け入れられたときに完了します。

Sender パラメータは接続を使ってリスニングを行うソケットコンポーネントです。Socket パラメータはオープンするリスニング接続のサーバーエンドポイントを示す TCustomWinSocket オブジェクトです。


TCustomSocket.OnLookup
TCustomSocket.OnLookup3111017

TCustomSocket	参照

OnLookup イベントは，クライアントソケットが接続相手のサーバーソケットを調べようとしたときに発生します。

type TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnLookup: TSocketNotifyEvent;

説明

クライアントソケットに OnLookup イベントハンドラを記述すると，サーバーソケットを見つけようとする直前に特定の処理が実行されるようにすることができます。特定のポート番号の指定など，ソケットのクライアントプロパティに影響を及ぼす Windows API 呼び出しは，この時点で初めて行えるようになります。Windows API 呼び出しでは，Socket パラメータの SocketHandle プロパティを使用します。

クライアントソケットが接続をオープンするとき，以下のイベントが発生します。

1.	サーバーソケットを見つけようとする前に OnLookup イベントが発生する

2.	Windows ソケットがセットアップされ，イベント通知のために初期化される

3.	サーバーソケットが見つけられた後に OnConnecting イベントが発生する

4.	接続要求がサーバーによって受け入れられ，クライアントソケットによって完了される

5.	接続が確立されたら OnConnect イベントが発生する

Sender パラメータは接続を開始するクライアントソケットコンポーネントです。Socket パラメータはサーバーとの間で確立される接続のクライアントエンドポイントを示す TCustomWinSocket オブジェクトです。

注意

OnLookup イベントハンドラで Sender パラメータの Address，Host，Port または Service プロパティを変更しても，サーバーソケットを見つけるのに使うアドレスまたはポートに影響は及びません。これらのプロパティは Open メソッドを呼び出す前に訂正しておく必要があります。


TCustomSocket.OnRead
TCustomSocket.OnRead3111018

TCustomSocket	参照

OnRead イベントは，クライアントソケットがソケット接続から情報を読み出すことが必要になったときに発生します。

type TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnRead: TSocketNotifyEvent;

説明

OnRead イベントハンドラを記述すると，ソケット接続から情報を読み出すことができます。Sender パラメータは接続を開始するクライアントソケットコンポーネントです。Socket パラメータはソケット接続のクライアントエンドポイントを示す TCustomWinSocket オブジェクトです。ソケットがブロッキングソケットの場合は，TWinSocketStream オブジェクトを使って接続からの読み出しを行います。それ以外の場合は Socket パラメータのメソッドを使って実際の読み出しを実行します。


TCustomSocket.OnWrite
TCustomSocket.OnWrite3111019

TCustomSocket	参照

OnWrite イベントは，クライアントソケットがソケット接続に情報を書き込むことが必要になったときに発生します。

type TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnWrite: TSocketNotifyEvent;

説明

OnWrite イベントハンドラを記述すると，ソケット接続に情報を書き込むことができます。Sender パラメータは接続を開始するクライアントソケットコンポーネントです。Socket パラメータはソケット接続のクライアントエンドポイントを示す TCustomWinSocket オブジェクトです。ソケットがブロッキングソケットの場合は，TWinSocketStream オブジェクトを使って接続への書き込みを行います。それ以外の場合は，Socket パラメータのメソッドを使って実際の書き込みを実行します。


TCustomSocket メソッド3111020

TCustomSocket	アルファベット順	凡例

TCustomSocket

Close

DoActivate

Error

Event

Loaded

Open

SetActive

SetAddress

SetHost

SetPort

SetService

TComponent からの継承

Create

Destroy

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomSocket メソッド3111021

TCustomSocket	オブジェクト順	凡例

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Close

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DoActivate

Error

Event

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Loaded

MethodAddress

MethodName

NewInstance

Open

RemoveComponent

SafeCallException

SetActive

SetAddress

SetHost

SetPort

SetService


TCustomSocket.Close
TCustomSocket.Close3111022

TCustomSocket	参照

Close メソッドは，ソケット接続をシャットダウンします。

procedure Close;

説明

Close メソッドを呼び出すと，ソケット接続をシャットダウンすることができます。Close メソッドは Active プロパティを False に設定します。

クライアントソケットの場合，Close はサーバーへの接続を終了します。サーバーソケットの場合，Close は接続をシャットダウンし，それ以降サーバーソケットがクライアント要求のリスニングを行わなくなるようにします。


TCustomSocket.DoActivate
TCustomSocket.DoActivate3111023

TCustomSocket	参照

DoActivate メソッドは，ソケット接続をオープンまたはクローズするメソッドの抽象プロトタイプです。

procedure DoActivate(Value: Boolean); virtual; abstract;

説明

TCustomSocket の派生オブジェクトは DoActivate メソッドをオーバーライドしてソケット接続を開始または終了するメソッドを提供します。接続をオープンまたはクローズするのに必要なステップは，ソケットがクライアントソケットであるかサーバーソケットであるかによって異なります。


TCustomSocket.Error
TCustomSocket.Error3111024

TCustomSocket	参照

Error メソッドは，エラーイベントハンドラが割り当てられていれば，エラーイベントをそのハンドラにディスパッチします。

TErrorEvent = (eeGeneral, eeSend, eeReceive, eeConnect, eeDisconnect, eeAccept);

procedure Error(Socket: TCustomWinSocket; ErrorEvent: TErrorEvent; var ErrorCode: Integer); virtual;

説明

アプリケーションは Error メソッドを呼び出すことはできません。Error メソッドはプロテクトメソッドとしてエクスポーズされるので，ScktComp ユニット内のヘルパーオブジェクトはソケットコンポーネントにエラーを送信できます。Error をオーバーライドすると，クラス固有のエラー処理を追加したり，OnError イベントをブロックしたりすることができます。


TCustomSocket.Event
TCustomSocket.Event3111025

TCustomSocket	参照

Event メソッドは，ソケットの通常の処理で発生するイベントを対応するイベントハンドラにディスパッチします。

TSocketEvent = (seLookup, seConnecting, seConnect, seDisconnect, seListen, seAccept, seWrite, seRead);

procedure Event(Socket: TCustomWinSocket; SocketEvent: TSocketEvent); virtual;

説明

アプリケーションは Event メソッドを呼び出すことはできません。Event メソッドはプロテクトメソッドとしてエクスポーズされるので，ScktComp ユニット内のヘルパーオブジェクトはソケットの通常の処理中に適切なイベントハンドラを呼び出すことができます。Event をオーバーライドすると，一定のイベントが発生したときのクラス固有の応答を導入したり，ソケットが関連付けられているイベントハンドラを呼び出さないようにしたりすることができます。


TCustomSocket.Loaded
TCustomSocket.Loaded3111026

TCustomSocket	参照

Loaded メソッドは， Active プロパティに格納されている値に従って，ソケットがファイルからロードされたときにソケット接続をオープンまたはクローズします。

procedure Loaded; override;

説明

アプリケーションはこのプロテクトメソッドを呼び出すことはできません。Loaded メソッドはソケットコンポーネントがストリームからロードされた後で自動的に呼び出されます。Loaded はデフォルトメソッドをオーバーライドして，ソケットコンポーネントで格納した Active プロパティの値を実現します。


TCustomSocket.Open
TCustomSocket.Open3111027

TCustomSocket	参照

Open メソッドは，ソケット接続をオープンします。

procedure Open;

説明

Open メソッドを呼び出すと，ソケット接続を開始できます。Open メソッドは Active プロパティを True に設定します。

クライアントソケットの場合，Open メソッドはサーバーを見つけて接続します。サーバーソケットの場合，Open メソッドはリスニングモードでソケット接続をオープンしますが，クライアントソケットへの接続は完了しません。


TCustomSocket.SetActive
TCustomSocket.SetActive3111028

TCustomSocket	参照

SetActive メソッドは，Active プロパティを設定します。

procedure SetActive(Value: Boolean);

説明

SetActive メソッドは Protected メソッドとして定義されているので，TCustomSocket の派生オブジェクトは Active プロパティの実装をカスタマイズできます。SetActive メソッドは DoActivate メソッドを呼び出してソケット接続をオープンまたはクローズします。


TCustomSocket.SetAddress
TCustomSocket.SetAddress3111029

TCustomSocket	参照

SetAddress メソッドは，Address プロパティを設定します。

procedure SetAddress(Value: string);

説明

SetAddress メソッドは Protected メソッドとして定義されているので，TCustomSocket の派生オブジェクトは Address プロパティの実装をカスタマイズできます。ソケット接続のオープン中に Address プロパティを設定しようとすると，SetAddress メソッドは ESocketError 例外を生成します。


TCustomSocket.SetHost
TCustomSocket.SetHost3111030

TCustomSocket	参照

SetHost メソッドは Host プロパティを設定します。

procedure SetHost(Value: string);

説明

SetHost メソッドは Protected メソッドとして定義されているので，TCustomSocket の派生オブジェクトは Host プロパティの実装をカスタマイズできます。ソケット接続のオープン中に Host プロパティを設定しようとすると，SetHost メソッドは ESocketError 例外を生成します。


TCustomSocket.SetPort
TCustomSocket.SetPort3111031

TCustomSocket	参照

SetPort メソッドは，Port プロパティを設定します。

procedure SetPort(Value: Integer);

説明

SetPort メソッドは Protected メソッドとして定義されているので，TCustomSocket の派生オブジェクトは Port プロパティの実装をカスタマイズできます。ソケット接続のオープン中に Port プロパティを設定しようとすると，SetPort メソッドは ESocketError 例外を生成します。


TCustomSocket.SetService
TCustomSocket.SetService3111032

TCustomSocket	参照

SetService メソッドは，Service プロパティを設定します。

procedure SetService(Value: string);

説明

SetService メソッドは Protected メソッドとして定義されているので，TCustomSocket の派生オブジェクトは Service プロパティの実装をカスタマイズできます。ソケット接続のオープン中に Service プロパティを設定しようとすると，SetService メソッドは ESocketError 例外を生成します。


スコープ3111033

protected

published

読み出し／書き込み

読み出し専用


スコープ3111034

protected


スコープ3111035

protected


継承3111036

TObject

TPersistent

TComponent


TCustomSocket 例3111037

TCustomSocket


TCustomTabControl
TCustomTabControl3112001

継承	プロパティ	メソッド	イベント	参照

TCustomTabControl は，TTabControl および TPageControl などのタブコントロールコンポーネントの基本型です。

ユニット

comctrls

説明

TCustomTabControl は，最上部で横に並んでいるノートブックスタイルのタブがあるコントロールを定義するときに基本クラスとして使います。TCustomTabControl はタブの外観と基本動作を制御し，またユーザーがタブを選択したときに応答するために多くのプロパティ，メソッド，およびイベントを提供します。


TCustomTabControl プロパティ3112002

TCustomTabControl	アルファベット順	凡例

TCustomTabControl

DisplayRect

HotTrack

MultiLine

ScrollOpposite

TabHeight

TabIndex

TabPosition

Tabs

TabWidth

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomTabControl プロパティ3112003

TCustomTabControl	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

DisplayRect

Enabled

Handle

Height

HelpContext

Hint

HotTrack

Left

MultiLine

Name

Owner

Parent

ParentWindow

ScrollOpposite

ShowHint

Showing

TabHeight

TabIndex

TabOrder

TabPosition

Tabs

TabStop

TabWidth

Tag

Top

VCLComObject

Visible

Width

WindowProc


TCustomTabControl.DisplayRect
TCustomTabControl.DisplayRect3112004

TCustomTabControl	参照

DisplayRect プロパティは，タブコントロールの長方形のクライアント領域の境界です。

property DisplayRect: TRect;

説明

DisplayRect プロパティは，タブページの内容を表すタブコントロール部分の座標をピクセル単位で取得できます。タブコントロール部分の外観は別のタブが選択されても変化しません。

ClientRect プロパティでなく DisplayRect を使うと，ほかのオブジェクトがあるタブコントロール部分を特定できます。

DisplayRect は Top，Bottom，Left，Right の各座標を 1 つの TRect 型レコードにして返します。


TCustomTabControl.HotTrack
TCustomTabControl.HotTrack3112005

TCustomTabControl	参照

HotTrack プロパティは，マウスを置くとタブのラベルが自動的に強調表示されるかどうかを決めます。

property HotTrack: Boolean;

説明

HotTrack プロパティを True に設定すると，マウスボタンをクリックした場合にどのタブが選択されるかをユーザーにビジュアルに示せます。HotTrack はタブコントロールに複数のタブ行がある場合に便利です。


TCustomTabControl.MultiLine
TCustomTabControl.MultiLine3112006

TCustomTabControl	参照	例

MultiLine プロパティは，タブを複数の行で表示するかどうかを決めます。

property MultiLine: Boolean;

説明

MultiLine プロパティは，タブの表示方法を決めることができます。MultiLine プロパティが True の場合，タブの数がタブコントロールの最上部の 1 列で収まりきらないと複数の行でタブが表示されます。その行数はタブコントロールのタブ数で決まります。MultiLine プロパティが False の場合，1 行だけでタブが表示され，ユーザーはスクロールしてすべてのタブを表示することになります。


TCustomTabControl.ScrollOpposite
TCustomTabControl.ScrollOpposite3112007

TCustomTabControl	参照

ScrollOpposite プロパティは，複数行のタブコントロールでタブ行をスクロールする方法を決めます。

property ScrollOpposite: Boolean;

説明

ScrollOpposite を設定すると，複数行のタブコントロールでユーザーがほかの行のタブを選択したときに前のタブ行がどこに移動するかを指定できます。ScrollOpposite が True の場合，前のタブ行は TabPosition が tpTop ならばタブコントロールの最下部に移動し，TabPosition が tpBottom ならば最上部に移動します。ScrollOpposite が False の場合，前の行はほかのすべてのタブ行の背後に移動します。

たとえばタブ行が 3 行のタブコントロールで，ユーザーが 2 行目のタブを選択した場合に ScrollOpposite は 1 行目のタブ行がどこに移動するかを決めます。ScrollOpposite が True の場合，2 行目はタブコントロールの最上部で一番手前（最下部のタブ行）に表示され，その後ろ（1 行上のタブ行）には 3 行目のタブ行が表示されます。1 行目のタブ行はタブコントロールの一番奥に移動します。ScrollOpposite が False の場合，1 行目は一番後ろ（最上部）に移動し，タブコントロールが 2 行目を手前（タブ領域の最下部）に，次に 3 行目（移動によって 2 行目）を，そして 1 行目を表示できるようにします。

注意

ScrollOpposite を True に設定すると自動的に MultiLine プロパティが True に設定されます。


TCustomTabControl.TabHeight
TCustomTabControl.TabHeight3112008

TCustomTabControl	参照	例

TabHeight プロパティは，タブコントロールのタブの高さをピクセル単位で決めます。

property TabHeight: Smallint;

説明

TabHeight を設定すると，タブコントロールのクライアント領域の上に表示されるタブの高さを制御できます。 TabHeight プロパティは各タブの縦のサイズをピクセル単位で示します。TabHeight プロパティを 0 に設定すると，タブの縦のサイズはテキストに合わせて自動調整されます。


TCustomTabControl.TabIndex
TCustomTabControl.TabIndex3112009

TCustomTabControl	参照

TabIndex プロパティは，タブコントロールで選択されたタブを識別します。

property TabIndex: Integer;

説明

TabIndex プロパティは，ユーザーがどのタブを選択したかを特定できます。TabIndex は Tabs プロパティで保守されるラベルのリスト内におけるタブのインデックスです。最初のタブ（一番左のタブ）の TabIndex は 0 で，次のタブは 1 となります。タブが選択されていない場合は TabIndex の値は -1 です。

TabIndex を設定すると，タブコントロールで選択されたタブをプログラムで変更できます。


TCustomTabControl.TabPosition
TCustomTabControl.TabPosition3112010

TCustomTabControl	参照

TabPosition プロパティは，タブを上または下に表示するかどうかを決めます。

TTabPosition = (tpTop, tpBottom);

property TabPosition: TTabPosition;

説明

TabPosition を tpTop に設定するとタブコントロールの上にタブを表示できます。TabPosition を tpBottom に設定するとタブコントロールの下に表示できます。ScrollOpposite プロパティが True の場合，タブを上と下に表示することが可能で，現在のタブを含む行とほかのすべての行が TabPosition で指定した位置に表示されます。


TCustomTabControl.Tabs
TCustomTabControl.Tabs3112011

TCustomTabControl	参照

Tabs プロパティは，タブコントロールのタブにラベル付けするテキスト文字列を格納します。

property Tabs: TStrings;

説明

Tabs プロパティは，タブコントロール内のタブのラベルにアクセスできます。Tabs に新しい文字列を追加するとタブコントロールに新しいタブを追加できます。タブコントロール内のタブを再配列するには Tabs リストを再配列します。


TCustomTabControl.TabWidth
TCustomTabControl.TabWidth3112012

TCustomTabControl	参照	例

TabWidth プロパティは，タブコントロールのタブの横のサイズをピクセル単位で指定します。

property TabWidth: Smallint;

説明

TabWidth プロパティを設定すると，タブコントロールのクライアント領域の上に表示されるタブの幅を制御できます。TabWidth は個々のタブの横のサイズをピクセル単位で示します。TabWidth を 0 に設定すると，タブの横のサイズはテキストに合わせて自動調整されます。


TCustomTabControl イベント3112013

TCustomTabControl	アルファベット順	凡例

TCustomTabControl

OnChange

OnChanging


TCustomTabControl イベント3112014

TCustomTabControl	オブジェクト順	凡例

OnChange

OnChanging


TCustomTabControl.OnChange
TCustomTabControl.OnChange3112015

TCustomTabControl	参照	例

OnChange イベントは，新しいタブが選択されると発生します。

TNotifyEvent = procedure (Sender: TObject);

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラを記述すると，選択されたタブが変更された直後に特定のアクションを実行できます。TabIndex プロパティを使うとどのタブが選択されているかを特定できます。このときに選択したタブで，設定した後の状態が反映されるコントロールに対して変更を加えることができます。

TabIndex の値が変わる前に OnChanging イベントが発生します。


TCustomTabControl.OnChanging
TCustomTabControl.OnChanging3112016

TCustomTabControl	参照	例

OnChanging イベントは，新しいタブを選択する直前に発生します。

TTabChangingEvent = procedure (Sender: TObject; var AllowChange: Boolean) of object;

property OnChanging: TTabChangingEvent;

説明

OnChanging イベントハンドラを記述すると，別のタブを選択する直前に特定のアクションを実行できます。AllowChange パラメータを False に設定すると変更を防ぐことができます。

OnChanging イベントハンドラを使うと，特定の条件に適合するまでユーザーが現在選択されているタブを終了しないようにできます。また，OnChanging イベントハンドラを使って，選択された別のタブに移動する前に，現在のタブコントロールの状態を保存することもできます。


TCustomTabControl メソッド3112017

TCustomTabControl	アルファベット順	凡例

TCustomTabControl

AlignControls

CanChange

Change

Create

CreateParams

CreateWnd

Destroy

DestroyWnd

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomTabControl メソッド3112018

TCustomTabControl	オブジェクト順	凡例

AlignControls

Assign

BeginDrag

BringToFront

Broadcast

CanChange

CanFocus

Change

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParams

CreateParented

CreateWnd

DefaultHandler

Destroy

DestroyComponents

Destroying

DestroyWnd

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TCustomTabControl.AlignControls
TCustomTabControl.AlignControls3112019

TCustomTabControl	参照

AlignControls メソッドは，タブコントロール内のコントロールの位置を揃えます。

procedure AlignControls(AControl: TControl; var Rect: TRect); override;

説明

AlignControls メソッドを呼び出すと，タブコントロール内のクライアント領域内のすべての子コントロールの位置を揃えます。AlignControls メソッドは各子コントロールの Align プロパティ値を使って位置を揃える方法を判断します。AControl パラメータは nil にもなります。AControl パラメータが nil でない場合，そのコントロールの位置合わせはほかの同じように位置合わせされているコントロールに優先します。

AlignControls は，Rect パラメータに DisplayRect の値を使うために継承されたメソッドをオーバーライドします。


TCustomTabControl.CanChange
TCustomTabControl.CanChange3112020

TCustomTabControl	参照

CanChange メソッドは，選択したタブを変更できるかどうかを決めます。

function CanChange: Boolean;

説明

CanChange メソッドは，選択したタブを変更しようとしたときに自動的に呼び出されます。CanChange は OnChanging イベントハンドラがタブの変更を防ぐように OnChanging イベントを発生させます。OnChanging イベントハンドラが記述されていない場合，CanChange は True を返して変更を可能にします。

CanChange をオーバーライドすると， OnChanging イベントハンドラが実行される前の追加の処理を指定したり，OnChanging イベントをブロックしたりできます。


TCustomTabControl.Change
TCustomTabControl.Change3112021

TCustomTabControl	参照

Change メソッドは，OnChange イベントを発生させます。

procedure Change;

説明

Change メソッドは選択されたタブが変わると自動的に呼び出されます。 Change メソッドをオーバーライドすると，OnChange イベントハンドラが実行される前の追加の処理を指定したり，OnChange イベントをブロックしたりできます。


TCustomTabControl.Create
TCustomTabControl.Create3112022

TCustomTabControl	参照

Create メソッドは，TCustomTabControl のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと実行時にタブコントロールを初期化できます。設計時にフォームに配置されたタブコントロールは自動的に作成されます。Create メソッドは継承された Create メソッドを呼び出し，タブコントロールの初期値を設定します。タブに表示されるテキスト文字列を保持するタブリストも作成されます。


TCustomTabControl.CreateParams
TCustomTabControl.CreateParams3112023

TCustomTabControl	参照

CreateParams メソッドは，タブコントロールにウィンドウ作成パラメータを設定します。

procedure CreateParams(var Params: TCreateParams); override;

説明

タブコントロールは，タブコントロールのウィンドウが生成される必要があるときに内部的に CreateParams を呼び出します。CreateParams は現在のプロパティの設定でタブコントロールを指定するために，継承されたメソッドをオーバーライドします。


TCustomTabControl.CreateWnd
TCustomTabControl.CreateWnd3112024

TCustomTabControl	参照

CreateWnd メソッドは，タブコントロールのウィンドウを作成します。

procedure CreateWnd; override;

説明

CreateWnd メソッドはタブコントロールのウィンドウが再作成されるときに自動的に呼び出されます。CreateWnd メソッドは，継承された CreateWnd メソッドを呼び出してから，内部記憶領域に保存されているタブのテキスト文字列を割り当てます。


TCustomTabControl.Destroy
TCustomTabControl.Destroy3112025

TCustomTabControl	参照

Destroy メソッドは，TCustomTabControl のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは Destroy を直接呼び出さないでください。代わりに Free を使います。Free はタブコントロールが解放されていないことを確認してからのみ Destroy を呼び出します。Destroy メソッドは，タブのテキスト文字列のリストを保持するタブリストを解放し，継承された Destroy メソッドを呼び出します。


TCustomTabControl.DestroyWnd
TCustomTabControl.DestroyWnd3112026

TCustomTabControl	参照

DestroyWnd メソッドは，タブコントロールが使うウィンドウを破棄します。

タブコントロールのウィンドウハンドルを破棄します。

procedure DestroyWnd; override;

説明

DestroyWnd メソッドは，タブコントロールのウィンドウを再生成する必要があるときにタブコントロールが破棄されると自動的に呼び出されます。DestroyWnd は，継承されたメソッドを呼び出す前にタブのテキスト文字列のコピーを内部記憶領域に保存します。


スコープ3112027

protected

published

読み出し／書き込み

読み出し専用


スコープ3112028

protected


スコープ3112029

protected


継承3112030

TObject

TPersistent

TComponent

TControl

TWinControl


TCustomTabControl 例3112031

TCustomTabControl


TCustomTreeView
TCustomTreeView3113001

継承	プロパティ	メソッド	イベント	参照

TCustomTreeView コンポーネントは，TTreeView などのツリービューコンポーネントの基本となる抽象型です。

ユニット

comctrls

説明

TCustomTreeView は，展開または縮小できるノードを持つ階層構造で情報を表すコンポーネントを定義するときに基本クラスとして使います。TCustomTreeView で定義するプロパティのほとんどは Protected プロパティなので，作成するツリービューコントロールで published に設定するかどうかを選択できます。

TCustomTreeView のインスタンスは作成しないでください。フォームにツリービューコントロールを追加するには TTreeView を使います。


TCustomTreeView プロパティ3113002

TCustomTreeView	アルファベット順	凡例

TCustomTreeView

BorderStyle

DropTarget

HideSelection

Images

Indent

Items

ReadOnly

Selected

ShowButtons

ShowLines

ShowRoot

SortType

StateImages

TopItem

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

Parent

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomTreeView プロパティ3113003

TCustomTreeView	オブジェクト順	凡例

Align

BorderStyle

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

DropTarget

Enabled

Handle

Height

HelpContext

HideSelection

Hint

Images

Indent

Items

Left

Name

Owner

Parent

Parent

ReadOnly

Selected

ShowButtons

ShowHint

Showing

ShowLines

ShowRoot

SortType

StateImages

TabOrder

TabStop

Tag

Top

TopItem

VCLComObject

Visible

Width

WindowProc


TCustomTreeView.BorderStyle
TCustomTreeView.BorderStyle3113004

TCustomTreeView	参照

BorderStyle プロパティは，ツリービューコントロールに境界を付けるかどうかを指定します。

TBorderStyle = bsNone..bsSingle;

property BorderStyle: TBorderStyle;

説明

BorderStyle プロパティを設定すると，ツリービューコントロールの周りを一重線で囲むかどうかを指定できます。次の値を指定できます。

値	意味

bsNone	非可視境界

bsSingle	一重境界線


TCustomTreeView.DropTarget
TCustomTreeView.DropTarget3113006

TCustomTreeView	参照

DropTarget プロパティは，ツリービューのどの項目がドラッグアンドドロップ処理のターゲットとして表示されるかを指定します。

property DropTarget: TTreeNode;

説明

DropTarget プロパティは，ツリービュー内のノードがドラッグアンドドロップ処理のターゲットとして描画されるかどうかを取得できます。DropTarget は，ツリービュー内の特定のノードをドラッグされる項目のドロップ先として指定するときに設定します。

注意

DropTarget が設定されているとき，アプリケーションは，指定されたノードがドラッグオブジェクトを受け入れられるように処理するコードを記述する必要があります。


TCustomTreeView.HideSelection
TCustomTreeView.HideSelection3113007

TCustomTreeView	参照

HideSelection プロパティは，フォーカスを別のコントロールに移したときに選択したノードを選択状態で表示するかどうか指定します。

property HideSelection: Boolean;

説明

HideSelection プロパティは，フォーカスがないときにも，ツリービューで現在選択されている項目についての視覚的なフィードバックをユーザーに与えるかどうかを指定できます。True ならば，再度そのコントロールにフォーカスが戻るまでは，選択されているノードも他のノードと同じように表示されます。False ならば，そのノードは選択状態で表示されます。


TCustomTreeView.Images
TCustomTreeView.Images3113008

TCustomTreeView	参照

Images プロパティは，どのイメージリストをツリービューに関連付けるかを表します。

property Images: TImageList;

説明

Images プロパティは，ノードのラベルの左側に表示できるビットマップの独自のリストを提供できます。個々のノードは，ImageIndex プロパティを設定することによって表示されるこのリストからイメージを指定します。


TCustomTreeView.Indent
TCustomTreeView.Indent3113009

TCustomTreeView	参照

Indent プロパティは，子ノードのリストを展開するときのインデント幅をピクセル単位で指定します。

property Indent: Integer;

説明

Indent プロパティを使うと，親ノードを展開するときに，子ノードが親ノードからどのくらいインデントされるかを指定できます。


TCustomTreeView.Items
TCustomTreeView.Items3113010

TCustomTreeView	参照

Items プロパティは，ツリービューコントロールに表示される個々のノードをリストします。

property Items: TTreeNodes;

説明

ツリービュー内の各ノードは TTreeNode オブジェクトです。個々の項目にアクセスするには，Items プロパティとともにツリービュー内での項目のインデックスを使います。たとえばツリービューの 2 番目の項目にアクセスするには次のようなコードを使います。

MyTreeNode := TreeView1.Items[1]

設計時にオブジェクトインスペクタでこのプロパティを設定するときにはツリービュー項目エディタが表示されます。［新規作成］ボタンと［サブアイテムの作成］ボタンを使ってツリービューに項目を追加します。Text プロパティを使うと項目のラベルに表示するテキストを変更できます。

実行時にノードを追加および挿入するには，TTreeNodes オブジェクトの AddChildFirst，AddChild，AddChildObjectFirst，AddChildObject，AddFirst，Add，AddObjectFirst，AddObject，および Insert の各メソッドを使います。

注意

インデックスを使ったツリービュー項目へのアクセスは，特にツリービューに項目が多い場合には非常に時間がかかります。処理効率の向上のためには，できるだけツリービューの項目インデックスに依存しないで済むようにアプリケーションを設計してください。


TCustomTreeView.ReadOnly
TCustomTreeView.ReadOnly3113011

TCustomTreeView	参照

ReadOnly プロパティは，ノードラベルをユーザーが編集できるかどうかを決めます。

property ReadOnly: Boolean;

説明

ReadOnly プロパティは，ツリービューのノードをユーザーが編集できるかどうかを指定します。ReadOnly が True の場合，ユーザーはノードを展開または縮小できますが，ラベルは編集できません。ReadOnly が False ならば，ユーザーはラベルの編集も行えます。デフォルト値は False です。


TCustomTreeView.Selected
TCustomTreeView.Selected3113012

TCustomTreeView	参照

Selected プロパティは，ツリービュー内の選択されているノードを返します。

property Selected: TTreeNode;

説明

Selected プロパティを読み出すと，ツリービュー内の選択されているノードにアクセスできます。選択されているノードがない場合は，Selected の値は nil です。

Selected を設定すると，ツリービュー内のノードを選択できます。ノードが選択されると，ツリービューの OnChanging および OnChanged イベントが発生します。また，指定したノードが縮小した親項目の子ノードである場合，親の子項目リストが展開して指定したノードが表示されます。この場合にも，ツリービューの OnExpanded および OnExpanding イベントが発生します。


TCustomTreeView.ShowButtons
TCustomTreeView.ShowButtons3113013

TCustomTreeView	参照

ShowButtons プロパティは，各親項目の左側に正符号（+）と負符号（-）のボタンを表示するかどうかを指定します。

property ShowButtons: Boolean;

説明

ShowButtons プロパティが True ならば，各親項目の左側にボタンが表示されます。ユーザーは親項目をダブルクリックするかわりにこのボタンをクリックして，子項目の展開または縮小（折りたたみ）ができます。


TCustomTreeView.ShowLines
TCustomTreeView.ShowLines3113014

TCustomTreeView	参照

ShowLines プロパティは，子ノードとそれに対応する親ノードとをつなぐ線を表示するかどうかを指定します。

property ShowLines: Boolean;

説明

ShowLines プロパティが True ならば，子ノードとその親ノードをつなぐ線が表示されます。階層のルートにあるノードは，自動的にはつながれません。ルートにあるノードをつなぐには，ShowsRoot プロパティも True に設定しなければなりません。


TCustomTreeView.ShowRoot
TCustomTreeView.ShowRoot3113015

TCustomTreeView	参照

ShowRoot プロパティは，最上位レベルにあるノードをつなぐ線を表示するかどうかを指定します。

property ShowRoot: Boolean;

説明

最上位レベルにあるノードに 1 つのルートにつなぐ線を表示するには，ツリービューの ShowRoot プロパティと ShowLines プロパティを True に設定します。


TCustomTreeView.SortType
TCustomTreeView.SortType3113016

TCustomTreeView	参照

SortType プロパティは，ツリービューのノードを自動的にソートするかどうかと，どのような状態のときにソートするかを決めます。

property SortType: TSortType;

説明

ツリービューをいったんソートすると元の階層は失われます。つまり，SortType を stNone に戻しても，項目の元の順序は復元できません。SortType には次の値を指定できます。

値	意味

stNone	ソートをしない

stData	Data オブジェクトまたは SortType が変更されたときに項目をソートする

stText	Caption または SortType が変更されたときに項目をソートする

stBoth	Data オブジェクト，Caption，SortType のいずれかが変更されたときに項目をソートする

OnCompare イベントが呼び出されて，ソートする 2 つのノードが比較されます。必要であれば，OnCompare イベントをフックして比較処理をカスタマイズできます。


TCustomTreeView.StateImages
TCustomTreeView.StateImages3113017

TCustomTreeView	参照

StateImages プロパティは，状態イメージに使うイメージリストを決めます。

property StateImages: TImageList;

説明

StateImages プロパティは，ツリービューのノードの状態を表すビットマップのセットを提供できます。 状態イメージは項目のアイコンの左側に追加イメージとして表示されます。


TCustomTreeView.TopItem
TCustomTreeView.TopItem3113018

TCustomTreeView	参照

TopItem プロパティは，ツリービューで表示される一番上のノードです。

property TopItem: TTreeNode;

説明

TopItem プロパティを変更すると，指定したノードがリストビューの一番上になるようにツリービューが垂直方向にスクロールします。


TCustomTreeView イベント3113019

TCustomTreeView	アルファベット順	凡例

TCustomTreeView

OnChange

OnChanging

OnCollapsed

OnCollapsing

OnCompare

OnDeletion

OnEdited

OnEditing

OnExpanded

OnExpanding

OnGetImageIndex

OnGetSelectedIndex


TCustomTreeView イベント3113020

TCustomTreeView	オブジェクト順	凡例

OnChange

OnChanging

OnCollapsed

OnCollapsing

OnCompare

OnDeletion

OnEdited

OnEditing

OnExpanded

OnExpanding

OnGetImageIndex

OnGetSelectedIndex


TCustomTreeView.OnChange
TCustomTreeView.OnChange3113021

TCustomTreeView	参照

OnChange イベントは，1 つのノードから別のノードへ選択を変更したときに発生します。

TTVChangedEvent = procedure(Sender: TObject; Node: TTreeNode) of object;

property OnChange: TTVChangedEvent;

説明

TTVChangedEvent イベントは TTreeView コンポーネント内で 1 つの項目から別の項目へ選択を変更したとき（OnChange イベント）に呼び出されるメソッドへのポインタの型です。Node パラメータは選択状態が変更されたノードです。


TCustomTreeView.OnChanging
TCustomTreeView.OnChanging3113022

TCustomTreeView	参照

OnChanging イベントは，現在のノードから 1 つのノードへ選択を変更しようとしたときに発生します。

TTVChangingEvent = procedure(Sender: TObject; Node: TTreeNode; var AllowChange: Boolean) of object;

property OnChanging: TTVChangingEvent;

説明

TTVChangingEvent イベントは 1 つのノードから別のノードへ選択を変更しようとしたときに呼び出されるメソッドへのポインタの型です。AllowChange をFalse に設定すると，選択を新しいノードに移動できなくなります。Node パラメータは現在選択されているノードを指定します。


TCustomTreeView.OnCollapsed
TCustomTreeView.OnCollapsed3113023

TCustomTreeView	参照

OnCollapsed イベントは，ノードを縮小した後に発生します。

TTVExpandedEvent = procedure(Sender: TObject; Node: TTreeNode) of object;

property OnCollapsed: TTVExpandedEvent;

説明

OnCollapsed イベントハンドラを記述すると，ツリービューのノードの縮小に応答することができます。Node パラメータは子ノードが表示されなくなるノードです。


TCustomTreeView.OnCollapsing
TCustomTreeView.OnCollapsing3113024

TCustomTreeView	参照

OnCollapsing イベントはノードを縮小しようとしたときに発生します。

TTVCollapsingEvent = procedure(Sender: TObject; Node: TTreeNode; var AllowCollapse: Boolean) of object;

property OnCollapsing: TTVCollapsingEvent;

説明

TTVCollapsingEventイベントはノードを縮小しようとしたときに呼び出されるメソッドへのポインタです。AllowCollapse を False に設定すると，Node パラメータで指定したノードを縮小できなくなります。


TCustomTreeView.OnCompare
TCustomTreeView.OnCompare3113025

TCustomTreeView	参照

OnCompare イベントは，ツリービュー内のノードのソート時に 2 つのノードの比較が必要になったときに発生します。

TTVCompareEvent = procedure(Sender: TObject; Node1, Node2: TTreeNode; Data: Integer; var Compare: Integer) of object;

property OnCompare: TTVCompareEvent;

説明

OnCompare イベントハンドラを記述すると，ツリービュー内のノードのソート順序をカスタマイズできます。Node1 が Node2 より小さい場合は，Compare パラメータを 0 より小さい値に設定します。Node1 が Node2 と同じなら，Compare を 0 に設定し，Node1 が Node2 よりも大きい場合は，Compare を 0 より大きい値に設定します。OnCompare イベントハンドラが提供されていない場合は，ツリービューノードはラベルのアルファベット順でソートされます。


TCustomTreeView.OnDeletion
TCustomTreeView.OnDeletion3113026

TCustomTreeView	参照

OnDeletion イベントは，ツリービューのノードを削除したときに発生します。

TTVExpandedEvent = procedure(Sender: TObject; Node: TTreeNode) of object;

property OnDeletion: TTVExpandedEvent;

説明

OnDeletion イベントハンドラを記述すると，ツリービューコントロールからのノードの削除に応答できます。


TCustomTreeView.OnEdited
TCustomTreeView.OnEdited3113027

TCustomTreeView	参照

OnEdited イベントは，ユーザーがノードの Text プロパティを編集した後に発生します。

TTVEditedEvent = procedure(Sender: TObject; Node: TTreeNode; var S: string) of object;

property OnEdited: TTVEditedEvent;

説明

OnEdited イベントハンドラを記述すると，ユーザーによるノードラベルの変更に応答できます。Node パラメータはラベルが編集されたノードです。S パラメータはノードの Text プロパティの新しい値です。ノードのラベルは，ユーザーによる編集が確定される前に OnEdited イベントハンドラで変更できます。このイベントは ReadOnly プロパティが False に設定されているときだけ発生します。


TCustomTreeView.OnEditing
TCustomTreeView.OnEditing3113028

TCustomTreeView	参照

OnEditing イベントは，ユーザーがノードの Text プロパティの編集を開始したときに発生します。

TTVEditingEvent = procedure(Sender: TObject; Node: TTreeNode; var AllowEdit: Boolean) of object;

property OnEditing: TTVEditingEvent;

説明

OnEditing イベントハンドラを記述すると，ユーザーがツリービュー内の特定のノードのラベルを編集できるかどうかを判定できます。AllowEdit パラメータを False に設定すると，ユーザーは Node パラメータで指定されるノードを編集できなくなります。ツリービュー内のすべてのノードを編集できないようにするには，かわりに ReadOnly プロパティを使います。


TCustomTreeView.OnExpanded
TCustomTreeView.OnExpanded3113029

TCustomTreeView	参照

OnExpanded イベントは，ノードを展開した後に発生します。

TTVExpandedEvent = procedure(Sender: TObject; Node: TTreeNode) of object;

property OnExpanded: TTVExpandedEvent;

説明

OnExpanded イベントハンドラを記述すると，ツリービュー内のノードの展開に応答できます。Node パラメータは，子ノードがユーザーに表示されるようになるノードを指定します。


TCustomTreeView.OnExpanding
TCustomTreeView.OnExpanding3113030

TCustomTreeView	参照

OnExpanding イベントは，ノードを展開しようとしたときに発生します。

TTVExpandingEvent = procedure(Sender: TObject; Node: TTreeNode; var AllowExpansion: Boolean) of object;

property OnExpanding: TTVExpandingEvent;

説明

OnExpanding イベントハンドラを記述すると，ノードが展開できるかどうかを判定できます。AllowExpansion パラメータを False に設定すると，ノードを展開できなくなります。


TCustomTreeView.OnGetImageIndex
TCustomTreeView.OnGetImageIndex3113031

TCustomTreeView	参照

OnGetImageIndex イベントは，ツリービューががノードの ImageIndex を調べたたときに発生します。

TTVExpandedEvent = procedure(Sender: TObject; Node: TTreeNode) of object;

property OnGetImageIndex: TTVExpandedEvent;

説明

OnGetImageIndex イベントハンドラを記述すると，特定のノードのイメージインデックスを実際に描画する前に変更できます。たとえば，ノードのビットマップを変更し，ノードの別の状態を表せます。


TCustomTreeView.OnGetSelectedIndex
TCustomTreeView.OnGetSelectedIndex3113032

TCustomTreeView	参照

OnGetSelectedIndex イベントは，ツリービューがノードの SelectedIndex を調べたときに発生します。

TTVExpandedEvent = procedure(Sender: TObject; Node: TTreeNode) of object;

property OnGetSelectedIndex: TTVExpandedEvent;

説明

OnGetSelectedIndex イベントハンドラを記述すると，ノードの選択したイメージインデックスを実際に描画する前に変更できます。


TCustomTreeView メソッド3113033

TCustomTreeView	アルファベット順

TCustomTreeView

AlphaSort

Create

CustomSort

Destroy

FullCollapse

FullExpand

GetHitTestInfoAt

GetNodeAt

IsEditing

LoadFromFile

LoadFromStream

SaveToFile

SaveToStream

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomTreeView メソッド3113034

TCustomTreeView	オブジェクト順

AlphaSort

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

CustomSort

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

FullCollapse

FullExpand

GetHitTestInfoAt

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetNodeAt

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

IsEditing

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

SaveToFile

SaveToStream

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TCustomTreeView.AlphaSort
TCustomTreeView.AlphaSort3113035

TCustomTreeView	参照

AlphaSort メソッドは，すべてのノードをソートし，ツリービューコントロール内をラベルのアルファベット順に並べます。

function AlphaSort: Boolean;

説明

AlphaSort メソッドを呼び出すと，ツリービューのノードをソートできます。成功すると，AlphaSort メソッドは True を返します。ツリービューのすべてのノードが一定のソート順になるようにするには（たとえば，ユーザーがラベルを編集したときなど），SortType プロパティを使います。


TCustomTreeView.Create
TCustomTreeView.Create3113036

TCustomTreeView	参照

Create メソッドは，TTreeView コントロールのインスタンスを作成します。

constructor Create(AOwner: TComponent);

説明

Create メソッドを呼び出すと，実行時にツリービューをインスタンス化できます。設計時にフォームに配置されたツリービューコントロールは自動的に作成されます。Create メソッドは継承されたコンストラクタを呼び出してから，BorderStyle を bsSingle に，ShowButtons を ShowRoot に，ShowLines と HideSelection を True に設定するなど，コントロールの多くのプロパティを初期化します。


TCustomTreeView.CustomSort
TCustomTreeView.CustomSort3113037

TCustomTreeView	参照

CustomSort メソッドは，ツリービュー内のノードを定義したソート順序にソートします。

TTVCompare = function(lParam1, lParam2, lParamSort: Longint): Integer stdcall;

tfunction CustomSort(SortProc: TTVCompare; Data: Longint): Boolean;

説明

CustomSort メソッドを呼び出すと，SortProc パラメータでソート順序が定義されているツリービューのノードをソートできます。ソート手続きの lParam1 および lParam2 パラメータは比較する TTreeNode オブジェクトに割り当てることができます。ソート手続きの lParamSort パラメータは CustomSort の Data パラメータの値です。ソート手続きは ，lParam1 が lParam2 の前にくる場合は 0 より小さい値を返し，2 つの値が同じならば 0 を返し，lParam1 が lParam2 の後にくる場合は 0 より大きい値を返します。

SortProc パラメータが nil ならば，デフォルトの AlphaSort メソッドが呼び出されます。

たとえば，ツリービューをアルファベットの逆順に並べるには，以下の CustomSortProc のようなコールバック関数を呼び出します。この関数は グローバル AnsiStrIComp 関数を呼び出し，その戻り値の正負を逆にします。

function CustomSortProc(Node1, Node2: TTreeNode; Data: integer): integer; stdcall;

begin

  Result := -AnsiStrIComp(PChar(Node1.Text), PChar(Node2.Text));

end;

次の手続きは，ツリービューのノードのソートのための CustomSort のパラメータとして使えるようになります。

TreeView1.CustomSort(@CustomSortProc, 0);

注意

ツリービューのすべてのノードが自動的にソートされるようにするには（たとえば，ユーザーがラベルを編集したときなど），かわりに SortType プロパティを使い，OnCompare イベントハンドラを提供します。


TCustomTreeView.Destroy
TCustomTreeView.Destroy3113038

TCustomTreeView	参照

Destroy メソッドは，ツリービューコントロールを破棄するメソッドで，Delete メソッドによって呼び出されます。

destructor Destroy; override;

説明

ツリーノードを削除するときは，Destroy メソッドのかわりに Delete メソッドを使います。


TCustomTreeView.FullCollapse
TCustomTreeView.FullCollapse3113039

TCustomTreeView	参照

FullCollapse メソッドは，ツリービューコントロール内のすべてのノードを縮小します。

procedure FullCollapse;

説明

FullCollapse メソッドを呼び出すと，第 1 レベルにあるノードを除き，ツリービュー内のノードはすべて隠すことができます。


TCustomTreeView.FullExpand
TCustomTreeView.FullExpand3113040

TCustomTreeView	参照

FullExpand メソッドは，ツリービューコントロール内のすべてのノードを展開します。

Procedure FullExpand;

説明

FullExpand メソッドを呼び出すと，ツリービュー内のすべてのノードを表示できます。ShowButtons が True の場合，ボタンはすべて［+］から［-］に変わります。


TCustomTreeView.GetHitTestInfoAt
TCustomTreeView.GetHitTestInfoAt3113041

TCustomTreeView	参照

GetHitTestInfoAt メソッドは，ある点をツリービューコントロールのクライアント領域から見た場合の相対的な位置情報を返します。

function GetHitTestInfoAt(X, Y: Integer): THitTests;

説明

GetHitTestInfoAt メソッドを呼び出すと，ツリービューのどの部分が X および Y パラメータで指定する点の下に位置するかを判定できます。たとえば，GetHitTestInfoAt メソッドを使うと，マウスがツリービューの特定の部分の上に置かれたときに，ノードを展開または縮小する方法についてのフィードバックを提供することができます。

GetHitTestInfoAt メソッドは THitTests 型を返します。GetHitTestInfoAt の戻り値は次のいずれかです。

値	意味

htAbove	ツリービューコントロールのクライアント領域より上にある

htBelow	ツリービューコントロールのクライアント領域より下にある

htNowhere	ツリービューコントロールのクライアント領域の中にあるが，最後の項目より下にある

htOnItem	項目に関連付けられているビットマップかラベルの上にある

htOnButton	項目に関連付けられているボタンの上にある

htOnIcon	項目に関連付けられているビットマップの上にある

htOnIndent	項目に関連付けられているインデントの上にある

htOnLabel	項目に関連付けられているラベル（テキスト）の上にある

htOnRight	項目の右側の領域内にある

htOnStateIcon	ユーザー定義状態にあるツリービュー項目の状態アイコンの上にある

htToRight	ツリービューコントロールのクライアント領域の右側にある

htToLeft	ツリービューコントロールのクライアント領域の左側にある

次のコードはマウスがツリービューの上にあるときにマウスボタンが押された場合，htHitTest 型のリストを検査し，発生した型を追加します。

procedure TForm1.TreeView1MouseDown(Sender: TObject; Button: TMouseButton;

  Shift: TShiftState; X, Y: Integer);

var

  MyHitTest : THitTests;

begin

  MyHitTest := TreeView1.GetHitTestInfoAt(X,Y);

  if htNowhere in MyHitTest then

    ListBox1.Items.Add('NoWhere');

  if htOnItem in MyHitTest then

    ListBox1.Items.Add('OnItem');

  if htOnButton in MyHitTest then

    ListBox1.Items.Add('OnButton');

  if htOnIndent in MyHitTest then

    ListBox1.Items.Add('OnIndent');

  if htOnLabel in MyHitTest then

    ListBox1.Items.Add('OnLabel');

  if htOnRight in MyHitTest then

    ListBox1.Items.Add('OnRight');

end;


TCustomTreeView.GetNodeAt
TCustomTreeView.GetNodeAt3113042

TCustomTreeView	参照

GetNodeAt メソッドは，指定した位置にあるノードを返します。

function GetNodeAt(X, Y: Integer): TTreeNode;

説明

GetNodeAt メソッドを呼び出すと，X および Y パラメータで指定される位置にあるノードにアクセスできます。X および Y は，ツリービューの左上隅に対する相対位置をピクセル数で指定します。その位置にノードがない場合，GetNodeAt は nil を返します。

たとえば，次のコードでは，GetNodeAt を使って，ドラッグされるノードをドロップしたときにマウスの下にあるノードの子ノードとして追加します。

procedure TForm1.TreeView1DragDrop(Sender, Source: TObject; X, Y: Integer);

var

  AnItem: TTreeNode;

  AttachMode: TNodeAttachMode;

  HT: THitTests;

begin

  if TreeView1.Selected = nil then Exit;

  HT := TreeView1.GetHitTestInfoAt(X, Y);

  AnItem := TreeView1.GetNodeAt(X, Y);

  if (HT - [htOnItem, htOnIcon, htNowhere, htOnIndent] <> HT) then

  begin

    if (htOnItem in HT) or (htOnIcon in HT) then AttachMode := naAddChild

    else if htNowhere in HT then AttachMode := naAdd

    else if htOnIndent in HT then AttachMode := naInsert;

    TreeView1.Selected.MoveTo(AnItem, AttachMode);

  end;

end;


TCustomTreeView.IsEditing
TCustomTreeView.IsEditing3113043

TCustomTreeView	参照

IsEditing メソッドは，ユーザーが現在ノードを編集中であるかどうかを示します。

function IsEditing: Boolean;

説明

IsEditing メソッドは，ツリービュー内のノードラベルが 1 つでも編集中であれば True を返します。


TCustomTreeView.LoadFromFile
TCustomTreeView.LoadFromFile3113044

TCustomTreeView	参照

LoadFromFile メソッドは，FileName に渡された名前のファイルを読み出し，その内容をツリービューにロードします。

procedure LoadFromFile(const FileName: string);

説明

LoadFromFile メソッドは，ファイルからツリービューデータを読み出し，その内容をツリービューにロードします。


TCustomTreeView.LoadFromStream
TCustomTreeView.LoadFromStream3113045

TCustomTreeView	参照

LoadFromStream メソッドは，ストリームからツリービューデータを読み出し，その内容をツリービューに格納します。

procedure LoadFromStream(Stream: TStream);

説明

LoadFromStream メソッドは，指定したストリームからツリービューのノードを読み出します。たとえば，アプリケーションはツリービューに表示される情報をバイナリ大規模オブジェクト（BLOB）項目のデータとして保存できます。LoadFromStream は TBlobStream オブジェクトを使ってデータを取り出します。


TCustomTreeView.SaveToFile
TCustomTreeView.SaveToFile3113046

TCustomTreeView	参照

SaveToFile メソッドは，FileName で指定したファイルにツリービューを保存します。

procedure SaveToFile(const FileName: string);

説明

SaveToFile メソッドは，ツリービューデータをテキストファイルに保存します。ノードは，後で LoadFromFile メソッドを使って，そのファイルから新しいツリービューオブジェクトにロードし直すことができます。


TCustomTreeView.SaveToStream
TCustomTreeView.SaveToStream3113047

TCustomTreeView	参照

SaveToStream メソッドは，Stream パラメータに渡されたストリームにツリービューのデータを書き込みます。

procedure SaveToStream(Stream: TStream);

説明

SaveToStream メソッドは，ツリービューデータをストリームに書き込みます。このデータは，LoadFromStream メソッドを使って，ストリームから別のツリービューオブジェクトに読み出すことができます。


スコープ3113048

protected

published

読み出し／書き込み

読み出し専用


スコープ3113049

protected


継承3113050

TObject

TPersistent

TComponent

TControl

TWinControl


TCustomTreeView 例3113051

TCustomTreeView


TCustomUpDown
TCustomUpDown3114001

継承	プロパティ	メソッド	イベント	参照

TCustomUpDown コントロールは TUpDown などのアップダウンコンポーネントの基本型です。

ユニット

comctrls

説明

TCustomUpDown は，スピンボックスで表示される矢印などのアップダウンコントロールを定義するときに基本クラスとして使います。アップダウンコントロールを使うと，ユーザーは矢印ボタンをクリックすることで数値のサイズを変更できます。TCustomUpDown は，アップダウンコントロールとフォーム内のほかのコントロールを関連付け，ユーザーが指定したサイズ変更に応答するためにいくつかのプロパティ，イベント，およびメソッドを提供します。

TCustomUpDown のインスタンスを作成しないでください。アップダウンコントロールをフォームに配置するには TUpDown を使います。


TCustomUpDown プロパティ3114002

TCustomUpDown	アルファベット順	凡例

TCustomUpDown

AlignButton

ArrowKeys

Associate

Increment

Max

Min

Orientation

Position

Thousands

Wrap

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TCustomUpDown プロパティ3114003

TCustomUpDown	オブジェクト順	凡例

Align

AlignButton

ArrowKeys

Associate

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

Increment

Left

Max

Min

Name

Orientation

Owner

Parent

ParentWindow

Position

ShowHint

Showing

TabOrder

TabStop

Tag

Thousands

Top

VCLComObject

Visible

Width

WindowProc

Wrap


TCustomUpDown.AlignButton
TCustomUpDown.AlignButton3114004

TCustomUpDown	参照

AlignButton プロパティは，対象コントロールと相対するアップダウンコントロールの位置を指定します。

TUDAlignButton = (udLeft, udRight);

property AlignButton: TUDAlignButton;

説明

AlignButton プロパティを設定するとアップダウンコントロールの位置付けを指定できます。アップダウンコントロールは，Associate プロパティで指定されたコントロールの外側の端に並べて表示されます。以下に指定できる値を示します。

値	意味

udLeft	対象コントロールの左端にアップダウンコントロールを位置付ける

udRight	対象コントロールの右端にアップダウンコントロールを位置付ける

アップダウンコントロールは対象コントロールの高さに合わせて自動的にサイズ変更されます。


TCustomUpDown.ArrowKeys
TCustomUpDown.ArrowKeys3114005

TCustomUpDown	参照

ArrowKeys プロパティは，アップダウンコントロールが〔↑〕および〔↓〕キーから入力を受け取るかどうかを決めます。

property ArrowKeys: Boolean;

説明

ArrowKeys プロパティは，アップダウンコントロールがキーボード入力に応答するかどうかを指定できます。ArrowKeys はアップダウンコントロールが対象コントロールに関連付けられている場合にのみ使います。ArrowKeys が True の場合，アップダウンコントロールは対象コントロールに入力フォーカスがあるときでも〔↑〕および〔↓〕キーに応答します。ArrowKeys が False の場合，アップダウンコントロールのボタンをマウスでクリックしなければなりません。対象コントロールを設定するには Associate プロパティを使います。

注意

アップダウンコントロールは，Orientation の値が udHorizontal の場合でも，〔↑〕および〔↓〕キーにのみ応答します。


TCustomUpDown.Associate
TCustomUpDown.Associate3114006

TCustomUpDown	参照

Associate プロパティは，アップダウンコントロールの対象コントロールを指定します。

property Associate: TWinControl;

説明

Associate プロパティは，アップダウンコントロールを対象コントロール（関連するウィンドウ）にリンクできます。アップダウンコントロールは対象コントロールの外側の端に自動的に配置され，対象コントロールに合うように高さが調整されます。

設計時には，対象コントロールはアップダウンコントロールと一緒には移動しません。設計時に，アップダウンコントロールと対象コントロールを一緒にするには，移動する前に両方のコントロールを複数選択するか，最初に対象コントロールを移動してからアップダウンコントロールの Associate プロパティを再設定します。


TCustomUpDown.Increment
TCustomUpDown.Increment3114007

TCustomUpDown	参照

Increment プロパティは，〔↑〕または〔↓〕キーが 1 回押されたときに Position 値が変化する量です。

property Increment: Integer;

説明

Increment プロパティは，アップダウンコントロールの変化量を設定できます。Increment を設定すると，ユーザーが矢印ボタンをクリックしたときに Position プロパティが Min ～ Max 間で移動する変化量を指定できます。


TCustomUpDown.Max
TCustomUpDown.Max3114008

TCustomUpDown	参照

Max プロパティは，Position プロパティの最大値です。

property Max: SmallInt;

説明

Max プロパティは，Position プロパティに指定できる値の範囲に上限を設定できます。


TCustomUpDown.Min
TCustomUpDown.Min3114009

TCustomUpDown	参照

Min プロパティは，Position プロパティの最小値です。

property Min: SmallInt;

説明

Min プロパティは，Position プロパティに指定できる値の範囲に上限を設定できます。


TCustomUpDown.Orientation
TCustomUpDown.Orientation3114010

TCustomUpDown	参照

Orientation プロパティは，矢印キーが指す方向を指定します。

TUDOrientation = (udHorizontal, udVertical);

property Orientation: TUDOrientation;

説明

Orientation プロパティは，矢印ボタンの方向を指定できます。以下のいずれかの値を指定します。

値	意味

udHorizontal	矢印ボタンは左右を指し，水平に表示される

udVertical	矢印ボタンは上下を指し，垂直に表示される

注意

Orientation が udHorizontal の場合でも，アップダウンコントロールは〔↑〕と〔↓〕キーにしか応答しません。


TCustomUpDown.Position
TCustomUpDown.Position3114011

TCustomUpDown	参照

Position プロパティは，アップダウンコントロールが表す現在の値です。

property Position: SmallInt;

説明

Position プロパティは，アップダウンコントロールが表す値を取得または変更できます。Position はMin～Maxの範囲内の値です。

Associate プロパティが編集コントロールを指定する場合，コントロールのテキストは自動的に Position の値に設定されます。Position が変わると編集コントロールのテキストが更新されます。Associate プロパティが nil の場合，OnClick イベントを使うと Position の値が変化したときに応答できます。


TCustomUpDown.Thousands
TCustomUpDown.Thousands3114012

TCustomUpDown	参照

Thousands プロパティは，10 進文字列の 3 桁ごとに千単位の区切りを挿入するかどうかを決めます。

property Thousands: Boolean;

説明

Thousands プロパティは，アップダウンコントロールの対象コントロールのテキスト書式を制御できます。Thousands が True の場合，3 桁ごとに区切りが挿入されます。対象コントロールに表示される数値は Position プロパティで指定します。


TCustomUpDown.Wrap
TCustomUpDown.Wrap3114013

TCustomUpDown	参照

Wrap プロパティは，Max または Min の値を超えようとしたときのアップダウンコントロールの処理を指定します。

property Wrap: Boolean;

説明

Wrap プロパティは，アップダウンコントロールが Max と Min で指定された範囲を連続ループとして扱うかどうかを指定できます。Wrap プロパティの値が True の場合，Position プロパティの値はユーザーが Max プロパティ値を超えて Position プロパティをインクリメントしたときに Min プロパティの値にリセットされ， Min プロパティの値を超えて Position プロパティをデクリメントしたときに Max プロパティの値にリセットされます。


TCustomUpDown イベント3114014

TCustomUpDown	アルファベット順	凡例

TCustomUpDown

OnChanging

OnClick


TCustomUpDown イベント3114015

TCustomUpDown	オブジェクト順	凡例

OnChanging

OnClick


TCustomUpDown.OnChanging
TCustomUpDown.OnChanging3114016

TCustomUpDown	参照

OnChanging イベントは，アップダウンコントロールの値が変更されようとすると発生します。

type TUDChangingEvent = procedure (Sender: TObject; var AllowChange: Boolean) of object;

property OnChanging: TUDChanginEvent;

説明

OnChanging イベントハンドラを記述すると条件付きで Position の値を変更不可にできます。AllowChange パラメータを False に設定すると Position の現在の値に対する変更を防ぐことができます。

OnChanging イベントはユーザーがアップダウンコントロールの矢印ボタンをクリックしたときと Position の値を直接変更しようとしたときに発生します。ユーザーがどのボタンをクリックしたかを調べるには， OnChanging イベントに先行する OnClick イベントを使います。


TCustomUpDown.OnClick
TCustomUpDown.OnClick3114017

TCustomUpDown	参照

OnClick イベントは，ユーザーが矢印ボタンをクリックすると発生します。

TUDBtnType = (btNext, btPrev);

TUDClickEvent = procedure (Sender: TObject; Button: TUDBtnType) of object;

property OnClick: TUDClickEvent

説明

OnClick イベントハンドラを記述すると，ユーザーが矢印ボタンをクリックしたときに特定のアクションを実行できます。たとえば，OnClick イベントハンドラを使うと，Position が変更されようとしている方向をトラッキングして，直後に呼び出される OnChanging イベントハンドラがその変更を許可するかどうかを指定できます。Position の値を変更したときに編集コントロールのテキストを自動的に更新するのに Associate プロパティを使わない場合，OnClick イベントハンドラを使うと Position の値が変更する直前にその変化に応答できます。

Button パラメータは Position の値がどのように変わろうとしているかを指定します。Button が btNext のときに上矢印または右矢印をクリックすると，Position の値は Increment によって増加します。Button が btPrev のときに下矢印または左矢印がクリックすると，Position の値は Increment によって減少します。


TCustomUpDown メソッド3114018

TCustomUpDown	アルファベット順	凡例

TCustomUpDown

CanChange

Click

Create

CreateParams

CreateParented

CreateWnd

Notification

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterFace

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomUpDown メソッド3114019

TCustomUpDown	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanChange

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Click

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParams

CreateParented

CreateWnd

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterFace

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Notification

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TCustomUpDown.CanChange
TCustomUpDown.CanChange3114020

TCustomUpDown	参照

CanChange メソッドは，Position が変更可能かどうかを指定します。

function CanChange: Boolean;

説明

CanChange メソッドはユーザーが矢印ボタンをクリックしたか Position の値を変更しようとしたときに自動的に呼び出されます。CanChange メソッドは，OnChanging イベントハンドラによって変更不可になっていないかぎり，OnChanging イベントを発生させて変更を許可します。

CanChange メソッドをオーバーライドすると，OnChanging イベントハンドラによって制限されていない Position の値の変更を防いだり， OnChanging イベントをブロックしたりできます。


TCustomUpDown.Click
TCustomUpDown.Click3114021

TCustomUpDown	参照

Click メソッドは，OnClick イベントを発生させます。

TUDBtnType = (btNext, btPrev);

procedure Click(Button: TUDBtnType); dynamic;

説明

Click メソッドはユーザーが矢印ボタンをクリックしたか，〔↑〕または〔↓〕キーを押したときに自動的に呼び出されます。Click メソッドをオーバーライドすると， OnClick イベントハンドラを実行する前に特別な処理を実行するように指定したり，OnClick イベントをブロックしたりできます。Button パラメータはどのボタンがクリックされたかを指定します。btNext は上矢印または右矢印を示し，btPrev は下矢印または左矢印を示します。


TCustomUpDown.Create
TCustomUpDown.Create3114022

TCustomUpDown	参照

Create メソッドは，TCustomUpDown のインスタンスを作成し初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出すと実行時にアップダウンコントロールをインスタンス化できます。設計時にフォームに配置されたアップダウンコントロールは自動的に作成されます。

継承されたコンストラクタの呼び出し後，Create は次のプロパティを初期化します。

・	Height および Width はスクロールバー矢印のサイズに従って値を設定される

・	ArrowKeys を True に設定する

・	Max を 100 に，Increment を 1 に設定する

・	AlignButton を udRight に，Orientation を udVertical に設定する

・	Thousands を True に設定する


TCustomUpDown.CreateParams
TCustomUpDown.CreateParams3114023

TCustomUpDown	参照

CreateParams メソッドは，アップダウンコントロールのウィンドウ作成パラメータを初期化します。

procedure CreateParams(var Params: TCreateParams); override;

説明

CreateParams はアップダウンコントロールのウィンドウが作成される前に自動的に呼び出されます。CreateParams は継承されたメソッドを呼び出してから，AlignButton，ArrowKeys，Orientation，Thousands，および Wrap の各プロパティの値を反映するために Params パラメータを設定します。


TCustomUpDown.CreateWnd
TCustomUpDown.CreateWnd3114024

TCustomUpDown	参照

CreateWnd メソッドは，アップダウンコントロールに使うウィンドウの初期パラメータを作成します。

procedure CreateWnd; override;

説明

アップダウンコントロールのウィンドウを作成するために継承されたメソッドを呼び出した後，CreateWnd は Associate，Increment，Max，Min，および Position のそれぞれのプロパティの現在の値を反映するために新しく作成されたウィンドウメッセージを送ります。


TCustomUpDown.Notification
TCustomUpDown.Notification3114025

TCustomUpDown	参照

Notification メソッドは，Associate プロパティが参照するコントロールが破棄されたときに Associate プロパティを更新します。

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

継承されたメソッドの呼び出し後，Notification は Associate プロパティに指定されたコントロールが破棄されようとしているかどうかを調べて，破棄される場合は Associate プロパティを nil に設定します。


スコープ3114026

protected

published

読み出し／書き込み

読み出し専用


スコープ3114027

protected


スコープ3114028

protected


継承3114029

TObject

TPersistent

TComponent

TControl

TWinControl


TCustomUpDown 例3114030

TCustomUpDown


TCustomWinSocket
TCustomWinSocket3115001

継承	プロパティ	メソッド	イベント	参照

TCustomWinSocket オブジェクトはすべての Windows ソケットオブジェクトの基本クラスです。

ユニット

scktcomp

説明

TCustomWinSocket オブジェクトは，Windows ソケット接続のエンドポイントを示すプロパティ，イベント，メソッドを備えています。TCustomWinSocket の下位オブジェクトは，Windows ソケット API 呼び出しを管理し，ソケット通信リンクについての情報を格納するために，ソケットコンポーネントによって使われます。

Windows ソケットは，アプリケーションが他のマシンと接続して情報を読み書きすることを可能にする通信プロトコルのセットをカプセル化します。Windows ソケットは TCP/IP プロトコルに基づく接続を提供します。また，Windows ソケットでは，Xerox Network System（XNS），Digital DECnet プロトコル，または Novell IPX/SPX ファミリーを使用する接続も可能です。ソケットは，実際のネットワークソフトウェアに関係なく，アプリケーションが他のマシンへの接続を確立することを可能にします。

TCustomWinSocket の下位オブジェクトは，ソケット接続での異なるエンドポイントを表します。TClientWinSocket オブジェクトは，サーバーソケットへのソケット通信リンクのクライアントエンドポイントを表します。TServerWinSocket オブジェクトは，リスニング接続のサーバーエンドポイントを表します。TServerClientWinSocket オブジェクトは，クライアントソケットへのソケット通信リンクのサーバーエンドポイントを表します。


TCustomWinSocket プロパティ3115002

TCustomWinSocket	アルファベット順	凡例

TCustomWinSocket

Addr

ASyncStyles

Connected

Data

Handle

LocalAddress

LocalHost

LocalPort

RemoteAddr

RemoteAddress

RemoteHost

RemotePort

SocketHandle


TCustomWinSocket プロパティ3115003

TCustomWinSocket	オブジェクト順	凡例

Addr

ASyncStyles

Connected

Data

Handle

LocalAddress

LocalHost

LocalPort

RemoteAddr

RemoteAddress

RemoteHost

RemotePort

SocketHandle


TCustomWinSocket.Addr
TCustomWinSocket.Addr3115004

TCustomWinSocket	参照

Addr プロパティは，ローカルソケットポートの完全指定を表す，Windows ソケット API 呼び出しで使われるインターネットソケットアドレス構造体を表すレコード型です。

type

  SunB = packed record

    s_b1, s_b2, s_b3, s_b4: u_char;

  end;

  SunW = packed record

    s_w1, s_w2: u_short;

  end;

  TInAddr = packed record

    case integer of

      0: (S_un_b: SunB);

      1: (S_un_w: SunW);

      2: (S_addr: u_long);

  end;

  TSockAddrIn = packed record

    case Integer of

      0: (sin_family: u_short;

          sin_port: u_short;

          sin_addr: TInAddr;

          sin_zero: array[0..7] of Char);

      1: (sa_family: u_short;

          sa_data: array[0..13] of Char)

  end;

property Addr: TSockAddrIn;

説明

Addr プロパティを使うと，Windows ソケット API 呼び出しを直接使うときにローカルシステム上のソケットが使うポート表すことができます。Addr の値は，LocalAddress および LocalPort プロパティの値によって決まります。


TCustomWinSocket.ASyncStyles
TCustomWinSocket.ASyncStyles3115005

TCustomWinSocket	参照

ASyncStyles プロパティは，ソケットが受け取ることができる，非同期イベントについての通知の集合です。

type

  TAsyncStyle = (asRead, asWrite, asOOB, asAccept, asConnect, asClose);

  TAsyncStyles = set of TAsyncStyle;

property ASyncStyles: TAsyncStyles;

説明

ASyncStyles プロパティは，ソケットがどの種類の通知に応答する必要があるかを判別できます。ASyncStyles を設定すると，ソケット接続からソケットが受け取る通知を変更することができます。ASyncStyles は，以下の値の集合です。

値	意味

asRead	ソケットは，読み出しの用意が整っているという通知を受け取る

asWrite	ソケットは，書き込みの用意が整っているという通知を受け取る

asOOB	ソケットは，バンド外のデータが届いたときに通知を受け取る

asAccept	ソケットは，別のソケットが接続を要求したときに通知を受け取る

asConnect	ソケットは，別のソケットへの通信リンクがオープンしたときに通知を受け取る

asClose	ソケットは，別のソケットへの通信リンクが終了したときに通知を受け取る

ASyncStyles によって指定された通知はすべて，Handle プロパティへのウィンドウメッセージとして届きます。

注意

ソケットが非ブロッキングソケットの場合は，ソケットに非同期的な読み出しおよび書き込みイベントについて通知されるように，ASyncStyles に asRead と asWrite が含まれている必要があります。


TCustomWinSocket.Connected
TCustomWinSocket.Connected3115006

TCustomWinSocket	参照

Connected プロパティは，ソケット接続がオープンしていて，他のマシンとの通信に利用可能であるかどうかを示します。

property Connected: Boolean;

説明

Connected プロパティは，Windows ソケット接続を使用または変更しようとする前に取得します。Connected はソケット接続が確立されているかどうかを示します。Connected が True なら，Windows ソケットはオープンされていて，利用可能です。Connected が False なら，Windows ソケットはクローズされていて，変更できません。

クライアント Windows ソケットをオープンするには，Open メソッドを使います。サーバー Windows ソケットをオープンするには，Listen メソッドを使います。クライアントソケットへの接続のサーバーエンドポイントを表す Windows ソケットは，コンストラクタでオープンされます。

Windows ソケットをクローズするには，Close メソッドを使います。


TCustomWinSocket.Data
TCustomWinSocket.Data3115007

TCustomWinSocket

Data プロパティは，ソケットに関連付けられているアプリケーション固有のデータへのポインタです。

property Data: Pointer;

説明

Data プロパティは，ソケット接続に固有の情報を Windows ソケットオブジェクトに関連付けることができます。たとえば，Data プロパティを使えば，サーバーソケットがクライアント接続要求を評価するのに使うアクセス権および認証情報を格納することができます。

Data プロパティは，グローバル変数を使用する必要なく，スレッドで保障される方法で情報を格納できます。多くのクライアントサーバーアプリケーションはマルチスレッドであるので，このプロパティは役に立ちます。


TCustomWinSocket.Handle
TCustomWinSocket.Handle3115008

TCustomWinSocket	参照

Handle プロパティは，Windows ソケットからの通知を受け取るウィンドウの Window ハンドルです。

property Handle: HWnd;

説明

Handle プロパティは，Windows ソケットへメッセージを送信するか，またはソケット接続からの非同期イベントのメッセージを受け取る Window 手続きをサブクラス化することができます。


TCustomWinSocket.LocalAddress
TCustomWinSocket.LocalAddress3115009

TCustomWinSocket	参照

LocalAddress プロパティは，ソケット接続にバインドされたローカルシステムの IP アドレスです。

property LocalAddress: string;

説明

LocalAddress プロパティは，次のような標準のインターネットドット区切り表記の 4 つの数値（4 バイト値）からなる文字列です。

123.197.1.2

各アドレスは，システムを識別し，ソケットによってサポートされているインターフェースの種類を示します。1 つのシステム（マシン）が複数のアドレスをサポートする場合もあります。LocalAddress はソケット接続にバインドされているローカルシステムがサポートしているアドレスの中から指定されるアドレスです。

1 つの LocalAddress を同時に複数のソケット接続が使うこともできます。その場合，LocalAddress が同じである各接続を区別するために，接続ごとに一意の LocalPort 番号が割り当てられる必要があります。


TCustomWinSocket.LocalHost
TCustomWinSocket.LocalHost3115010

TCustomWinSocket	参照

LocalHost プロパティは，ローカルシステムの名前です。

property LocalHost: string;

説明

LocalHost プロパティは，Windows ソケットを使うアプリケーションを実行しているシステムの名前を取得できます。LocalHost プロパティは，次のような，ローカルソケットエンドポイントのドメイン名とサービスからなる文字列です。

http://www.wSite.Com

LocalHost は，LocalAddress プロパティに指定した，ローカル IP アドレスのエリアスを提供します。ほとんどのイントラネットでは，そのネットワーク上のシステムの IP アドレスに対応するホスト名が提供されています。Windows 95 および NT マシンでは，ホスト名が利用できない場合は，HOSTS ファイルに名前を入力して，ローカル IP アドレスに対応するホスト名を作成します。HOSTS ファイルについての詳細は，Microsoft の Windows ソケットのマニュアルを参照してください。


TCustomWinSocket.LocalPort
TCustomWinSocket.LocalPort3115011

TCustomWinSocket	参照

LocalPort プロパティは，ソケット接続によって使われるポートの ID 番号です。

property LocalPort: Integer;

説明

LocalPort プロパティは，ソケット接続にバインドされているポート番号を判別できます。リスニング接続のサーバーエンドポイントの場合は，LocalPort はサーバーソケットが提供するサービスに関連付けられている ID です。別のソケットへの接続のクライアントまたはサーバーエンドポイントの場合は，通常，LocalPort は接続が確立されたときに選ばれた任意の値です。

ポート番号を使うと，LocalAddress プロパティによって識別される 1 つのシステムが，同時に複数の接続のホストとなることができます。LocalPort と LocalAddress の組み合わせは単一のソケット接続だけにバインドされます。この組み合わせは Addr プロパティによって表されます。

LocalPort の多くの値は，規約により，ftp または http などの特定のサービスに関連付けられています。LocalPort の値が特定のサービスに関連付けられているかどうかを調べるには LookupService メソッドを使います。


TCustomWinSocket.RemoteAddr
TCustomWinSocket.RemoteAddr3115012

TCustomWinSocket	参照

RemoteAddr プロパティは，リモートソケットポートの完全指定を表す，Windows ソケット API 呼び出しで使われるインターネットソケットアドレス構造体を表すレコード型です。

Type

  SunB = packed record

    s_b1, s_b2, s_b3, s_b4: u_char;

  end;

  SunW = packed record

    s_w1, s_w2: u_short;

  end;

  TInAddr = packed record

    case integer of

      0: (S_un_b: SunB);

      1: (S_un_w: SunW);

      2: (S_addr: u_long);

  end;

  TSockAddrIn = packed record

    case Integer of

      0: (sin_family: u_short;

          sin_port: u_short;

          sin_addr: TInAddr;

          sin_zero: array[0..7] of Char);

      1: (sa_family: u_short;

          sa_data: array[0..13] of Char)

  end;

property RemoteAddr: TSockAddrIn;

説明

Windows ソケット API 呼び出しを直接使うときは，RemoteAddr を使って，接続の相手側のソケットが使うポートを表します。RemoteAddr の値は，RemoteAddress と RemotePort プロパティの値によって決まります。


TCustomWinSocket.RemoteAddress
TCustomWinSocket.RemoteAddress3115013

TCustomWinSocket	参照

RemoteAddress プロパティは，ソケット接続にバインドされたリモートシステムの IP アドレスです。

property RemotelAddress: string;

説明

RemoteAddress プロパティは，次のような標準のインターネットドット区切り表記の 4 つの数値（4 バイト値）からなる文字列です。

123.197.1.2

各アドレスは，ソケット接続の相手のシステムを識別し，リモートソケットによってサポートされているインターフェースの種類を示します。1 つのシステムが複数のアドレスをサポートする場合もあります。RemoteAddress はソケット接続にバインドされているリモートシステムがサポートしているアドレスの中から指定されるアドレスです。

1 つの RemoteAddress が複数のソケット接続に関わっている場合があります。その場合，RemoteAddress が同じである各接続を区別するために，接続ごとに一意の RemotePort 番号が割り当てられます。RemoteAddr プロパティは，ソケット接続によって使われる RemoteAddress と RemotePort の組み合わせを一意に識別します。


TCustomWinSocket.RemoteHost
TCustomWinSocket.RemoteHost3115014

TCustomWinSocket	参照

RemoteHost プロパティはリモートシステムの名前です。

property RemoteHost: string;

説明

RemoteHost プロパティは，ソケット接続の相手側のシステムの名前を取得できます。RemoteHost プロパティは，次のようなソケット接続のリモートエンドポイントのドメイン名とサービスからなる文字列です。

http://www.wSite.Com

RemoteHost は，RemoteAddress プロパティに指定したローカル IP アドレスのエリアスを提供します。


TCustomWinSocket.RemotePort
TCustomWinSocket.RemotePort3115015

TCustomWinSocket	参照

RemotePort プロパティは，ソケット接続を確立するために RemoteHost によって使われるポートの ID 番号です。

property RemotePort: Integer;

説明

RemotePort プロパティは，ソケット接続の相手側のソケットによって使われるポート番号を取得できます。

ポート番号を使うと，RemoteAddress または RemoteHost プロパティによって識別される 1 つのシステムが，同時に複数の接続のホストとなることができます。RemotePort と RemoteAddress の組み合わせは，単一のソケット接続にだけバインドされます。この組み合わせは RemoteAddr プロパティによって表されます。

多くのポート番号が，規約により，ftp または http などの特定のサービスに関連付けられています。RemotePort の値が特定のサービスに関連付けられているかどうかを調べるには LookupService メソッドを使います。

注意

クライアントソケットが目的のサービスを指定するために特定のポートを要求する場合，実際の接続の RemotePort の値は要求したポート番号とは異なることがあります。ほとんどのサーバーソケットはサービスに関連付けられているポートで監視を行いますが，接続を確立するために利用可能な任意のポート番号に切り替えます。


TCustomWinSocket.SocketHandle
TCustomWinSocket.SocketHandle3115016

TCustomWinSocket	参照

SocketHandle プロパティは，ソケットの Windows ハンドルです。

type TSocket = u_int;

property SocketHandle: TSocket;

説明

SocketHandle プロパティは，ソケットのハンドルを必要とする Windows ソケット API 呼び出しで使います。Connected プロパティが False なら，SocketHandle は INVALID_SOCKET です。

SocketHandle プロパティは，Listen または Open メソッドにより，有効な Windows ソケットハンドルに設定されます。


TCustomWinSocket イベント3115017

TCustomWinSocket	アルファベット順

TCustomWinSocket

OnErrorEvent

OnSocketEvent


TCustomWinSocket イベント3115018

TCustomWinSocket	オブジェクト順

OnErrorEvent

OnSocketEvent


TCustomWinSocket.OnErrorEvent
TCustomWinSocket.OnErrorEvent3115019

TCustomWinSocket	参照

OnErrorEvent イベントは，ソケットが接続の確立，使用，またはシャットダウンに失敗したときに発生します。

type

  TErrorEvent = (eeGeneral, eeSend, eeReceive, eeConnect, eeDisconnect, eeAccept);

  TSocketErrorEvent = procedure (Sender: TObject; Socket: TCustomWinSocket; ErrorEvent: TErrorEvent; var ErrorCode: Integer) of object;

property OnErrorEvent: TSocketErrorEvent;

説明

OnErrorEvent イベントハンドラを記述すると，ソケット接続で発生したエラーに応答することができます。OnErrorEvent イベントハンドラがエラー状況を正常に処理する場合，ErrorCode パラメータを 0 に設定すると ESocketError は生成されません。

Sender パラメータは，エラーハンドラを所有している Windows ソケットオブジェクトです。Socket パラメータは，エラーを起こした Windows ソケットオブジェクトです。通常は，Sender パラメータと同じになります。ErrorEvent パラメータは，失敗が起こったときにソケットが何を行おうとしていたかを示します。ErrorCode パラメータは，失敗した Windows API 関数呼び出しによって返されるエラーコードです。


TCustomWinSocket.OnSocketEvent
TCustomWinSocket.OnSocketEvent3115020

TCustomWinSocket	参照

OnSocketEvent イベントは，Windows ソケットが非同期イベントの通知を受け取ったときに発生します。

TSocketEvent = (seLookup, seConnecting, seConnect, seDisconnect, seListen, seAccept, seWrite, seRead);

TSocketEventEvent = procedure (Sender: TObject; Socket:TCustomWinSocket;SocketEvent: TSocketEvent) of object;

type

  TSocketEvent = (seLookup, seConnecting, seConnect, seDisconnect, seListen, seAccept, seWrite, seRead);

  TSocketEventEvent = procedure (Sender: TObject; Socket: TCustomWinSocket; SocketEvent: TSocketEvent) of object;

property OnSocketEvent: TSocketEventEvent;

説明

OnSocketEvent イベントハンドラを記述すると，Windows ソケットから受け取られた通知に応答することができます。

OnSocketEvent イベントハンドラを設定する前に，このイベントハンドラがまだ割り当てられていないことを確認します。一部の Windows ソケットオブジェクトは，ソケットイベントをディスパッチする OnSocketEvent イベントハンドラで初期化されます。このイベントハンドラを取り替えると，一部の予期されるイベントの発生を防ぐことができます。

Sender パラメータは，イベントハンドラを所有している Windows ソケットオブジェクトです。Socket パラメータは，通知を受け取った Windows ソケットオブジェクトです。通常は，Sender パラメータと同じになります。SocketEvent パラメータは受け取った通知の種類を示します。


TCustomWinSocket メソッド3115021

TCustomWinSocket	アルファベット順	凡例

TCustomWinSocket

Accept

Close

Connect

Create

Destroy

Disconnect

Error

Event

InitSocket

Listen

Lock

LookupName

LookupService

Open

Read

ReceiveBuf

ReceiveLength

ReceiveText

SendBuf

SendStream

SendStreamThenDrop

SendText

SetAsyncStyles

Unlock

Write

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TCustomWinSocket メソッド3115022

TCustomWinSocket	オブジェクト順	凡例

Accept

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Close

Connect

Create

DefaultHandler

Destroy

Disconnect

Dispatch

Error

Event

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InitSocket

InstanceSize

Listen

Lock

LookupName

LookupService

MethodAddress

MethodName

NewInstance

Open

Read

ReceiveBuf

ReceiveLength

ReceiveText

SafeCallException

SendBuf

SendStream

SendStreamThenDrop

SendText

SetAsyncStyles

Unlock

Write


TCustomWinSocket.Accept
TCustomWinSocket.Accept3115023

TCustomWinSocket	参照

Accept メソッドは，クライアントソケットへの接続を受け入れるメソッドにインターフェースを提供します。

type TSocket = u_int;

procedure Accept(Socket: TSocket); virtual;

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。Accept メソッドは，クライアントソケットが接続を要求しているという通知への応答として呼び出されます。Socket パラメータは，通知を受け取るソケットの Windows ソケットハンドルです。

Accept メソッドは，通知に関しては何も行いません。リスニングサーバーソケットを表す TCustomWinSocket の下位オブジェクトは，このメソッドをオーバーライドして，クライアントソケットへの接続を受け入れます。

Accept は ASyncStyles プロパティに asAccept が含まれている場合にのみ呼び出されます。


TCustomWinSocket.Close
TCustomWinSocket.Close3115024

TCustomWinSocket	参照

Close メソッドは，ソケット接続がオープンしている場合に，その接続をシャットダウンします。

procedure Close;

説明

Close メソッドを呼び出すと，オープンソケット接続を終了させることができます。Close は seDisconnect 型の OnSocketEvent イベントをトリガしてから，接続をシャットダウンします。Windows ソケットがリスニングサーバーソケットの場合は，Close はクライアントソケットへのすべてのオープン接続をシャットダウンしてから，リスニング接続をシャットダウンします。


TCustomWinSocket.Connect
TCustomWinSocket.Connect3115025

TCustomWinSocket	参照

Connect メソッドは，クライアントソケットに送信される接続通知に応答するメソッドにインターフェースを提供します。

type TSocket = u_int;

procedure Connect(Socket: TSocket); virtual;

説明

アプリケーションはこの Protected メソッドを呼び出すことはできません。Connect メソッドは，クライアントソケットがサーバーソケットへの接続を正常に完了したという通知への応答として呼び出されます。Socket パラメータは，通知を受け取るソケットの Windows ソケットハンドルです。

TCustomWinSocket の Connect メソッドは，通知に関しては何も行いません。クライアントソケットを表す TCustomWinSocket の下位オブジェクトは，このメソッドをオーバーライドして，接続通知に応答します。

Connect は ASyncStyles プロパティに asConnect が含まれている場合にのみ呼び出されます。


TCustomWinSocket.Create
TCustomWinSocket.Create3115026

TCustomWinSocket	参照

Create メソッドは，Windows ソケットハンドルから TCustomWinSocket のインスタンスを作成します。

type TSocket = u_int;

constructor Create(ASocket: TSocket);

説明

Create メソッドを呼び出すと，Windows ソケットオブジェクトを作成できます。ほとんどの Windows ソケットオブジェクトは，そのオブジェクトを使うソケットコンポーネントによって自動的に作成されます。アプリケーションは，サーバーソケットコンポーネントの OnGetSocket イベントハンドラで独自の Windows ソケットオブジェクトを作成することがあります。

継承コンストラクタを呼び出した後，Create は以下の処理を実行します。

・	Winsock.dll が初期化されていることを確認する

・	マルチスレッド処理を管理するヘルパーオブジェクトを割り当てる

・	ASyncStyles プロパティを初期化して，[asRead, asWrite, asConnect, asClose] に設定する

・	SocketHandle プロパティを ASocket パラメータに初期化し，Connected プロパティを設定して，ASocket が有効なオープン Windows ソケットのハンドルであるかどうかを示す

・	Addr プロパティを初期化する


TCustomWinSocket.Destroy
TCustomWinSocket.Destroy3115027

TCustomWinSocket	参照

Destroy メソッドは，TCustomWinSocket のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは Windows ソケットオブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。Windows ソケットオブジェクトがソケットコンポーネントによって使われていない場合以外は，そのオブジェクトはソケットコンポーネントによって自動的に解放されます。


TCustomWinSocket.Disconnect
TCustomWinSocket.Disconnect3115028

TCustomWinSocket	参照

Disconnect メソッドは，Windows ソケットハンドルによって表されるソケット接続をシャットダウンします。

type TSocket = u_int;

procedure Disconnect(Socket: TSocket); virtual;

説明

アプリケーションはこのメソッドを呼び出すことはできません。Disconnect は，Close メソッドを Protected メソッドとして実現したものです。

Disconnect メソッドは Lock メソッドを呼び出して，メソッドが確実にスレッド保障になるようにします。次に，seDisconnect 型の OnSocketEvent イベントを呼び出します。OnSocketEvent の後で，Disconnect は接続をクローズします。最後に Unlock メソッドを呼び出して，Lock メソッドによって開始されたクリティカルセクションを終了します。


TCustomWinSocket.Error
TCustomWinSocket.Error3115029

TCustomWinSocket	参照

Error メソッドは，Windows ソケットが受け取ったエラーメッセージを OnErrorEvent イベントハンドラにディスパッチします。

type TErrorEvent = (eeGeneral, eeSend, eeReceive, eeConnect, eeDisconnect, eeAccept);

procedure Error(Socket: TCustomWinSocket; ErrorEvent: TErrorEvent; var ErrorCode: Integer); dynamic;

説明

アプリケーションは Error メソッドを呼び出すことはできません。Error メソッドは Protected メソッドとして定義されているので，TCustomWinSocket の下位オブジェクトは失敗した Windows ソケット API 呼び出しのエラーイベントを生成するか，または OnErrorEvent エラーハンドラがエラー状態で終了した後にデフォルトのエラー処理を追加できます。

Socket パラメータは，エラー通知を受け取った Windows ソケットオブジェクトか，または失敗した Windows ソケット API 呼び出しを行った Windows ソケットオブジェクトです。ErrorEvent パラメータは，エラー発生時に Windows ソケットが何を行おうとしていたかを示します。ErrorCode パラメータは Windows から返されるエラーコードです。


TCustomWinSocket.Event
TCustomWinSocket.Event3115030

TCustomWinSocket	参照

Event メソッドは，Windows ソケットが受け取った通知を OnSocketEvent イベントハンドラにディスパッチします。

type TSocketEvent = (seLookup, seConnecting, seConnect, seDisconnect, seListen, seAccept, seWrite, seRead);

procedure Event(Socket: TCustomWinSocket; SocketEvent: TSocketEvent); dynamic;

説明

アプリケーションは Event メソッドを呼び出すことはできません。Event メソッドは Protected メソッドとして定義されているので，TCustomWinSocket の下位オブジェクトは Windows ソケット API を呼び出すときにソケットイベントを生成するか，または OnSocketEvent イベントハンドラのほかに発生するデフォルトのイベント処理を追加できます。

Socket パラメータは，イベント通知を受け取った Windows ソケットオブジェクトか，または Windows ソケット API を呼び出した Windows ソケットオブジェクトです。SocketEvent パラメータは，受け取った通知の種類，または Socket によって行われた呼び出しの種類を示します。


TCustomWinSocket.InitSocket
TCustomWinSocket.InitSocket3115031

TCustomWinSocket	参照

InitSocket メソッドは，目的のソケットポートの記述から Windows インターネットソケットアドレス構造体を表すレコード型変数を生成します。

type

  SunB = packed record

    s_b1, s_b2, s_b3, s_b4: u_char;

  end;

  SunW = packed record

    s_w1, s_w2: u_short;

  end;

  TInAddr = packed record

    case integer of

      0: (S_un_b: SunB);

      1: (S_un_w: SunW);

      2: (S_addr: u_long);

  end;

  TSockAddrIn = packed record

    case Integer of

      0: (sin_family: u_short;

          sin_port: u_short;

          sin_addr: TInAddr;

          sin_zero: array[0..7] of Char);

      1: (sa_family: u_short;

          sa_data: array[0..13] of Char)

  end;

function InitSocket(var Name, Address, Service: string; Port: Word; Client: Boolean): TSockAddrIn;

説明

アプリケーションは InitSocket メソッドを呼び出すことはできません。InitSocket メソッドは，ソケットコンポーネントから取得されるパラメータに対する Windows インターネットソケットアドレス構造体を取得するために，Open または Listen メソッドによって呼び出されます。InitSocket メソッドは Protected メソッドとして定義されているので，コンポーネント作成者は TCustomWinSocket の Open または Listen メソッドをオーバーライドできます。

Name パラメータはソケットのホスト名です。Address パラメータは IP アドレスです。Service パラメータはソケットを使って行うサービスです。Port パラメータはソケットのポート番号です。Client パラメータは，ソケットアドレス構造体がクライアントソケットによって接続先を記述するために使われるのか，サーバーソケットによってリスニング接続を記述するために使われるのかを示します。

Windows インターネットソケットアドレスの TInAddr 部は，ホスト名がある場合は，ホスト名から取得されます。それ以外の場合は，Address パラメータが使われます。Client が True の場合は，Name または Address パラメータのいずれかが指定されていなければなりません。Client が False の場合は，両方とも空白にしておけば，複数のアドレスでリスニングを行うサーバーを指定できます。

Windows インターネットソケットアドレスのポート番号は，Service パラメータが設定されている場合は，Service パラメータから取得されます。それ以外の場合は，Port パラメータが使われます。この 2 つのパラメータは，いずれか 1 つを指定しなければなりません。


TCustomWinSocket.Listen
TCustomWinSocket.Listen3115032

TCustomWinSocket	参照

Listen メソッドは，サーバーソケットのリスニング接続をオープンします。

procedure Listen(var Name, Address, Service: string; Port: Word; QueueSize: Integer);

説明

アプリケーションは Listen メソッドを呼び出すことはできません。Listen メソッドは，リスニング接続をオープンするために，サーバーソケットコンポーネントによって呼び出されます。

Listen メソッドは，リスニング接続を開始し，パラメータから派生した Windows インターネットソケットアドレスをソケットにバインドする Windows ソケットを作成します。次に Listen は seListen 型の OnSocketEvent イベントを生成します。最後に Listen は， Connected プロパティを True に設定して，QueueSize に指定した数のクライアント要求を格納できるキューを持つリスニング接続としてソケットをオープンします。

Name，Address，Service，Port パラメータは，サーバーソケットコンポーネントの Host，Address，Service，Port プロパティからそれぞれ取られます。QueueSize は TServerSocket によって 5 に設定されます。


TCustomWinSocket.Lock
TCustomWinSocket.Lock3115033

TCustomWinSocket	参照

Lock メソッドは，Unlock メソッドが呼び出されるまでは他のすべての実行スレッドをブロックするクリティカルセクションを開始します。

procedure Lock;

説明

Lock メソッドは，スレッド保障でないコードのセクションを開始する前に呼び出します。Unlock メソッドは，コードのクリティカルセクションが完了したときに呼び出します。どうしても必要な場合以外は，Lock を使ってブロッキング接続での読み書きなどの時間のかかる処理をロックしないようにしてください。ロックを使って時間のかかる処理を行うと，アプリケーション内のすべての実行スレッドが Unlock が呼び出されるまで待たなければならなくなるため，処理効率に深刻な影響を及ぼします。


TCustomWinSocket.LookupName
TCustomWinSocket.LookupName3115034

TCustomWinSocket	参照

LookupName メソッドは，ホスト名から Windows インターネットソケットアドレス構造体の TInAddr レコード型変数を生成します。

type

  SunB = packed record

    s_b1, s_b2, s_b3, s_b4: u_char;

  end;

  SunW = packed record

    s_w1, s_w2: u_short;

  end;

  TInAddr = packed record

    case integer of

      0: (S_un_b: SunB);

      1: (S_un_w: SunW);

      2: (S_addr: u_long);

  end;

function LookupName(const name: string) : TInAddr;

説明

LookupName メソッドを呼び出すと，name パラメータによって識別されるシステムに関連付けられているインターネットアドレスを取得できます。LookupName は，Windows インターネットソケットアドレス構造体の TInAddr 部 を生成するために InitSocket によって使われます。


TCustomWinSocket.LookupService
TCustomWinSocket.LookupService3115035

TCustomWinSocket	参照

LookupServiceメソッドは，特定のサービスに関連付けられているポート番号を返します。

function LookupService(const service: string): Integer;

説明

LookupService メソッドを呼び出すと，service パラメータに指定したサービスの標準ポート番号を取得できます。Windows では，ftp，http，finger，time など，多くの標準サービス名が提供されています。各標準名は規約により特定のポート番号に関連付けられています。これらの標準ポート番号を使うと，クライアントソケットは，特定のポート番号を要求して目的のサービスを指定することができます。また，サーバーソケットは，提供されるサービスのポート番号で監視を行うことができます。サーバーは，追加サービスとそのサービスに関連付けるポート番号をSERVICES ファイルに指定できます。SERVICES ファイルについての詳細は，Microsoft の Windows ソケットのマニュアルを参照してください。

InitSocket メソッドは LookupService を呼び出して，ソケットコンポーネントによって指定された Service のポート番号を取得します。


TCustomWinSocket.Open
TCustomWinSocket.Open3115036

TCustomWinSocket	参照

Open メソッドは，リモートソケットへの接続をオープンします。

procedure Open(var Name, Address, Service: string; Port: Word);

説明

アプリケーションは Open メソッドを呼び出すことはできません。Open メソッドは，サーバーソケットへの接続をオープンするために，クライアントソケットコンポーネントによって呼び出されます。

Open メソッドは，サーバーソケットへ接続し，seLookup 型の OnSocketEvent イベントを生成する Windows ソケットを作成します。OnSocketEvent の後で，Open はサーバーソケットを探して，パラメータから派生した Windows インターネットソケットアドレスをソケットにバインドします。次に，Open は seConnecting 型の OnSocketEvent イベント生成します。サーバーソケットによって接続が受け入れられると，Open はサーバーソケットへの接続を完了します。次に，seConnect 型の OnSocketEvent イベントを生成します。OnSocketEvent イベントの後で，Connected を True に設定します。

Name，Address，Service，Port パラメータは，クライアントソケットコンポーネントの Host，Address，Service，Port プロパティからそれぞれ取られます。


TCustomWinSocket.Read
TCustomWinSocket.Read3115037

TCustomWinSocket	参照

Read メソッドは，ソケット接続の用意が整ったという通知への応答として seRead 型の OnSocketEvent イベントを生成します。

type TSocket = u_int;

procedure Read(Socket: TSocket); virtual;

説明

アプリケーションはprotected Read メソッドを呼び出すことはできません。Read メソッドは，ソケット接続で読み出しの用意が整ったという非同期通知への応答として呼び出されます。その後で，OnSocketEvent イベントハンドラで Windows ソケットが接続から情報を読み出したり，OnRead または OnClientRead イベントハンドラでソケットコンポーネントが接続から情報を読み出したりすることができるようになります。イベントハンドラは ReceiveBuf メソッドまたは ReceiveText メソッドを使って，接続から情報を読み出すことができます。

注意

Read は，非ブロッキングソケットでの非同期読み出し通知でのみ呼び出されます。ブロッキングソケットの場合は，読み出しに TWinSocketStream オブジェクトを使う必要があります。TWinSocketStream オブジェクトは，情報の転送を開始する前に，リモートソケットの用意ができるのを待ちます。


TCustomWinSocket.ReceiveBuf
TCustomWinSocket.ReceiveBuf3115038

TCustomWinSocket	参照

ReceiveBuf メソッドは，最大で Count に指定したバイト数をソケット接続から Buf パラメータに読み出します。

function ReceiveBuf(var Buf; Count: Integer): Integer;

説明

ReceiveBuf メソッドを呼び出すと，Windows ソケットオブジェクトの OnSocketEvent イベントハンドラ，あるいはソケットコンポーネントの OnRead または OnClientRead イベントハンドラでソケット接続から情報を読み出すことができます。ReceiveBuf は実際に読み出したバイト数を返します。

ReceiveBuf は，非ブロッキング Windows ソケットへの読み出し通知に対する応答として使われるだけです。ブロッキングソケットの場合は，読み出しに TWinSocketStream を使う必要があります。TWinSocketStream オブジェクトは，情報の転送を開始する前に，リモートソケットの用意ができるのを待ちます。

接続から読み出されるバイト数は ReceiveLength メソッドで指定されます。


TCustomWinSocket.ReceiveLength
TCustomWinSocket.ReceiveLength3115039

TCustomWinSocket	参照

ReceiveLength メソッドは，Windows ソケットが読み出せるように，ソケット接続で送信される用意ができているバイト数です。

function ReceiveLength: Integer;

説明

ReceiveLength メソッドを呼び出すと，非同期読み出し通知への応答としてソケット接続で読み出す情報の量を指定できます。


TCustomWinSocket.ReceiveText
TCustomWinSocket.ReceiveText3115040

TCustomWinSocket	参照

ReceiveText メソッドはソケット接続から文字列を読み出します。

function ReceiveText: string;

説明

ReceiveText メソッドを呼び出すと，Windows ソケットオブジェクトの OnSocketEvent イベントハンドラで，あるいはソケットコンポーネントの OnRead または OnClientRead イベントハンドラでソケット接続から文字列を読み出すことができます。ReceiveText は文字列のバイト数を返します。

ReceiveText は，非ブロッキング Windows ソケットへの読み出し通知に対する応答として使われるだけです。ブロッキングソケットの場合は，読み出しに TWinSocketStream を使う必要があります。TWinSocketStream オブジェクトは，情報の転送を開始する前に，リモートソケットの用意ができるのを待ちます。


TCustomWinSocket.SendBuf
TCustomWinSocket.SendBuf3115041

TCustomWinSocket	参照

SendBuf メソッドは，Buf パラメータから Count バイトのデータをソケット接続に書き込みます。

function SendBuf(var Buf; Count: Integer): Integer;

説明

SendBuf メソッドを呼び出すと，ソケット接続に情報を書き込むことができます。書き込みは，Windows ソケットオブジェクトの OnSocketEvent イベントハンドラ，あるいはソケットコンポーネントの OnWrite または OnClientWrite イベントハンドラで行われることがあります。反対に SendBuf は，接続で読み出しを行えることを知らせる通知を受けずに接続に書き込むことになっているソケットから情報を書き込むこともあります。SendBuf は実際に書き込まれたバイト数を返します。接続への書き込み中にエラーが発生した場合は，SendBuf は接続を終了し，ESocketError 例外を生成します。


TCustomWinSocket.SendStream
TCustomWinSocket.SendStream3115042

TCustomWinSocket	参照

SendStream メソッドは，AStream パラメータから読み出せるすべての情報をソケット接続に書き込みます。

function SendStream(AStream: TStream): Boolean;

説明

SendStream メソッドを呼び出すと，ソケット接続に情報を書き込むことができます。書き込みは，Windows ソケットオブジェクトの OnSocketEvent イベントハンドラ，あるいはソケットコンポーネントの OnWrite または OnClientWrite イベントハンドラで行われることがあります。反対に SendStream は，接続で読み出しを行えることを知らせる通知を受けずに接続に書き込むことになっているソケットから情報を書き込むこともあります。SendStream は AStream で示されるストリームから情報を読み出して，その情報をソケット接続に書き込みます。SendStream の戻り値は，情報が正常に接続に書き込まれたかどうかを示します。


TCustomWinSocket.SendStreamThenDrop
TCustomWinSocket.SendStreamThenDrop3115043

TCustomWinSocket	参照

SendStreamThenDrop メソッドは，AStream パラメータから読み出せるすべての情報をソケット接続に書き込んでから，接続を終了します。

function SendStreamThenDrop(AStream: TStream): Boolean;

説明

SendStreamThenDrop メソッドを呼び出すと，書き込みが完了したら接続が不要になる場合に，ソケット接続に情報を書き込んでから接続を終了することができます。SendStream は AStream で示されるストリームから情報を読み出し，その情報をソケット接続に書き込んでから，接続をシャットダウンします。SendStream の戻り値は，なんらかの情報が接続に書き込まれたかどうかを示します。


TCustomWinSocket.SendText
TCustomWinSocket.SendText3115044

TCustomWinSocket	参照

SendText メソッドは，文字列 S をソケット接続に書き込みます。

procedure SendText(const S: string);

説明

SendText メソッドを呼び出すと，文字列をソケット接続に書き込むことができます。書き込みは，Windows ソケットオブジェクトの OnSocketEvent イベントハンドラ，あるいはソケットコンポーネントの OnWrite または OnClientWrite イベントハンドラで行われることがあります。反対に SendText は，接続で読み出しを行えることを知らせる通知を受けずに接続に書き込むことになっているソケットから情報を書き込むこともあります。接続への書き込み中にエラーが発生した場合は，SendText は接続を終了し，ESocketError 例外を生成します。


TCustomWinSocket.SetAsyncStyles
TCustomWinSocket.SetAsyncStyles3115045

TCustomWinSocket	参照

SetAsyncStyles メソッドは AsyncStyles プロパティを設定します。

procedure SetAsyncStyles(Value: TASyncStyles);

説明

SetAsyncStyles メソッドは AsyncStyles プロパティを実現します。SetAsyncStyles メソッドは Protected メソッドとして定義されているので，TCustomWinSocket の下位オブジェクトは AsyncStyles の値を特定の種類の Windows ソケットに適切な通知に制限できます。


TCustomWinSocket.Unlock
TCustomWinSocket.Unlock3115046

TCustomWinSocket	参照

Unlock メソッドは，クリティカルセクションが Lock メソッドによって開始された後で，他のスレッドの実行を再有効化します。

procedure Unlock;

説明

Unlock メソッドは，スレッドセーフでないコードのセクションの最後で呼び出します。Unlock の呼び出しはすべて，コードのクリティカルセクションの最初の Lock メソッドの呼び出しと対を成していなければなりません。


TCustomWinSocket.Write
TCustomWinSocket.Write3115047

TCustomWinSocket	参照

Write メソッドは，ソケット接続の用意が整ったという通知への応答として，seWrite 型の OnSocketEvent イベントを生成します。

type TSocket = u_int;

procedure Write(Socket: TSocket); virtual;

説明

アプリケーションはprotected Write メソッドを呼び出すことはできません。Write メソッドは，ソケット接続でソケットが情報を送信するための用意が整ったという非同期通知に対する応答として呼び出されます。その後で，OnSocketEvent イベントハンドラで Windows ソケットが接続に情報を書き込んだり，OnWrite または OnClientWrite イベントハンドラでソケットコンポーネントが接続に情報を書き込んだりできるようになります。イベントハンドラは，SendBuf メソッド，SendStream メソッド，または SendText メソッドを使って情報を接続に書き込むことができます。

注意

Write は，非ブロッキングソケットでの非同期書き込み通知でのみ呼び出されます。ブロッキングソケットは，独自のメカニズムを使っていつ接続でソケットが書き込みを行う用意が整うかを判定する必要があります。


読み出し／書き込み3115048

読み出し専用


スコープ3115049

protected


継承3115050

TObject


TCustomWinSocket 例3115051

TCustomWinSocket


TDatabase
TDatabase3116001

継承	プロパティ	メソッド	イベント	参照

TDatabase コンポーネントはデータベースアプリケーションで単一のデータベースに接続する場合に個別の制御を提供します。

ユニット

dbtables

説明

TDatabase コンポーネントは，データベースアプリケーションで次のようなデータベース制御が必要なときに使います。

・	永続的なデータベース接続の作成

・	データベースサーバーログインのカスタマイズ

・	トランザクションの制御

・	アプリケーションに固有な BDE エリアスの作成

TDatabase は，リモート SQL データベースサーバーへの接続の際に BDE を使ったデータベーストランザクション処理を制御する場合には特に重要です。

注意

アプリケーションがデータベース接続で上記の制御を必要としない場合は， TDatabase コンポーネントをアプリケーションで各データベース接続に対して明示的に宣言しなくてもかまいません。TDatabase コンポーネントがデータベース接続に対して明示的に宣言およびインスタンス化されていない場合は，実行時にデフォルトのプロパティセットを使って一時的なデータベースコンポーネントが作成されます。


TDatabase プロパティ3116002

TDatabase	アルファベット順	凡例

TDatabase

AliasName

Connected

DatabaseName

DataSetCount

DataSets

Directory

DriverName

Handle

HandleShared

InTransaction

IsSQLBased

KeepConnection

Locale

LoginPrompt

Params

Session

SessionAlias

SessionName

Temporary

TraceFlags

TransIsolation

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDatabase プロパティ3116003

TDatabase	オブジェクト順	凡例

AliasName

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Connected

DatabaseName

DataSetCount

DataSets

DesignInfo

Directory

DriverName

Handle

HandleShared

InTransaction

IsSQLBased

KeepConnection

Locale

LoginPrompt

Name

Owner

Params

Session

SessionAlias

SessionName

Tag

Temporary

TraceFlags

TransIsolation

VCLComObject


TDatabase.AliasName
TDatabase.AliasName3116004

TDatabase	参照

AliasName プロパティは，データベース接続が使用するボーランドデータベースエンジン（BDE）エリアスを指定します。

property AliasName: string;

説明

AliasName プロパティを使うと，データベースコンポーネントの既存の BDE エリアスの名前を指定できます。BDE エリアスには，InterBase，dBASE，Paradox などの特定のデータベースへの接続のためのデータベース環境設定情報が含まれています。BDE エリアスと関連付けられている環境設定情報はデータベースの種類によって異なります。

エリアスは自動的にパラメータの 1 つとしてドライバ名を指定するため，アプリケーションが AliasName を設定すると，以前に DriverName プロパティに割り当てられていた値はすべてクリアされます。他のエリアス接続情報は AliasName が設定されるときに Params プロパティに格納されます。

注意

Connected プロパティが True のときに AliasName を設定しようとすると，例外が生成されます。

注意

目的の BDE エリアス環境設定がまだ存在していない場合，アプリケーションは AliasName を設定するかわりに DatabaseName，DriverName，Params プロパティを指定することができます。またアプリケーションは，AliasName がすでに設定されているとき，DatabaseName を設定してアプリケーション専用のエリアス名として使用することができます。

参考

設計時に TDatabase コンポーネントをダブルクリックすると，データベースエディタを起動して AliasName を設定できます。


TDatabase.Connected
TDatabase.Connected3116005

TDatabase	参照

Connected プロパティは，データベース接続がアクティブかどうかを示します。

property Connected: Boolean;

説明

Connected プロパティを True に設定すると，データセットをオープンせずにデータベース接続を確立できます。Connected プロパティを False に設定すると，データベース接続を終了できます。アプリケーションは Connected プロパティをチェックして，データベース接続の現在の状態を判定することができます。Connected プロパティが True の場合はデータベース接続はアクティブで，Connected プロパティが False で KeepConnection プロパティも False の場合は，データベース接続は非アクティブです。

注意

KeepConnection プロパティを True に設定すると，データベース接続を開始するたびにサーバーにログインしないで済むようになります。


TDatabase.DatabaseName
TDatabase.DatabaseName3116006

TDatabase	参照

DatabaseName プロパティは，データベースコンポーネントに関連付けるデータベースの名前を指定します。

property DatabaseName: string;

説明

DatabaseName プロパティを使うと，データベースコンポーネントに関連付けるデータベースの名前を指定できます。DatabaseName が既存のボーランドデータベースエンジン（BDE）エリアスと同じである場合は，AliasName プロパティと DriverName プロパティを設定する必要はありません。DatabaseName が既存の BDE エリアスと一致しない場合は，アプリケーションは AliasName プロパティと DatabaseName プロパティに有効なエリアスを設定するか，または DriverName プロパティと Params プロパティを設定する必要があります。

Paradox または dBASE データベースへ接続するときは，DatabaseName は絶対パス名にすることができます。

注意

Connected プロパティが True のときに DatabaseName を設定しようとすると，例外が生成されます。

参考

設計時に TDatabase コンポーネントをダブルクリックすると，データベースエディタを起動して DatabaseName を設定できます。


TDatabase.DataSetCount
TDatabase.DataSetCount3116007

TDatabase	参照

DataSetCount プロパティは，データベースコンポーネントに関連付けられているアクティブなデータセットの数を示します。

property DataSetCount: Integer;

説明

DataSetCount プロパティを使うと，データベースコンポーネントに関連付けられている現在アクティブなデータセットの数を判定できます。データセットをオープンしたり，クローズしたりするのにつれて，この値は変更されます。

たとえば，次のコードは，DataSetCount を使って，すべてのオープンデータセット（テーブル）に対して 1 つの処理が確実に行われるようにします。

var

  I: Integer;

begin

 with Database1 do

  for I := 0 to DataSetCount - 1 do

    if DataSets[I] is TTable then

      DataSets[I].CachedUpdates := True;

end;


TDatabase.DataSets
TDatabase.DataSets3116008

TDatabase	参照

DataSets プロパティは，データベースコンポーネントのすべてのアクティブなデータセットのインデックス化された配列を示します。

property DataSets[Index: Integer]: TDBDataSet;

説明

DataSets プロパティを使うと，データベースコンポーネントに関連付けられているアクティブなデータセットにアクセスできます。アクティブなデータセットは，現在オープンされているデータセットです。たとえば，次のコードは，DataSets プロパティと DataSetCount プロパティを使って，すべてのオープンデータセット（テーブル）に対して 1 つの処理が確実に行われるようにします。

var

  I: Integer;

begin

 with Database1 do

  for I := 0 to DataSetCount - 1 do

    if DataSets[I] is TTable then

      DataSets[I].CachedUpdates := True;

end;


TDatabase.Directory
TDatabase.Directory3116009

TDatabase	参照

Directory プロパティは，Paradox データベースまたは dBASE データベースの作業用ディレクトリを指定します。

property Directory: string

説明

実行時に Directory プロパティを指定すると，Paradox データベースまたは dBASE データベースの作業用ディレクトリを変更または取得できます。作業用ディレクトリは，実行時にデータベースが一時的なテーブルを作成するのに使用する場所です。

ディレクトリ位置は，通常，データベースエリアス（AliasName プロパティで指定）の PATH パラメータで指定します。ただし，一部のアプリケーションでは，実行時に，データベースを開いた後で作業用ディレクトリを変更することが必要になる場合があります。

実行時に Directory プロパティの値を変更するには，データベースをすでに開いている必要があります。開いていな場合は，例外が生成されます。現在の Directory プロパティの値をクリアすると，データベースを初めて開いたときに指定されていた作業用ディレクトリに設定されます。

注意

リモートデータベースへ接続するときは Directory を使用しないでください。そのような状況では例外が生成されます。また，データベースが閉じているときにアプリケーションが Directory にアクセスした場合にも，例外が生成されます。


TDatabase.DriverName
TDatabase.DriverName3116010

TDatabase	参照

DriverName プロパティは，データベースの BDE ドライバの名前を指定します。

property DriverName: string;

説明

DriverName プロパティを使用すると，AliasName を指定せずに DatabaseName を指定するデータベース接続に使用する BDE ドライバの名前を指定できます。DriverName は，有効な BDE ドライバ（STANDARD，ORACLE，SYBASE，INTERBASE など）でなければなりません。

注意

アプリケーションが DriverName を設定する場合は，Params プロパティの接続パラメータも指定する必要があります。通常は，AliasName プロパティで指定したエリアスが接続パラメータを提供しますが，BDE ドライバ名の競合を避けるため，DriverName が設定されると，AliasName プロパティは自動的にクリアされます。

Connected プロパティが True のときに DriverName を設定しようとすると，例外が生成されます。

参考

設計時に TDatabase コンポーネントをダブルクリックすると，データベースエディタを起動して DriverName を設定できます。


TDatabase.Handle
TDatabase.Handle3116011

TDatabase	参照

Handle プロパティは，ボーランドデータベースエンジン（BDE）データベースハンドルを指定します。

type

HDBIDB: Longint;

property Handle: HDBIDB;

説明

Handle プロパティは，TDatabase メソッドをバイパスして BDE API を直接呼び出す場合にだけ使用します。多くの BDE 関数呼び出しでハンドルパラメータが必要になります。Handle には，データベースを開いたときの初期値が割り当てられます。

注意

アプリケーションで Delphi の標準コンポーネントでは利用できない BDE 機能が必要な場合を除いて，このプロパティを使用しないでください。


TDatabase.HandleShared
TDatabase.HandleShared3116012

TDatabase

HandleShared プロパティは，データベースハンドルを共有するかどうかを示します。

property HandleShared: Boolean;

説明

HandleShared プロパティは，データベースコンポーネントが，あるセッションコンポーネントでその BDE  ハンドルを共有するかどうかを示します。HandleShared を True に設定すると，リモートのデータモジュールやオブジェクトリポジトリから継承したデータモジュールに表示されるデータベースコンポーネント間における，命名上の競合を回避できます。


TDatabase.InTransaction
TDatabase.InTransaction3116013

TDatabase	参照

InTransaction プロパティは，データベーストランザクションが進行中かどうかを示します。

property InTransaction: Boolean

説明

実行時に InTransaction を調べると，データベーストランザクションが現在進行中かどうかを判定できます。トランザクションが進行中の場合，InTransaction は True です。それ以外の場合は False です。

InTransaction の値は直接変更できません。StartTransaction を呼び出すと InTransaction が True に設定されます。Commit または Rollback を呼び出すと InTransaction が False に設定されます。


TDatabase.IsSQLBased
TDatabase.IsSQLBased3116014

TDatabase	参照

IsSQLBased プロパティは，データベースコンポーネントがボーランドデータベースエンジン（BDE）SQL Link ドライバまたは BDE ODBC ソケットを使用しているかどうかを示します。

property IsSQLBased: Boolean;

説明

実行時に IsSQLBased プロパティを調べると，データベース接続で BDE SQL Link ドライバ，ODBC ソケット，または，Paradox，dBASE，ASCII テキストファイル STANDARD ドライバを使用しているかどうかを判定できます。IsSQLBased が True の場合，データベース接続で SQL Link ドライバを使用しているか，または ODBC ソケットを使用してサードパーティの ODBC ドライバと通信しています。データベース接続で STANDARD ドライバを使用している場合，IsSQLBased プロパティは False になります。


TDatabase.KeepConnection
TDatabase.KeepConnection3116015

TDatabase	参照

KeepConnection プロパティは，オープンされているデータセットがなくてもアプリケーションをデータベースに接続しておくかどうかを指定します。

property KeepConnection: Boolean;

説明

KeepConnection プロパティを使うと，オープンされているデータセットが現在なくてもアプリケーションをデータベースに接続しておくかどうかを指定できます。KeepConnection が Trueの場合（デフォルト）は，接続は維持されます。リモートデータベースサーバーへ接続する場合や，アプリケーションが頻繁にデータセットをオープンしたりクローズしたりする場合は，KeepConnection を True に設定すると，ネットワークトラフィックを減少させアプリケーションの処理速度を速めることができ，接続を確立し直すたびにサーバーにログインしないで済むようにすることができます。

KeepConnection が False の場合，オープンデータセットがないときは接続が解除されます。接続が解除されると，接続に割り当てられていたシステムリソースが解放されますが，後でそのデータベースを使用するデータセットをオープンする場合には，接続を再確立および初期化する必要があります。

注意

Delphi によって必要に応じて自動的に作成される一時的なデータベースコンポーネントの KeepConnection 設定は，TSession の KeepConnections プロパティで決まります。


TDatabase.Locale
TDatabase.Locale3116016

TDatabase	参照

Locale プロパティは，データベースコンポーネントのボーランドデータベースエンジン（BDE）言語ドライバを識別します。

type

TLocale: Pointer;

property Locale: TLocale;

説明

Locale プロパティを調べると，データベースコンポーネントが使用する BDE 言語ドライバを判定できます。また，BDE を直接呼び出すアプリケーションも，API 関数パラメータとして Locale プロパティの情報を渡すことが必要な場合があります。

また，言語ドライバの情報は，データベースコンポーネントが BDE エリアスを使用しているときは Params プロパティの値の 1 つとして利用できることもあります。

注意

アプリケーションで Delphi の標準コンポーネントでは利用できない BDE 機能が必要な場合を除いて，このプロパティを使用しないでください。


TDatabase.LoginPrompt
TDatabase.LoginPrompt3116017

TDatabase	参照

LoginPrompt プロパティは，データベース接続を確立しようとするときに，標準［ログイン］ダイアログボックスが表示されるかどうかを示します。

property LoginPrompt: Boolean;

説明

LoginPrompt プロパティは，リモートデータベース接続のログイン方法を制御します。True の場合（デフォルト），アプリケーションがデータベースに接続しようとしたときに，Delphi の標準［ログイン］ダイアログボックスが表示されるか，または，アプリケーションに OnLogin イベントが記述されていればそのイベントが呼び出されます。

標準［ログイン］ダイアログボックスでは，有効なユーザー名とパスワードの入力が求められます。ユーザーが入力した値が有効でない場合は接続できません。OnLogin イベントを提供するアプリケーションは，そのイベントでこれらの値がサーバーに確実に渡されるようにする必要があります。

アプリケーションが LoginPrompt を False に設定した場合，ユーザー名とパスワードは，Params プロパティの USERNAME パラメータと PASSWORD パラメータとして提供する必要があります。

注意

ユーザー名とパスワードを Params プロパティまたは OnLogin イベントのコードに格納しておくことは，サーバーのセキュリティを危険にさらすことになります。


TDatabase.Params
TDatabase.Params3116018

TDatabase	参照

Params プロパティは，データベースコンポーネントと関連付けられているボーランドデータベースエンジン（BDE）エリアスのデータベース接続パラメータを保持します。

property Params: TStrings;

説明

Params プロパティで，パス名，サーバー名，スキーマキャッシュサイズ，言語ドライバ，ユーザー名，パスワードなどの，データベース接続パラメータを調べたり指定したりすることができます。Params プロパティの実際のパラメータは，データベースコンポーネントの現在の BDE エリアスおよびドライバによって異なります。

注意

アプリケーションは Params を使って，BDE エリアスによって供給されたデフォルト設定値をオーバーライドすることができます。

Params プロパティは，それぞれ別々のデータベース接続パラメータを表す文字列項目のリストです。AliasName プロパティで有効な BDE エリアスを指定していれば，Params にはそのエリアスに定義されているパラメータが自動的に入ります。エリアスを提供するかわりに，アプリケーションが DriverName プロパティを使ってローカルエリアスを提供した場合は，直接 Params 値を提供する必要があります。

参考

設計時に TDatabase コンポーネントをダブルクリックすると，データベースエディタを起動して Params を設定できます。


TDatabase.Session
TDatabase.Session3116019

TDatabase	参照

Session プロパティは，データベースコンポーネントが関連付けられているセッションコンポーネントを示します。

property Session: TSession

説明

Session プロパティは，データベースコンポーネントを制御しているセッションコンポーネントを示します。デフォルトでは，データベースコンポーネントはすべてのデータベースアプリケーションに対して自動的に作成されるデフォルトセッションコンポーネントの Session に関連付けられています。データベースコンポーネントをマルチスレッドアプリケーションで別のセッションに割り当てる場合は，SessionName プロパティで別のセッションコンポーネントの名前を指定します。


TDatabase.SessionAlias
TDatabase.SessionAlias3116020

TDatabase	参照

SessionAlias プロパティは，データベースコンポーネントがセッションエリアスを使用しているかどうかを示します。

property SessionAlias: Boolean;

説明

SessionAlias プロパティは，データベースコンポーネントがセッションエリアスを使用しているかどうか示します。SessionAlias が True の場合はセッションエリアスが使用されています。False の場合は使用されていません。

セッションエリアスは，以下の場合にデータベースコンポーネントに対して自動的に作成されます。

・	AliasName プロパティのかわりに DriverName プロパティと Params プロパティを使っていて，Params プロパティにパラメータがある

・	AliasName で BDE エリアスによって供給された Params 値をオーバーライドする

また，アプリケーションで，Params プロパティで指定したものとは別のユーザー名を使ってユーザーがサーバーにログインすることが許可されている場合にも，セッションエリアスが作成されます。

セッションエリアスはアプリケーション実行中のみ存在します。セッションエリアスは BDE 環境設定ファイルに記録されず，アプリケーションの外からアクセスできません。


TDatabase.SessionName
TDatabase.SessionName3116021

TDatabase	参照

SessionName プロパティは，データベースコンポーネントが使用しているセッションの名前を表します。

property SessionName: string;

説明

SessionName プロパティは，データベースコンポーネントをどのセッションに関連付けるかを指定します。SessionName が空白の場合，データベースコンポーネントは自動的にデフォルトのセッション名 Default に関連付けられます。

データベースコンポーネントをデータベースアプリケーションで別のセッションに関連付けるには，SessionName を既存のセッションコンポーネントの SessionName プロパティと一致させる必要があります。


TDatabase.Temporary
TDatabase.Temporary3116022

TDatabase	参照

Temporary プロパティは，データベースコンポーネントが，必要に応じてシステムが作成した一時的なものなのか，アプリケーション内で明示的に作成，管理，解放される永続的なものなのかを示します。

property Temporary: Boolean;

説明

Temporary プロパティは，データベースコンポーネントが必要に応じてシステムが作成した一時的なものなのか，アプリケーション内で明示的に作成，管理，解放される永続的なものなのかを示します。システムが作成したコンポーネントの場合 Temporary は True で，それ以外の場合は False です。

一時的なデータベースコンポーネントは，データセットをオープンしたときにそのデータセットが既存のデータベースコンポーネントに関連付けられていない場合に作成されます。データセットをクローズするときに Temporary が True のままの場合は，一時的なデータベースコンポーネントは解放されます。アプリケーションが一時的なデータベースコンポーネントを破棄しないようにするには，データセットがアクティブなうちに Temporary を False に設定します。ただしその場合は，データベースが必要でなくなったときに，アプリケーションでデータベースを閉じるようにする必要があります。


TDatabase.TraceFlags
TDatabase.TraceFlags3116023

TDatabase	参照

TraceFlags プロパティは，実行時に SQL モニタで追跡されるデータベース操作を指定します。

type

TTraceFlag = (tfQPrepare, tfQExecute, tfError, tfStmt, tfConnect, tfTransact,

tfBlob, tfMisc, tfVendor, tfDataIn, tfDataOut);

TTraceFlags = set of TTraceFlag;

property TraceFlags: TTraceFlags;

説明

TraceFlagsは，実行時に SQL モニタがアプリケーションで追跡するデータベース操作を指定します。TraceFlags は SQL モニタに対してだけ意味があります。SQL モニタを使うと，リモート SQL データベースサーバーを使った作業のチューニングや SQL デバッグを行えます。

注意

通常は，アプリケーションのコードで TraceFlags を設定せずに，SQL モニタでトレースオプションを設定します。

セッションに関連付けられているデータベースコンポーネントの TraceFlags プロパティの初期値は，セッションコンポーネントの TraceFlags プロパティの値で決まります。

TTraceFlags 型は TraceFlags プロパティに指定できる値を定義します。指定できる値を以下に示します。

値	意味

tfQPrepare	Prepare 文をモニタする

tfQExecute	ExecSQL 文をモニタする

tfError	サーバーからのエラーメッセージをモニタする。エラーメッセージには，エラーコードが含まれることがある

tfStmt	すべての SQL 文をモニタする

tfConnect	データベースとの接続や接続解除に関連した操作（接続ハンドルの割り当てや解放など）をモニタする

tfTransact	トランザクション文（StartTransaction，Commit，Rollbackなど）をモニタする

tfBlob	BLOB データ型に対する操作をモニタする

tfMisc	他のフラグオプションに網羅されないその他の文をモニタする

tfVendor	データベースサーバーへの直接の API 関数呼び出しをモニタする

tfDataIn	サーバーから受け取ったデータをモニタする

tfDataOut	サーバーへ送るデータをモニタする

TTraceFlags は集合型であるため，アプリケーションは複数のフラグを組み合わせて指定して複数の文をモニタすることができます。たとえば，次の文ではデータベース接続と SQL 文の準備がモニタされます。

TraceFlags := [tfConnect, tfQPrepare];


TDatabase.TransIsolation
TDatabase.TransIsolation3116024

TDatabase	参照

TransIsolation プロパティは，ボーランドデータベースエンジン（BDE）によって管理されるトランザクションのトランザクションアイソレーションレベルを指定します。

type

TTransIsolation = (tiDirtyRead, tiReadCommitted, tiRepeatableRead);

property TransIsolation: TTransIsolation;

説明

TransIsolation プロパティは，BDE によって管理されるデータベーストランザクションのトランザクションアイソレーションレベルを指定します。トランザクションアイソレーションレベルは，そのトランザクションが同時に同じテーブルにアクセスする他のトランザクションと対話する方法や，他のトランザクションによる変更内容をそのトランザクションがどの程度認識するようにするかを決めます。

注意

パススルー SQL を使ってトランザクションを処理するアプリケーションの場合，適切な SQL 文を使ってトランザクションアイソレーションレベルを直接データベースサーバーに渡す必要があります。

TransIsolation には次の 3 つの値のいずれかを指定できます。

アイソレーションレベル	意味

tiDirtyRead	他のトランザクションによるデータベースへのコミットされていない変更内容を読み出せる。コミットされていない変更内容は永続的なものではなく，いつでもロールバック（取り消し）できる。一番低いアイソレーションレベル

tiReadCommitted	他のトランザクションによるデータベースへのコミットされた（永続的な）変更内容だけを読み出せる。TransIsolation プロパティのデフォルト値

tiRepeatableRead	データベースを単独で一度だけ読み出せる。それ以降に他のトランザクションによって加えられた変更は認識しない。トランザクションがレコードを読み出したら，自分で変更しない限り，レコードは変更されない

データベースサーバーによって，サポートされているトランザクションアイソレーションレベルが異なります。アプリケーションが TransIsolation をリモート SQL サーバーによってサポートされていないレベルに設定した場合は，BDE はそのサーバーでサポートされている次に高いアイソレーションレベルを使用します。BDE が認識するサーバーによってサポートされているアイソレーションレベルは次のとおりです。

サーバー	指定したレベル	使用されるレベル

Oracle	tiDirtyRead	tiReadCommitted

tiReadCommitted	tiReadCommitted

tiRepeatableRead	tiRepeatableRead（読み出し専用）

Sybase，MS-SQL	tiDirtyRead	tiReadCommitted

tiReadCommitted	tiRepeatableRead

tiReadCommitted	設定できない

DB2	tiDirtyRead	tiDirtyRead

tiReadCommitted	tiReadCommitted

tiRepeatableRead	tiRepeatableRead

Informix	tiDirtyRead	tiDirtyRead

tiReadCommitted	tiReadCommitted

tiRepeatableRead	tiRepeatableRead

InterBase	tiDirtyRead	tiReadCommitted

tiReadCommitted	tiReadCommitted

tiRepeatableRead	tiRepeatableRead

Paradox，dBASE	tiDirtyRead	tiDirtyRead

tiReadCommitted	設定できない

tiRepeatableRead	設定できない

注意

Paradox および dBASE に対するローカルトランザクションの場合，TransIsolation を tiDirtyRead に設定する必要があります。tiDirtyRead に設定しないと，例外が生成されます。

アプリケーションが ODBC を使ってサーバーとのインターフェースをとる場合は，ODBC ドライバはアイソレーションレベルもサポートしなくてはなりません。サポートされるアイソレーションレベルについての詳細は，各 ODBC ドライバのマニュアルを参照してください。


TDatabase イベント3116025

TDatabase	アルファベット順	凡例

TDatabase

OnLogin


TDatabase イベント3116026

TDatabase	オブジェクト順	凡例

OnLogin


TDatabase.OnLogin
TDatabase.OnLogin3116027

TDatabase	参照

OnLogin イベントは，アプリケーションがデータベースに接続したときに発生します。

TLoginEvent = procedure(Database: TDatabase; LoginParams: TStrings) of object;

property OnLogin: TLoginEvent;

説明

OnLogin イベントハンドラを記述すると，アプリケーションがデータベースへ接続しようとしたときに特定の処理が行われるようにすることができます。デフォルトでは，データベースログインが必要です。現在の USERNAME が Params プロパティから読み出され，標準［ログイン］ダイアログボックスが表示されます。このダイアログボックスは，ユーザー名とパスワードの入力を要求し，ユーザーが入力した値を使って Params プロパティの USERNAME および PASSWORD 値を設定します。この値はリモートサーバーに渡されます。

OnLogin イベントハンドラを提供するアプリケーションは LoginParams に USERNAME および PASSWORD 値を設定する必要があります。LoginParams は一時的な文字列リストで，必要がなくなったら，自動的に解放されます。


TDatabase メソッド3116028

TDatabase	アルファベット順

TDatabase

ApplyUpdates

Close

CloseDataSets

Commit

Create

Destroy

FlushSchemaCache

Open

Rollback

StartTransaction

ValidateName

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntity

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDatabase メソッド3116029

TDatabase	オブジェクト順

ApplyUpdates

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Close

CloseDataSets

Commit

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FlushSchemaCache

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntity

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

Open

RemoveComponent

Rollback

SafeCallException

StartTransaction

ValidateName


TDatabase.ApplyUpdates
TDatabase.ApplyUpdates3116030

TDatabase	参照

ApplyUpdates メソッドは，指定したデータセット内の未処理のキャッシュアップデートをデータベースサーバーに登録します。

procedure ApplyUpdates(const DataSets: array of TDBDataSet);

説明

ApplyUpdates メソッドは，オープンデータセットの指定したセットの未処理のキャッシュアップデートをデータベースサーバーに登録します。ApplyUpdates は指定したデータセットの CachedUpdates プロパティが True の場合にのみ意味があります。

DataSets は，どのデータセットの未処理のキャッシュアップデートを登録するかを指定するデータセット名のリストです。DataSets は現在オープンされているすべてのデータセットをリストする必要はありません。リストされている各データセットに対して ApplyUpdates はデータセットの ApplyUpdates メソッドと CommitUpdates メソッドを呼び出して，そのデータセットの未処理のキャッシュアップデートを登録します。

アップデートの適用は，データベースコンポーネントのトランザクションコントロールのコンテキストで発生する 2 段階の処理で行われます。アプリケーションが ApplyUpdates を呼び出すと，以下のイベントが発生します。

1.	データベーストランザクションが開始される

2.	キャッシュアップデートがデータベースに書き込まれる（第 1 段階）

データベースへの書き込みが正常に行われた場合は，以下の処理が行われる

1.	データベースの変更がコミットされ，トランザクションが終了する

2.	キャッシュアップデートがコミットされ，内部キャッシュバッファが解放される（第 2 段階）

データベースへの書き込みが正常に行われなかった場合は，データベースの変更がロールバックされてトランザクションが終了する。

このような 2 段階での処理により，特に，複数の相互に関連しているデータセット（たとえば，マスタ/リンクフォームと関連付けられているデータセットなど）を更新する場合に，エラーの回復を効率的に行えます。


TDatabase.Close
TDatabase.Close3116031

TDatabase	参照

Close メソッドは，データベースコンポーネントに関連付けられているすべてのオープンデータセットをクローズし，データベースサーバーとの接続を解除します。

procedure Close;

説明

Close メソッドは，データベースサーバーとの接続を解除します。接続の解除により，接続に割り当てられていたシステムリソースが解放されます。

注意

Close は，KeepConnection プロパティが False のときに，データベースコンポーネントに関連付けられているオープンデータセットがなくなると，自動的に呼び出されます。また，データベース接続は Connected プロパティを False に設定しても解除できます。


TDatabase.CloseDataSets
TDatabase.CloseDataSets3116032

TDatabase	参照

CloseDataSets メソッドは，データベースサーバーとの接続は解除せずに，データベースコンポーネントに関連付けられているすべてのデータセットをクローズします。

procedure CloseDatasets;

説明

CloseDataSets メソッドは，データベースサーバーとの接続は解除せずに，すべてのアクティブなデータセットをクローズします。アプリケーションが Close を呼び出すと，通常はすべてのデータセットがクローズされ，データベースサーバーとの接続は解除されます。Close のかわりに CloseDataSets を呼び出せば，アプリケーションはすべてのアクティブなデータセットをクローズできますが，接続は解除されないので後でデータベースサーバーに接続し直さずに済みます。


TDatabase.Commit
TDatabase.Commit3116033

TDatabase	参照

Commit メソッドは，現在のトランザクションに関連付けられているデータの変更，挿入，削除を永続的に保存し，現在のトランザクションを終了します。

procedure Commit;

説明

Commit メソッドは，現在のトランザクションに関連付けられているデータの変更，追加，削除をすべてデータベースサーバーに永続的に保存してから，現在のトランザクションを終了します。現在のトランザクションとは最後に StartTransaction を呼び出して開始されたトランザクションです。

注意

アプリケーションは，Commit を呼び出す前に InTransaction プロパティのステータスをチェックできます。アプリケーションが Commit を呼び出したときにアクティブなトランザクションがない場合は，例外が生成されます。


TDatabase.Create
TDatabase.Create3116034

TDatabase	参照

Create メソッドは，TDatabase コンポーネントのインスタンスを作成します。

constructor Create(AOwner: TComponent);

説明

Create メソッドは，実行時にデータベースコンポーネントをインスタンス化します。アプリケーションはデータベースコンポーネントの存在を制御するためにコンポーネントを作成してプロパティとイベントを設定するか，または実行時に Delphi に必要に応じて一時データベースコンポーネントを作成させることができます。

Create はデータベースコンポーネントをインスタンス化して，以下の処理を行います。

・	Session プロパティをアクティブなセッションに設定する

・	SessionName プロパティをアクティブなセッションコンポーネントの名前に設定する

・	コンポーネントをセッションのデータベースコンポーネントのリストに追加する

・	DataSets プロパティに空のデータセットコンポーネントのリストを作成する

・	Params プロパティに空の文字列のリストを作成する

・	LoginPrompt プロパティと KeepConnection プロパティを True に設定する

・	Locale プロパティをセッションのロケールに設定する

・	TransIsolation プロパティを tiReadCommitted に設定する


TDatabase.Destroy
TDatabase.Destroy3116035

TDatabase	参照

Destroy メソッドは，データベースコンポーネントのインスタンスを破棄します。

destructor Destroy;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはデータベースコンポーネントが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy はすべてのアクティブなデータセットを閉じて，必要であればデータベースサーバーとの接続を終了します。次に，Params プロパティと DataSets プロパティに割り当てられていた文字列リソースを解放してから，継承デストラクタを呼び出します。


TDatabase.FlushSchemaCache
TDatabase.FlushSchemaCache3116036

TDatabase	参照

FlushSchemaCache メソッドは，テーブルのキャッシュスキーマ情報をフラッシュします。

procedure FlushSchemaCache(const TableName: string);

説明

FlushSchemaCache メソッドは，SQL テーブルのスキーマ情報が変更された場合（たとえば，項目，インデックス，またはテーブルがデータベースに追加されるかデータベースから接続解除されため）に呼び出します。

アプリケーションが SQL テーブルを開くと，項目名，項目型，インデックス情報を記述したスキーマ情報がメモリに格納されます。アプリケーションが SQL テーブルのスキーマを変更する場合は，FlushSchemaCache を呼び出してメモリ内のスキーマ情報を更新する必要があります。


TDatabase.Open
TDatabase.Open3116037

TDatabase	参照

Open メソッドは，データベースサーバーに接続します。

procedure Open;

説明

Open メソッドは，ローカルまたはリモートのデータベースサーバーへの接続を確立します。Open メソッドは DatabaseName プロパティまたは Directory プロパティで指定したデータベースが存在していることと，ユーザー名とパスワードが有効であることを確認します。確認できた場合は，データベースに接続します。データベースコンポーネントに OnLogin イベントが記述されている場合は実行されます。それ以外の場合はデフォルトの［ログ］ダイアログボックスが表示されます。

注意

Connected プロパティを True に設定しても，データベースサーバーに接続できます。


TDatabase.Rollback
TDatabase.Rollback3116038

TDatabase	参照

Rollback メソッドは，現在のトランザクションでの変更，追加，削除をすべて取り消して，トランザクションを終了します。

procedure Rollback;

説明

Rollback メソッドは，現在のトランザクションでの変更，追加，削除をすべて取り消してトランザクションを終了します。現在のトランザクションとは，最後に StartTransaction を呼び出して開始されたトランザクションです。

注意

アプリケーションは，Rollback を呼び出す前に InTransaction プロパティのステータスをチェックできます。アプリケーションが Rollback を呼び出したときにアクティブなトランザクションがない場合は例外が生成されます。


TDatabase.StartTransaction
TDatabase.StartTransaction3116039

TDatabase	参照

StartTransaction メソッドは，データベースサーバーに対して新しいトランザクションを開始します。

procedure StartTransaction;

説明

StartTransaction メソッドはデータベースサーバーに対して新しいトランザクションを開始します。アプリケーションは，StartTransaction を呼び出す前に InTransaction プロパティのステータスをチェックし，TransIsolation プロパティを設定する必要があります。InTransaction が True の場合（トランザクションがすでに進行中）は，次の StartTransaction 呼び出しを行う前に Commit または Rollback を呼び出して現在のトランザクションを終了しておかないと例外が生成されます。

StartTransaction の呼び出し以降に行った変更，追加，削除は，アプリケーションが Commit を呼び出して変更内容を保存するか，Rollback を呼び出して変更内容を取り消すまでサーバーに保持されます。


TDatabase.ValidateName
TDatabase.ValidateName3116040

TDatabase	参照

ValidateName メソッドは，指定したデータベースがアクティブなセッションですでにオープンされている場合，例外を生成します。

procedure ValidateName(const Name: string);

説明

ValidateName を呼び出すと，1 のセッション内からデータベースへ重複してアクセスするのを防ぐことができます。Name はテストするデータベースの名前の文字列です。指定したデータベースがすでにオープンされている場合，ValidateName は EDatabaseError 例外を生成します。データベースがオープンされていない場合，アプリケーションは処理を続行します。

注意

ほとんどのアプリケーションはこのメソッドを直接呼び出す必要はありません。このメソッドはデータベースをオープンするたびに自動的に呼び出されます。


スコープ3116041

published

読み出し／書き込み

読み出し専用


スコープ3116042

published


継承3116043

TObject

TPersistent

TComponent


TDatabase 例3116044

TDatabase


THTTPDataLink
THTTPDataLink3117001

継承	プロパティ	メソッド	参照

THTTPDataLink は，TDSTableProducer オブジェクトがデータソースとのリンク状態を管理するときに使うコンポーネントです。

ユニット

dbweb

説明

THTTPDataLink は，TDSTableProducer オブジェクトとともに動作するように作られています。このコンポーネントを使えるクラスは TDSTableProducer だけです。


THTTPDataLink プロパティ3117002

THTTPDataLink	アルファベット順	凡例

THTTPDataLink

DefaultFields

FieldCount

Fields

SparseMap

TDataLink からの継承

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


THTTPDataLink プロパティ3117003

THTTPDataLink	オブジェクト順	凡例

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

DefaultFields

Editing

FieldCount

Fields

ReadOnly

RecordCount

SparseMap


THTTPDataLink.DefaultFields
THTTPDataLink.DefaultFields3117004

THTTPDataLink	参照

DefaultFields プロパティは，TDSTableProducer によって作られるデータセット表現が，動的に生成された項目コンポーネントを使うかどうかを示します。

property DefaultFields: Boolean;

説明

DefaultFields プロパティを読み込むと，動的に生成された項目コンポーネントまたは持続項目コンポーネントが，テーブル表示内に表示されるかどうかがわかります。テーブル表示内の各項目は，DefaultFields が True の場合，動的に割り当てられた項目コンポーネントを表し，False の場合，持続項目コンポーネントから構築されます。データソースの表示が持続項目コンポーネントから構築される場合，基となるデータベーステーブルに存在する項目の全部が，この画像に現れない場合があります。


THTTPDataLink.FieldCount
THTTPDataLink.FieldCount3117005

THTTPDataLink	参照

FieldCount プロパティは，Fields 配列内のエントリ数を示します。

property FieldCount: Integert;

説明

FieldCount プロパティは，Fields プロパティ内の全項目コンポーネントを反復して処理するときに使います。このプロパティは，データソース内に表示される列の数を表します。Fields 配列には未定義項目コンポーネントが含まれることがあり，これは計算項目などデータセット内に存在しない項目コンポーネントに対応するものです。


THTTPDataLink.Fields
THTTPDataLink.Fields3117006

THTTPDataLink	参照

Fields プロパティは，データソース画像に表示される可能性のある，データセットの全項目コンポーネントからなるインデックス配列です。

property Fields[I: Integer]: TField;

説明

Fields プロパティは，インデックスによって項目コンポーネントにアクセスできます。Fields[0]は最初のコンポーネント，Fields[1]は 2 番目のコンポーネントとなり，以下同様です。SparseMap プロパティが True の場合，このプロパティには未定義項目コンポーネントが含まれます。これらの未定義コンポーネントが指定されると，このプロパティは nil を返します。

TDSTableProducer は，Fields プロパティを使って，データセットを構成する全項目コンポーネントを追跡します。必要なときはいつでも，TDSTableProducer は列の項目バインディングと Fields プロパティ内の項目コンポーネントを一致させます。


THTTPDataLink.SparseMap
THTTPDataLink.SparseMap3117007

THTTPDataLink	参照

SparseMap プロパティは，TDSTableProduce がテーブル内の項目の数または順序をカスタマイズしたかどうかを示します。

property SparseMap: Boolean;

説明

SparseMap プロパティは，Fields プロパティが単に元のデータセットをそのまま表わしているのかどうかがわかります。TDSTableProducer は，項目マップを構築したときに SparseMap を設定します。SparseMap が False になるのは，TDSTableProducer がデータセットから直接，デフォルト項目マップを構築したときで，True になるのは項目の数または順序がデフォルトの項目マップと異なるものになったときです。True の場合，Fields 配列には未定義項目が入っている場合があります。


THTTPDataLink メソッド3117008

THTTPDataLink	アルファベット順	凡例

THTTPDataLink

ActiveChanged

AddMapping

ClearMapping

Create

DataSetChanged

DataSetScrolled

Destroy

EditingChanged

FocusControl

GetMappedIndex

LayoutChanged

Modified

RecordChanged

Reset

UpdateData

TDataLink からの継承

Edit

UpdateRecord

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THTTPDataLink メソッド3117009

THTTPDataLink	オブジェクト順	凡例

ActiveChanged

AddMapping

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearMapping

Create

DataSetChanged

DataSetScrolled

DefaultHandler

Destroy

Dispatch

Edit

EditingChanged

FieldAddress

FocusControl

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetMappedIndex

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LayoutChanged

MethodAddress

MethodName

Modified

NewInstance

RecordChanged

Reset

SafeCallException

UpdateData

UpdateRecord


THTTPDataLink.ActiveChanged
THTTPDataLink.ActiveChanged3117010

THTTPDataLink	参照

ActiveChanged メソッドは，Active プロパティが変化したとき，それを TDSTableProducer に通知します。

procedure ActiveChanged; override;

説明

アプリケーションで直接 ActiveChanged を呼び出すことはできません。Active プロパティが変化すると，このメソッドが起動します。データセットがアクティブになったとき，このメソッドは TDSTableProducer の LinkActive メソッドを呼び出して，それによってテーブルのレイアウトを再計算します。


THTTPDataLink.AddMapping
THTTPDataLink.AddMapping3117011

THTTPDataLink	参照

AddMapping メソッドは，Fields 配列の末尾に項目コンポーネントを追加します。

function AddMapping(const FieldName: string): Boolean;

説明

アプリケーションでは直接 AddMapping を呼び出さないでください。直接，呼び出すと，TDSTableProducer が使用する THTMLTableColumns オブジェクトと Fields 配列が同期しなくなるからです。TDSTableProducer は繰り返し AddMapping を呼び出して Fields 配列をセットアップし，Fields 配列の内容がテーブル表示の列と一致するようにします。


THTTPDataLink.ClearMapping
THTTPDataLink.ClearMapping3117012

THTTPDataLink	参照

ClearMapping メソッドは，Fields 配列を空にし，そのメモリも解放します。

procedure ClearMapping;

説明

アプリケーションでは直接 ClearMapping を呼び出さないでください。直接呼び出すと，TDSTableProducer が使用する THTMLTableColumns オブジェクトと Fields 配列が同期しなくなるからです。TDSTableProducer は，列マッピングが変わるたびに，ClearMapping を呼び出してから Fields 配列を再構築します。


THTTPDataLink.Create
THTTPDataLink.Create3117013

THTTPDataLink	参照

Create メソッドは THTTPDataLink のインスタンスを作成します。

constructor Create(DSTableProducer: TDSTableProducer);

説明

アプリケーションでは直接 THTTPDataLink の Create メソッドを呼び出さないでください。TDSTableProducer は自身のコンストラクタから THTTPDatalink オブジェクトをインスタンス化します。


THTTPDataLink.DataSetChanged
THTTPDataLink.DataSetChanged3117014

THTTPDataLink	参照

DataSetChanged メソッドは，データセットが変化したことを TDSTableProducer に通知します。

procedure DataSetChanged; override;

説明

アプリケーションで直接 DataSetChanged を呼び出すことはできません。データセットの内容が変化すると，自動的にこのメソッドが起動されます。


THTTPDataLink.DataSetScrolled
THTTPDataLink.DataSetScrolled3117015

THTTPDataLink	参照

DataSetScrolled メソッドは，データセット上のスクローリングイベントを無視します。

procedure DataSetScrolled(Distance: Integer); override;

説明

アプリケーションで直接 DataSetScrolled を呼び出すことはできません。このメソッドは，継承されたメソッドをオーバーライドすることで，ユーザとの対話ができるオブジェクトがデータソースを共有したときに TDSTableProducer がスクローリングイベントを無視できるようにします。


THTTPDataLink.Destroy
THTTPDataLink.Destroy3117016

THTTPDataLink	参照

Destroy メソッドは，THTTPDataLink のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。THTTPDataLink オブジェクトのオーナーである TDSTableProducer オブジェクトは，自身のデストラクタから Free メソッドを呼び出し，THTTPDataLink オブジェクトを破棄します。Free メソッドは，THTTPDataLink オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy メソッドは，Fields 配列が使用していたメモリを解放した後，継承されたデストラクタを呼び出します。


THTTPDataLink.EditingChanged
THTTPDataLink.EditingChanged3117017

THTTPDataLink	参照

EditingChanged メソッドは，データセットの編集状態の変化を無視します。

procedure EditingChanged; override;

説明

アプリケーションで直接 EditingChanged を呼び出すことはできません。このメソッドは，データセットの編集状態の変化を無視します。TDSTableProducer とは無関係だからです。


THTTPDataLink.FocusControl
THTTPDataLink.FocusControl3117018

THTTPDataLink	参照

FocusControl メソッドは，指定された項目にフォーカスを設定させようとする要求を破棄します。

procedure FocusControl(Field: TFieldRef); override;

説明

TDSTableProducer は，個々の項目にフォーカスを設定する方法をサポートしていません。FocusControl メソッドは，データソースを介して送られた，フォーカスを個々の項目に設定したいという要求を破棄します。


THTTPDataLink.GetMappedIndex
THTTPDataLink.GetMappedIndex3117019

THTTPDataLink	参照

GetMappedIndex メソッドは，Fields 配列内項目コンポーネントを指すインデックスと対応する，データセット内項目コンポーネントを指すインデックスを返します。

function  GetMappedIndex(ColIndex: Integer): Integer;

説明

アプリケーションで直接 GetMappedIndex を呼び出すことはできません。このメソッドは，Fields 配列内の項目コンポーネントを指すインデックスである ColIndex を入力パラメータとして受取り，それに対応するデータセット内の項目コンポーネントのインデックスを返します。


THTTPDataLink.LayoutChanged
THTTPDataLink.LayoutChanged3117020

THTTPDataLink	参照

LayoutChanged メソッドは，設計時に列レイアウトが変化したことを TDSTableProducer に通知します。

procedure LayoutChanged; override;

説明

アプリケーションで直接 LayoutChanged を呼び出すことはできません。このメソッドは，設計時に列レイアウトが変化したときに自動的に起動され，TDSTableProducer に指示して，テーブルのレイアウトを再計算させます。


THTTPDataLink.Modified
THTTPDataLink.Modified3117021

THTTPDataLink	参照

Modified メソッドは，データセットの現在のレコードに書き込まれていないデータ変化を追跡します。

procedure Modified;

説明

Modified メソッドは，データセットの現在のレコードにおいて項目の値を変更する前に呼び出します。Fields プロパティによってインデックス付けされた項目コンポーネントに直接，書き込まれた変更については，このメソッドを呼び出す必要はありません。


THTTPDataLink.RecordChanged
THTTPDataLink.RecordChanged3117022

THTTPDataLink	参照

RecordChanged メソッドは，データソースの現在のレコードまたは項目が変化したことを無視します。

procedure RecordChanged(Field: TField); override;

説明

アプリケーションで直接 RecordChanged を呼び出すことはできません。このメソッドは，データソース内の現在のレコードが変化したことを無視します。TDSTableProducer とは無関係だからです。


THTTPDataLink.Reset
THTTPDataLink.Reset3117023

THTTPDataLink	参照

Reset メソッドは，編集中のデータで，データセットの現在のレコードにまだ書き込まれていないものをすべて取り消します。

procedure Reset;

説明

アプリケーションで直接 Reset を呼び出すことはできません。TDSTableProducer の派生オブジェクトは，編集中の内容を取り消すメソッドまたはユーザーインターフェースを実装できます。


THTTPDataLink.UpdateData
THTTPDataLink.UpdateData3117024

THTTPDataLink	参照

UpdateData メソッドは，データセットに対する変更登録要求を破棄します。

procedure UpdateData; override;

説明

TDSTableProducer は，データセットの HTML 表示を作成します。この表示は，データセットの編集に使えるコントロールではありません。UpdateData メソッドは，データソースを介して送られた，データセットに対する変更登録要求を破棄します。


読み出し／書き込み3117025

読み出し専用


スコープ3117026

protected


継承3117027

TObject

TPersistent

TDataLink


THTTPDataLink 例3117028

THTTPDataLink


TDataLink
TDataLink3118001

継承	プロパティ	メソッド	参照

TDataLink オブジェクトは，データを扱うオブジェクトが TDataSource と TDataSet の動作を対応させたり，データイベントに応答するために使用されるヘルパークラスです。

ユニット

db

説明

TDataLink オブジェクトまたはその派生クラスは，データセットとのリンクを示す DataSource プロパティを備えるデータベース対応オブジェクトやデータイベントに応答する必要があるデータベース対応オブジェクトで使います。

データベース対応オブジェクトのコンストラクタは TDataLink クラスのコンストラクタを呼び出して，関係するプロパティをすべて初期化しなければなりません。その後で，データベース対応オブジェクトは TDataLink クラスの DataSource プロパティを使って TDataSource オブジェクトにリンクできます。

データセットの単一の項目にリンクしているデータベース対応オブジェクトでは TFieldDataLink オブジェクトをかわりに使わなければなりません。


TDataLink プロパティ3118002

TDataLink	アルファベット順	凡例

TDataLink

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


TDataLink プロパティ3118003

TDataLink	オブジェクト順	凡例

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


TDataLink.Active
TDataLink.Active3118004

TDataLink	参照

Active プロパティは， TDataLink が管理するデータセットがアクティブかどうかを表します。

property Active: Boolean;

説明

Active プロパティは，TDataLink オブジェクトの使うデータセットがアクティブかどうかを取得します。Active プロパティが False のときは，データセットが閉じられていて，データセットはデータベースからのデータの読み出しおよびデータベースへのデータの書き込みができません。Active プロパティが True のときは，データセットからのデータの読み出しおよびデータセットへのデータの書き込みができます。


TDataLink.ActiveRecord
TDataLink.ActiveRecord3118005

TDataLink	参照

ActiveRecord プロパティは，レコードバッファの内部セットにある現在のレコードのインデックスを指定します。このバッファは TDataLink オブジェクトのオーナーのためにデータセットによって管理されています。

property ActiveRecord: Integer;

説明

ActiveRecord プロパティは，データセットによって管理される 1 つ以上のレコードのセットにある現在のレコードを読み出したり設定したりできます。データセットに管理されるレコードセットはデータセットから一度に見ることができるレコードの数に対応します。たとえば，TDataLink オブジェクトのオーナーがデータ処理グリッドである場合，データセットが管理するレコードセットはグリッドに表示される行の数と対応し，ActiveRecord プロパティは現在の行を示します。


TDataLink.BufferCount
TDataLink.BufferCount3118006

TDataLink	参照

BufferCount プロパティは，TDataLink オブジェクトのオーナーが使うデータセットによって管理されるレコードセットのサイズを指定します。

property BufferCount: Integer;

説明

BufferCount プロパティを設定すると，TDataLink オブジェクトのオーナーにサービスを提供するためにバッファリングするレコードの数をデータセットに通知できます。例えば，データベース対応グリッドでは，BufferCount プロパティをグリッドで見ることができる行の数に設定します。

BufferCount プロパティを読み取ると，TDataLink オブジェクトのオーナーが使うデータセットによってバッファリングされたすべてのレコードを反復処理することができます。たとえば，データベース対応オブジェクトが，各レコードを順番に調べるように ActiveRecord プロパティを移動させ，レコードセットを一巡することによって自身を描画することができます。


TDataLink.DataSet
TDataLink.DataSet3118007

TDataLink	参照

DataSet プロパティは，TDataLink オブジェクトがトラッキングしているデータベース内のデータを表す DataSet オブジェクトを示します。

property DataSet: TDataSet;

説明

DataSet プロパティは，TDataLink オブジェクトが管理を補助するデータセットを取得することができます。TDataLink オブジェクトは DataSet プロパティが受け取ったデータイベントに応答します。次に，TDataLink オブジェクトのオーナーであるオブジェクトにかわってデータセットを変更します。


TDataLink.DataSource
TDataLink.DataSource3118008

TDataLink	参照

DataSource プロパティは，TDataLink オブジェクトのオーナーがデータセットに接続するときに使う TDataSource オブジェクトを示します。

property DataSource: TDataSource;

説明

DataSource プロパティは，データセットに接続する TDataSource オブジェクトを調べたり指定したりできます。TDataLink オブジェクトは DataSource が受け取るデータイベントに応答します。

注意

TDataLinkTo プロパティは TDataLink またはその派生オブジェクトのオーナーであるデータベース対応オブジェクトの DataSource プロパティを実装するには，TDataLink から派生したメンバーの DataSource プロパティを取得または設定するメソッドを作成します。


TDataLink.DataSourceFixed
TDataLink.DataSourceFixed3118009

TDataLink	参照

DataSourceFixed プロパティは，DataSource プロパティが設定できるかどうかを示します。

property DataSourceFixed: Boolean;

説明

DataSourceFixed プロパティは，DataSource プロパティを変更できるかどうかを決めることができます。デフォルトでは，DataSourceFixed プロパティは False で DataSource プロパティは変更することができます。

非同期イベントが DataSouce プロパティを処理の終了前に変更する可能性がある場合，処理を実行する前に DataSourceFixed プロパティを True に設定すれば，処理中は DataSource プロパティを一定に保つことができます。データ処理が終了した後で，DataSourceFixed プロパティを False に戻すことができます。

DataSourceFixed プロパティを設定すると，TDataLink オブジェクトのオーナーであるデータベース対応オブジェクトの DataSource プロパティの設定値を固定できます。


TDataLink.Editing
TDataLink.Editing3118010

TDataLink	参照

Editing プロパティは，DataSource プロパティが編集モードであるかどうかを示します。

property Editing: Boolean;

説明

Editing プロパティは，DataSource プロパティがデータセットに新規レコードを挿入しているのか，または現在のレコードを変更しているのかを調べることができます。データセットを編集モードにして，Editing プロパティを True に切り替えるには，Edit メソッドを使います。


TDataLink.ReadOnly
TDataLink.ReadOnly3118011

TDataLink	参照

ReadOnly プロパティは，TDataLink オブジェクトのデータセットを変更できるかどうかを決めます。

property ReadOnly: Boolean;

説明

ReadOnly プロパティは，TDataLink オブジェクトのデータセットを変更できるかどうかを決めることができます。ReadOnly プロパティを True に設定すると，以後の Edit メソッドへの呼び出しはすべて失敗し，編集状態の DataSource プロパティは編集状態でなくなります。ReadOnly プロパティを False に設定すると，データセットのデータを変更できるようになります。


TDataLink.RecordCount
TDataLink.RecordCount3118012

TDataLink	参照

RecordCount プロパティは，データセットによって TDataLink オブジェクトのオーナーのために管理される内部レコードバッファ内のレコードの数を示します。

property RecordCount: Integer;

説明

RecordCount プロパティは，TDataLink オブジェクトのオーナーの使うデータセットが管理するバッファに含まれる実際のレコードの数を調べることができます。

通常，RecordCount プロパティの値は BufferCount プロパティと同じです。RecordCount はデータセットのレコードバッファに実際にあるレコード数を示し，データセットで管理できるレコード数は示しません。たとえば，データベース対応グリッドに 4 行があり，1 行だけにデータが表示される場合，BufferCount プロパティの値は 4 ですが，RecordCount プロパティの値は 1 です。


TDataLink メソッド3118013

TDataLink	アルファベット順	凡例

TDataLink

ActiveChanged

CheckBrowseMode

Create

DataSetChanged

DataSetScrolled

Destroy

Edit

EditingChanged

FocusControl

LayoutChanged

RecordChanged

UpdateData

UpdateRecord

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDataLink メソッド3118014

TDataLink	オブジェクト順	凡例

ActiveChanged

Assign

CheckBrowseMode

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DataSetChanged

DataSetScrolled

DefaultHandler

Destroy

Dispatch

Edit

EditingChanged

FieldAddress

FocusControl

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LayoutChanged

MethodAddress

MethodName

NewInstance

RecordChanged

SafeCallException

UpdateData

UpdateRecord


TDataLink.ActiveChanged
TDataLink.ActiveChanged3118015

TDataLink	参照

ActiveChanged メソッドは，Active プロパティの変更に応答します。

procedure ActiveChanged;

説明

TDataLink オブジェクトによって定義される ActiveChanged メソッドは，Active プロパティの変更に応答するメソッドが使うインターフェースを提供します。派生オブジェクトがこのような変更に応答しなくてもよい場合，継承メソッドにこれらを無視させることができます。


TDataLink.CheckBrowseMode
TDataLink.CheckBrowseMode3118016

TDataLink	参照

CheckBrowseMode メソッドは，データセットを変更するイベントが発生する直前にデータベース対応オブジェクトで処理が行えるようにします。

procedure CheckBrowseMode;

説明

TDataLink オブジェクトで定義される CheckBrowseMode メソッドは，データセットを変更するイベントが発生する直前に任意の状態情報を更新できるメソッドのためのインターフェースを提供します。派生オブジェクトがこのようなイベントに応答しなくてもよい場合，継承メソッドにイベントを無視させることができます。


TDataLink.Create
TDataLink.Create3118017

TDataLink	参照

Create メソッドは，TDataLink のインスタンスを作成します。

constructor Create;

説明

Create メソッドは TDataLink オブジェクトを使って DataSource プロパティを実装するデータベース対応オブジェクトのコンストラクタによって呼び出されます。

Create メソッドは継承したコンストラクタを呼び出した後で，BufferCount プロパティを 1 に初期化します。TDataLink オブジェクトを使って DataSource プロパティへのリンクを管理するデータベース対応オブジェクトは，継承したコンストラクタを呼び出した後で，BufferCount プロパティの値を，自身がバッファリングするレコードの数に変更しなければなりません。


TDataLink.DataSetChanged
TDataLink.DataSetChanged3118018

TDataLink	参照

DataSetChanged メソッドはデータセットにおける変更に応答します。

procedure DataSetChanged;

説明

DataSetChanged メソッドはデータセットの内容の変更に応答します。データセットの内容を変更するものであれば，データの編集，レコードの挿入または削除，あるいはキーの変更によってもこのメソッドが呼び出されます。また，データセットのスクロールやオブジェクト内のデータレイアウトの変更といった，データベース対応オブジェクト内のデータ表示に関係する変更によってもこのメソッドが呼び出されます。DataSetChanged メソッドは RecordChanged メソッドを呼び出します。派生クラスはこの手続きをオーバーライドしてデータセットへの変更をさらに調整することができます。


TDataLink.DataSetScrolled
TDataLink.DataSetScrolled3118019

TDataLink	参照

DataSetScrolled メソッドは，データベース対応オブジェクト内のデータセット表示のスクロールに応答します。

procedure DataSetScrolled(Distance: Integer);

説明

DataSetScrolled メソッドは Distance パラメータを無視して DataSetChanged メソッドを呼び出します。派生クラスはこの手続きをオーバーライドして，データセットがスクロールしたときにさらに調整ができます。


TDataLink.Destroy
TDataLink.Destroy3118020

TDataLink	参照

Destroy メソッドは，TDataLink のインスタンスを破棄します。

destructor Destroy;

説明

アプリケーションで直接 Destroy メソッドを呼び出すことはせず，Free メソッドを呼び出すようにしてください。Free メソッドは TDataLink オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは TDataLink オブジェクトへの参照をデータソースオブジェクトから削除してから継承デストラクタを呼び出します。

TDataLink オブジェクトはそのオーナーのデストラクタ内で破棄されなければいけません。オーナーは TDataLink のコンストラクタから Create メソッドを呼び出します。


TDataLink.Edit
TDataLink.Edit3118021

TDataLink	参照

Edit メソッドは，DataSource プロパティを編集状態に切り替えようと試みます。

function Edit: Boolean;

説明

Edit メソッドを呼び出すと，現在のレコードを変更可能するよう試みることができます。戻り値が True の場合は DataSource プロパティがすでに編集状態であるか，編集可能な状態に変更されたことを示します。戻り値が False の場合は DataSource プロパティを編集できる状態に変更できないことをしめします。ReadOnly プロパティが True の場合などは，Edit で編集状態にすることはできないので戻り値は False になります。


TDataLink.EditingChanged
TDataLink.EditingChanged3118022

TDataLink	参照

EditingChanged メソッドは，DataSource の編集状態の変更に応答します。

procedure EditingChanged;

説明

TDataLink オブジェクトによって定義される EditingChanged メソッドは，DataSource プロパティの編集状態の変更に応答するメソッドのためのインターフェースを提供します。EditingChanged メソッドは Editing プロパティの値が変化した直後に呼び出されます。派生オブジェクトがこのような変更に対応しなくともよい場合，継承メソッドに変更を無視させることができます。


TDataLink.FocusControl
TDataLink.FocusControl3118023

TDataLink	参照

FocusControl メソッドは，TDataLink オブジェクトと関連付けられたデータベース対応コンポーネントにフォーカスを強制的に移動するメソッドのためのインターフェースを提供します。

procedure FocusControl(Field: TFieldRef);

説明

TDataLink オブジェクトによって定義される FocusControl メソッドは，TDataLink オブジェクトと関連付けられたデータベース対応オブジェクトに入力フォーカスを強制的に移動できるメソッドのためのインターフェースを提供します。派生オブジェクトがこのような機能を必要としない場合，継承メソッドに要求を無視させることができます。


TDataLink.LayoutChanged
TDataLink.LayoutChanged3118024

TDataLink	参照

LayoutChanged メソッドは，データベース対応オブジェクトによるデータ表示の変更に応答します。

procedure LayoutChanged;

説明

LayoutChanged メソッドは DataSetChanged メソッドを呼び出します。LayoutChanged の目的は，データベース対応オブジェクトによるデータ表示が変更されたときに応答するメソッドのためのインターフェースを提供することです。このような変更には TCustomDBGrid の列の数または順序の変更などがあります。


TDataLink.RecordChanged
TDataLink.RecordChanged3118025

TDataLink	参照

RecordChanged メソッドは，データセットの現在のレコードまたは項目への変更に応答します。

procedure RecordChanged(Field: TField);

説明

TDataLink オブジェクトによって定義される RecordChanged メソッドは，現在のレコードの内容の変更に応答できるメソッドのためのインターフェースを提供します。RecordChanged メソッドは，変更がデータセットの現在のレコードに登録された後と，DataSetChanged メソッドから呼び出されます。

Field パラメータは現在のレコードでどの項目の値が変更されたかを示します。Field が nil の場合，現在のレコード内の複数の項目が変更されています。

派生オブジェクトがこのような変更に対応しなくともよい場合，継承メソッドにこれらの変更を無視させることができます。


TDataLink.UpdateData
TDataLink.UpdateData3118026

TDataLink	参照

UpdateData メソッドは，データセット内のレコードに編集内容を書き込むためのインターフェースを提供します。

procedure UpdateData;

説明

TDataLink オブジェクトによって定義される UpdateData メソッドは，レコードの登録で発生する RecordChanged メソッドの呼び出しを回避しながら，データセット内の現在のレコードに更新内容を書き込むメソッドのためのインターフェースを提供します。派生オブジェクトがデータセットに編集内容を書き込む必要のない場合，継承メソッドに何もさせる必要はありません。


TDataLink.UpdateRecord
TDataLink.UpdateRecord3118027

TDataLink	参照

UpdateRecord メソッドは，編集をデータセットに登録するための通知に応答します。

procedure UpdateRecord;

説明

UpdateRecord メソッドは，UpdateData メソッドの実行中に発生する可能性がある RecordChanged メソッド呼び出しを防いでから UpdateData メソッドを呼び出します。


読み出し／書き込み3118028

読み出し専用


スコープ3118029

protected


継承3118030

TObject

TPersistent


TDataLink 例3118031

TDataLink


TDataModule
TDataModule3119001

継承	プロパティ	メソッド	イベント	参照	例

TDataModule は，アプリケーション内の非ビジュアルコンポーネントを一元処理するための専用クラスです。

ユニット

forms

説明

アプリケーションで TDataModule オブジェクトを使うと，アプリケーション内の非ビジュアルコンポーネントを一元処理する場所が提供されます。非ビジュアルコンポーネントはデータアクセスコンポーネント（TSession，TSessionList，TDatabase，TTable，TQuery，TStoredProc，TBatchMove）が代表的ですが，それ以外の非ビジュアルコンポーネントである場合もあります（TTimer，TOpenDialog，TImageList，TOleContainer など）。

設計時には，TDataModule オブジェクトは，非ビジュアルコンポーネントを入れるビジュアルコンテナを提供します。開発者は，このコンテナでプロパティを設定したり，イベントハンドラを記述したりできます。設計時にデータモジュールを作成するには［ファイル(F)｜データモジュールの新規作成］を選択します。

また，データモジュールのユニットファイルにアプリケーション全体に適用されるものをすべて入れておくようにしてもよいでしょう。

データモジュールをアプリケーション内の他のユニットでも利用できるようにするには，そのユニットを選択してから，［ファイル(F)｜ユニットを使う(U)］を選択してそのユニットの uses 節にデータモジュールを追加します。


TDataModule プロパティ3119002

TDataModule	アルファベット順	凡例

TDataModule

DesignOffset

DesignSize

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDataModule プロパティ3119003

TDataModule	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

DesignOffset

DesignSize

Name

Owner

Tag

VCLComObject


TDataModule.DesignOffset
TDataModule.DesignOffset3119004

TDataModule	参照

DesignOffset プロパティは，設計時のデータモジュールのデザインオフセットを指定します。

property DesignOffset: TPoint;

説明

設計時のデータモジュールのデザインオフセットを指定します。アプリケーションがこの値を設定する必要はありません。


TDataModule.DesignSize
TDataModule.DesignSize3119005

TDataModule	参照

DesignSize プロパティは，設計時のデータモジュールのデザインサイズを指定します。

property DesignSize: TPoint;

説明

設計時のデータモジュールのデザインサイズを指定します。アプリケーションがこの値を設定する必要はありません。


TDataModule イベント3119006

TDataModule	アルファベット順	凡例

TDataModule

OnCreate

OnDestroy


TDataModule イベント3119007

TDataModule	オブジェクト順	凡例

OnCreate

OnDestroy


TDataModule.OnCreate
TDataModule.OnCreate3119008

TDataModule	参照

OnCreate イベントは，アプリケーションがデータモジュールをインスタンス化したときに発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnCreate: TNotifyEvent;

説明

アプリケーションがデータモジュールをインスタンス化したときに一定の処理が行われるようにするために OnCreate イベントハンドラを記述します。たとえば，データモジュールにデータベースおよびデータセットコンポーネントがある場合なら，アプリケーションがただちにデータベース接続を確立するようにします。データモジュールにタイマーがある場合なら，アプリケーションがタイマーを初期化するようにします。


TDataModule.OnDestroy
TDataModule.OnDestroy3119009

TDataModule	参照

OnDestroy イベントは，データモジュールを破棄しようとしたときに発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnDestroy: TNotifyEvent;

説明

アプリケーションがデータモジュールを解放したときに一定の処理が行われるようにするために ，OnDestroy イベントハンドラを記述します。たとえば，データモジュールのユニットコードが，文字列リストなどのオブジェクトのいずれかをインスタンス化する場合には，それらのオブジェクトを解放するのに OnDestroy イベントハンドラを使うことができます。


TDataModule メソッド3119010

TDataModule	アルファベット順

TDataModule

Create

CreateNew

Destroy

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDataModule メソッド3119011

TDataModule	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateNew

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TDataModule.Create
TDataModule.Create3119012

TDataModule	参照

Create メソッドは，データモジュールのインスタンスを作成します。

constructor Create(AOwner: TComponent);

説明

Create メソッドを呼び出すと，設計時にデータモジュールを作成しなかった場合に実行時にデータモジュールをインスタンス化できます。Create メソッドは CreateNew メソッドを呼び出します。エラーが発生した場合は例外を生成します。エラーが発生しなければ，Create メソッドは，データモジュールに割り当てられている OnCreate イベントハンドラがあればそれを呼び出します。


TDataModule.CreateNew
TDataModule.CreateNew3119013

TDataModule	参照

CreateNew メソッドは，データモジュールのインスタンスを作成します。

constructor CreateNew(AOwner: TComponent);

説明

直接 CreateNew メソッドを呼び出さずに，Create メソッドを呼び出してください。CreateNew は継承された Create コンストラクタを呼び出してから，TScreen.AddDataModule メソッドを呼び出します。


TDataModule.Destroy
TDataModule.Destroy3119014

TDataModule	参照

Destroy メソッドは，データモジュールのインスタンスを破棄します。

destructor Destroy;

説明

直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは，問い合わせが解放されていないことを確認してから Destroy を呼び出します。Destroy はすべてのフィックスアップ参照を削除し，定義されている OnDestroy イベントハンドラがあればそれを呼び出し，TScreen.RemoveDataModule を呼び出してから，継承された Destroy デストラクタを呼び出します。


スコープ3119015

published

読み出し／書き込み

読み出し専用


スコープ3119016

published


継承3119017

TObject

TPersistent

TComponent


TDataModule 例3119018

TDataModule


TDataSet
TDataSet3120001

継承	プロパティ	メソッド	イベント	参照

TDataSet は，データベースの行および列のデータを表すすべてのデータセットコンポーネントの仮想基本クラスです。

ユニット

db

説明

TDataSet は，データベースエンジンから独立した，データの処理用のプロパティ，イベント，メソッドのセットをカプセル化する仮想基本クラスです。TDataSet のプロパティ，イベント，メソッドの多くは抽象または仮想です。

抽象宣言とは，実体を記述しないで宣言だけをするということです。これは TDataSet レベルでそれらを使用またはアクセスすることができないということを意味します。かわりに開発者は，これらの抽象メソッドを宣言および実装する TDataSet の派生コンポーネントを使用または派生させる必要があります。仮想メソッドは TDataSet で宣言および実装されますが，多くの場合，それらのメソッドは，TClientDataSet，TBDEDataSet，TDBDataSet，TQuery，TStoredProc，TTable などの下位コンポーネントで再実装されるスタブであるにすぎません。

たとえば，分散データセットを使用する単層および多層データベースアプリケーションでは TDataSet を直接継承する TClientDataSet を使ってデータにアクセスします。独自の分散データセットオブジェクトを開発する場合は，さらに TClientDataSet からそれらのオブジェクトを派生させる必要があります。

同様に，従来の Delphi データベースアプリケーションでは，TQuery，TStoredProc，TTable オブジェクトを使って，ボーランドデータベースエンジン（BDE）を通じてデータにアクセスします。クライアントアプリケーションで直接 BDE を使うカスタムデータセットコンポーネントを作成する場合は，それらのコンポーネントを TBDEDataSet，TDBDataSet，TQuery，TStoredProc，TTable から派生させる必要があります。


TDataSet プロパティ3120002

TDataSet	アルファベット順	凡例

TDataSet

Active

AutoCalcFields

BOF

Bookmark

CanModify

DataSource

DefaultFields

Designer

EOF

FieldCount

FieldDefs

Fields

FieldValues

Filter

Filtered

FilterOptions

Found

Modified

Name

RecNo

RecordCount

RecordSize

State

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDataSet プロパティ3120003

TDataSet	オブジェクト順	凡例

Active

AutoCalcFields

BOF

Bookmark

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DataSource

DefaultFields

Designer

DesignInfo

EOF

FieldCount

FieldDefs

Fields

FieldValues

Filter

Filtered

FilterOptions

Found

Modified

Name

Owner

RecNo

RecordCount

RecordSize

State

Tag

VCLComObject


TDataSet.Active
TDataSet.Active3120004

TDataSet	参照

Active プロパティは，データセットが開いているかどうかを示します。

property Active: Boolean;

説明

Active プロパティは，データセットとデータベース内のデータとの接続を判定したり設定したりできます。Active が False なら，データセットは閉じられており，データセットはデータベースからデータを読み出したり，データベースにデータを書き込んだりすることはできません。Active が True のときは，データベースからデータを読み出したり，データベースにデータを書き込んだりすることができます。

Active プロパティを True に設定すると，以下の処理を行うことができます。

・	BeforeOpen イベントハンドラがデータセット用に定義されている場合，BeforeOpen イベントハンドラを呼び出す

・	データセットの状態を dsBrowse に設定する

・	データセットをオープンする

・	AfterOpen イベントハンドラがデータセット用に定義されている場合，AfterOpen イベントハンドラを呼び出す

データセットが開いているときにエラーが発生した場合，データセットの状態は dsInactive に設定され，データセットは閉じます。

アプリケーションは，データベースのステータスに影響を及ぼす他のプロパティや，アプリケーションでデータを表示するコントロールを変更する前に，Active を False に設定する必要があります。

注意

Open メソッドを呼び出すと Active は True に設定され，Close メソッドを呼び出すと Active は False に設定されます。


TDataSet.AutoCalcFields
TDataSet.AutoCalcFields3120005

TDataSet	参照

AutoCalcFields プロパティは，OnCalcFields イベントの発生を制御します。

property AutoCalcFields: Boolean;

説明

AutoCalcFields プロパティを設定すると，データセット処理中に計算項目を更新するために，いつ OnCalcFields イベントが発生するかを制御できます。計算項目は値をデータセット内の 1 つまたは複数の項目の値から派生させ，場合によってはその値に追加処理を行う項目です。AutoCalcFields が True ならば（デフォルト），OnCalcFields イベントは次の場合に発生します。

・	データセットが開いた

・	データセットが dsEdit 状態になった

・	フォーカスが 1 つの可視コントロールから別の可視コントロールへ，またはデータベース対応グリッドコントロールの 1 つの列から別の列へ移り，レコードに変更が加えられた

・	データベースからレコードを取り出した

OnCalcFields が呼び出される回数を少なくするには，AutoCalcFields を False に設定します。AutoCalcFields が False のときは，OnCalcFields はレコード内の個々の項目に変更が加えられても呼び出されません。アプリケーションがユーザーによるデータの変更を許可している場合は，OnCalcFields は頻繁に発生します。そのような場合には，AutoCalcFields を False に設定すれば， OnCalcFields イベントが呼び出される回数を少なくすることができます。


TDataSet.BOF
TDataSet.BOF3120006

TDataSet	参照

BOF プロパティは，カーソルがデータセットの最初のレコードにあるかどうかを示します。

property BOF: Boolean;

説明

BOF（ファイルの先頭） プロパティを参照すると，カーソルがデータセットの最初のレコードにあるかどうかを判別できます。BOF が True ならば，カーソルはデータセットの最初の行にあります。BOF が True になるのは，アプリケーションが以下の処理を行ったときです。

・	データセットを開いた直後

・	データセットの First メソッドを呼び出した

・	データセットの Prior メソッドを呼び出したが，失敗した（カーソルがすでにデータセットの最初の行にあったため）

・	空の範囲またはデータセットに対して SetRange を呼び出した

その他の場合 BOF はすべて False です。上記の条件のいずれかに適合し，アプリケーションが直接このプロパティを参照した場合以外は，アプリケーションは BOF を False とみなす必要があります。


TDataSet.Bookmark
TDataSet.Bookmark3120007

TDataSet	参照

Bookmark プロパティは，データセット内の現在のブックマークを示します。

type

TBookmarkStr: string;

property Bookmark: TBookmarkStr;

説明

Bookmark はデータセット内の現在のブックマークを取得または設定します。ブックマークはデータセット内の位置をマークして，アプリケーションがすばやくその位置に戻れるようにする方法です。

アプリケーションは，Bookmark を読み出してカレントレコードに関連付けられているブックマークを取り出したり，保存されているブックマーク値をこのプロパティに代入してデータセット内のカーソル位置を変更したりすることができます。


TDataSet.CanModify
TDataSet.CanModify3120008

TDataSet	参照

CanModify プロパティは，データセットの基になるデータベースがデータの書き込みアクセスを許可するかどうかを示します。

property CanModify: Boolean;

説明

TDataSet オブジェクトのインスタンスでは，このプロパティは常に True です。TQuery，TStoredProc，TTable などの下位オブジェクトは，このプロパティを取得するためのメソッドを再宣言して再実装することで，有意義な値を返すようにしています。


TDataSet.DataSource
TDataSet.DataSource3120009

TDataSet	参照

DataSource プロパティは，データセットが参照するデータソースを示します。

property DataSource: TDataSource;

説明

DataSource は，データセットが自身のデータソースを指定できない場合に nil を返すプロパティです。

データソースの指定をサポートしている下位データセットオブジェクトは，DataSource プロパティを取得または設定するためのメソッドを再宣言し，実装します。


TDataSet.DefaultFields
TDataSet.DefaultFields3120010

TDataSet	参照

DefaultFields プロパティは，データセットが開かれたときにデータセットの基になる項目コンポーネントが動的に生成されるかどうかを示します。

property DefaultFields Boolean;

説明

DefaultFields プロパティを読み出すと，データセットが動的に生成された項目コンポーネントを使用しているのか，静的な項目コンポーネントを使用しているのかを判定できます。DefaultFields が True ならば，データセットは動的に割り当てられた項目コンポーネントを使用しています。DefaultFields が False ならば，データセットは静的な項目コンポーネントを使用しています。

設計時に項目エディタを使って静的な項目コンポーネントがデータセットに割り当てられる場合を除いて，データセットが開かれるときに，データセットは常に，基になるデータベーステーブルの構造に基づいて動的な項目コンポーネントを生成します。


TDataSet.Designer
TDataSet.Designer3120011

TDataSet	参照

Designer プロパティは，データセットに設定されているデータセットデザイナを返します。

property Designer: TDataSetDesigner;

説明

TDataSet オブジェクトでは，Designer プロパティは，データセットデザイナを指定しないデータセットに nil を返すプロパティです。項目エディタなどのデータセットデザイナは，開発者が設計時にデータセットに属する項目を指定できるようにします。

データセットデザイナの指定をサポートする下位データセットオブジェクトは，Designer プロパティを取得および設定するためのメソッドを再宣言し，実装します。


TDataSet.EOF
TDataSet.EOF3120012

TDataSet	参照

EOF プロパティは，カーソルがデータセットの最後のレコードにあるかどうかを示します。

property EOF: Boolean;

説明

EOF（ファイルの最後）プロパティを参照すると，カーソルがデータセットの最後のレコードにあるかどうかを判別できます。EOF が True ならば，カーソルは確実にデータセットの最後の行にあります。EOF が True になるのは，アプリケーションが以下の処理を行ったときです。

・	空のデータセットを開いた

・	データセットの Last メソッドを呼び出した

・	データセットの Next メソッドを呼び出したが，失敗した（カーソルがすでにデータセットの最後の行にあったため）

・	空の範囲またはデータセットに対して SetRange を呼び出した

その他の場合 EOF はすべて False です。上記の条件のいずれかに適合し，アプリケーションが直接このプロパティを参照した場合以外は，アプリケーションは EOF を False とみなす必要があります。

参考

EOF と BOF がいずれも True ならば，データセットまたは範囲は空です。


TDataSet.FieldCount
TDataSet.FieldCount3120013

TDataSet	参照

FieldCount プロパティは，データセットに関連付けられている項目コンポーネントの数を示します。

property FieldCount: Integer;

説明

FieldCount プロパティを調べると，データセットに関連付けられている項目の数を判定できます。動的に作成された項目に関連付けられているデータセットの場合は，FieldCount の値は，データセットを開くたびに異なることがあります。静的な項目に関連付けられているデータセットの場合は，FieldCount の値はいつデータセットを開いても変わりません。


TDataSet.FieldDefs
TDataSet.FieldDefs3120014

TDataSet	参照

FieldDefs プロパティは，データセットに対する項目定義のリストを指します。

property FieldDefs: TFieldDefs;

説明

FieldDefs プロパティは，データセットに対する項目定義の内部リストを指します。アプリケーションが FieldDefs を調べてデータセットに対する項目定義を探すことができますが，CreateTable を使って新しいテーブルを作成する場合を除いてこれらの定義を変更してはなりません。それ以外の場合は，FieldDefs は，主に TDataSet およびその下位コンポーネントの他のプロパティ，イベント，メソッドが内部的に使用するためのものです。

データセット内の項目および項目値にアクセスするには，Fields および FieldValues プロパティと FieldsByName メソッドを使用します。


TDataSet.Fields
TDataSet.Fields3120015

TDataSet	参照

Fields プロパティは，データセットのすべての項目コンポーネントのインデックス付き配列を提供します。

property Fields[Index: Integer]: TField ;

説明

Fields プロパティは，インデックス番号によって項目コンポーネントにアクセスできます。Fields は 0 をベースとする配列です。項目が実行時に動的に生成されたのであれば，Fields 内での項目コンポーネントの順序は，データセットの基になるテーブル内の列の順序と同じです。データセットが静的項目を使用している場合は，項目コンポーネントの順序は設計時に項目エディタで項目を指定した順序と同じです。

Fields プロパティを使った項目へのアクセスは，次のような場合に便利です。

・	データセット内の一部またはすべての項目に対して処理を繰り返す

・	実行時に，そのテーブルの内部データ構造がわからない

アプリケーションで個々の項目のデータ型がわかっている場合は，Fields プロパティを使って個々の項目値を読み書きすることができます。たとえば，次の文では項目値を編集ボックスの Text プロパティに割り当てます。

Edit1.Text := CustTable[6].AsString;

次の文は，編集ボックスの値を項目に割り当てます。

CustTable.Edit;

CustTable.Fields[6].AsString := Edit1.Text;

CustTable.Post;

注意

項目値の取得および割り当てには，FieldByName メソッドを使うことをお勧めします。


TDataSet.FieldValues
TDataSet.FieldValues3120016

TDataSet	参照

FieldValues プロパティは，データセットのカレントレコードにおけるすべての項目値へのアクセスを提供します。

property FieldValues[const FieldName: string]: Variant;

説明

FieldValues プロパティは，データセット内の項目の値を読み書きできます。FieldValues は TDataSet のデフォルトプロパティです。

FieldName は取得および設置する先の項目の名前で，引用符で囲む必要があります。

FieldValues は Variant を受け入れたり返したりするので，どの型の項目でも処理および変換できます。FieldValues は TDataSet のデフォルトプロパティなので，このプロパティを参照するとき，プロパティ名を省略してもかまいません。たとえば，次の 2 つの文は構文上等価で，編集ボックスの値を整数項目に書き込みます。

Customers.FieldValues['CustNo'] := Edit1.Text;

Customers['CustNo'] := Edit1.Text;

次の文は文字列値を項目から編集ボックスに読み出します。

Edit1.Text := Customers['Company'];

注意

FieldValues は常に Variants を使うので，特に大量のデータを処理するアプリケーションでは，項目のネイティブな形式（つまり，項目の AsXXX プロパティ）を使った場合に比べて，データアクセスに時間がかかることがあります。


TDataSet.Filter
TDataSet.Filter3120017

TDataSet	参照

Filter プロパティは，データセットに対する現在のフィルタの文字列を指定します。

property Filter: string;

説明

Filter プロパティは，データセットフィルタを指定できます。データセットに対してフィルタ処理を適用すると，フィルタの条件に適合するレコードのみがアプリケーションで利用できるようになります。Filter には，フィルタ条件を記す文字列が入ります。たとえば，次のフィルタ条件では，State 項目が「CA」か「MA」であるレコードのみが表示されるようになります。

'State = ''CA'' or State = ''MA'''

項目名にスペースが含まれるときは，次のように項目名を大カッコで囲む必要があります。

'[Home State] = ''CA'' or [Home State] = ''MA'''

注意

アプリケーションは，実行時に，Filter を設定してデータセットに対するフィルタ条件を変更する（たとえば，ユーザーの入力に応答して）ことができます。


TDataSet.Filtered
TDataSet.Filtered3120018

TDataSet	参照

Filtered プロパティは，データセットに対してフィルタ処理が有効かどうかを示します。

property Filtered: Boolean;

説明

Filtered プロパティを調べると，データセットフィルタ処理が有効かどうかを判定できます。Filtered が True ならば，フィルタがアクティブになります。それ以外の場合 Filtered は False です。Filter プロパティまたは OnFilterRecord イベントハンドラで指定したフィルタ条件を適用するには，Filtered を True に設定します。

注意

フィルタ処理がアクティブなときにユーザーがレコードを編集すると，そのレコードがフィルタの検査条件に適合しなくなることがあります。次にデータセットからそのレコードを読み出そうとしたときに，そのフィルタが有効なままなら，そのレコードは表示されません。その場合は，フィルタ条件に適合した次のレコードがカレントレコードになります。


TDataSet.FilterOptions
TDataSet.FilterOptions3120019

TDataSet	参照

FilterOptions プロパティは，フィルタ処理で，大文字小文字の違いを区別するかどうか，および，レコードをフィルタ処理する際に部分的な比較を行えるようにするかどうかを指定します。

type

TFilterOption = (foCaseInsensitive, foNoPartialCompare);

TFilterOptions = set of TFilterOption;

property FilterOptions: TFilterOptions

説明

FilterOptions プロパティを設定すると，文字列または文字項目をフィルタ処理する際，大文字小文字の違いを区別するかどうか，および，フィルタ条件の照合で部分的な比較を行えるようにするかどうかを指定できます。

デフォルトでは，FilterOptions は空のセットに設定されています。文字列項目に基づくフィルタの場合は，FilterOptions に foCaseInsensitive を設定すれば，大文字小文字に関係なく指定した文字列のすべてのバリエーションを得ることができます。

フィルタの文字列の最後にアスタリスク（*）を付けると，文字列を部分的に比較することができます。文字列の部分的な比較を無効にし，文字列の比較でアスタリスクをリテラル文字として扱うには，FilterOptions に foNoPartialCompare を含めます。


TDataSet.Found
TDataSet.Found3120020

TDataSet	参照

Found プロパティは，別のレコードへの移動が成功したかどうかを示します。

property Found: Boolean;

説明

Found プロパティのステータスを調べると，FindFirst，FindLast，FindNext，FindPrior の呼び出しが成功したかどうかを判定できます。Found が True ならば，成功したことを意味します。False ならば，別のレコードへの移動は失敗です。


TDataSet.Modified
TDataSet.Modified3120021

TDataSet	参照

Modified プロパティは，カレントレコードが変更されているかどうかを示します。

property Modified: Boolean;

説明

Modified プロパティを調べると，カレントレコードが変更されているかどうかを判定できます。Modified が True ならば，カレントレコードは変更されています。False ならば，カレントレコードは変更されていません。

注意

一般に，アプリケーションが Modified のステータスを調べる必要はありません。通常は，レコードを変更する TDataSet およびその下位コンポーネントのプロパティ，イベント，メソッドが自動的にこのステータスを確認して，その値に応じて適切な処理を実行します。


TDataSet.RecNo
TDataSet.RecNo3120023

TDataSet	参照

RecNo プロパティは，データセット内のカレントレコードを示すプロパティです。

property RecNo: Integer;

説明

この関数はすべての場合に -1 を返します。通常，アプリケーションは TDataSet レベルで RecNo にアクセスしません。かわりに，TTable などの下位オブジェクトで再宣言され，実装された RecNo プロパティがアクセスされます。RecNo は，RecNo を再実装していない派生データセットオブジェクトにフォールバックプロパティを提供します。


TDataSet.RecordCount
TDataSet.RecordCount3120024

TDataSet	参照

RecordCount プロパティは，データセットに関連付けられているレコードの総数を示します。

property RecordCount: Integer;

説明

TDataSet オブジェクトでは，この関数はすべての場合に -1 を返します。通常，アプリケーションは TDataSet レベルで RecordCount にアクセスしません。かわりに，TTable などの下位オブジェクトで再宣言され，実装された RecordCount プロパティがアクセスされます。RecordCount は，RecordCount を再実装していない派生データセットオブジェクトにフォールバックプロパティを提供します。


TDataSet.RecordSize
TDataSet.RecordSize3120025

TDataSet	参照

RecordSize プロパティは，データセット内のレコードのサイズを示します。

property RecordSize: Word;

説明

RecordSize プロパティは，TDataSet から派生したオブジェクトで再宣言されて実装される抽象プロパティです。TDataSet では，RecordSize は無意味です。


TDataSet.State
TDataSet.State3120026

TDataSet	参照

State プロパティは，データセットの現在の操作モードを示します。

type

TDataSetState = (dsInactive, dsBrowse, dsEdit, dsInsert, dsSetKey, dsCalcFields,

dsFilter, dsNewValue, dsOldValue, dsCurValue);

property State: TDataSetState;

説明

State プロパティを調べると，データセットの現在の操作モードを判定できます。State はデータセット内のデータについてどんな操作（たとえば，既存レコードの編集や新しいレコードの挿入など）を行うことができるかを表します。アプリケーションがデータを処理するのにつれて，データセットの状態は常に変化します。以下に，Stateのすべての値とその意味を示します。

値	意味

dsInactive	データセットは閉じられているため，データは利用できない

dsBrowse	データセットは表示できるが，変更はできない。開いているデータセットのデフォルトの状態

dsEdit	カレントレコードを変更できる

dsInsert	新しいレコードを挿入できる

dsSetKey	TTable 専用。レコードの検索が有効であるか，または SetRange 操作を実行中。限られた範囲のデータを表示できるが，データの編集または挿入はできない

dsCalcFields	OnCalcFields イベントが進行中。計算項目以外の項目は編集できず，新しいレコードを挿入できない

dsFilter	OnFilterRecord イベントが進行中。限られた範囲のデータを表示できる。データの編集または挿入はできない

dsNewValue	TField.NewValue プロパティがアクセス中であることを示すために内部的に使われる一時的な状態

dsOldValue	TField.OldValue プロパティがアクセス中であることを示すために内部的に使われる一時的な状態

dsCurValue	TField.CurValue プロパティがアクセス中であることを示すために内部的に使われる一時的な状態

データセットを開くと，State は dsInactive から dsBrowse へと変更されます。アプリケーションは Edit を呼び出してデータセットの状態を dsEdit に変えたり，Insert を呼び出してデータセットの状態を dsInsert に変えたりすることができます。データセットが TTable オブジェクトの場合は，アプリケーションは SetKey または SetRange を呼び出して，データセットの状態を dsSetKey に変えることができます。

編集，挿入，削除，変更を登録したり取り消したりすると，State は現在の状態から dsBrowse へと変わります。データセットを閉じると，現在の状態から dsInactive へと変わります。

dsCalcFields，dsFilter，dsNewValue，dsOldValue，dsCurValue など，一部の状態は，アプリケーションから直接見たり，設定したりすることはできません。これらの状態は，OnCalcField および OnFilterRecord イベントが発生したとき，またはアプリケーションが TField.XXXValue プロパティにアクセスしたときに自動的に設定されます。


TDataSet イベント3120027

TDataSet	アルファベット順

TDataSet

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TDataSet イベント3120028

TDataSet	オブジェクト順

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TDataSet.AfterCancel
TDataSet.AfterCancel3120029

TDataSet	参照

AfterCancel イベントは，アプリケーションがカレントレコードの変更を取り消す要求を完了した後に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property AfterCancel: TDataSetNotifyEventl;

説明

AfterCancel イベントハンドラを記述すると，アプリケーションがカレントレコードの変更を取り消した後に特定の処理が行われるようにすることができます。Cancel メソッドは，カーソル位置を更新し，必要であればカレントレコードのロックを解除し，データセットの状態を dsBrowse に設定した後で，AfterCancel を呼び出します。Cancel イベントの後，ユーザーに制御を戻す前に，アプリケーションでそのほかの処理が必要な場合は，その処理のコードを AfterCancel イベントに記述します。


TDataSet.AfterClose
TDataSet.AfterClose3120030

TDataSet	参照

AfterClose イベントは，アプリケーションがデータセットを閉じた後に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property AfterClose: TDataSetNotifyEventl;

説明

AfterClose イベントハンドラを記述すると，アプリケーションがデータセットを閉じた直後に特定の処理が行われるようにすることができます。たとえば，セキュリティの手段として，データセットが閉じられたら，データベースコンポーネントの Params プロパティの PASSWORD エントリをアプリケーションが消去するようにすることができます。

AfterClose は，データセットが閉じられて，データセットの状態が dsInactive に設定された後で呼び出されます。


TDataSet.AfterDelete
TDataSet.AfterDelete3120031

TDataSet	参照

AfterDelete イベントは，アプリケーションがレコードを削除した後に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property AfterDelete: TDataSetNotifyEventl;

説明

AfterDelete イベントハンドラを記述すると，アプリケーションがデータセット内のカレントレコードを削除した直後に特定の処理が行われるようにすることができます。AfterDelete は，Delete メソッドがそのレコードを削除し，データセットの状態を dsBrowse に設定し，カーソルを削除したレコードの次のレコードに置いた後に呼び出されます。


TDataSet.AfterEdit
TDataSet.AfterEdit3120032

TDataSet	参照

AfterEdit イベントは，アプリケーションがレコードを編集した後に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property AfterEdit: TDataSetNotifyEventl;

説明

AfterEdit イベントハンドラを記述すると，アプリケーションがレコードを編集した直後に特定の処理が行われるようにすることができます。AfterEdit は，Edit メソッドがレコードの編集を有効にし，計算項目を再計算し，レコードの変更を処理するイベントハンドラを呼び出した後に呼び出されます。


TDataSet.AfterInsert
TDataSet.AfterInsert3120033

TDataSet	参照

AfterInsert イベントは，アプリケーションが新しいレコードを挿入した後に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property AfterInsert: TDataSetNotifyEventl;

説明

AfterInsert イベントハンドラを記述すると，アプリケーションがレコードを挿入した直後に特定の処理が行われるようにすることができます。AfterInsert は，Append メソッドまたは Insert メソッドによって新しいレコードを挿入または追加した後に呼び出されます。


TDataSet.AfterOpen
TDataSet.AfterOpen3120034

TDataSet	参照

AfterOpen イベントは，アプリケーションがデータセットを開いた後，データセットへのアクセスが起こる前に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property AfterOpen: TDataSetNotifyEventl;

説明

AfterOpen イベントハンドラを記述すると，アプリケーションがデータセットを開いた直後に特定の処理が行われるようにすることができます。AfterOpen は，データセットがオープンされ，データセットの状態が dsBrowse に設定された後で呼び出されます。たとえば，AfterOpen イベントハンドラを使えば，システムのレジストリを調べて，前回アプリケーションを実行したときにアクセスされた最後のデータセット内のレコードを判定して，カーソルをそのレコードに置いたりすることができます。


TDataSet.AfterPost
TDataSet.AfterPost3120035

TDataSet	参照

AfterPost イベントは，アプリケーションがカレントレコードをデータベースまたはキャッシュに書き込んだ後でデータセットの状態がブラウズ状態に戻される前に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property AfterPost: TDataSetNotifyEventl;

説明

AfterPost イベントハンドラを記述すると，アプリケーションがカレントレコードの変更内容を登録した直後に特定の処理が行われるようにすることができます。AfterPost はレコードに対して変更，削除，挿入が行われた後で Post メソッドによって呼び出されます。


TDataSet.AfterScroll
TDataSet.AfterScroll3120036

TDataSet	参照

AfterScroll イベントは，アプリケーションがあるレコードから別のレコードへスクロールした後に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property AfterScroll: TDataSetNotifyEventl;

説明

AfterScroll イベントハンドラを記述すると，First，Last，MoveBy，Next，Prior，FindKey，Delete，GotoBookmark，Insert，Append，FindFirst，FindNext，FindLast，FindPrior，Locate メソッドの呼び出しに対する結果としてアプリケーションが別のレコードへスクロールした直後に特定の処理が行われるようにすることができます。AfterScroll は，これらのメソッドおよびデータセット内のレコードを切り替える他のメソッドによって他のすべてのイベントがトリガされた後で呼び出されます。


TDataSet.BeforeCancel
TDataSet.BeforeCancel3120037

TDataSet	参照

BeforeCancel イベントは，カレントレコードの変更を取り消す要求をアプリケーションが実行する前に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property BeforeCancel: TDataSetNotifyEventl;

説明

BeforeCancel イベントハンドラを記述すると，変更を取り消す要求をアプリケーションが実行する前に特定の処理が行われるようにすることができます。BeforeCancel は，Cancel メソッドが Edit，Insert，Delete などのデータセット操作を取り消す前に Cancel メソッドによって呼び出されます。

アプリケーションは，BeforeCancel イベントを使ってユーザーによる変更内容をアンドゥバッファに記録することができます。


TDataSet.BeforeClose
TDataSet.BeforeClose3120038

TDataSet	参照

BeforeClose イベントは，データセットを閉じる要求をアプリケーションが実行する前に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property BeforeClose: TDataSetNotifyEventl;

説明

BeforeClose イベントハンドラを記述すると，アプリケーションがデータセットを閉じる前に特定の処理が行われるようにすることができます。Close メソッドを呼び出すか，または Active プロパティを False に設定すると，BeforeClose イベントハンドラが呼び出されます。


TDataSet.BeforeDelete
TDataSet.BeforeDelete3120039

TDataSet	参照

BeforeDelete イベントは，アプリケーションがカレントレコードを削除しようとする前に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property BeforeDelete: TDataSetNotifyEventl;

説明

BeforeDelete イベントハンドラを記述すると，アプリケーションがカレントレコードを削除する前に，特定の処理が行われるようにすることができます。BeforeDelete イベントは，実際にレコードが削除される前に Delete メソッドによって呼び出されます。

このイベントを利用すれば，たとえば，アプリケーションで，レコードの削除の確認を求めるダイアログボックスが表示されるようにすることができます。レコードの削除が拒否された場合は，アプリケーションはAbort 手続きを呼び出してレコードの削除を中止することができます。


TDataSet.BeforeEdit
TDataSet.BeforeEdit3120040

TDataSet	参照

BeforeEdit イベントは，アプリケーションがカレントレコードに対して編集モードに入る前に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property BeforeEdit: TDataSetNotifyEventl;

説明

BeforeEdit イベントハンドラを記述すると，アプリケーションがカレントレコードの編集を有効にする前に特定の処理が行われるようにすることができます。たとえば，アプリケーションはデータベース編集の記録を付けておき，そのログを使って，編集要求，時刻，ユーザーを BeforeEdit イベントに記録してからでないと編集状態に入れないようにすることができます。


TDataSet.BeforeInsert
TDataSet.BeforeInsert3120041

TDataSet	参照

BeforeInsert イベントは，アプリケーションが挿入モードに入る前に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property BeforeInsert: TDataSetNotifyEventl;

説明

BeforeInsert イベントハンドラを記述すると，アプリケーションが新しいレコードを挿入または追加する前に特定の処理が行われるようにすることができます。BeforeInsert は，データセットの状態を dsInsert に設定する前に Insert または Append によって呼び出されます。


TDataSet.BeforeOpen
TDataSet.BeforeOpen3120042

TDataSet	参照

BeforeOpen イベントは，アプリケーションがデータセットを開く要求を実行する前に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property BeforeOpen: TDataSetNotifyEventl;

説明

BeforeOpen イベントハンドラを記述すると，アプリケーションが表示または編集のためにデータセットを開く前に特定の処理が行われるようにすることができます。BeforeOpen は，アプリケーションがデータセットの Active プロパティを True に設定したとき，またはアプリケーションが Open メソッドを呼び出したときに発生します。


TDataSet.BeforePost
TDataSet.BeforePost3120043

TDataSet	参照

BeforePost イベントは，アプリケーションがカレントレコードの変更をデータベースまたはキャッシュに登録する前に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property BeforePost: TDataSetNotifyEventl;

説明

BeforePost イベントハンドラを記述すると，アプリケーションがデータセットの変更をデータベースに登録する前に特定の処理が行われるようにすることができます。BeforePost は，アプリケーションが Post メソッドを呼び出したときに発生します。Post は入力必須項目がすべて存在していることを確認し，BeforePost を呼び出してから，そのレコードを実際に登録します。

アプリケーションは BeforePost を使って，データ変更をデータベースへ登録する前にデータ検証を実行することができます。データ検証の結果，変更したデータが無効だった場合は，Abort 手続きを呼び出してその Post 操作を取り消すことができます。


TDataSet.BeforeScroll
TDataSet.BeforeScroll3120044

TDataSet	参照

BeforeScroll イベントは，アプリケーションがあるレコードから別のレコードへスクロールする前に発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property BeforeScroll: TDataSetNotifyEventl;

説明

BeforeScroll イベントハンドラを記述すると，アプリケーションが First，Last，MoveBy，Delete，GotoBookmark，Insert，Append，Next，Prior，FindKey，FindFirst，FindNext，FindLast，FindPrior，Locate メソッドの呼び出しの結果として別のレコードへスクロールする直前に特定の処理が行われるようにすることができます。BeforeScroll は，これらのメソッドおよびデータセット内のレコードを切り替える他のメソッドによって他のすべてのイベントがトリガされる前に呼び出されます。


TDataSet.OnCalcFields
TDataSet.OnCalcFields3120045

TDataSet	参照

OnCalcFields イベントは，アプリケーションが計算項目を再計算したときに発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property OnCalcFields: TDataSetNotifyEventl;

説明

OnCalcFields イベントハンドラを記述すると，アプリケーションが計算項目を再計算したときに特定の処理が行われるようにすることができます。計算項目は値をデータセット内の 1 つまたは複数の項目の値から派生させ，場合によってはその値に追加処理を行う項目です。

OnCalcFields は頻繁に呼び出されるので，コードは短くしてください。

AutoCalcFields プロパティが Trueならば，次の場合に OnCalcFields が発生します。

・	データセットを開いた

・	データセットが dsEdit 状態になった

・	フォーカスがある可視コントロールから別の可視コントロールへ，またはデータベース対応グリッドコントロールのある列から別の列へ移り，レコードに変更が加えられた

・	データベースからレコードを取り出した

注意

AutoCalcFields プロパティが True のとき，OnCalcFields でデータセット（データセットがマスターリンク関係の一部の場合はリンクされたデータセット）を変更しないようにしてください。変更した場合には，OnCalcFields イベントが再び発生し，再帰が起こります。

OnCalcFields が呼び出される回数を少なくするには，AutoCalcFields を False に設定します。AutoCalcFields が False のときは，OnCalcFields はレコード内の個々の項目に変更が加えられても呼び出されません。アプリケーションがユーザーによるデータの変更を許可している場合は，OnCalcFields は頻繁に発生します。そのような場合には，AutoCalcFields を False に設定すれば，AutoCalcFields が呼び出される回数を少なくすることができます。


TDataSet.OnDeleteError
TDataSet.OnDeleteError3120046

TDataSet	参照

OnDeleteError イベントは，アプリケーションがレコードを削除しようとして例外が生成されたときに発生します。

type

TDataAction = (daFail, daAbort, daRetry);

TDataSetErrorEvent = procedure(DataSet: TDataSet; E: EDatabaseError;

var Action: TDataAction) of object;

property OnDeleteError: TDataSetErrorEven;

説明

OnDeleteError イベントハンドラを記述すると，アプリケーションがレコードを削除しようとして失敗したときに発生する例外を処理することができます。E は，例外エラーメッセージが入ったデータベースエラーオブジェクトです。これによりアプリケーションはエラーメッセージを表示できるようになります。Action はこのハンドラがエラーにどのように応答するかを示します。以下に Action の設定値とその意味を示します。

値	意味

daFail	削除処理を中止し，エラーメッセージを表示する

daAbort	削除処理を中止するが，エラーメッセージは表示しない

daRetry	削除処理をやり直す。エラーハンドラ内でエラー状態を訂正してから，Action を daRetry に設定する

OnDeleteError が呼び出されたときは，Action は必ず daFail に設定されています。エラーハンドラが自分を呼び出したエラー状態を訂正できる場合は，Action を daRetry に設定してからハンドラを終了します。Action が daRetry のときは，削除処理が再試行されます。

エラー状況が訂正できない場合，Action を daFailではなく daAbort に設定すれば，エラーメッセージが表示されないようにすることもできます（必要な場合）。


TDataSet.OnEditError
TDataSet.OnEditError3120047

TDataSet	参照

OnEditError イベントは，アプリケーションがレコードを変更または挿入しようとして例外が生成されたときに発生します。

type

TDataAction = (daFail, daAbort, daRetry);

TDataSetErrorEvent = procedure(DataSet: TDataSet; E: EDatabaseError;

var Action: TDataAction) of object;

property OnEditError: TDataSetErrorEven;

説明

OnEditError イベントハンドラを記述すると，レコードを編集しようとして失敗したときに発生する例外を処理することができます。E は，例外エラーメッセージが入ったデータベースエラーオブジェクトです。これによりアプリケーションはエラーメッセージを表示できるようになります。Action はこのハンドラがエラーにどのように応答するかを示します。以下に Action の設定値とその意味を示します。

値	意味

daFail	編集処理を中止し，エラーメッセージを表示する

daAbort	編集処理を中止するが，エラーメッセージは表示しない

daRetry	編集処理をやり直す。エラーハンドラ内でエラー状況を訂正してから，Action を daRetry に設定する

OnEditError が呼び出されたときは，Action は必ず daFail に設定されています。エラーハンドラが自分を呼び出したエラー状況を訂正できる場合は，Action を daRetry に設定してからハンドラを終了します。Action が daRetry のときは，編集処理が再試行されます。

エラー状況が訂正できない場合，Action を daFailではなく daAbort に設定すれば，エラーメッセージが表示されないようにすることもできます（必要な場合）。


TDataSet.OnFilterRecord
TDataSet.OnFilterRecord3120048

TDataSet	参照

OnFilterRecord イベントは，フィルタ処理が有効な場合に，データセット内のカレントレコードがかわるたびに発生します。

type

 TFilterRecordEvent = procedure(DataSet: TDataSet; var Accept: Boolean) of object;

property OnFilterRecord: TFilterRecordEvent;

説明

OnFilterRecord イベントハンドラを記述すると，レコードがアプリケーションにとって可視であるかどうかを判定するテスト条件に対して，データセット内の各レコードを検査することができます。

レコードがフィルタ条件に適合するかどうかを示すには，フィルタハンドラは Accept パラメータを True に設定してレコードを含めるようにするか，または False に設定してレコードを含めないようにする必要があります。たとえば，次のフィルタでは，State 項目が「CA」に設定されているレコードのみが表示されるようになります。

procedure TForm1.Table1FilterRecord(DataSet: TDataSet; var Accept:
  Boolean);

begin

  Accept := DataSet['State'] = 'CA';

end;

リモートの SQL テーブルあるいはクライアントデータセット上のフィルタ式は，以下に示すような項目の比較演算をサポートしています。

Accept := Field1 > Field2

項目の比較演算は，ローカルのテーブル（Paradox，dBASE，Access）ではサポートされていません。

Filtered プロパティが True のときにフィルタ処理が可能になります。アプリケーションがフィルタ処理を実行しているときは，データセットの State プロパティは dsFilter です。FilterOptions プロパティは，大文字小文字の区別と部分的な比較を制御します。

注意

アプリケーションは Filter プロパティを使っても，フィルタを指定することができます。Filter プロパティは OnFilterRecord イベントハンドラを補完します。1 つのアプリケーションで同時に使う場合は，Filter プロパティと OnFilterRecord イベントハンドラとの対話の結果として，空のフィルタセットが生み出されないように注意する必要があります。


TDataSet.OnNewRecord
TDataSet.OnNewRecord3120049

TDataSet	参照

OnNewRecord イベントは，アプリケーションがデータセットに新しいレコードを挿入または追加したときに発生します。

type

TDataSetNotifyEvent = procedure(DataSet: TDataSet) of object;

property OnNewRecord: TDataSetNotifyEventl;

説明

OnNewRecord イベントハンドラを記述すると，アプリケーションが新しいレコードを挿入または追加したときに特定の処理が実行されるようにすることができます。OnNewRecord は実際の挿入または追加処理の一部として呼び出されます。アプリケーションで，レコードの初期値を設定したり，相互に関連のあるデータセットへの連続的な挿入処理を実現したりするのに OnNewRecord イベントを利用することができます。


TDataSet.OnPostError
TDataSet.OnPostError3120050

TDataSet	参照

OnPostError イベントは，アプリケーションがレコードを変更または挿入した結果をデータベースまたはキャッシュに登録しようとして例外が生成されたときに発生します。

type

TDataAction = (daFail, daAbort, daRetry);

TDataSetErrorEvent = procedure(DataSet: TDataSet; E: EDatabaseError;

var Action: TDataAction) of object;

property OnPostError: TDataSetErrorEven;

説明

OnPostError イベントハンドラを記述すると，レコードを登録しようとして失敗したときに発生する例外を処理することができます。E は，例外エラーメッセージが入ったデータベースエラーオブジェクトです。これによりアプリケーションはエラーメッセージを表示できるようになります。Action はこのハンドラがエラーにどのように応答するかを示します。以下に Action の設定値とその意味を示します。

値	意味

daFail	登録処理を中止し，エラーメッセージを表示する

daAbort	登録処理を中止するが，エラーメッセージは表示しない

daRetry	登録処理をやり直す。エラーハンドラ内でエラー状況を訂正してから，Action を daRetry に設定する

OnPostError が呼び出されたときは，Action は必ず daFail に設定されています。エラーハンドラが自分を呼び出したエラー状況を訂正できる場合は，Action を daRetry に設定してからハンドラを終了します。Action が daRetry のときは，登録処理が再試行されます。

エラー状況が訂正できない場合，Action を daFailではなく daAbort に設定すれば，エラーメッセージが表示されないようにすることもできます（必要な場合）。


TDataSet メソッド3120051

TDataSet	アルファベット順

TDataSet

ActiveBuffer

Append

AppendRecord

BookmarkValid

Cancel

CheckBrowseMode

ClearFields

Close

CompareBookmarks

ControlsDisabled

Create

CreateBlobstream

CursorPosChanged

Delete

Destroy

DisableControls

Edit

EnableControls

FieldByName

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FreeBookmark

GetBookmark

GetCurrentRecord

GetFieldList

GetFieldNames

GotoBookmark

Insert

InsertRecord

IsEmpty

IsLinkedTo

IsSeguenced

Last

Locate

Lookup

MoveBy

Next

Open

Post

Prior

Refresh

Resync

SetFields

Translate

UpdateCursorPos

UpdateRecord

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDataSet メソッド3120052

TDataSet	オブジェクト順

ActiveBuffer

Append

AppendRecord

Assign

BookmarkValid

Cancel

CheckBrowseMode

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearFields

Close

CompareBookmarks

ControlsDisabled

Create

CreateBlobstream

CursorPosChanged

DefaultHandler

Delete

Destroy

DestroyComponents

Destroying

DisableControls

Dispatch

Edit

EnableControls

FieldAddress

FieldByName

FindComponent

FindField

FindFirst

FindLast

FindNext

FindPrior

First

Free

FreeBookmark

FreeInstance

FreeNotification

FreeOnRelease

GetBookmark

GetCurrentRecord

GetFieldList

GetFieldNames

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GotoBookmark

HasParent

InheritsFrom

InitInstance

Insert

InsertComponent

InsertRecord

InstanceSize

IsEmpty

IsLinkedTo

IsSeguenced

Last

Locate

Lookup

MethodAddress

MethodName

MoveBy

NewInstance

Next

Open

Post

Prior

Refresh

RemoveComponent

Resync

SafeCallException

SetFields

Translate

UpdateCursorPos

UpdateRecord


TDataSet.ActiveBuffer
TDataSet.ActiveBuffer3120053

TDataSet	参照

ActiveBuffer メソッドは，カレントレコード用のバッファへのポインタを返します。

function ActiveBuffer: PChar;

説明

ActiveBuffer メソッドは，アクティブバッファがカレントレコード用のバッファを指すことが保証されるようにするために，データセットの多くのメソッドによって内部的に使用されます。アプリケーションが既存のデータセットメソッドを使用している場合は，アクティブバッファは常に正しく設定されています。したがって，ActiveBuffer を直接呼び出す必要性はあまりありません。

また，ActiveBuffer は，ブックマーク関連のメソッドでカレントレコードバッファへのインデックスに対してブックマーク情報を取り出すために使用されることもあります。

カスタムデータセットルーチンを提供するアプリケーションでは，バッファデータにアクセスするために ActiveBuffer を呼び出すことが必要です（特に，データセット内のレコードの集合に対して処理を繰り返す場合）。そのようなケースでは，カスタムルーチンが Next または Prior などのメソッドを呼び出すと，アクティブバッファが自動的に設定されます。


TDataSet.Append
TDataSet.Append3120054

TDataSet	参照

Append メソッドは，データセットの最後に新しい空のレコードを追加します。

procedure Append;

説明

Append メソッドは，次の手順でレコードを追加します。

1.	データセットの最後で新しい空のレコードを開く

2.	カレントレコードを新しいレコードに設定する

Append メソッドを呼び出した後，アプリケーションはユーザーがそのレコードの項目にデータを入力できるようにし，次に，変更内容を Post メソッド（または ApplyUpdates メソッド，キャッシュアップデートが有効な場合）を使ってデータベースに登録することができます。新たに追加されたレコードは，次のいずれかの方法でデータベースに登録されます。

・	インデックスの付いた Paradox および dBASE テーブルの場合，レコードはインデックスに基づいたデータセット内の位置に挿入される

・	インデックスの付いていない Paradox および dBASE テーブルの場合，レコードはデータセット内の最後に追加される

・	SQL データベースの場合，追加先の物理位置は実装によって異なる。インデックスの付いたテーブルの場合，インデックスが新しいレコードの情報で更新される


TDataSet.AppendRecord
TDataSet.AppendRecord3120055

TDataSet	参照

AppendRecord メソッドは，データセットの最後に値の入った新しいレコードを追加し，それをデータベースに登録します。

procedure AppendRecord(const Values: array of const);

説明

AppendRecord メソッドを呼び出すと，データセットの最後に新しい空のレコードを追加し，Values の項目値をそのレコードに入れ，それらの値をデータベースに登録できます。新たに追加されたレコードは，次のいずれかの方法でデータベースに登録されます。

・	インデックスの付いた Paradox および dBASE テーブルの場合，レコードはインデックスに基づいたデータセット内の位置に挿入される

・	インデックスの付いていない Paradox および dBASE テーブルの場合，レコードはデータセット内の最後に追加される

・	SQL データベースの場合，追加先の物理位置は実装によって異なる。インデックスの付いたテーブルの場合，インデックスが新しいレコードの情報で更新される

新たに追加されたレコードがカレントレコードになります。


TDataSet.BookmarkValid
TDataSet.BookmarkValid3120056

TDataSet	参照

BookmarkValid メソッドは，指定したブックマークの妥当性を検査する仮想関数を実現します。

type

TBookmark = Pointer;

function BookmarkValid(Bookmark: TBookmark): Boolean; virtual;

説明

TDataSet オブジェクトでは，この関数はすべての場合に False を返します。通常，アプリケーションは TDataSet レベルで BookmarkValid を呼び出しません。かわりに，TTable などの下位オブジェクトで再宣言され，実装された BookmarkValid を呼び出します。BookmarkValid は，BookmarkValid を再実装していない派生データセットオブジェクトにフォールバックメソッドを提供します。


TDataSet.Cancel
TDataSet.Cancel3120057

TDataSet	参照

Cancel メソッドは，カレントレコードに対する変更がまだ登録されていない場合，その変更を取り消します。

procedure Cancel; virtual;

説明

Cancel メソッドを呼び出すと，カレントレコードに属する 1 つまたは複数の項目に対して加えられた変更を取り消すことができます。変更がまだデータベースに登録されていないければ，Cancel はそのレコードを以前の状態に戻し，データセットの State プロパティを dsBrowse に設定します。

一般に，Cancel は，ユーザーの要求に応じて，または不正な項目値を取り消す項目検証ルーチンで変更を取り消すのに使用されます。TDBNavigator オブジェクトには，Cancel メソッドの呼び出しを発生させる Cancel ボタンがあります。


TDataSet.CheckBrowseMode
TDataSet.CheckBrowseMode3120058

TDataSet	参照

アプリケーションが，データセット内のカレントレコードを変更するメソッドを呼び出したときに，データ変更を自動的に登録するかまたは取り消します。

procedure CheckBrowseMode;

説明

CheckBrowseMode メソッドは，データセットの状態が dsEdit，dsInsert，dsSetKey で，別のレコードに切り替えるメソッドが呼び出されたときに，カレントレコードに対する変更がデータベースに登録されることが保証されるようにするために，多くのデータセットオブジェクトのメソッドによって内部的に使用されます。

State プロパティが dsEdit または dsInsert の場合，CheckBrowseMode は UpdateRecord メソッドを呼び出してから，データセットの Modified プロパティが True なら，Post メソッドを呼び出します。Modified が False なら，CheckBrowseMode は Cancel メソッドを呼び出します。

State プロパティが dsSetKey の場合，CheckBrowseMode は Post メソッドを呼び出します。

State プロパティが dsInactive の場合，CheckBrowseMode は例外を生成します。

アプリケーションが既存のデータセットメソッドを使用している場合は，CheckBrowseMode は必要なときに必ず呼び出されます。したがって，CheckBrowseMode を直接呼び出す必要性はふつうありません。

カスタムデータセットルーチンを提供しているアプリケーションでは，別のレコードへ切り替えたときに変更がデータベースに登録されることが保証されるようにするために，ルーチン内で CheckBrowseMode を呼び出すことが必要になる場合があります。


TDataSet.ClearFields
TDataSet.ClearFields3120059

TDataSet	参照

カレントレコードのすべての項目の内容を消去します。

procedure ClearFields;

説明

ClearFields メソッドを呼び出すと，カレントレコードのすべての項目の内容を消去できます。データセットの状態が dsInsert と dsEdit のいずれでもない場合は，ClearFields は例外を生成します。それ以外の場合は，DataEvent イベントハンドラを呼び出して，CheckBrowseMode を呼び出してから，そのレコードのすべての項目を初期化することにより効率的に消去を行います。SetKey 処理が実行中でなければ，ClearFields はすべての計算項目を再計算します。最後に，そのデータセットに関連付けられているデータソースコンポーネントの OnDataChange イベントハンドラを呼び出します。


TDataSet.Close
TDataSet.Close3120060

TDataSet	参照

Close メソッドは，データセットを閉じます。

procedure Close;

説明

Close メソッドを呼び出すと，データセットの Active プロパティを False に設定できます。Active が False のときは，データセットは閉じられているので，そのデータセットはデータベースからデータを読み出したり，データベースにデータを書き込んだりすることはできません。

アプリケーションは，データベースのステータスに影響を及ぼす他のプロパティやアプリケーションでデータを表示するコントロールを変更する前に，Active を False に設定する必要があります。たとえば，データセットの DataSource プロパティを変更する場合は，まず Active を False に設定して，データセットを確実に閉じる必要があります。Active を False に設定すると，そのデータセットの状態が dsInactive に変更され，BDE カーソルが閉じます。


TDataSet.CompareBookmarks
TDataSet.CompareBookmarks3120061

TDataSet	参照

CompareBookmarks メソッドは，2 つのブックマークを比較する仮想関数です。

type

TBookmark = Pointer;

function CompareBookmarks(Bookmark1, Bookmark2: TBookmark): Integer; virtual;

説明

TDataSet オブジェクトでは，この関数はすべての場合に 0 を返します。通常，アプリケーションは TDataSet レベルで CompareBookmarks を呼び出しません。かわりに，TTable などの下位オブジェクトで再宣言され，実装された CompareBookmarks を呼び出します。CompareBookmarks は，CompareBookmarks を再実装していない派生データセットオブジェクトにフォールバックメソッドを提供します。


TDataSet.ControlsDisabled
TDataSet.ControlsDisabled3120062

TDataSet	参照

ControlsDisabled メソッドは，データベース対応コントロール内のデータ表示の更新が現在データセットに対して無効であるかどうかを表します。

function ControlsDisabled: Boolean;

説明

ControlsDisabled メソッドを呼び出すと，データベース対応コントロール内のデータ表示の更新が現在無効であるかどうかを判定できます。ControlsDisabled が True なら，コントロールは現在無効です。データセットの無効化を追跡する参照カウントが 0 より大きいうちは，ControlsDisabled は True です。このカウントは DisableControls 手続きが呼び出されるたびに増加します。アプリケーションで DisableControls を呼び出せば，処理効率を向上させたり，データセット内の多数のレコードに対する自動繰り返しの処理のたびに表示更新が行われないようにすることができます。

次の例は，別プロセスによって何度か無効化されたデータセットのコントロールの表示を再度有効化する手続きです。

procedure ReEnableControls (DataSet: TDataSet);

begin

  while DataSet.ControlsDisabled do

    DataSet.EnableControls;

end;


TDataSet.Create
TDataSet.Create3120063

TDataSet	参照

Create メソッドは，TDataSet コンポーネントのインスタンスを生成します。

constructor Create(AOwner: TComponent);

説明

Create メソッドを呼び出すと，実行時にデータセットコンポーネントをインスタンス化できます。通常，アプリケーションは，TDataSet ではなく，TTable，TQuery，TStoredProc などのデータセットの下位オブジェクトをインスタンス化します。これらのインスタンス化されたオブジェクトは Delphi によって自動的に処理されます。

一方，ボーランドデータベースエンジン（BDE）をバイパスするカスタムコンポーネントなど，特殊なデータセットコンポーネントを作成するアプリケーションの場合は，Create を呼び出して，TDataSet コンポーネントをインスタンス化する必要があります。Create は以下の処理を実行します。

・	データセットに空の項目定義を作成する

・	データセットに空の項目リストを作成する

・	データセットに空のデータソースリストを作成する

・	AutoCalcFields プロパティを True に設定する

・	データセットの項目バッファを消去する


TDataSet.CursorPosChanged
TDataSet.CursorPosChanged3120064

TDataSet	参照

CursorPosChanged メソッドは，データセット内のカーソル位置を -1 に設定します。

procedure CursorPosChanged;

説明

CursorPosChanged メソッドは，論理カーソル位置に対する相対的な物理カーソル位置を追跡する変数を無効化する内部メソッドです。CursorPosChanged は，要求されたレコードの検索を始める前に Locate および Lookup メソッドによって呼び出されます。これらのメソッドは，成功すれば，カーソル位置を一致した最初のレコードに移動します。


TDataSet.Delete
TDataSet.Delete3120065

TDataSet	参照

Delete メソッドは，カレントレコードを削除し，カーソルを次のレコードに移動します。

procedure Delete;

説明

Delete メソッドを呼び出すと，カレントレコードをデータベースから削除できます。データセットがアクティブでない場合は，Delete は例外を生成します。それ以外の場合は，Delete は次の処理を実行します。

・	データセットが空でないことを確認する（空の場合は例外が生成される）

・	CheckBrowseMode を呼び出して，未処理の変更があればそれを前のレコードに登録する

・	BeforeDelete イベントハンドラをトリガする

・	レコードを削除する

・	レコードに割り当てられていたバッファを解放する

・	データセットを dsBrowse モードに設定する

・	データセットを同期し直してカーソルを次の削除されていないレコードに置く

・	AfterDelete イベントハンドラを呼び出す

・	AfterScroll イベントハンドラを呼び出す


TDataSet.Destroy
TDataSet.Destroy3120066

TDataSet	参照

Destroy メソッドは，データセットコンポーネントのインスタンスを破棄します。

destructor Destroy;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。データセットの破棄は通常は Delphi によって自動的に処理されます。ただし，アプリケーションが独自のデータセットのインスタンスを生成する場合は，Free メソッドを呼び出す必要があります。Free メソッドはデータセットコンポーネントが解放されていないことを確認してから Destroy メソッドを呼び出します。

Destroy は次の処理を実行します。

・	データセットを閉じる

・	データセットのデータセットデザイナを解放する（データセットデザイナがある場合）

・	データセットとデータソースコンポーネントとの関連付けを解除し，割り当てていたメモリを解放する

・	データセットに関連付けられている項目を破棄し，割り当てていたメモリを解放する

・	項目定義に割り当てていたメモリを解放する

・	継承された Destroy デストラクタを呼び出す


TDataSet.DisableControls
TDataSet.DisableControls3120067

TDataSet	参照

DisableControls メソッドは，データソースコンポーネントを通じて，データセットに関連付けられているデータベース対応コントロール内でのデータ表示を無効にします。

procedure DisableControls;

説明

DisableControls メソッドを呼び出すと，データセット内の多数のレコードに対する繰り返し処理を実行する前にデータベース対応コントロール内でのデータ表示を無効にすることができます。コントロール内でのデータ表示を無効にしておけば，データはディスプレイに表示されずに済むので，データセットに対する高速な繰り返し処理の際のコントロールのちらつきを防止し，処理効率を向上させることができます。

コントロール内でのデータ表示が有効になっている場合は，DisableControls はデータセットの現在の状態を記録し，データセットの有効化イベントを deDataSetChange に設定し，データセットの無効カウント変数をインクリメントします。それ以外の場合は，DisableControls はこの無効なカウント変数をインクリメントするだけです。

有効化イベントと無効カウント変数は，他のメソッドおよびオブジェクトによって，データベース対応コントロール内でデータを表示するかどうかを判定するために内部的に使用されます。無効カウント変数が 0 より大きいときは，データは表示されません。

通常 DisableControls は，例外が発生してもそのコントロールを再有効化させるように try...finally ブロックのコンテキスト内で呼び出されます。以下にコード例を示します。

.

.

.

with CustTable do

begin

  DisableControls;

  try

    First;

    while not EOF do

    begin

      { ここで各レコードを処理する }

      .

      .

      .

      Next;

    end;

  finally

    EnableControls;

  end;

end;

注意

コントロールがすでに無効なときは DisableControls は安全に呼び出すことができます。複雑なアプリケーションでは，場合によってはネストしていて，どちらもコントロールを無効化するのに必要となる処理が別々にある場合もあります。


TDataSet.Edit
TDataSet.Edit3120068

TDataSet	参照

Edit メソッドは，データセット内のデータを編集できるようにします。

procedure Edit;

説明

Edit メソッドを呼び出すと，データセット内のカレントレコードを編集可能にすることができます。Edit はデータセットの現在の状態を変更します。データセットが空ならば，Edit は Insert  を呼び出します。それ以外の場合は，Edit は次の処理を実行します。

・	CheckBrowseMode を呼び出して，未処理の変更があればそれを前のレコードに登録する

・	BeforeEdit イベントハンドラを呼び出す

・	レコードを取り出す

・	データセットの状態を dsEdit にして，アプリケーションまたはユーザーがレコード内の項目を変更できるようにする

・	レコード変更イベントを発生させる

・	AfterEdit イベントハンドラを呼び出す


TDataSet.EnableControls
TDataSet.EnableControls3120069

TDataSet	参照

EnableControls メソッドは，データソースコンポーネントを通じて，データセットに関連付けられているデータベース対応コントロール内でのデータ表示を有効にします。

procedure EnableControls;

説明

EnableControls メソッドを呼び出すと，前回の DisableControls の呼び出し以降のデータをデータベース対応コントロール内で表示できます。EnableControls は，データセットの無効カウント変数がすでに 0 になっていなければ，その変数の値をデクリメントします。デクリメントした結果，無効カウント変数が 0 になった場合は，EnableControls は，必要ならば現在のデータセットの状態を更新してから，データ表示を再有効化させるイベントハンドラを呼び出します。

ふつう EnableControls は，コントロールが無効になっている間に例外が発生してもそのコントロールを再有効化させるために try...finally ブロックのコンテキスト内で呼び出されます。以下にコード例を示します。

.

.

.

with CustTable do

begin

  DisableControls;

  try

    First;

    while not EOF do

    begin

      { ここで各レコードを処理する }

      .

      .

      .

      Next;

    end;

  finally

    EnableControls;

  end;

end;


TDataSet.FieldByName
TDataSet.FieldByName3120070

TDataSet	参照

FieldByName メソッドは，指定した項目名に基づいて項目を取得します。

function FieldByName(const FieldName: string): TField;

説明

FieldByName メソッドを呼び出すと，項目の名前のみわかっている場合に，その項目の情報を取得することができます。FieldName は既存の項目の名前です。FieldByName は，指定した項目の TField オブジェクトを返します。

アプリケーションはその項目の特定のプロパティおよびメソッドに直接アクセスできます。たとえば，次の文では，指定した項目が計算項目であるかどうかを判定できます。

if Customers.FieldByName('FullName').Calculated then

  MessageDlg(Format('%s is a calculated field. ', ['FullName']),
  mtInformation, [mbOK], 0);

FieldByName は，データベースアプリケーションを作成していて，設計時に基になるテーブルにアクセスできないために静的項目コンポーネントを使えないという場合に特に便利です。

注意

指定した項目の値を取得または設定する場合は，FieldByName ではなく，データセットのデフォルトプロパティの FieldValues を使用します。


TDataSet.FindField
TDataSet.FindField3120071

TDataSet	参照

FindField メソッドは，データセット内で指定した項目オブジェクトを検索します。

function FindField(const FieldName: string): TField;

説明

FindField メソッドを呼び出すと，指定した項目コンポーネントがデータセット内に存在するかどうかを判定できます。FieldName は検索する項目の名前です。名前が一致する項目が見つかった場合は，FindField は指定した項目の TField オブジェクトを返します。それ以外の場合は，nil を返します。

FindField は，パラメータとして有効な項目名を指定することが必要な FieldByName などの他のデータセットメソッドを呼び出す前に呼び出すことができる便利な関数です。


TDataSet.FindFirst
TDataSet.FindFirst3120072

TDataSet	参照

FindFirst メソッドは，フィルタ処理を行ったデータセット内の最初のレコードにカーソルを移動します。

function FindFirst: Boolean;

説明

TDataSet オブジェクトでは，この関数は，カーソルの配置が正しく行えなかったことを示す False を返します。通常，アプリケーションは TDataSet レベルで FindFirst を呼び出しません。かわりに，TTable などの下位オブジェクトレベルで FindFirst を呼び出します。FindFirst は，フィルタに合致するレコードを検索するために FindRecord メソッドを呼び出します。アプリケーションは，カスタムデータセットとして，TDataSet から派生したオブジェクトを生成した場合，この FindRecord メソッドを再宣言し，再実装する必要があります。


TDataSet.FindLast
TDataSet.FindLast3120073

TDataSet	参照

FindLast メソッドは，フィルタ処理を行ったデータセット内の最後のレコードにカーソルを移動します。

function FindLast: Boolean;

説明

TDataSet オブジェクトでは，この関数は，カーソルの配置が正しく行えなかったことを示す False を返します。通常，アプリケーションは TDataSet レベルで FindLast を呼び出しません。かわりに，TTable などの下位オブジェクトで FindLast を呼び出します。FindLast は，フィルタに合致するレコードを検索するために FindRecord メソッドを呼び出します。アプリケーションは，カスタムデータセットとして，TDataSet から派生したオブジェクトを生成した場合，この FindRecord メソッドを再宣言し，再実装する必要があります。


TDataSet.FindNext
TDataSet.FindNext3120074

TDataSet	参照

FindNext メソッドは，フィルタ処理を行ったデータセット内の次のレコードにカーソルを移動します。

function FindNext: Boolean;

説明

TDataSet オブジェクトでは，この関数は，カーソルの配置が正しく行えなかったことを示す False を返します。通常，アプリケーションは TDataSet レベルで FindNext を呼び出しません。かわりに，TTable などの下位オブジェクトで FindNext を呼び出します。FindNext は，フィルタに合致するレコードを検索するために FindRecord メソッドを呼び出します。アプリケーションは，カスタムデータセットとして，TDataSet から派生したオブジェクトを生成した場合，この FindRecord メソッドを再宣言し，再実装する必要があります。


TDataSet.FindPrior
TDataSet.FindPrior3120075

TDataSet	参照

FindPrior メソッドは，フィルタ処理を行ったデータセット内の前のレコードにカーソルを移動します。

function FindPrior: Boolean;

説明

TDataSet オブジェクトでは，この関数は，カーソルの配置が正しく行えなかったことを示す False を返します。通常，アプリケーションは TDataSet レベルで FindPrior を呼び出しません。かわりに，TTable などの下位オブジェクトで FindPrior を呼び出します。FindPrior は，フィルタに合致するレコードを検索するために FindRecord メソッドを呼び出します。アプリケーションは，カスタムデータセットとして，TDataSet から派生したオブジェクトを生成した場合，この FindRecord メソッドを再宣言し，再実装する必要があります。


TDataSet.First
TDataSet.First3120076

TDataSet	参照

First メソッドは，データセット内の最初のレコードにカーソルを移動する汎用メソッドです。

procedure First;

説明

First メソッドは TDataSet レベルで呼び出さないでください。TDataSet の下位オブジェクトでは，データセット内の最初のレコードにカーソルを移動し，そのレコードをカレントレコードにするために First を呼び出します。First はカレントレコードに対するすべての変更を登録し，次の処理を実行します。

・	レコードバッファをクリアする

・	カーソルをデータセットの先頭に設定する

・	最初のレコードを取り出し，カーソルをそのレコードに移動して，そのレコードをカレントレコードにする仮想抽象メソッドを呼び出す。TDataSet の場合は，このメソッドは宣言されるだけで，実装されていない

・	グリッドコントロールを埋めるためのデータなど，表示に必要な次のレコードを取り出す。

・	BOF プロパティを True に設定する

・	データセット変更イベントのイベントハンドラを呼び出す


TDataSet.FreeBookmark
TDataSet.FreeBookmark3120077

TDataSet	参照

FreeBookmark メソッドは，指定したブックマークに割り当てられているリソースを解放します。

type

TBookmark = Pointer;

procedure FreeBookmark(Bookmark: TBookmark); virtual;

説明

FreeBookmark メソッドを呼び出すと，次の処理を実行できます。

・	既存のブックマークを再割り当てする前に解放する

・	指定したブックマークが必要でなくなったときに，そのブックマークに割り当てられているメモリを解放する


TDataSet.GetBookmark
TDataSet.GetBookmark3120078

TDataSet	参照

GetBookmark メソッドは，データセット内の現在のカーソル位置にブックマークを割り当てます。

type

TBookmark = Pointer;

function GetBookmark: TBookmark; virtual;

説明

GetBookmark メソッドを呼び出すと，データセット内のカレントレコードにブックマークを設定できます。レコードにブックマークを設定すると，アプリケーションは，そのブックマークが存在している限りいつでもデータセット内のそのレコードに戻ることができます。

GetBookmark を使うときは，アプリケーション内ですでに TBookmark 型の変数が宣言されている必要があります。GetBookmark を使うと，その変数に，それ以降の GotoBookmark メソッドおよび FreeBookmark メソッドの呼び出しが参照できる値を代入することができます。

注意

GetBookmark を使ってブックマークを作成するアプリケーションは，後でブックマークが不要になったら FreeBookmark を呼び出して，割り当てられていたシステムリソースを解放する必要があります。


TDataSet.GetCurrentRecord
TDataSet.GetCurrentRecord3120079

TDataSet	参照

GetCurrentRecord メソッドは，カレントレコードをバッファに取り出す仮想関数です。

function GetCurrentRecord(Buffer: PChar): Boolean; virtual;

説明

TDataSet オブジェクトでは，この関数は，失敗を示す False を常に返します。ほとんどのアプリケーションは TDataSet レベルで GetCurrentRecord を呼び出しません。かわりに，TTable などの下位オブジェクトで再宣言され，実装された GetCurrentRecord を呼び出します。GetCurrentRecord は，この関数を再実装および実現していない派生オブジェクトにフォールバック関数を提供します。


TDataSet.GetFieldList
TDataSet.GetFieldList3120080

TDataSet	参照

GetFieldList メソッドは，指定した項目オブジェクトの集合をリストに取り出します。

procedure GetFieldList(List: TList; const FieldNames: string);

説明

GetFieldList メソッドを呼び出すと，指定した項目オブジェクトの集合を，アプリケーションによって生成および保持されるリストオブジェクトにコピーできます。

List は，項目オブジェクトのコピー先となる TList オブジェクトです。FieldNames は，コピーされる項目の名前が入る文字列です。この文字列に複数の項目名を入れる場合は，セミコロンで区切ります。GetFieldList は，データセットの項目オブジェクトのリスト内で一致する名前が見つかった項目オブジェクトのみが入ったリストを作成します。

注意

通常，アプリケーションは，項目オブジェクトをコピーするのに GetFieldList を呼び出す必要はありません。項目オブジェクトは，データセット自身で直接管理します。ただし，一部のケースでは，データセット内の実際のオブジェクトよりも，項目オブジェクトのコピーまたはそのデータを使ったほうが作業がしやすい場合もあります。そのような場合には，GetFieldList が便利です。


TDataSet.GetFieldNames
TDataSet.GetFieldNames3120081

TDataSet	参照

GetFieldNames メソッドは，データセット内のすべての項目の名前のリストを取り出します。

procedure GetFieldNames(List: TStrings);

説明

GetFieldNames メソッドを呼び出すと，データセット内のすべての項目の名前のリストを取得できます。List は，アプリケーションによって生成および保持される TStrings オブジェクトです。

項目名のリストを取得することは，実行時に動的に生成される項目オブジェクトを持つデータセットを使用するアプリケーションの場合には特に有用です。項目名のリストを取得すれば，アプリケーションは作業対象を実行時に存在している項目だけに制限することができます。


TDataSet.GotoBookmark
TDataSet.GotoBookmark3120082

TDataSet	参照

GotoBookmark メソッドは，指定したブックマークが示すレコードにカーソルを移動します。

type

TBookmark = Pointer;

procedure GotoBookmark(Bookmark: TBookmark);

説明

GotoBookmark メソッドは TDataSet レベルで呼び出さないでください。GotoBookmark は，TDataSet によって実現されていない仮想抽象内部メソッドを呼び出します。そのかわりに，TDataSet の下位オブジェクトは，GotoBookmark メソッドを再宣言して実装します。アプリケーションはこの下位オブジェクトのレベルで GotoBookmark メソッドを呼び出す必要があります。


TDataSet.Insert
TDataSet.Insert3120083

TDataSet	参照

Insert メソッドは，新しい空のレコードをデータセットに挿入します。

procedure Insert;

説明

Insert メソッドを呼び出すと，次の手順でレコードを挿入します

1.	データセット内で新しい空のレコードを開く

2.	カレントレコードを新しいレコードに設定する

Insert を呼び出した後，アプリケーションはユーザーがそのレコードの項目にデータを入力できるようにし，次に，Post（または ApplyUpdates，キャッシュアップデートが有効な場合）を使って変更内容をデータベースに登録することができます。新たに挿入されたレコードは，次のいずれかの方法でデータベースに登録されます。

・	インデックスの付いた Paradox および dBASE テーブルの場合，レコードはインデックスに基づいたデータセット内の位置に挿入される

・	インデックスの付いていない Paradox および dBASE テーブルの場合，レコードはデータセット内の現在のカーソル位置に挿入される

・	SQL データベースの場合，追加先の物理位置は実装によって異なる。インデックスの付いたテーブルの場合，インデックスが新しいレコードの情報で更新される


TDataSet.InsertRecord
TDataSet.InsertRecord3120084

TDataSet	参照

InsertRecord メソッドは，データセットに値の入った新しいレコードを挿入し，それをデータベースに登録します。

procedure InsertRecord(const Values: array of const);

説明

InsertRecord メソッドを呼び出すと，データセット内に新しい空のレコードを挿入し，Values の項目値をそのレコードに入れ，それらの値をデータベースに登録できます。新たに挿入されたレコードは，次のいずれかの方法でデータベースに登録されます。

・	インデックスの付いた Paradox および dBASE テーブルの場合，レコードはインデックスに基づいたデータセット内の位置に挿入される

・	インデックスの付いていない Paradox および dBASE テーブルの場合，レコードはデータセット内の現在のカーソル位置に挿入される

・	SQL データベースの場合，挿入先の物理位置は実装によって異なる。インデックスの付いたテーブルの場合，インデックスが新しいレコードの情報で更新される

新たに挿入されたレコードがカレントレコードになります。


TDataSet.IsEmpty
TDataSet.IsEmpty3120085

TDataSet	参照

IsEmpty メソッドは，データセットにレコードが入っていないかどうかを示します。

function IsEmpty: Boolean;

説明

IsEmpty メソッドを呼び出すと，データセットにレコードが入っているかどうかを判定できます。IsEmpty は，データセットにレコードが入っていない場合に True を返します。入っている場合は False を返します。


TDataSet.IsLinkedTo
TDataSet.IsLinkedTo3120086

TDataSet	参照

IsLinkedTo メソッドは，データセットが指定したデータソースにリンクされているかどうかを確認します。

function IsLinkedTo(DataSource: TDataSource): Boolean;

説明

IsLinkedTo メソッドを呼び出すと，データセットが指定したデータソースにリンクされているかどうかを確認できます。DataSource は，テストするデータソースオブジェクトです。

注意

IsLinkedTo は，主に TDataSet を基にしてカスタムコンポーネントを派生させる開発者向けに提供されています。一般的なデータアクセスで使用されることは意図されていませんし，またその必要もありません。

データセットがすでに指定したデータソースを使用している場合，IsLinkedTo は True を返します。データセットが指定したデータソースを使用していないで，そのデータソースに独自のデータセットがまだない場合は，IsLinkedTo は False を返します。


TDataSet.Last
TDataSet.Last3120087

TDataSet	参照

Last メソッドは，データセット内の最後のレコードにカーソルを移動する汎用メソッドです。

procedure Last;

説明

Last メソッドは TDataSet レベルで呼び出さないでください。TDataSet の下位オブジェクトでは，データセット内の最後のレコードにカーソルを移動し，そのレコードをカレントレコードにするために Last を呼び出します。Last はカレントレコードに対するすべての変更を登録し，次の処理を実行します。

・	レコードバッファをクリアする

・	カーソルをデータセットの最後に設定する

・	最後のレコードを取り出し，カーソルをそのレコードに移動してカレントレコードにする仮想抽象メソッドを呼び出す。TDataSet の場合は，このメソッドは宣言されるだけで，実装されていない

・	グリッドコントロールを埋めるためのデータなど，表示に必要な追加レコードを取り出す。TDataSet の場合は，このメソッドは，宣言されるだけで実装されていない別の仮想抽象メソッドを呼び出す

・	EOF プロパティを True に設定する

・	データセット変更イベントのイベントハンドラを呼び出す


TDataSet.Locate
TDataSet.Locate3120088

TDataSet	参照

Locate メソッドは，指定したレコードをデータセット内で検索し，そのレコードをカレントレコードにする仮想メソッドです。

type

TLocateOption = (loCaseInsensitive, loPartialKey);

TLocateOptions = set of TLocateOption;

function Locate(const KeyFields: string; const KeyValues: Variant;

    Options: TLocateOptions): Boolean; virtual;

説明

TDataSet オブジェクトでは，この関数は，一致するレコードが見つからず，カーソルが再配置されなかったことを示す False を返します。通常，アプリケーションは TDataSet レベルで Locate を呼び出しません。かわりに，TTable などの下位オブジェクトで再宣言され，実装された Locate を呼び出します。Locate は，Locate を再実装していない派生データセットオブジェクトにフォールバックメソッドを提供します。


TDataSet.Lookup
TDataSet.Lookup3120089

TDataSet	参照

Lookup メソッドは，指定した検索値に一致するレコードから項目値を取り出す仮想メソッドです。

function Lookup(const KeyFields: string; const KeyValues: Variant;

    const ResultFields: string): Variant; virtual;

説明

TDataSet オブジェクトでは，この関数は，一致する項目が見つからなかったことを示す False を返します。通常，アプリケーションは TDataSet レベルで Lookup を呼び出しません。かわりに，TTable などの下位オブジェクトで再宣言され，実装された Lookup を呼び出します。Lookup は，Lookup を再実装していない派生データセットオブジェクトにフォールバックメソッドを提供します。


TDataSet.MoveBy
TDataSet.MoveBy3120090

TDataSet	参照

MoveBy メソッドは，データセット内のカレントレコードに相対する位置にカーソルを移動します。

function MoveBy(Distance: Integer): Integer;

説明

MoveBy メソッドを呼び出すと，データセット内のカレントレコードに相対する位置にカーソルを移動できます。Distance は移動するレコード数を示します。Distance が正の値である場合は次に進みます。Distance が負の値である場合は前に戻ります。たとえば，次の文では，10 レコード分前に戻ります。

MoveBy(-10);

MoveBy はカレントレコードに対する変更をすべて登録し，次の処理を実行します。

・	BeforeScroll イベントのイベントハンドラを呼び出す

・	BOF および EOF プロパティを False に設定する

・	Distance が正の値の場合は，可能ならば Distance の値を 0 になるまでデクリメントしながら繰り返しそれ以降のレコードを取得し，カーソルを最後に取得したレコードに移動し，そのレコードをカレントレコードにする。ファイルの最後を超える移動を試みると，MoveBy は EOF を True に設定する

・	Distance が負の値の場合は，可能ならば Distance の値を 0 になるまでインクリメントしながら繰り返し前にあるレコードを取得し，カーソルを最後に取得したレコードに移動し，そのレコードをカレントレコードにする。ファイルの先頭を超える移動を試みると，MoveBy は BOF を True に設定する

・	AfterScroll イベントのイベントハンドラを呼び出す

・	実際に移動したレコード数を返す。ほとんどの場合，Result は Distance の絶対値になる。ただし，Distance 分のレコードを移動する前にファイルの先頭または最後に到達した場合は，Result の値は Distance の絶対値より小さい値になる


TDataSet.Next
TDataSet.Next3120091

TDataSet	参照

Next メソッドは，データセット内の次のレコードにカーソルを移動する汎用メソッドを実現します。

procedure Next;

説明

Next メソッドは TDataSet レベルで呼び出さないでください。TDataSet の下位オブジェクトでは，データセット内の次のレコードにカーソルを移動し，そのレコードをカレントレコードにするために Next を呼び出します。

Next はカレントレコードに対するすべての変更を登録し，次の処理を実行します。

・	BeforeScroll イベントのイベントハンドラを呼び出す

・	BOF および EOF プロパティを False に設定する

・	次のレコードに移動し，カーソルをそのレコードに移動して，そのレコードをカレントレコードにする仮想抽象メソッドを呼び出す。TDataSet の場合は，このメソッドは宣言されるだけで，実装されていない

・	グリッドコントロールを埋めるためのデータなど，表示に必要な追加レコードを取り出す。TDataSet の場合は，このメソッドは，宣言されるだけで実装されない別の仮想抽象メソッドを呼び出す

・	カーソルがすでにデータセット内の最後のレコードにある場合は EOF プロパティを True に設定する

・	AfterScroll イベントのイベントハンドラを呼び出す


TDataSet.Open
TDataSet.Open3120092

TDataSet	参照

Open メソッドは，データセットを開きます。

procedure Open;

説明

Open メソッドを呼び出すと，データセットの Active プロパティを True に設定できます。Active が True のときは，データベースからデータを読み出したり，データベースにデータを書き込んだりすることができます。

Active を True に設定すると，以下の処理が行われます。

・	データセットに定義されている場合 BeforeOpen イベントハンドラを呼び出す

・	データセットの状態を dsBrowse に設定する

・	必要ならば，データセットでボーランドデータベースエンジン（BDE）カーソルを開く（TBDEDataSet およびその下位オブジェクトの TQuery，TStoredProc，TTable の場合のみ）

・	データセットに定義されている場合 AfterOpen イベントハンドラを呼び出す

データセットが開いているときにエラーイベントが発生すると，データセットの状態は dsInactive に設定され，カーソルは閉じます。


TDataSet.Post
TDataSet.Post3120093

TDataSet	参照

Post メソッドは，変更されたレコードをデータベースに書き込む仮想メソッドです。

procedure Post; virtual;

説明

TDataSet オブジェクトは変更されたレコードをデータベースに書き込む仮想メソッドを実装します。Edit，Insert，Append などのようにデータセットの状態を変更したり，First，Last，Next，Prior などのようにあるレコードから別のレコードへ移動するデータセットメソッドは，自動的に Post を呼び出します。

TDataSet のすべての下位オブジェクトは，データベースへレコードを書き込むために Post を再宣言して実装します。


TDataSet.Prior
TDataSet.Prior3120094

TDataSet	参照

Prior メソッドは，データセット内の前にレコードにカーソルを移動する汎用メソッドです。

procedure Prior;

説明

Prior メソッドは TDataSet レベルで呼び出さないでください。TDataSet の下位オブジェクトでは，データセット内の前のレコードにカーソルを移動し，そのレコードをカレントレコードにするために Prior を呼び出します。Prior はカレントレコードに対するすべての変更を登録し，次の処理を実行します。

・	BeforeScroll イベントのイベントハンドラを呼び出す

・	BOF および EOF プロパティを False に設定する

・	前のレコードに移動し，カーソルをそのレコードに移動して，そのレコードをカレントレコードにする仮想抽象メソッドを呼び出す。TDataSet の場合は，このメソッドは宣言されるだけで，実装されない

・	グリッドコントロールを埋めるためのデータなど，表示に必要な追加レコードを取り出す。TDataSet の場合は，このメソッドは，宣言されるだけで実装されていない別の仮想抽象メソッドを呼び出す

・	カーソルがすでにデータセット内の最初のレコードにある場合は BOF プロパティを True に設定する

・	AfterScroll イベントのイベントハンドラを呼び出す


TDataSet.Refresh
TDataSet.Refresh3120095

TDataSet	参照

Refresh メソッドは，データセットのデータの表示を更新するためにデータベースからデータを再読み出しする汎用メソッドです。

procedure Refresh;

説明

Refresh メソッドは TDataSet オブジェクトでは呼び出さないでください。かわりに，TDataSet の下位オブジェクトで再宣言され再実装された Refresh メソッドを呼び出します。Refresh は，アプリケーションの持つデータがデータベースの最新のデータであることを保証します。たとえば，アプリケーションがデータセットに対してフィルタ処理をオフにした場合は，直ちに Refresh を呼び出して，フィルタ条件に適合していたものだけでなく，データセット内のすべてのレコードを表示する必要があります。


TDataSet.Resync
TDataSet.Resync3120096

TDataSet	参照

Resync メソッドは，カレントレコードとその前後のレコードを再読み出しします。

type

TResyncMode = set of (rmExact, rmCenter);

procedure Resync(Mode: TResyncMode); virtual;

説明

Resync メソッドは，カーソル位置を変更する可能性のある呼び出しを行うときに Delphi データセットと基になる物理データとの間で同期をとり直すために他のデータセットメソッドによって使用される内部ルーチンです。アプリケーションは，Resync を呼び出すかわりに Refresh メソッドを使う必要があります。

Mode は，Resync が行うオプションの処理を示します。

Mode に rmExact がある場合，カーソルが有効なレコード上にないときに Resync を呼び出すと，例外が生成されます。

Mode に rmCenter がある場合は，Resync はバッファ内のすべてのレコードの中央のレコードをカレントレコードにします。

Mode にかかわらず，Resync はカレントレコードのバッファをアクティブ化し，表示の目的で前後のレコードを取り出し，データセット変更イベントを発生させます。


TDataSet.SetFields
TDataSet.SetFields3120097

TDataSet	参照

SetFields メソッドは，レコード内のいくつかの項目に値を設定します。

procedure SetFields(const Values: array of const);

説明

SetFields メソッドを呼び出すと，カレントレコード内の一部またはすべての項目の値を一度に設定できます。

Values には，各項目に挿入される値が入ります。値は，データセットの基になるテーブル内での列の順序に基づいてレコードに代入されます。これらの値はリテラル，変数，NULL， nil のいずれでもかまいません。Values 内の値の数がレコード内の項目数より少ない場合は，Values 内の値の数までの項目に値が設定され，それ以外の項目の値はかわりません

SetFields を呼び出す前に，Edit を呼び出してデータセットの状態を dsEdit に変更しておきます。SetFields を呼び出した後で，Post を呼び出して変更内容をデータベースに書き込みます。

注意

他の項目の値を既存値のままにして，一部の項目の値だけを設定するには，変更しない項目に nil を代入します。


TDataSet.Translate
TDataSet.Translate3120098

TDataSet

Translate メソッドは，データ文字列を転送元から転送先へコピーする仮想手続きです。必要ならば，コピー中に文字の変換を実行します。

procedure Translate(Src, Dest: PChar; ToOem: Boolean); virtual;

説明

TDataSet オブジェクトでは，この関数は，転送元文字列を転送先文字列へコピーし，ToOem で渡された値を無視します。通常，アプリケーションは TDataSet レベルで Translate を呼び出しません。かわりに，TTable などの下位オブジェクトや開発者が派生したオブジェクトで再宣言され，実装された Translate を呼び出します。Translate は，Translate を再実装していない派生データセットオブジェクトにフォールバックメソッドを提供します。


TDataSet.UpdateCursorPos
TDataSet.UpdateCursorPos3120099

TDataSet	参照

UpdateCursorPos メソッドは，カーソルをカレントレコードに移動します。

procedure UpdateCursorPos;

説明

UpdateCursorPos メソッドは，物理カーソルがカレントレコードに置かれていることを保証するために多くのデータセットメソッドによって使用される内部ルーチンです。通常はアプリケーションが UpdateCursorPos を呼び出す必要はありません。UpdateCursorPos は，物理カーソル位置が論理カーソル位置と一致することが保証されるようにするために呼び出されます。


TDataSet.UpdateRecord
TDataSet.UpdateRecord3120100

TDataSet	参照

UpdateRecord メソッドは，レコードの更新に対してデータイベントを呼び出します。

procedure UpdateRecord;

説明

UpdateRecord メソッドは，キャッシュアップデートが有効な場合に OnUpdateRecord イベントを生成するために一部のデータセットメソッドによって使用される内部ルーチンです。データセットメソッドをバイパスするカスタムデータセットメソッドを提供している場合を除けば，アプリケーションが直接 UpdateRecord を呼び出す必要はありません。


スコープ3120101

published

読み出し／書き込み

読み出し専用


継承3120102

TObject

TPersistent

TComponent


TDataSet 例3120103

TDataSet


TDataSource
TDataSource3121001

継承	プロパティ	メソッド	イベント	参照	例

TDataSource コンポーネントは，データセットコンポーネントとフォーム上のデータベース対応コントロールとのインターフェースを提供します。

ユニット

db

説明

TDataSource は，データセットとフォーム上のデータベース対応コントロール間のインターフェースが提供します。データベース対応コントロールを使うと，データセットを構成するデータの表示，検索，および編集を行うことができます。

データベース対応コントロールでデータセットのデータを表示したり操作したりする場合，すべてのデータセットはデータソースコンポーネントと関連付けなければなりません。同様に，データを受け取って操作する各データベース対応コントロールはデータソースコンポーネントと関連付ける必要があります。

データソースコンポーネントはマスターリンク関係でもデータセットとリンクします。


TDataSource プロパティ3121002

TDataSource	アルファベット順	凡例

TDataSource

AutoEdit

DataSet

Enabled

State

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDataSource プロパティ3121003

TDataSource	オブジェクト順	凡例

AutoEdit

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DataSet

DesignInfo

Enabled

Name

Owner

State

Tag

VCLComObject


TDataSource.AutoEdit
TDataSource.AutoEdit3121004

TDataSource	参照

AutoEdit プロパティは，データソースコンポーネントに関連付けられたデータベース対応コントロールがフォーカスを受け取ったときに，データソースコンポーネントが自動的にデータセットの Edit メソッドを呼び出すかどうかを決めます。

property AutoEdit: Boolean;

説明

AutoEdit プロパティのデフォルト値は True です。AutoEdit プロパティが True の場合，ユーザーがコントロールによって表示されているデータを変更しようとすると，そのデータを構成するデータセットの Edit メソッドが呼び出されます。

不注意な変更からデータを保護するには，AutoEdit プロパティを False に設定します。AutoEdit プロパティが False の場合でも，アプリケーションで直接データセットの Edit メソッドを呼び出せばデータを変更できます。


TDataSource.DataSet
TDataSource.DataSet3121005

TDataSource	参照

DataSet プロパティは，データソースコンポーネントが提供するデータベース対応コントロールとのインターフェースの対象となるデータセットを指定します。

property DataSet: TDataSet;

説明

設計時または実行時に DataSet プロパティを既存のデータセットコンポーネント名に設定します。実行時に DataSet プロパティの値を変更すると，アプリケーションは同じデータベース対応コントロールを利用して異なるデータセットのデータを表示したり編集したりできます。

注意

設計時にデータモジュール内のデータセットをフォームにリンクするには，［ファイル(F)｜ユニットを使う(U)］を選択します。


TDataSource.Enabled
TDataSource.Enabled3121006

TDataSource	参照

Enabled プロパティは，データソースコンポーネントに関連付けられたデータベース対応コントロールがデータを表示するかどうかを決めます。

property Enabled: Boolean;

説明

Enabled プロパティは，データソースに関連付けらたデータベース対応コントロールがデータを表示するかどうかを制御します。Enabled プロパティが True（デフォルト）の場合には，データが表示されます。Enabled プロパティが False の場合には，データソースに関連付けられたコントロールはすべて空白になります。

注意

アプリケーションは複数のレコードの処理中に Enabled プロパティを False に設定してデータベース対応コントロールを空白にすることができますが，TDataSet の EnableControls メソッドと DisableControls メソッドを使うことをお勧めします。これらのメソッドを使うと，処理中にコントロールが空白になることはありません。


TDataSource.State
TDataSource.State3121007

TDataSource	参照

State プロパティは，データソースコンポーネントに関連付けられたデータセットコンポーネントの現在の状態を読み出します。

property State: TDataSetState;

説明

State プロパティを調べると，データソースコンポーネントに関連付けられたデータセットの現在の状態がわかります。データセットの状態は，データセットに対して行われているアクションを示します。以下に State プロパティの値を示します。

State	意味

dsInactive	データセットが閉じているか，DataSet プロパティに値が割り当てられていないか，Enabled プロパティが False である

dsBrowse	データセットを開いて表示している。データセットのデフォルトの状態

dsEdit	データセットは開いている。カレントレコードを変更できる.

dsInsert	データセットは開いている。新規レコードの挿入中である

dsSetKey	データセットは開いている。インデックス付き項目を使ってレコードを検索できる状態，または SetRange 処理の実行中である。いずれの場合も限られたデータのみを表示できる。データを変更することはできない

dsCalcFields	データセットが開いた状態で，OnCalcFields イベントの実行中である。計算項目以外は変更できない

dsFilter	データセットが開いた状態で，フィルタ処理の実行中である。限られたデータのみを表示できる。データを変更することはできない

これらの値はデータセットの State プロパティの値と一致していますが，Enabled が False の場合または DataSet に値が割り当てられていない場合には，データセットの実際の状態に関係なく State プロパティは dsInactive になります。


TDataSource イベント3121008

TDataSource	アルファベット順	凡例

TDataSource

OnDataChange

OnStateChange

OnUpdateData


TDataSource イベント3121009

TDataSource	オブジェクト順	凡例

OnDataChange

OnStateChange

OnUpdateData


TDataSource.OnDataChange
TDataSource.OnDataChange3121010

TDataSource	参照

OnDataChange イベントは，データソースコンポーネントに関連付けられたデータセットでカレントレコードを編集したり，アプリケーションが別の項目やレコードに移動したときに発生します。

type

TDataChangeEvent = procedure(Sender: TObject; Field: TField) of object;

property OnDataChange: TDataChangeEvent;

説明

OnDataChange イベントハンドラを記述すると，データソースコンポーネントに関連付けられたデータセットでカレントレコードの項目を編集したり，アプリケーションが別の項目やレコードに移動したときに特定のアクションを実行できます。このイベントを生成するメソッドにはデータセットの Next メソッドや Prior メソッドなどがあります。

データベース対応コントロールは，以下の処理によってデータが変更されたことをデータソースに通知します。

・	新規のレコードへのスクロール

・	項目のデータの変更

同時に複数の項目が変更された場合（別のレコードに移動した場合など）には，Field パラメータは nil になります。そうでない場合には Field パラメータは編集された項目を示します。

アプリケーションがデータベースに対応していない複数のコントロールで同時にデータを表示しなければならない場合に OnDataChange は特に便利です。


TDataSource.OnStateChange
TDataSource.OnStateChange3121011

TDataSource	参照

OnStateChange イベントは，データソースコンポーネントのデータセットの状態が変わったときに発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnStateChange: TNotifyEvent;

説明

OnStateChange イベントハンドラを記述すると，データソースコンポーネントに関連付けられたデータセットの State プロパティが変更されたときに特定のアクションを実行できます。

データベースに正常に接続している間，データセットの状態は頻繁に変わります。たとえば，ユーザーがデータベース対応コントロールで項目の編集を始めると，データセットの State プロパティはまだ dsEdit になっていなければ dsBrowse から dsEdit に変わります。OnStateChange イベントハンドラは，状態の変更に対する応答としてメニュー項目やボタンを使用可能/使用不可にするなどのアクションを実行できます。


TDataSource.OnUpdateData
TDataSource.OnUpdateData3121012

TDataSource	参照

OnUpdateData イベントは，カレントレコードが更新されるときに発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnUpdateData: TNotifyEvent;

説明

OnUpdateData イベントハンドラを記述すると，データベースにデータの変更を登録する前に特定のアクションを実行できます。アプリケーションがデータベースに変更を登録するときに OnUpdateData イベントハンドラが存在していれば，データセットの Post メソッドが実行される前にそのハンドラが呼び出されます。OnUpdateData イベントハンドラは，変更を登録する前にさらにデータを処理したり検証したりする場合に便利です。


TDataSource メソッド3121013

TDataSource	アルファベット順

TDataSource

Create

Destroy

Edit

IsLinkedTo

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDataSource メソッド3121014

TDataSource	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Edit

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsLinkedTo

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TDataSource.Create
TDataSource.Create3121015

TDataSource	参照

Create メソッドは，TDataSource コンポーネントのインスタンスを作成します。

constructor Create(AOwner: TComponent);

説明

Create メソッドを呼び出すと，実行時に TDataSource コンポーネントをインスタンス化できます。設計時にデータモジュールに追加されたデータソースコンポーネントの場合，Delphi は自動的に Create を呼び出します。

Create メソッドはデータリンクリストをインスタンス化し，コンポーネントの Enabled および AutoEdit プロパティを True に設定します。


TDataSource.Destroy
TDataSource.Destroy3121016

TDataSource	参照

Destroy メソッドは，データソースコンポーネントのインスタンスを破棄します。

destructor Destroy;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはデータソースコンポーネントが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy は OnStateChange とコンポーネントのデータセットをそれぞれ nil に設定し，データリンクリストを解放してからコンポーネントの継承デストラクタを呼び出します。


TDataSource.Edit
TDataSource.Edit3121017

TDataSource	参照

Edit メソッドは，データソースコンポーネントに関連付けられたデータセットの Edit メソッドを呼び出すかどうかを示します。

procedure Edit;

説明

Edit を呼び出すと，ユーザーがデータソースに関連付けられたデータセットを編集できるかどうかをデータソースコンポーネントで制御できます。Edit は，データソースの AutoEdit プロパティが True かどうか，State プロパティが dsBrowse かどうかを調べてからデータセットの Edit メソッドを呼び出します。データセットの Edit メソッドを呼び出す前にこれらのプロパティを調べることで，データセットが編集できる状態にあり，データソースも編集を許可していることを保証します。


TDataSource.IsLinkedTo
TDataSource.IsLinkedTo3121018

TDataSource	参照

IsLinkedTo メソッドは，指定されたデータセットにデータソースがリンクしているかどうかを調べます。

function IsLinkedTo(DataSet: TDataSet): Boolean;

説明

IsLinkedTo メソッドを呼び出すと，指定されたデータセットにデータソースがリンクしているかどうかを確認できます。DataSet は，データソースがリンクしているデータセット名です。

データソースが指定されたデータセットを使用している場合，IsLinkedTo メソッドは True を返します。データソースが指定されたデータセットを使用していないがデータセットは存在するという場合，IsLinkedTo メソッドはデータソースコンポーネントの DataSet プロパティを DateSet パラメータで指定されたデータセットに設定して True を返します。

データソースが指定されたデータセットを使用していない場合でデータセットにも自身のデータソースがないときには，IsLinkedTo メソッドは False を返します。

注意

IsLinkedTo メソッドは，主にコンポーネント開発者が循環データ参照を検出するときに使用する低レベルのメソッドです。こうした場合を除いて，IsLinkedTo は直接呼び出さないでください。


スコープ3121019

published

読み出し／書き込み

読み出し専用


スコープ3121020

published


継承3121021

TObject

TPersistent

TComponent


TDataSource 例3121022

TDataSource


TCustomDataStore
TCustomDataStore3122001

継承	プロパティ	メソッド	イベント	参照

TCustomDataStore は，クロス集計されたデータを分析および保守するコンポーネントの基本クラスです。

ユニット

mxstore

説明

TCustomDataStore は，構造化されたデータセットからデータをフェッチし，その集計結果を多次元配列に分解するときに基本クラスとして使います。各次元は，情報を集計するデータセット内の 1 項目に相当します。TCustomDataStore は，アクティブな次元セット上のこの配列のキャッシュ射影を保守します。キャッシュすることで TCustomDataStore はアクティブな次元サブセットの射影をすばやく提供できます。

TCustomDataStore は，クロス集計されたデータ配列の次元およびそれらの次元で計算された集計値を記述するプロパティおよびメソッドを提供します。

TCustomDataStore のインスタンスは作成しないでください。TCustomDataStore オブジェクトでクロス集計したデータをフォームのオブジェクトで利用できるようにするには，TDecisionCube オブジェクトを使います。


TCustomDataStore プロパティ3122002

TCustomDataStore	アルファベット順	凡例

TCustomDataStore

BinData

Capacity

CurrentSummary

DataSet

DimensionCount

DimensionMap

DimensionMapCount

MaxCells

MaxDimensions

MaxSummaries

ShowProgressDialog

SummaryCount

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TCustomDataStore プロパティ3122003

TCustomDataStore	オブジェクト順	凡例

BinData

Capacity

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

CurrentSummary

DataSet

DesignInfo

DimensionCount

DimensionMap

DimensionMapCount

MaxCells

MaxDimensions

MaxSummaries

Name

Owner

ShowProgressDialog

SummaryCount

Tag

VCLComObject


TCustomDataStore.BinData
TCustomDataStore.BinData3122004

TCustomDataStore	参照

BinData プロパティは，多次元配列内のいずれかの次元にその次元に沿ったすべての値の集計値を格納するセルが含まれていないかどうかを示します。

property BinData: Boolean;

説明

BinData プロパティは，アクティブな次元のいずれかが範囲ごとにグループ化されているかどうか，またはページ状態（折り畳まれた状態）になっているかどうかを判別できます。BinData が True の場合，少なくとも 1 つの次元が複数の値の範囲に折りたたまれています。BinData が False の場合，データセットで表示される次元項目の各値のエントリがすべての次元に含まれています。


TCustomDataStore.Capacity
TCustomDataStore.Capacity3122005

TCustomDataStore	参照

Capacity プロパティは，集計値のキャッシュ配列に使うメモリを制限します。

property Capacity: Integer;

説明

Capacity プロパティを設定すると，クロス集計データ格納で集計値の多次元配列を格納するときに使うバイト数を制限できます。アクティブな次元および集計の数が多すぎるため，キャッシュするバイト数がこの値を超える場合には，ELowCapacityError が生成されます。


TCustomDataStore.CurrentSummary
TCustomDataStore.CurrentSummary3122006

TCustomDataStore	参照

CurrentSummary プロパティは，クロス集計データ格納で保守されるアクティブな集計の集合に含まれる現在の集計のインデックスです。

property CurrentSummary: Integer;

説明

CurrentSummary プロパティは，アクティブな集計のうち，どの集計からデータ格納のクライアントに値が提供されるかを特定できます。最初のアクティブな集計が現在の集計になっている場合には，CurrentSummary は 0 を返します。最後のアクティブな集計が現在の集計になっている場合には SummaryCount-1 を返します。

DataSet プロパティで指定されるデータセットは，次元マップの次元と集計を構成するすべての項目を提供します。データセットが提供するすべての次元および集計のサブセットは，常にクロス集計データ格納でキャッシュされ，デシジョンソースオブジェクトで利用できます。すべてのアクティブな（キャッシュされた）集計のうち，デシジョンソースオブジェクトに提供されるのは 1 度に 1 つだけです。その集計が現在の集計になります。


TCustomDataStore.DataSet
TCustomDataStore.DataSet3122007

TCustomDataStore	参照

DataSet プロパティは，クロス集計データ格納で保守される次元と集計を構成する項目を提供するデータセットです。

property DataSet: TDataSet;

説明

DataSet プロパティは，データ格納で処理されるクロス集計データがあるデータセットを設定します。通常，DataSet は TDecisionQuery オブジェクトです。TDecisionQuery オブジェクトは，クロス集計データ格納用の集計を計算するためにグループ化された SQL 問い合わせです。

DataSet プロパティには，TDecisionQuery と同じフォームの SQL を使う TQuery オブジェクト，または TDecisionQuery の問い合わせの結果と同じ構造で集計値を保持するデータセットを設定することもできます。

DataSet プロパティが TQuery オブジェクトまたは TDecisionQuery オブジェクトの場合，クロス集計データ格納はどの項目が次元でどの項目が集計かを自動的に決めます。DataSet プロパティが問い合わせでない場合，次元マップの項目は明示的に次元または集計として識別されなければなりません。また，項目が集計を表す場合は集計の型を指定しなければなりません。

注意

クロス集計データ格納の集計値は TDataSet オブジェクトが計算しなくてはなりません。データ格納では未使用のデータは集計されませんが，集計したデータは次元に分解されます。


TCustomDataStore.DimensionCount
TCustomDataStore.DimensionCount3122008

TCustomDataStore	参照

DimensionCount プロパティは，クロス集計データ格納でキャッシュされる次元の数です。

property DimensionCount: Integer;

説明

DimensionCount プロパティは，アクティブな次元の数を特定できます。DataSet プロパティで指定されるデータセットは，次元マップの次元と集計を構成する項目すべてを提供します。データセットが提供するすべての次元および集計のサブセットは，常にクロス集計データ格納でキャッシュされ，デシジョンソースオブジェクトで利用できます。DimensionCount は，デシジョンソースオブジェクトに提供されるアクティブな（キャッシュされた）次元の数です。


TCustomDataStore.DimensionMap
TCustomDataStore.DimensionMap3122009

TCustomDataStore	参照

DimensionMap プロパティは，クロス集計データ格納で保守される次元および集計を記述する TCubeDim オブジェクトの集合です。

property DimensionMap: TCubeDims;

説明

DimensionMap プロパティは，データ格納の次元および集計にアクセスできます。次元マップの個々のエントリは，DataSet プロパティで指定されるデータセットの項目，またはデータセットの項目から派生する計算項目を表します。DimensionMap は，クロス集計データ格納を構成するデータセットから，こうした項目について項目名や多次元配列内での項目の使い方などの情報を提供します。

データ格納がアクティブでない場合，TCubeDim オブジェクトのプロパティを使うと，データ格納でキャッシュされる情報を変更できます。個々の TCubeDim オブジェクトの ActiveType プロパティを使うと，データセットが提供する次元または集計をクロス集計データ格納でキャッシュするかどうかを指定できます。TCubeDim オブジェクトの BinType プロパティを使うと，一時次元に沿ったセルが日付の範囲を表したり，その次元をページ状態（折り畳まれた状態）にしたりできます。

データセットが問い合わせでない場合，TCubeDim オブジェクトの DimensionType プロパティを使うと，どの項目が次元でどの項目が集計かを識別するとともに，集計項目で表した集計の型を識別することができます。

データ格納がアクティブなときに次元マップのエントリのプロパティを変更するには，Refresh メソッドを使います。

注意

設計時には，次元マップを構成する TCubeDim オブジェクトの DimensionType，Name，ActiveType の 3 つのプロパティは，デシジョンキューブエディタを使って設定できます。


TCustomDataStore.DimensionMapCount
TCustomDataStore.DimensionMapCount3122010

TCustomDataStore	参照

DimensionMapCount プロパティは，次元マップの次元と集計を構成するデータセットの項目の総数です。

property DimensionMapCount:Integer;

説明

DimensionMapCount プロパティは，DimensionMap プロパティでアクセスできる TCubeDim オブジェクトの数を判別できます。DimensionMapCount の値は，DataSet プロパティで指定されるデータセットの項目数にデータセットの項目から派生した項目数（カウント項目と集計項目から派生する平均値の項目など）を加えた値です。

DimensionMapCount の値は DimensionCount と SummaryCount の値を加えたものではありません。DimensionCount と SummaryCount は，クロス集計データキューブによってキャッシュされ，デシジョンソースで利用可能な次元と集計の数をカウントします。DimensionMapCount は，キャッシュに格納されていない非アクティブな次元と集計もカウントします。


TCustomDataStore.MaxCells
TCustomDataStore.MaxCells3122011

TCustomDataStore	参照

MaxCells プロパティは，一度にキャッシュに入れるセルの数を制限します。

property MaxCells: Integer;

説明

MaxCells プロパティは，クロス集計データ格納で使用するメモリ量を制限できます。メモリ使用量は，多次元配列内にキャッシュする次元を 1 つ増やすごとに等比級数的に増加し，キャッシュする集計を 1 つ増やすと直線的に増加します。MaxCells は一度に多くの次元または集計がキャッシュされることを防ぎます。

次元または集計の ActiveType プロパティが diActive ならば，その次元または集計は必ずキャッシュに追加されます。次元または集計の ActiveType プロパティが diAsNeeded ならば，セルの数が MaxCells を超えない場合にのみキャッシュに追加されます。データ格納では，必要な次元および集計がデータソースで開かれたときに，それらをスワップインし，必要に応じて閉じている次元または現在使われていない集計をスワップアウトして空き領域を作ります。

注意

アクティブな次元と必要に応じて追加される次元のすべてを 1 度に開くことができるように MaxCells には大きい値を設定してください。


TCustomDataStore.MaxDimensions
TCustomDataStore.MaxDimensions3122012

TCustomDataStore	参照

MaxDimensions プロパティは，1 回のクロス集計データ格納でキャッシュできる次元の数を制限します。

property MaxDimensions: Integer;

説明

MaxDimensions プロパティは，データ格納で使われるメモリの容量を制限できます。メモリ使用量は，多次元配列にキャッシュされる次元を 1 つ増やすごとに等比級数的に増加します。MaxDimensions は 1 度に多くの次元がキャッシュされることを防ぎます。

次元の ActiveType プロパティが diActive の場合，その次元は必ずキャッシュに追加されます。次元の ActiveType プロパティが diAsNeeded の場合，その次元は，新たに次元を追加してもアクティブな次元の数が MaxDimensions を超えない場合にのみ追加されます。データ格納では，必要な次元がデシジョンソースで開かれたときに，それらの次元をスワップインし，必要なら閉じられた次元をスワップアウトして空き領域を作ります。

注意

アクティブな次元と必要に応じて追加される次元のすべてを 1 度に開くことができるように，MaxDimensions には大きい値を設定してください。


TCustomDataStore.MaxSummaries
TCustomDataStore.MaxSummaries3122013

TCustomDataStore	参照

MaxSummaries プロパティは，1 回のクロス集計データ格納でキャッシュできる集計の数を制限します。

property MaxSummaries: Integer;

説明

MaxSummaries プロパティは，データ格納で使われるメモリの容量を制限できます。メモリ使用量は，多次元配列にキャッシュされる集計を 1 つ増やすごとに直線的に増加します。MaxSummaries は 1 度に多くの集計がキャッシュされることを防ぎます。

集計の ActiveType プロパティが diActive の場合，その集計は必ずキャッシュに追加されます。ActiveType プロパティが diAsNeeded の場合，その集計は，新たに集計を追加してもアクティブな集計の数が MaxSummaries を超えない場合にのみ追加されます。データ格納では，必要な集計が現在の集計として選択されたときに，それらの集計をスワップインし，必要なら，そのほかに必要に応じて追加される集計をスワップアウトして空き領域を作ります。


TCustomDataStore.ShowProgressDialog
TCustomDataStore.ShowProgressDialog3122014

TCustomDataStore	参照

ShowProgressDialog プロパティは，クロス集計値のキャッシュが作成されるときにプログレスバーを表示するかどうかを決めます。

property ShowProgressDialog: Boolean;

説明

ShowProgressDialog プロパティを設定すると，キャッシュ作成状況を示すためにプログレスバーを表示するかどうかを指定できます。クロス集計データ格納に次元が含まれる場合，キャッシュを再作成するとかなりの時間がかかることがあります。プログレスバーはこの処理にどれくらい時間がかかるかを示します。


TCustomDataStore.SummaryCount
TCustomDataStore.SummaryCount3122015

TCustomDataStore	参照

SummaryCount プロパティは，クロス集計データ格納にキャッシュされる集計項目の数です。

property SummaryCount: Integer;

説明

SummaryCount プロパティは，次元マップ内のアクティブな集計の数を特定できます。DataSet プロパティで指定されるデータセットは，次元マップの次元および集計を構成するすべての項目を提供します。データセットが提供するすべての次元および集計のサブセットは，常にクロス集計データ格納でキャッシュされ，デシジョンソースオブジェクトで利用できます。SummaryCount は，デシジョンソースオブジェクトにデータを提供できるアクティブな（キャッシュされた）集計の数です。


TCustomDataStore イベント3122016

TCustomDataStore	アルファベット順

TCustomDataStore

AfterClose

AfterOpen

BeforeClose

BeforeOpen

OnLowCapacity

OnRefresh


TCustomDataStore イベント3122017

TCustomDataStore	オブジェクト順

AfterClose

AfterOpen

BeforeClose

BeforeOpen

OnLowCapacity

OnRefresh


TCustomDataStore.AfterClose
TCustomDataStore.AfterClose3122018

TCustomDataStore	参照

AfterClose イベントは，クロス集計データ格納が非アクティブにされた直後に発生します。

TCubeNotifyEvent = procedure(DataCube: TCustomDataStore) of object;

property AfterClose: TCubeNotifyEvent;

説明

AfterClose イベントハンドラを記述すると，クロス集計データ格納が終了したときに特定のアクションを実行できます。たとえば，アプリケーションではデータ格納の状態について情報をフィードバックしたり，次にデータ格納がアクティブになったときのために次元マップを更新したりできます。


TCustomDataStore.AfterOpen
TCustomDataStore.AfterOpen3122019

TCustomDataStore	参照

AfterOpen イベントは，クロス集計データ格納がアクティブになった直後に発生します。

TCubeNotifyEvent = procedure(DataCube: TCustomDataStore) of object;

property AfterOpen: TCubeNotifyEvent;

説明

AfterOpen イベントハンドラを記述すると，クロス集計データ格納がアクティブになったときに特定のアクションを実行できます。このイベントは，データセットで保守される多次元キャッシュがどれだけのメモリを使用するかを決める最初の機会です。


TCustomDataStore.BeforeClose
TCustomDataStore.BeforeClose3122020

TCustomDataStore	参照

BeforeClose イベントは，クロス集計データ格納が非アクティブになる直前に発生します。

TCubeNotifyEvent = procedure(DataCube: TCustomDataStore) of object;

property BeforeClose: TCubeNotifyEvent;

説明

BeforeClose イベントハンドラを記述すると，データ格納が終了する直前に特定のアクションを実行できます。たとえばアプリケーションでは，キャッシュがクリアされ関連付けられたメモリがすべて解放される前に，キャッシュの現在の状態についての情報を保存できます。


TCustomDataStore.BeforeOpen
TCustomDataStore.BeforeOpen3122021

TCustomDataStore	参照

BeforeOpen イベントは，データ格納がアクティブになる直前に発生します。

TCubeNotifyEvent = procedure(DataCube: TCustomDataStore) of object;

property BeforeOpen: TCubeNotifyEvent;

説明

BeforeOpen イベントハンドラを記述すると，クロス集計データ格納がアクティブになる直前に特定のアクションを実行できます。このイベントが発生したときに，Capacity の値を調整したり，DimensionMap のアクティブな次元の数に基づいて ShowProgressDialog を設定したりします。

BeforeOpen イベントは，キャッシュが作成される前に DimensionMap 内のエントリを調整する最後の機会です。データ格納がそれまでアクティブになったことがない場合，DimensionMap プロパティはこの時点で nil になります。BeforeOpen イベントハンドラは，次元マップが nil の場合に次元マップをプログラムで作成できます。次元マップが nil でない場合，次元項目のプロパティを変更できますが，次元項目の順序と項目数は変更しないでください。


TCustomDataStore.OnLowCapacity
TCustomDataStore.OnLowCapacity3122022

TCustomDataStore	参照

OnLowCapacity イベントは，多次元キャッシュが Capacity プロパティで割り当てられた以上のメモリを必要とするときに発生します。

TErrorAction = ( eaFail, eaContinue );

TCapacityErrorEvent = procedure(var Action: TErrorAction) of object;

property OnLowCapacity: TCapacityErrorEvent;

説明

OnLowCapacity イベントハンドラを記述すると ELowCapacityError 例外に応答できます。OnLowCapacity イベントハンドラは，キャッシュのサイズが使用可能なメモリ容量と合うように Capacity の値を変更したり，次元マップの次元を非アクティブ化したりできます。OnLowCapacity イベントハンドラがメモリ容量の問題を処理する場合は，データ格納でキャッシュの作成を続けられるように Action パラメータを eaContinue に変更してください。変更しないと ELowCapacityError 例外が生成されます。


TCustomDataStore.OnRefresh
TCustomDataStore.OnRefresh3122023

TCustomDataStore	参照

OnRefresh イベントは，次元マップが変更される直前に発生します。

TCubeRefreshEvent = procedure(DataCube: TCustomDataStore; DimMap: TCubeDims)

    of object;

property OnRefresh: TCubeRefreshEvent;

説明

OnRefresh イベントハンドラを記述すると，次元マップが変更されるときに特定のアクションを実行できます。DimMap パラメータは DimensionMap プロパティに新しく設定される値を指定します。OnRefresh イベントハンドラを使うと DimensionMap プロパティが設定され，キャッシュが再作成される前に次元項目のプロパティを変更できます。このとき，設定されようとしている次元マップに合うように MaxDimensions プロパティまたは MaxSummaries プロパティを再設定することもできます。


TCustomDataStore メソッド3122024

TCustomDataStore	アルファベット順

TCustomDataStore

CalcsubTotals

Create

Destroy

GetDimensionMemberCount

GetDimensionName

GetMemberAsString

GetMemberAsVariant

GetMemoryUsage

GetSummaryAsString

GetSummaryAsVariant

GetSummaryName

Refresh

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TCustomDataStore メソッド3122025

TCustomDataStore	オブジェクト順

Assign

CalcsubTotals

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetDimensionMemberCount

GetDimensionName

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetMemberAsString

GetMemberAsVariant

GetMemoryUsage

GetNamePath

GetParentComponent

GetSummaryAsString

GetSummaryAsVariant

GetSummaryName

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

Refresh

RemoveComponent

SafeCallException


TCustomDataStore.Create
TCustomDataStore.Create3122026

TCustomDataStore	参照

Create メソッドは，TCustomDataStore のインスタンスを作成します。

constructor Create( AOwner: TComponent ); override;

説明

Create を呼び出すと，実行時に TCustomDataStore のインスタンスを作成できます。Create は，次元マップおよびクロス集計したデータを管理するためにクロス集計データ格納で使うヘルパーオブジェクトを割り当てます。


TCustomDataStore.Destroy
TCustomDataStore.Destroy3122027

TCustomDataStore	参照

Destroy メソッドは，TCustomDataStore のインスタンスを破棄します。

destructor Destroy; override;

説明

Destroy メソッドは直接呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはデシジョンキューブに割り当てたメモリが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。


TCustomDataStore.GetDimensionMemberCount
TCustomDataStore.GetDimensionMemberCount3122028

TCustomDataStore	参照

GetDimensionMemberCount メソッドは，データ格納の次元に含まれる個々の値の数を返します。

function GetDimensionMemberCount( Dimension: Integer ): Integer; virtual;

説明

GetDimensionMemberCount を呼び出すと，Dimension パラメータで指定される次元にある個々の項目値の数を判別できます。0 は最初のアクティブな次元を指定し，DimensionCount-1 は最後のアクティブな次元を指定します。

次元の個々の値を取得するには，GetMemberAsString メソッドまたは GetMemberAsVariant メソッドを使います。GetDimensionMemberCount は，GetMemberAsString メソッドまたは GetMemberAsVariant メソッドの Index パラメータの上限となる値を返します。

Dimension パラメータで参照される次元の名前を取得するには，GetDimensionName メソッドを使います。


TCustomDataStore.GetDimensionName
TCustomDataStore.GetDimensionName3122029

TCustomDataStore	参照

GetDimensionName メソッドは，アクティブな次元の名前を返します。

function GetDimensionName( Dimension: Integer ): String; virtual;

説明

GetDimensionName を呼び出すと，Dimension パラメータでインデックス付けされる次元の名前を取得できます。0 は最初のアクティブな次元を指定し，DimensionCount-1 は最後のアクティブな次元を指定します。次元に対応する TDimensionItem の Name プロパティが変更されていない限り，次元の名前はその次元が表すデータベース項目の名前です。


TCustomDataStore.GetMemberAsString
TCustomDataStore.GetMemberAsString3122030

TCustomDataStore	参照

GetMemberAsString メソッドは，データ格納の次元から，文字列として形式設定された指定の値を返します。

function GetMemberAsString( Dimension, Index: Integer ): String; virtual;

説明

GetMemberAsString を呼び出すと，Dimension パラメータで指定される次元から値を取り出すことができます。0 は最初の次元を指定し，DimensionCount-1 は最後の次元を指定します。Index パラメータは，0 を起点として次元のどの値を返すかを示します。GetDimensionMemberCount は次元に含まれる値の数を返します。

GetMemberAsString は文字列として形式設定された項目値を返します。形式設定されていないバリアントとして項目値を取得するには，GetMemberAsVariant メソッドを使います。


TCustomDataStore.GetMemberAsVariant
TCustomDataStore.GetMemberAsVariant3122031

TCustomDataStore	参照

GetMemberAsVariant メソッドは，クロス集計データ格納の次元から指定の値を返します。

function GetMemberAsVariant( Dimension, Index: Integer ): Variant;

説明

GetMemberAsVariant を呼び出すと，Dimension パラメータで指定される次元から値を取り出すことができます。0 は最初の次元を指定し，DimensionCount-1 は最後の次元を指定します。Index パラメータは，0 を起点として次元のどの値を返すかを示します。GetDimensionMemberCount は次元に含まれる値の数を返します。


TCustomDataStore.GetMemoryUsage
TCustomDataStore.GetMemoryUsage3122032

TCustomDataStore	参照

GetMemoryUsage メソッドは，すべてのアクティブな次元に含まれる集計の多次元配列をキャッシュするために使うメモリのバイト数を返します。

function GetMemoryUsage: Integer;

説明

GetMemoryUsage を呼び出すと，データ格納用にクロス集計情報を保存するキャッシュのサイズを特定できます。戻り値が大きすぎる場合には，BinType プロパティを binSet に設定してアクティブな次元の一部をページングするか，ActiveType プロパティを diAsNeeded に設定してデータ格納が次元の一部をスワップアウトできるようにすることを考えてください。キューブ次元には DimensionMap プロパティを使ってアクセスできます。

アクティブな次元を追加するたびに，必要なクロス集計データ格納の記憶領域は等比級数的に増大します。アプリケーションでは，デシジョンコントロールですぐに利用できるようにするために次元を多くキャッシュする利点とメモリ使用が過大にならないようにアクティブな次元を少なくしておくこととを比較検討しなければなりません。


TCustomDataStore.GetSummaryAsString
TCustomDataStore.GetSummaryAsString3122033

TCustomDataStore	参照

GetSummaryAsString メソッドは，すべてのアクティブな次元に含まれる値のセットの現在の集計値を返します。

function GetSummaryAsString( Coord: TSmallIntArray ): String; virtual;

説明

GetSummaryAsString を呼び出すと，集計値の多次元配列から 1 つのセルの値を取得できます。Coord パラメータにはインデックスの配列を設定します。各インデックスは配列の次元の 1 つにある値を識別します。Coord の最初の値は最初のアクティブな次元にある必要な値のインデックスを指定し，Coord の 2 番目の値は 2 番目のアクティブな次元にある必要な値のインデックスを指定するといった具合になります。Coord には DimensionCount の値が入っていなければなりません。

Coord パラメータのエントリに対応するアクティブな次元の名前を取得するには，GetDimensionName メソッドを使います。いずれかの次元から指定した値の名前を取得するには，GetMemberAsString メソッドを使います。

GetSummaryAsString は集計値を文字列として形式設定します。集計をバリアントとして取得するには，GetSummaryAsVariant メソッドを使ってください。


TCustomDataStore.GetSummaryAsVariant
TCustomDataStore.GetSummaryAsVariant3122034

TCustomDataStore	参照

GetSummaryAsVariant メソッドは，すべてのアクティブな次元に含まれる値のセットの現在の集計値を返します。

function GetSummaryAsVariant( Coord: TSmallIntArray ): Variant; virtual;

説明

GetSummaryAsVariant を呼び出すと，集計値の多次元配列から 1 つのセルの値を取得できます。Coord パラメータにはインデックスの配列を設定します。各インデックスは配列の次元の 1 つにある値を識別します。Coord の最初の値は最初のアクティブな次元にある必要な値のインデックスを指定し，Coord の 2 番目の値は 2 番目のアクティブな次元にある必要な値のインデックスを指定するといった具合になります。Coord には DimensionCount の値が入っていなければなりません。

Coord パラメータのエントリに対応するアクティブな次元の名前を取得するには，GetDimensionName メソッドを使います。いずれかの次元から指定した値の名前を取得するには，GetMemberAsString メソッドを使います。

文字列として形式設定された集計を取得するには，GetSummaryAsString メソッドを使ってください。


TCustomDataStore.GetSummaryName
TCustomDataStore.GetSummaryName3122035

TCustomDataStore	参照

GetSummaryName メソッドは，アクティブな集計の名前を返します。

function GetSummaryName( ISum: Integer ): String; virtual;

説明

GetSummaryName を呼び出すと，ISum パラメータで指定される集計の名前を取得できます。0 は最初のアクティブな集計を指定し，SummaryCount-1 は最後のアクティブな集計を指定します。


TCustomDataStore.Refresh
TCustomDataStore.Refresh3122036

TCustomDataStore	参照

Refresh メソッドは，クロス集計データ格納の次元マップを更新します。

function Refresh( DimensionMap : TCubeDims; bForce: Boolean): Boolean;

説明

次元マップ内の次元のプロパティを変更するには，DimensionMap プロパティをコピーして TCubeDim オブジェクトのプロパティに対して必要な変更を行ってから，Refresh を呼び出して変更後の次元マップに渡します。bForce パラメータはキャッシュを無条件で再作成するかどうかを指定します。bForce が False の場合，キャッシュは，変更によって必要とならない限り，再作成されません。

データ格納がアクティブなときは，直接次元マップを変更しないで Refresh を呼び出してください。データ格納でキャッシュを作成中に Refresh を呼び出さないでください。BeforeOpen イベントと AfterOpen イベントを使うと，いつキャッシュが再作成されるかがわかります。


スコープ3122037

published

読み出し／書き込み

読み出し専用


継承3122038

TObject

TPersistent

TComponent


TCustomDataStore 例3122039

TCustomDataStore


TDateField
TDateField3123001

継承	プロパティ	メソッド	イベント	参照

TDateField オブジェクトは，データセット内の日付型項目を表します。

ユニット

db

説明

日付型項目は日付の値を含んでいます。

TDateField オブジェクトは，新しいプロパティ，イベント，およびメソッドは導入しません。このオブジェクトは DataSize プロパティと Create メソッドをオーバーライドして，ftDate 型の項目の詳細を反映します。


TDateField プロパティ3123002

TDateField	アルファベット順	凡例

TDateTimeField からの継承

AsDateTime

AsFloat

AsString

AsVariant

DisplayFormat

Value

TField からの継承

Alignment

AsBoolean

AsCurrency

AsInteger

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDateField プロパティ3123003

TDateField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayFormat

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


DataSize

DataSize プロパティは，ネイティブデータベース形式で日付項目の値を格納するときに必要なメモリ容量です。

property DataSize: Word;

説明

DataSize プロパティは，日付項目コンポーネントの値を格納するときに必要なバイト数を取得できます。GetData メソッドおよび SetData メソッドを処理するときに必要なバッファサイズを決めることができます。

日付項目の場合，DataSize は常に 4 です。この値はデータベーステーブルの日付値のサイズであり，TDateField で指定される日付値を格納および操作するための TDateTime データ型のサイズではありません。


TDateField イベント3123005

TDateField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TDateField イベント3123006

TDateField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TDateField メソッド3123007

TDateField	アルファベット順

TDateField

Create

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDateField メソッド3123008

TDateField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TDateField.Create
TDateField.Create3123009

TDateField	参照

Create メソッドは TDateField のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出すと，TDateField のインスタンスを作成および初期化できます。継承コンストラクタを呼び出した後で，Create は DataType プロパティの値を ftDate に設定します。

Create を直接呼び出す必要はほとんどありません。データセット内のすべての日付型項目について，日付型項目オブジェクトは自動的にインスタンス化されるからです。


スコープ3123010

published

読み出し／書き込み

読み出し専用


スコープ3123011

published


継承3123012

TObject

TPersistent

TComponent

TField

TDateTimeField


TDateField 例3123013

TDateField


TDateTimeField
TDateTimeField3124001

継承	プロパティ	メソッド	イベント	参照	例

TDateTimeField オブジェクトはデータセットの日付時刻型項目を表します。

ユニット

db

説明

日付時刻型項目は，日付と時刻から構成される，タイムスタンプと呼ばれることもある情報を表します。

TDateTimeField オブジェクトは，日付時刻の値と他のデータ形式の間の変換を行うプロパティ，および日付時刻の値の表示形式を決めるプロパティを新しく導入します。TField の派生オブジェクトとして，TDateTimeField オブジェクトはデータベース内の項目の値およびプロパティの管理に便利なプロパティ，メソッド，およびプロパティを数多く用意します。

他の 2 つの時間項目型 TDateField および TTimeField は，TDateTimeField オブジェクトを継承しています。


TDateTimeField プロパティ3124002

TDateTimeField	アルファベット順	凡例

TDateTimeField

AsDateTime

AsFloat

AsString

AsVariant

DisplayFormat

Value

TField からの継承

Alignment

AsBoolean

AsCurrency

AsInteger

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDateTimeField プロパティ3124003

TDateTimeField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayFormat

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TDateTimeField.AsDateTime
TDateTimeField.AsDateTime3124004

TDateTimeField	参照

AsDateTime プロパティは，日付時刻型項目の値を日付時刻の値に変換したり，その逆の変換をしたりします。

property AsDateTime: TDateTime;

説明

AsDateTime プロパティは次の処理に使います。

・	日付時刻の値を日付時刻型項目に代入

・	日付時刻型項目の値を日付時刻変数に代入

日付時刻の値の時刻部分は，DateType プロパティの値が ftDate である項目の AsDateTime プロパティを設定するときには無視されます。日付時刻の値の日付部分は，DataType プロパティの値が ftTime である項目の AsDateTime プロパティを設定するときには無視されます。

同様に，DataType プロパティの値が ftDate である項目の AsDateTime プロパティは，項目の値は当日の午前 12:00 時になります。DataType プロパティの値が ftTime である項目の AsDateTime プロパティは，項目の値は西暦 1899 年 12 月 30 日の現在時刻になります。

DataType プロパティの値が ftDateTime である項目の AsDateTime プロパティを取得および設定した場合，項目の値は当日の現在時刻になります。

AsDateTime プロパティは，TDateTime 型オブジェクトに保存されている日付時刻の値を使います。TDateTime の値の整数部分は，西暦 1899 年 12 月 30 日からの経過日数を示します。TDateTime の小数部分が，経過時間の 1 日 (24 時間) に対する百分率を示します。

以下に TDateTime の値とそれに対応する日付および時刻の例を示します。

値	日付および時刻

0	 1899 年 12 月 30 日 午前 12:00

2.75	-1900 年 1 月 1 日 午後 6:00

-1.25	 1899 年 12 29 日 午前 6:00

35065	-1996 年 1 月 1 日 午前 12:00

2 つの日付の間の日数を求めるには，両日付の値で減算します。同様に，日付および時刻を進めるには，目的の日数，および時刻の百分率を値に加算します。

注意

TDateTimeField オブジェクトは日付および時刻を TDateTime 型オブジェクトに保存するので，AsDateTime プロパティの値は日付時刻型項目の Value プロパティと同じになります。オブジェクトの実際のクラスが不明の項目コンポーネントを扱うときには，AsDateTime を使用してください。


TDateTimeField.AsFloat
TDateTimeField.AsFloat3124005

TDateTimeField	参照

AsFloat プロパティは，日付時刻型項目の値を浮動小数点値に変換したり，その逆の変換をしたりします。

property AsFloat: Double;

説明

AsFloat プロパティは次の処理に使います。

・	浮動小数点値を日付時刻型項目に代入

・	日付時刻型項目の値に浮動小数点変数を代入

次のコードは浮動小数点値を日付時刻型項目の値に代入します。

MyDateTimeField.AsFloat := 35065.75;  { A date and time of of Jan 1, 1996 6:00 p.m. }

日付時刻型項目の値を浮動小数点値に代入するには，次のようなコードを使います。

FloatVariable := MyDateTimeField.AsFloat;

TDateTimeField オブジェクトは，日付を西暦 1899 年 12 月 30 日からの経過日数に変換します。時刻の値は 1 日を 24 時間とした場合の経過時間の百分率に変換されます。日付時刻量を表す浮動小数点値は，変換された日付および時刻の値の合計です。

浮動小数点値の小数 (時刻) 部分は，DataType プロパティの値が ftDate である AsFloat プロパティを設定する際には無視されます。浮動小数点値の整数 (日付) 部分は，DataType プロパティの値が ftTime である AsFloat プロパティを設定する際には無視されます。

同様に，DataType プロパティの値が ftDate である項目の AsFloat プロパティを読み出すと，小数 (時刻) 部分のない浮動小数点値が生成されます。 DataType プロパティの値が ftTime である項目の AsFloat プロパティは，-1 よりも大きく 1 よりも小さい浮動小数点値 (小数のみの浮動小数点値) が生成されます。


TDateTimeField.AsString
TDateTimeField.AsString3124006

TDateTimeField	参照

AsString プロパティは，日付時刻型項目の値を文字列に変換したり，その逆の変換をしたりします。

property AsString: string;

説明

AsString プロパティは次の処理に使います。

・	文字列を日付時刻型項目に代入

・	日付時刻型項目の値を文字列に代入

次のコードは文字列を日付時刻型項目の値に代入します。

MyDateTimeField.AsString := �1/1/1997 8:00 am�;

日付時刻型項目の値を文字列変数に代入するには，次のようなコードを使います。

StringVariable := MyDateTimeField.AsString;

日付時刻型項目の DataType プロパティの値が ftDate である場合，AsString プロパティを設定するには StrToDate 関数を使用して文字列を日付の値に変換します。DataType プロパティの値が ftTime である場合，AsString プロパティを設定するには StrToTime 関数を使用します。DataType プロパティが ftDateTime の場合，AsString プロパティを設定するには StrToDateTime 関数を使います。

DisplayFormat プロパティが設定されている場合，AsString プロパティは，日付時刻型項目の値の形式が DisplayFormat プロパティに合せて設定されます。DisplayFormat プロパティが設定されていない場合，AsString プロパティは，日付時刻型項目の値の形式は Windows のコントロールパネルの設定にしたがいます。


TDateTimeField.AsVariant
TDateTimeField.AsVariant3124007

TDateTimeField	参照

AsVariant プロパティは，日付時刻型項目の値をバリアント値に変換したり，その逆の変換をしたりします。

property AsVariant: Variant;

説明

AsVariant プロパティは次の処理に使います。

・	日付時刻型項目の値をバリアント変数に代入

・	バリアント値を日付時刻型項目に代入

バリアントは，項目およびデータの型が不明のときに便利です。


DataSize

DataSize プロパティは，ネイティブデータベース形式で日付時刻型項目の値を格納するときに必要なメモリ容量です。

property DataSize: Word;

説明

DataSize プロパティは，日付時刻型項目コンポーネントの値を格納するときに必要なバイト数を取得できます。GetData メソッドおよび SetData メソッドを処理するときに必要なバッファサイズを決めることができます。

日付時刻型項目の場合，DataSize は常に 8 です。


TDateTimeField.DisplayFormat
TDateTimeField.DisplayFormat3124009

TDateTimeField	参照

DisplayFormat プロパティは日付時刻型項目の自動表示形式をオーバーライドして表示形式を指定する文字列を含みます。

property DisplayFormat: string;

説明

DisplayFormat プロパティは，日付時刻型項目の値が文字列として表示されるときに使用される形式指定子を指定します。

DisplayFormat プロパティに文字列が割り当てられていない場合，値は Windows のコントロールパネルの設定にしたがって表示されます。

DisplayFormat 文字列は以下の形式指定子を使って指定します。

指定子	表示

aaa	曜日を日本語の省略形（日-土）で表示する

aaaa	曜日を日本語（日曜日-土曜日）で表示する

c	ShortDateFormat グローバル変数で指定された形式の日付の後に，LongTimeFormat グローバル変数で指定された形式の時刻が続く。DateTime 値の小数部分がゼロの場合，時刻は表示されない

d	日付を先頭のゼロなしで表示する（1 から 31 まで）

dd	日付を先頭のゼロも含めて表示する（01 から31 まで）

ddd	ShortDayNames グローバル変数で与えられた文字列を使って，曜日を省略形（日-土）で表示する

dddd	LongDayNames グローバル変数で与えられた文字列を使って，曜日を完全形（日曜日-土曜日）で表示する

ddddd	ShortDateFormat グローバル変数で与えられた形式で日付を表示する

dddddd	LongDateFormat グローバル変数で与えられた形式で日付を表示する

e	元号に基づく和暦の年を 0 を付けずに表示する（1995 年ならば 7）

ee	元号に基づく和暦の年を 2 桁で表示する（1995 年ならば 07）

g	元号の先頭 1 文字を表示する（名，大，昭，平）。2.0 では英字で表現された先頭 1 文字でしたが，このバージョンで変更されています

gg	元号を表示する（明治，大正，昭和，平成）。2.0 では元号の先頭 1 文字を表しましたが，このバージョンで変更されています

ggg	元号を表示する（明治，大正，昭和，平成）

m	先頭にゼロのない数字（1-12）として月を表示する。h または hh 指定子の直後に m 指定子を指定すると，月ではなく分が表示される

mm	先頭にゼロのある数字（01-12）として月を表示する。h または hh 指定子の直後に mm 指定子を指定すると，月ではなく分が表示される

mmm	ShortMonthNames グローバル変数で与えられた文字列を使って，月を省略形（1-12）で表示する

mmmm	LongMonthNames グローバル変数で与えられた文字列を使って，月を完全形（1 月-12 月）で表示する

yy	年を 2 桁の数字（00-99）で表示する

yyyy	年を 4 桁の数字（(0000-9999）で表示する

h	先頭にゼロのない数字（0-23）として時を表示する

hh	先頭にゼロのある数字（00-23）として時を表示する

n	先頭にゼロのない数字（0-59）として分を表示する

nn	先頭にゼロのある数字（00-59）として分を表示する

s	先頭にゼロのない数字（0-59）として秒を表示する

ss	先頭にゼロのある数字（00-59）として秒を表示する

t	ShortTimeFormat グローバル変数で与えられた形式で時刻を表示する

tt	LongTimeFormat グローバル変数で与えられた形式で時刻を表示する

am/pm	先行する h または hh 指定子に 12 時間形式の時刻値を使い，正午以前の時間には am を，正午以降の時間には pm を表示する。am/pm 指定子には，大文字，小文字，大文字と小文字の両方が使え，指定のとおりに結果が表示される

a/p	先行する h または hh 指定子に 12 時間形式の時刻値を使い，正午以前の時間には a を，正午以降の時間には p を表示する。a/p 指定子には，大文字，小文字，大文字と小文字の両方が使え，指定のとおりに結果が表示される

ampm	先行する h または hh 指定子に 12 時間形式の時刻値を使い，正午以前の時間には TimeAMString グローバル変数の値を，正午以降の時間には TimePMString グローバル変数の値を表示する

/	DateSeparator グローバル変数で与えられた日付区切り文字を表示する

:	TimeSeparator グローバルへ数で与えられた時刻区切り文字を表示する

'xx'/"xx"	一重または二重の引用不で囲まれた文字はそのまま表示され，形式には影響を与えない

形式指定子は，小文字で書いても大文字で書いても同じです。

Format パラメータで与えられる文字列が空の場合，日付および時刻の値は c 形式指定子が与えられたものとして設定されます。


TDateTimeField.Value
TDateTimeField.Value3124010

TDateTimeField	参照

Value プロパティは，日付時刻型項目の値です。

property Value: TDateTime;

説明

Value プロパティは，実行時に日付時刻項目コンポーネントとの間でデータを直接読み書きできます。TDateTimeField オブジェクトのコンポーネントはデータを TDateTime の値として保存および操作します。日付時刻型項目では，Value プロパティは AsDateTime プロパティと同じです。


TDateTimeField イベント3124011

TDateTimeField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TDateTimeField イベント3124012

TDateTimeField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TDateTimeField メソッド3124013

TDateTimeField	アルファベット順

TDateTimeField

Create

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDateTimeField メソッド3124014

TDateTimeField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TDateTimeField.Create
TDateTimeField.Create3124015

TDateTimeField	参照

Create メソッドは，TDateTimeField オブジェクトをインスタンス化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，TDateTimeField オブジェクトのインスタンスを作成および初期化できます。継承コンストラクタを呼び出した後で，Create メソッドは DataType プロパティの値を ftDateTime に設定します。

Create メソッドを直接呼び出す必要はほとんどありません。日付時刻型項目オブジェクトはデータセット内の日付時刻型項目ごとに自動的にインスタンス化されるからです。


スコープ3124016

published

読み出し／書き込み

読み出し専用


スコープ3124017

published


継承3124018

TObject

TPersistent

TComponent

TField


TDateTimeField 例3124019

TDateTimeField


TDataSourceLink
TDataSourceLink3125001

継承	プロパティ	メソッド	参照

TDataSourceLink は，TDBLookupControl オブジェクトの DataSource へのリンクを管理するヘルパーオブジェクトです。

ユニット

dbctrls

説明

TDataSourceLink は，TDBLookupControl と組み合わせて機能するように設計されています。TDBLookupControl クラスのみが使用できるヘルパーオブジェクトです。


TDataSourceLink プロパティ3125002

TDataSourceLink	アルファベット順	凡例

TDataLink からの継承

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


TDataSourceLink プロパティ3125003

TDataSourceLink	オブジェクト順	凡例

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


TDataSourceLink メソッド3125004

TDataSourceLink	アルファベット順	凡例

TDataSourceLink

ActiveChanged

FocusControl

RecordChanged

TDataLink からの継承

Create

Destroy

Edit

UpdateRecord

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDataSourceLink メソッド3125005

TDataSourceLink	オブジェクト順	凡例

ActiveChanged

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

Edit

FieldAddress

FocusControl

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RecordChanged

SafeCallException

UpdateRecord


TDataSourceLink.ActiveChanged
TDataSourceLink.ActiveChanged3125006

TDataSourceLink	参照

ActiveChanged メソッドは，TDBLookupControl に DataSource の Active プロパティの変更を通知します。

procedure ActiveChanged; override;

説明

アプリケーションから ActiveChanged 手続きを直接呼び出すことはできません。Active プロパティが変更されたときに，ActiveChanged 手続きが呼び出されます。Active プロパティが True になったとき，ActiveChanged は，TDBLookupControl オブジェクトは DataField プロパティを再取得させます。このため，参照コントロールが正しい項目コンポーネントを使うことが保証されます。


TDataSourceLink.FocusControl
TDataSourceLink.FocusControl3125007

TDataSourceLink	参照

FocusControl メソッドは，TDBLookupControl オブジェクトのデータ項目に入力フォーカスを移動します。

procedure FocusControl(Field: TFieldRef); override;

説明

アプリケーションから FocusControl 手続きを呼び出すことはできません。FocusControl は，DataSet 内の項目コンポーネントが項目を表すフォーム上のコントロールにフォーカスを設定しようとしたときに自動的に呼び出されます。FocusControl は，Field パラメータが一致した場合，フォーカスを TDBLookupControl の DataField に移動します。


TDataSourceLink.RecordChanged
TDataSourceLink.RecordChanged3125008

TDataSourceLink	参照

RecordChanged メソッドは，DataSource の現在のレコードまたは項目が変更されたことを TDBLookupControl に通知します。

procedure RecordChanged(Field: TField); override;

説明

アプリケーションから RecordChanged を直接呼び出すことはできません。現在のレコードの内容が変更されたときに，RecordChanged が自動的に呼び出されます。Field パラメータが参照コントロールのキー項目である場合，または Field パラメータがレコード全体の変更を示す nil である場合は，RecordChanged は，参照コントロールはキー項目の値を再度取り出させます。


読み出し／書き込み3125009

読み出し専用


スコープ3125010

protected


継承3125011

TObject

TPersistent

TDataLink


TDataSourceLink 例3125012

TDataSourceLink


TDBCheckBox
TDBCheckBox3126001

継承	プロパティ	メソッド	イベント	参照

TDBCheckBox コントロールは，ユーザーが選択または選択を解除できるようにするデータベース対応コントロールです。

ユニット

dbctrls

説明

TDBCheckBox を使うとデータベース対応チェックボックスをフォームに配置できます。チェックボックスはユーザーにオプションを提供し，ユーザーはチェックボックスにチェックマークを付けてオプションを選択したり，チェックマークをはずして選択を解除できます。データベースチェックボックス（TDBCheckBox）は通常のチェックボックス（TCheckBox）によく似ていますが，データセットの特定の項目のデータを参照する点が違います。チェックボックスは 2 つの状態（選択されているか選択を解除されているか）しか表せないので，データベースチェックボックスは論理項目に適しています。

TDBCheckBox のデータベース対応機能が必要でないアプリケーションの場合は，TCheckBox を使うとシステムリソースを節約できます。


TDBCheckBox プロパティ3126002

TDBCheckBox	アルファベット順	凡例

TDBCheckBox

DataField

DataSource

Field

ReadOnly

ValueChecked

ValueUnchecked

TCustomCheckBox からの継承

Alignment

AllowGrayed

Checked

State

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBCheckBox プロパティ3126003

TDBCheckBox	オブジェクト順	凡例

Align

Alignment

AllowGrayed

BoundsRect

Brush

Caption

Checked

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DataField

DataSource

DesignInfo

DragCursor

DragMode

Enabled

Field

Font

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ReadOnly

ShowHint

Showing

State

TabOrder

TabStop

Tag

Top

ValueChecked

ValueUnchecked

VCLComObject

Visible

Width

WindowProc


TDBCheckBox.DataField
TDBCheckBox.DataField3126004

TDBCheckBox	参照

DataField プロパティは，データベース対応コントロールがどの項目からデータを表示するかを指定します。

property DataField: string;

説明

DataField プロパティはチェックボックスが表す項目コンポーネントの項目名に設定します。表示する項目があるデータセットは DataSource プロパティで指定します。


TDBCheckBox.DataSource
TDBCheckBox.DataSource3126005

TDBCheckBox	参照

DataSource プロパティは，チェックボックスをデータセットにリンクします。

property DataSource: TDataSource;

説明

DataSource プロパティは，データがあるデータセットのデータソースコンポーネントを指定します。チェックボックスが項目のデータを表せるようにするには，DataSource プロパティと DataField プロパティの両方を設定しなければなりません。


TDBCheckBox.Field
TDBCheckBox.Field3126006

TDBCheckBox	参照

Field プロパティは，チェックボックスが表している現在の値を持つ TField オブジェクトです。

property Field: TField;

説明

プログラムで項目のデータの値を変更するには，Field オブジェクトを使います。


TDBCheckBox.ReadOnly
TDBCheckBox.ReadOnly3126007

TDBCheckBox	参照

ReadOonly プロパティは，項目の値をユーザーが変更できるかどうかを決めます。

property ReadOnly: Boolean;

説明

ReadOnly プロパティは，ユーザーがチェックボックスをチェックしたりチェックを解除したりして項目の値を変更できるかどうかを指定します。ReadOnly が True の場合，チェックボックスはカレントレコード上の項目の値を表示するためにのみ使われます。ReadOnly が False の場合，ユーザーはチェックボックスを使って項目値を変更できます。


TDBCheckBox.ValueChecked
TDBCheckBox.ValueChecked3126008

TDBCheckBox	参照

ValueChecked プロパティは，チェックボックスがチェックされた状態に相当する項目値です。

property ValueChecked: string;

説明

ValueChecked プロパティは，チェックボックスがチェックされたときにチェックボックスによって表される項目値を指定します。ValueChecked プロパティの値がデータセットのカレントレコードの項目のデータと等しい場合，データベースチェックボックスがチェックされたように表示されます。ユーザーがデータベースチェックボックスをチェックすると，項目値は ValueChecked に設定されます。

ValueChecked はセミコロンで区切って複数の値を表すことができます。項目のどれかがデータセットのカレントレコードの項目の内容に一致すると，チェックボックスがチェックされたように表示されます。たとえば，次のように ValueChecked の値を設定します。

DBCheckBox1.ValueChecked := 'True;Yes;On';

関連する項目の内容が文字列 True，Yes，または On の場合，チェックボックスにチェックマークが付きます。その項目の値は ValueChecked と大文字と小文字の違いを区別しないで比較されます。 ValueChecked が複数の値を表すチェックボックスをユーザーが選択すると，リスト内の最初の値がその項目に代入されます。

カレントレコードの項目の内容が ValueUnchecked プロパティの値として指定した文字列に一致すると，チェックボックスからチェックマークがはずされます。項目の内容が ValueChecked と ValueUnchecked のどちらの文字列とも一致しなければ，チェックボックスは淡色表示になります。

注意

データベースチェックボックスの DataField が論理型項目の場合，項目の内容が True ならば，必ずチェックボックスにチェックマークが付き，項目の内容が False ならば，必ずチェックマークがはずされます。ValueChecked プロパティと ValueUnchecked プロパティの値は論理型項目には影響しません。


TDBCheckBox.ValueUnchecked
TDBCheckBox.ValueUnchecked3126009

TDBCheckBox	参照

ValueUnchecked プロパティは，チェックボックスがチェックを解除された状態に相当する項目値です。

property ValueUnchecked: string;

説明

ValueUnchecked プロパティは，チェックボックスのチェックが外されたときに表す項目値を指定します。ValueUnchecked プロパティの値がデータセットのカレントレコードの項目にあるデータと等しい場合，データセットチェックボックスからチェックが外されたように表示されます。ユーザーがデータベースチェックボックスのチェックを外すと，項目の値は ValueUnchecked に設定されます。

ValueUnchecked はセミコロンで区切って複数の値を表すことができます。項目のどれかがデータセットのカレントレコードの項目の内容に一致すると，チェックボックスからチェックが外されます。たとえば，次のように ValueUnchecked の値を設定します。

DBCheckBox1.ValueUnchecked := 'False;No;Off';

関連する項目が文字列 False，No，または Off の場合，チェックボックスはチェックを外した状態に表示されます。項目の値は ValueUnchecked と大文字と小文字の違いを区別しないで比較されます。 ValueUnchecked が複数の値を表すチェックボックスをユーザーが選択すると，リスト内の最初の値がその項目に代入されます。

カレントレコードの項目の内容が ValueChecked プロパティの値として指定した文字列に一致すると，チェックボックスにチェックが付きます。項目の内容が ValueChecked と ValueUnchecked のどちらの文字列とも一致しなければ，チェックボックスは淡色表示になります。

注意

データベースチェックボックスの DataField が論理型項目の場合，項目の内容が False ならチェックボックスのチェックが外され，項目の内容が True ならチェックが付きます。ValueChecked プロパティと ValueUnchecked プロパティの値は論理型項目には影響しません。


TDBCheckBox イベント3126010

TDBCheckBox	アルファベット順	凡例

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBCheckBox イベント3126011

TDBCheckBox	オブジェクト順	凡例

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBCheckBox メソッド3126012

TDBCheckBox	アルファベット順

TDBCheckBox

Create

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBCheckBox メソッド3126013

TDBCheckBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDBCheckBox.Create
TDBCheckBox.Create3126014

TDBCheckBox	参照

Create メソッドは，TDBCheckBox のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出して，実行時に TDBCheckBox オブジェクトをインスタンス化します。設計時にフォームまたはデータモジュール上にある TDBCheckBox オブジェクトの場合 Create メソッドは自動的に呼び出されます。

継承コンストラクタを呼び出して汎用チェックボックスを割り当て，初期化した後，Create メソッドは以下の処理を行います。

・	csReplicatable を ControlStyle に追加する。

・	データセットにリンクするために必要なヘルパーオブジェクトを作成し，初期化する。


TDBCheckBox.Destroy
TDBCheckBox.Destroy3126015

TDBCheckBox	参照

Destroy メソッドは，TDBCheckBox のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TDBCheckBox オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは，TDBCheckBox のヘルパーオブジェクトを解放してから継承デストラクタを呼び出します。


スコープ3126016

published

読み出し／書き込み

読み出し専用


スコープ3126017

published


継承3126018

TObject

TPersistent

TComponent

TControl

TWinControl

TButtonControl

TCustomCheckBox


TDBCheckBox 例3126019

TDBCheckBox


TDBComboBox
TDBComboBox3127001

継承	プロパティ	メソッド	イベント	参照

TDBComboBox はデータベース対応コンボボックスコントロールです。

ユニット

dbctrls

説明

TDBComboBox を使うと，リストで項目を選択するか，コントロールの編集ボックス部分に入力することでデータセットのカレントレコードの項目の値を変更できます。項目の値は，データベースコンボボックスの ReadOnly プロパティが False であれば，選択された項目または入力されたテキストに変更されます。コンボボックスをカスタマイズすると，たとえばコントロールの編集領域での入力の使用可能/使用不可を切り換えたり，リストをドロップダウンリストまたは常に表示するリストとして表示したり，リスト内の項目をソートしたりできます。


TDBComboBox プロパティ3127002

TDBComboBox	アルファベット順	凡例

TDBComboBox

DataField

DataSource

Field

Items

ReadOnly

Style

TCustomComboBox からの継承

Canvas

DropDownCount

DroppedDown

ItemHeight

ItemIndex

SelLength

SelStart

SelText

Sorted

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Text

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBComboBox プロパティ3127003

TDBComboBox	オブジェクト順	凡例

Align

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DataField

DataSource

DesignInfo

DragCursor

DragMode

DropDownCount

DroppedDown

Enabled

Field

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

ItemHeight

ItemIndex

Items

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ReadOnly

SelLength

SelStart

SelText

ShowHint

Showing

Sorted

Style

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

Width

WindowProc


TDBComboBox.DataField
TDBComboBox.DataField3127004

TDBComboBox	参照

DataField プロパティは，コンボボックスがどの項目からデータを表示するか設定します。

property DataField: string;

説明

DataField プロパティは，どの項目がコンボボックスによって表示されるかを指定します。コンボボックスはその項目の現在の値を表示して，現在のレコードのこの項目の値を設定できるようにします。表示する項目があるデータセットは DataSource プロパティで指定します。


TDBComboBox.DataSource
TDBComboBox.DataSource3127005

TDBComboBox	参照

DataSource プロパティは，コンボボックスをデータセットにリンクします。

property DataSource: TDataSource;

説明

DataSource プロパティは，データがあるデータセットのデータソースコンポーネントを指定します。コンボボックスが項目のデータを表せるようにするには， DataSource プロパティと DataField プロパティの両方を設定しなければなりません。


TDBComboBox.Field
TDBComboBox.Field3127006

TDBComboBox	参照

Field プロパティは， TField オブジェクトです。その現在の値はコンボボックスに表示されます。

property Field: TField;

説明

Field オブジェクトを使うとプログラムで項目のデータの値を変更できます。


TDBComboBox.Items
TDBComboBox.Items3127007

TDBComboBox	参照

Items プロパティは，データベースコンボボックスのリストに表示される文字列のリストです。

property Items: TStrings;

説明

Items プロパティは，ユーザーが選択できる値を指定します。Items は TStrings 型のオブジェクトなので，TStrings オブジェクトの Add，Delete，Insert，Exchange，Move の各メソッドを使って項目の追加，削除，挿入，および移動ができます。たとえば，各文字列をコンボボックスリストに追加するには，次のようなコード行を追加します。

DBCombox1.Items.Add('AFieldValue');

ItemIndex プロパティは Items のどの項目が選択されているかを示します。


TDBComboBox.ReadOnly
TDBComboBox.ReadOnly3127008

TDBComboBox	参照

ReadOnly プロパティは，項目の値をユーザーが変更できるかどうかを決めます。

property ReadOnly: Boolean;

説明

ReadOnly を設定すると，コンボボックスを表示用にのみ使うかどうかを指定できます。ReadOnly が True の場合，コンボボックスは現在のレコード上の項目の値を表示するためにのみ使われます。 ReadOnly が False の場合，ユーザーはコンボボックスを使って項目の値を編集できます。


TDBComboBox.Style
TDBComboBox.Style3127009

TDBComboBox	参照

Style プロパティは，コンボボックスの表示方法を決めます。

TComboBoxStyle = (csDropDown, csSimple, csDropDownList, csOwnerDrawFixed, csOwnerDrawVariable);

property Style: TComboBoxStyle;

説明

Style プロパティは，ユーザーがリストから値を選択するだけでなく編集領域で入力することもできるかどうかを指定したり，ユーザーがボタンをクリックしたときにリストをドロップダウンするか常に表示するかを指定したりできます。デフォルトでは，Style は csDropDown に設定されています。つまり，コンボボックスはドロップダウンリストに文字列として Items の各項目を表示し，ユーザーは編集領域でその値を編集できます。Style は次の値に設定できます。

値	意味

csDropDown	ユーザーがテキストを入力できる編集ボックスがあるドロップダウンリストを作成する。Itemsのすべての項目は文字列であり，どの項目も同じ高さになる。Items の各項目はレコード項目内容として入力可能なものであること

csSimple	おば時サイズのリストボックスと重ねられた編集ボックスを作成する。ユーザーは新しい値を入力することも，リストから選ぶこともできる

csDropDownList	編集ボックスがアタッチされていない，つまりユーザーが項目を編集したり新しい項目を入力したりできないドロップダウンリストを作成する。すべての項目は文字列であり，どの項目も同じ高さになる。レコードの項目の現在の内容がドロップダウンリスト内で指定した Items の 1 つに一致しなければ，編集ボックスは空白になる。ユーザーはドロップダウンリストから 1 つの文字列を選択することによってのみ，項目の内容を変更できる

csOwnerDrawFixed	ドロップダウンリストが自動的に表示されない点を除き csDropDownList と同じ。Items の各項目は ItemsHeight プロパティで指定した高さになる

csOwnerDrawVariable	ドロップダウンリストが自動的に表示されない点を除き csDropDownList と同じ。Items の各項目の高さは可変にできる

オーナー描画コンボボックスには文字列以外の項目を表示できます。たとえば，コンボボックスにグラフィックイメージを文字列と一緒に，または文字列のかわりに表示できます。しかしアプリケーションがリスト内の各項目のイメージを描画しなければならないので，オーナー描画コンボボックスではさらに多くのプログラミングが必要になります。

Style が csOwnerDrawFixed または csOwnerDrawVariable の場合，リストの項目を描画する必要があると OnDrawItem イベントが発生します。Style が csOwnerDrawVariable の場合，OnMeasureItem イベントも発生します。


TDBComboBox イベント3127010

TDBComboBox	アルファベット順	凡例

TCustomComboBox からの継承

OnChange

OnDrawItem

OnDropDown

OnMeasureItem

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnStartDrag


TDBComboBox イベント3127011

TDBComboBox	オブジェクト順	凡例

OnChange

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnDrawItem

OnDropDown

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMeasureItem

OnStartDrag


TDBComboBox メソッド3127012

TDBComboBox	アルファベット順

TDBComboBox

Create

Destroy

TCustomComboBox からの継承

Clear

SelectAll

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBComboBox メソッド3127013

TDBComboBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDBComboBox.Create
TDBComboBox.Create3127014

TDBComboBox	参照

Create メソッドは，TDBComboBox のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出して，実行時に TDBComboBox オブジェクトをインスタンス化します。設計時にフォームまたはデータモジュール上に置かれた TDBComboBox オブジェクトの場合，Create メソッドは自動的に呼び出されます。

Create メソッドは，継承コンストラクタを呼び出して汎用コンボボックスオブジェクトを割り当てて初期化してから，データセットにリンクするために必要なヘルパーオブジェクトを作成し初期化します。


TDBComboBox.Destroy
TDBComboBox.Destroy3127015

TDBComboBox	参照

Destroy メソッドは，TDBComboBox のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TDBComboBox オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは TDBComboBox のヘルパーオブジェクトを解放してから継承デストラクタを呼び出します。


スコープ3127016

published

読み出し／書き込み

読み出し専用


スコープ3127017

published


継承3127018

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomComboBox


TDBComboBox 例3127019

TDBComboBox


TDBCtrlPanel
TDBCtrlPanel3128001

継承	プロパティ	メソッド	参照

TDBCtrlPanel は TDBCtrlGrid オブジェクトのパネルです。

ユニット

dbcgrids

説明

TDBCtrlPanelは，データセットのレコード 1 件分の項目を保持します。TDBCtrlGrid オブジェクトは同じ TDBCtrlPanel オブジェクトの複数のコピーを行または列に並べてデータセットのレコードを表し，そこで各パネルはデータセットの 1 つのレコードを表します。

設計時にパネルを 1 つレイアウトします。データベース対応編集コントロールまたはデータ表示オブジェクトを追加します。実行時に，TDBCtrlGrid はデータセットのレコード文パネルを複製します。

パネルの外観は，そのパネルを含む TDBCtrlGrid オブジェクトのプロパティによって決まります。TDBCtrlGrid の OnPaintPanel イベントを使うと，パネルのペイントをカスタマイズできます。


TDBCtrlPanel プロパティ3128002

TDBCtrlPanel	アルファベット順	凡例

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBCtrlPanel プロパティ3128003

TDBCtrlPanel	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentWindow

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TDBCtrlPanel メソッド3128004

TDBCtrlPanel	アルファベット順

TDBCtrlPanel

Create

CreateLinked

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBCtrlPanel メソッド3128005

TDBCtrlPanel	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateLinked

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDBCtrlPanel.CreateLinked
TDBCtrlPanel.CreateLinked3128006

TDBCtrlPanel	参照

CreateLinked メソッドは TDBCtrlPanel のインスタンスを作成し，初期化します。

  constructor CreateLinked(DBCtrlGrid: TDBCtrlGrid);

説明

TDBCtrlPanel のコンストラクタは直接呼び出さないでください。TDBCtrlGrid は自身のコンストラクタから TDBCtrlPanel の CreateLinked  メソッドを呼び出します。

CreateLinked メソッドは Parent プロパティを DBCtrlGrid パラメータに初期化し，ControlStyle プロパティを [csAcceptsControls, csCaptureMouse, csClickEvents, csDoubleClicks, csOpaque, csReplicatable] に初期化します。


スコープ3128007

published

読み出し／書き込み

読み出し専用


継承3128008

TObject

TPersistent

TComponent

TControl

TWinControl


TDBCtrlPanel 例3128009

TDBCtrlPanel


TDBCtrlGrid
TDBCtrlGrid3129001

継承	プロパティ	メソッド	イベント	参照

TDBCtrlGrid は自由なレイアウトでデータソースのレコードを表示します。

ユニット

dbcgrids

説明

TDBCtrlGrid オブジェクトをフォームに配置すると，データベーステーブルまたは問い合わせのレコードを表示および編集できます。各レコードが 1 行に表示される TDBGrid コンポーネントとは異なり，TDBCtrlGrid ではデータセットの各レコードを自由にレイアウトできます。各レコードはそれぞれのパネルに表示されます。設計時にパネルを 1 つ設計すると，表示するレコードごとに TDBCtrlGrid がそのパネルを複製します。

実行時に，ユーザーはデータベースナビゲータ（TDBNavigator）を使って TDBCtrlGrid オブジェクトのデータ間を移動し，データを挿入，削除，および編集できます。データグリッドを使って行われた編集は，ユーザーがほかのレコードに移動するか，またはアプリケーションを閉じるまで元のデータセットには反映されません。


TDBCtrlGrid プロパティ3129002

TDBCtrlGrid	アルファベット順	凡例

TDBCtrlGrid

AllowDelete

AllowInsert

Canvas

ColCount

DataSource

EditMode

Orientation

PanelBorder

PanelCount

PanelHeight

PanelIndex

PanelWidth

RowCount

SelectedColor

ShowFocus

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBCtrlGrid プロパティ3129003

TDBCtrlGrid	オブジェクト順	凡例

Align

AllowDelete

AllowInsert

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ColCount

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DataSource

DesignInfo

DragCursor

DragMode

EditMode

Enabled

Font

Handle

Height

HelpContext

Hint

Left

Name

Orientation

Owner

PanelBorder

PanelCount

PanelHeight

PanelIndex

PanelWidth

Parent

ParentColor

ParentFont

ParentShowHint

ParentWindow

PopupMenu

RowCount

SelectedColor

ShowFocus

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TDBCtrlGrid.AllowDelete
TDBCtrlGrid.AllowDelete3129004

TDBCtrlGrid	参照

AllowDelete プロパティは，ユーザーが〔Ctrl〕+〔Del〕キーを押してデータセットからカレントレコードを削除できるかどうかを決めます。

property AllowDelete: Boolean;

説明

AllowDelete プロパティを False に設定すると，TDBCtrlGrid オブジェクトがレコードを削除するのを抑制します。

AllowDelete プロパティが False の場合，ユーザーが〔Ctrl〕+〔Del〕キーを押すか，または Key パラメータが gkDelete に設定されている DoKey メソッドが呼び出されても，TDBCtrlGrid オブジェクトはデータセットからレコードを削除しません。この場合でも，TDBCtrlGrid オブジェクトはレコードを挿入できます。

AllowDelete プロパティが True（デフォルト）の場合，ユーザーが〔Ctrl〕+〔Del〕キーを押すか，または Key パラメータが gkDelete に設定されている DoKey メソッドが呼び出されると，TDBCtrlGrid オブジェクトはデータセットからレコードを削除します。ただし，AllowDelete プロパティが True に設定されていても，データセットが編集モードでないとレコードは削除されません。


TDBCtrlGrid.AllowInsert
TDBCtrlGrid.AllowInsert3129005

TDBCtrlGrid	参照

AllowInsert プロパティは，ユーザーが〔Ins〕キーまたは〔Ctrl〕+〔Ins〕キー押して新しいレコードを挿入または追加できるかどうかを決めます。

property AllowInsert: Boolean;

説明

AllowInsert プロパティを False に設定すると，TDBCtrlGrid オブジェクトがレコードを挿入するのを抑制できます。

AllowInsert プロパティが False の場合，ユーザーが〔Ins〕キーまたは〔Ctrl〕+〔Ins〕キーを押すか，または Key パラメータが gkInsert か gkAppend に設定されている DoKey メソッドが呼び出されても，TDBCtrlGrid オブジェクトはデータセットにレコードを挿入しません。この場合でも，TDBCtrlGrid オブジェクトはレコードを削除できます。

AllowInsert プロパティが True（デフォルト）の場合，ユーザーが〔Ins〕キーを押すと TDBCtrlGrid オブジェクトはデータセットのカレントレコードの前に新しいレコードを挿入し，〔Ctrl〕+〔Ins〕キーを押すとデータセットの最後に新しいレコードを追加します。AllowInsert プロパティが True に設定されていても，データセットが編集モードでないとレコードは挿入されません。


TDBCtrlGrid.Canvas
TDBCtrlGrid.Canvas3129006

TDBCtrlGrid	参照

Canvas プロパティは，TDBCtrlGrid オブジェクトの描画面です。

property Canvas: TCanvas;

説明

Canvas のプロパティおよびメソッドを使うと，OnPaintPanel イベントハンドラから TDBCtrlGrid オブジェクトにパネルのイメージを描画できます。


TDBCtrlGrid.ColCount
TDBCtrlGrid.ColCount3129007

TDBCtrlGrid	参照

ColCount プロパティは，グリッドに表示するパネルの列数を指定します。

property ColCount: Integer;

説明

ColCount プロパティは TDBCtrlGrid オブジェクトに表示するパネルの列数に設定します。各パネルはデータセットの別々のレコードを表します。

ColCount プロパティを設定すると，TDBCtrlGrid オブジェクトは新しい列数に合わせて自動的にサイズ変更します。PanelWidth は変化しません。


TDBCtrlGrid.DataSource
TDBCtrlGrid.DataSource3129008

TDBCtrlGrid	参照

DataSource プロパティは，TDBCtrlGrid オブジェクトがデータを見つけるデータセットへのリンクを指定します。

property DataSource: TDataSource;

説明

DataSource プロパティは，グリッドがデータを取り出すデータセットにリンクされた TDataSource オブジェクトを設定します。DataSource プロパティは，データベース対応グリッドにデータセットのデータ間を移動してデータを読み書きを可能にし，また同じデータソースを使うほかのデータベース対応オブジェクトとの間でレコードを最新に保つことができます。


TDBCtrlGrid.EditMode
TDBCtrlGrid.EditMode3129009

TDBCtrlGrid	参照

EditMode プロパティは，TDBCtrlGrid を使ってレコードを挿入，削除，または編集できるかどうかを決めます。

property EditMode: Boolean;

説明

EditMode プロパティを True に設定すると，ユーザーはグリッドを使ってデータセットを編集できます。ユーザーは〔F2〕キーまたは〔Enter〕キーを押して EditMode プロパティを切り替えることができます。グリッドを使ってレコードを挿入または削除すると，EditMode プロパティが True に設定されます。


TDBCtrlGrid.Orientation
TDBCtrlGrid.Orientation3129010

TDBCtrlGrid	参照

Orientation プロパティは，データセットのレコードを TDBCtrlGrid で表示する方法を決めます。

TDBCtrlGridOrientation = (goVertical, goHorizontal);

property Orientation: TDBCtrlGridOrientation;

説明

Orientation プロパティを goVertical（デフォルト）に設定すると，パネルは垂直スクロールバー付きで行に並べられます。Orientation プロパティを goHorizontal に設定すると，パネルは水平スクロールバー付きで列に並べられます。


TDBCtrlGrid.PanelBorder
TDBCtrlGrid.PanelBorder3129011

TDBCtrlGrid	参照

PanelBorder プロパティは，各パネルが浮き上がった境界付きで描画されるかどうかを決めます。

TDBCtrlGridBorder = (gbNone, gbRaised);

property PanelBorder: TDBCtrlGridBorder;

説明

デフォルト値の gbRaised は浮き上がった境界を描画します。PanelBorder プロパティを gbNone に設定すると境界が消去されます。


TDBCtrlGrid.PanelCount
TDBCtrlGrid.PanelCount3129012

TDBCtrlGrid	参照

PanelCount プロパティは，グリッドに表示されるレコード数を示します。

property PanelCount: Integer;

説明

TDBCtrlGrid は ColCount と RowCount の値を掛けた数までパネルを表すことができます。通常，PanelCount プロパティはこの値になります。グリッド全体を満たすだけのレコードがない場合，PanelCount プロパティはこの値より小さくなります。


TDBCtrlGrid.PanelHeight
TDBCtrlGrid.PanelHeight3129013

TDBCtrlGrid	参照

PanelHeight プロパティは，各パネルの高さをピクセル単位で示します。

property PanelHeight: Integer;

説明

PanelHeight プロパティは，グリッドの各パネルのサイズを設定します。PanelHeight プロパティを設定すると，グリッドはパネルの新しい高さに合わせて自動的にサイズ変更されます。


TDBCtrlGrid.PanelIndex
TDBCtrlGrid.PanelIndex3129014

TDBCtrlGrid	参照

PanelIndex プロパティは，カレントレコードを表すグリッド内のパネルのインデックスを示します

property PanelIndex: Integer;

説明

PanelIndex プロパティは，どのパネルがデータセットのカレントレコードかを示します。PanelIndex プロパティを設定すると，グリッドのパネルに対応するデータセット内のレコードに移動できます。

PanelIndex パラメータの値は 0 ～ PanelCount - 1 の範囲で，0 が最初のパネル，1 が 2 番目のパネルというようになっています。PanelIndex プロパティのインデックスが示すパネルの位置は Orientation プロパティの値によって異なります。Orientation プロパティが goVertical の場合，パネルは行でカウントされます。Orientation プロパティが goHorizontal の場合，パネルは列でカウントされます。


TDBCtrlGrid.PanelWidth
TDBCtrlGrid.PanelWidth3129015

TDBCtrlGrid	参照

PanelWidth プロパティは，各パネルの幅をピクセル単位で示します。

property PanelWidth: Integer;

説明

PanelWidth プロパティは，グリッドの各パネルのサイズを設定します。PanelWidth プロパティを設定すると，グリッドはパネルの新しい幅に合わせて自動的にサイズ変更されます。


TDBCtrlGrid.RowCount
TDBCtrlGrid.RowCount3129016

TDBCtrlGrid	参照

RowCount プロパティは，グリッドに表示するパネルの行数を示します。

property RowCount: Integer;

説明

RowCount プロパティは，TDBCtrlGrid オブジェクトに表示するパネルの行数を設定します。各パネルはデータセットの別々のレコードを表します。

RowCount プロパティを設定すると，TDBCtrlGrid オブジェクトは新しい行数が収まるように自動的にサイズ変更されます。PanelHeight プロパティは変わりません。


TDBCtrlGrid.SelectedColor
TDBCtrlGrid.SelectedColor3129018

TDBCtrlGrid	参照

SelectedColor プロパティは，データセットのカレントレコードを表すパネルの背景色を示します。

property SelectedColor: TColor;

説明

SelectedColor プロパティに Color プロパティと違う値を設定すると，カレントレコードを表すパネルを目立たせることができます。TDBCtrlGrid オブジェクトは，選択されているパネルが入力フォーカスを持っていなくても，そのパネルを SelectedColor プロパティを使って描画します。ほかのすべてのパネルは Color プロパティに設定されている背景色に従って描画されます。

SelectedColor は以下のいずれかの値を指定します。

値	意味

clBlackclBlack	黒色

clMaroon	栗色

clGreen	緑色

clOlive	黄緑色

clNavy	濃紺色

clPurple	紫色

clTeal	暗青緑色

clGray	灰色

clSilver	銀色

clRed	赤色

clLime	濃緑色

clBlue	青色

clFuchsia	赤紫色

clAqua	空色

clWhite	白色

clBackground	Windows の背景の現在の色

clActiveCaption	アクティブウィンドウのタイトルバーの現在の色

clInactiveCaption	アクティブでないウィンドウのタイトルバーの現在の色

clMenu	メニューの現在の背景色

clWindow	ウィンドウの現在の背景色

clWindowFrame	ウィンドウ枠の現在の色

clMenuText	メニュー上のテキストの現在の色

clWindowText	ウィンドウ内のテキストの現在の色

clCaptionText	アクティブウィンドウのタイトルバー上のテキストの現在の色

clActiveBorder	アクティブウィンドウの現在の境界色

clInactiveBorder	アクティブでないウィンドウの現在の境界色

clAppWorkSpace	アプリケーションの作業領域の現在の色

clHighlight	選択したテキストの現在の背景色

clHightlightText	選択したテキストの現在の色

clBtnFace	ボタン面の現在の色

clBtnShadow	ボタンの影の現在の色

clGrayText	淡色表示されているテキストの現在の色

clBtnText	ボタンのテキストの現在の色

clInactiveCaptionText	アクティブでないウィンドウのタイトルバーのテキストの現在の色

clBtnHighlight	ボタンの強調表示の現在の色

cl3DDkShadow 	Windows 95 または NT 4.0 のみ。3 次元表示要素の暗い影

cl3DLight 	Windows 95 または NT 4.0 のみ。3 次元表示要素の明るい色

clInfoText 	Windows 95 または NT 4.0 のみ。ツールチップコントロールのテキストの色

clInfoBk 	Windows 95 または NT 4.0 のみ。ツールチップコントロールの背景色


TDBCtrlGrid.ShowFocus
TDBCtrlGrid.ShowFocus3129017

TDBCtrlGrid	参照

ShowFocus プロパティは，TDBCtrlGrid オブジェクトのカレントレコードが入力フォーカスを持った場合に，そのまわりに長方形のフォーカスの領域を描画するかどうかを指定します。

property ShowFocus: Boolean;

説明

ShowFocus プロパティを True に設定すると，TDBCtrlGrid オブジェクトはカレントレコードが入力フォーカスを持ったときに，そのまわりに長方形のフォーカス領域を描画します。OnPaintPanel イベントハンドラにフォーカスを視覚的にフィードバックするほかの方法を記述する場合は ShowFocus プロパティを False に設定します。


TDBCtrlGrid イベント3129019

TDBCtrlGrid	アルファベット順	凡例

TDBCtrlGrid

OnPaintPanel

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBCtrlGrid イベント3129020

TDBCtrlGrid	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnPaintPanel

OnStartDrag


TDBCtrlGrid.OnPaintPanel
TDBCtrlGrid.OnPaintPanel3129021

TDBCtrlGrid	参照

OnPaintPanel イベントは，TDBCtrlGrid オブジェクトがグリッドにパネルを描画する必要があるときに発生します。

TPaintPanelEvent = procedure(DBCtrlGrid: TDBCtrlGrid; Index: Integer) of object;

property OnPaintPanel: TPaintPanelEvent;

説明

OnPaintPanel イベントハンドラを記述して，TDBCtrlGrid オブジェクトのパネルの描画をカスタマイズできます。TDBCtrlGrid オブジェクトは Color または SelectedColor プロパティを使って背景をペイントし，PanelBorder プロパティで指定されていれば浮き上がった境界を描画します。それから，OnPaintPanel イベントが発生し，イベントハンドラがパネルのイメージを追加できます。

DBCtrlGrid パラメータはパネルを含むグリッドを示します。Index パラメータはペイントされているパネルのインデックスを示し，値が 0 なら最初のパネル，1 なら 2 番目のパネルを示します。PanelIndex プロパティを使うと，描画されているパネルが選択されているのかどうかがわかります。

パネルをペイントするには Canvas プロパティを使います。キャンバス上の点（0，0）はパネルの左上隅，点（PanelWidth，PanelHeight）は右下隅を示します。

パネル上のコントロールは別々に描画され，OnPaintpanel イベントハンドラで描画される必要はありません。


TDBCtrlGrid メソッド3129022

TDBCtrlGrid	アルファベット順

TDBCtrlGrid

Create

Destroy

DoKey

GetTabOrderList

KeyDown

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBCtrlGrid メソッド3129023

TDBCtrlGrid	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DoKey

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

KeyDown

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDBCtrlGrid.Create
TDBCtrlGrid.Create3129024

TDBCtrlGrid	参照

Create メソッドは，TDBCtrlGrid のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TDBCtrlGrid オブジェクトを作成して初期化できます。設計時にフォームに配置された TDBCtrlGrid オブジェクトは自動的に作成されます。

Create メソッドは使用するヘルパーオブジェクトを割り当て，以下のように初期化します。

・	AllowInsert および AllowDelete を True に初期化する

・	ColCount を 1，RowCount を 3 に初期化する

・	ControlStyle を [csOpaque, csDoubleClicks] に初期化する

・	PanelBorder を gbRaised に初期化する

・	PanelWidth を 200，PanelHeight を 72 に初期化する

・	SelectedColor を Color に初期化する

・	ShowFocus を True に初期化する

・	TabStop を True に初期化する


TDBCtrlGrid.Destroy
TDBCtrlGrid.Destroy3129025

TDBCtrlGrid	参照

Destroy メソッドは，TDBCtrlGrid のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TDBCtrlGrid オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは TDBCtrlGrid のヘルパーオブジェクトを解放してから継承デストラクタを呼び出します。


TDBCtrlGrid.DoKey
TDBCtrlGrid.DoKey3129026

TDBCtrlGrid	参照

DoKey メソッドは，多くの標準キー入力に対する応答を実装します。

TDBCtrlGridKey = (gkNull, gkEditMode, gkPriorTab, gkNextTab, gkLeft, gkRight, gkUp, gkDown,

     gkScrollUp, gkScrollDown, gkPageUp, gkPageDown, gkHome, gkEnd, gkInsert, gkAppend,

     gkDelete, gkCancel);

procedure DoKey(Key: TDBCtrlGridKey);

説明

DoKey メソッドを呼び出すと，Key パラメータで指定されている処理を実行できます。たとえば，DoKey メソッドを使って OnKeyDown イベントハンドラのキー入力を再マッピングできます。

以下に Key パラメータの値とそのアクションを示します。

値	アクション

gkNull	処理なし

gkEditMode	EditMode を切り替える

gkPriorTab	前のパネルに移動する

gkNextTab	次のパネルに移動する

gkLeft	1 パネル左へ移動する

gkRight	1 パネル右へ移動する

gkUp	1 パネル上へ移動する

gkDown	1 パネル下へ移動する

gkScrollUp	1 パネル上で移動する

gkScrollDown	1 パネル下へ移動する

gkPageUp	データセットで ColCount x RowCount のレコード数だけ上へ移動する

gkPageDown	データセットで ColCount x RowCount のレコード数だけ下へ移動する

gkHome	データセットの最初のレコードに移動する

gkEnd	データセットの最後のレコードに移動する

gkInsert	データセットのカレントレコードの前に新しいレコードを挿入し，EditMode を True に設定する

gkAppend	データセットの最後に新しいレコードを挿入し，EditMode を True に設定する

gkDelete	データセットからカレントレコードを削除し，EditMode を False に設定する

gkCancel	データセットに書き込まれていない編集を取り消し，EditMode を False に設定する


TDBCtrlGrid.GetTabOrderList
TDBCtrlGrid.GetTabOrderList3129027

TDBCtrlGrid	参照

GetTabOrderList メソッドは，デフォルトをオーバーライドして，タブ順からすべての子コントロールを削除します。

procedure GetTabOrderList(List: TList); override;

説明

GetTabOrderList メソッドは空のリストを返します。TDBCtrlGrid オブジェクトはタブキーの独自の処理を実現し，データベース順でパネル間を移動します。


TDBCtrlGrid.KeyDown
TDBCtrlGrid.KeyDown3129028

TDBCtrlGrid	参照

KeyDown メソッドはキーが押されたときに特別な処理を実行します。

procedure KeyDown(var Key: Word; Shift: TShiftState); override;

説明

OnKeyDown イベントハンドラが呼び出されてから，KeyDown メソッドは Key および Shift パラメータの各組み合わせを論理キーコードに変換し，DoKey メソッドを呼び出して適切なアクションを実行します。

KeyDown は以下の変換を実行します。

Key 値と Shift 値	キーコード

〔←〕	gkLeft

〔→〕	gkRight

〔↑〕	gkUp

〔↓〕	gkDown

〔PageUp〕	gkPageUp

〔PageDown〕	gkPageDown

〔Home〕	gkHome

〔End〕	gkEnd

〔Enter〕	gkEditMode

〔F2〕	gkEditMode

〔Ins〕	gkAppend

〔Ctrl〕+〔Ins〕	gkInsert

〔Ctrl〕+〔Del〕	gkDelete

〔Esc〕	gkCancel

ほかのすべてのキー	gkNull


スコープ3129029

published

読み出し／書き込み

読み出し専用


スコープ3129030

published


継承3129031

TObject

TPersistent

TComponent

TControl

TWinControl


TDBCtrlGrid 例3129032

TDBCtrlGrid


TDBCtrlGridLink
TDBCtrlGridLink3130001

継承	プロパティ	メソッド	参照

TDBCtrlGridLink オブジェクトは，TDBCtrlGrid オブジェクトが使うデータイベントの管理を助けるヘルパーオブジェクトです。

ユニット

dbcgrids

説明

TDBCtrlGridLink オブジェクトは TDBCtrlGrid オブジェクトとともに動作します。TDBCtrlGrid クラスのみが使用できるオブジェクトです。


TDBCtrlGridLink プロパティ3130002

TDBCtrlGridLink	アルファベット順	凡例

TDataLink からの継承

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


TDBCtrlGridLink プロパティ3130003

TDBCtrlGridLink	オブジェクト順	凡例

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


TDBCtrlGridLink メソッド3130004

TDBCtrlGridLink	アルファベット順	凡例

TDBCtrlGridLink

ActiveChanged

Create

DataSetChanged

TDataLink からの継承

Destroy

Edit

UpdateRecord

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDBCtrlGridLink メソッド3130005

TDBCtrlGridLink	オブジェクト順	凡例

ActiveChanged

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DataSetChanged

DefaultHandler

Destroy

Dispatch

Edit

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

UpdateRecord


TDBCtrlGridLink.ActiveChanged
TDBCtrlGridLink.ActiveChanged3130006

TDBCtrlGridLink	参照

ActiveChanged メソッドは，TDBCtrlGrid オブジェクトに Active プロパティの変更を通知します。

procedure ActiveChanged; override;

説明

アプリケーションが ActiveChanged 手続きを直接呼び出すことはできません。Active プロパティの変更によって ActiveChanged 手続きが呼び出されます。ActiveChanged により，TDBCtrilGrid オブジェクトは，データセット内のデータを反映するようにその外観を変更します。


TDBCtrlGridLink.Create
TDBCtrlGridLink.Create3130007

TDBCtrlGridLink	参照

Create メソッドは，TDBCtrlGridLink のインスタンスを作成します。

constructor Create(DBCtrlGrid: TDBCtrlGrid);

説明

アプリケーションでは直接 TDBCtrlGridLink の Create メソッドを呼び出さないでください。TDBCtrlGridLink のオーナーである TDBCtrlGrid が自身のコンストラクタから Create メソッドを呼び出します。


TDBCtrlGridLink.DataSetChanged
TDBCtrlGridLink.DataSetChanged3130008

TDBCtrlGridLink	参照

DataSetChanged メソッドは，データセットへの変更を TDBCtrlGrid オブジェクトに通知します。

procedure DataSetChanged; override;

説明

アプリケーションが DataSetChanged メソッドを直接呼び出すことはできません。DataSetChanged メソッドは，データセットの内容が変更されたときに自動的に呼び出されます。データセットがスクロールしたり，TDBCtrlGrid オブジェクトによるデータセットの表示が変化したときには，DataSetChanged メソッドが間接的に呼び出されます。DataSetChanged メソッドにより，TDBCtrlGrid オブジェクトは，データセットへの変更を反映するようにその外観を変更します。


読み出し／書き込み3130009

読み出し専用


スコープ3130010

protected


継承3130011

TObject

TPersistent

TDataLink


TDBCtrlGridLink 例3130012

TDBCtrlGridLink


TDBDataSet
TDBDataSet3131001

継承	プロパティ	メソッド	イベント	参照

TDBDataSet コンポーネントは，派生データセットオブジェクトのデータセット接続をカプセル化します。

ユニット

dbtables

説明

TDBDataSet コンポーネントは，データセットのデータベース関連接続プロパティ／メソッドを定義したデータセットオブジェクトです。アプリケーションで直接 TDBDataSet オブジェクトを使わずに，データベース関連プロパティ／メソッドを継承した TQuery，TStoredProc，TTable などの派生オブジェクトを使用してください。

カスタムデータセットを作成する開発者は，これらのオブジェクトを派生させて，TDataSet の全機能，および TDBDateSet のデータベース固有プロパティだけでなく TBDEDataSet の BDE 関連プロパティ／メソッドを継承するかもしれません。その場合は TDBDataSet のプロテクトメソッドのソースコードは参考になるでしょう。


TDBDataSet プロパティ3131002

TDBDataSet	アルファベット順	凡例

TDBDataSet

Database

DatabaseName

DBHandle

DBLocale

DBSession

Provider

SessionName

TBDEDataSet からの継承

CacheBlobs

CachedUpdates

CanModify

ExpIndex

Filter

Filtered

FilterOptions

Handle

KeySize

Locale

RecNo

RecordCount

RecordSize

UpdateObject

UpdateRecordTypes

UpdatesPending

TDataSet からの継承

Active

AutoCalcFields

BOF

Bookmark

DataSource

DefaultFields

Designer

EOF

FieldCount

FieldDefs

Fields

FieldValues

Found

Modified

Name

State

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBDataSet プロパティ3131003

TDBDataSet	オブジェクト順	凡例

Active

AutoCalcFields

BOF

Bookmark

CacheBlobs

CachedUpdates

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Database

DatabaseName

DataSource

DBHandle

DBLocale

DBSession

DefaultFields

Designer

DesignInfo

EOF

ExpIndex

FieldCount

FieldDefs

Fields

FieldValues

Filter

Filtered

FilterOptions

Found

Handle

KeySize

Locale

Modified

Name

Owner

Provider

RecNo

RecordCount

RecordSize

SessionName

State

Tag

UpdateObject

UpdateRecordTypes

UpdatesPending

VCLComObject


TDBDataSet.Database
TDBDataSet.Database3131004

TDBDataSet	参照

Databasse プロパティは，データベースコンポーネントを指定し，データセットを構成する 1 つまたは複数のテーブルを表します。

property Database: TDatabase;

説明

Database プロパティを使うと，データセットに関連付けられたデータベースコンポーネントのプロパティ，イベント，およびメソッドにアクセスできます。このプロパティは，読み出し専用プロパティで，DatabaseName プロパティで指定されたデータベースが開いたとき自動的に設定されます。


TDBDataSet.DatabaseName
TDBDataSet.DatabaseName3131005

TDBDataSet	参照

DatabaseName プロパティは，データセットに関連付けるデータベースの名前を指定します。

property DatabaseName: string;

説明

DatabaseName プロパティを使うと，データセットコンポーネントに関連付けるデータベースの名前を指定できます。このプロパティは，アプリケーションで使用されるデータベースコンポーネントの名前と一致しなければなりません。

注意

すでにデータセットコンポーネントに関連付けられているデータベースが開いているときに このプロパティを設定しようとすると，例外が発生します。

参考

設計時に TDatabase コンポーネントをダブルクリックすると，Database エディタが呼び出され，DatabaseName プロパティを設定することができます。


TDBDataSet.DBHandle
TDBDataSet.DBHandle3131006

TDBDataSet	参照

DBHandle プロパティは，データセットの BDE（ボーランドデータベースエンジン）データベースハンドルを指定します。

type

HDBISES: Longint;

property DBHandle: HDBISES;

説明

DBHandle プロパティをチェックすると，データセットのデータベースハンドルがわかります。このプロパティが役に立つのは，データセット／データベースメソッドを使わずに BDE API に直接書き込むようなアプリケーションだけです。多くの BDE 関数呼び出しでハンドルパラメータが必要です。このプロパティは，セッションがアクティブになったとき初期値が割り当てられます。

注意

標準の Delphi コンポーネントでは使用できない BDE 機能を必要とする場合以外，このプロパティを使わないでください。


TDBDataSet.DBLocale
TDBDataSet.DBLocale3131007

TDBDataSet	参照

DBLocale プロパティは，データセットコンポーネントの BDE（ボーランドデータベースエンジン）言語ドライバを示します。

type

TLocale: Pointer;

property DBLocale: TLocale;

説明

DBLocale プロパティを調べると，データセットコンポーネントが使う BDE 言語ドライバがわかります。直接 BDE を呼び出すアプリケーションは，API 関数パラメータとして DBLocale 情報を渡す場合があります。

注意

標準の Delphi コンポーネントでは使用できない BDE 機能を必要とする場合以外，このプロパティを使わないでください。


TDBDataSet.DBSession
TDBDataSet.DBSession3131008

TDBDataSet	参照

DBSession プロパティは，データセットコンポーネントに関連付けられているデータベースセッションコンポーネントを指します。

property DBSession: TSession

説明

DBSession プロパティを使うと，データセットコンポーネントに関連付けられているデータベースコンポーネントを制御するセッションコンポーネントがわかります。デフォルトで，データベースコンポーネントは，すべてのデータベースアプリケーションで自動的に作成されるデフォルトセッションコンポーネント，Session と関連付けられています。


TDBDataSet.Provider
TDBDataSet.Provider3131009

TDBDataSet

Provider プロパティは，データセットのプロバイダインターフェースを指定します。

property Provider: IProvider;

説明

Provider プロパティを調べると、オブジェクトの IProvider インターフェースを特定できます。IProvider インターフェースは，クライアントデータセットが IProvider インターフェースを通してアプリケーションサーバー上のデータセットオブジェクトと直接通信できる多層のアプリケーションを開発する場合にのみ使います。


TDBDataSet.SessionName
TDBDataSet.SessionName3131010

TDBDataSet	参照

SessionName プロパティは，データセットに関連付けられているセッションの名前を示します。

property SessionName: string;

説明

SessionName プロパティを使うと，データセットコンポーネントに関連付けられているセッションを取得したり指定したりできます。このプロパティは，データセットコンポーネントに関連付けられているデータベースコンポーネントの SessionName プロパティ名に自動的に設定されます。このプロパティが空白の場合，データセットコンポーネントは自動的にデフォルトセッション，Session に関連付けられます。

データセットコンポーネントに他のセッションを関連付けるには，このプロパティはこのデータベースコンポーネントが使っている既存のセッションコンポーネントの SessionName プロパティと一致しないといけません。


TDBDataSet イベント3131011

TDBDataSet	アルファベット順	凡例

TBDEDataSet からの継承

OnServerYield

OnUpdateError

OnUpdateRecord

TDataSet からの継承

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TDBDataSet イベント3131012

TDBDataSet	オブジェクト順	凡例

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError

OnServerYield

OnUpdateError

OnUpdateRecord


TDBDataSet メソッド3131013

TDBDataSet	アルファベット順

TDBDataSet

CheckOpen

CloseDatabase

TBDEDataSet からの継承

ApplyUpdates

BookmarkValid

Cancel

CancelUpdates

CommitUpdates

CompareBookmarks

ConstraintCallBack

ConstraintsDisabled

Create

CreateBlobStream

Destroy

DisableConstraints

EnableConstraints

FetchAll

FlushBuffers

GetCurrentRecord

GetIndexInfo

IsSeguenced

Locate

Lookup

OpenDatabase

RevertRecord

UpdateStatus

TDataSet からの継承

ActiveBuffer

Append

AppendRecord

CheckBrowseMode

ClearFields

Close

ControlsDisabled

CursorPosChanged

Delete

DisableControls

Edit

EnableControls

FieldByName

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FreeBookmark

GetBookmark

GetFieldList

GetFieldNames

GotoBookmark

Insert

InsertRecord

IsEmpty

IsLinkedTo

Last

MoveBy

Next

Open

Post

Prior

Refresh

Resync

SetFields

Translate

UpdateCursorPos

UpdateRecord

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBDataSet メソッド3131014

TDBDataSet	オブジェクト順

ActiveBuffer

Append

AppendRecord

ApplyUpdates

Assign

BookmarkValid

Cancel

CancelUpdates

CheckBrowseMode

CheckOpen

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearFields

Close

CloseDatabase

CommitUpdates

CompareBookmarks

ConstraintCallBack

ConstraintsDisabled

ControlsDisabled

Create

CreateBlobStream

CursorPosChanged

DefaultHandler

Delete

Destroy

DestroyComponents

Destroying

DisableConstraints

DisableControls

Dispatch

Edit

EnableConstraints

EnableControls

FetchAll

FieldAddress

FieldByName

FindComponent

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FlushBuffers

Free

FreeBookmark

FreeInstance

FreeNotification

FreeOnRelease

GetBookmark

GetCurrentRecord

GetFieldList

GetFieldNames

GetIndexInfo

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GotoBookmark

HasParent

InheritsFrom

InitInstance

Insert

InsertComponent

InsertRecord

InstanceSize

IsEmpty

IsLinkedTo

IsSeguenced

Last

Locate

Lookup

MethodAddress

MethodName

MoveBy

NewInstance

Next

Open

OpenDatabase

Post

Prior

Refresh

RemoveComponent

Resync

RevertRecord

SafeCallException

SetFields

Translate

UpdateCursorPos

UpdateRecord

UpdateStatus


TDBDataSet.CheckOpen
TDBDataSet.CheckOpen3131015

TDBDataSet	参照

CheckOpen メソッドは，ボーランドデータベースエンジン（BDE）を呼び出した結果をチェックします。

function CheckOpen(Status: DBIResult): Boolean;

説明

CheckOpen メソッドを呼び出すと，テーブルにアクセスしようとしたときに BDE 呼び出しがエラーを返したかどうかがわかります。Status パラメータは，前回の BDE 呼び出しの結果です。このメソッドは，テーブルへのアクセスが成功した場合に True を返します。Paradox テーブルにアクセスしたときに Status パラメータがテーブル操作権が不十分であることを示した場合には、CheckOpen はデータベースセッションの GetPassword メソッドを呼び出して，ユーザーにパスワードを求めます。ダイアログが正常終了すると，CheckOpen は True を返します。

ダイアログが正常終了しないと False を返します。これはデータセットアクセスが失敗したことを表します。


スコープ3131016

published

読み出し／書き込み

読み出し専用


スコープ3131017

published


継承3131018

TObject

TPersistent

TComponent

TDataSet

TBDEDataSet


TDBDataSet 例3131019

TDBDataSet


TDBEdit
TDBEdit3132001

継承	プロパティ	メソッド	イベント	参照	例

TDBEdit はデータセットの項目を表示および編集できる 1 行編集コントロールです。

ユニット

dbctrls

説明

TDBEdit を使うと，ユーザーはデータベースの項目を編集できます。TDBEdit はマスクを使って入力をデータベースの項目に有効なデータだけに制限できます。TDBEdit は Text プロパティを使って項目の内容を表します。

TDBEdit で扱えるテキストは 1 行だけです。複数の行を必要とする長いデータが項目に含まれる可能性がある場合は，TDBMemo オブジェクトを使うことを考えてください。

アプリケーションが TDBEdit のデータベース対応機能を必要としない場合は，システムリソースを節約するために編集コントロール（TEdit）またはマスク編集コントロール（TMaskEdit）をかわりに使ってください。


TDBEdit プロパティ3132002

TDBEdit	アルファベット順	凡例

TDBEdit

DataField

DataSource

Field

ReadOnly

TCustomMaskEdit からの継承

EditText

IsMasked

MaxLength

Text

TCustomEdit からの継承

AutoSelect

AutoSize

BorderStyle

CharCase

Modified

PasswordChar

SelLength

SelStart

SelText

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBEdit プロパティ3132003

TDBEdit	オブジェクト順	凡例

Align

AutoSelect

AutoSize

BorderStyle

BoundsRect

Brush

CharCase

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DataField

DataSource

DesignInfo

DragCursor

DragMode

EditText

Enabled

Field

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

IsMasked

Left

MaxLength

Modified

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PasswordChar

PopupMenu

ReadOnly

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

Width

WindowProc


TDBEdit.DataField
TDBEdit.DataField3132004

TDBEdit	参照

DataField プロパティは，編集コントロールがどの項目からデータを表示するか指定します。

property DataField: string;

説明

DataField プロパティは，編集コントロールをデータセットの項目と結合します。データベースの項目を完全に指定するには，データセットとそのデータセット内の項目の両方を定義する必要があります。DataField プロパティで指定した項目を含むデータセットを，編集ボックスコントロールの DataSource プロパティに指定します。

DataField プロパティが整数か浮動小数点データを含むデータベースの項目を表す場合は，そのような項目に有効な文字だけを編集ボックスに入力できます。不当な文字の入力はできません。


TDBEdit.DataSource
TDBEdit.DataSource3132005

TDBEdit	参照

DataSource プロパティは，編集コントロールをそれが表す項目を含むデータセットにリンクします。

property DataSource: TDataSource;

説明

DataSource プロパティは，編集コントロールをデータがあるデータセットにリンクできます。編集コントロールのデータベースの項目を完全に指定するには，データセットとそのデータセット内の項目の両方を定義する必要があります。DataField プロパティを使うと，データセットの特定の項目を指定できます。


TDBEdit.Field
TDBEdit.Field3132006

TDBEdit	参照

Field プロパティは，編集ボックスが表すデータベースの項目の TField オブジェクトを指定します。

property Field: TField;

説明

Field プロパティは，編集ウィンドウを通さずにデータベースの項目の内容とプロパティに直接アクセスできます。Field プロパティを使うと，プログラムでデータベースの項目の内容を変更できます。変更をすぐにデータセットに反映させないで編集ウィンドウの内容を変更するには，かわりに Text プロパティを使います。Text プロパティを変更する場合，ユーザーはその変更を取り消すことができます。


TDBEdit.ReadOnly
TDBEdit.ReadOnly3132007

TDBEdit	参照

ReadOnly プロパティは，ユーザーがデータベース編集ボックスを使ってカレントレコードの項目の値を変更できるかどうかを決めます。

property ReadOnly: Boolean;

説明

ReadOnly プロパティを True に設定すると，ユーザーはデータベースの項目の内容を変更できません。ReadOnly プロパティが True の場合，編集コントロールは項目の内容を表示するためだけに使われます。ReadOnly プロパティが False の場合，データセットが編集モードであればユーザーは項目の値を変更できます。


TDBEdit イベント3132008

TDBEdit	アルファベット順	凡例

TCustomEdit からの継承

OnChange

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBEdit イベント3132009

TDBEdit	オブジェクト順	凡例

OnChange

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBEdit メソッド3132010

TDBEdit	アルファベット順	凡例

TDBEdit

Change

Create

Destroy

EditCanModify

KeyDown

KeyPress

Notification

Reset

TCustomMaskEdit からの継承

Clear

GetTextLen

ValidateEdit

TCustomEdit からの継承

ClearSelection

CopyToClipboard

CutToClipboard

GetSelTextBuf

PasteFromClipboard

SelectAll

SetSelTextBuf

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBEdit メソッド3132011

TDBEdit	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

Change

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClearSelection

ClientToScreen

ContainsControl

ControlAtPos

CopyToClipboard

Create

CreateParented

CutToClipboard

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EditCanModify

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetSelTextBuf

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

KeyDown

KeyPress

MethodAddress

MethodName

NewInstance

Notification

PaintTo

PasteFromClipboard

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

Reset

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetSelTextBuf

SetTextBuf

Show

Update

UpdateControlState

ValidateEdit


TDBEdit.Change
TDBEdit.Change3132012

TDBEdit	参照

Change メソッドは，テキストが変更されたという事実を追跡し，それから継承メソッドを使って OnChange イベントハンドラが割り当てられていればそれを呼び出します。

procedure Change; override;

説明

Change はプロテクトメソッドです。アプリケーションは直接このメソッドを呼び出せません。このメソッドは Windows のイベントによって自動的にトリガされます。Change メソッドはテキストの変更に応答してテキストが変更されたという事実を内部的に追跡します。その後この情報は，データセットに反映すべく変更があるか，またはユーザーがリセットを要求した場合に削除すべき変更があるかどうかを判断するために利用されます。


TDBEdit.Create
TDBEdit.Create3132013

TDBEdit	参照

Create メソッドは，TDBEdit のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TDBEdit オブジェクトを作成できます。設計時にフォームに配置された TDBEdit オブジェクトは自動的に作成されます。

Create メソッドは継承されたコンストラクタをオーバーライドして，編集コントロールのデータベース処理機能を初期化します。


TDBEdit.Destroy
TDBEdit.Destroy3132014

TDBEdit	参照

Destroy メソッドは，TDBEdit のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TDBEdit オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは継承デストラクタをオーバーライドして，表示の問題とデータベースの対話を管理するために割り当てられているヘルパーオブジェクトを解放します。


TDBEdit.EditCanModify
TDBEdit.EditCanModify3132015

TDBEdit	参照

EditCanModify メソッドは，データセットが編集モードにあるかどうかに従ってテキストの編集を許可または拒否します。

function EditCanModify: Boolean; override;

説明

EditCanModify メソッドは，データセットが編集モードの場合にだけコントロールで編集が許可されるように継承メソッドをオーバーライドします。編集コントロールで編集をまったく許可しない場合は，ReadOnly プロパティを設定してください。

注意

EditCanModify は Protected メソッドです。アプリケーションは直接このメソッドを呼び出せません。


TDBEdit.KeyDown
TDBEdit.KeyDown3132016

TDBEdit	参照

KeyDown メソッドは，継承メソッドを補足して，ユーザーが〔Del〕キーまたは〔Shift〕+〔Ins〕キーを押した場合にデータセットを編集モードにします。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

procedure KeyDown(var Key: Word; Shift: TShiftState); override;

説明

KeyDown メソッドは，OnKeyDown イベントハンドラを呼び出す継承メソッドを最初に呼び出します。次に，KeyDown メソッドはユーザーが〔Del〕キーまたは〔Shift〕+〔Ins〕キーを押した場合にデータセットを編集できる状態にします。派生クラスは KeyDown メソッドをオーバーライドして追加のキーの組み合わせを処理できますが，必ず継承メソッドが呼び出されなければなりません。

注意

KeyDown はプロテクトメソッドです。アプリケーションは直接このメソッドを呼び出せません。このメソッドは，Windows のイベントによって自動的に呼び出されます。


TDBEdit.KeyPress
TDBEdit.KeyPress3132017

TDBEdit	参照

KeyPress メソッドは，継承メソッドに機能を追加して，編集コントロールの状態を変更するキー入力を処理します。

procedure KeyPress(var Key: Char); override;

説明

KeyPress メソッドは OnKeyPress イベントハンドラを呼び出す継承メソッドを最初に呼び出します。次に KeyPress メソッドは項目型に対して有効な文字ではない場合，またはデータベースの項目とのリンクがない場合にそのキー入力を破棄します。文字が有効な場合，KeyPress メソッドはデータセットを編集モードにします。

〔Esc〕キーを押すと，KeyPress メソッドは Reset メソッドを呼び出してデータセットに反映されていない編集をすべて破棄します。

注意

KeyPress はプロテクトメソッドです。アプリケーションは直接このメソッドを呼び出せません。このメソッドは，Windows のイベントによって自動的に呼び出されます。


TDBEdit.Notification
TDBEdit.Notification3132018

TDBEdit	参照

Notification メソッドは，継承メソッドをオーバーライドして，DataSource の opRemove 通知に応答します。

TOperation = (opInsert, opRemove);

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

継承メソッドを呼び出してから，Notification メソッドは通知が DataSource の削除を示しているかどうかを確認します。削除を示している場合，Notification は DataSource プロパティを nil に設定します。

派生クラスは Notification メソッドをオーバーライドして追加の通知を処理できますが，必ず継承メソッドが呼び出されなければなりません。

注意

Notification はプロテクトメソッドです。アプリケーションは直接このメソッドを呼び出せません。


TDBEdit.Reset
TDBEdit.Reset3132019

TDBEdit	参照

Reset メソッドは，データセットに反映されていない編集を取り消します。

procedure Reset; override;

説明

Reset メソッドはデフォルトメソッドをオーバーライドして，ユーザーが〔Esc〕キーを押した場合にデータセットに反映されていない編集をすべて取り消します。

注意

Reset はプロテクトメソッドです。アプリケーションは直接このメソッドを呼び出せません。このメソッドは，ユーザーが〔Esc〕キーを押したときに自動的に呼び出されます。


スコープ3132020

published

読み出し／書き込み

読み出し専用


スコープ3132021

protected


スコープ3132022

published


継承3132023

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomEdit

TCustomMaskEdit


TDBEdit 例3132024

TDBEdit


TDBError
TDBError3133001

継承	プロパティ	メソッド	参照

TDBError は EDBEngineError 例外クラスがボーランドデータベースエンジンのエラーを表すために使うオブジェクトです。

ユニット

dbtables

説明

EDBEngineError 例外はボーランドデータベースエンジンのエラーが発生すると生成されます。EDBEngineError は BDE エラーのスタックを読み出し，各エラーごとに独立した TDBError オブジェクトを作成します。TDBError オブジェクトは EDBEngineError の Errors プロパティに含まれています。

BDE エラーのカテゴリおよびサブコードは，BDE.PAS に定義されています。


TDBError プロパティ3133002

TDBError	アルファベット順	凡例

TDBError

Category

ErrorCode

Message

NativeError

SubCode


TDBError プロパティ3133003

TDBError	オブジェクト順	凡例

Category

ErrorCode

Message

NativeError

SubCode


TDBError.Category
TDBError.Category3133004

TDBError

Category プロパティは，ErrorCode が返すエラーのカテゴリです。

property Category: Byte;

説明

Category は BDE エラーコードの上位バイトです。


TDBError.ErrorCode
TDBError.ErrorCode3133005

TDBError	参照

ErrorCode プロパティは，ボーランドデータベースエンジンが返すエラーコードです。

property ErrorCode: DBIResult;

説明

ErrorCode は BDE が返すエラーコードで，Category と SubCode から構成されています。

DBIResult は DBIError 手続きが使う特別な整数型で，BDE エラーコードを保持しています。


TDBError.Message
TDBError.Message3133006

TDBError

Message プロパティは，エラーメッセージのテキストです。

property Message: string;

説明

Message はネイティブ（サーバー）エラーに対するリモートサーバーメッセージ，あるいはサーバー以外で発生したエラーの ErrorCode に関連付けられている BDE メッセージです。


TDBError.NativeError
TDBError.NativeError3133007

TDBError

NativeError プロパティは，サーバーが返すリモートエラーコードです。

property NativeError: Longint;

説明

0 ならばサーバーエラーではありません。


TDBError.SubCode
TDBError.SubCode3133008

TDBError

SubCode プロパティは，ErrorCode が参照するエラーのサブコードです。

property SubCode: Byte;

説明

SubCode は BDE エラーコードの下位バイトです。


TDBError メソッド3133009

TDBError	アルファベット順

TDBError

Create

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDBError メソッド3133010

TDBError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDBError.Create
TDBError.Create3133011

TDBError	参照

Create メソッドは，BDE が返すエラー情報を使って TDBError のインスタンスを初期化します。

constructor Create(ErrorCode: DBIResult);

説明

TDBError の Create メソッドは EDBEngineError の Create メソッドによって呼び出されます。これは，TDBError の Free メソッド が EDBEngineError の Destroy メソッドによって呼び出されるのと同じです。


読み出し／書き込み3133012

読み出し専用


継承3133013

TObject


TDBError 例3133014

TDBError


TDBGridColumns
TDBGridColumns3134001

継承	プロパティ	メソッド	参照

TDBGridColumns オブジェクトは TColumn オブジェクトのコンテナです。

ユニット

dbgrids

説明

各 TDBGridColumns オブジェクトはデータグリッド（TDBGrid コンポーネント）の TColumn オブジェクトのコレクションを保持します。TDBGridColumns は Items 配列にある列のインデックスを保持します。Count プロパティには，TDBGridColumns のコレクションに保持されている列の数が入ります。設計時には，データグリッドの列エディタを使って列を追加，削除，または変更します。


TDBGridColumns プロパティ3134002

TDBGridColumns	アルファベット順	凡例

TDBGridColumns

Grid

Items

State

TCollection からの継承

Count

ItemClass


TDBGridColumns プロパティ3134003

TDBGridColumns	オブジェクト順	凡例

Count

Grid

ItemClass

Items

State


TDBGridColumns.Grid
TDBGridColumns.Grid3134004

TDBGridColumns	参照

Grid プロパティは，TDBGridColumns のインスタンスが属するデータグリッドコントロールを表します。

property Grid: TCustomDBGrid;

説明

Grid プロパティは読み出し専用で，TDBGridColumns オブジェクトを持つデータグリッドコントロール（TDBGrid コンポーネント）を表します。


TDBGridColumns.Items
TDBGridColumns.Items3134005

TDBGridColumns

Items プロパティは，TDBGridColumns のコレクションに保持している列のインデックスを表します。

property Items[Index: Integer]: TColumn default;

説明

Index パラメータの値は TColumn オブジェクトの Index プロパティに対応します。この値はデータグリッドにおける列の位置を表します。


TDBGridColumns.State
TDBGridColumns.State3134006

TDBGridColumns	参照

State プロパティは，データグリッドの列がデータセットの項目に基づいているかどうかを示します。

property State: TDBGridColumnsState;

説明

State プロパティを csDefault に設定した場合には，グリッド列の多くのプロパティは対応するデータセットに依存しなくなります。列の形態や順序などのプロパティは，データセットの項目によって決定されます。列の変更はデータセットの項目に反映され，データセットの項目の変更は列に反映されます。

State プロパティを csCustomized に設定した場合には，データグリッドの列は対応するデータセットとは関係なく作成されます。たとえば，デフォルトでは列タイトルのキャプションは対応する項目の DisplayLabel プロパティと同じですが，State プロパティを csCustomized に設定すると，列タイトルの Caption プロパティと項目の DisplayLabel プロパティはまったく独立した 2 つのプロパティとして変更できます。実際に，カスタマイズした（持続的な）列はデータセットの項目と対応させる必要はありません。

注意

列エディタを使ってデータグリッドの列を設定すると，State プロパティは自動的に csCustomized に設定されます。また，実行時に State プロパティを変更すると，既存の列はすべて削除されます。


TDBGridColumns メソッド3134007

TDBGridColumns	アルファベット順

TDBGridColumns

Add

Create

LoadFromFile

LoadFromStream

RebuildColumns

RestoreDefaults

SaveToFile

SaveToStream

TCollection からの継承

Assign

BeginUpdate

Clear

Destroy

EndUpdate

FindItemID

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDBGridColumns メソッド3134008

TDBGridColumns	オブジェクト順

Add

Assign

BeginUpdate

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

EndUpdate

FieldAddress

FindItemID

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

RebuildColumns

RestoreDefaults

SafeCallException

SaveToFile

SaveToStream


TDBGridColumns.Add
TDBGridColumns.Add3134009

TDBGridColumns	参照

Add メソッドは，新しい TColumn インスタンスを作成して Items 配列に追加します。

function Add: TColumn;

説明

Add メソッドは新しい列を返します。設計時には，データグリッドの列エディタを使ってグリッドに列を追加します。


TDBGridColumns.Create
TDBGridColumns.Create3134010

TDBGridColumns	参照

Create メソッドは，TDBGridColumns オブジェクトを作成し，初期化します。

TColumnClass = class of TColumn;

constructor Create(Grid: TCustomDBGrid; ColumnClass: TColumnClass);

説明

Create メソッドは，データグリッドのインスタンスオブジェクトと TColumn オブジェクト（または TColumn から派生したクラス名）の 2 つのパラメータを取ります。


TDBGridColumns.LoadFromFile
TDBGridColumns.LoadFromFile3134011

TDBGridColumns	参照

LoadFromFile メソッドは，FileName で指定したファイルを読み出して，データを TDBGridColumns オブジェクトにロードします。

procedure LoadFromFile(const Filename: string);

説明

LoadFromFile メソッドを呼び出すと，グリッド列のデータをファイルから取り出して，TDBGridColumns オブジェクトにロードすることができます。


TDBGridColumns.LoadFromStream
TDBGridColumns.LoadFromStream3134012

TDBGridColumns	参照

LoadFromStream メソッドは，ストリームからグリッド列のデータを読み出して，その内容を TDBGridColumns オブジェクトに格納します。

procedure LoadFromStream(S: TStream);

説明

LoadFromStream メソッドを呼び出すと，Stream を読み出して，その内容を TDBGridColumns オブジェクトに格納することができます。


TDBGridColumns.RebuildColumns
TDBGridColumns.RebuildColumns3134013

TDBGridColumns

RebuildColumns メソッドは，既存の列を削除して，グリッドに結び付けられたデータセットから新しい列を生成します。

procedure RebuildColumns;

説明

RebuildColumns メソッドは既存の列をすべて削除し，グリッドが結び付けられているデータセットから新しい列を作成することによって TDBGridColumns オブジェクトを初期化します。グリッドがデータセットに結び付けられていない場合，RebuildColumns メソッドは既存の列をすべて削除するだけで新しい列は作成しません。


TDBGridColumns.RestoreDefaults
TDBGridColumns.RestoreDefaults3134014

TDBGridColumns	参照

RestoreDefaults メソッドは，すべての列をデフォルト設定に戻します。

procedure RestoreDefaults;

説明

RestoreDefaults メソッドは Items 配列全体に対して繰り返し適用されます。このとき，各 TColumn オブジェクトに対して RestoreDefaults メソッドが呼び出されます。このメソッドは TColumn オブジェクトのプロパティに対して加えたすべての変更を無効にし，デフォルト値に戻します。


TDBGridColumns.SaveToFile
TDBGridColumns.SaveToFile3134015

TDBGridColumns	参照

SaveToFile メソッドは，TDBGridColumns オブジェクトを FileName で指定したファイルに保存します。

procedure SaveToFile(const Filename: string);

説明

SaveToFile メソッドを呼び出すと，TDBGridColumns のデータをテキストファイルに保存できます。


TDBGridColumns.SaveToStream
TDBGridColumns.SaveToStream3134016

TDBGridColumns	参照

SaveToStream メソッドは，Stream で指定した名前のストリームに TDBGridColumns オブジェクトの内容を書き込みます。

procedure SaveToStream(S: TStream);

説明

SaveToStream メソッドを呼び出すと，TDBGridColumns のデータをストリームに書き出すことができます。


読み出し／書き込み3134017

読み出し専用


継承3134018

TObject

TPersistent

TCollection


TDBGridColumns 例3134019

TDBGridColumns


TDBGrid
TDBGrid3135001

継承	プロパティ	メソッド	イベント	参照	例

TDBGrid は表のグリッドにデータセットのレコードを表示し，レコードを操作します。

ユニット

dbgrids

説明

TDBGrid オブジェクトをフォームに配置すると，データベーステーブルまたは問い合わせからレコードを表示し，レコードを編集できます。アプリケーションはデータグリッドを使ってデータベースのデータを挿入，削除，編集するか，または単純に表示することができます。

実行時に，ユーザーはデータベースナビゲータ（TDBNavigator）を使ってグリッドのデータ間を移動し，データを挿入，削除，および編集できます。データグリッドを使って行われた編集は，ユーザーがほかのレコードに移動するか，またはアプリケーションを閉じるまで元のデータセットには反映されません。

TDBGrid オブジェクトは TCustomDBGrid で導入される汎用の動作を実装します。TDBGrid オブジェクトは TCustomDBGrid から継承したプロパティの多くをpublishedに設定しますが，新しい動作は何も導入しません。


TDBGrid プロパティ3135002

TDBGrid	アルファベット順	凡例

TCustomDBGrid からの継承

Columns

DataSource

DefaultDrawing

FieldCount

Fields

Options

ReadOnly

SelectedField

SelectedIndex

SelectedRows

TitleFont

TCustomGrid からの継承

BorderStyle

EditorMode

FixedColor

TCustomControl からの継承

Canvas

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBGrid プロパティ3135003

TDBGrid	オブジェクト順	凡例

Align

BorderStyle

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DataSource

DefaultDrawing

DesignInfo

DragCursor

DragMode

EditorMode

Enabled

FieldCount

Fields

FixedColor

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

Left

Name

Options

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ReadOnly

SelectedField

SelectedIndex

SelectedRows

ShowHint

Showing

TabOrder

TabStop

Tag

TitleFont

Top

VCLComObject

Visible

Width

WindowProc


TDBGrid イベント3135004

TDBGrid	アルファベット順	凡例

TCustomDBGrid からの継承

OnCellClick

OnColEnter

OnColExit

OnColumnMoved

OnDrawColumnCell

OnDrawDataCell

OnEditButtonClick

OnTitleClick

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnStartDrag


TDBGrid イベント3135005

TDBGrid	オブジェクト順	凡例

OnCellClick

OnColEnter

OnColExit

OnColumnMoved

OnDblClick

OnDragDrop

OnDragOver

OnDrawColumnCell

OnDrawDataCell

OnEditButtonClick

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnStartDrag

OnTitleClick


TDBGrid メソッド3135006

TDBGrid	アルファベット順

TCustomDBGrid からの継承

Create

DefaultDrawColumnCell

DefaultDrawDataCell

Destroy

ValidFieldIndex

TCustomGrid からの継承

MouseCoord

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBGrid メソッド3135007

TDBGrid	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultDrawColumnCell

DefaultDrawDataCell

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

MouseCoord

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState

ValidFieldIndex


スコープ3135008

published

読み出し／書き込み

読み出し専用


スコープ3135009

published


継承3135010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomGrid

TCustomDBGrid


TDBGrid 例3135011

TDBGrid


TDBImage
TDBImage3136001

継承	プロパティ	メソッド	イベント	参照

TDBImage コントロールはデータセットのカレントレコードの BLOB（バイナリ大規模オブジェクト）項目のグラフィックイメージを表示します。

ユニット

dbctrls

説明

TDBImage を使うとグラフィック項目の値を表せます。TDBImage はフォームがデータセットのグラフィック項目を表示可能にします。TDBImage はユーザーがクリップボードを使ってグラフィックデータを編集できるようにします。アプリケーションが実行中で，データベースイメージコントロールがフォーカスを持っているときは，ユーザーは標準の Windows アクセラレータキー（〔Ctrl〕+〔X〕，〔Ctrl〕+〔C〕，および〔Ctrl〕+〔V〕キー）を使って切り取り，コピー，および張り付けができます。ほかのレコードに移動する前に〔Esc〕キーを押すことでデータベースイメージの元の状態に戻ることができます。

TDBImage のデータベース対応機能が必要でないアプリケーションの場合は，イメージコントロール（TImage）を使うとシステムリソースを節約できます。


TDBImage プロパティ3136002

TDBImage	アルファベット順	凡例

TDBImage

AutoDisplay

BorderStyle

Center

DataField

DataSource

Field

Picture

QuickDraw

ReadOnly

Stretch

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBImage プロパティ3136003

TDBImage	オブジェクト順	凡例

Align

AutoDisplay

BorderStyle

BoundsRect

Brush

Center

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DataField

DataSource

DesignInfo

DragCursor

DragMode

Enabled

Field

Font

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

Picture

PopupMenu

QuickDraw

ReadOnly

ShowHint

Showing

Stretch

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TDBImage.AutoDisplay
TDBImage.AutoDisplay3136004

TDBImage	参照

AutoDisplay プロパティは，データベースイメージコントロールのグラフィック BLOB を自動表示するかどうかを決めます。

property AutoDisplay: Boolean;

説明

AutoDisplay プロパティが True（デフォルト値）なら BLOB 項目の値が変化する（新しいレコードに移動するなど）と，新しいデータのイメージが自動表示されます。

AutoDisplay プロパティが False なら BLOB 項目が変化すると，イメージがクリアされます。データを表示するにはコントロールをダブルクリックするか，コントロールを選択してから〔Enter〕キーを押します。LoadPicture メソッドを呼び出しても，コントロールはデータを表示します。

BLOB 項目の自動ロードが長すぎるなら，AutoDisplay プロパティの値を False に変更してください。


TDBImage.BorderStyle
TDBImage.BorderStyle3136005

TDBImage	参照

BorderStyle プロパティは，データベースイメージコントロールに境界を付けるかどうかを決めます。

property BorderStyle: TBorderStyle;

説明

BorderStyle はデータベースイメージコントロールに一重境界線を付けるかどうかを指定します。以下の値のいずれかを指定します。

値	意味

bsNone	非可視境界

bsSingle	一重境界線


TDBImage.Center
TDBImage.Center3136006

TDBImage	参照

Center プロパティはイメージをイメージコントロールの中央に配置するかどうかを決めます。

property Center: Boolean;

説明

イメージがイメージコントロール内にぴったり収まらない場合，Center を使うとイメージをどのように位置付けるかを指定できます。Center が True の場合，イメージはコントロールの中央に揃えます。Center が False の場合、イメージをコントロールの左上隅に揃えます。

注意

Center は Stretch プロパティが True のときには効果がありません。


TDBImage.DataField
TDBImage.DataField3136007

TDBImage	参照

DataField プロパティはデータベースイメージがどの項目からデータを表示するか指定します。

property DataField: string;

説明

DataField を使うとイメージコントロールをデータセット内の項目に結び付けることができます。データベース項目をすべて指定するには、そのデータセット内のデータセットでデータセットと項目の両方を定義しなければなりません。イメージコントロールの DataSource プロパティは DataField が入っているデータセットを指定します。DataField はグラフィック項目を指定します。


TDBImage.DataSource
TDBImage.DataSource3136008

TDBImage	参照

DataSource プロパティはイメージコントロールをデータセットにリンクします。

property DataSource: TDataSource;

説明

DataSource を使うとイメージコントロールをデータがあるデータセットにリンクできます。イメージコントロールのデータベース項目をすべて指定するには，データセット内でデータセットと項目の両方を定義しなければなりません。DataField プロパティを使うとデータセット内の特定の項目を指定できます。


TDBImage.Field
TDBImage.Field3136009

TDBImage	参照

Field プロパティはデータベースイメージがリンクされている TField コンポーネントを返します。

property Field: TField;

説明

Field を読み出すと，イメージコントロールのウィンドウを経由しないでデータベース項目の内容およびプロパティに直接アクセスできます。Field を使うとデータベース項目の内容をプログラムで変更できます。項目の値を設定しイメージコントロールのウィンドウで表示するには Picture プロパティを使います。


TDBImage.Picture
TDBImage.Picture3136010

TDBImage	参照

Picture プロパティはデータベースイメージコントロールに表示するイメージを決めます。

property Picture: TPicture;

説明

Picture を読み出すと，項目の値を表す TPicture オブジェクトを取得できます。Picture を設定するとグラフィック項目の値をプログラムで変更できます。プロパティの値はアイコン，メタファイル，ビットマップなどのグラフィックオブジェクトが入っている TPicture オブジェクトです。


TDBImage.QuickDraw
TDBImage.QuickDraw3136011

TDBImage	参照

QuickDraw プロパティはイメージをパレットを使って表示するかどうかを指定します。

property QuickDraw: Boolean;

説明

QuickDraw を設定すると，項目値を表示するときにカスタムパレットを使うかどうかを指定できます。False の場合にはパレットが使われ，処理時間はかかりますが可能な限り最高の品質でイメージを表示します。True の場合は特別なパレットは使われず高速で表示されますが，イメージの画質が劣化します。特に 256 色のビデオドライバで 256 色のイメージを表示した場合，劣化が顕著になります。


TDBImage.ReadOnly
TDBImage.ReadOnly3136012

TDBImage	参照

ReadOnly プロパティはイメージコントロールを使って項目の内容をユーザーが変更できるかどうかを決めます。

property ReadOnly: Boolean;

説明

ReadOnly プロパティを True に設定すると，ユーザーがデータベース項目の内容を変更することを防げます。 ReadOnly が True の場合，イメージコントロールは項目の内容を表示するためにのみ使われます。ReadOnly プロパティが False の場合，ユーザーはデータセットが編集モードであれば項目の値を変更できます。


TDBImage.Stretch
TDBImage.Stretch3136013

TDBImage	参照

Stretch プロパティはビットマップおよびメタファイルをデータベースイメージのサイズと形状に合わせるかどうかを決めます。

property Stretch: Boolean;

説明

Stretch を True に設定すると，画像がイメージコントロールのサイズと形状を引き継げます。イメージコントロールがサイズ変更されると，イメージも一緒にサイズ変更されます。Stretch は高さと幅を別々にサイズ変更します。したがって，単に拡大する場合と違い，Stretch はイメージコントロールが画像と同じ形状でないとイメージが歪むことがあります。


TDBImage イベント3136014

TDBImage	アルファベット順	凡例

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBImage イベント3136015

TDBImage	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBImage メソッド3136016

TDBImage	アルファベット順

TDBImage

CopyToClipboard

Create

CutToClipboard

Destroy

LoadPicture

PasteFromClipboard

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBImage メソッド3136017

TDBImage	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

CopyToClipboard

Create

CreateParented

CutToClipboard

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

LoadPicture

MethodAddress

MethodName

NewInstance

PaintTo

PasteFromClipboard

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDBImage.CopyToClipboard
TDBImage.CopyToClipboard3136018

TDBImage	参照

CopyToClipboard メソッドは，データベースイメージコントロールの画像をクリップボードにコピーします。

procedure CopyToClipboard;

説明

CopyToClipboard メソッドを使うと，Picture プロパティで指定されたグラフィックのコピーをクリップボードに送ることができます。


TDBImage.Create
TDBImage.Create3136019

TDBImage	参照

Create メソッドは，TDBImage のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TDBImage オブジェクトをインスタンス化できます。設計時にフォームまたはデータモジュールに配置された TDBImage オブジェクトの場合には，Create メソッドは自動的に呼び出されます。

Create メソッドは，継承コンストラクタを呼び出して汎用コントロールオブジェクトを割り当て，それを初期化した後，以下の動作を行います。

・	csOpaque，csReplicatable を ControlStyle に追加する

・	TabStop，AutoDisplay，および Center を True に設定し，BorderStyle を bsSingle に設定する

・	TPicture オブジェクトを作成して Picture プロパティに代入する

・	コントロールの高さと幅を初期化する

・	データセットとリンクするために必要なヘルパーオブジェクトを作成して初期化する


TDBImage.CutToClipboard
TDBImage.CutToClipboard3136020

TDBImage	参照

CutToClipboard メソッドは，コントロールのイメージを削除し，それをクリップボードにコピーします。

procedure CutToClipboard;

説明

CutToClipboard メソッドは，コントロールのイメージをクリップボードにコピーして，そのイメージをコントロールから削除します。CutToClipboard は関連付けられた項目にヌル値を渡します。


TDBImage.Destroy
TDBImage.Destroy3136021

TDBImage	参照

Destroy メソッドは TDBImage のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TDBImage オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは TDBImage のヘルパーオブジェクトを解放してから継承デストラクタを呼び出します。


TDBImage.LoadPicture
TDBImage.LoadPicture3136022

TDBImage	参照

LoadPicture メソッドは項目に保存されているイメージをデータベースイメージコントロールにロードします。

procedure LoadPicture;

説明

AutoDisplay プロパティの値が False の場合，データベースイメージコントロールのイメージは自動的にはロードされません。AutoDisplay プロパティが False の場合，コントロールにイメージを表示するときに LoadPicture メソッドを呼び出せば，イメージを実行中いつロードするかを制御できます。


TDBImage.PasteFromClipboard
TDBImage.PasteFromClipboard3136023

TDBImage	参照

PasteFromClipboard メソッドはクリップボードの内容をコントロールにコピーします。

procedure PasteFromClipboard;

説明

PasteFromClipboard メソッドを使うと，項目の値にクリップボードに保存されているイメージを設定できます。


スコープ3136024

published

読み出し／書き込み

読み出し専用


スコープ3136025

published


継承3136026

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl


TDBImage 例3136027

TDBImage


TDBListBox
TDBListBox3137001

継承	プロパティ	メソッド	イベント	参照

TDBListBox コントロールはデータベース対応のリストボックスです。TDBListBox コントロールを使うと，ユーザーはリストで項目を選択することにより，データセットのカレントレコードの項目の値を変更できます。

ユニット

dbctrls

説明

TDBListBox を使うと，限定されたセットからの項目値の変更を許可するフォームにリストボックスを追加できます。

TDBListBox のデータベース対応機能が必要でない場合は，リストボックス（TListBox）を使うとシステムリソースを節約できます。

カスタマイズしたリストボックスオブジェクトを作成するには，基本クラスとして TCustomListBox を使ってください。


TDBListBox プロパティ3137002

TDBListBox	アルファベット順	凡例

TDBListBox

DataField

DataSource

Field

Items

ReadOnly

TCustomListBox からの継承

BorderStyle

Canvas

IntegralHeight

ItemHeight

ItemIndex

SelCount

Selected

Style

TopIndex

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowsProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBListBox プロパティ3137003

TDBListBox	オブジェクト順	凡例

Align

BorderStyle

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DataField

DataSource

DesignInfo

DragCursor

DragMode

Enabled

Field

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

IntegralHeight

ItemHeight

ItemIndex

Items

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ReadOnly

SelCount

Selected

ShowHint

Showing

Style

TabOrder

TabStop

Tag

Top

TopIndex

VCLComObject

Visible

Width

WindowsProc


TDBListBox.DataField
TDBListBox.DataField3137004

TDBListBox	参照

DataField プロパティは，リストボックスに表示される値を持つ項目を指定します。

property DataField: string;

説明

DataField プロパティを設定すると，どの項目がリストボックスによって表されるかを指定できます。リストボックスはその項目の現在の値を表示し，ユーザーが現在のレコード上のこの項目の値を設定できるようにします。この項目が入っているデータセットは DataSource プロパティで指定します。


TDBListBox.DataSource
TDBListBox.DataSource3137005

TDBListBox	参照

DataSource プロパティは，リストボックスをデータセットにリンクします。

property DataSource: TDataSource;

説明

データがあるデータセットを識別するデータソースコンポーネントを指定します。リストボックスが項目のデータを表せるようにするには，DataSource プロパティと DataField プロパティの両方を設定しなければなりません。


TDBListBox.Field
TDBListBox.Field3137006

TDBListBox	参照

Field プロパティは，リストボックスがリンクされている TField オブジェクトを返します。

property Field: TField;

説明

プログラムで項目のデータの値を変更するには，Field オブジェクトを使います。


TDBListBox.Items
TDBListBox.Items3137007

TDBListBox	参照

Items プロパティには，リストボックスに表示される文字列を指定します。

property Items;

説明

Items プロパティを使うとユーザーが選択できる値を指定できます。Items は TStrings 型オブジェクトなので， TStrings オブジェクトの Add，Delete，Insert，Exchange，および Move の 5 つのメソッドを使って項目を追加，削除，挿入，移動ができます。たとえば，各文字列をリストボックスに追加するには，次のようなコードを記述します。

DBListBox1.Items.Add('FieldValue');

ItemIndex プロパティはどの項目が選択されているかを示します。


TDBListBox.ReadOnly
TDBListBox.ReadOnly3137008

TDBListBox	参照

ReadOnly プロパティは，リストボックスを使って項目値をユーザーが変更できるかどうかを決めます。

property ReadOnly: Boolean;

説明

ReadOnly プロパティを使うと，リストボックスを表示のためにのみ使用するかどうかを指定できます。ReadOnly が True の場合，リストボックスは現在のレコード上の項目値を表示するためにのみ使われます。ReadOnly が False の場合，ユーザーはリストボックスを使って項目値を Items リスト内の値のいずれかに変更できます。


TDBListBox イベント3137009

TDBListBox	アルファベット順	凡例

TCustomListBox からの継承

OnDrawItem

OnMeasureItem

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBListBox イベント3137010

TDBListBox	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnDrawItem

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMeasureItem

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBListBox メソッド3137011

TDBListBox	アルファベット順

TDBListBox

Create

Destroy

TCustomListBox からの継承

Clear

ItemAtPos

ItemRect

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterFace

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBListBox メソッド3137012

TDBListBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterFace

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

ItemAtPos

ItemRect

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDBListBox.Create
TDBListBox.Create3137013

TDBListBox	参照

Create メソッドは，TDBListBox のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TDBListBox オブジェクトをインスタンス化できます。設計時にフォームまたはデータモジュールに配置された TDBListBox オブジェクトの場合，Create メソッドは自動的に呼び出されます。

継承コンストラクタを呼び出して汎用リストボックスオブジェクトを割り当て，それを初期化した後，Create メソッドはデータセットにリンクするために必要なヘルパーオブジェクトを作成して初期化します。


TDBListBox.Destroy
TDBListBox.Destroy3137014

TDBListBox	参照

Destroy メソッドは，TDBListBox のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TDBListBox オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは TDBListBox のヘルパーオブジェクトを解放してから継承デストラクタを呼び出します。


スコープ3137015

published

読み出し／書き込み

読み出し専用


スコープ3137016

published


継承3137017

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomListBox


TDBListBox 例3137018

TDBListBox


TDBLookupComboBox
TDBLookupComboBox3138001

継承	プロパティ	メソッド	イベント	参照

TDBLookupComboBox は，1 つのデータセット内の項目値のセットを対応するほかのデータセットの値のセットで表すコンボボックスです。

ユニット

dbctrls

説明

TDBLookupComboBox を使うと，ほかのデータセットのデータが必要な項目への入力用に，参照項目からなる便利なドロップダウンリストをユーザーに提供できます。

TDBLookupComboBox は参照項目コンポーネントにリンクしている場合，項目コンポーネントの参照データセット内での項目値と参照値の関係を自動的に読み出します。項目値と参照データセット内の対応する値との関係は，項目コンポーネントとリンクしていない場合に参照コンボボックスのプロパティを使って明示的に設定することもできます。


TDBLookupComboBox プロパティ3138002

TDBLookupComboBox	アルファベット順	凡例

TDBLookupComboBox

DropDownAlign

DropDownRows

DropDownWidth

ListVisible

ReadOnly

Text

TDBLookupControl からの継承

DataField

DataSource

Field

KeyField

KeyValue

ListField

ListFieldIndex

ListSource

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBLookupComboBox プロパティ3138003

TDBLookupComboBox	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DataField

DataSource

DesignInfo

DragCursor

DragMode

DropDownAlign

DropDownRows

DropDownWidth

Enabled

Field

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

KeyField

KeyValue

Left

ListField

ListFieldIndex

ListSource

ListVisible

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ReadOnly

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

Width

WindowProc


TDBLookupComboBox.DropDownAlign
TDBLookupComboBox.DropDownAlign3138004

TDBLookupComboBox	参照

DropDownAlign プロパティは編集ボックスに対するドロップダウンリストの位置を指定します。

TDropDownAlign = (daLeft, daRight, daCenter);

property DropDownAlign: TDropDownAlign;

説明

DropDownAlign を使うと参照コンボボックスの編集ボックスに対するドロップダウンリストの位置を指定できます。ドロップダウンリストは編集ボックスの左，右，または中央に合わせて配置できます。


TDBLookupComboBox.DropDownRows
TDBLookupComboBox.DropDownRows3138005

TDBLookupComboBox	参照

DropDownRows プロパティは TDBLookupComboBox のドロップダウンリストに表示する項目数を指定します。

property DropDownRows: Integer;

説明

参照項目が DropDownRows で指定した数よりも多いときは，参照リストボックスはスクロールバーを表示します。


TDBLookupComboBox.DropDownWidth
TDBLookupComboBox.DropDownWidth3138006

TDBLookupComboBox	参照

DropDownWidth プロパティはドロップダウンリストのピクセル単位での幅です。

property DropDownWidth: Integer;

説明

DropDownWidth を使うとドロップダウンリストの幅をカスタマイズできます。DropDownWidth のデフォルト値は 0 で，ドロップダウンリストはコンボボックスと同じ幅になります。

DropDownWidth プロパティは，複数の参照項目を表示して，データベース参照コンボボックスの列が複数になる場合に便利です。


TDBLookupComboBox.ListVisible
TDBLookupComboBox.ListVisible3138007

TDBLookupComboBox	参照

ListVisible プロパティは参照リストが開いている（ドロップダウンされている）かどうかを示します。

property ListVisible: Boolean;

説明

ListVisible を読み出すと参照値のリストが現在開いている（ドロップダウンされている）かどうかを判別できます。ListVisible が True の場合はリストが開いています。ListVisible が False の場合はリストが閉じています。


TDBLookupComboBox.Text
TDBLookupComboBox.Text3138008

TDBLookupComboBox	参照

Text プロパティはカレントレコードの項目の値に対応する参照値です。

property Text: string;

説明

Text プロパティを読み出すと選択されている参照値を特定できます。Text は参照コンボボックスの編集領域で表示される値です。ReadOnly が False で，データセットが編集モードにあれば，ユーザーは新しい値を入力して Text の値を変更できます。


TDBLookupComboBox イベント3138009

TDBLookupComboBox	アルファベット順	凡例

TDBLookupComboBox

OnCloseUp

OnDropDown

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBLookupComboBox イベント3138010

TDBLookupComboBox	オブジェクト順	凡例

OnClick

OnCloseUp

OnDragDrop

OnDragOver

OnDropDown

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBLookupComboBox.OnCloseUp
TDBLookupComboBox.OnCloseUp3138011

TDBLookupComboBox	参照

OnCloseUp イベントは，開いている（ドロップダウンされている）リストが閉じた直後に発生します。

property OnCloseUp: TNotifyEvent;

説明

OnCloseUp イベントハンドラを記述するとコンボボックスリストが閉じるときに応答できます。リストが閉じると，選択されている参照値に対応する値が項目に代入されます。リストはユーザーの操作または CloseUp メソッドの呼び出しによって閉じることができます。


TDBLookupComboBox.OnDropDown
TDBLookupComboBox.OnDropDown3138012

TDBLookupComboBox	参照

OnDropDown イベントは，コンボボックスが開く（ドロップダウンする）直前に発生します。

property OnDropDown: TNotifyEvent;

説明

OnDropDown イベントハンドラを記述すると参照リストを表示する前に特定のアクションを実行できます。リストはユーザーの操作または DropDown メソッドの呼び出しで開くことができます。


TDBLookupComboBox メソッド3138013

TDBLookupComboBox	アルファベット順

TDBLookupComboBox

CloseUp

Create

DropDown

TDBLookupControl からの継承

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBLookupComboBox メソッド3138014

TDBLookupComboBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

CloseUp

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

DropDown

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDBLookupComboBox.CloseUp
TDBLookupComboBox.CloseUp3138015

TDBLookupComboBox	参照

CloseUp メソッドは開いている（ドロップダウンされている）リストを閉じます。

procedure CloseUp(Accept: Boolean);

説明

CloseUp を呼び出すと参照コンボボックスのリストをプログラムで閉じることができます。Accept パラメータは，項目値を参照リストで選択した値に対応する値で修正するかどうかを決めます。


TDBLookupComboBox.Create
TDBLookupComboBox.Create3138016

TDBLookupComboBox	参照

Create メソッドは TDBLookupComboBox のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出すと，実行時に TDBLookupComboBox オブジェクトをインスタンス化できます。設計時にフォームまたはデータモジュール上に配置された TDBLookupComboBox オブジェクトの場合，Create は自動的に呼び出されます。

継承コンストラクタを呼び出して汎用リストボックスオブジェクトを割り当てて初期化した後，Create はさまざまなヘルパーオブジェクトを作成および初期化します。


TDBLookupComboBox.DropDown
TDBLookupComboBox.DropDown3138017

TDBLookupComboBox	参照

DropDown メソッドは参照リストを開いて（ドロップダウンして），ユーザーが参照値を選択できるようにします。

procedure DropDown;

説明

DropDown を呼び出すと参照リストをプログラムで開くことができます。リストが表示される前に OnDropDown イベントが発生します。


スコープ3138018

published

読み出し／書き込み

読み出し専用


スコープ3138019

published


継承3138020

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TDBLookupControl


TDBLookupComboBox 例3138021

TDBLookupComboBox


TDBLookupControl
TDBLookupControl3139001

継承	プロパティ	メソッド	参照

TDBLookupControl は，レコード項目への入力用に，ほかのデータセットの参照項目からの便利なリストをユーザーに提供するコントロールのための抽象基本クラスです。

ユニット

dbctrls

説明

ユーザーが別のデータセットから対応する値を選択することで値を設定できるようにするコントロールを定義するときに基本クラスとして TDBLookupControl を使います。TDBLookupComboBox と TDBLookupListBox は両方とも TDBLookupControl を継承しているコントロールであり，TDBLookupControl オブジェクトで実装されている自動参照機能をユーザーに提供します。

TDBLookupControl のインスタンスを作成しないでください。代わりに TDBLookupControl の派生オブジェクトをインスタンス化してユーザーが参照値のセットから項目値を設定できるようにします。


TDBLookupControl プロパティ3139002

TDBLookupControl	アルファベット順	凡例

TDBLookupControl

DataField

DataSource

Field

KeyField

KeyValue

ListField

ListFieldIndex

ListSource

ReadOnly

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ParentColor

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBLookupControl プロパティ3139003

TDBLookupControl	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DataField

DataSource

DesignInfo

Enabled

Field

Handle

Height

HelpContext

Hint

KeyField

KeyValue

Left

ListField

ListFieldIndex

ListSource

Name

Owner

Parent

ParentColor

ParentWindow

ReadOnly

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TDBLookupControl.DataField
TDBLookupControl.DataField3139004

TDBLookupControl	参照

DataField プロパティは参照コントロールが表す値を持つ項目を指定します。

property DataField: string;

説明

DataField プロパティは，参照コントロールを DataSource プロパティで指定されたデータセット内の項目に結び付けます。DataField プロパティは参照コントロールからの値を設定できる項目であり，参照コントロールに表示される値を提供する項目ではありません。

DataField プロパティが参照項目コンポーネントを指定する場合，KeyField プロパティまたは ListField プロパティを設定する必要はありません。項目コンポーネントにはデータ項目の値と参照値との関係を示すすべての情報が入っているからです。


TDBLookupControl.DataSource
TDBLookupControl.DataSource3139005

TDBLookupControl	参照

DataSource プロパティは参照コントロールを DataField プロパティが入っているデータセットにリンクします。

property DataSource: TDataSource;

説明

DataSource プロパティは，参照コントロールを表すデータセットのデータソースコンポーネントを指定します。参照コントロールはほかのテーブルの対応する項目の値を表示することでテーブルの項目を表します。DataSource プロパティはコントロールが表す項目のデータセットにリンクします。ListSource は参照コントロールに実際に表示される項目を持つ参照テーブルにリンクします。参照コントロールをデータ編集に使う場合，実際に変更される項目は DataSource 内の項目です。


TDBLookupControl.Field
TDBLookupControl.Field3139006

TDBLookupControl	参照

Field プロパティは参照コントロールが表す TField オブジェクトです。

property Field: TField;

説明

Field オブジェクトを使うと，参照コントロールが表す項目の項目コンポーネントに直接アクセスできます。Field が参照項目の場合，項目コンポーネントのプロパティは項目と参照データセットとの関係を表します。参照コントロールがデータセット以外の参照値のセットを表せるようにするには，DataField プロパティを使って参照項目に結び付けてから TField の LookupList プロパティを使って参照値のリストを指定します。


TDBLookupControl.KeyField
TDBLookupControl.KeyField3139007

TDBLookupControl	参照

KeyField プロパティは，DataField 項目の値と一致する ListSource データセットの項目を指定します。

property KeyField: string;

説明

KeyField は，参照コントロールの ListSource を DataSource にリンクします。 KeyField として指定された項目名は DataField として指定された項目名と同じである必要はありませんが，2 つの項目の値は同じでなければなりません。

ListField を指定したら，参照コントロールが実際に ListField プロパティで表示する項目を選択します。

DataField 項目が参照項目の場合，KeyField または ListField に対して何も指定しないでください。参照コントロールは KeyField にデータ項目の LookupKeyFields プロパティを自動的に使います。


TDBLookupControl.KeyValue
TDBLookupControl.KeyValue3139008

TDBLookupControl	参照

KeyValue プロパティは，KeyField 項目と DataField 項目の共通の値です。

property KeyValue: Variant;

説明

KeyField は（参照コントロールによって表示される値ではなく）参照コントロールに表される値を指定します。KeyValue を設定すると，参照コントロールは ListSource データセットから KeyField の値と KeyValue が一致するレコードを見つけようとします。一致するレコードが見つかると，参照コントロールはそのレコード上の ListField の値を表示します。


TDBLookupControl.ListField
TDBLookupControl.ListField3139009

TDBLookupControl	参照

ListField プロパティは，値が参照コントロールに表示されている 1 つまたは複数の項目を識別します。

property ListField: string;

説明

参照コントロールは，ほかのテーブルで対応する 1 つまたは複数の項目の値をリスト表示することでテーブル内の項目を表します。ListField は実際に表示される参照テーブル内の 1 つまたは複数の項目の名前です。DataField は参照コントロールが実際に表す DataSource 内の項目で，KeyField は参照テーブルで DataField と同じ値を持つ項目です。

リストの項目をすべて指定するには，参照テーブル名と項目名の両方を定義しなければなりません。参照コントロールの ListSource プロパティは参照テーブルのデータセットを指定します。

ListField は複数の項目も表すことができます。項目が複数の場合は各項目をセミコロンで区切ります。

ListField を指定する前に，KeyField プロパティを使って 2 つのデータセット間のリンクを定義してください。ListField を設定しない場合，参照コントロールはデフォルトで KeyField 項目の値を表示します。DataField 項目が参照項目の場合，ListField に対して何も指定しないでください。データコントロールが自動的に ListField として参照項目の LookupResultField プロパティを使います。


TDBLookupControl.ListFieldIndex
TDBLookupControl.ListFieldIndex3139010

TDBLookupControl	参照

ListFieldIndex プロパティは，インクリメントサーチに使われる ListField プロパティの項目を指定します。

property ListFieldIndex: Integer;

説明

ListField プロパティが複数の項目を指定する場合に ListFieldIndex を使うと，どの項目をインクリメンタルサーチに使うかを指定できます。TDBLookupComboBox オブジェクトの場合，ListFieldIndex はコンボボックスの編集ボックス部分に表示する項目も決めます。

ListFieldIndex は， ListField のすべての値が表示されている場合に最も重要な値を最初の位置以外の位置に表示できるようにします。ListFieldIndex の値は ListField プロパティで指定された項目の数よりも小さな値でなければなりません。


TDBLookupControl.ListSource
TDBLookupControl.ListSource3139011

TDBLookupControl	参照

ListSource プロパティは参照コントロールに表示されているデータのデータソースを指定します。

property ListSource: TDataSource;

説明

DataField を KeyField 項目および ListField 項目があるデータソースに設定します。DataField 項目が参照項目の場合，ListSource に対して何も指定しないでください。データコントロールが自動的に参照項目の LookupDataSet プロパティを使ってデータソースを作成します。


TDBLookupControl.ReadOnly
TDBLookupControl.ReadOnly3139012

TDBLookupControl	参照

ReadOnly プロパティはユーザーが参照コントロールを使って DataField 項目の値を変更できるかどうかを決めます。

property ReadOnly: Boolean;

説明

ReadOnly は，参照コントロールを表示のためにのみ使うかどうかを指定します。ReadOnly が True の場合，参照コントロールはカレントレコード上の DataField 項目の値に対応する参照値を表示するためにのみ使われます。ReadOnly が False の場合，ユーザーが参照コントロールを使って項目の値を変更できます。


TDBLookupControl メソッド3139013

TDBLookupControl	アルファベット順	凡例

TDBLookupControl

Create

Destroy

Notification

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBLookupControl メソッド3139014

TDBLookupControl	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Notification

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDBLookupControl.Create
TDBLookupControl.Create3139015

TDBLookupControl	参照

Create メソッドは TDBLookupControl のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出すと，実行時に TDBLookupControl オブジェクトをインスタンス化できます。設計時にフォームまたはデータモジュール上に配置された TDBLookupControl オブジェクトの場合，Create は自動的に呼び出されます。

継承コンストラクタを呼び出して汎用カスタムコントロールを割り当て，それを初期化した後，Create はデータセットとリンクするために必要なヘルパーオブジェクトを作成し，それを初期化します。


TDBLookupControl.Destroy
TDBLookupControl.Destroy3139016

TDBLookupControl	参照

Destroy メソッドは TDBLookupControl のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TDBLookupControl オブジェクトがまだ解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy は TDBLookupControl のヘルパーオブジェクトを解放してから継承デストラクタを呼び出します。


TDBLookupControl.Notification
TDBLookupControl.Notification3139017

TDBLookupControl	参照

Notification メソッドは，DataSource および ListSource の opRemove 通知に応答するために継承されたメソッドをオーバーライドします。

TOperation = (opInsert, opRemove);

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

継承されたメソッドの呼び出し後，Notification は通知が DataSource または ListSource の削除を示すかどうかを調べます。削除を示す場合，Notification はプロパティを nil に設定します。

派生クラスは追加の通知を処理するために Notification メソッドをオーバーライドできますが，継承されたメソッドは必ず呼び出さなければなりません。


スコープ3139018

protected

published

読み出し／書き込み

読み出し専用


スコープ3139019

protected


継承3139020

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl


TDBLookupControl 例3139021

TDBLookupControl


TDBLookupListBox
TDBLookupListBox3140001

継承	プロパティ	メソッド	イベント	参照

TDBLookupListBox は，ほかのデータセットのデータが必要な項目への入力用に，参照項目のリストを提供します。

ユニット

dbctrls

説明

TDBLookupListBox を使うと，ほかのデータセットの項目の値を使って項目値を設定するための参照項目からなる便利なリストをユーザーに提供できます。参照リストボックスは，通常，実際の項目値のよりわかりやすい説明を表す値を表示します。

TDBLookupListBox は参照項目コンポーネントにリンクしている場合，項目コンポーネントの参照データセット内の項目値と参照値の関係を自動的に読み取ります。項目値と参照データセット内でそれに対応する値との関係は，リストボックスが参照項目にリンクしていない場合，参照リストボックスのプロパティを使って明示的に設定できます。


TDBLookupListBox プロパティ3140002

TDBLookupListBox	アルファベット順	凡例

TDBLookupListBox

BorderStyle

ReadOnly

RowCount

SelectedItem

TDBLookupControl からの継承

DataField

DataSource

Field

KeyField

KeyValue

ListField

ListFieldIndex

ListSource

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBLookupListBox プロパティ3140003

TDBLookupListBox	オブジェクト順	凡例

Align

BorderStyle

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DataField

DataSource

DesignInfo

DragCursor

DragMode

Enabled

Field

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

KeyField

KeyValue

Left

ListField

ListFieldIndex

ListSource

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

PopupMenu

ReadOnly

RowCount

SelectedItem

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TDBLookupListBox.BorderStyle
TDBLookupListBox.BorderStyle3140004

TDBLookupListBox	参照

BorderStyle プロパティは参照リストボックスに境界を付けるかどうかを指定します

property BorderStyle: TBorderStyle;

説明

BorderStyle プロパティは，参照リストボックスに境界を付けるかどうかを指定できます。次の値を指定できます。

値	意味

bsNone	非可視境界

bsSingle	一重境界線


TDBLookupListBox.RowCount
TDBLookupListBox.RowCount3140005

TDBLookupListBox	参照

RowCount プロパティはリストボックス内で表示できる行の数を決めます。

property RowCount: Integer;

説明

RowCount プロパティは参照リストボックスに表示される行の数に設定します。リストボックスは指定した行数が表示できるようにサイズ変更されます。リストボックスを（たとえば，その Height プロパティを変更して）サイズ変更すると，新しい高さに一致するように RowCount プロパティの値が変更されます。


TDBLookupListBox.SelectedItem
TDBLookupListBox.SelectedItem3140006

TDBLookupListBox	参照

SelectedItem プロパティは現在選択されているリストボックスに表示される値を格納します。

property SelectedItem: string;

説明

SelectedItem を読み出すと，参照リストボックスを使ってユーザーが選択した値を特定できます。項目が選択されていない場合，SelectedItem は空の文字列です。


TDBLookupListBox イベント3140007

TDBLookupListBox	アルファベット順	凡例

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBLookupListBox イベント3140008

TDBLookupListBox	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBLookupListBox メソッド3140009

TDBLookupListBox	アルファベット順

TDBLookupListBox

Create

TDBLookupControl からの継承

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBLookupListBox メソッド3140010

TDBLookupListBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDBLookupListBox.Create
TDBLookupListBox.Create3140011

TDBLookupListBox	参照

Create メソッドは TDBLookupListBox のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出すと，実行時に TDBLookupListBox オブジェクトをインスタンス化できます。設計時にフォームまたはデータモジュール上に配置された TDBLookupListBox オブジェクトの場合，Create は自動的に呼び出されます。

継承コンストラクタを呼び出して汎用参照コントロールを割り当てて初期化した後，Create はデータセットにリンクするために必要なヘルパーオブジェクトを作成および初期化します。


スコープ3140012

published

読み出し／書き込み

読み出し専用


スコープ3140013

published


継承3140014

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TDBLookupControl


TDBLookupListBox 例3140015

TDBLookupListBox


TLoginDialog
TLoginDialog3141001

継承	プロパティ	メソッド	イベント	参照

TLoginDialog は，アプリケーション内でログインのセキュリティを提供するために使われるログインダイアログボックスです。

ユニット

dblogdlg

説明

TLoginDialog を使うと，アプリケーション内でログインのセキュリティを提供できます。通常，TLoginDialog オブジェクトは LoginDialogEx 関数で作成され，ローカルデータベーステーブルへの安全なアクセスを提供するために使われます。しかし，TLoginDialog は他の型のログインダイアログボックスの基本オブジェクトとしても使うことができます。


TLoginDialog プロパティ3141002

TLoginDialog	アルファベット順	凡例

TCustomForm からの継承

Active

ActiveControl

ActiveMDIChild

ActiveOleControl

BorderIcons

BorderStyle

Canvas

ClientHandle

ClientHeight

ClientRect

ClientWidth

Designer

DropTarget

FormStyle

HelpFile

Icon

KeyPreview

MDIChildCount

MDIChildren

Menu

ModalResult

ObjectMenuItem

OleFormObject

Parent

PixelsPerInch

Position

PrintScale

Scaled

TileMode

Visible

WindowMenu

WindowState

TScrollingWinControl からの継承

AutoScroll

HorzScrollBar

VertScrollBar

TWinControl からの継承

Brush

ClientOrigin

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

Color

ControlState

ControlStyle

Cursor

Enabled

Font

Height

Hint

Left

Name

ParentFont

PopupMenu

ShowHint

Top

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TLoginDialog プロパティ3141003

TLoginDialog	オブジェクト順	凡例

Active

ActiveControl

ActiveMDIChild

ActiveOleControl

Align

AutoScroll

BorderIcons

BorderStyle

BoundsRect

Brush

Canvas

Caption

ClientHandle

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

Designer

DesignInfo

DropTarget

Enabled

Font

FormStyle

Handle

Height

HelpContext

HelpFile

Hint

HorzScrollBar

Icon

KeyPreview

Left

MDIChildCount

MDIChildren

Menu

ModalResult

Name

ObjectMenuItem

OleFormObject

Owner

Parent

ParentFont

ParentWindow

PixelsPerInch

PopupMenu

Position

PrintScale

Scaled

ShowHint

Showing

TabOrder

TabStop

Tag

TileMode

Top

VCLComObject

VertScrollBar

Visible

Width

WindowMenu

WindowProc

WindowState


TLoginDialog イベント3141004

TLoginDialog	アルファベット順	凡例

TCustomForm からの継承

OnActivate

OnClose

OnCloseQuery

OnCreate

OnDeactivate

OnDestroy

OnHelp

OnHide

OnPaint

OnResize

OnShow

TWinControl からの継承

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnMouseDown

OnMouseMove

OnMouseUp


TLoginDialog イベント3141005

TLoginDialog	オブジェクト順	凡例

OnActivate

OnClick

OnClose

OnCloseQuery

OnCreate

OnDblClick

OnDeactivate

OnDestroy

OnDragDrop

OnDragOver

OnHelp

OnHide

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnPaint

OnResize

OnShow


TLoginDialog メソッド3141006

TLoginDialog	アルファベット順	凡例

TLoginDialog

FormShow

TForm からの継承

ArrangeIcons

Cascade

Next

Previous

Tile

TCustomForm からの継承

Close

CloseQuery

Create

CreateNew

DefocusControl

Destroy

FocusControl

GetFormImage

Hide

Print

Release

SendCancelMode

SetFocus

SetFocusedControl

Show

ShowModal

WandChildKey

TScrollingWinControl からの継承

DisableAutoRange

EnableAutoRange

ScrollInView

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TLoginDialog メソッド3141007

TLoginDialog	オブジェクト順	凡例

ArrangeIcons

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

Cascade

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Close

CloseQuery

ContainsControl

ControlAtPos

Create

CreateNew

CreateParented

DefaultHandler

DefocusControl

Destroy

DestroyComponents

Destroying

DisableAlign

DisableAutoRange

Dispatch

DragDrop

Dragging

EnableAlign

EnableAutoRange

EndDrag

FieldAddress

FindComponent

FocusControl

Focused

FormShow

Free

FreeInstance

FreeNotification

FreeOnRelease

GetFormImage

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Next

PaintTo

Perform

Previous

Print

Realign

Refresh

Release

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

ScrollInView

SendCancelMode

SendToBack

SetBounds

SetFocus

SetFocusedControl

SetTextBuf

Show

ShowModal

Tile

Update

UpdateControlState

WandChildKey


スコープ3141008

published

読み出し／書き込み

読み出し専用


スコープ

published


スコープ3141009

published


継承3141010

TObject

TPersistent

TComponent

TControl

TWinControl

TScrollingWinControl

TCustomForm

TForm


TLoginDialog 例3141011

TLoginDialog


TDBMemo
TDBMemo3142001

継承	プロパティ	メソッド	イベント	参照

TDBMemo は，データベース内の項目の表示および編集ができる複数行編集コントロールです。

ユニット

dbctrls

説明

TDBMemo を使うと，長いテキストデータを含む項目を編集したり，そのような項目の内容を表示できます。TDBMemo オブジェクトは，Text プロパティを使って項目の内容を表します。

TDBMemo オブジェクトには複数行のテキストが許されます。このため，TDBMemo オブジェクトは長い文字型項目またはテキストバイナリラージオブジェクト（BLOB）に適しています。短い文字型項目には，TDBEdit コンポーネントが使えないか検討してみてください。

アプリケーションに TDBMemo オブジェクトのデータベース対応機能が不要の場合は，代わりにメモコントロール（TMemo）を使います。


TDBMemo プロパティ3142002

TDBMemo	アルファベット順	凡例

TDBMemo

AutoDisplay

DataField

DataSource

Field

ReadOnly

TCustomMemo からの継承

Alignment

Lines

ScrollBars

WantTabs

WordWrap

TCustomEdit からの継承

BorderStyle

MaxLength

Modified

SelLength

SelStart

SelText

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Text

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBMemo プロパティ3142003

TDBMemo	オブジェクト順	凡例

Align

Alignment

AutoDisplay

BorderStyle

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DataField

DataSource

DesignInfo

DragCursor

DragMode

Enabled

Field

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

Left

Lines

MaxLength

Modified

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ReadOnly

ScrollBars

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

WantTabs

Width

WindowProc

WordWrap


TDBMemo.AutoDisplay
TDBMemo.AutoDisplay3142004

TDBMemo	参照

AutoDisplay プロパティは，データベースメモ内のメモまたはグラフィック BLOB の内容を自動表示するかどうかを決めます。

property AutoDisplay: Boolean;

説明

AutoDisplay プロパティが True の場合，コントロールは BLOB 項目が変更されたとき (新しいレコードに移動した場合など) に新しいデータを自動的に表示します。

AutoDisplay プロパティが False の場合，コントロールは BLOB 項目が変更されたときにも項目名のみを表示します。データを表示するには，コントロールをダブルクリックするか，コントロールを選択してから〔Enter〕を押します。

AutoDisplay プロパティの効果は外観を整えることだけではありません。TDBMemo によって表示されるデータは Text プロパティの値です。AutoDisplay プロパティが False の場合，データが変更されると，Text プロパティの値は項目名になります。このため，AutoDisplay プロパティが False の場合は，アプリケーションで項目の値を確認する際に Text プロパティの値を使うときは注意してください。

LoadMemo メソッドを呼び出すと，Text は BLOB 項目の現在の値を更新します。この変更は，表示されているコントロールの外観にも反映されます。

BLOB 項目の自動ロードに時間がかかりすぎる場合は，AutoDisplay プロパティの値を False にします。

注意

AutoDisplay プロパティは BLOB 項目にのみ適用できます。コントロールが他の型のテキスト項目にバインディングされている場合，AutoDisplay プロパティは無効です。


TDBMemo.DataField
TDBMemo.DataField3142005

TDBMemo	参照

DataField プロパティは，データベースメモがデータを表示する項目の名前を指定します。

property DataField: string;

説明

DataField プロパティは，メモコントロールとリンクするデータセット内の項目を設定します。DataField プロパティを設定しただけでは，メモコントロールはデータベース項目とリンクされません。目的の項目を含むデータセットを DataSource プロパティで指定する必要があります。


TDBMemo.DataSource
TDBMemo.DataSource3142006

TDBMemo	参照

DataSource プロパティは，メモコントロールがデータを表示する項目を含むデータセットにメモコントロールをリンクします。

property DataSource: TDataSource;

説明

メモコントロールをデータセットにリンクするには，DataSource プロパティを目的のデータセットを示すデータソースコンポーネントに設定します。DataField プロパティを使って，データセット内のどの項目がメモデータを含むかを指定します。


TDBMemo.Field
TDBMemo.Field3142007

TDBMemo	参照

Field プロパティは，データベースメモのリンク先となる TField コンポーネントを指定します。

property Field: TField;

説明

Field プロパティは，編集ウィンドウを調べなくともデータベース項目の内容およびプロパティに直接アクセスできます。Field プロパティを使って，データベース項目の内容をプログラム的に変更することができます。

メモコントロールの内容を変更してもそれをデータセット内のレコードにすぐ書き込まない場合は，Text プロパティを使います。Text プロパティを使えば，ユーザーが変更を取り消すことができます。


TDBMemo.ReadOnly
TDBMemo.ReadOnly3142008

TDBMemo	参照

ReadOnly プロパティは，データベースメモの内容を変更可能にするかどうかを決めます。

property ReadOnly: Boolean;

説明

ReadOnly プロパティが True の場合，内容を変更することはできません。ReadOnly プロパティが False であれば，内容を変更できます。

ReadOnly プロパティは，現在のレコードの項目値をデータベースメモで変更可能にするかどうか，すなわちコントロールを値の表示のみに使うかどうかを決めます。ReadOnly プロパティが False の場合，データセットが編集モードであれば項目値は変更可能です。


TDBMemo イベント3142009

TDBMemo	アルファベット順	凡例

TCustomEdit からの継承

OnChange

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBMemo イベント3142010

TDBMemo	オブジェクト順	凡例

OnChange

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBMemo メソッド3142011

TDBMemo	アルファベット順	凡例

TDBMemo

Change

Create

Destroy

KeyDown

KeyPress

LoadMemo

Notification

WndProc

TCustomEdit からの継承

Clear

ClearSelection

CopyToClipboard

CutToClipboard

GetSelTextBuf

PasteFromClipboard

SelectAll

SetSelTextBuf

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBMemo メソッド3142012

TDBMemo	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

Change

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClearSelection

ClientToScreen

ContainsControl

ControlAtPos

CopyToClipboard

Create

CreateParented

CutToClipboard

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetSelTextBuf

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

KeyDown

KeyPress

LoadMemo

MethodAddress

MethodName

NewInstance

Notification

PaintTo

PasteFromClipboard

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetSelTextBuf

SetTextBuf

Show

Update

UpdateControlState

WndProc


TDBMemo.Change
TDBMemo.Change3142013

TDBMemo	参照

Change メソッドは，データソースにテキスト値の変更を通知し，その後で OnChange イベントハンドラを呼び出します。

procedure Change; override;

説明

アプリケーションで Change メソッドを直接呼び出さないで下さい。Change メソッドは Windows イベントによって自動的に呼び出されます。派生クラスは Change メソッドをオーバーライドして Text プロパティへの変更に対する反応を追加することができます。Change メソッドをオーバーライドするクラスは，継承メソッドも呼び出さねばなりません。


TDBMemo.Create
TDBMemo.Create3142014

TDBMemo	参照

Create メソッドは，TDBMemo のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，TDBMemo オブジェクトのインスタンスを作成および初期化できます。Create メソッドは継承コンストラクタをオーバーライドして TDBMemo オブジェクトのデータ処理機能を初期化します。


TDBMemo.Destroy
TDBMemo.Destroy3142015

TDBMemo	参照

Destroy メソッドは，TDBMemo のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TDBMemo オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy メソッドは，コンストラクタに割り当てられたデータ処理と関連付けられたメモリを解放してから，継承コンストラクタを呼び出します。


TDBMemo.KeyDown
TDBMemo.KeyDown3142016

TDBMemo	参照

KeyDown メソッドは，〔Del〕または〔Shift〕+〔Insert〕が押されたときに，継承メソッドをオーバーライドしてデータセットを編集モードにします。

procedure KeyDown(var Key: Word; Shift: TShiftState); override;

説明

KeyDown メソッドは最初に継承メソッドを呼び出し，継承メソッドは OnKeyDown イベントハンドラを呼び出します。次に KeyDown メソッドは〔Del〕または〔Shift〕+〔Insert〕が押されたときにデータセットを編集モードにしようとします。メモコントロールがデータセットにリンクされていない場合，KeyDown メソッドはキー入力を破棄します。派生クラスは KeyDown メソッドをオーバーライドしてキーの組み合わせを追加できますが，継承メソッドは常に呼び出されなければなりません。


TDBMemo.KeyPress
TDBMemo.KeyPress3142017

TDBMemo	参照

KeyPress メソッドは，継承メソッドをオーバーライドして，編集コントロールの状態を変更するキー入力を扱います。

procedure KeyPress(var Key: Char); override;

説明

KeyPress メソッドは，最初に継承メソッドを呼び出し，継承メソッドは OnKeyPress イベントハンドラを呼び出します。次に，KeyPress メソッドはキーの値を調べて，項目型に有効な文字でないか，データベース項目へのリンクがなければ値を破棄します。有効な文字であれば，KeyPress メソッドはデータセットを編集モードに切り替えようとします。

メモコントロールの項目がテキスト BLOB である場合，〔Enter〕を押すことで KeyPress メソッドに LoadMemo メソッドを呼び出させることができます。〔Esc〕を押すと，KeyPress メソッドは未登録の編集内容を破棄します。


TDBMemo.LoadMemo
TDBMemo.LoadMemo3142018

TDBMemo	参照

LoadMemo メソッドは，テキスト BLOB をデータベース内の項目からメモコントロールにロードします。

procedure LoadMemo;

説明

LoadMemo メソッドによってアプリケーションはメモコントロールがいつテキスト BLOB 項目の実際の内容を表示するかを制御できます。LoadMemo メソッドを使うと，メモコントロール内のテキストを現在のレコード内の項目の値に更新できます。LoadMemo メソッドはテキスト BLOB 項目について，AutoDisplay プロパティが False であるときにのみ使えるので，項目の値が自動的に更新されることはありません。


TDBMemo.Notification
TDBMemo.Notification3142019

TDBMemo	参照

Notification メソッドは，継承メソッドをオーバーライドして DataSource プロパティ上の opRemove 通知に反応します。

TOperation = (opInsert, opRemove);

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

継承メソッドを呼び出した後で，Notification メソッドは通知が DataSource プロパティの削除を指示しているかどうかを調べます。指示があれば，Notification プロパティは DataSource プロパティを nil に設定します。

派生クラスは Notification メソッドをオーバーライドして通知の処理を追加できますが，継承メソッドは常に呼び出されなければなりません。


TDBMemo.WndProc
TDBMemo.WndProc3142020

TDBMemo	参照

WndProc メソッドは，メモコントロールに対するメッセージ反応を提供します。

procedure WndProc(var Message: TMessage); override;

説明

WndProc メソッドは TWinControl の WndProc プロパティをオーバーライドして，TDBMemo コントロールの描画に特有のウィンドウメッセージを扱い，他のウィンドウメッセージを継承 WndProc メソッドに送ります。

WndProc プロパティをオーバーライドしてメッセージに特別な反応を提供する派生クラスは，最後に継承 WndProc メソッドを呼び出して他のメッセージをディスパッチしなければなりません。


スコープ3142021

published

読み出し／書き込み

読み出し専用


スコープ3142022

protected


スコープ3142023

published


継承3142024

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomEdit

TCustomMemo


TDBMemo 例3142025

TDBMemo


TDBNavigator
TDBNavigator3143001

継承	プロパティ	メソッド	イベント	参照	例

TDBNavigator コンポーネント（レコード操作ボタン）は，データセットのデータ間の移動と，空白レコードの挿入やレコードの登録などのデータ処理に使います。

ユニット

dbctrls

説明

レコード操作ボタンは，TDBGrid または TDBEdit などのデータベース対応コントロールがあるフォーム上で使います。TDBNavigator は，データを編集したり，表示したりするときのデータセットに対する制御をユーザーに提供します。

ユーザーがレコード操作ボタンの 1 つを選択すると，レコード操作ボタンがリンクしているデータセットで適切なアクションが実行されます。たとえば，ユーザーが［レコードの挿入］ボタンをクリックすると，空白レコードがデータセットに挿入されます。

TDBNavigator は以下のボタンのどれかまたはすべてを表示できます。

ボタン	目的

最初のレコード(nbFirst）	カレントレコードをデータセットの最初のレコードに設定し，［最初のレコード］ボタンと［前のレコード］ボタンを使用不可にし，［次のレコード］ボタンと［最後のレコード］ボタンが使用不可になっていれば使用可能にする

前のレコード(nbPrior)	カレントレコードを前のレコードに設定し，［最後のレコード］ボタンと［次のレコード］ボタンが使用不可になっていれば使用可能にする

次のレコード(nbNext)	カレントレコードを次のレコードに設定し，［最初のレコード］ボタンと［前のレコード］ボタンが使用不可になっていれば使用可能にする

最後のレコード(nbLast)	カレントレコードをデータセットの最後のレコードに設定し，［最後のレコード］ボタンと［次のレコード］ボタンを使用不可にし，［最初のレコード］ボタンと［前のレコード］ボタンが使用不可になっていれば使用可能にする

レコードの挿入(nbInsert)	カレントレコードの前に新しいレコードを挿入し，データセットを挿入と編集の状態にする

レコードの削除(nbDelete)	カレントレコードを削除し，次のレコードをカレントレコードにする

レコードの編集(nbEdit)	データセットを編集状態にし，カレントレコードを変更できるようにする

レコードの登録(nbPost)	カレントレコードへの変更をデータベースに書き込む

編集の取り消し(nbCancel)	カレントレコードへの編集を取り消し，レコードの表示を編集前の状態に戻し，挿入と編集の状態がアクティブになっていればそれを非アクティブにする

データ更新(nbRefresh)	データセットと関連付けられているバッファリングされているデータを更新する。TQuery コンポーネントの場合，このボタンは RequestLive プロパティが True でなければ使用不可になる


TDBNavigator プロパティ3143002

TDBNavigator	アルファベット順	凡例

TDBNavigator

ConfirmDelete

DataSource

Flat

Hints

VisibleButtons

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Height

Hint

Left

Name

Parent

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBNavigator プロパティ3143003

TDBNavigator	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConfirmDelete

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DataSource

DesignInfo

DragCursor

DragMode

Enabled

Flat

Handle

Height

HelpContext

Hint

Hints

Left

Name

Owner

Parent

ParentCtl3D

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

VisibleButtons

Width

WindowProc


TDBNavigator.ConfirmDelete
TDBNavigator.ConfirmDelete3143004

TDBNavigator	参照

ConfirmDelete プロパティは，データセットのカレントレコードを削除するレコード操作ボタンを使う場合，削除を確認するメッセージボックスを表示するかどうかを指定します。

property ConfirmDelete: Boolean;

説明

ConfirmDelete プロパティは，ユーザーが誤ってデータセットからレコードを削除することを防ぐことができます。

ConfirmDelete が True ならば，ユーザーが削除ボタンを押すとメッセージボックスが表示され，［OK］ボタンを選択しないかぎりレコードは削除されません。ConfirmDelete が False ならば，メッセージボックスは表示されずレコードはそのまま削除されます。


TDBNavigator.DataSource
TDBNavigator.DataSource3143005

TDBNavigator	参照

DataSource プロパティは，レコード操作ボタンとそれが制御するデータセットをリンクします。

property DataSource: TDataSource;

説明

DataSource プロパティは，レコード操作ボタンとデータセットをリンクできます。必要なデータがあるデータセットを識別するデータソースコンポーネントを指定してください。


TDBNavigator.Flat
TDBNavigator.Flat3143006

TDBNavigator	参照

Flat プロパティは，レコード操作ボタンを境界のある 3 次元（立体）に見せるか，境界のない 2 次元に見せるかを決定します。

property Flat: Boolean;

説明

Flat が True の場合，レコード操作ボタンに境界は表示されず，平面に見えます。Flat がFalse の場合，ボタンはくっきりと浮き出ます。


TDBNavigator.Hints
TDBNavigator.Hints3143007

TDBNavigator	参照

Hints プロパティは，レコード操作ボタンのヘルプヒントをカスタマイズする手段を提供します。

property Hints: TStrings;

説明

Hints プロパティは，個々のレコード操作ボタンの独自のヘルプヒントを提供できます。各ボタンにはデフォルトのヘルプヒントがあります。Hints を使うと，デフォルトヘルプヒントのどれかまたはすべての値をカスタマイズしたヒントに変更できます。

Hints は文字列のリストです。リストの各文字列は各ボタンのヒントを表します。文字列リストの最初の文字列はレコード操作ボタンの最初のボタン（［最初のレコード］ボタン）のヘルプヒントになります。7 番目のヒントは 7 番目のボタン（［レコードの編集］ボタン）のヘルプヒントになります。

実行時にヒントを指定する場合は，デフォルト値を維持するヘルプヒントに対して空の文字列（''）を入力します。Hints プロパティに対してオブジェクトインスペクタの文字列リストプロパティエディタを使う場合は，該当する行を空白にしておきます。

注意

実行時にヘルプヒントを表示するには，ShowHint プロパティに True を設定します。


TDBNavigator.VisibleButtons
TDBNavigator.VisibleButtons3143008

TDBNavigator	参照

VisibleButtons プロパティ配列は，レコード操作ボタンにどのボタンを表示するかを決めます。

TNavigateBtn = (nbFirst, nbPrior, nbNext, nbLast, nbInsert, nbDelete, nbEdit, nbPost, nbCancel, nbRefresh);

TButtonSet = set of TNavigateBtn;

説明

VisibleButtons プロパティは，表示するレコード操作ボタンを選択できます。VisibleButtons セットからレコード操作ボタンのどれかを除外すると，そのボタンは非表示になるので，ユーザーは特定の操作を実行できなくなります。たとえば，ユーザーの操作をデータセットのレコード表示だけにしたい場合は，VisibleButtons に nbFirst，nbPrior，nbNext，および nbLast だけを入れます。

VisibleButtons には以下の値を指定できます。

ボタン	値	動作

First	nbFirst	最初のレコードに移動する

Prior	nbPrior	前のレコードに移動する

Next	nbNext	次のレコードに移動する

Last	nbLast	最後のレコードに移動する

Insert	nbInsert	空白レコードを挿入する

Delete	nbDelete	カレントレコードを削除する

Edit	nbEdit	カレントレコードの編集を許可する

Post	nbPost	カレントレコードを通知する

Cancel	nbCancel	現在の編集を取り消す

Refresh	nbRefresh	データセット内のデータを再度割り出す


TDBNavigator イベント3143009

TDBNavigator	アルファベット順	凡例

TDBNavigator

BeforeAction

OnClick

TCustomPanel からの継承

OnResize

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnStartDrag


TDBNavigator イベント3143010

TDBNavigator	オブジェクト順	凡例

BeforeAction

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnResize

OnStartDrag


TDBNavigator.BeforeAction
TDBNavigator.BeforeAction3143011

TDBNavigator	参照

BeforeAction イベントは，レコード操作ボタンがクリックされたとき，アクションが実行される前に発生します。

TNavigateBtn = (nbFirst, nbPrior, nbNext, nbLast, nbInsert, nbDelete, nbEdit, nbPost, nbCancel, nbRefresh);

ENavClick = procedure (Sender: TObject; Button: TNavigateBtn) of object;

property BeforeAction: ENavClick;

説明

BeforeAction イベントハンドラを記述すると，ユーザーがレコード操作ボタンをクリックしてデフォルトの応答が発生する前に，特定のアクションを実行できます。


TDBNavigator.OnClick
TDBNavigator.OnClick3143012

TDBNavigator	参照

OnClick イベントは，レコード操作ボタンがクリックされ，アクションが実行された後に発生します。

TNavigateBtn = (nbFirst, nbPrior, nbNext, nbLast, nbInsert, nbDelete, nbEdit, nbPost, nbCancel, nbRefresh);

ENavClick = procedure (Sender: TObject; Button: TNavigateBtn) of object;

property OnClick: ENavClick;

OnClick イベントハンドラを記述すると，クリックイベントに応答することができます。レコード操作ボタンにはクリックされたときのデフォルト動作がすでに設定されているので，OnClick イベントハンドラを記述する必要はありません。

OnClick イベントは以下の場合に発生します。

・	ユーザーがマウスを使ってレコード操作ボタンの 1 つをクリックした

・	レコード操作ボタンにフォーカスが設定されているときにユーザーがスペースバーを押した

・	BtnClick メソッドが呼び出された

注意

OnClick イベントは，クリックされたボタンのデフォルト動作が実行された後に発生します。


TDBNavigator メソッド3143013

TDBNavigator	アルファベット順

TDBNavigator

BtnClick

Create

Destroy

SetBounds

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBNavigator メソッド3143014

TDBNavigator	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

BtnClick

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDBNavigator.BtnClick
TDBNavigator.BtnClick3143015

TDBNavigator	参照

BtnClick メソッドは，レコード操作ボタンのボタンをクリックしたときと同じ動作をしてボタンの動作を起動します。

TNavigateBtn = (nbFirst, nbPrior, nbNext, nbLast, nbInsert, nbDelete, nbEdit, nbPost, nbCancel, nbRefresh);

説明

BtnClick メソッドは，ユーザーではなくアプリケーションにレコード操作ボタンを制御させたい場合に使います。TNavigateBtn 型を Index パラメータの値に指定して BtnClick を呼び出すと，選択したボタンと関連付けられているコマンドを実行できます。

BtnClick を呼び出すと，ボタンのデフォルト動作の後にレコード操作ボタンの OnClick イベントが発生します。


TDBNavigator.Create
TDBNavigator.Create3143016

TDBNavigator	参照

Create メソッドは，TDBNavigator のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TDBNavigator をインスタンス化できます。設計時にフォームまたはデータモジュール上に配置された TDBNavigator オブジェクトの場合，Create は自動的に呼び出されます。

継承コンストラクタを呼び出した後，Create はボタンおよびデータセットとのリンクを管理するために TDBNavigator によって使われるヘルパーオブジェクトを作成し，レコード操作ボタンの外観に影響するいくつかのプロパティを初期化します。


TDBNavigator.Destroy
TDBNavigator.Destroy3143017

TDBNavigator	参照

Destroy メソッドは，TDBNavigator のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TDBNavigator オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy は Create メソッドでインスタンス化されたヘルパーオブジェクトを解放してから継承デストラクタを呼び出します。


TDBNavigator.SetBounds
TDBNavigator.SetBounds3143018

TDBNavigator	参照

SetBounds メソッドは，レコード操作ボタンの境界プロパティをまとめて設定します。

procedure SetBounds(ALeft, ATop, AWidth, AHeight: Integer);

説明

レコード操作ボタンの複数の境界プロパティをまとめて設定する場合に SetBounds を呼び出します。Left，Top，Width，および Height プロパティは，それぞれ ALeft，ATop，AWidth，および AHeight パラメータに渡された値に設定されます。SetBounds はレコード操作ボタンを境界内に収まるように描画します。

境界を個別に設定することもできますが，SetBounds を使うと変更ごとにボタンを再描画することなく一度にまとめて複数の変更を行うことができます。


スコープ3143019

published

読み出し／書き込み

読み出し専用


スコープ3143020

published


継承3143021

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomPanel


TDBNavigator 例3143022

TDBNavigator


TDBRadioGroup
TDBRadioGroup3144001

継承	プロパティ	メソッド	イベント	参照

TDBRadioGroup コンポーネントはデータベースに接続されているラジオボタンのグループを表します。

ユニット

dbctrls

説明

TDBRadioGroup を使うと，データベース対応のラジオボタンのセットをグループ化できます。直接同じコントロールコンポーネント内に入っているラジオボタンは「グループ化されている」といいます。その場合，1 つのラジオボタンにチェックマークを付けると，そのグループ内の他のラジオボタンはすべてチェックマークが外されます。データベースラジオグループは，表示された選択肢のどれか 1 つを項目に入力するようユーザーに義務づける手段を提供します。また，データベースラジオグループは，入力できる値が少ない項目のデータを表示するのにも便利です。

TDBRadioGroup にラジオボタンを追加するには，オブジェクトインスペクタで Items プロパティを編集します。ラジオボタンは Items 内の各文字列をキャプションとしてグループボックス内に表示されます。

ユーザーがラジオボタンを 1 つ選択すると，選択したボタンの「値」が，データセット内の現在のレコードに対するリンク項目の内容になります。オブジェクトインスペクタで Values プロパティを編集して，Values の最初の値が Items の最初の文字列に対応するように,そのボタンの値を編集します。Values の文字列が 1 つも設定されていない場合は，各ボタンのキャプションがその値となります。


TDBRadioGroup プロパティ3144002

TDBRadioGroup	アルファベット順	凡例

TDBRadioGroup

DataField

DataSource

Field

Items

ReadOnly

Value

Values

TCustomRadioGroup からの継承

Columns

ItemIndex

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBRadioGroup プロパティ3144003

TDBRadioGroup	オブジェクト順	凡例

Align

BoundsRect

Brush

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DataField

DataSource

DesignInfo

DragCursor

DragMode

Enabled

Field

Font

Handle

Height

HelpContext

Hint

ItemIndex

Items

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ReadOnly

ShowHint

Showing

TabOrder

TabStop

Tag

Top

Value

Values

VCLComObject

Visible

Width

WindowProc


TDBRadioGroup.DataField
TDBRadioGroup.DataField3144004

TDBRadioGroup	参照

DataField プロパティは，ラジオグループがデータを表示する元となる項目を示します。

property DataField: string;

説明

DataField プロパティは，ラジオグループが表すデータベース項目の名前を指定できます。


TDBRadioGroup.DataSource
TDBRadioGroup.DataSource3144005

TDBRadioGroup	参照

DataSource プロパティは，データベースラジオグループが表示するデータがどこにあるかを示します。

property DataSource: TDataSource;

説明

DataSource プロパティは，テーブルなど，データセットコンポーネントを指す TDataSource オブジェクトを保持します。データセットコンポーネントはアクセスしたいデータベースにリンクされている必要があります。


TDBRadioGroup.Field
TDBRadioGroup.Field3144006

TDBRadioGroup	参照

Field プロパティは，ラジオグループのリンク先の TField コンポーネントを示します。

property Field: TField;

説明

Field プロパティは，リンクされているデータセットコンポーネントがデータベースにアクセスするために作成する TField オブジェクトを保持します。


TDBRadioGroup.Items
TDBRadioGroup.Items3144007

TDBRadioGroup	参照

Items プロパティは，ラジオグループ内のラジオボタンのリストを示します。

property Items: TStrings;

説明

Items プロパティは，ラジオグループ内のラジオボタンのキャプションのリストとなる TStrings オブジェクトを保持します（ラジオボタンを追加または削除するには，オブジェクトインスペクタでこの Items リストを編集します）。これらのキャプションは，Values プロパティでオーバーライドしなければ，ラジオボタンの「値」になります。1 つのボタンを選択すると，そのボタンの値は，データベース内の現在のレコードにリンクされている項目の内容になります。


TDBRadioGroup.ReadOnly
TDBRadioGroup.ReadOnly3144008

TDBRadioGroup	参照

ReadOnly プロパティは，ユーザーがグループ内の別のラジオボタンを選択できるかどうか，つまり項目内のデータを変更できるかどうかを決めます。

property ReadOnly: Boolean;

説明

ReadOnly が True ならば，ラジオグループは現在のレコードからデータを表示しますが，項目の内容を変更するのに使用することはできません。デフォルト値は False です。


TDBRadioGroup.Value
TDBRadioGroup.Value3144009

TDBRadioGroup

Value プロパティは，データベース内の現在のレコードにリンクされている項目の内容です。

property Value: string;

説明

Value プロパティは現在のレコードにリンクされている項目の内容を保持します。ユーザーが別のラジオボタンを選択すると，Value プロパティは変更されます。


TDBRadioGroup.Values
TDBRadioGroup.Values3144010

TDBRadioGroup	参照

Values プロパティは，ボタンのキャプションをオーバーライドしてラジオボタンの値を決めます。

property Values: TStrings;

説明

ユーザーが 1 つのラジオボタンを選択すると，そのボタンの「値」はデータベース内のリンクされている項目に書き込まれます。デフォルトでは，ボタンの値は画面上でボタンの隣に表示されるキャプション，つまり Items プロパティの値です。

ラジオボタンの値をキャプションとは別にしたい場合があります。たとえば，ラジオボタンを使って，内容が「Y」か「N」になるデータベース項目を表すときに，ボタンのキャプションは「Yes」または「No」としたいというような場合です。そのような場合には， Items リストに「Yes」および「No」と入力し，Values リストには「Y」および「N」と入力します。

オブジェクトインスペクタでは Items リストと同じように Values リストを編集することができます。ボタンのキャプションをボタンの値と同じにするには，Values プロパティを空白にしておきます。


TDBRadioGroup イベント3144011

TDBRadioGroup	アルファベット順	凡例

TDBRadioGroup

OnChange

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnStartDrag


TDBRadioGroup イベント3144012

TDBRadioGroup	オブジェクト順	凡例

OnChange

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnStartDrag


TDBRadioGroup.OnChange
TDBRadioGroup.OnChange3144013

TDBRadioGroup	参照

OnChange イベントは，リンクされている項目内のデータをユーザーが変更したときに発生します。

property OnChange: TNotifyEvent

説明

OnChange イベントは，ラジオグループがアクセスするデータベース項目の内容に変更が加えられたときに発生します。OnChange イベントハンドラを使うと，ラジオグループが更新されたときに特別な処理が実行されるようにすることができます。


TDBRadioGroup メソッド3144014

TDBRadioGroup	アルファベット順	凡例

TDBRadioGroup

CanModify

Create

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBRadioGroup メソッド3144015

TDBRadioGroup	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

CanModify

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDBRadioGroup.CanModify
TDBRadioGroup.CanModify3144016

TDBRadioGroup	参照

CanModify メソッドは，ユーザーがグループ内の別のラジオボタンを選択できるかどうかを決めます。

function CanModify: Boolean; override;

説明

CanModify メソッドは，ラジオグループが編集可能なデータソースにリンクされていて，ReadOnly プロパティが False に設定されている場合に True を返します。


TDBRadioGroup.Create
TDBRadioGroup.Create3144017

TDBRadioGroup

Create メソッドは，TDBRadioGroup インスタンスを作成し初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは継承されたコンストラクタメソッドを呼び出してから，データアクセスを制御するのに使う内部オブジェクトおよび変数を初期化します。


TDBRadioGroup.Destroy
TDBRadioGroup.Destroy3144018

TDBRadioGroup

Destroy メソッドは，TDBRadioGroup インスタンスとそのラジオボタンを破棄します。

destructor Destroy; override;

説明

Destroy メソッドは，データアクセスを制御するために内部的に作成されたオブジェクトを解放してから，継承されたデストラクタメソッドを呼び出します。


スコープ3144019

published

読み出し／書き込み

読み出し専用


スコープ3144020

protected


スコープ3144021

published


継承3144022

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomGroupBox

TCustomRadioGroup


TDBRadioGroup 例3144023

TDBRadioGroup


TDBRichEdit
TDBRichEdit3145001

継承	プロパティ	メソッド	イベント	参照

TDBRichEdit オブジェクトは，データセットで書式付きテキストメモ項目を表示および編集できる複数行編集コントロールです。

ユニット

dbctrls

説明

TDBRichEdit オブジェクトは，データベース項目を書式付きテキスト編集コントロールで編集できるようにします。TDBRichEdit は書式付きテキストを入力および処理するためのプロパティとメソッドを提供します。TDBRichEdit 自身は，これらの書式オプションをユーザーが利用できるようにするユーザーインターフェースコンポーネントを提供しません。アプリケーションは TDBRichEdit オブジェクトの書式付きテキスト機能を持つために，ユーザーインターフェースコンポーネントを実装しなければなりません。

TDBRichEdit は項目の内容を表すために Text プロパティを使います。

データベース項目にテキストの書式の情報が含まれない場合，代わりに TDBMemo オブジェクトまたは TDBEdit オブジェクトを使うことを考えてください。

アプリケーションに TDBRichEdit のデータベース対応機能が必要ない場合，書式付きテキスト編集コントロール（TRichEdit）を使I

ます。


TDBRichEdit プロパティ3145002

TDBRichEdit	アルファベット順	凡例

TDBRichEdit

AutoDisplay

DataField

DataSource

Field

ReadOnly

TCustomRichEdit からの継承

DefAttributes

DefaultConverter

HideScrollBars

HideSelection

PageRect

Paragraph

PlainText

SelAttributes

SelLength

SelStart

SelText

TCustomMemo からの継承

Alignment

Lines

ScrollBars

WantReturns

WantTabs

WordWrap

TCustomEdit からの継承

BorderStyle

MaxLength

Modified

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Text

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBRichEdit プロパティ3145003

TDBRichEdit	オブジェクト順	凡例

Align

Alignment

AutoDisplay

BorderStyle

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DataField

DataSource

DefAttributes

DefaultConverter

DesignInfo

DragCursor

DragMode

Enabled

Field

Font

Handle

Height

HelpContext

HideScrollBars

HideSelection

Hint

ImeMode

ImeName

Left

Lines

MaxLength

Modified

Name

Owner

PageRect

Paragraph

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PlainText

PopupMenu

ReadOnly

ScrollBars

SelAttributes

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

WantReturns

WantTabs

Width

WindowProc

WordWrap


TDBRichEdit.AutoDisplay
TDBRichEdit.AutoDisplay3145004

TDBRichEdit	参照

AutoDisplay プロパティは，書式付き編集コントロール内のメモ項目の内容を自動表示するかどうかを指定します。

property AutoDisplay: Boolean;

説明

AutoDisplay が True の場合，BLOB 項目の値が変化する（新しいレコードに移動するなど）と，書式付き編集コントロールが新しいデータを自動表示します。

AutoDisplay が False の場合，BLOB 項目が変化すると，コントロールは項目名だけを表示します。データを表示するには，そのコントロールをダブルクリックするか，コントロールを選択してから Enter を押します。

AutoDisplay の効果は表示だけの問題ではありません。TDBRichEdit オブジェクトに表示されるデータは Text プロパティの値です。AutoDisplay が False の場合，データが変化すると Text プロパティの値はその項目の名前に変わります。したがって，AutoDisplay が False なら，アプリケーションでは，基になる項目の値を確認するために Text プロパティの値を使うときに注意が必要です。

LoadMemo メソッドを呼び出すと Text が BLOB 項目の現在の値に更新されます。この変更によって画面上のコントロールの外観も変わります。

BLOB 項目の自動ロードが長すぎるときは，AutoDisplay の値を False に変更してください。

注意

AutoDisplay は BLOB 項目だけに適用されます。コントロールが別の型のテキスト項目に結び付けられている場合は AutoDisplay は何の効果もありません。


TDBRichEdit.DataField
TDBRichEdit.DataField3145005

TDBRichEdit	参照

DataField プロパティは，書式付き編集コントロールのどの項目がデータを表示するか指定します。

property DataField: string;

説明

DataField プロパティは，書式付き編集コントロールをデータセットの項目に結び付けます。データベース項目を完全に指定するには，データセットとデータセット内の項目の両方を定義しなければなりません。書式付き編集コントロールの DataSource プロパティは DataField を格納するデータセットを指定します。


TDBRichEdit.DataSource
TDBRichEdit.DataSource3145006

TDBRichEdit	参照

DataSource プロパティは，書式付き編集コントロールを，このプロパティで指定される項目があるデータセットにリンクします。

property DataSource: TDataSource;

説明

DataSource プロパティは，書式付き編集コントロールをデータがあるデータセットにリンクします。データベース項目を編集コントロールに完全に指定するには，データセットとデータセット内の項目の両方を定義しなければなりません。DataField プロパティを使うと，データセット内の特定の項目を指定できます。


TDBRichEdit.Field
TDBRichEdit.Field3145007

TDBRichEdit	参照

Field プロパティは，書式付き編集コントロールが表すデータベース項目に TField オブジェクトを指定します。

property Field: TField;

説明

Field プロパティは，編集ウィンドウを経由しないで直接データベース項目の内容およびプロパティにアクセスするために使われます。Field を使うとデータベース項目の内容をプログラムで変更できます。変更をすぐにデータセットに登録しないで編集ウィンドウの内容を変更したい場合は Text プロパティを使ってください。Text プロパティを変更した場合にはその変更を取り消すことができます。


TDBRichEdit.ReadOnly
TDBRichEdit.ReadOnly3145008

TDBRichEdit	参照

ReadOnly プロパティは，ユーザーがデータベースの編集コントロールを使って現在のレコードの項目値を変更できるかどうかを決めます。

property ReadOnly: Boolean;

説明

ReadOnly を True に設定すると，ユーザーによるデータベース項目の変更を防ぐことができます。 ReadOnly が True ならば，編集コントロールを使って項目の内容を表示できるだけです。ReadOnly が False の場合，ユーザーはデータセットが編集モードであれば項目の値を変更できます。


TDBRichEdit イベント3145009

TDBRichEdit	アルファベット順	凡例

TCustomRichEdit からの継承

OnProtectChange

OnResizeRequest

OnSaveClipboard

OnSelectionChange

TCustomEdit からの継承

OnChange

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBRichEdit イベント3145010

TDBRichEdit	オブジェクト順	凡例

OnChange

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnProtectChange

OnResizeRequest

OnSaveClipboard

OnSelectionChange

OnStartDrag


TDBRichEdit メソッド3145011

TDBRichEdit	アルファベット順	凡例

TDBRichEdit

Change

Create

Destroy

KeyDown

KeyPress

LoadMemo

Notification

TCustomRichEdit からの継承

Clear

FindText

GetSelTextBuf

Print

RegisterConversionFormat

TCustomEdit からの継承

ClearSelection

CopyToClipboard

CutToClipboard

PasteFromClipboard

SelectAll

SetSelTextBuf

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBRichEdit メソッド3145012

TDBRichEdit	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

Change

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClearSelection

ClientToScreen

ContainsControl

ControlAtPos

CopyToClipboard

Create

CreateParented

CutToClipboard

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

FindText

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetSelTextBuf

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

KeyDown

KeyPress

LoadMemo

MethodAddress

MethodName

NewInstance

Notification

PaintTo

PasteFromClipboard

Perform

Print

Realign

Refresh

RegisterConversionFormat

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetSelTextBuf

SetTextBuf

Show

Update

UpdateControlState


TDBRichEdit.Change
TDBRichEdit.Change3145013

TDBRichEdit	参照

Change メソッドは，継承されたメソッドがイベントハンドラ（割り当てられている場合）を呼び出す前にテキストが変更されたことをトラックします。

procedure Change; override;

説明

Change はプロテクトメソッドです。アプリケーションで直接呼び出すことはできません。Windows のイベントによって自動的に呼び出されます。Change は，テキストが変更されたことを内部的にトラックすることによってこれらのイベントに応答します。この情報は，ユーザーがリセットを要求した場合にデータセットに登録したり削除したりする変更があるかどうかを知るのに使います。


TDBRichEdit.Create
TDBRichEdit.Create3145014

TDBRichEdit	参照

Create メソッドは，TDBRichEdit のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出すと，実行時に TDBRichEdit オブジェクトをインスタンス化できます。設計時にフォームまたはデータモジュールに配置された TDBRichEdit オブジェクトの場合，Create は自動的に呼び出されます。

Create は継承コンストラクタを呼び出し，汎用の書式付き編集オブジェクトを割り当てて初期化した後，次の処理を行います。

・	ReadOnly を True に設定する

・	AutoDisplay を True に設定する

・	データセットへのリンクに必要なヘルパーオブジェクトを作成および初期化する


TDBRichEdit.Destroy
TDBRichEdit.Destroy3145015

TDBRichEdit	参照

Destroy メソッドは，TDBRichEdit のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TDBRichEdit オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy は TDBRichEdit のヘルパーオブジェクトを解放してから継承デストラクタを呼び出します。


TDBRichEdit.KeyDown
TDBRichEdit.KeyDown3145016

TDBRichEdit	参照

KeyDown メソッドは，ユーザーが〔Del〕または〔Shift〕+〔Ins〕を押したときにデータセットを編集モードにする継承されたメソッドを補完します。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

procedure KeyDown(var Key: Word; Shift: TShiftState); override;

説明

KeyDown はまず継承されたメソッドを呼び出し，それによって OnKeyDown イベントハンドラを呼び出します。次に KeyDown はユーザーが〔Del〕または〔Shift〕+〔Ins〕を押したときにデータセットを編集状態にします。派生クラスは追加のキーの組み合わせを処理するために KeyDown をオーバーライドできますが，継承されたメソッドは必ず呼び出さなくてはなりません。

注意

KeyDown はプロテクトメソッドです。アプリケーションでは直接呼び出すことができません。Windows イベントに応答して自動的に呼び出されます。


TDBRichEdit.KeyPress
TDBRichEdit.KeyPress3145017

TDBRichEdit	参照

KeyPress メソッドは，編集コントロールの状態を変更するキー入力を処理する継承されたメソッドを補完します。

procedure KeyPress(var Key: Char); override;

説明

KeyPress メソッドはまず継承されたメソッドを呼び出し，それによって OnKeyPress イベントハンドラを呼び出します。次に KeyPress はキー値を調べ，項目型に有効な文字でないかデータベース項目へのリンクがない場合にそれを破棄します。有効な文字の場合は KeyPress がデータセットを編集モードにします。

〔Esc〕キーを押すと KeyPress はすべての未登録の編集を破棄します。〔Enter〕キーを押すと KeyPress は書式付き編集コントロールに関連付けられたメモ項目の値をロードするために LoadMemo を呼び出します。

注意

KeyPress はプロテクトメソッドです。アプリケーションでは直接呼び出すことができません。Windows イベントに応答して自動的に呼び出されます。


TDBRichEdit.LoadMemo
TDBRichEdit.LoadMemo3145018

TDBRichEdit	参照

LoadMemo メソッドは，メモ BLOB をデータベースの項目から書式付き編集コントロールにロードします。

procedure LoadMemo;

説明

LoadMemo メソッドは，書式付き編集コントロールがメモ項目の実際の内容をいつ表示するかをアプリケーションで制御できるようにします。LoadMemo を使うと，書式付き編集コントロール内のテキストを現在のレコードの項目値に更新できます。LoadMemo は，AutoDisplay プロパティが Falseで項目値が自動的にロードされないときだけに使います。


TDBRichEdit.Notification
TDBRichEdit.Notification3145019

TDBRichEdit	参照

Notification メソッドは，DataSource についての opRemove 通知に応答するために，継承されたメソッドをオーバーライドします。

TOperation = (opInsert, opRemove);

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

継承されたメソッドの呼び出し後，Notification は通知が DataSource の削除を示すかどうかを調べます。削除を示す場合，Notification は DataSource プロパティを nil に設定します。

派生クラスは追加の通知を処理するために Notification メソッドをオーバーライドできますが，継承されたメソッドは必ず呼び出さなければなりません。

注意

Notification はプロテクトメソッドです．アプリケーションでは直接呼び出すことができません。


スコープ3145020

published

読み出し／書き込み

読み出し専用


スコープ3145021

protected


スコープ3145022

published


継承3145023

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomEdit

TCustomMemo

TCustomRichEdit


TDBRichEdit 例3145024

TDBRichEdit


TDBText
TDBText3146001

継承	プロパティ	メソッド	イベント	参照

TDBText コンポーネントはフォームに項目の値を表示するデータベース対応のコントロールです。

ユニット

dbctrls

説明

TDBText を使うと，データセットのカレントレコードの項目内容をフォームに表示できます。データベーステキストコントロールによって表示される項目値は，ユーザーがテキストコントロールを使って変更することはできません。ユーザーが項目値を編集できるようにするには，かわりに TDBEdit または TDBMemo を使います。

TDBText のデータベース対応機能が必要でない場合は，システムリソースの節約のためにラベルコンポーネント（TLabel）またはスタティックテキストコントロール（TStaticText）を使ってください。


TDBText プロパティ3146002

TDBText	アルファベット順	凡例

TDBText

AutoSize

DataField

DataSource

Field

TCustomLabel からの継承

Alignment

Transparent

WordWrap

TGraphicControl からの継承

Canvas

TControl からの継承

Align

BoundsRect

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDBText プロパティ3146003

TDBText	オブジェクト順	凡例

Align

Alignment

AutoSize

BoundsRect

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlState

ControlStyle

Cursor

DataField

DataSource

DesignInfo

DragCursor

DragMode

Enabled

Field

Font

Height

Hint

Left

Name

Owner

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Tag

Top

Transparent

VCLComObject

Visible

Width

WindowProc

WordWrap


TDBText.AutoSize
TDBText.AutoSize3146004

TDBText	参照

AutoSize プロパティは，データベーステキストコントロールが現在の文字列の幅と高さに合わせて自動的にサイズ変更するかどうかを決めます。

property AutoSize: Boolean;

説明

AutoSize プロパティは，クライアント領域内に項目値の高さと幅が収まるように，データベーステキストコントロールのサイズが自動的に調節されるようにすることができます。AutoSize が False ならば，コントロールのサイズは変更されません。AutoSize が True ならば，コントロールのサイズはキャプションが変更されるたびに調節されます。また，Font プロパティが変更されたときにも，コントロールのサイズは調節されます。

WordWrap が True ならば，データベーステキストコントロールの幅は一定になります。AutoSize も True の場合は，項目値を変更すると，コントロールの高さが変更されます。AutoSize が True で WordWrap が False ならば，コントロールの高さはフォントによって決められ，項目値を変更すると，コントロールの幅が変更されます。


TDBText.DataField
TDBText.DataField3146005

TDBText	参照

DataField プロパティは，データベーステキストコントロールによって表示される値を持つ項目を識別します。

property DataField: string;

説明

DataField プロパティは，データベーステキストコントロールとデータセット内の項目をバインドできます。データベース項目を完全に指定するには，データセットとそのデータセット内の項目の両方を定義する必要があります。コントロールの DataSource プロパティは DataField があるデータセットを指定します。


TDBText.DataSource
TDBText.DataSource3146006

TDBText	参照

DataSource プロパティは，テキストコントロールと，そのテキストコントロールが表示する項目のあるデータセットとをリンクさせます。

property DataSource: TDataSource;

説明

DataSource プロパティは，データベーステキストコントロールとデータのあるデータセットとをリンクできます。コントロールにデータベース項目を完全に指定するには，データセットとそのデータセット内の項目の両方を定義する必要があります。DataField プロパティを使うと，データセット内の特定の項目を指定できます。


TDBText.Field
TDBText.Field3146007

TDBText	参照

Field プロパティは， データベーステキストコントロールが表示するデータベース項目の TField オブジェクトを指定します。

property Field: TField;

説明

項目のデータの値をプログラミングによって変更するには Field オブジェクトを使います。


TDBText イベント3146008

TDBText	アルファベット順	凡例

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBText イベント3146009

TDBText	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDBText メソッド3146010

TDBText	アルファベット順

TDBText

Create

Destroy

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Invalidate

Perform

Refresh

Repaint

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDBText メソッド3146011

TDBText	オブジェクト順

Assign

BeginDrag

BringToFront

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DragDrop

Dragging

EndDrag

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTextBuf

GetTextLen

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Perform

Refresh

RemoveComponent

Repaint

SafeCallException

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update


TDBText.Create
TDBText.Create3146012

TDBText	参照

Create メソッドは，TDBText のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出すと，実行時に TDBText オブジェクトをインスタンス化できます。設計時にフォームまたはデータモジュールに配置された TDBText オブジェクトの場合，Create は自動的に呼び出されます。

継承コンストラクタを呼び出して汎用ラベルオブジェクトを割り当てて初期化した後，Create は以下の処理を実行します。

・	csReplicatable を ControlStyle に追加する

・	AutoSize を False に設定する

・	データセットとリンクするために必要なヘルパーオブジェクトを作成および初期化する


TDBText.Destroy
TDBText.Destroy3146013

TDBText	参照

Destroy メソッドは，TDBText のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TDBText オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy は TDBText のヘルパーオブジェクトを解放してから継承デストラクタを呼び出します。


スコープ3146014

published

読み出し／書き込み

読み出し専用


スコープ3146015

published


継承3146016

TObject

TPersistent

TComponent

TControl

TGraphicControl

TCustomLabel


TDBText 例3146017

TDBText


TDdeClientConv
TDdeClientConv3147001

継承	プロパティ	メソッド	イベント	参照

TDdeClientConv コンポーネントは DDE サーバーアプリケーションと DDE 対話を確立します。

ユニット

ddeman

説明

TDdeClientConv コンポーネントは，アプリケーションを DDE クライアントとして動作させたいときに TDdeClientItem オブジェクトといっしょに使います。TDdeClientConv コンポーネントは，以下のサービスを提供する多くのプロパティ，イベント，メソッドを提供します。

・	指定した DDE トピックで指定した DDE サーバーへリンクする

・	リンクが確立された後，データまたはマクロコマンドを DDE サーバーへ送る

・	DDE サーバーへ送るデータの形式を指定する

・	DDE リンクが開かれたり，閉じられたときに，イベントハンドラが応答できるようにする

TDdeClientItem オブジェクトを TDdeClientConv に関連付けるには，TDdeClientItem オブジェクトの DdeConv プロパティを設定します。


TDdeClientConv プロパティ3147002

TDdeClientConv	アルファベット順	凡例

TDdeClientConv

ConnectMode

Conv

DataMode

DdeFmt

DdeService

DdeTopic

FormatChars

ServiceApplication

WaitStat

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDdeClientConv プロパティ3147003

TDdeClientConv	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConnectMode

Conv

DataMode

DdeFmt

DdeService

DdeTopic

DesignInfo

FormatChars

Name

Owner

ServiceApplication

Tag

VCLComObject

WaitStat


TDdeClientConv.ConnectMode
TDdeClientConv.ConnectMode3147004

TDdeClientConv	参照

ConnectMode プロパティは，フォームが開かれたときに DDE サーバーとのリンクが自動的に確立されるかどうかを指定します。

TDataMode = (ddeAutomatic, ddeManual);

property ConnectMode: TDataMode;

説明

ConnectMode プロパティは，DDE 対話を確立する方法を変更できます。ConnectMode が ddeAutomatic ならば，SetLink によってリンクが定義されているときにそのリンクが確立されます。ConnectMode が ddeManual ならば，アプリケーションは DDE 対話を確立するために OpenLink メソッドまたは PasteLink メソッドを呼び出す必要があります。


TDdeClientConv.Conv
TDdeClientConv.Conv3147005

TDdeClientConv	参照

Conv プロパティは，現在の DDE 対話のハンドルです。

property Conv: HConv;

説明

Conv プロパティは，Windows API 関数呼び出しで必要になったときに DDE 対話のハンドルを取得できます。Conv プロパティは OpenLink または PasteLink によって DDE 対話が確立された後で使用できるようになります。


TDdeClientConv.DataMode
TDdeClientConv.DataMode3147006

TDdeClientConv	参照

DataMode プロパティは，DDE 対話の一部が自動的に実行されるかどうかを決めるプロパティにインターフェースを提供します。

TDataMode = (ddeAutomatic, ddeManual);

property DataMode: TDataMode;

説明

DataMode プロパティは TDdeClientConv に対しては実現されません。派生オブジェクトはこのプロパティを使って RequestData または PokeData 呼び出しなどの DDE 対話の一部を自動的に実行できます。

注意

DDE 対話を確立する方法を指定するには，DataMode ではなく ConnectMode を使います。


TDdeClientConv.DdeFmt
TDdeClientConv.DdeFmt3147007

TDdeClientConv	参照

DdeFmt プロパティは，データ項目を送信または要求するのに使われる標準クリップボード形式を表す整数値です。

property DdeFmt: Integer;

説明

DdeFmt プロパティは，サーバーによって指定されていないときに DDE データ項目の形式を指定できます。


TDdeClientConv.DdeService
TDdeClientConv.DdeService3147008

TDdeClientConv	参照

DdeService プロパティは，DDE クライアントにリンクする DDE サーバーアプリケーションを指定します。

property DDEService: string;

説明

DdeService プロパティは，リンクするサーバーアプリケーションを指定できます。通常は DdeService は DDE サーバーアプリケーションの実行可能メインファイルから .EXE 拡張子を除いたファイル名（と必要ならばパス）です。DDE サーバーが Delphi アプリケーションならば DdeService は拡張子 .DPR または .EXE なしのプロジェクト名です。たとえば，PROJ1.DPR の TDdeServerConv コンポーネントにリンクするには，DdeService に PROJ1 を設定します。

DdeService を指定するには設計時にオブジェクトインスペクタに DDE サーバーアプリケーション名を入力するか［DDE 設定］ダイアログボックスで［リンク貼り付け(P)］を選択します。実行時にリンクを確立するには，SetLink メソッドを使ってサービスとトピックを指定します。

注意

DdeService で必要な値はサーバーアプリケーションによって異なります。サーバーアプリケーションの指定方法に特有な情報についての詳細は，DDE サーバーアプリケーションのマニュアルを参照して下さい。


TDdeClientConv.DdeTopic
TDdeClientConv.DdeTopic3147009

TDdeClientConv	参照

DdeTopic プロパティは，DDE 対話のトピックを指定します。

property DDETopic: string;

説明

DdeTopic プロパティは，サーバー定義の DDE 対話のトピック名を指定できます。DdeTopic はたいていサーバーアプリケーションが使うファイル名（と必要ならばパス）です。 DDE サーバーが Delphi アプリケーションならば，DdeTopic のデフォルトはリンクコンポーネントを持つフォームのキャプションです。DDE クライアントが TDdeServerConv コンポーネントにリンクされている場合，DdeTopic はフォームキャプションではなくサーバー対話コンポーネントの名前です。

DdeTopic を指定するには設計時にオブジェクトインスペクタに DDE トピック名を入力するか［DDE 設定］ダイアログボックスで［リンク貼り付け(P)］を選択します。実行時にリンクを確立するには，SetLink メソッドを使ってサービスとトピックを指定します。

注意

DDE 対話で利用可能なトピック名はサーバーアプリケーションが定義します。利用可能なトピック名についての詳細は DDE サーバーアプリケーションのマニュアルを参照してください。


TDdeClientConv.FormatChars
TDdeClientConv.FormatChars3147010

TDdeClientConv	参照

FormatChars プロパティは，DDE サーバーアプリケーションから転送されたテキストデータの特定の文字にフィルタをかけるかどうか指定します。

property FormatChars: Boolean;

説明

FormatChars プロパティは，テキストデータといっしょにバックスペース文字，改行コード，復帰コード，タブを転送する DDE サーバーアプリケーションで使います。これは，DDE クライアントデータに不正な空白，改行，文字を生成することがあります。形式設定文字がクライアントデータの形式設定に影響を与えないようにするには，FormatChars を False に設定します。DDE サーバーによって送信された形式設定文字も含まれるようにするには，FormatChars を True に設定します。


TDdeClientConv.ServiceApplication
TDdeClientConv.ServiceApplication3147011

TDdeClientConv	参照

ServiceApplication プロパティは，DDE サーバーアプリケーションのメイン実行可能ファイル名（と必要であればパス）から .EXE 拡張子を除いたものを指定します。

property ServiceApplication: string;

説明

ServiceApplication プロパティにはサーバーアプリケーションの名前を設定します。通常，これは DdeService プロパティと同じ値です。しかし，DdeService の値は DDE サーバーアプリケーションの実行可能ファイル名以外の場合もあります。

TDdeClientConv が DDE 対話を確立しようとしたときに，サーバーアプリケーションが実行されていない場合，OpenLink は ServiceApplication プロパティを使ってサーバーを起動します。


TDdeClientConv.WaitStat
TDdeClientConv.WaitStat3147012

TDdeClientConv	参照

WaitStat プロパティは，非同期 DDE トランザクションを禁止する DDE マクロのサービスをサーバーが処理中であるかどうかを示します。

property WaitStat: Boolean;

説明

WaitStat プロパティは，DDE トランザクションを開始できるかどうかを取得できます。WaitStat が True のときは，サーバーは最後のマクロを処理中で，マクロの実行，データの要求，またはデータの送信は失敗します。WaitStat が False のときは，サーバーは DDE 対話で次のトランザクションを実行できます。


TDdeClientConv イベント3147013

TDdeClientConv	アルファベット順	凡例

TDdeClientConv

OnClose

OnOpen


TDdeClientConv イベント3147014

TDdeClientConv	オブジェクト順	凡例

OnClose

OnOpen


TDdeClientConv.OnClose
TDdeClientConv.OnClose3147015

TDdeClientConv	参照

OnClose イベントは，何らかの理由で DDE 対話が終了したときに発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnClose: TNotifyEvent;

説明

OnClose イベントハンドラを記述すると，DDE 対話が終了したときに特定の処理が実行されるようにすることができます。DDE 対話は，サーバーが対話を終了した場合，リンクが閉じられるか変更された場合，または TDdeClientConv オブジェクトが破棄された場合に終了します。


TDdeClientConv.OnOpen
TDdeClientConv.OnOpen3147016

TDdeClientConv	参照

OnOpen イベントは，サーバーとの DDE リンクが確立されるとすぐに発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnOpen: TNotifyEvent;

説明

OnOpen イベントハンドラを記述すると，DDE サーバーとのリンクが確立したときに特定の処理が実行されるようにすることができます。DDE リンクは OnOpen メソッドまたは PasteLink メソッドによって確立されます。また，ConnectMode が ddeAutomatic の場合は，SetLink が DDE リンクを確立することもあります。サーバーアプリケーションが起動できなかったりしたために，リンクが失敗した場合は, OnOpen は呼び出されません。


TDdeClientConv メソッド3147017

TDdeClientConv	アルファベット順

TDdeClientConv

CloseLink

Create

Destroy

ExecuteMacro

ExecuteMacroLines

OpenLink

PasteLink

PokeData

PokeDataLines

RequestData

SetLink

StartAdvise

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDdeClientConv メソッド3147018

TDdeClientConv	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CloseLink

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteMacro

ExecuteMacroLines

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

OpenLink

PasteLink

PokeData

PokeDataLines

RemoveComponent

RequestData

SafeCallException

SetLink

StartAdvise


TDdeClientConv.CloseLink
TDdeClientConv.CloseLink3147019

TDdeClientConv	参照

CloseLink メソッドは，実行中の DDE 対話を終了します。

function CloseLink;

説明

CloseLink メソッドは，DDE サーバーとの通信をすべて終了するときに使います。リンクを解除すると DDE クライアントとサーバー間の DDE 対話は新しくリンクを確立するまでできません。


TDdeClientConv.Create
TDdeClientConv.Create3147020

TDdeClientConv	参照

Create メソッドは，TDdeClientConv のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，TDdeClientConv のインスタンスを作成できます。継承されたコンストラクタを呼び出した後，Create は個々の DDE クライアント項目を管理するのに使うヘルパーオブジェクトを作成します。


TDdeClientConv.Destroy
TDdeClientConv.Destroy3147021

TDdeClientConv	参照

Destroy メソッドは，TDdeClientConv のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TDdeClientConv オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy はサーバーとのリンクを解除し，すべてのヘルパーオブジェクトを解放してから，継承デストラクタを呼び出します。


TDdeClientConv.ExecuteMacro
TDdeClientConv.ExecuteMacro3147022

TDdeClientConv	参照

ExecuteMacro メソッドは，DDE サーバーアプリケーションにマクロコマンド文字列を送信します。

function ExecuteMacro(Cmd: PChar; WaitFlg: Boolean): Boolean;

説明

ExecuteMacro メソッドを呼び出すと，サーバーアプリケーションに 1 つのマクロコマンドを送信できます。複数のマクロコマンドを送信するには，ExecuteMacro ではなくExecuteMacroLines を使用します。マクロを DDE サーバーアプリケーションに渡すのに成功すると，ExecuteMacro は True を返します。コマンド文字列を送信できないと，ExecuteMacro は False を返します。

Cmd はヌルで終わる文字列で，DDE サーバーアプリケーションが実行するマクロを含んでいます。Cmd の実際の値は DDE サーバーアプリケーションによって決まります。指定できるコマンド文字列については DDE サーバーアプリケーションのマニュアルを参照してください。

WaitFlg は，他の DDE トランザクションを実行する場合に，DDE サーバーアプリケーションがマクロの実行を完了するのを DDE クライアントが待つかどうかを指定します。WaitFlg が True ならば，以降の ExecuteMacro，ExecuteMacroLines，PokeData，PokeDataLines，RequestData の呼び出しは，DDE サーバーアプリケーションがマクロを完了するまで成功しません。

DDE サーバーアプリケーションが現在実行中のマクロを完了しないうちに，マクロを実行しようとするかデータを送信しようとすると，実行中のマクロは失敗するか，予想外の結果を生じることがあります。マクロの完了前にコマンド文字列を送信したりデータを送信した結果については，DDE サーバーアプリケーションのマニュアルを参照してください。

注意

マクロコマンドが正常に DDE サーバーに渡された場合は，ExecuteMacro は True を返します。True 値が返され，マクロコマンドがサーバーに受け入れられた場合でも，マクロコマンドが正常に実行されたことが保証されるわけではありません。


TDdeClientConv.ExecuteMacroLines
TDdeClientConv.ExecuteMacroLines3147023

TDdeClientConv	参照

ExecuteMacroLines メソッドは，マクロコマンド文字列リストを DDE サーバーアプリケーションに送信します。

function ExecuteMacroLines(Cmd: TStrings; WaitFlg: Boolean): Boolean;

説明

ExecuteMacroLines メソッドを呼び出すと，サーバーアプリケーションに複数のマクロコマンドを送信できます。単一のマクロコマンドを送信するには，ExecuteMacroLines ではなく ExecuteMacro を使用します。マクロを正しく DDE サーバーに渡すと，ExecuteMacroLines は True を返します。ExecuteMacroLines がコマンド文字列リストを送信できないと，ExecuteMacroLines は False を返します。

Cmd は DDE サーバーアプリケーションが実行するマクロを含んでいます。WaitFlg は，他の DDE トランザクションを送信する場合に，DDE サーバーアプリケーションがすべてのマクロの実行を完了するのを DDE クライアントが待つかどうかを指定します。WaitFlg が True に設定されている場合は，以降の ExecuteMacro，ExecuteMacroLines，PokeData，PokeDataLines，RequestData の呼び出しは，DDE サーバーアプリケーションがすべてのマクロを完了するまで成功しません。


TDdeClientConv.OpenLink
TDdeClientConv.OpenLink3147024

TDdeClientConv	参照

OpenLink メソッドは，新しい DDE 対話を開始します。

function OpenLink: Boolean;

説明

OpenLink メソッドを呼び出すと，DdeService との新しい DDE 対話を確立できます。サーバーアプリケーションが実行されていない場合，OpenLink は ServiceApplication を起動します。対話が正しく開かれた場合，OnOpen イベントが発生し，OpenLink は True を返します。対話が正しく開かれなかった場合，OpenLink は False を返します。

注意

ConnectMode が ddeAutomatic ならば，OpenLink は，SetLink によって DdeTopic および DdeService が指定されていれば自動的に呼び出されます。


TDdeClientConv.PasteLink
TDdeClientConv.PasteLink3147025

TDdeClientConv	参照

PasteLink メソッドは，現在のクリップボードオブジェクトとの DDE 対話を開きます。

function PasteLink: Boolean;

説明

PasteLink メソッドを呼び出すと，クリップボードにあるオブジェクトとの DDE リンクを確立できます。PasteLink は，クリップボードから DdeTopic または DdeService プロパティを設定します。リンクが正常に確立されると，PasteLink は True を返します。


TDdeClientConv.PokeData
TDdeClientConv.PokeData3147026

TDdeClientConv	参照

PokeData メソッドは，DDE サーバーアプリケーションにデータを送ります。

function PokeData(Item: string; Data: PChar): Boolean;

説明

PokeData メソッドは，送信されたデータをサポートしている DDE サーバーにテキストデータを転送できます。Item は DDE サーバー内のリンク項目を指定します。Data はヌルで終わる文字列で，転送するテキストデータを指定します。

DDE 項目の値はリンクされた DDE サーバーアプリケーションによって決まります。通常，Item はテキストの選択可能部分，つまり編集ボックス内にある表計算ワークシートのセルやデータベース項目などです。DDE サーバーが Delphi アプリケーションならば，Item はリンクされた DDE サーバーコンポーネントの名前です。

通常，データは DDE サーバーから DDE クライアントアプリケーションへ流れます。一部の DDE サーバーアプリケーションは転送データを受け入れません。PokeData はデータが正常に転送されたら True を，正常に転送されなかったら False を返します。

1 つの文字列だけでなく文字列リストを転送する必要がある場合は PokeDataLines メソッドを使います。

注意

WaitFlg パラメータを True に設定して ExecuteMacro メソッドか ExecuteMacroLines メソッドを呼び出した場合，サーバーアプリケーションがマクロの実行を完了するまでは PokeData は自動的に失敗になります。WaitStat プロパティは，PokeData がサーバーにデータを送信するタイミングを示します。


TDdeClientConv.PokeDataLines
TDdeClientConv.PokeDataLines3147027

TDdeClientConv	参照

PokeDataLines メソッドは，DDE サーバーアプリケーションに複数のデータを送ります。

function PokeDataLines(Item: string; Data: TStrings): Boolean;

説明

PokeDataLines メソッドは，送信されたデータをサポートしている DDE サーバーに複数行のテキストデータを転送できます。Item は DDE サーバー内のリンク項目を指定します。Data は転送するテキストデータを指定する文字列のセットです。

DDE 項目の値はリンクされた DDE サーバーアプリケーションによって決まります。通常，Item はテキストの選択可能部分，つまり編集ボックス内にある表計算ワークシートのセルやデータベース項目などです。DDE サーバーが Delphi アプリケーションならば，Item はリンクされた DDE サーバーコンポーネントの名前です。

通常，データは DDE サーバーから DDE クライアントアプリケーションへ流れます。一部の DDE サーバーアプリケーションは転送データを受け入れません。PokeDataLines はデータが正常に転送されたら True を，正常に転送されなかったら False を返します。

文字列リストでなく 1 つの文字列だけを転送する必要がある場合は PokeData メソッドを使います。

注意

WaitFlg パラメータを True に設定して ExecuteMacro メソッドか ExecuteMacroLines メソッドを呼び出した場合，サーバーアプリケーションがマクロの実行を完了するまでは PokeData は自動的に失敗になります。WaitStat プロパティは，PokeData がサーバーにデータを送信するタイミングを示します。


TDdeClientConv.RequestData
TDdeClientConv.RequestData3147028

TDdeClientConv	参照

RequestData メソッドは，DDE サーバーにデータを要求します。

function RequestData(const Item: string): PChar;

説明

RequestData メソッドを呼び出すと，Item で指定したデータの要求を DDE サーバーに送信できます。RequestData は，指定した DDE サーバー項目の値を返します。RequestData は，返されたデータを格納するメモリを自動的に割り当てますが，アプリケーションはこの PChar 文字列を処理後に破棄する必要があります。破棄には StrDispose 関数を使います。

DDE サーバーに，頻繁に更新されることのある DDE 項目が含まれている場合は，それらの項目用の TDdeClientItem オブジェクトを作成すれば，データは自動的に受信および更新することができます。

この DDE 項目の値はリンクされた DDE サーバーアプリケーションによって決まります。通常，Item はテキストの選択可能部分，つまり編集ボックス内にある表計算ワークシートのセルやデータベース項目などです。DDE サーバーが Delphi アプリケーションならば，Item はリンクされた DDE サーバーコンポーネントの名前です。

注意

DdeItem の指定についての詳細は DDE サーバーアプリケーションのマニュアルを参照してください。


TDdeClientConv.SetLink
TDdeClientConv.SetLink3147029

TDdeClientConv	参照

SetLink メソッドは，DDE 対話のサービスとトピックを指定し，ConnectMode が ddeAutomatic ならばリンクを開こうとします。

function SetLink(Service: string; Topic: string): Boolean;

説明

SetLink メソッドを呼び出すと，DDE 対話を完全に指定できます。ConnectMode が ddeManual ならば，SetLink を呼び出すことは，DdeTopic および DdeService プロパティを設定して，関連付けられている TDdeClientItem オブジェクトからすべてのデータを削除することと同じです。ConnectMode が ddeAutomatic の場合には，SetLink は DDE サーバーとのリンクも確立します。

Service および Topic パラメータは，それぞれ DdeTopic および DdeService プロパティの値を指定します。


TDdeClientConv.StartAdvise
TDdeClientConv.StartAdvise3147030

TDdeClientConv	参照

StartAdvise メソッドは，現在の DDE 対話に関連付けられているすべての TDdeClientItems に対してアドバイスループを開始します。

function StartAd vise: Boolean;

説明

StartAdvise メソッドを呼び出すと，現在の DDE 対話に関連付けられているすべての TDdeClientItems に対してアドバイスループを開始できます。ループの開始が成功すると，StartAdvise は True を返します。


スコープ3147031

published

読み出し／書き込み

読み出し専用


スコープ3147032

published


継承3147033

TObject

TPersistent

TComponent


TDdeClientConv 例3147034

TDdeClientConv


TDdeClientItem
TDdeClientItem3148001

継承	プロパティ	メソッド	イベント	参照

TDdeClientItem コンポーネントは DDE 対話の項目を定義します。

ユニット

ddeman

説明

TDdeClientItem を TDdeClientConv と一緒に使うと，アプリケーションを DDE クライアントとして機能させることができます。DDE クライアント項目は，DDE サーバーがサポートする項目を 1 つ指定します。また，1 つの TDdeClientConv オブジェクトが複数のクライアント項目に関連付けられる場合もあります。DDE クライアント対話で DDE サーバーとのリンクが確立されている場合，サーバーは対話が終了するまで自動的にすべてのクライアント項目の更新を続けます。


TDdeClientItem プロパティ3148002

TDdeClientItem	アルファベット順	凡例

TDdeClientItem

DdeConv

DdeItem

Lines

Text

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDdeClientItem プロパティ3148003

TDdeClientItem	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DdeConv

DdeItem

DesignInfo

Lines

Name

Owner

Tag

Text

VCLComObject


TDdeClientItem.DdeConv
TDdeClientItem.DDEConv3148004

TDdeClientItem	参照

DDEConv プロパティは，DDE クライアント項目に関連付ける DDE クライアント対話を指定します。

property DdeConv: TDDEClientConv;

説明

DDEConv プロパティを設定すると，DDE クライアント対話に DDE クライアント項目を関連付けることができます。DDEConv の値は DDE 対話を定義する DDE クライアント対話オブジェクトの名前です。DDEConv は，DDE クライアント項目の Text を提供するサーバーへのリンクを確立します。


TDdeClientItem.DdeItem
TDdeClientItem.DdeItem3148005

TDdeClientItem	参照

DdeItem プロパティは，DDE 対話の項目を指定します。

property DDEItem: string;

説明

DdeItem プロパティには，DDE サーバーがサポートする DDE 項目の名前を設定します。DdeItem の値はリンク DDE サーバーアプリケーションによって決まります。DdeItem は選択可能なテキスト部分（編集ボックスのスプレッドシートセルまたはデータベース項目など）です。DDE サーバーが Delphi アプリケーションならば，DdeItem はリンクする DDE サーバー項目の名前です。

設計時に DdeItem を指定するには，オブジェクトインスペクタに項目文字列を入力します。あるいは，［DDE 設定］ダイアログボックスを使ってリンクを貼り付けることで DDE 対話から指定することもできます。［DDE 設定］ダイアログボックスはオブジェクトインスペクタで DdeService または DdeTopic の省略記号（...）ボタンをクリックすると呼び出されます。［DDE 設定］ダイアログボックスで［リンク貼り付け(P)］を選択し，リンク情報がクリップボードにあるときは，オブジェクトインスペクタで DdeItem 用のリストから項目を選択します。

注意

DDE 項目を指定する方法については DDE サーバーアプリケーションのマニュアルを参照してください。


TDdeClientItem.Lines
TDdeClientItem.Lines3148006

TDdeClientItem	参照

Lines プロパティは，DDE 対話で交換するテキストデータを示します。

property Lines: TStrings;

説明

Lines プロパティは，DDE サーバーアプリケーションで更新されるテキストを取得できます。Lines は DDE サーバーによって自動的に更新されます。Lines がサーバーによって変更されると，OnChange イベントが発生します。

Lines プロパティは，DDE サーバーにデータを送るときに設定します。

Lines は Text プロパティに対応しています。Lines または Text の値を更新すると必ずもう一方も変更されるので，Lines の 1 行目は常に Text に等しくなります。

注意

DDE クライアント対話の PokeDataLines メソッドを呼び出して，Lines 内のデータを DDE サーバーに送ることもできます。


TDdeClientItem.Text
TDdeClientItem.Text3148007

TDdeClientItem	参照

Text プロパティは，DDE 対話で交換するテキストデータが入っています。

property Text: string;

説明

Text プロパティは，DDE サーバーアプリケーションによって更新されるテキストを取得できます。Text は DDE サーバーによって自動的に更新されます。Text がサーバーによって変更されると OnChange イベントが発生します。

Text プロパティを設定すると，DDE サーバーにデータを送ることができます。

Text は Lines プロパティに対応しています。Lines または Text の値を更新すると必ずもう一方も変更されるので，Lines の 1 行目は常に Text に等しくなります。

Text に指定できるのは 1 行だけです。テキストデータが複数行にわたる場合は Lines プロパティを使ってください。

注意

DDE クライアント対話の PokeData メソッドを呼び出して，データを DDE サーバーに送ることもできます。


TDdeClientItem イベント3148008

TDdeClientItem	アルファベット順	凡例

TDdeClientItem

OnChange


TDdeClientItem イベント3148009

TDdeClientItem	オブジェクト順	凡例

OnChange


TDdeClientItem.OnChange
TDdeClientItem.OnChange3148010

TDdeClientItem	参照

OnChange イベントは，DDE サーバーが Lines プロパティを更新した直後に発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラを記述すると，DDE サーバーが DDE クライアント項目のテキストを更新したときに特定のアクションを実行できます。DDE クライアント項目の新しい値を確認するには，Lines または Text プロパティを読み出します。


TDdeClientItem メソッド3148011

TDdeClientItem	アルファベット順

TDdeClientItem

Create

Destroy

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDdeClientItem メソッド3148012

TDdeClientItem	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TDdeClientItem.Create
TDdeClientItem.Create3148013

TDdeClientItem	参照

Create メソッドは，TDdeClientItem のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TDdeClientItem をインスタンス化できます。Create は継承されたコンストラクタを呼び出してから，ヘルパーオブジェクトを作成して Lines プロパティを管理します。


TDdeClientItem.Destroy
TDdeClientItem.Destroy3148014

TDdeClientItem	参照

Destroy メソッドは，TDdeClientItem のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TDdeClientItem オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy は Lines プロパティに関連付けられたメモリを解放してから，継承デストラクタを呼び出します。


スコープ3148015

published

読み出し／書き込み

読み出し専用


スコープ3148016

published


継承3148017

TObject

TPersistent

TComponent


TDdeClientItem 例3148018

TDdeClientItem


TDdeServerItem
TDdeServerItem3149001

継承	プロパティ	メソッド	イベント	参照

TDdeServerItem コンポーネントは DDE 対話の項目を定義します。

ユニット

ddeman

説明

TDdeServerItem コンポーネントは単独で，またはアプリケーションを DDE サーバーにしたいときに TDdeServerConv オブジェクトと一緒に使います。DDE クライアントは，Name プロパティを参照して個々の DDE サーバー項目とリンクします。いったん DDE クライアントとのリンクが確立されると，DDE サーバー項目は，項目データの変更に応じてクライアントを更新したり，DDE クライアントが送信するデータを受け取ったりすることができます。


TDdeServerItem プロパティ3149002

TDdeServerItem	アルファベット順	凡例

TDdeServerItem

Fmt

Lines

ServerConv

Text

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDdeServerItem プロパティ3149003

TDdeServerItem	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Fmt

Lines

Name

Owner

ServerConv

Tag

Text

VCLComObject


TDdeServerItem.Fmt
TDdeServerItem.Fmt3149004

TDdeServerItem	参照

Fmt プロパティは，DDE クライアント項目が DDE クライアントにデータを渡すのに使用するクリップボード形式です。

property Fmt: Integer;

説明

OnChange イベントハンドラで Fmt プロパティを設定すると，DDE クライアントに渡されるデータがテキストでない場合にそのデータのクリップボード形式を指定できます。DDE クライアントに送られる DDE データはこの形式になり，クライアントはそのデータを正しく解釈できます。クライアントが DDE サーバー項目にデータをポークするときに Fmt を読み出すと，クライアントがデータをフォーマットするのに使用したクリップボード形式を判別できます。


TDdeServerItem.Lines
TDdeServerItem.Lines3149005

TDdeServerItem	参照

Lines プロパティは，DDE 対話で交換するデータを示します。

property Lines: TStrings;

説明

Lines プロパティは DDE サーバー項目が DDE クライアントに送信するデータを設定します。Lines プロパティが変更されるたびに，OnChange イベントが発生し，新しい値が DDE クライアントへ送信されます。DDE サーバー項目が送信されたデータを受け入れる場合は，Lines は DDE クライアントが DDE サーバー項目へデータを送信するたびにデータを受け取ります。データを送信する DDE クライアントによって Lines が変更されると，OnChange イベントが発生した後で OnPokeData イベントが発生します。

通常は，Lines にはテキストが入ります。Lines を設定すると，Fmt プロパティは CF_TEXT に設定されます。ただし，Delphi の文字列にはテキスト以外のデータを含めることができます。Lines がテキストデータを指定していない場合は，Fmt は OnChange イベントハンドラ内でデータの形式を示すように変更されなければなりません。

Lines は Text プロパティに対応しています。Lines または Text のどちらかの値が変化すると，Lines の最初の行が Text と等しくなるようにもう一方も更新されます。


TDdeServerItem.ServerConv
TDdeServerItem.ServerConv3149006

TDdeServerItem	参照

ServerConv プロパティは，DDE サーバー項目へ関連付ける DDE サーバー対話を指定します。

property ServerConv: TDdeServerConv;

説明

ServerConv を設定すると，DDE サーバー項目を DDE サーバー対話によって表される DDE トピックに関連付けることができます。ServerConv が設定されていない場合は，対話の DDE トピック は TDdeServerItem コンポーネントを含むフォームの Caption プロパティの値になります。


TDdeServerItem.Text
TDdeServerItem.Text3149007

TDdeServerItem	参照

Text プロパティは，DDE 対話で交換するテキストデータが入っています。

property Text: string;

説明

Text プロパティは DDE サーバー項目が DDE クライアントに送信するデータを設定します。Text プロパティが変更されるたびに，OnChange イベントが発生し，新しい値が DDE クライアントへ送信されます。DDE サーバー項目が送信されたデータを受け入れる場合は，Text は DDE クライアントが DDE サーバー項目へデータを送信するたびにデータを受け取ります。データを送信する DDE クライアントによって Text が変更されると，OnChange イベントが発生した後で OnPokeData イベントが発生します。

通常は，Text にはテキストが入ります。Text を設定すると，Fmt プロパティは CF_TEXT に設定されます。ただし，Delphi の文字列にはテキスト以外のデータを含めることができます。Text がテキストデータを指定していない場合は，Fmt は OnChange イベントハンドラ内でデータの形式を示すように変更されなければなりません。

Text は Lines プロパティに対応しています。Text または Lines のどちらかの値が変化すると，Lines の最初の行が Text と等しくなるようにもう一方も更新されます。

交換されるデータが複数行に渡る場合は，Text ではなく Lines を使用します。


TDdeServerItem イベント3149008

TDdeServerItem	アルファベット順	凡例

TDdeServerItem

OnChange

OnPokeData


TDdeServerItem イベント3149009

TDdeServerItem	オブジェクト順	凡例

OnChange

OnPokeData


TDdeServerItem.OnChange
TDdeServerItem.OnChange3149010

TDdeServerItem	参照

OnChange イベントは，Lines プロパティが変更され，変更内容が DDE クライアントに送信される前に発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラを記述すると，DDE サーバー項目が DDE クライアントを更新しようとしたときに特定の処理が実行されるようにすることができます。DDE クライアント項目の新しい値は，Lines プロパティまたは Text プロパティを読み出すことで調べることができます。

Lines の値にテキストデータが含まれていない場合は，OnChange イベントハンドラには Fmt の値を変更することが割り当てられなければなりません。OnChange は，Lines プロパティの設定により，Fmt が CF_TEXT に設定された後で，データがクライアントに送信される前に呼び出されます。


TDdeServerItem.OnPokeData
TDdeServerItem.OnPokeData3149011

TDdeServerItem	参照

OnPokeData イベントは，DDE クライアントが Lines プロパティの値を変更した後で発生します。

type

TNotifyEvent = procedure(Sender: TObject) of  object;

property OnPokeData: TNotifyEvent;

説明

OnPokeData イベントハンドラを記述すると，DDE クライアントが DDE サーバー項目にデータをポークしたときに特定の処理が実行されるようにすることができます。DDE サーバー項目の新しい値は，Lines プロパティまたは Text プロパティを読み出すことで調べることができます。

DDE クライアントがデータを DDE サーバー項目にポークすると，PokeData メソッドが呼び出されます。PokeData メソッドは以下のイベントを発生させます。

1.	まず，新しい値が Lines（Text）プロパティに割り当てられる

2.	OnChange イベントが発生する

3.	新しい値が DDE クライアントに戻される

4.	OnPokeData イベントが発生する


TDdeServerItem メソッド3149012

TDdeServerItem	アルファベット順

TDdeServerItem

Change

CopyToClipboard

Create

Destroy

PokeData

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDdeServerItem メソッド3149013

TDdeServerItem	オブジェクト順

Assign

Change

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyToClipboard

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

PokeData

RemoveComponent

SafeCallException


TDdeServerItem.Change
TDdeServerItem.Change3149014

TDdeServerItem	参照

Change メソッドは，OnChange イベントを発生させます。

procedure Change; dynamic;

説明

Change メソッドを呼び出すと，Lines または Text プロパティを設定していないときに，OnChange イベントを発生させることができます。Change メソッドを OnChange イベントとともに使うと，DDE サーバー項目が Lines および Text プロパティによって使用されている文字列と互換性のないデータを交換できるようになります。


TDdeServerItem.CopyToClipboard
TDdeServerItem.CopyToClipboard3149015

TDdeServerItem	参照

CopyToClipboard メソッドは，DDE サーバー項目コンポーネントの Text プロパティまたは Lines プロパティで指定するデータを DDE リンク情報とともに Windows のクリップボードにコピーします。

procedure CopyToClipboard;

説明

CopyToClipboard メソッドを呼び出すと，DDE クライアントは［編集(E)｜リンク貼り付け(P)］コマンドまたは DDE クライアントアプリケーションの同等のコマンドを実行して，DDE サーバー項目にリンクできるようになります。

実行時に DDE リンクを作成するには CopyToClipboard を使います。設計時にリンクを作成するには，TDdeServerItem オブジェクトを選択してからメニューで［編集(E)｜コピー(C)］を選択します。DDE クライアントアプリケーションを起動し，DDE クライアントアプリケーションの規則に従ってリンクを貼り付けます。リンクの貼り付けについての詳細は DDE クライアントアプリケーションのマニュアルを参照してください。


TDdeServerItem.Create
TDdeServerItem.Create3149016

TDdeServerItem	参照

Create メソッドは，TDdeServerItem のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に DDE サーバー項目をインスタンス化できます。設計時にフォームに配置された TDdeServerItem オブジェクトの場合，Create は自動的に呼び出されます。

継承されたコンストラクタを呼び出した後，Create は Fmt プロパティを CF_TEXT に初期化し，Lines プロパティを管理するためのヘルパーオブジェクトを作成します。


TDdeServerItem.Destroy
TDdeServerItem.Destroy3149017

TDdeServerItem	参照

Destroy メソッドは，TDdeServerItem のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TDdeServerItem が解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy は Lines プロパティに関連付けられているメモリを解放してから，継承デストラクタを呼び出します。


TDdeServerItem.PokeData
TDdeServerItem.PokeData3149018

TDdeServerItem	参照

PokeData メソッドは，DDE クライアントによって DDE サーバー項目に送信されたデータを処理します。

function PokeData(Data: HDdeData): LongInt;

説明

PokeData メソッドを呼び出すと，DDE クライアントから送信されたデータを DDE 対話が保持していることを DDE サーバー項目に知らせることができます。Data は送信されたデータの DDE ハンドルです。

PokeData メソッドは以下の処理を実行します。

1.	Data ハンドルを使って送信されたデータを取得する

2.	Lines プロパティを新しいデータ値に設定する

3.	OnChange イベントを発生させる

4.	新しいデータ値を DDE クライアントに送り返す

5.	OnPokeData イベントを発生させる


スコープ3149019

published

読み出し／書き込み

読み出し専用


スコープ3149020

published


継承3149021

TObject

TPersistent

TComponent


TDdeServerItem 例3149022

TDdeServerItem


TDdeServerConv
TDdeServerConv3150001

継承	プロパティ	メソッド	イベント	参照

TDdeServerConv コンポーネントは DDE クライアントとの対話における DDE トピックを表します。

ユニット

ddeman

説明

TDdeServerConv を使うと，DDE クライアントアプリケーションとの間に DDE トピックを確立できます。DDE トピックの各項目は TDdeServerItem オブジェクトで表されます。これらの項目は，ServerConv プロパティを設定することで DDE サーバー対話とリンクされます。

TDdeServerConv コンポーネントを使うかどうかは任意です。TDdeServerConv オブジェクトを使わなくても，クライアントは DDE 対話に入り，TDdeServerItem オブジェクトから更新を直接受け取ることができます。ただし DDE サーバー対話では，DDE クライアントから送られるマクロをすべて処理しなければなりません。

DDE サーバー対話の Name プロパティは，DDE クライアントが DDE サーバー対話へのリンクを確立するために使うトピックを提供します。DDE サーバー対話と関連付けられていない DDE サーバー項目は，フォームの Caption プロパティをトピック名として使います。単一のフォームで複数の DDE トピックを確立する場合や，実行時にフォームの Caption が一意でない，あるいは変更される可能性がある場合には，TDdeServerConv オブジェクトを使います。


TDdeServerConv プロパティ3150002

TDdeServerConv	アルファベット順	凡例

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDdeServerConv プロパティ3150003

TDdeServerConv	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDdeServerConv イベント3150004

TDdeServerConv	アルファベット順	凡例

TDdeServerConv

OnClose

OnExecuteMacro

OnOpen


TDdeServerConv イベント3150005

TDdeServerConv	オブジェクト順	凡例

OnClose

OnExecuteMacro

OnOpen


TDdeServerConv.OnClose
TDdeServerConv.OnClose3150006

TDdeServerConv	参照

OnClose イベントは，DDE クライアントが DDE 対話を終了したときに発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnClose: TNotifyEvent;

説明

OnClose イベントハンドラを記述すると，DDE 対話の終了時に特定のアクションを実行できます。クライアントが DDE 対話を終了すると対話は終了します。しかしながら，TDdeServerConv オブジェクトを破棄しても DDE 対話は終了しません。この場合，DDE サーバー項目は，DDE サーバー対話から削除されるだけで，DDE クライアントへのリンクは維持されます。

Sender パラメータは DDE クライアントではなく TDdeServerConv 自身になります。


TDdeServerConv.OnExecuteMacro
TDdeServerConv.OnExecuteMacro3150007

TDdeServerConv	参照

OnExecuteMacro イベントは，DDE クライアントが DDE サーバー対話にマクロを送ったときに発生します。

type

TMacroEvent = procedure(Sender: TObject; Msg: TStrings) of object;

property OnExecuteMacro: TMacroEvent;

説明

OnExecuteMacro イベントハンドラを記述すると，DDE クライアントが送ったマクロに対する応答を実現できます。Sender パラメータは DDE サーバー対話を指定します。Msg パラメータは実行するマクロ文字列を指定します。


TDdeServerConv.OnOpen
TDdeServerConv.OnOpen3150008

TDdeServerConv	参照

OnOpen イベントは，クライアントへの DDE リンクが確立した直後に発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnOpen: TNotifyEvent;

説明

OnOpen イベントハンドラを記述すると，DDE クライアントへのリンクを確立したときに特定のアクションを実行できます。Sender パラメータは DDE クライアントではなく DDE サーバー対話を指定します。


TDdeServerConv メソッド3150009

TDdeServerConv	アルファベット順

TDdeServerConv

Create

Destroy

ExecuteMacro

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDdeServerConv メソッド3150010

TDdeServerConv	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteMacro

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TDdeServerConv.Create
TDdeServerConv.Create3150011

TDdeServerConv	参照

Create メソッドは TDdeServerConv のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出して，実行時に TDdeServerConv のインスタンスを作成します。設計時にフォーム上にある TDdeServerConv オブジェクトの場合，Create は自動的に呼び出されます。


TDdeServerConv.Destroy
TDdeServerConv.Destroy3150012

TDdeServerConv	参照

Destroy メソッドは TDdeServerConv のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TDdeServerConv オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドはアプリケーションから DDE サーバー対話のトピックを削除しますが，現在開いている DDE 対話は終了しません。DDE サーバー対話に関連付けられていた DDE サーバー項目はフォームに関連付けられ，DDE クライアントへのリンクを維持します。


TDdeServerConv.ExecuteMacro
TDdeServerConv.ExecuteMacro3150013

TDdeServerConv	参照

ExecuteMacro メソッドは，DDE クライアントが送ったマクロに応答します。

function ExecuteMacro(Data: HDdeData): LongInt;

説明

ExecuteMacro メソッドは，Delphi アプリケーションが DDE クライアントから送られたマクロに応答する唯一の手段を提供します。ExecuteMacro は，DDE クライアントが DDE リンクを介して Macro を送ったときに呼び出されます。Data は，マクロが入っている DDE データへのハンドルです。

ExecuteMacro は Data からマクロの文字列を読み出して，OnExecuteMacro イベントハンドラを呼び出します。OnExecuteMacro イベントハンドラがない場合，マクロは無視されます。OnExecuteMacro イベントハンドラの有無とは関係なく，Data にマクロがあれば DDE クライアントは常にマクロが正常に転送されたという通知を受けます。


スコープ3150014

published

読み出し／書き込み

読み出し専用


スコープ3150015

published


継承3150016

TObject

TPersistent

TComponent


TDdeServerConv 例3150017

TDdeServerConv


TDecisionCube
TDecisionCube3151001

継承	プロパティ	メソッド	イベント	参照

TDecisionCube は，TDecisionSource オブジェクトによって提供されるクロス集計されたデータを保持します。

ユニット

mxdb

説明

TDecisionCube オブジェクトをフォームまたはデータモジュールに追加すると，アプリケーションがクロス集計データを表せます。TDecisionCube はソースデータセットからのデータを各次元が情報を集計するデータセット内の 1 つの項目に相当する多次元構造体に分解します。データセットはすべて TDecisionCube オブジェクトのソースとして使えますが，TDecisionQuery を使うのが最も簡単です。

TDecisionCube はクロス集計データ格納でデータを TDecisionSource オブジェクトに提供できるようにするプロパティとメソッドを提供します。Decision グリッドと Decision グラフはデシジョンキューブから直接データを取得しません。TDecisionCube オブジェクトの次元の構成を表す TDecisionSource オブジェクトを使います。


TDecisionCube プロパティ3151002

TDecisionCube	アルファベット順	凡例

TDecisionCube

Active

TCustomDataStore からの継承

BinData

Capacity

CurrentSummary

DataSet

DesignState

DimensionCount

DimensionMap

DimensionMapCount

MaxCell

MaxDimensions

MaxSummaries

ShowProgressDialog

SummaryCount

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDecisionCube プロパティ3151003

TDecisionCube	オブジェクト順	凡例

Active

BinData

Capacity

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

CurrentSummary

DataSet

DesignInfo

DesignState

DimensionCount

DimensionMap

DimensionMapCount

MaxCell

MaxDimensions

MaxSummaries

Name

Owner

ShowProgressDialog

SummaryCount

Tag

VCLComObject


TDecisionCube.Active
TDecisionCube.Active3151004

TDecisionCube	参照

Active プロパティは，デシジョンキューブがデータを提供できるかどうかを指定します。

property Active: Boolean;

説明

Active プロパティは，デシジョンキューブがデシジョンコントロールにデータを提供できるかどうかを判別できます。Active を True に設定するとデシジョンキューブは DataSet で指定されたデータセットからデータを取り込み分析します。

Active が False ならば，デシジョンキューブが閉じるのでデシジョンソースはデシジョンキューブからデータを読み出せません。Active が True ならばデータをデシジョンキューブから読み出せます。

注意

ctive プロパティは，DataSet プロパティで指定されたデータセットがアクティブでない限り True に設定することができません。


TDecisionCube イベント3151006

TDecisionCube	アルファベット順	凡例

TCustomDataStore からの継承

AfterClose

AfterOpen

BeforeClose

BeforeOpen

OnLowCapacity

OnRefresh


TDecisionCube イベント3151007

TDecisionCube	オブジェクト順	凡例

AfterClose

AfterOpen

BeforeClose

BeforeOpen

OnLowCapacity

OnRefresh


TDecisionCube メソッド3151008

TDecisionCube	アルファベット順

TDecisionCube

Create

Destroy

GetDetailSQL

GetSQL

ShowCubeDialog

TCustomDataStore からの継承

CalcSubTotals

GetDimensionMemberCount

GetDimensionName

GetMemberAsString

GetMemberAsVariant

GetMemoryUsage

GetSummaryAsString

GetSummaryAsVariant

GetSummaryName

Refresh

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDecisionCube メソッド3151009

TDecisionCube	オブジェクト順

Assign

CalcSubTotals

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetDetailSQL

GetDimensionMemberCount

GetDimensionName

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetMemberAsString

GetMemberAsVariant

GetMemoryUsage

GetNamePath

GetParentComponent

GetSQL

GetSummaryAsString

GetSummaryAsVariant

GetSummaryName

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

Refresh

RemoveComponent

SafeCallException

ShowCubeDialog


TDecisionCube.Create
TDecisionCube.Create3151010

TDecisionCube	参照

Create メソッドは，TDecisionCube のインスタンスを作成します。

constructor Create( AOwner: TComponent ); override;

説明

Create メソッドを呼び出すと，実行時にデシジョンキューブをインスタンス化できます。設計時にフォームまたはデータモジュールに配置されたデシジョンキューブは自動的に作成されます。

Create はデシジョンキューブとヘルパーオブジェクトにメモリを割り当ててから State プロパティを dcInactive に，DesignState プロパティを dsAllData に初期化します。


TDecisionCube.Destroy
TDecisionCube.Destroy3151011

TDecisionCube	参照

Destroy メソッドは，TDecisionCube のインスタンスを破棄します。

destructor Destroy; override;

説明

直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはデシジョンキューブに割り当てたメモリが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。


TDecisionCube.GetDetailSQL
TDecisionCube.GetDetailSQL3151012

TDecisionCube	参照

GetDetailSQL メソッドは，デシジョンキューブ内のデータから記述されたサブセットを生成するのに使う SQL 文を返します。

function GetDetailSQL( ValueArray: TSmallIntArray; SelectList: string; bActive: Boolean): string;

説明

GetDetailSQL が返す SQL 文を使うと，デシジョンキューブ内で値のサブセットを生成するレコードを表すデータセットを生成できます。出力される問い合わせは ValueArray パラメータで記述された射影内で表されるレコードを生成します。データセットにはデシジョンキューブの次元を構成するすべての項目に加えて，SelectList パラメータで指定されていればその項目も含まれます。問い合わせには，デシジョンキューブのデータセットに必ず入っていなければならない集計値や分類は含まれません。

ValueArray パラメータの各エントリはデシジョンキューブの 1 つの次元に相当し，最初のエントリは最初の次元に，2 番目のエントリは 2 番目のエントリに相当します。値の配列のエントリ値が 0 より小さい場合，その次元のすべての項目値は新しいデータセットに含まれます。値の配列のエントリ値が 0 以上の場合，その値は次元項目の値のインデックスとして解釈されます。ValueArray が項目値を指定するとき，SQL 文はデータセットを，元のデータベーステーブルの対応する項目の値に一致するレコードだけに限定します。したがって ValueArray は，折り畳まれた次元のセットを使った次元配列を表します。

SelectList パラメータは，SQL 問い合わせの結果セットに含まれる項目の名前をカンマで区切ったリストです。問い合わせには必ず ValueArray パラメータで表される次元に相当する項目が入っていなればなりません。SelectList がアスタリスク（*）1 つの場合，元のデータセットに入っているすべての項目が含まれます。

bActive は ValueArray パラメータが非アクティブな次元を含むかどうかを示します。bActive が True ならアクティブな次元だけが含まれます。また bActive が True のとき，アクティブな次元に相当する項目だけが自動的に SQL 問い合わせに含まれます。


TDecisionCube.GetSQL
TDecisionCube.GetSQL3151013

TDecisionCube	参照

GetSQL メソッドは，デシジョンキューブ内のデータから記述されたサブセットを生成するのに使う SQL 文を返します。

function GetSQL( ValueArray: TSmallIntArray; bActive: Boolean): string;

説明

GetSQL が返す SQL 文を使うと，デシジョンキューブ内で情報のサブセットを生成するデータを読むことができます。出力される問い合わせは ValueArray パラメータで記述された射影を含むデータセットを生成します。現在のデータセットのすべての集計は出力される問い合わせに含まれます。

ValueArray パラメータの各エントリはデシジョンキューブの 1 つの次元に相当し，最初のエントリは最初の次元に，2 番目のエントリは 2 番目のエントリに相当します。値の配列のエントリ値が 0 より小さい場合，その次元のすべての項目値は新しいデータセットに含まれます。値の配列のエントリ値が 0 以上の場合，その値は次元項目の値のインデックスとして解釈されます。ValueArray が項目値を指定するとき，SQL 文はデータセットを，元のデータベーステーブルの対応する項目の値に一致するレコードだけに制限します。したがって ValueArray は，折り畳まれた次元のセットを使った次元配列を表します。

bActive は ValueArray パラメータが非アクティブな次元を含むかどうかを示します。bActive が True ならアクティブな次元だけが含まれます。

デシジョンキューブ内の次元のサブセットだけが含まれるようにデータセットをさらに限定するには，GetDetailSQL メソッドを使います。


TDecisionCube.ShowCubeDialog
TDecisionCube.ShowCubeDialog3151014

TDecisionCube	参照

ShowCubeDialog メソッドは，デシジョンキューブエディタを表示します。

procedure ShowCubeDialog;

説明

ShowCubeDialog メソッドを呼び出すと，ユーザーがデシジョンキューブエディタを使ってアクティブなデータの次元を変更できるようになります。ShowCubeEditor は，設計時にデシジョンキューブコンポーネントのポップアップメニューからデシジョンキューブエディタを選択したときと同じダイアログボックスを表示します。

デシジョンキューブエディタを使うと，ユーザーが次元をアクティブまたは非アクティブにしたり次元の名前を変更したりできます。また設計時にデシジョンコントロールに表示される情報の内容を制御することもできます。


スコープ3151015

published

読み出し／書き込み

読み出し専用


スコープ3151016

published


継承3151017

TObject

TPersistent

TComponent

TCustomDataStore


TDecisionCube 例3151018

TDecisionCube


TDecisionGraph
TDecisionGraph3152001

継承	プロパティ	メソッド	イベント	参照

TDecisionGraph は，クロス集計したデータをグラフに表します。

ユニット

mxgraph

説明

TDecisionGraph を使うとデシジョングラフをフォームに入れることができます。デシジョングラフは次元の数で計算した 1 つの集計を図にします。グラフの軸はそれらの次元に相当し，デシジョンソースオブジェクトによって提供されます。デフォルトでは，最初の行次元が X 軸として，最初の列次元が Y 軸として表示されます。

集計される項目と集計の基になる項目（次元）は，デシジョンキューブの次元マップから選択された集計および次元の構成を見るために，実行時に動的に変更できます。次元および集計に対する変更は TDecisionPivot オブジェクトを使って開始できます。

TDecisionGraph は TCustomDecisionGraph から継承した多くのプロパティ，イベント，メソッドを公開しますが，新しい動作は提供しません。

クロス集計したデータをグリッドで表すには，TDecisionGrid を使ってください。


TDecisionGraph プロパティ3152002

TDecisionGraph	アルファベット順	凡例

TCustomDecisionGraph からの継承

DecisionSource

SaveSeries

TChart からの継承

AllowPanning

AllowZoom

AnimatedZoom

AnimatedZoomSteps

BackImage

BackImageInside

BackImageMode

BottomWall

Foot

Gradient

LeftWall

PrintResolution

Title

Zoomed

TCustomChart からの継承

AxisVisible

BackColor

BottomAxis

BufferedDisplay

Chart3DPercent

ClipPoints

Frame

LeftAxis

Legend

MarginBottom

MarginLeft

MarginRight

MarginTop

MaxPointsPerPage

Monochrome

Page

RightAxis

ScaleLastPage

Series

SeriesList

TopAxis

View3d

View3dWalls

TCustomTeePanel からの継承

Canvas

TCustomPanel からの継承

BevelInner

BevelOuter

BevelWidth

BorderStyle

BorderWidth

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Height

Hint

Left

Name

Parent

ParentColor

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDecisionGraph プロパティ3152003

TDecisionGraph	オブジェクト順	凡例

Align

AllowPanning

AllowZoom

AnimatedZoom

AnimatedZoomSteps

AxisVisible

BackColor

BackImage

BackImageInside

BackImageMode

BevelInner

BevelOuter

BevelWidth

BorderStyle

BorderWidth

BottomAxis

BottomWall

BoundsRect

Brush

BufferedDisplay

Canvas

Chart3DPercent

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ClipPoints

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DecisionSource

DesignInfo

DragCursor

DragMode

Enabled

Foot

Frame

Gradient

Handle

Height

HelpContext

Hint

Left

LeftAxis

LeftWall

Legend

MarginBottom

MarginLeft

MarginRight

MarginTop

MaxPointsPerPage

Monochrome

Name

Owner

Page

Parent

ParentColor

ParentShowHint

ParentWindow

PopupMenu

PrintResolution

RightAxis

SaveSeries

ScaleLastPage

Series

SeriesList

ShowHint

Showing

TabOrder

TabStop

Tag

Title

Top

TopAxis

VCLComObject

View3d

View3dWalls

Visible

Width

WindowProc

Zoomed


TDecisionGraph イベント3152004

TDecisionGraph	アルファベット順	凡例

TChart からの継承

OnAllowScroll

OnClickAxis

OnClickBackground

OnClickLegend

OnClickSeries

OnGetLegendPos

OnGetLegendRect

OnScroll

OnUndoZoom

OnZoom

TCustomChart からの継承

OnAfterDraw

OnGetAxisLabel

OnGetLegendText

OnGetNextAxisLabel

OnPageChange

OnResize

TCustomPanel からの継承

OnResize

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDecisionGraph イベント3152005

TDecisionGraph	オブジェクト順	凡例

OnAfterDraw

OnAllowScroll

OnClick

OnClickAxis

OnClickBackground

OnClickLegend

OnClickSeries

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnGetAxisLabel

OnGetLegendPos

OnGetLegendRect

OnGetLegendText

OnGetNextAxisLabel

OnMouseDown

OnMouseMove

OnMouseUp

OnPageChange

OnResize

OnResize

OnScroll

OnStartDrag

OnUndoZoom

OnZoom


TDecisionGraph メソッド3152006

TDecisionGraph	アルファベット順

TCustomDecisionGraph からの継承

Create

Destroy

TChart からの継承

CalcClickedPart

CalcMetaBounds

ChartPrintRect

CopyToClipboardBitmap

CopyToClipboardMetafile

DrawToMetaCanvas

ExchangeSeries

FillSeriesSourceItems

FillValueSourceItems

GetEditorClass

IsScreenHighColor

NextPage

PreviousPage

Print

PrintLandscape

PrintOrientation

PrintPartial

PrintPartialCanvas

PrintPortrait

PrintRect

SaveToBitmapFile

SaveToMetafile

SaveToMetafileEnh

SaveToMetafileRect

SeriesDown

SeriesUp

TeeCreateMetafile

UndoZoom

ZoomPercent

ZoomRectTCustomChart からの継承

ActiveSeriesLegend

AddSeries

BackWallRect

CalcSize3d

CalcSize3dWalls

ChartRegionRect

CheckDatasource

CheckPenWidth

ClipRectangle

Draw

FormattedLegend

FormattedValueLegend

FreeAllSeries

GetASeries

GetAxisSeries

GetFreeSeriesColor

GetLabelsSeries

InternalDraw

IsFreeSeriesColor

IsValidDataSource

MarkText

MaxMarkWidth

MaxTextWidth

MaxXValue

MaxYValue

MinXValue

MinYValue

NumPages

RemoveAllSeries

RemoveSeries

SeriesCount

SeriesTitleLegend

UnClipRectangle

XLabelText

TCustomTeePanel からの継承

CanvasChanged

DoHorizLine

DoLine

DoPolygon

DoRectangle

DoVertLine

FontCanvas

GetCursorPos

GetRectangle

GetWidthHeight

ReCalcWidthHeight

RotateLabel

SetBooleanProperty

SetBrushCanvas

SetColorProperty

SetDoubleProperty

SetIntegerProperty

SetInternalCanvas

SetLongintProperty

SetStringProperty

TeeCharHeight

TeeTextHeight

TeeTextOut

TeeTextWidth

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDecisionGraph メソッド3152007

TDecisionGraph	オブジェクト順

ActiveSeriesLegend

AddSeries

Assign

BackWallRect

BeginDrag

BringToFront

Broadcast

CalcClickedPart

CalcMetaBounds

CalcSize3d

CalcSize3dWalls

CanFocus

CanvasChanged

ChartPrintRect

ChartRegionRect

CheckDatasource

CheckPenWidth

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ClipRectangle

ContainsControl

ControlAtPos

CopyToClipboardBitmap

CopyToClipboardMetafile

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DoHorizLine

DoLine

DoPolygon

DoRectangle

DoVertLine

DragDrop

Dragging

Draw

DrawToMetaCanvas

EnableAlign

EndDrag

ExchangeSeries

FieldAddress

FillSeriesSourceItems

FillValueSourceItems

FindComponent

Focused

FontCanvas

FormattedLegend

FormattedValueLegend

Free

FreeAllSeries

FreeInstance

FreeNotification

FreeOnRelease

GetASeries

GetAxisSeries

GetCursorPos

GetEditorClass

GetFreeSeriesColor

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetLabelsSeries

GetNamePath

GetParentComponent

GetRectangle

GetTabOrderList

GetTextBuf

GetTextLen

GetWidthHeight

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

InternalDraw

Invalidate

IsFreeSeriesColor

IsScreenHighColor

IsValidDataSource

MarkText

MaxMarkWidth

MaxTextWidth

MaxXValue

MaxYValue

MethodAddress

MethodName

MinXValue

MinYValue

NewInstance

NextPage

NumPages

PaintTo

Perform

PreviousPage

Print

PrintLandscape

PrintOrientation

PrintPartial

PrintPartialCanvas

PrintPortrait

PrintRect

Realign

ReCalcWidthHeight

Refresh

RemoveAllSeries

RemoveComponent

RemoveControl

RemoveSeries

Repaint

RotateLabel

SafeCallException

SaveToBitmapFile

SaveToMetafile

SaveToMetafileEnh

SaveToMetafileRect

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SeriesCount

SeriesDown

SeriesTitleLegend

SeriesUp

SetBooleanProperty

SetBounds

SetBrushCanvas

SetColorProperty

SetDoubleProperty

SetFocus

SetIntegerProperty

SetInternalCanvas

SetLongintProperty

SetStringProperty

SetTextBuf

Show

TeeCharHeight

TeeCreateMetafile

TeeTextHeight

TeeTextOut

TeeTextWidth

UnClipRectangle

UndoZoom

Update

UpdateControlState

XLabelText

ZoomPercent

ZoomRect


スコープ3152008

published


スコープ3152009

published


継承3152010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomPanel

TCustomTeePanel

TCustomChart

TChart

TCustomAxisPanel

TCustomDecisionGraph


TDecisionGraph 例3152011

TDecisionGraph


TDecisionGrid
TDecisionGrid3153001

継承	プロパティ	メソッド	イベント	参照

TDecisionGrid は，デシジョンソースからクロス集計されたデータをグリッド形式で表します。

ユニット

mxgrid

説明

TDecisionGrid を使うとデシジョングリッドをフォームに入れることができます。デシジョングリッドは任意の数の次元で計算した 1 つの集計を表します。次元はグリッドの行または列として表示され，次元の項目値がラベルとしてグリッドの上と左に表示されます。

集計される項目と集計の基になる項目（次元）は，デシジョンキューブの次元マップから選択された集計および次元の構成を見るために，実行時に動的に変更できます。次元および集計に対する変更は，直接デシジョングリッドを操作するか，TDecisionPivot オブジェクトを使うことで開始できます。

TDecisionGrid は TCustomDecisionGrid から継承したプロパティ，イベント，メソッドの多くを公開しますが，新しい動作は提供しません。

クロス集計したデータをグラフで表すには TDecisionGraph を使ってください。


TDecisionGrid プロパティ3153002

TDecisionGrid	アルファベット順	凡例

TCustomDecisionGrid からの継承

CaptionColor

CaptionFont

Cells

ColCount

DataColor

DataFont

DataSumColor

DecisionSource

DefaultColWidth

DefaultRowHeight

Dimensions

FixedCols

FixedRows

GridLineColor

GridLineWidth

LabelColor

LabelFont

LabelSumColor

Options

RowCount

ShowCubeEditor

Totals

TCustomGrid からの継承

BorderStyle

DefaultDrawing

ScrollBars

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDecisionGrid プロパティ3153003

TDecisionGrid	オブジェクト順	凡例

Align

BorderStyle

BoundsRect

Brush

CaptionColor

CaptionFont

Cells

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ColCount

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DataColor

DataFont

DataSumColor

DecisionSource

DefaultColWidth

DefaultDrawing

DefaultRowHeight

DesignInfo

Dimensions

DragCursor

DragMode

Enabled

FixedCols

FixedRows

GridLineColor

GridLineWidth

Handle

Height

HelpContext

Hint

LabelColor

LabelFont

LabelSumColor

Left

Name

Options

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

RowCount

ScrollBars

ShowCubeEditor

ShowHint

Showing

TabOrder

TabStop

Tag

Top

Totals

VCLComObject

Visible

Width

WindowProc


TDecisionGrid イベント3153004

TDecisionGrid	アルファベット順	凡例

TCustomDecisionGrid からの継承

OnDecisionDrawCell

OnDecisionExamineCell

OnTopLeftChanged

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDecisionGrid イベント3153005

TDecisionGrid	オブジェクト順	凡例

OnClick

OnDblClick

OnDecisionDrawCell

OnDecisionExamineCell

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag

OnTopLeftChanged


TDecisionGrid メソッド3153006

TDecisionGrid	アルファベット順

TCustomDecisionGrid からの継承

CellDrawState

CellRect

CellValueArray

Create

Destroy

Notification

TCustomGrid からの継承

MouseCoord

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDecisionGrid メソッド3153007

TDecisionGrid	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

CellDrawState

CellRect

CellValueArray

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

MouseCoord

NewInstance

Notification

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


スコープ3153008

published

読み出し／書き込み

読み出し専用


スコープ3153009

published


継承3153010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomGrid

TCustomDecisionGrid


TDecisionGrid 例3153011

TDecisionGrid


TDecisionPivot
TDecisionPivot3154001

継承	プロパティ	メソッド	イベント	参照

TDecisionPivot は，ユーザーがデシジョンソースのピボット状態を制御することを可能にします。

ユニット

mxpivsrc

説明

デシジョンピボットをフォームに追加すると，ユーザーがデシジョングラフとデシジョングリッドのピボット状態を制御可能にできます。デシジョンピボットには，デシジョンキューブと現在の集計を選択するためのドロップダウンリストボックスのアクティブな次元に相当するボタンが入っています。

次元のボタンをクリックすることによりその次元を開いたり閉じたりして，デシジョンソースが詳しいデータ値を次元に提供するかどうかを制御します。次元のピボットのボタンを右クリックするとユーザーが次元の折り畳み方を制御可能にするメニューが表示されます。折り畳まれた次元は次元内の 1 つの値に集束します。デシジョンピボット上のボタンをドラッグするとデシジョンソースの次元が新しいピボットの構成に再調整されます。


TDecisionPivot プロパティ3154002

TDecisionPivot	アルファベット順	凡例

TDecisionPivot

BorderStyle

BorderWidth

ButtonAutoSize

ButtonHeight

ButtonSpacing

ButtonWidth

DecisionSource

GroupLayout

Groups

GroupSpacing

TCustomPanel からの継承

Alignment

BevelInner

BevelOuter

BevelWidth

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDecisionPivot プロパティ3154003

TDecisionPivot	オブジェクト順	凡例

Align

Alignment

BevelInner

BevelOuter

BevelWidth

BorderStyle

BorderWidth

BoundsRect

Brush

ButtonAutoSize

ButtonHeight

ButtonSpacing

ButtonWidth

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DecisionSource

DesignInfo

DragCursor

DragMode

Enabled

Font

GroupLayout

Groups

GroupSpacing

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TDecisionPivot.BorderStyle
TDecisionPivot.BorderStyle3154004

TDecisionPivot	参照

BorderStyle プロパティは，デシジョンピボットの周囲に線を描くかどうかを決めます。

property BorderStyle: TBorderStyle;

説明

BorderStyle プロパティは，デシジョンピボットの周囲に一重線を描くかどうかを指定するために使われます。BorderStyle が bsSingle ならば外側のベベルの外側のパネルの周囲に一重線が描かれます。次の値を指定できます。

値	意味

bsNone	非可視境界

bsSingle	一重境界線

デシジョンピボットの周囲に描く線を BorderWidth プロパティと間違えないでください。BorderWidth は外側のベベルと内側のベベルとの距離です。


TDecisionPivot.BorderWidth
TDecisionPivot.BorderWidth3154005

TDecisionPivot	参照

BorderWidth プロパティは，外側のベベルと内側のベベルの間のピクセル単位での距離です。

TBorderWidth: 0..MaxInt;

property BorderWidth: TBorderWidth;

説明

BorderWidth プロパティは，デシジョンピボットの周囲の境界の幅を指定するために使われます。値が 0 なら境界がないことを表します。

デシジョンピボットの境界は外側のベベルと内側のベベルの間の領域です。内側のベベルを高くしたり低くしたりした場合しか表示されませんが，BevelInner が bvNone の場合でもピボット内のコントロールの大きさに影響します。

ピボットの境界と境界の周囲に描いた線とを間違えないでください。ピボットの周囲の線は BorderStyle プロパティで指定します。


TDecisionPivot.ButtonAutoSize
TDecisionPivot.ButtonAutoSize3154006

TDecisionPivot	参照

ButtonAutoSize プロパティは，デシジョンピボットをサイズ変更したときに次元のボタンを自動的にサイズ変更するかどうかを指定します。

property ButtonAutoSize: Boolean;

説明

ButtonAutoSize を True に設定すると，デシジョンピボットのサイズ変更に合わせて自動的に次元のボタンを伸縮できます。ButtonAutoSize が False ならばボタンのサイズは ButtonHeight と ButtonWidth で指定したサイズになります。

注意

GroupLayout が xtTopLeft の場合は ButtonAutoSize の値は無視されます。


TDecisionPivot.ButtonHeight
TDecisionPivot.ButtonHeight3154007

TDecisionPivot	参照

ButtonHeight プロパティは，次元のボタンのピクセル単位の高さです。

property ButtonHeight: Integer;

説明

ButtonHeight プロパティは，次元のボタンの高さを指定するために使われます。ButtonAutoSize プロパティが True のときは ButtonHeight は使われません。ButtonAutoSize が True ならば，デシジョンピボットの配置を変更するたびにボタンの高さが自動的に調整されます。


TDecisionPivot.ButtonSpacing
TDecisionPivot.ButtonSpacing3154008

TDecisionPivot	参照

ButtonSpacing プロパティは，次元のボタンとボタンの間のピクセル数です。

property ButtonSpacing: Integer;

説明

ButtonSpacing を設定すると 1 つのグループ内のボタン同士の間隔を制御できます。ButtonSpacing を増やすとデシジョンピボットの配置が広く見せることができます。ButtonSpacing を減らすと行と列のグループをコンパクトに見せることができます。


TDecisionPivot.ButtonWidth
TDecisionPivot.ButtonWidth3154009

TDecisionPivot	参照

ButtonWidth プロパティは，次元のボタンのピクセル単位の幅です。

property ButtonWidth: Integer;

説明

ButtonWidth プロパティは，次元のボタンの幅を指定するために使われます。 ButtonAutoSize が True のときは ButtonWidth は使われません。ButtonAutoSize が True ならば，デシジョンピボットの配置を変更するたびにボタンの幅が自動的に調整されます。


TDecisionPivot.DecisionSource
TDecisionPivot.DecisionSource3154010

TDecisionPivot	参照

DecisionSource プロパティは，デシジョンピボットを制御するデシジョンソースオブジェクトです。

property DecisionSource: TDecisionSource;

説明

DecsionSource プロパティは，デシジョンピボットをデシジョンソースコンポーネントにリンクするために使われます。デシジョンピボットのコントロールはデシジョンソースのピボットの状態を変更します。

デシジョンソースのピボットの状態は，デシジョングリッドなど別のコントロールにも応答して変化します。デシジョンソースのピボットの状態が変化すると，デシジョンピボットは次元のボタンの配置と集計コンボボックスの選択を更新します。


TDecisionPivot.GroupLayout
TDecisionPivot.GroupLayout3154011

TDecisionPivot	参照

GroupLayout プロパティは，次元のボタンと集計コントロールのデシジョンピボット上での配置を指定します。

TDecisionButtonPosition = (xtHorizontal, xtVertical, xtLeftTop);

property GroupLayout: TDecisionButtonPosition;

説明

GroupLayout プロパティは，デシジョンピボットのレイアウト（または配置）を指定するために使われます。以下に GroupLayout に設定される値を示します。

値	意味

xtHorizontal	ピボットのコントロールは縦に並べられる

xtVertical	ピボットのコントロールは横に並べられる

xtLeftTop	ピボットのコントロールはピボットの縁に沿って並べられる。行次元はピボットの左端に，列次元はピボットの上部に並べられ，集計コントロールは左上に表示される

GroupLayout が xtLeftTop ならば，デシジョンピボットの中心は空白になります。デシジョングラフまたはデシジョングリッドはこの空白に配置でき，制御するボタンが次元に沿って並べられます。

GroupLayout が xtHorizontal または xtVertical ならば，集計コントロールが最初に表示されてから行次元と列次元が表示されます。Groups プロパティはこれらを任意に配置から削除できます。


TDecisionPivot.Groups
TDecisionPivot.Groups3154012

TDecisionPivot	参照

Groups プロパティは，どのコントロールがデシジョンピボットに表示されるかを指定します。

TDecisionPivotOption = (xtRows, xtColumns, xtSummaries);

TDecisionPivotOptions = set of TDecisionPivotOption;

property Groups: TDecisionPivotOptions;

説明

Groups プロパティは，デシジョンピボットに表示されるコントロールの型を限定するために使われます。この設定によりコントロールがフォームのどこに表示されるかより自由に指定できます。たとえばフォームに 3 つの次元ピボットが入っている場合に，1 つには行次元のボタン，1 つには列次元のボタン，1 つには集計選択コンボボックスを入れます。これら 3 つのピボットはフォームの任意の位置に配置できます。

Groups は以下に示す値を 1 つまたは複数格納するセットです。

値	意味

xtRows	ピボットには行次元のボタンが入る

xtColumns	ピボットには列次元のボタンが入る

xtSummaries	ピボットには集計選択コンボボックスが入る


TDecisionPivot.GroupSpacing
TDecisionPivot.GroupSpacing3154013

TDecisionPivot	参照

GroupSpacing プロパティは，コントロールのグループとグループの間のピクセル数です。

property GroupSpacing: Integer;

説明

GroupSpacing プロパティは，集計コンボボックス，行次元のボタンのグループ，および列次元のボタンのグループの間隔を制御するために使われます。GroupSpacing を増やすとコントロールのグループをより明確に見せることができます。GroupSpacing を減らすとデシジョンピボットをよりコンパクトに見せることができます。


TDecisionPivot イベント3154014

TDecisionPivot	アルファベット順	凡例

TCustomPanel からの継承

OnResize

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnStartDrag


TDecisionPivot イベント3154015

TDecisionPivot	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnResize

OnStartDrag


TDecisionPivot メソッド3154016

TDecisionPivot	アルファベット順

TDecisionPivot

Create

Destroy

SetBounds

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDecisionPivot メソッド3154017

TDecisionPivot	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDecisionPivot.Create
TDecisionPivot.Create3154018

TDecisionPivot	参照

Create メソッドは，TDecsionPivot のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出すと，実行時にデシジョンピボットをインスタンス化できます。設計時にフォームに配置されたデシジョンピボットは自動的に作成されます。継承コンストラクタを呼び出し後，Create は次のプロパティを初期化します。

・	BorderStyle は bsNone，BorderWidth は 3

・	ButtonAutoSize は True

・	ButtonHeight は 24，ButtonWidth は 64

・	ButtonSpacing は 3，GroupSpacing は 10

・	Groups は [xtRows, xtColumns, xtSummaries]

・	GroupLayout は xtHorizontal


TDecisionPivot.Destroy
TDecisionPivot.Destroy3154019

TDecisionPivot	参照

Destroy メソッドは，TDecsionPivot のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはデシジョンピボットが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。


TDecisionPivot.SetBounds
TDecisionPivot.SetBounds3154020

TDecisionPivot	参照

SetBounds メソッドは，デシジョンピボットのサイズを変更します。

procedure SetBounds(Left, Top, Height, Width: Integer); override;

説明

SetBounds メソッドを呼び出すと，デシジョンピボットの境界プロパティすべてを 1 度に変更できます。これは Left，Top，Width，Height の 4 つのプロパティを個別に設定するのと同じです。これら 4 つのプロパティを同時に設定することで，SetBounds では，ここの値を変更するたびに再描画されません。Left，Top，Width，および Height の各プロパティの値はそれぞれ ALeft，ATop，AWidth，および AHeight パラメータの値として指定します。

SetBounds はデシジョンピボットのサイズが変わったときにデシジョンピボット内のボタンの配置を調整するために継承されたメソッドをオーバーライドします。


スコープ3154021

published

読み出し／書き込み

読み出し専用


スコープ3154022

published


継承3154023

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomPanel


TDecisionPivot 例3154024

TDecisionPivot


TDecisionQuery
TDecisionQuery3155001

継承	プロパティ	メソッド	イベント	参照

TDecisionQuery は，デシジョンキューブにクロス集計されたデータを提供する専用の問い合わせです。

ユニット

mxtables

説明

TDecsionQuery をデシジョンキューブのデータセットとして使うと，データを適切に提供できるようになります。TDecsionQuery は次元と集計をデシジョンコントロールで分析されたデータセットで直接定義できるようにします。次に，デシジョンキューブで使用可能な形式のデータセットから情報を提供するために SQL 問い合わせを用意します。

デシジョンキューブは別の型のデータセットを使いますが，情報は TDecsionQuery オブジェクトの出力と同じように構造化されていなければなりません。


TDecisionQuery プロパティ3155002

TDecisionQuery	アルファベット順	凡例

TQuery からの継承

Constrained

DataSource

Local

ParamCheck

ParamCount

Params

Prepared

RequestLive

RowsAffected

SQL

SQLBinary

StmtHandle

Text

UniDirectional

TDBDataSet からの継承

Database

DatabaseName

DBHandle

DBLocale

DBSession

Provider

SessionName

UpdateMode

TBDEDataSet からの継承

CacheBlobs

CachedUpdates

CanModify

ExpIndex

Filter

Filtered

FilterOptions

Handle

KeySize

Locale

RecNo

RecordCount

RecordSize

UpdateObject

UpdateRecordTypes

UpdatesPending

TDataSet からの継承

Active

AutoCalcFields

BOF

Bookmark

Constraints

DefaultFields

Designer

EOF

FieldCount

FieldDefs

Fields

FieldValues

Found

Modified

Name

State

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDecisionQuery プロパティ3155003

TDecisionQuery	オブジェクト順	凡例

Active

AutoCalcFields

BOF

Bookmark

CacheBlobs

CachedUpdates

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Constrained

Constraints

Database

DatabaseName

DataSource

DBHandle

DBLocale

DBSession

DefaultFields

Designer

DesignInfo

EOF

ExpIndex

FieldCount

FieldDefs

Fields

FieldValues

Filter

Filtered

FilterOptions

Found

Handle

KeySize

Local

Locale

Modified

Name

Owner

ParamCheck

ParamCount

Params

Prepared

Provider

RecNo

RecordCount

RecordSize

RequestLive

RowsAffected

SessionName

SQL

SQLBinary

State

StmtHandle

Tag

Text

UniDirectional

UpdateMode

UpdateObject

UpdateRecordTypes

UpdatesPending

VCLComObject


TDecisionQuery イベント3155004

TDecisionQuery	アルファベット順	凡例

TBDEDataSet からの継承

OnServerYield

OnUpdateError

OnUpdateRecord

TDataSet からの継承

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TDecisionQuery イベント3155005

TDecisionQuery	オブジェクト順	凡例

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError

OnServerYield

OnUpdateError

OnUpdateRecord


TDecisionQuery メソッド3155006

TDecisionQuery	アルファベット順

TQuery からの継承

Create

Destroy

ExecSQL

ParamByName

Prepare

UnPrepare

TDBDataSet からの継承

CheckOpen

OpenDatabase

TBDEDataSet からの継承

ApplyUpdates

BookmarkValid

Cancel

CancelUpdates

CommitUpdates

CompareBookmarks

ConstraintCallBack

ConstraintsDisabled

CreateBlobStream

DisableConstraints

EnableConstraints

FetchAll

FlushBuffers

GetCurrentRecord

GetIndexInfo

IsSeguenced

Locate

Lookup

RevertRecord

UpdateStatus

TDataSet からの継承

ActiveBuffer

Append

AppendRecord

CheckBrowseMode

ClearFields

Close

ControlsDisabled

CursorPosChanged

Delete

DisableControls

Edit

EnableControls

FieldByName

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FreeBookmark

GetBookmark

GetFieldList

GetFieldNames

GotoBookmark

Insert

InsertRecord

IsEmpty

IsLinkedTo

Last

MoveBy

Next

Open

Post

Prior

Refresh

Resync

SetFields

Translate

UpdateCursorPos

UpdateRecord

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDecisionQuery メソッド3155007

TDecisionQuery	オブジェクト順

ActiveBuffer

Append

AppendRecord

ApplyUpdates

Assign

BookmarkValid

Cancel

CancelUpdates

CheckBrowseMode

CheckOpen

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearFields

Close

CommitUpdates

CompareBookmarks

ConstraintCallBack

ConstraintsDisabled

ControlsDisabled

Create

CreateBlobStream

CursorPosChanged

DefaultHandler

Delete

Destroy

DestroyComponents

Destroying

DisableConstraints

DisableControls

Dispatch

Edit

EnableConstraints

EnableControls

ExecSQL

FetchAll

FieldAddress

FieldByName

FindComponent

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FlushBuffers

Free

FreeBookmark

FreeInstance

FreeNotification

FreeOnRelease

GetBookmark

GetCurrentRecord

GetFieldList

GetFieldNames

GetIndexInfo

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GotoBookmark

HasParent

InheritsFrom

InitInstance

Insert

InsertComponent

InsertRecord

InstanceSize

IsEmpty

IsLinkedTo

IsSeguenced

Last

Locate

Lookup

MethodAddress

MethodName

MoveBy

NewInstance

Next

Open

OpenDatabase

ParamByName

Post

Prepare

Prior

Refresh

RemoveComponent

Resync

RevertRecord

SafeCallException

SetFields

Translate

UnPrepare

UpdateCursorPos

UpdateRecord

UpdateStatus


スコープ3155008

published

読み出し／書き込み

読み出し専用


スコープ3155009

published


継承3155010

TObject

TPersistent

TComponent

TDataSet

TBDEDataSet

TDBDataSet

TQuery


TDecisionQuery 例3155011

TDecisionQuery


TDecisionSource
TDecisionSource3156001

継承	プロパティ	メソッド	イベント	参照

TDecisionSource は，デシジョンコントロールをデシジョンキューブからのデータの設定（ピボット状態）にリンクします。

ユニット

mxdb

説明

TDecisionSource を使うとデシジョングリッドまたはデシジョングラフにデシジョンキューブからクロス集計データを提供できます。TDecisionSource はデシジョンキューブから行次元と列次元への次元の特定のピボット状態を表します。また，TDecsionSource は値の集計に注意を集中させるために次元の表示を並べ替えたり，ピボット状態で次元の表示と非表示を切り替えたりするメソッドを提供します。

デシジョンソースを共有するコントロールはすべて同じピボット状態を表示します。たとえば，同じデシジョンソースにリンクされたデシジョングリッドとデシジョングラフをフォームに格納することができます。デシジョングリッドの次元をピボット上に置くと自動的に対応するグラフのイメージが更新されます。1 つのフォーム内のデシジョンキューブからの情報の射影を 2 つ別々に表示するには，2 つの個別のデシジョンソースを使います。

デシジョンソースのピボット状態はデシジョングリッドを操作したり，デシジョンピボットを使ったりすることで変更できます。


TDecisionSource プロパティ3156002

TDecisionSource	アルファベット順	凡例

TDecisionSource

ControlType

CurrentSum

DecisionCube

nColDims

nDataCols

nDataRows

nDims

nOpenColDims

nOpenRowDims

nRowDims

nSums

Ready

SparseCols

SparseRows

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDecisionSource プロパティ3156003

TDecisionSource	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlType

CurrentSum

DecisionCube

DesignInfo

Name

nColDims

nDataCols

nDataRows

nDims

nOpenColDims

nOpenRowDims

nRowDims

nSums

Owner

Ready

SparseCols

SparseRows

Tag

VCLComObject


TDecisionSource.ControlType
TDecisionSource.ControlType3156004

TDecisionSource	参照

ControlType プロパティは，デシジョンソースがデシジョンピボットからのメッセージに応答する方法を指定します。

TDecisionControlType = (xtCheck, xtRadio, xtRadioEx);

property ControlType: TDecisionControlType;

説明

ControlType プロパティは，同時に開ける行次元または列次元の組み合わせを指定するために使われます。以下に ControlType に設定される値を示します。

値	意味

xtCheck	次元のボタンを押すと個々の次元が開いたり閉じたりして，開いている次元の数が変わる

xtRadio	次元のボタンを押すと選択した次元が開いたり閉じたりして，その方向にあるほかの次元をすべて閉じる。ControlType が xtRadio の場合，最大で 1 つの行次元と 1 つの列次元が同時に開いている

xtRadionEx	次元のボタンを押すと，選択した次元は開きその方向のそれ以外の次元はすべて閉じるか，選択した次元は閉じその方向の他の 1 つの次元が開く。ControlType が xtRadioEx の場合，正確に 1 つの行次元と 1 の列次元が常に開いていなければならない


TDecisionSource.CurrentSum
TDecisionSource.CurrentSum3156005

TDecisionSource	参照

CurrentSum プロパティは，デシジョンキューブによって保守されるアクティブな集計のセットからの現在の集計のインデックスです。

property CurrentSum: integer;

説明

CurrentSum プロパティは，アクティブな集計のどの集計がデシジョンソースのクライアントに値を提供するのに使われるかを特定します。CurrentSum は最初のアクティブな集計が現在の集計の場合に 0 を返します。CurrentSum は最後のアクティブな集計が現在の集計の場合には nSums-1 を返します。

現在の集計を変更するには SetCurrentSummary メソッドを使います。GetSummaryName メソッドを使うと現在の集計の名前を取得できます。


TDecisionSource.DecisionCube
TDecisionSource.DecisionCube3156006

TDecisionSource	参照

DecsionCube プロパティは，クロス集計データをデシジョンソースに提供するデシジョンキューブです。

property DecisionCube: TDecisionCube;

説明

DecisionCube プロパティは，デシジョンソースがデータをどこから取り出すかを指定するために使われます。デシジョンキューブはキャッシュに集計の多次元配列を保持します。デシジョンソースはそのキャッシュ内のデータの射影をデシジョンコントロールに提供します。


TDecisionSource.nColDims
TDecisionSource.nColDims3156007

TDecisionSource	参照

nColDims プロパティは，デシジョンソースの現在のピボット状態での列次元の数です。

property nColDims: Integer;

説明

nColDims プロパティは，デシジョンソースがデシジョンコントロールに提供できる列次元の数を判別するために使われます。列次元はデシジョングラフの Y 軸上またはデシジョングリッドの上部に表示されます。nColDims は開いている次元と閉じている次元をカウントします。実際にデシジョンコントロールに提供される列次元の数を判別するには，nOpenColDims プロパティを使います。


TDecisionSource.nDataCols
TDecisionSource.nDataCols3156008

TDecisionSource	参照

nDataCols プロパティは，デシジョングリッドのデータ領域の列数です。

property nDataCols: Integer;

説明

nDataCols プロパティは，デシジョンソースがデシジョングリッドの行に提供する集計値の数を特定するために使われます。nDataCols でカウントされる各列は，開いているそれぞれの列次元の値または次元の小計の組み合わせを表します。


TDecisionSource.nDataRows
TDecisionSource.nDataRows3156009

TDecisionSource	参照

nDataRows プロパティは，デシジョングリッドのデータ領域の行数です。

property nDataRows: Integer;

説明

nDataRows プロパティは，デシジョンソースがデシジョングリッドに入っている列に提供する集計値の数を示します。nDataRows でカウントされる各行は，開いているそれぞれの行次元の値または小計の組み合わせを表します。


TDecisionSource.nDims
TDecisionSource.nDims3156010

TDecisionSource	参照

nDims プロパティは，デシジョンキューブにおけるアクティブな次元数です。

property nDims: Integer;

説明

nDims プロパティは，デシジョンソースがデシジョンコントロールに提供できる次元の数を特定するために使われます。デシジョンソースは，デシジョンコントロールに nDims プロパティでカウントされたすべての次元を必ず提供するわけではありません。閉じている次元もあります。

デシジョンソースから利用可能な次元は列次元と行次元に分割されます。2 つの次元はそれぞれ nColDims プロパティと nRowDims プロパティでカウントされます。nDims は nColDims と nRowDims の合計に等しくなります。


TDecisionSource.nOpenColDims
TDecisionSource.nOpenColDims3156011

TDecisionSource	参照

nOpenColDims プロパティは，デシジョンソースから提供される列数です。

property nOpenColDims: Integer;

説明

nOpenColDims プロパティは，デシジョンソースからデシジョンコントロールに提供される開いている列の数を示します。列次元はデシジョングラフの Y 軸上またはデシジョングリッドの上部に表示されます。nOpenColDims はデシジョンコントロールで表示される開いている次元だけをカウントします。現在のピボット状態で利用可能なすべての列次元の数を特定するには nColDims プロパティを使います。


TDecisionSource.nOpenRowDims
TDecisionSource.nOpenRowDims3156012

TDecisionSource	参照

nOpenRowDims プロパティは，デシジョンソースから提供される行次元数です。

property nOpenRowDims: Integer;

説明

nOpenRowDims プロパティは，デシジョンソースからデシジョンコントロールに提供される開いている行次元の数を特定するために使われます。行次元はデシジョングラフの X 軸上またはデシジョングリッドの左上部に表示されます。nOpenRowDims はデシジョンコントロールで表示される開いている行次元だけをカウントします。現在のピボット状態で利用可能な行次元すべての数を特定するには nRowDims プロパティを使います。


TDecisionSource.nRowDims
TDecisionSource.nRowDims3156013

TDecisionSource	参照

nRowDims プロパティは，デシジョンソースの現在のピボット状態での行次元数です。

property nRowDims: Integer;

説明

nRowDims プロパティは，デシジョンソースからデシジョンコントロールへ提供できる行次元の数を特定するために使われます。行次元はデシジョングラフの X 軸上またはデシジョングリッドの左上部に表示されます。nRowDims は開いている次元と閉じている次元の両方をカウントします。実際にデシジョンコントロールに提供される行次元の数を特定するには nOpenRowDims プロパティを使います。


TDecisionSource.nSums
TDecisionSource.nSums3156014

TDecisionSource	参照

nSums プロパティは，デシジョンキューブでアクティブな集計の数です。

property nSums: Integer;

説明

nSums プロパティは，デシジョンソースがデシジョンコントロールに提供できる集計型の数を特定するために使われます。デシジョンソースはデシジョンコントロールに一度に 1 つの集計しか提供できません。CurrentSum プロパティは nSums のどの集計がデシジョンソースから提供されるかを指定します。


TDecisionSource.Ready
TDecisionSource.Ready3156015

TDecisionSource	参照

Ready プロパティは，デシジョンソースがアクティブなデシジョンキューブにリンクしているかどうかを示します。

property Ready: Boolean;

説明

Ready プロパティは，デシジョンソースがデータをデシジョンコントロールに提供できるかどうかを判別するために使われます。


TDecisionSource.SparseCols
TDecisionSource.SparseCols3156016

TDecisionSource	参照

SparseCols プロパティは，空の行が現在の射影から削除されたかどうかを示します。

property SparseCols: boolean;

説明

SparseCols を True に設定すると現在のピボット状態で空になっている列を表示できます。SparseCols を False に設定すると，1 つまたは複数の行次元上の集計データを持つ次元の値だけを表示できます。

注意

SparseCols は GetDimensionMemberCount に返された値は変更しません。


TDecisionSource.SparseRows
TDecisionSource.SparseRows3156017

TDecisionSource	参照

SparseRows プロパティは，空の行が現在の射影から削除されたかどうかを示します。

property SparseRows: boolean;

説明

SparseRows を True に設定すると現在のピボット状態で空になっている行を表示できます。SparseRows を False に設定すると 1 つまたは複数の列次元上の集計データを持つ次元値だけを表示できます。

注意

SparseRows は GetDimensionMemberCount に返された値は変更しません。


TDecisionSource イベント3156018

TDecisionSource	アルファベット順	凡例

TDecisionSource

OnBeginPivot

OnEndPivot

OnLayoutChange

OnNewDimensions

OnStateChange

OnSummaryChange


TDecisionSource イベント3156019

TDecisionSource	オブジェクト順	凡例

OnBeginPivot

OnEndPivot

OnLayoutChange

OnNewDimensions

OnStateChange

OnSummaryChange


TDecisionSource.OnBeginPivot
TDecisionSource.OnBeginPivot3156020

TDecisionSource	参照

OnBeginPivot イベントは，現在のピボット状態を変更する直前に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnBeginPivot: TNotifyEvent;

説明

OnBeginPivot イベントハンドラを記述するとデシジョンソースから提供される情報が変更される直前に特定のアクションを実行できます。OnPivot が発生するとピボットの結果は計算されますが実現されません。GetGroup，GetIndex，GetState，GetValue，および GetRowState メソッドを使うと実現される直前のピボット状態についての情報を取得できます。終了直前のピボットの状態についての情報を取得するには，次元情報を OnEndPivot イベントハンドラに保存します。保存しておくと新しい状態についての情報を，最後に変更されたピボット状態の情報と比較することができます。OnBeginPivot イベントハンドラは，デシジョンソースのメソッドを使ってピボット状態にさらに変更を加えることができます。


TDecisionSource.OnEndPivot
TDecisionSource.OnEndPivot3156021

TDecisionSource	参照

OnEndPivot イベントは，現在のピボット状態を変更した直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnEndPivot: TNotifyEvent;

説明

OnEndPivot イベントハンドラを記述すると，デシジョンソースから提供される情報が変更された直後で，デシジョンコントロールがその変更を反映するために更新される前に特定のアクションを実行できます。このときピボット状態についての情報を保存すると便利です。

デシジョンソースのピボット状態が変わると，変更結果が計算されたときに OnBeginPivot が発生し，デシジョンソースがその変更を反映して更新されたときに OnEndPivot が発生します。その変更に対応してデシジョンピボットにリンクされたデシジョンコントロールを更新されると OnLayoutChange イベントが発生します。


TDecisionSource.OnLayoutChange
TDecisionSource.OnLayoutChange3156022

TDecisionSource	参照

OnLayoutChange イベントは，デシジョンソースのピボット状態に対する変更を反映するためにデシジョンコントロールが更新された直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnLayoutChange: TNotifyEvent;

説明

OnLayoutChange イベントハンドラを記述すると，アクティブな次元の構成の変更に応答できます。OnLayoutChange はピボット状態または並べ替えを変更した場合に発生しますが，デシジョンキューブにキャッシュされている情報は元のままです。OnLayoutChange が発生すると，デシジョンソースから提供可能な情報は変更されず，その情報の構成だけが変更されます。デシジョンキューブにキャッシュされたデータの変更に応答するには OnNewDimensions イベントを使います。


TDecisionSource.OnNewDimensions
TDecisionSource.OnNewDimensions3156023

TDecisionSource	参照

OnNewDimensions イベントは，デシジョンキューブから提供されるデータを変更した直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnNewDimensions: TNotifyEvent;

説明

OnNewDimensions イベントハンドラを記述すると，データキューブの次元のアクティブなプロパティが変わるときなど，データ配列を変える変更に応答できます。OnNewDimensions が発生すると，デシジョンソースから提供される情報が変わります。データを再編成するだけでデータキューブにキャッシュされたデータは変えない変更に応答するには，OnEndPivot イベントまたは OnLayoutChange イベントを使います。データキューブ自体の変更に応答するには OnStateChange イベントを使います。


TDecisionSource.OnStateChange
TDecisionSource.OnStateChange3156024

TDecisionSource	参照

OnStateChange イベントは，DecisionCube プロパティを変更すると発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnStateChange: TNotifyEvent;

説明

OnStateChange イベントハンドラを記述すると，DecisionCube プロパティが変わったとき，またはデシジョンキューブの Active プロパティが変わったときに応答できます。部分的な変更に応答するには OnNewDimensions イベント，OnLayoutChange イベント，または OnEndPivot イベントを使います。


TDecisionSource.OnSummaryChange
TDecisionSource.OnSummaryChange3156025

TDecisionSource	参照

OnSummaryChange イベントは，CurrentSum プロパティを変更した直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnSummaryChange: TNotifyEvent;

説明

OnSummaryChange イベントハンドラを記述すると，デシジョンソースに提供された集計が変わるときに特定のアクションを実行できます。CurrentSum プロパティ値は新しい現在の集計を反映します。


TDecisionSource メソッド3156026

TDecisionSource	アルファベット順

TDecisionSource

CloseDimIndexRight

Create

Destroy

DrillDimIndex

Get2DDataAsVariant

GetActiveDim

GetDataAsString

GetDataAsVariant

GetDimensionMemberCount

GetDimensionName

GetGroup

GetGroupCount

GetGroupExtent

GetIndex

GetMemberAsString

GetMemberAsVariant

GetRowState

GetState

GetSummaryName

GetValue

GetValueArray

GetValueIndex

MoveDimIndexes

OpenDimIndexLeft

OpenDimIndexRight

SetCurrentSummary

SwapDimIndexes

ToggleDimIndex

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDecisionSource メソッド3156027

TDecisionSource	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CloseDimIndexRight

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DrillDimIndex

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

Get2DDataAsVariant

GetActiveDim

GetDataAsString

GetDataAsVariant

GetDimensionMemberCount

GetDimensionName

GetGroup

GetGroupCount

GetGroupExtent

GetIndex

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetMemberAsString

GetMemberAsVariant

GetNamePath

GetParentComponent

GetRowState

GetState

GetSummaryName

GetValue

GetValueArray

GetValueIndex

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

MoveDimIndexes

NewInstance

OpenDimIndexLeft

OpenDimIndexRight

RemoveComponent

SafeCallException

SetCurrentSummary

SwapDimIndexes

ToggleDimIndex


TDecisionSource.CloseDimIndexRight
TDecisionSource.CloseDimIndexRight3156028

TDecisionSource	参照

CloseDimIndexRight メソッドは，次元を閉じます。

TDimGroup = (dgRow, dgCol, dgSum, dgPage, dgNone);

procedure CloseDimIndexRight(dimGroup: TDimGroup; Index: Integer; bOpen: boolean);

説明

CloseDimIndexRight メソッドを呼び出すと，デシジョンソースが使うデシジョンコントロールに表示される射影内に表示されないようするために次元を閉じることができます。

CloseDimIndexRight は Index パラメータによって識別された次元の次に開いている最初の次元を閉じます。dimGroup パラメータが dgRow ならば，Index は行次元を識別して，0 は 1 番目の行次元を指定し，1 は 2 番目の行次元を指定します。dimGroup パラメータが dgCol ならば，Index は 0 を 1 番目の列次元とするインデックスで列次元を識別します。dimGrouop のほかの値は CloseDimIndexRight メソッドで使わないでください。開いている 1 番目の行次元または列次元を閉じるには Index を -1 に設定します。bOpen パラメータは，Index パラメータを解釈するときに閉じている次元をカウントするかどうかを指定します。bOpen が True の場合は開いている次元のみカウントされます。


TDecisionSource.Create
TDecisionSource.Create3156029

TDecisionSource	参照

Create メソッドは，TDecisionSource のインスタンスを作成し，初期化します。

constructor Create( AOwner: TComponent ); override;

説明

Create メソッドを呼び出すと，実行時にデシジョンソースをインスタンス化できます。設計時にフォームまたはデータモジュールに配置されたデシジョンソースオブジェクトは自動的に作成されます。


TDecisionSource.Destroy
TDecisionSource.Destroy3156030

TDecisionSource	参照

Destroy メソッドは，TDecisionSource のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはデシジョンソースが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

デシジョンコントロールがデシジョンソースにリンクされている場合，Destroy は常に DecisionSource プロパティを nil に変更します。


TDecisionSource.DrillDimIndex
TDecisionSource.DrillDimIndex3156031

TDecisionSource	参照

DrillDimIndex メソッドは，次元を折り畳んで 1 つの値にまとめます。

TDimGroup = (dgRow, dgCol, dgSum, dgPage, dgNone);

procedure DrillDimIndex(dimGroup: TDimGroup; Index: Integer; ValueIndex: Integer;

   bOpen:boolean);

説明

DrillDimIndex メソッドを呼び出すと，1 つの値の集計だけが表示されるように次元を折り畳むことができます。

dimGroup パラメータは折り畳む次元の型を指定します。dimGroup が dgRow ならば，Index パラメータは折り畳むのが行次元であることを示します。dimGroup が dgCol ならば，Index パラメータは折り畳むのが列次元であることを示します。dimGroup のほかの値は DrillDimIndex メソッドで使わないでください。最初の行次元または列次元の Index は 0 で，2 番目の次元の Index は 1 などとなります。ValueIndex パラメータは表示する次元すべての値の中で 1 つの値のインデックスです。次元に沿った 1 つの値ではなく次元全体の集計だけを表示するには，ValueIndex を -1 に設定します。bOpen パラメータは，Index パラメータを解釈するときに閉じている次元をカウントするかどうかを指定します。bOpen が True のときは開いている次元のみカウントされます。

すべての値が表示されるように折り畳んだ状態から元の状態に復元するには ToggleDimIndex メソッドを使います。


TDecisionSource.Get2DDataAsVariant
TDecisionSource.Get2DDataAsVariant3156032

TDecisionSource	参照

Get2DDataAsVariant メソッドは，現在のピボット状態の 2 つの次元の射影の集計を返します。

function Get2DDataAsVariant(iDimA, iDimB: Integer; aValueIndex, bValueIndex:Integer):

   Variant;

説明

Get2DDataAsVariant メソッドを呼び出すと，iDimA 次元上の aValueIndex 座標および iDimB 次元上の bValueIndex 座標に相当するデシジョンキューブから集計値を取得できます。戻り値は，次元が折り畳まれていない限り，ほかのアクティブな次元のすべての値を集計するバリアントです。折り畳まれている次元の場合，折り畳まれた次元の値のみ集計に含まれます。

iDimA パラメータと iDimB パラメータは 2 つの次元射影に使う次元を指定し，0 ならば最初のアクティブな次元を示し，1 ならば 2 番目の次元を示します。次元インデックスは絶対インデックスとして表現されます。行または列のインデックスから絶対インデックスを取得するには GetActiveDim メソッドを使います。aValueIndex パラメータと bValueIndex パラメータはその 2 つの次元上の値のインデックスで，0 ならば最初の値を示し，1 ならば 2 番目の値を示します。GetMemberAsString メソッドまたは GetMemberAsVariant メソッドを使うと，aValueIndex メソッドおよび bValueIndex メソッドに相当する項目値を取得できます。


TDecisionSource.GetActiveDim
TDecisionSource.GetActiveDim3156033

TDecisionSource	参照

GetActiveDim メソッドは，行固有の次元または列固有の次元のインデックスを絶対次元インデックスに変換します。

TDimGroup = (dgRow, dgCol, dgSum, dgPage, dgNone);

function GetActiveDim(dimGroup: TDimGroup; Index: Integer; bOpen: boolean): Integer;

説明

GetActiveDim メソッドを呼び出すとデシジョンキューブにおける次元のインデックスをデシジョングリッドにおける位置から取得できます。行次元の名前と値は，デシジョングリッドの右側のラベルセルに表示されます。1 番目の行次元は 1 列目に表示され，2 番目の行次元は 2 列目に表示されます。同様に，列次元はデシジョングリッドの右側の上部に表示され，1 番目の列次元はグリッドの 1 列目に表示されます。

dimGroup パラメータは次元が行次元か列次元かを示します。dimGroup が dgRow ならば次元は行次元です。dimGroup が dgCol ならば次元は列次元です。GetActiveDim は dimGroup のほかの値には実現されません。Index パラメータは行次元または列次元のセットにおける次元の位置を示して，0 は 1 番目の行次元または列次元を指定し，1 は 2 番目の行次元または列次元を指定します。bOpen パラメータは，Index を解釈するときに閉じている次元をカウントするかどうかを指定します。bOpen が True の場合はは開いている次元のみカウントされます。

GetActiveDim は次元の絶対インデックスを返します。絶対インデックスは GetDimensionName または GetMemberAsString などデシジョンソースの多くのメソッドで使います。

注意

行固有または列固有のインデックスを絶対次元インデックスから取得するには GetIndex メソッドを使います。


TDecisionSource.GetDataAsString
TDecisionSource.GetDataAsString3156034

TDecisionSource	参照

GetDataAsString メソッドは，デシジョングリッドのセルに表示されるデータ値を文字列形式で返します。

function GetDataAsString(ARow, ACol:Integer; var SubLevel: Integer): String;

説明

GetDataAsString メソッドを呼び出すとデシジョングリッドのデータセルの表示文字列を取得できます。ARow パラメータと ACol パラメータはデシジョングリッド内のセルの行および列の番号を示します。(0,0) はデータ領域の左最上部を示します。

GetDataAsString は，行と列のインデックスに相当する，デシジョンキューブにおける次元の座標を計算し，小計の計算対象になる次元すべての記録を作成します。次にデシジョンキューブから集計値を取得して，集計された各次元の値を組み合わせます。GetDataAsString は最終集計値を文字列形式で返します。また，SubLevel パラメータに入っている集計された次元数も返します。


TDecisionSource.GetDataAsVariant
TDecisionSource.GetDataAsVariant3156035

TDecisionSource	参照

GetDataAsVariant メソッドは，デシジョングリッドのセルに表示されるデータ値を返します。

function GetDataAsVariant(Arow, ACol: Integer; var SubLevel: Integer): Variant;

説明

GetDataAsVariant メソッドを呼び出すとデシジョングリッドのデータセルの値を取得できます。ARow および ACol パラメータはデシジョングリッドのセルの行数および列数を示し，(0,0) はデータ領域のセルの左上部を指定します。

GetDataAsVariant は，行と列のインデックスに行と列の次元に相当する，デシジョンキューブにおける次元の座標を計算し，小計の対象になる次元すべての記録を作成します。次に次元の座標を取得して，集計された各次元の値を組み合わせます。GetDataAsVariant は最終集計値を返します。また， SubLevel パラメータに入っている集計された次元数も返します。


TDecisionSource.GetDimensionMemberCount
TDecisionSource.GetDimensionMemberCount3156036

TDecisionSource	参照

GetDimensionMemberCount メソッドは，指定された次元に表示する個々の値の数を返します。

function GetDimensionMemberCount(iDim: Integer): Integer;

説明

GetDimensionMemberCount メソッドを呼び出すと iDim パラメータで識別される値の数を特定できます。iDim パラメータは次元の絶対インデックスで，0 ならばデシジョンキューブでアクティブな最初の次元を示し，1 ならば 2 番目にアクティブな次元を示します。行固有または列固有の次元インデックスを絶対次元インデックスに変換するには GetActiveDim メソッドを使います。

GetDimensionMemberCount は GetMemberAsString メソッドまたは GetMemberAsVariant メソッドの ValueIndex パラメータに上限を設定します。

注意

GetDimensionMemberCount が返す値はピボット状態と SparseCols プロパティおよび SparseRows プロパティの値によって異なることがあります。


TDecisionSource.GetDimensionName
TDecisionSource.GetDimensionName3156037

TDecisionSource	参照

GetDimensionName メソッドは，次元に表示する名前を返します。

function GetDimensionName(iDim: Integer): String;

説明

GetDimensionName メソッドを呼び出すと次元のラベルとして表示する名前を取得できます。iDim パラメータは次元の絶対インデックスで，0 ならばデシジョンキューブで最初のアクティブな次元を示し，1 ならば 2 番目のアクティブな次元を示します。行固有または列固有の次元インデックスを絶対次元インデックスに変換するには GetActiveDim メソッドを使います。

次元の名前は，通常，次元が表す項目の名前を使います。次元の名前を変更するには，デシジョンキューブエディタを使うか，デシジョンキューブの次元マップに入っている次元の Name プロパティを設定します。


TDecisionSource.GetGroup
TDecisionSource.GetGroup3156038

TDecisionSource	参照

GetGroup メソッドは，現在のピボット状態で次元がどこに表示されるかを示します。

TDimGroup = (dgRow, dgCol, dgSum, dgPage, dgNone);

function GetGroup(iDim: Integer) : TDimGroup;

説明

GetGroup メソッドを呼び出すと， iDim パラメータで指定された次元が現在のピボット状態で使われる方法を判別できます。iDim パラメータは次元の絶対インデックスで，0 ならばアクティブな最初の次元，1 ならばアクティブな 2 番目の次元を示します。

次元が行次元（デシジョングリッドの左またはデシジョングラフの Y 軸上に表示）ならば，GetGroup は dgRow を返します。行次元（デシジョングリッドの上部またはデシジョングラフの X 軸上に表示）ならば，GetGroup は dgCol を返します。次元がページ次元（デシジョンコントロールに表示されないがデータを次元に沿った 1 つの値に限定する）ならば，GetGroup は dgPage を返します。GetGroup は dgSum または dgNone を返しません。

注意

行次元または列次元内の次元の位置を判別するには GetIndex メソッドを使います。


TDecisionSource.GetGroupExtent
TDecisionSource.GetGroupExtent3156039

TDecisionSource	参照

GetGroupExtent メソッドは，次元の個々の値のセルインデックスの範囲を返します。

TDimRange = Record

    First: Integer;

    Last: Integer;

  end;

TDimGroup = (dgRow, dgCol, dgSum, dgPage, dgNone);

function GetGroupExtent(dimGroup: TDimGroup; Index: Integer; Cell: Integer): TDimRange;

説明

GetGroupExtent メソッドを呼び出すと，Cell パラメータと同じ値を指定された次元上に持つ，デシジョングリッドのセルの範囲を検索できます。Cell はセルを格納する行または列のインデックスで，0 はデシジョングリッドのデータ領域における最初の行または列を指定します。dimGroup が dgRow ならば Cell はグリッドの行を識別します。dimGroup が dgCol ならば Cell はグリッドの列を識別します。ほかの値は dimGroup に指定しないでください。Index は行固有または列固有の次元のインデックスを指定します。

たとえば，デシジョングリッドが最初の 2 列に 2 つの行次元を持つ場合，

MyRange := GetGroupExtent(dgRow, 0, 3);

という行は MyRange を，1 番目の行次元上に 3 番目のセルと同じ値を持つセルの行インデックスの範囲に設定できます。この範囲内のセルの数は GetDimensionMemberCount によって 2 番目の開いている行次元に返される値を同じです。次の

MyRange := GetGroupExtent(dgRow, 1, 3);

という行は MyRange を 3 から 3 の範囲に設定します。2 番目の行次元が最も内側の次元なので，各値は 1 つの行で表されるからです。

注意

次元に小計が含まれる場合，小計のセルは GetGroupExtent が返す範囲に含まれます。


TDecisionSource.GetIndex
TDecisionSource.GetIndex3156040

TDecisionSource	参照

GetIndex メソッドは，行固有または列固有の次元のインデックスを返します。

function GetIndex(iDim: Integer; bOpen: boolean): Integer;

説明

GetIndex メソッドを呼び出すと，行固有または列固有の次元のインデックスをデシジョンキューブにおけるインデックスから取得できます。GetIndex は最初の行次元または列次元には 0 を返します。GetIndex は 2 番目の行次元または列次元には 1 を返します。iDim パラメータは次元の絶対インデックスです。bOpen パラメータが True ならば，GetIndex は開いている次元だけをカウントした場合の次元の位置です。bOpen が False ならば，閉じている次元も含めたすべての次元をカウントした場合の位置です。

GetGroup メソッドを使うと， GetIndex が返したインデックスが行固有インデックス（GetGroup が dgRow を返す）なのか列固有インデックス（GetGroup が dgRow を返す)なのかを判別できます。

デシジョンキューブにおける次元のインデックスを行固有または列固有インデックスから取得するには GetActiveDim メソッドを使います。


TDecisionSource.GetMemberAsString
TDecisionSource.GetMemberAsString3156041

TDecisionSource	参照

GetMemberAsString メソッドは，次元の値にラベル文字列を返します。

function GetMemberAsString(iDim: Integer; ValueIndex: Integer): String;

説明

GetMemberAsString メソッドを呼び出すと，iDim パラメータで指定された次元上で，ValueIndex パラメータで指定された値を文字列形式で取得できます。

iDim パラメータは次元の絶対インデックスを表し，0 ならばデシジョンキューブにおいて最初のアクティブな次元を示し，1 ならば 2 番目のアクティブな次元を示します。行固有または列固有の次元インデックスを絶対次元インデックスに変化するには GetActiveDim メソッドを使います。

ValueIndex パラメータは次元の 1 つの値のインデックスで，0 は次元の最初の値を指定し GetDimensionMemberCount は次元の値の数を返します。


TDecisionSource.GetMemberAsVariant
TDecisionSource.GetMemberAsVariant3156042

TDecisionSource	参照

GetMemberAsVariant メソッドは，次元の 1 つの値を返します。

function GetMemberAsVariant(iDim: Integer; ValueIndex: Integer): Variant;

説明

GetMemberAsVariant メソッドを呼び出すと，iDim パラメータで指定された次元上で，ValueIndex パラメータで指定された値を取得できます。

iDim パラメータは次元の絶対インデックスで，0 ならばデシジョンキューブで最初のアクティブな次元を示し，1 ならば 2 番目のアクティブな次元を示します。行固有または列固有の次元インデックスを絶対次元インデックスに変化するには GetActiveDim メソッドを使います。

ValueIndex パラメータは次元の 1 つの値のインデックスで，0 は次元の最初の値を指定し GetDimensionMemberCount は次元の値の数を返します。


TDecisionSource.GetRowState
TDecisionSource.GetRowState3156043

TDecisionSource	参照

GetRowState メソッドは，隣接した次元が開いているか閉じているかを示します。

TRowStates = (rcNextOpen, rcPrevOpen, rcNextClosed, rcPrevClosed);

TRowState = set of TRowStates;

function GetRowState(iDim: Integer): TRowState;

説明

GetRowState メソッドを呼び出すと現在のピボット状態で次元に隣接した次元の状態を判別できます。iDim パラメータはどの次元に隣接する次元を調べるのかを指定する絶対インデックスです。iDim が 0 のときは，次元はデシジョンキューブでアクティブな最初の次元になります。iDim が 1 のときは，アクティブな 2 番目の次元などとなります。

戻り値には，前の次元が開いている場合は rcPrevOpen が含まれ，前の次元が閉じている場合は rcPrevClosed が含まれます。最初の行または列次元には rcPrevOpen と rcPrevClosed は含まれません。最後の行または列次元には rcNextOpen と rcNextClosed が含まれません。

注意

GetRowState メソッドの名前に注意してください。GetRowState メソッドは，iDim が列次元を指定する場合には隣接する列次元についての情報を提供し，iDim が行次元を指定する場合には隣接する行次元についての情報を提供するメソッドです。


TDecisionSource.GetState
TDecisionSource.GetState3156044

TDecisionSource	参照

GetState メソッドは，次元の状態を返します。

TDimState = (dmClosed, dmOpen, dmDrilled, dmPaged, dmNone);

function GetState(iDim: Integer): TDimState;

説明

GetState メソッドを呼び出すと指定された次元が開いているのか，閉じているのか，折り畳まれているのかを判別できます。iDim パラメータは次元の絶対インデックスで，0 ならデシジョンキューブでアクティブな最初の次元を指定し，1 ならば 2 番目にアクティブな次元を指定します。GetState は次の値のいずれかを返します。

値	意味

dmClosed	次元は閉じている。次元の値はデシジョンコントロールに表示されない

dmOpen	次元は開いている。次元の値はすべてデシジョンコントロールに表示される

dmDrilled	次元は折り畳まれている。次元に沿って 1 つの値（またはすべての値の集計）だけがデシジョンコントロールに表示される

dmPaged	次元は 1 つの値またはすべての値の集計のみ表示できる

dmNone	次元はアクティブでない

注意

dmDrilled 状態はデシジョンコントロールで dmPaged と同じように表示されます。ただし，ページ次元の状態は変わりませんが，折り畳まれた次元の状態は閉じたり開いたりすると変わることがあります。ページ次元はほかの型に比べてかなりメモリ使用量が少なくなります。


TDecisionSource.GetSummaryName
TDecisionSource.GetSummaryName3156045

TDecisionSource	参照

GetSummaryName メソッドは，デシジョンキューブでアクティブな集計の名前を返します。

function GetSummaryName(iSum: Integer): String;

説明

GetSummaryName メソッドを呼び出すと集計の名前を特定できます。iSum パラメータは，デシジョンキューブから提供可能なアクティブな集計のリストに入っている集計のインデックスです。GetSummaryName を使うと， SetCurrentSummary メソッドを使って設定できる集計の名前を特定できます。


TDecisionSource.GetValue
TDecisionSource.GetValue3156046

TDecisionSource	参照

GetValue メソッドは，折り畳まれた次元またはページ次元の集束値を返します。

function GetValue(iDim: Integer): Integer;

説明

GetValue メソッドを呼び出すと折り畳まれた次元またはページ次元でどの値が集束されているかを判別できます。折り畳まれた次元とページ次元は，次元に沿って 1 つの項目のデータだけを表示します。GetValue はその 1 つの値のインデックスを返します。その値は，GetMemberAsString メソッドまたは GetMemberAsVariant メソッドを呼び出すことでそのインデックスから取得できます。

iDim パラメータは折り畳まれた次元またはページ次元の絶対インデックスを示し，0 はデシジョンキューブでアクティブな最初の次元を指定し，1 は アクティブな 2 番目の次元を指定します。

注意

次元が，次元内のすべての値の集計だけを表示するために折り畳まれている場合は GetValue は -1 を返します。iDim パラメータで指定された次元が折り畳まれていないかページ次元でない場合，GetValue は -1 を返します。


TDecisionSource.GetValueArray
TDecisionSource.GetValueArray3156047

TDecisionSource	参照

GetValueArray メソッドは，データセルを集計するすべての次元項目の値を返します。

function GetValueArray(ACol, ARow: Integer; var ValueArray: TSmallIntArray): boolean;

説明

GetValueArray メソッドを呼び出すと，デシジョンキューブによって保守される多次元配列内のデシジョングリッドからデータセルの座標を取得できます。ACol パラメータと ARow パラメータはセルを格納する行および列のインデックスを表し，(0,0) はグリッドにおいて左最上部のセルではなく，データ領域で左最上部のセルを指定します。ValueArray パラメータはアクティブな各次元の項目値のインデックスを返します。インデックスが -1 ならば，セルは対応する次元内のすべての値の小計を表すことを示します。GetMemberAsString メソッドまたは GetMemberAsVariant メソッドを使うと ValueArray パラメータ内のインデックスを項目値に変換できます。GetValueArray は関数が成功したかどうかを示す論理値を返します。


TDecisionSource.GetValueIndex
TDecisionSource.GetValueIndex3156048

TDecisionSource	参照

GetValueIndex メソッドは，デシジョングリッドのセルに相当する次元値のインデックスを返します。

TDimGroup = (dgRow, dgCol, dgSum, dgPage, dgNone);

function GetValueIndex(dimGroup: TDimGroup; Index: Integer; Cell: Integer; var isBreak: boolean; var isSum: boolean) : Integer;

説明

GetValueIndex メソッドを呼び出すと，Index パラメータで指定された次元のデシジョングリッドにおけるセルの座標を取得できます。dimGroup パラメータは次元が行次元（dgRow）なのか列次元（dgCol）なのかを示します。dimGroup を dgRow または dgCol 以外の次元グループに設定している場合に GetValueIndex を呼び出さないでください。Index パラメータは行固有または列固有の次元インデックスです。最初の行次元または列次元の Index は 0 で，2 番目の次元の Index は 1 などとなります。Cell パラメータはセルの行または列のインデックスを表し，0 はグリッドのデータ領域で最初の行または列を指定します。

次元値のインデックスを返すだけでなく，GetValueIndex は次元のセルすべての中の Cell の位置についての追加情報も提供します。GetValueIndex は，Cell が指定された次元上で戻り値を持つ次元グループにおける最初のセルならば，isBreak を True に設定します。GetValueIndex は，Cell が次元の小計を表す場合は iSum を True に設定します。


TDecisionSource.MoveDimIndexes
TDecisionSource.MoveDimIndexes3156049

TDecisionSource	参照

MoveDimIndexes メソッドは，次元の位置を変更します。

TDimGroup = (dgRow, dgCol, dgSum, dgPage, dgNone);

procedure MoveDimIndexes(SDimGroup, DDimGroup: TDimGroup; SIndex, DIndex: Integer; bOpen:boolean);

説明

MoveDimIndexes メソッドを呼び出すとデシジョングリッドのピボット状態を変更します。MoveDimIndexes は SIndex パラメータと SDimGroup パラメータで示される次元を DIndex パラメータと DDimGroup パラメータで示される位置に移動します。

SDimGroup パラメータと DDimGroup パラメータは，次元の位置がデシジョングリッドの行に沿っているのか（SDimGroup または DDimGroup が dgRow），列に沿ってるのか（SDimGroup または DDimGroup が dgCol）を指定します。SIndex パラメータと DIndex パラメータは行次元または列次元における次元の位置のインデックスを示し，0 は最初の位置を指定し 1 は 2 番目の位置を指定します。bOpen パラメータは，SIndex パラメータと DIndex パラメータを解釈するときに閉じている次元をカウントするかどうかを指定します。bOpen が True ならば開いている次元のみカウントされます。


TDecisionSource.OpenDimIndexLeft
TDecisionSource.OpenDimIndexLeft3156050

TDecisionSource	参照

OpenDimIndexLeft メソッドは，指定された次元の前に表示される閉じている次元を開きます。

TDimGroup = (dgRow, dgCol, dgSum, dgPage, dgNone);

procedure OpenDimIndexLeft(dimGroup: TDimGroup; Index: Integer; bOpen: boolean);

説明

OpenDimIndexLeft メソッドを呼び出すと，デシジョンコントロールに値を表示するために閉じている次元を再び開きます。

OpenDimIndexLeft は，Index パラメータで識別される次元の前で最初に閉じている次元を開きます。dimGroup パラメータが dgRow ならば，Index は行次元を識別し，0 ならば最初の行次元を指定し，1 ならば 2 番目の行次元を指定します。dimGroup パラメータが dgCol ならば，Index は列次元を識別し，最初の列次元のインデックスが 0 で始まります。dimGrouop の値以外は OpenDimIndexLeft メソッドで使わないでください。最後の閉じている行次元または列次元を開くには Index を -1 に設定します。bOpen パラメータは Index を解釈するときに閉じている次元をカウントするかどうかを指定します。bOpen が True ならば開いている次元のみカウントされます。


TDecisionSource.OpenDimIndexRight
TDecisionSource.OpenDimIndexRight3156051

TDecisionSource	参照

OpenDimIndexRight メソッドは，指定された次元の後に表示する最初の閉じている次元を開きます。

TDimGroup = (dgRow, dgCol, dgSum, dgPage, dgNone);

procedure OpenDimIndexRight(dimGroup: TDimGroup; Index: Integer; bOpen: boolean);

説明

OpenDimIndexRight メソッドを呼び出すと，デシジョンコントロールに値を表示するために閉じている次元を再び開きます。

OpenDimIndexRight は，Index パラメータで識別される次元の後の最初の閉じている次元を開きます。dimGroup パラメータが dgRow ならば，Index は行次元を識別し，0 ならば最初の行次元を指定し，1 ならば 2 番目の行次元を指定します。dimGroup パラメータが dgCol ならば，Index は列次元を識別し，最初の列次元のインデックスが 0 で始まります。dimGrouop の値以外は OpenDimIndexRight メソッドで使わないでください。最初の閉じている行次元または列次元を開くには Index を -1 に設定します。 bOpen パラメータは Index を解釈するときに閉じている次元をカウントするかどうかを指定します。bOpen が True ならば開いている次元のみカウントされます。


TDecisionSource.SetCurrentSummary
TDecisionSource.SetCurrentSummary3156052

TDecisionSource	参照

SetCurrentSummary メソッドは，どの集計がデシジョンソースから提供されるかを指定します。

procedure SetCurrentSummary(Value: Integer);

説明

デシジョンキューブはアクティブな集計のセットをキャッシュに保持します。デシジョンソースは 1 つの集計しかデシジョンコントロールに提供できません。SetCurrentSummary メソッドを呼び出すと，デシジョンソースからどのアクティブな集計を表示するかを指定できます。Value パラメータは，デシジョンキューブに保守されるアクティブな集計のリストにおける集計のインデックスを指定します。

現在の集計から選択されたアクティブな集計の名前を取得するには GetSummaryName メソッドを使います。


TDecisionSource.SwapDimIndexes
TDecisionSource.SwapDimIndexes3156053

TDecisionSource	参照

SwapDimIndexes メソッドは，2 つの次元の位置を入れ替えます。

TDimGroup = (dgRow, dgCol, dgSum, dgPage, dgNone);

procedure SwapDimIndexes(SDimGroup, DDimGroup: TDimGroup; SIndex, DIndex: Integer; bOpen:boolean);

説明

SwapDimIndexes メソッドを呼び出すとデシジョングリッドのピボット状態を変更できます。SwapDimIndexes は SIndex パラメータおよび SDimGroup パラメータで示される次元の位置と DIndex パラメータおよび DDimGroup パラメータで示される次元の位置を入れ替えます。

SDimGroup パラメータと DDimGroup パラメータは，次元の位置がデシジョングリッドの行に沿っているのか（SDimGroup または DDimGroup が dgRow），列に沿っているのか（SDimGroup また DDimGroup が dgCol）を指定します。SIndex パラメータと DIndex パラメータは行次元または列次元における次元の位置のインデックスを示し，0 は最初の位置を指定し 1 は 2 番目の位置を指定します。bOpen パラメータは，SIndex パラメータと DIndex パラメータを解釈するときに閉じている次元をカウントするかどうかを指定します。bOpen が True ならば開いている次元のみカウントされます。


TDecisionSource.ToggleDimIndex
TDecisionSource.ToggleDimIndex3156054

TDecisionSource	参照

ToggleDimIndex メソッドは，開いているか，閉じているか，折り畳まれている次元の状態を変更します。

TDimGroup = (dgRow, dgCol, dgSum, dgPage, dgNone);

procedure ToggleDimIndex(dimGroup: TDimGroup; Index: Integer; bOpen: boolean);

説明

ToggleDimIndex メソッドを呼び出すと閉じている次元を開き，開いている次元を閉じ，折り畳まれている次元を展開できます。

dimGroup が dgRow ならば，Index パラメータは次元の行固有のインデックスを指定します。dimGroup が dgCol ならば，Index パラメータは次元の列固有インデックスを指定します。最初の行次元または列次元の Index は 0 で，2 番目の次元の Index は 1 などとなります。bOpen パラメータは，Index パラメータを解釈するときに閉じている次元をカウントするかどうかを指定します。bOpen が True ならば開いている次元のみカウントされます。


スコープ3156055

published

読み出し／書き込み

読み出し専用


スコープ3156056

published


継承3156057

TObject

TPersistent

TComponent


TDecisionSource 例3156058

TDecisionSource


TDesigner
TDesigner3157001

継承	プロパティ	メソッド

使用メソッド:

ユニット

forms

・	PaintGrid メソッド

・	ValidateRename メソッド

TDesigner オブジェクトは TObject から直接派生した抽象型で，Delphi 環境のすべてのフォームデザイナの基礎を提供します。

説明

この抽象デザイナオブジェクトはすべてのデザイナオブジェクトで使うプロパティを 2 つ提供し，作業用デザイナオブジェクトがオーバーライドしなくてはならない抽象メソッドを 5 つ定義します。


TDesigner プロパティ3157002

TDesigner	アルファベット順

TDesigner

Form

IsControl


TDesigner プロパティ3157003

TDesigner	オブジェクト順

Form

IsControl


TDesigner.Form
TDesigner.Form3157004

TDesigner

Form プロパティは，現在設計されているフォームへの参照を提供します。

property Form: TForm


TDesigner.IsControl
TDesigner.IsControl3157005

TDesigner

IsControl プロパティは，フォームがフォーム状態とコントロール状態のどちらにあるかを指定します。

property IsControl: Boolean


TDesigner メソッド3157006

TDesigner	アルファベット順

TDesigner

IsDesignMsg

Modified

Notification

PaintGrid

ValidateRename

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDesigner メソッド3157007

TDesigner	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

InheritsFrom

InitInstance

InstanceSize

IsDesignMsg

MethodAddress

MethodName

Modified

NewInstance

Notification

PaintGrid

ValidateRename


TDesigner.IsDesignMsg
TDesigner.IsDesignMsg3157008

TDesigner

IsDesignMsg メソッドは，デザイナがいつメッセージを処理するかを決定します。

function IsDesignMsg(Sender: TControl; var Message: TMessage): Boolean; virtual; abstract;

説明

IsDesignMsg メソッドはデザイナ内のコンポーネントに送られるメッセージごとに呼び出されます。メッセージが設計メッセージならば True を返し，デザイナがコンポーネント用に処理しなくてはならないメッセージであることを示します。


TDesigner.Modified
TDesigner.Modified3157009

TDesigner

Modified メソッドは，コンポーネントが変更されたときにプロパティエディタとコンポーネントエディタに通知します。

procedure Modified; virtual; abstract;

説明

コンポーネントが変更されると，プロパティエディタとコンポーネントエディタがこのメソッドを呼び出し，デザイナが変更に応答できるようになります。


TDesigner.Notification
TDesigner.Notification3157010

TDesigner

Notification メソッドは，フォームに送られた通知にデザイナが応答できるようにします。

procedure Notification(AComponent: TComponent; Operation: TOperation); virtual; abstract;

説明

フォームは通知を受け取るとデザイナの Notification メソッドを呼び出し，フォームが受け取るすべての通知にデザイナが応答できるようにします。


TDesigner.PaintGrid
TDesigner.PaintGrid3157011

TDesigner

PaintGrid メソッドは，フォームのキャンバスに位置合わせグリッドを描画します。

procedure PaintGrid; virtual; abstract;


TDesigner.ValidateRename
TDesigner.ValidateRename3157012

TDesigner

procedure ValidateRename(AComponent: TComponent; const CurName, NewName: string); virtual; abstract;

説明

通常，ValidateRename メソッドはフォームの ValidateRename メソッドによって呼び出され，名前の変更に対する制限（予約語の使用禁止など）を厳しくします。


継承3157013

TObject


TDesigner 例3157014

TDesigner


EDimIndexError
EDimIndexError3158001

継承	プロパティ	メソッド	参照

EDimIndexError は，無効なインデックスを使ってデシジョンソース内の次元を指定した場合の例外クラスです。

ユニット

mxdb

説明

EDimIndexError は，デシジョンソースのいずれかのメソッドが次元に対応していない次元インデックスを使って呼び出されたときに生成されます。


EDimIndexError のプロパティ3158002

EDimIndexError	アルファベット順

Exception からの継承

HelpContext

Message


EDimIndexError のプロパティ3158003

EDimIndexError	オブジェクト順

HelpContext

Message


EDimIndexError のメソッド3158004

EDimIndexError	アルファベット順

Exception 外からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EDimIndexError のメソッド3158005

EDimIndexError	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3158006

TObject

Exception


EDimIndexError の例3158007

EDimIndexError


TDimensionItem
TDimensionItem3159001

継承	プロパティ	メソッド	参照

TDimensionItem は，クロス集計データ記憶内で次元および集計を表すオブジェクトの基本クラスです。

ユニット

mxcommon

説明

クロス集計データ記憶が使う項目を表すクラスを定義する際に，TDimensionItem を基本クラスとして使います。TDimensionItem は，クロス集計データ記憶が使うデータセットの項目とその項目がそのデータ記憶で果たす役割を記述します。クロス集計データ記憶は，集計値の多次元配列を構成する項目を表すために次元項目を自動的に作成します。

TDimensionItem は 1 つの下位オブジェクト，TcubeDim を持ち，これが日付範囲を表す能力で次元項目を強化します。


TDimensionItem のプロパティ3159002

TDimensionItem	アルファベット順	凡例

TDimensionItem

ActiveFlag

BaseName

DerivedFrom

DimensionType

FieldName

FieldType

Format

Name

TCollectionItem からの継承

Collection

DisplayName

ID

Index


TDimensionItem のプロパティ3159003

TDimensionItem	オブジェクト順	凡例

ActiveFlag

BaseName

Collection

DerivedFrom

DimensionType

DisplayName

FieldName

FieldType

Format

ID

Index

Name


TDimensionItem.ActiveFlag
TDimensionItem.ActiveFlag3159004

TDimensionItem	参照

ActiveFlag プロパティは，次元項目をクロス集計データ記憶のキャッシュに格納するかどうかを指定します。

TActiveFlags = (diActive, diAsNeeded, diInactive);

property ActiveType: TActiveFlags;

説明

次元項目を常に使えることが必須の場合，ActiveFlag を diActive に設定します。逆に次元項目を使う頻度が低い場合には，ActiveFlag を diAsNeeded に設定します。デシジョンキューブはメモリを確保するために，Active を diAsNeeded に設定した次元項目を，実際の使用時に呼応してキャッシュから出し入れするスワップ処理を行います。ActiveFlag を diInactive に設定すると，データ記憶が管理する多次元配列を縮小してその次元項目を含まないようにできます。ActiveFlag が diInactive のときは，データ記憶は次元項目についての情報をデシジョンソースオブジェクトに提供できません。

クロス集計データ記憶のメモリ必要性は，含めるアクティブな次元を増やすことにより幾何級数的に増大します。また，含めるアクティブな集計を増やすことにより一次元的に増大します。つまり，アプリケーションは，デシジョンコントロールで次元と集計を即座に使えるように多数の次元と集計をキャッシュしておく性能上のメリットと，キャッシュされた多次元データ配列をメモリ消費が異常に増えないだけのサイズに維持しておく必要性との最適バランスを見つけ出さなければなりません。


TDimensionItem.BaseName
TDimensionItem.BaseName3159005

TDimensionItem	参照

BaseName プロパティは，次元項目が表すデータベース項目や次元項目で集計するデータベース項目の FieldName です。

property BaseName: string;

説明

BaseName プロパティは，次元項目の基礎をなす値を持つ項目を識別します。次元項目が次元を表す場合，BaseName はその次元に対応する項目の名前です。それ以外の場合には，BaseName は次元項目により集計される値を持つ項目の名前です。

注意

Basename は，完全修飾の SQL 選択子です。テーブル名と項目名は，引用符も含めて正しい区切り文字を使って指定しなければなりません。


TDimensionItem.DerivedFrom
TDimensionItem.DerivedFrom3159006

TDimensionItem	参照

DerivedFrom プロパティは，派生値を計算する次元項目のインデックスです。

property DerivedFrom: integer;

説明

DerivedFrom プロパティは，次元項目がそのデシジョンキューブのデータセットの項目を表すかどうかを示します。平均を表す次元項目はデータセットから直接派生せず，データセット内に表示されるカウント項目と集計項目から取得されます。派生した平均次元項目が作成されると，DerivedFrom はカウントまたは集計次元項目のインデックスに設定されます。対応する集計またはカウント次元項目は，派生値の計算時に BaseName プロパティを照合することにより特定されます。


TDimensionItem.DimensionType
TDimensionItem.DimensionType3159007

TDimensionItem	参照

DimensionType プロパティは，次元項目の使い方を示します。

TDimFlags = ( dimDimension, dimSum, dimCount, dimAverage, dimMin, dimMax,

   dimGenericAgg, dimUnknown);

property DimensionType: TDimFlags;

説明

DimensionType プロパティは，次元項目がクロス集計データ記憶の管理する多次元配列の次元を表すかどうか，または多次元配列のセルに値を供給する集計項目を表すかどうかを示します。次元項目が集計を表すときは，DimensionType は同時に集計の種類も示します。

次元項目が問い合わせの項目を表す場合，DimensionType を設定しないでください。次元項目を使うクロス集計データ記憶が問い合わせに結合されている場合，DimensionType の値は自動的に問い合わせの意味を反映するように設定されます。そのデータ記憶が別の種類のデータセットに結合されている場合は，DimensionType を多次元配列で次元項目の使い方を示す値に設定します。

以下に DimensionType の値を示します。

値	意味

dimDimension	次元項目は多次元配列の次元を表す

dimSum	次元項目は 1 つの項目値の合計を表す集計である

dimCount	次元項目は非空白の項目値のカウントを表す集計である

dimAverage	次元項目は平均項目値を表す集計である

dimMin	次元項目は最小項目値を表す集計である（現在実装されていない）

dimMax	次元項目は最大項目値を表す集計である（現在実装されていない）

dimGenericAgg	次元項目はほかの種類の集計である


TDimensionItem.FieldName
TDimensionItem.FieldName3159008

TDimensionItem	参照

FieldName プロパティは，次元項目が表す項目名です。

property FieldName: string;

説明

FieldName プロパティは，次元項目が基づく項目名を示します。FieldName は，次元が表す TField オブジェクトの FieldName プロパティと同じです。

FieldName プロパティは設定しないでください。その値は，次元項目の値を供給するデータセットの項目を示すように自動設定されます。次元を表示するデシジョンコントロールが使う名前を変更するには，Name プロパティを使います。


TDimensionItem.FieldType
TDimensionItem.FieldType3159009

TDimensionItem	参照

FieldType プロパティは，次元項目が表す項目のデータ型です。

TFieldType = (ftUnknown, ftString, ftSmallint, ftInteger, ftWord, ftBoolean, ftFloat, ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftBytes, ftVarBytes, ftAutoInc, ftBlob, ftMemo, ftGraphic, ftFmtMemo, ftParadoxOle, ftDBaseOle, ftTypedBinary, ftCursor);

property FieldType: TFieldType;

説明

FieldType プロパティは，次元項目の値を構成するデータの型を示します。FieldType は，クロス集計データ記憶のデータセットの対応する TField オブジェクトの DataType プロパティと同じです。

FieldType プロパティは設定しないでください。FieldType の値は，次元項目が提供するデータの型を反映するように自動設定されます。


TDimensionItem.Format
TDimensionItem.Format3159010

TDimensionItem	参照

Format プロパティは，数値データまたは履歴データを表す次元に基づいて項目値を形式設定する方法を示します。

property Format: String;

説明

Format プロパティは，数値項目または履歴項目を表す次元項目に基づいて設定します。Format 文字列を構成する形式指定子は，項目の種類に依存します。

数値項目の形式指定子の詳細については，ランタイムライブラリ関数 FormatFloat を参照してください。履歴項目の形式指定子の詳細については，ランタイムライブラリ関数 FormatDateTime を参照してください。

値名を表示するデシジョンコントロールは Format の値を読み出します。ただし，項目値の形式設定時には Format の値をオーバーライドできます。


TDimensionItem.Name
TDimensionItem.Name3159011

TDimensionItem	参照

Name プロパティは，次元または集計の名前を表すために使う文字列です。

property Name: String;

説明

Name プロパティは，クロス集計データ記憶の GetDimensionName メソッドまたは GetSummaryName メソッドが提供する名前を変更できます。次元名を表示するデシジョンコントロールは Name の値を読み出しますが，そのオーバーライドもできます。


TDimensionItem のメソッド3159012

TDimensionItem	アルファベット順

TDimensionItem

IsDimension

IsSummary

TCollectionItem からの継承

Create

Destroy

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDimensionItem のメソッド3159013

TDimensionItem	オブジェクト順

Assign

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

IsDimension

IsSummary

MethodAddress

MethodName

NewInstance

SafeCallException


TDimensionItem.IsDimension
TDimensionItem.IsDimension3159014

TDimensionItem	参照

IsDimension メソッドは，次元項目が次元を表すかどうかを示します。

function IsDimension: Boolean;

説明

IsDimension メソッドを呼び出すと，次元項目の使い方を指定できます。次元項目がクロス集計データ記憶の管理する多次元配列の次元の 1 つを表す場合，IsDimension は True を返します。次元項目が多次元配列のセルに入る集計値を提供する項目を表す場合には，IsDimension は False を返します。


TDimensionItem.IsSummary
TDimensionItem.IsSummary3159015

TDimensionItem	参照

IsSummary メソッドは，次元項目が集計を表すかどうかを示します。

function IsSummary: Boolean;

説明

IsSummary メソッドを呼び出すと，次元項目の使い方を指定できます。次元項目がクロス集計データ記憶の管理する多次元配列のセルに入る集計値を提供する項目を表す場合，IsSummary は True を返します。次元項目が多次元配列の次元の 1 つを表す場合には，IsSummary は False を返します。


スコープ3159016

published

アクセス種別

読み出し専用


継承3159017

TObject

TPersistent

TCollectionItem


TDimensionItem の例3159018

TDimensionItem


TDimensionItems

Hierarchy	Properties	Methods	See also

Unit

mxcommon

Description

TDimensionItems is the base class for objects that represent dimension maps.

Use TDimensionItems as a base class when defining classes that represent the dimension map of a crosstabulated data store. TDimensionItems represents a collection of TDimensionItem objects, where each TDimensionItem corresponds to a field from the data set of the crosstabulated data store.

TDimensionItems has a single descendant, TCubeDims, that adds additional functionality to handle dimension maps that include date ranges.


TDimensionItems properties

TDimensionItems	Alphabetically	Legend

In TDimensionItems

ActiveDimensionCount

ActiveSummaryCount

DimensionCount

Items

SummaryCount

Derived from TCollection

Count

ItemClass


TDimensionItems properties

TDimensionItems	By object	Legend

ActiveDimensionCount

ActiveSummaryCount

Count

DimensionCount

ItemClass

Items

SummaryCount


TDimensionItems.ActiveDimensionCount

TDimensionItems	See also

ActiveDimensionCount is the number of dimension items in the collection that represent active dimensions in the crosstabulated data store.

property ActiveDimensionCount: Integer;

Description

Read ActiveDimensionCount to determine the number of dimensions in the multidimensional data array cached by the data store. The memory requirements of the cached array go up exponentially with each active dimension, so ActiveDimensionCount provides a rough sense of the size of the cached array.

ActiveDimensionCount is the number of dimension items in the Items array that have their DimensionType property set to dimDimension and their Active property set to True. Change ActiveDimensionCount indirectly by changing the Active property on dimension items with DimensionType values of dimDimension.

The DimensionCount property indicates the total number of dimension items with DimensionType set to dimDimension. It provides an upper limit to the ActiveDimensionCount property.


TDimensionItems.ActiveSummaryCount

TDimensionItems	See also

ActiveSummaryCount is the number of dimension items in the collection that represent active summaries in the crosstabulated data store.

property ActiveSummaryCount: Integer;

Description

Read ActiveSummaryCount to determine the number of summaries in the cells of the multidimensional data array cached by the data store. The memory requirements of the cached array go up linearly with each active summary. ActiveSummaryCount is the number of different summaries that can be made available to decision controls.

ActiveSummaryCount is the number of dimension items in the Items array that don�t have their DimensionType property set to dimDimension and do have their Active property set to True. Change ActiveSummaryCount indirectly by changing the Active property on dimension items with DimensionType values other than dimDimension.

The SummaryCount property indicates the total number of dimension items that do not have DimensionType set to dimDimension. It provides an upper limit to the ActiveSummaryCount property.


TDimensionItems.DimensionCount

TDimensionItems	See also

DimensionCount is the number of dimension items in the Items array with DimensionType set to dimDimension.

property DimensionCount: Integer;

Description

Read DimensionCount to determine the number of potential dimensions for the multidimensional data array cached by the data store. DimensionCount reflects the number of unsummarized fields in the data set of the crosstabulated data store. While the data store can make any of these dimensions available, usually only a subset are active at any time, in order to limit memory consumption. The ActiveDimensionCount property gives the number of dimensions that are currently active.


TDimensionItems.Items

TDimensionItems	See also

Items is an indexed array of all dimension items maintained by the TDimensionItems object.

property Items[Index: Integer]:TDimensionItem; default;

Description

Use Items to access individual dimension items maintained by the TDimensionItems object. The first dimension item has an Index of 0, the second dimension item has an Index of 1, and so on.

Each dimension item in the Items array represents a field from the data set of a crosstabulated data store. Each dimension item represents either a dimension (a field over which data is summarized), or a summary (a value summarized over the dimensions).

Items is the default property of TDimensionItems. This means that the name of the Items property can be eliminated from code that uses the Items property. Thus, the line

DecisionCube1.DimensionMap.Items[0].Active := False;

could be written

DecisionCube1.DimensionMap[0].Active := False;

Note

Do not change the Items property. The set of items in the Items array is set automatically to represent the fields from the data set. The properties of individual dimension items within the Items array may be changed to specify whether the dimension items should be cached by the data store, to change the name used when displaying the dimension items, and so on.


TDimensionItems.SummaryCount

TDimensionItems	See also

SummaryCount is the number of dimension items in the Items array with DimensionType set to a value other than dimDimension.

property SummaryCount: Integer;

Description

Read SummaryCount to determine the number of potential summaries that could be stored in the cells of the multidimensional data array cached by the data store. SummaryCount reflects the number of summarized fields in the data set of the crosstabulated data store. If memory is a serious concern, the data store can make any of these summaries inactive. The ActiveSummaryCount property gives the number of summaries that are currently active.


TDimensionItems methods

TDimensionItems	Alphabetically

In TDimensionItems

Add

AddDerivedField

AlreadyExists

Assign

AverageFieldCheck

Create

Derived from TCollection

BeginUpdate

Clear

Destroy

EndUpdate

FindItemID

Derived from TPersistent

GetNamePath

Derived from TObject

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDimensionItems methods

TDimensionItems	By object

AddDerivedField

Add

AlreadyExists

Assign

AverageFieldCheck

BeginUpdate

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

EndUpdate

FieldAddress

FindItemID

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDimensionItems.Add

TDimensionItems	See also

Add adds a dimension item to the end of the Items array.

function Add: TDimensionItem;

Description

Do not call the Add method to add dimension items to a TDimensionItems object. The dimension items are added automatically to reflect the fields in the data set of the associated crosstabulated data store.

Add adds a new dimension item to the collection and returns the new dimension item.


TDimensionItems.AddDerivedField

TDimensionItems	See also

AddDerivedField adds a derived average summary to the end of the Items array.

function AddDerivedField(Index: integer; dimType: tDimFlags):boolean;

Description

Summaries that represent average values are not taken directly from the source dataset of a decision cube, but are derived from count summaries and summation summaries. AddDerivedField creates a dimension item for an average summary. The Index parameter specifies the index of an existing dimension item whose BaseName property specifies the field over which averages should be computed. AddDerivedField checks for the summary dimension items needed to derive the average. If both an average and a summation are available for the base field, AddDerivedField creates the average summary dimension item. AddDerivedField returns True if the dimension item is successfully created, False otherwise.

Note

The dimType parameter is currently ignored. Descendants of AddDerivedField can override this method to derive other types of dimension items. In this case, dimType should specify the type of derived dimension item that should be created. When overriding AddDerivedField, call the inherited method if dimType is dimAverage.


TDimensionItems.AlreadyExists

TDimensionItems	See also

AlreadyExists indicates whether a dimension item with the specified properties already exists in the Items property array.

type TDimFlags = ( dimDimension, dimSum, dimCount, dimAverage, dimMin, dimMax, dimGenericAgg);

function AlreadyExists(BaseName: string; sType: TDimFlags): boolean;

Description

Call AlreadyExists to determine whether there is a dimension item in the Items property array with the BaseName property equal to the BaseName parameter and the DimensionType property equal to the sType parameter.


TDimensionItems.Assign

TDimensionItems	See also

Assign copies the list of dimension items from another TDimensionItems object.

procedure Assign(Source: TPersistent); override;

Description

Assign calls the inherited method to copy the properties of the Source parameter. The inherited method will copy properties from any object that implements an AssignTo method that can copy to a TDimensionItems object.


TDimensionItems.AverageFieldCheck

TDimensionItems	See also

AverageFieldCheck determines whether the necessary summary dimension items over a base dimension exist so that a dimension item of type dimAverage can be created.

function AverageFieldCheck(Index: integer; var SumIndex, CountIndex: integer): boolean;

Description

Call AverageFieldCheck to ensure that the necessary summary dimension items exist for creating an average summary. The Index parameter specifies an existing dimension item whose BaseName property specifies the field over which the average should be computed. The SumIndex and CountIndex parameters return the summation and count dimension items that can be used to compute average values.


TDimensionItems.Create

TDimensionItems	See also

Create creates an instance of TDimensionItems.

type TDimensionItemClass = class of TDimensionItem;

constructor Create(Owner: TPersistent; ItemClass: TDimensionItemClass);

Description

Applications should not need to call the constructor of TDimensionItems. TCustomDataStore objects create TDimensionItems objects to implement their DimensionMap property.


Accessibility

Read-only


Hierarchy

TObject

TPersistent

TCollection


TDimensionItems example

TDimensionItems


EDimensionMapError
EDimensionMapError3161001

継承	プロパティ	メソッド	参照

EDimensionMapError は，デシジョンキューブのデータセットが正しい形式を持っていない場合の例外クラスです。

ユニット

mxdb

説明

EDimensionMapError は，デシジョンキューブのデータセットが集計値を 1 つも持っていなかったり，集計値しか持っていなかったりした場合，または正しい分類を持っていない場合に生成されます。


EDimensionMapError のプロパティ3161002

EDimensionMapError	アルファベット順

Exception からの継承

HelpContext

Message


EDimensionMapError のプロパティ3161003

EDimensionMapError	オブジェクト順

HelpContext

Message


EDimensionMapError のメソッド3161004

EDimensionMapError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EDimensionMapError のメソッド3161005

EDimensionMapError	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3161006

TObject

Exception


EDimensionMapError の例3161007

EDimensionMapError


TDirectoryListBox
TDirectoryListBox3162001

継承	プロパティ	メソッド	イベント	参照

TDirectoryListBox は，カレントドライブのディレクトリ構造を参照するリストボックスコントロールです。

ユニット

filectrl

説明

TDirectoryListBox は TCustomListbox で導入されている汎用動作を実装します。TDirectoryListBox は TCustomListbox から継承したプロパティの多くをパブリッシュに設定し，ユーザーがディレクトリまたはドライブを変更するための新しい動作を導入しています。

他の専用のリストボックスについては，TCustomListBox の他の下位クラスまたは派生クラスを参照してください。


TDirectoryListBox プロパティ3162002

TDirectoryListBox	アルファベット順	凡例

TDirectoryListBox

CaseSensitive

Directory

DirLabel

Drive

FileList

PreserveCase

TCustomListBox からの継承

Canvas

Columns

IntegralHeight

ItemHeight

ItemIndex

Items

SelCount

Selected

TopIndex

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDirectoryListBox プロパティ3162003

TDirectoryListBox	オブジェクト順	凡例

Align

BoundsRect

Brush

Canvas

CaseSensitive

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

Directory

DirLabel

DragCursor

DragMode

Drive

Enabled

FileList

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

IntegralHeight

ItemHeight

ItemIndex

Items

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

PreserveCase

SelCount

Selected

ShowHint

Showing

TabOrder

TabStop

Tag

Top

TopIndex

VCLComObject

Visible

Width

WindowProc


TDirectoryListBox.CaseSensitive
TDirectoryListBox.CaseSensitive3162004

TDirectoryListBox	参照

CaseSensitive プロパティは，ディスクシステムが大文字と小文字を区別するディレクトリ情報をサポートするかどうかを判別します。

property CaseSensitive: Boolean;

説明

CaseSensitive プロパティは，現在のファイルシステムが大文字と小文字を区別するファイル名をサポートするかどうかがわかります。CaseSensitive はサポートしている場合は True を返し，そうでない場合は False を返します。


TDirectoryListBox.Directory
TDirectoryListBox.Directory3162005

TDirectoryListBox	参照

Directory プロパティは，ディレクトリリストボックスコントロールのカレントディレクトリを決めます。

property Directory: string;

説明

ディレクトリリストボックスは，リストボックスのカレントディレクトリとして Directory プロパティの値を表示します。次の例を見ると，ディレクトリリストボックスとファイルリストボックスがそれぞれの Directory プロパティを介してどのように関連するのかわかります。

例

次のコードでは，フォーム上のファイルリストボックスとディレクトリリストボックスがあるときに，ユーザーがディレクトリリストボックスを使ってディレクトリを変更すると，ディレクトリリストボックスのカレントディレクトリを変更し，ファイルリストボックスにそのディレクトリのファイルを表示します。

procedure TForm1.DirectoryListBox1Change(Sender: TObject);

begin

  FileListBox1.Directory := DirectoryListBox1.Directory;

end;

注意

フォームにファイルリストボックスがある場合は，Directory プロパティで指定したディレクトリのファイルが自動的にファイルリストボックスに表示されるように FileList プロパティを設定します。


TDirectoryListBox.DirLabel
TDirectoryListBox.DirLabel3162006

TDirectoryListBox	参照

DirLabel プロパティは，カレントディレクトリをラベルコントロールのキャプションとして簡単に表示できます。

property DirLabel: TLabel;

説明

DirLabel プロパティは，カレントディレクトリとともに更新されるラベルを指定できます。ディレクトリリストボックスでカレントディレクトリが変更されると，ラベルキャプションもそれに応じて変更されます。


TDirectoryListBox.Drive
TDirectoryListBox.Drive3162007

TDirectoryListBox	参照

Drive プロパティは，リストボックスがディレクトリ構造を表示するドライブを決めます。

property Drive: Char;

説明

Drive の値が変更されると，Directory 値も指定されたドライブのカレントディレクトリに変更されます。

例

次の例では，ドライブコンボボックス，ファイルリストボックス，およびディレクトリリストボックスがフォーム上にあると想定しています。ユーザーがドライブコンボボックスでドライブを選択すると，このコードはドライブコンボボックスに表示されているドライブを変更し，ディレクトリリストボックスに選択されたドライブのカレントディレクトリを表示し，そしてファイルリストボックスに選択されたドライブのカレントディレクトリにあるファイルを表示します。

procedure TForm1.DriveComboBox1Change(Sender: TObject);

begin

  DirectoryListBox1.Drive := DriveComboBox1.Drive;

  FileListBox1.Directory := DirectoryListBox1.Directory;

end;


TDirectoryListBox.FileList
TDirectoryListBox.FileList3162008

TDirectoryListBox	参照

FileList プロパティは，ディレクトリリストボックスとファイルリストボックスを簡単に接続できます。

property FileList: TFileListBox;

説明

FileList プロパティは，カレントディレクトリのファイルを表示するファイルリストボックスを指定できます。

FileList には，ディレクトリのファイルを表示するファイルリストボックスを設定します。ディレクトリリストボックスの Directory プロパティを設定します。

例

次の例は，フォーム上のボタン，編集ボックス，ラベル，ドライブコンボボックス，ディレクトリリストボックス，ファイルリストボックス，およびフィルタコンボボックスを使います。ユーザーがボタンをクリックすると，［ファイルを開く］ダイアログボックスや［名前を付けて保存］ダイアログボックスのコントロールの場合と同じように，フォーム上の残りのコントロールが関連して機能を始めます。

procedure TForm1.Button1Click(Sender: TObject);

begin

  DriveComboBox1.DirList := DirectoryListBox1;

  DirectoryListBox1.FileList := FileListBox1;

  DirectoryListBox1.DirLabel := Label1;

  FileListBox1.FileEdit := Edit1;

  FilterComboBox1.FileList := FileListBox1;

end;


TDirectoryListBox.PreserveCase
TDirectoryListBox.PreserveCase3162009

TDirectoryListBox	参照

PreserveCase プロパティは，ファイルシステムがディスクに書き込むときにファイル名の大文字と小文字の区別を維持するかどうかを示します。

property PreserveCase: Boolean;

説明

PreserveCase プロパティは，現在のファイルシステムがファイル名の大文字と小文字の区別を維持するかどうかがわかります。PreserveCase は維持される場合に True を返し，維持されない場合に False を返します。


TDirectoryListBox イベント3162010

TDirectoryListBox	アルファベット順	凡例

TDirectoryListBox

OnChange

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDirectoryListBox イベント3162011

TDirectoryListBox	オブジェクト順	凡例

OnChange

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDirectoryListBox.OnChange
TDirectoryListBox.OnChange3162012

TDirectoryListBox

OnChange イベントは，ユーザーがマウスかキーボードを使って新しいディレクトリを選択するか，またはユーザーが選択バーを移動して〔Enter〕キーを押したときに発生します。

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラを記述すると，新しいディレクトリが選択されたときにアクションを処理するイベントハンドラを記述できます。


TDirectoryListBox メソッド3162013

TDirectoryListBox	アルファベット順

TDirectoryListBox

Create

Destroy

DisplayCase

FileCompareText

GetItemPath

OpenCurrent

Update

TCustomListBox からの継承

Clear

ItemAtPos

ItemRect

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDirectoryListBox メソッド3162014

TDirectoryListBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DisplayCase

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FileCompareText

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetItemPath

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

ItemAtPos

ItemRect

MethodAddress

MethodName

NewInstance

OpenCurrent

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDirectoryListBox.Create
TDirectoryListBox.Create3162015

TDirectoryListBox	参照

Create メソッドは，ディレクトリリストボックスをインスタンス化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にディレクトリリストボックスをインスタンス化できます。設計時に作成されたディレクトリリストボックスの場合，Create は自動的に呼び出されます。

Create はディレクトリリストボックスにメモリを割り当て，継承 Create メソッドを呼び出します。次に以下のプロパティを設定します。

・	Width を 145 に設定する。

・	Style を lbOwnerDrawFixed に設定する。

・	Sorted を False に設定する。

続いて，開いたフォルダ，閉じたフォルダ，およびカレントフォルダのビットマップを作成およびロードし，ディレクトリをデフォルトドライブのカレントディレクトリに初期化します。


TDirectoryListBox.Destroy
TDirectoryListBox.Destroy3162016

TDirectoryListBox	参照

Destroy メソッドは，ディレクトリリストボックスのインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドはリストボックスオブジェクトが解放されていないことを確認してから Destroy メソッドを呼び出します。

Destroy は開いたフォルダ，閉じたフォルダ，およびカレントフォルダに使われているビットマップを解放し，継承 Destroy メソッドを呼び出します。


TDirectoryListBox.DisplayCase
TDirectoryListBox.DisplayCase3162017

TDirectoryListBox	参照

DisplayCase メソッドは，渡された文字列の大文字と小文字を維持するか，または変換します。

function  DisplayCase(const S: String): String;

説明

DisplayCase メソッドは，PreserveCase と CaseSensitive が両方とも True ではない場合に，インストールされている言語ドライバを使って S を小文字に変換します。それ以外の場合は単純に S をそのまま返します。


TDirectoryListBox.FileCompareText
TDirectoryListBox.FileCompareText3162018

TDirectoryListBox	参照

FileCompareText メソッドは，2 つの文字列をファイルシステムの大文字と小文字の区別を考慮して比較します。

function  FileCompareText(const A, B: String): Integer;

説明

FileCompareText は，CaseSensitive が False の場合に，A および B に渡された文字列を比較します。それ以外の場合は，AnsiCompareStr を使って文字列を比較します。


TDirectoryListBox.GetItemPath
TDirectoryListBox.GetItemPath3162019

TDirectoryListBox	参照

GetItemPath メソッドは，ディレクトリリストボックスのディレクトリのパスを返します。

function GetItemPath(Index : Integer): string;

説明

GetItemPath メソッドを呼び出すと，Index 値で指定したディレクトリのパスを取得できます。リストの最初のディレクトリのインデックス値は 0 です。

例

次の例は，フォーム上のディレクトリリストボックス，ボタン，およびラベルを使います。ユーザーがディレクトリリストボックスでディレクトリを選択してボタンをクリックすると，選択されたディレクトリが開いて，リストボックスの 2 番目のディレクトリのパスがラベルのキャプションとして表示されます。

procedure TForm1.Button1Click(Sender: TObject);

begin

  DirectoryListBox1.OpenCurrent;

  Label1.Caption := DirectoryListBox1.GetItemPath(1);

end;


TDirectoryListBox.OpenCurrent
TDirectoryListBox.OpenCurrent3162020

TDirectoryListBox

OpenCurrent メソッドは，選択されたディレクトリを開きます。

procedure OpenCurrent;

説明

OpenCurrent はディレクトリリストボックスで選択されたディレクトリを，ユーザーがそのディレクトリをダブルクリックしたかのように開きます。

例

次の例は，フォーム上のディレクトリリストボックス，ボタン，ラベルを使います。ユーザーがディレクトリリストボックスでディレクトリを選択してボタンをクリックすると，選択されたディレクトリが開いて，リストボックスの 2 番目のディレクトリのパスがラベルのキャプションとして表示されます。

procedure TForm1.Button1Click(Sender: TObject);

begin

  DirectoryListBox1.OpenCurrent;

  Label1.Caption := DirectoryListBox1.GetItemPath(1);

end;


TDirectoryListBox.Update
TDirectoryListBox.Update3162021

TDirectoryListBox

Update メソッドは，ディレクトリリストを更新します。

procedure Update;

説明

Update はディレクトリリストボックスコントロールのディレクトリリストを更新して現在の設定を反映します。

例

次のサンプルコードは，フォームが作成されたときに DirectoryListBox1 のディレクトリを C:\TEMP に設定します。Button1 が押されると，MYDIR というサブディレクトリが C:\TEMP に追加されますが，Button2 が押されて Update が呼び出されるまで DirectoryListBox1 では MYDIR は更新されません。

procedure TForm1.Button1Click(Sender: TObject);

begin

  MkDir('c:\temp\mydir');

end;

procedure TForm1.FormCreate(Sender: TObject);

begin

  DirectoryListBox1.Directory := 'c:\temp';

end;

procedure TForm1.Button2Click(Sender: TObject);

begin

  DirectoryListBox1.Update;

end;


スコープ3162022

published

読み出し／書き込み

読み出し専用


スコープ3162023

published


継承3162024

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomListBox


TDirectoryListBox 例3162025

TDirectoryListBox


TWebDispatcher
TWebDispatcher3163001

継承	プロパティ	メソッド	イベント

TWebDispatcher オブジェクトは，応答を処理する適切なアクション項目に HTTP 要求メッセージを渡します。

ユニット

httpapp

説明

TWebDispatcher を使うと，通常のデータモジュールを Web モジュールに変換できます。他の非ビジュアルコンポーネントや Web アプリケーションのビジネスルールを含んでいる既存のデータモジュールに，TWebDispatcher オブジェクトを追加します。次に，自動生成された Web アプリケーションを Web モジュールから削除して，現在 Web ディスパッチャを持つデータモジュールに置き換えます。

TWebDispathcher は，Web サーバーアプリケーションが HTTP 要求メッセージに応答できるようにします。アプリケーションに追加できる Web ディスパッチャは 1 つだけです。そのため，TWebDispathcher を持つデータモジュールを追加する前に，自動生成された Web モジュール（これは Web ディスパッチャの型の 1 つです）を Web アプリケーションから削除しなければなりません。

TWebDispatcher オブジェクトは，HTTP 要求メッセージへの応答方法を格納しているアクション項目のコレクションを保守します。ディスパッチャに保守されるアクション項目の表示，追加，および削除を行うには，アクションエディタを使います。アクションエディタを開くには，TWebDispatcher アイコンをダブルクリックします。

TWebDispatcher は TCustomWebDispatcher で導入されるプロパティやイベントをいくつかパブリッシュしますが，自身の新しいプロパティ，イベント，メソッドは提供しません。


TWebDispatcher プロパティ3163002

TWebDispatcher	アルファベット順	凡例

TCustomWebDispatcher からの継承

Action

Actions

Request

Response

TDataModule からの継承

DesignOffset

DesignSize

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TWebDispatcher プロパティ3163003

TWebDispatcher	オブジェクト順	凡例

Action

Actions

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

DesignOffset

DesignSize

Name

Owner

Request

Response

Tag

VCLComObject


TWebDispatcher イベント3163004

TWebDispatcher	アルファベット順	凡例

TCustomWebDispatcher からの継承

AfterDispatch

BeforeDispatch

TDataModule からの継承

OnCreate

OnDestroy


TWebDispatcher イベント3163005

TWebDispatcher	オブジェクト順	凡例

AfterDispatch

BeforeDispatch

OnCreate

OnDestroy


TWebDispatcher メソッド3163006

TWebDispatcher	アルファベット順

TCustomWebDispatcher からの継承

ActionByName

Create

Destroy

TDataModule からの継承

CreateNew

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TWebDispatcher メソッド3163007

TWebDispatcher	オブジェクト順

ActionByName

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateNew

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


スコープ3163008

published

読み出し／書き込み

読み出し専用


スコープ3163009

published


継承3163010

TObject

TPersistent

TComponent

TDataModule

TCustomWebDispatcher


TWebDispatcher 例3163011

TWebDispatcher


TDisplayDim
TDisplayDim3164001

継承	プロパティ	メソッド	参照

TDisplayDim はデシジョングリッドに次元を表示します。

ユニット

mxgrid

説明

TDisplayDim を使うと，デシジョングリッドの次元のプロパティを設定できます。デシジョングリッドは，その左上角で実行される次元ラベルを示す TDisplayDim オブジェクトの集合を保持します。TDisplayDim のプロパティを使うと，1 つの次元のラベルを際立たせたり，次元のサブトータルをオンまたはオフにしたりできます。


TDisplayDim のプロパティ3164002

TDisplayDim	アルファベット順	凡例

TDisplayDim

Alignment

Color

DisplayName

FieldName

Format

Subtotals

TCollectionItem からの継承

Collection

ID

Index


TDisplayDim のプロパティ3164003

TDisplayDim	オブジェクト順	凡例

Alignment

Collection

Color

DisplayName

FieldName

Format

ID

Index

Subtotals


TDisplayDim.Alignment
TDisplayDim.Alignment3164004

TDisplayDim

Alignment プロパティは，ラベルセル内の値の配置を指定します。

TAlignment = (taLeftJustify, taRightJustify, taCenter);

property Alignment: TAlignment;

説明

Alignment プロパティを設定すると，ラベルセル内で次元項目の値をどのように配置するかを指定できます。Alignment には以下の値を指定できます。

値	意味

taLeftJustify	値はラベルセルの左端に配置される

taRightJustify	値はラベルセルの右端に配置される

taCenter	値はラベルセルの中央に配置される

参照

TDecisionSource.GetMemberAsString メソッド


TDisplayDim.Color
TDisplayDim.Color3164005

TDisplayDim	参照

Color プロパティは，次元用のラベルセルの背景色を指定します。

property Color: TColor;

説明

Color プロパティを設定すると，1 つの次元に沿ってラベルのデシジョングリッドの LabelColor プロパティをオーバーライドできます。この次元に沿って項目の値を表示するセルでは背景色に Color を使います。


TDisplayDim.DisplayName
TDisplayDim.DisplayName3164006

TDisplayDim	参照

DisplayName プロパティは，キャプションセル内の次元を示すときに使う名前です。

property DisplayName: string;

説明

DisplayName プロパティには，この次元の名前を表示するキャプションセルに現れる名前を指定します。DisplayName は，その GetDimensionName メソッド内のデシジョンソースで返される次元の名前をオーバーライドします。


TDisplayDim.FieldName
TDisplayDim.FieldName3164007

TDisplayDim	参照

FieldName プロパティは，次元で表示される基本データセット内の項目名です。

property FieldName: string;

説明

FieldName プロパティは，次元の基礎となる項目の名前を指定します。FieldName は，データセット内の項目用の TField オブジェクトの FieldName プロパティと同じです。

注意

FieldName プロパティを変更してはいけません。FieldName プロパティを変更すると，データセット内の基本項目へのリンクが失われます。


TDisplayDim.Format
TDisplayDim.Format3164008

TDisplayDim	参照

Format プロパティは，次元に沿って値のラベルを作成するときに使う形式文字列です。

property Format:String;

説明

Format プロパティを設定すると，次元項目の値をどのような形式で表示ラベルに適用するかを指定できます。Format 文字列を形成する形式指定子は項目の型に依存します。

数値項目における形式指定子の説明は FormatFloat ルーチンライブラリ関数を参照してください。日付時刻項目における形式指定子の説明は FormatDateTimeルーチンライブラリ関数を参照してください。Format はその他の項目型には影響しません。


TDisplayDim.Subtotals
TDisplayDim.SubTotals3164009

TDisplayDim	参照

SubTotals プロパティは，グリッドが次元にサブトータルを表示するかどうかを示します。

property Subtotals: Boolean;

説明

SubTotals プロパティを True に設定すると，次元の最後の値の次にサブトータルの行または列を付加できます。サブトータルの行または列には，次元のすべての値がまとめられた集計項目の値が格納されます。SubTotals を False に設定すると，次元の最後尾のサブトータルの行または列が除外されます。

グリッド内のすべての次元に関するサブトータルのオン／オフを 1 度で切り替えるには，デシジョングリッドの Totals プロパティを使います。


TDisplayDim のメソッド3164010

TDisplayDim	アルファベット順

TCollectionItem からの継承

Create

Destroy

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDisplayDim のメソッド3164011

TDisplayDim	オブジェクト順

Assign

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


スコープ3164012

published

アクセス種別

読み出し専用


継承3164013

TObject

TPersistent

TCollectionItem


TDisplayDim の例3164014

TDisplayDim


TDisplayDims
TDisplayDims3165001

継承	プロパティ	メソッド	参照

TDisplayDims は TDisplayDim オブジェクトのコレクションです。

ユニット

mxgrid

説明

TDisplayDims を使うとデシジョングリッドの次元を説明できます。TDisplayDims が保守する各 TDisplayDim オブジェクトは，デシジョンソースの 1 つの項目に対応します。デシジョングリッドは TDisplayDims を使って，グリッドの左上角に表示される次元ラベルの外観を指定します。


TDisplayDims のプロパティ3165002

TDisplayDims	アルファベット順	凡例

TDisplayDims

Items

TCollection からの継承

Count

ItemClass


TDisplayDims のプロパティ3165003

TDisplayDims	オブジェクト順	凡例

Count

ItemClass

Items


TDisplayDims.Items
TDisplayDims.Items3165004

TDisplayDims	参照

Items プロパティは，コレクションに入っている TDisplayDim オブジェクトのインデックス付き配列です。

property Items[Index: Integer]:TDisplayDim; default;

説明

Items プロパティは，TDisplayDims が保守する TDisplayDim オブジェクトのプロパティにアクセスできます。Items は TDisplayDims のデフォルトプロパティなので，このプロパティを使うときに Items プロパティの名前を指定しなくてもかまいません。したがって次の行の記述

MyDim := DecisionGrid1.Dimensions.Items[0];

を次のように記述できます。

MyDim := DecisionGrid1.Dimensions[0];

Items 配列の TDisplayDim オブジェクトは，TDisplayDims オブジェクトに関連付けられたデシジョンコントロールが使うデシジョンソースの次元に正確に一致します。Items 配列の要素は直接変更しないでください。表示次元を再配列するには，デシジョンソースの SwapDimIndexes メソッドを使います。表示次元を非表示にするには，デシジョンソースの CloseDimIndexRight メソッドを使います。非表示次元を表示するには，デシジョンソースの OpenDimIndexLeft メソッドまたは OpenDimIndexRight メソッドを使います。


TDisplayDims のメソッド3165005

TDisplayDims	アルファベット順

TCollection からの継承

Add

Assign

BeginUpdate

Clear

Create

Destroy

EndUpdate

FindItemID

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDisplayDims のメソッド3165006

TDisplayDims	オブジェクト順

Add

Assign

BeginUpdate

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

EndUpdate

FieldAddress

FindItemID

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


アクセス種別3165007

読み出し専用


継承3165008

TObject

TPersistent

TCollection


TDisplayDims の例3165009

TDisplayDims


TDragObject
TDragObject3166001

継承	メソッド	参照

TDragObject は Delphi のドラッグアンドドロップ動作に使う基本クラスです。

ユニット

controls

説明

TDragObject からオブジェクトを派生させ，必要に応じて仮想メソッドをオーバーライドすることで，オブジェクトデータのドラッグアンドドロップを実現できます。OnStartDrag イベントではカスタムドラッグオブジェクトを作成します。また，ドラッグアンドドロップを受け付けるときは，ターゲットの OnDragOver イベント内で Public な IsDragObject 関数を使います。

TDragObject を使うと，より柔軟なドラッグアンドドロップ処理を実現できます。通常は，OnDragOver および OnDragDrop イベントの Source パラメータがドラッグ動作を開始するコントロールを表します。異なる種類の複数のコントロールが同じ種類のデータ（ファイル名，テキスト，金額など）のドラッグを開始する必要がある場合には，ソースは各種のコントロールをサポートしていなければなりません。各ソースコントロールは OnStartDrag イベントで同じ種類のドラッグオブジェクトを作成できるので，ドラッグオブジェクトを使えばターゲットにはドラッグオブジェクトをソースとして処理する手段だけが備わっていればよいことになります。OnDragOver および OnDragDrop イベントはコントロールと違って，IsDragObject を呼び出すことでソースがドラッグオブジェクトであるかどうかを判断できます。

ドラッグオブジェクトは複数の .DLL 間やメインの .EXE 内でドラッグできます。これは，パッケージを使用していないときに，.EXE で実装したフォームから .DLL で実装したフォームにドラッグ操作を行いたい場合に便利です。


TDragObject メソッド3166002

TDragObject	アルファベット順	凡例

TDragObject

Finished

GetDragCursor

GetDragImages

GetName

HideDragImage

Instance

ShowDragImage

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDragObject メソッド3166003

TDragObject	オブジェクト順	凡例

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Finished

Free

FreeInstance

GetDragCursor

GetDragImages

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetName

HideDragImage

InheritsFrom

InitInstance

Instance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

ShowDragImage


TDragObject.Finished
TDragObject.Finished3166004

TDragObject	参照

Finished メソッドは，マウスボタンを放したときに呼び出され，ドラッグ動作が完了したことを示します。

procedure Finished(Target: TObject; X, Y: Integer; Accepted: Boolean); virtual;

説明

Finished はデフォルトでは何も処理を行いませんが，オーバーライドして一定の動作を提供することができます。Target はドラッグを受け付けるオブジェクトです。Target には nil を指定することもできます。Accepted は，Target がドラッグアンドドロップを受け付けると True を返します。Finished は TDragControlObject でオーバーライドおよび実装されます。


TDragObject.GetDragCursor
TDragObject.GetDragCursor3166005

TDragObject	参照

GetDragCursor メソッドは，マウスを移動したときに呼び出され，現在どのカーソルを表示すればよいかを示します。

function GetDragCursor(Accepted: Boolean; X, Y: Integer): TCursor; virtual;

説明

（X, Y）の位置（ピクセル単位）にあるターゲットコントロールがドラッグを受け付けた（Accepted が True の）場合，ドラッグオブジェクトはドラッグカーソルを csDrag カーソルに設定します。それ以外の場合には，デフォルトで crNoDrop カーソルが表示されます。


TDragObject.GetDragImages
TDragObject.GetDragImages3166006

TDragObject	参照

GetDragImages メソッドは，ドラッグアンドドロップ動作の開始時に呼び出され，ドラッグ中に表示されるイメージを持つコントロールのイメージリストを返します。

function GetDragImages: TCustomImageList; virtual;

説明

通常，イメージリストには 1 つのイメージだけが含まれ，VCL が自動的にイメージリストを作成して管理します。また，イメージリストは nil としても指定でき，その場合にはカーソルだけを使用できます。


TDragObject.GetName
TDragObject.GetName3166007

TDragObject	参照

GetName メソッドは，ドラッグ動作を識別する名前の文字列を返します。

function GetName: string; virtual

説明

デフォルトでは GetName はクラスの名前を返しますが，任意の文字列を返すようにオーバーライドできます。


TDragObject.HideDragImage
TDragObject.HideDragImage3166008

TDragObject	参照

HideDragImage メソッドは，TDragObject では実装されない仮想メソッドです。

procedure HideDragImage; virtual;

説明

HideDragImage は仮想メソッドなので，TDragObject から派生したクラスでオーバーライドできます。HideDragImage は，派生クラスの TDragControlObject でオーバーライドされます。


TDragObject.Instance
TDragObject.Instance3166009

TDragObject	参照

Instance メソッドは，ドラッグオブジェクトを作成した EXE または DLL のインスタンス（モジュール）ハンドルを返します。

function Instance: THandle; virtual;


TDragObject.ShowDragImage
TDragObject.ShowDragImage3166010

TDragObject	参照

ShowDragImage メソッドは，TDragObject での実装では機能を持たない仮想メソッドです。

procedure ShowDragImage; virtual;

説明

ShowDragImage は仮想メソッドなので，TDragObject から派生したクラスでオーバーライドできます。ShowDragImage は，派生クラスの TDragControlObject でオーバーライドされます。


スコープ3166011

protected


継承3166012

TObject


TDragObject 例3166013

TDragObject


TDrawGrid
TDrawGrid3167001

継承	プロパティ	メソッド	イベント	参照

TDrawGrid は既存のデータ構造を列と行の形式で情報を表示するグリッドコントロールです。

ユニット

grids

説明

TDrawGrid オブジェクトをフォームに追加すると，任意の情報を表形式で表示できます。TDrawGrid は，グリッドの体裁を制御する多くのプロパティや，ユーザーアクションに応答してグリッドの表構造を活用するイベントおよびメソッドを提供します。

TDrawGrid は，アプリケーションがグリッドの体裁や動作をカスタマイズできるようにするイベントおよびメソッドをいくつか導入します。

グリッドのセルに，オブジェクトを表すテキスト文字列が入っている場合は，TDrawGrid のかわりに TStringGrid オブジェクトを使います。グリッドでデータセット内のレコードの項目値を表示する場合は，TDrawGrid のかわりに TDBGrid を使います。


TDrawGrid プロパティ3167002

TDrawGrid	アルファベット順	凡例

TCustomGrid からの継承

BorderStyle

Col

ColCount

ColWidths

DefaultColWidth

DefaultDrawing

DefaultRowHeight

EditorMode

FixedColor

FixedCols

FixedRows

GridHeight

GridLineWidth

GridWidth

LeftCol

Options

Row

RowCount

RowHeights

ScrollBars

Selection

TabStops

TopRow

VisibleColCount

VisibleRowCount

TCustomControl からの継承

Canvas

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDrawGrid プロパティ3167003

TDrawGrid	オブジェクト順	凡例

Align

BorderStyle

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Col

ColCount

Color

ColWidths

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DefaultColWidth

DefaultDrawing

DefaultRowHeight

DesignInfo

DragCursor

DragMode

EditorMode

Enabled

FixedColor

FixedCols

FixedRows

Font

GridHeight

GridLineWidth

GridWidth

Handle

Height

HelpContext

Hint

Left

LeftCol

Name

Options

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

Row

RowCount

RowHeights

ScrollBars

Selection

ShowHint

Showing

TabOrder

TabStop

TabStops

Tag

Top

TopRow

VCLComObject

Visible

VisibleColCount

VisibleRowCount

Width

WindowProc


TDrawGrid イベント3167004

TDrawGrid	アルファベット順	凡例

TDrawGrid

OnColumnMoved

OnDrawCell

OnGetEditMask

OnGetEditText

OnRowMoved

OnSelectCell

OnSetEditText

OnTopLeftChanged

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TDrawGrid イベント3167005

TDrawGrid	オブジェクト順	凡例

OnClick

OnColumnMoved

OnDblClick

OnDragDrop

OnDragOver

OnDrawCell

OnEndDrag

OnEnter

OnExit

OnGetEditMask

OnGetEditText

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnRowMoved

OnSelectCell

OnSetEditText

OnStartDrag

OnTopLeftChanged


TDrawGrid.OnColumnMoved
TDrawGrid.OnColumnMoved3167006

TDrawGrid	参照

OnColumnMoved イベントは，列の位置が変更された直後に発生します。

TMovedEvent = procedure (Sender: TObject; FromIndex, ToIndex: Longint) of object;

property OnColumnMoved: TMovedEvent;

説明

OnColumnMoved イベントを記述すると，グリッド列の位置が変更されたときに特別な処理を実行できます。列は，プログラムで，またはユーザーの操作によって移動できます。FromIndex パラメータは列の以前のインデックスで，ToIndex パラメータは新しいインデックスです。OnColumnMoved イベントは，Options プロパティで goColMoving オプションが設定されていない限り発生しません。


TDrawGrid.OnDrawCell
TDrawGrid.OnDrawCell3167007

TDrawGrid	参照

OnDrawCell イベントは，グリッド内のセルを描画する必要があるときに発生します。

TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

TDrawCellEvent = procedure (Sender: TObject; Col, Row: Longint; Rect: TRect;

   State: TGridDrawState) of object;

property OnDrawCell: TDrawCellEvent;

説明

OnDrawCell イベントハンドラを記述すると，グリッド内のすべてのセルの内容を描画できます。Canvas プロパティのメソッドを使ってセルを描画します。Rect パラメータはキャンバス上でのセルの位置を示します。Col および Row パラメータは描画するセルの列および行インデックスを示します。State パラメータはセルに入力フォーカスがあるかどうか，セルが選択されているかどうか，セルが固定セル（スクロールしないセル）であるかどうかを示します。

OnDrawCell イベントハンドラが割り当てられていない場合，描画グリッド内のすべてのセルは空白で表示されます。DefaultDrawing プロパティが True ならば，描画グリッドは OnDrawCell イベントの前にセルの背景色をペイントし，OnDrawCell イベントハンドラがセルの内容の描画を完了した後で，選択されたセルの周りにフォーカス四角形を描画します。DefaultDrawing が False ならば，OnDrawCell イベントハンドラでセルの背景をペイントし，選択およびフォーカスについて視覚的に示します。


TDrawGrid.OnGetEditMask
TDrawGrid.OnGetEditMask3167008

TDrawGrid	参照

OnGetEditMask イベントは，インプレースエディタが編集マスクを要求したときに発生します。

TGetEditEvent = procedure (Sender: TObject; ACol, ARow: Longint; var Value: string) of object;

property OnGetEditMask: TGetEditEvent;

説明

OnGetEditMask イベントハンドラを記述すると，ユーザーがセルに入力できる有効な入力文字列を示す編集マスクをインプレースエディタに提供できます。Value パラメータを，ACol および ARow パラメータによって指定されるセル用の編集マスクを示す文字列に設定します。セルに編集マスクがない場合は，Value パラメータを空の文字列に設定します。

OnGetEditMask イベントは，Options プロパティで goEditing オプションが設定されていない限り発生しません。


TDrawGrid.OnGetEditText
TDrawGrid.OnGetEditText3167009

TDrawGrid	参照

OnGetEditText イベントは，インプレースエディタがセルの値を要求したときに発生します。

TGetEditEvent = procedure (Sender: TObject; ACol, ARow: Longint; var Value: string) of object;

property OnGetEditText: TGetEditEvent;

説明

OnGetEditText イベントハンドラを記述すると，セルの内容を表す文字列をインプレースエディタに提供できます。Value パラメータを，ACol および ARow パラメータによって指定されるセルの文字列に設定します。セルが編集モードになると，セルの内容は OnGetEditText イベントハンドラによって返される Value 文字列として描画されます。このイメージは，編集モードでないときのセルの体裁と一致する必要はなく，OnDrawCell イベントハンドラを使って描画されます。

OnGetEditText イベントは，Options プロパティで goEditing オプションが設定されていない限り発生しません。


TDrawGrid.OnRowMoved
TDrawGrid.OnRowMoved3167010

TDrawGrid	参照

OnRowMoved イベントは，行の位置が変更された直後に発生します。

TMovedEvent = procedure (Sender: TObject; FromIndex, ToIndex: Longint) of object;

property OnRowMoved: TMovedEvent;

説明

OnRowMoved イベントハンドラを記述すると，グリッド内の行の位置が変更されたときに特別な処理を実行できます。行は，プログラムで，またはユーザーの操作によって移動できます。FromIndex パラメータは行の以前のインデックスで，ToIndex パラメータは新しいインデックスです。OnRowMoved イベントは，Options プロパティで goRowMoving オプションが設定されていない限り発生しません。


TDrawGrid.OnSelectCell
TDrawGrid.OnSelectCell3167011

TDrawGrid	参照

OnSelectCell イベントは，グリッド内のセルが選択される前に発生します。

TSelectCellEvent = procedure (Sender: TObject; Col, Row: Longint; var CanSelect: Boolean)

   of object;

property OnSelectCell: TSelectCellEvent;

説明

OnSelectCell イベントハンドラを記述すると，グリッド内の特定のセルが選択できるかどうかを指定できます。Col および Row パラメータは，選択しようとするセルの列および行インデックスを示します。CanSelect パラメータを False に設定すると，セルを選択できなくすることができます。


TDrawGrid.OnSetEditText
TDrawGrid.OnSetEditText3167012

TDrawGrid	参照

OnSetEditText イベントは，ユーザーがセルの値の編集を完了したときに発生します。

TSetEditEvent = procedure (Sender: TObject; ACol, ARow: Longint; const Value: string)

   of object;

property OnSetEditText: TSetEditEvent;

説明

OnSetEditText イベントハンドラを記述すると，インプレースエディタでユーザーによって編集されるテキストについて特別な処理を実行できます。たとえば，OnDrawCell イベントハンドラで表示できるように，OnSetEditText イベントを使ってセルの値を取り出して保存することができます。Value パラメータは ACol および ARow パラメータによって指定されるセルの新しい値です。

OnSetEditText イベントは，Options プロパティで goEditing オプションが設定されていない限り発生しません。


TDrawGrid.OnTopLeftChanged
TDrawGrid.OnTopLeftChanged3167013

TDrawGrid	参照

OnTopLeftChanged イベントは，TopRow プロパティまたは LeftCol プロパティが変更された直後に発生します。

property OnTopLeftChanged: TNotifyEvent;

説明

OnTopLeftChanged イベントを記述すると，グリッド内の非固定セルがスクロールされたときに特別な処理を実行できます。


TDrawGrid メソッド3167014

TDrawGrid	アルファベット順	凡例

TDrawGrid

CellRect

ColumnMoved

DrawCell

GetEditMask

GetEditText

MouseToCell

RowMoved

SelectCell

SetEditText

TopLeftChanged

TCustomGrid からの継承

Create

Destroy

MouseCoord

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDrawGrid メソッド3167015

TDrawGrid	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

CellRect

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ColumnMoved

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

DrawCell

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetEditMask

GetEditText

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

MouseCoord

MouseToCell

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

RowMoved

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectCell

SendToBack

SetBounds

SetEditText

SetFocus

SetTextBuf

Show

TopLeftChanged

Update

UpdateControlState


TDrawGrid.CellRect
TDrawGrid.CellRect3167016

TDrawGrid	参照

CellRect メソッドは，グリッド内のセルの画面座標を返します。

function CellRect(ACol, ARow: Longint): TRect;

説明

CellRect メソッドを呼び出すと，ACol および ARow パラメータで示される列および行のセルの境界をピクセル数で取得できます。ACol と ARow に 0 が設定されると，左上のセルが指定されます。

指定するセルが表示されていない場合，CellRect メソッドは空の長方形を返します。


TDrawGrid.ColumnMoved
TDrawGrid.ColumnMoved3167017

TDrawGrid	参照

ColumnMoved メソッドは，OnColumnMoved イベントを生成します。

procedure ColumnMoved(FromIndex, ToIndex: Longint); override;

説明

ColumnMoved メソッドはグリッド内の列が移動した直後に呼び出されます。ColumnMoved メソッドは継承するメソッドをオーバーライドして OnColumnMoved イベントを生成します。TDrawGrid の下位オブジェクトはこのメソッドをオーバーライドして，内部的な調整を行ったり，OnColumnMoved イベントをブロックしたりすることができます。


TDrawGrid.DrawCell
TDrawGrid.DrawCell3167018

TDrawGrid	参照

DrawCell メソッドは，OnDrawCell イベントを生成します。

TGridDrawState = set of (gdSelected, gdFocused, gdFixed);

procedure DrawCell(ACol, ARow: Longint; ARect: TRect; AState: TGridDrawState); override;

説明

DrawCell メソッドは，グリッド内のセルが描画されるたびに自動的に呼び出されます。DefaultDrawing プロパティが True ならば，DrawCell が呼び出される前に，セルの背景がペイントされ，DrawCell の後で，固定セルの 3D 効果またはフォーカスのあるセルの周りのフォーカス四角形が描画されます。TDrawGrid の下位オブジェクトはこのメソッドをオーバーライドして，セルの内容を描画したり，OnDrawCell イベントをブロックしたりすることができます。


TDrawGrid.GetEditMask
TDrawGrid.GetEditMask3167019

TDrawGrid	参照

GetEditMask メソッドは，OnGetEditMask イベントを生成します。

function  GetEditMask(ACol, ARow: Longint): string; override;

説明

インプレースエディタは GetEditMask メソッドを呼び出して，ACol および ARow パラメータによって指定されているセルに関連付けられている入力マスクを取得します。GetEditMask メソッドは OnGetEditMask イベントハンドラによって設定された Value パラメータを返します。OnGetEditMask イベントハンドラがない場合は，GetEditMask は空の文字列を返して，編集マスクがないことを示します。


TDrawGrid.GetEditText
TDrawGrid.GetEditText3167020

TDrawGrid	参照

GetEditText メソッドは，OnGetEditText イベントを生成します。

function  GetEditText(ACol, ARow: Longint): string; override;

説明

インプレースエディタは GetEditText メソッドを呼び出して，指定されたセルのテキストを取得します。GetEditText メソッドは OnGetEditText イベントハンドラによって設定された Value パラメータを返します。OnGetEditText イベントハンドラがない場合は，GetEditText は空の文字列を返します。


TDrawGrid.MouseToCell
TDrawGrid.MouseToCell3167021

TDrawGrid	参照

MouseToCell メソッドは，画面座標（X,Y）の位置にあるセルの列と行を返します。

procedure MouseToCell(X, Y: Integer; var ACol, ARow: Longint);

説明

MouseToCell メソッドを呼び出すと，グリッドに対して相対的な画面座標を行および列インデックスに変換できます。パラメータ X と Y は変換される点の画面座標です。MouseToCell は，ACol パラメータに 点（X,Y）上の列の番号を，ARow パラメータに行番号を返します。

通常，MouseToCell メソッドはマウスイベントハンドラで使います。メソッドを呼び出すときにマウス座標をパラメータ X と Y として指定します。


TDrawGrid.RowMoved
TDrawGrid.RowMoved3167022

TDrawGrid	参照

RowMoved メソッドは，OnRowMoved イベントを生成します。

procedure RowMoved(FromIndex, ToIndex: Longint); override;

説明

RowMoved メソッドはグリッド内の行の位置が変更された直後に呼び出されます。RowMoved メソッドは継承するメソッドをオーバーライドして OnRowMoved イベントを生成します。TDrawGrid の下位オブジェクトはこのメソッドをオーバーライドして，内部的な調節を行ったり，OnRowMoved イベントをブロックしたりすることができます。


TDrawGrid.SelectCell
TDrawGrid.SelectCell3167023

TDrawGrid	参照

SelectCell メソッドは，グリッド内の特定のセルが選択できるかどうかを判定します。

function SelectCell(ACol, ARow: Longint): Boolean; override;

説明

グリッドコントロールは，ACol および ARow パラメータによって識別されるセルへ選択の移動を試みる前に SelectCell メソッドを内部的に呼び出します。ACol および ARow はセルの列および行インデックスです。1 番目の列が列インデックス 0 で，1 番上の行が行インデックス 0 になります。

SelectCell メソッドは OnSelectCell イベントを生成します。このメソッドは，セルが選択できないことを OnSelectCell イベントハンドラが示していなければ True を返します。TDrawGrid の下位オブジェクトはこのメソッドをオーバーライドして，セルに表示される情報のプロパティをチェックしたり，OnSelectCell イベントをブロックしたりすることができます。


TDrawGrid.SetEditText
TDrawGrid.SetEditText3167024

TDrawGrid	参照

SetEditText メソッドは，OnSetEditText イベントを生成します。

procedure SetEditText(ACol, ARow: Longint; const Value: string); dynamic;

説明

SetEditText メソッドは，グリッドがカレントセルの新しい値を格納できるようにするために，インプレースエディタによって呼び出されます。SetEditText は継承するメソッドをオーバーライドして OnSetEditText イベントを生成します。TDrawGrid の下位オブジェクトはこのメソッドをオーバーライドして，セルの値の内部表現を更新したり，OnSetEditText イベントをブロックしたりすることができます。


TDrawGrid.TopLeftChanged
TDrawGrid.TopLeftChanged3167025

TDrawGrid	参照

TopLeftChanged メソッドは，OnTopLeftChanged イベントを生成します。

procedure TopLeftChanged; dynamic;

説明

グリッドコントロールは，LeftCol または TopRow プロパティが変更されるたびに TopLeftChanged メソッドを内部的に呼び出します。継承するメソッドを呼び出して，インプレースエディタの位置を更新した後で，TopLeftChanged メソッドは OnTopLeftChanged イベントを生成します。


スコープ3167026

published

読み出し／書き込み

読み出し専用


スコープ3167027

protected


スコープ3167028

published


継承3167029

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomGrid


TDrawGrid 例3167030

TDrawGrid


TDragControlObject
TDragControlObject3168001

継承	プロパティ	メソッド	参照

TDragControlObject オブジェクトは，通常のドラッグアンドドロップ操作を管理します。

ユニット

controls

説明

TDragControlObject オブジェクトは Delphi の内部で通常のドラッグアンドドロップ操作を実行するために使います。TDragControlObject を使うと，OnDragOver および OnDragDrop イベントはドラッグオブジェクト自体ではなくドラッグしているコントロールを Sender として受け取ります。


TDragControlObject プロパティ3168002

TDragControlObject	アルファベット順	凡例

TDragControlObject

Control


TDragControlObject プロパティ3168003

TDragControlObject	オブジェクト順	凡例

Control


TDragControlObject.Control
TDragControlObject.Control3168004

TDragControlObject	参照

Control プロパティは，ドラッグアンドドロップ操作でドラッグしているコントロールを返します。

property Control: TControl;

説明

Control プロパティは，現在ドラッグしているコントロールを取得できます。


TDragControlObject メソッド3168005

TDragControlObject	アルファベット順	凡例

TDragControlObject

Create

Finished

GetDragCursor

GetDragImages

HideDragImage

ShowDragImage

TDragObject からの継承

GetName

Instance

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDragControlObject メソッド3168006

TDragControlObject	オブジェクト順	凡例

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Finished

Free

FreeInstance

GetDragCursor

GetDragImages

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetName

HideDragImage

InheritsFrom

InitInstance

Instance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

ShowDragImage


TDragControlObject.Create
TDragControlObject.Create3168007

TDragControlObject	参照

Create メソッドは TDragControlObject のインスタンスを作成し，ドラッグされているコントロールへの参照を格納します。

constructor Create(AControl: TControl);

説明

アプリケーションから直接 TDragControlObject の Create メソッドを呼び出さないでください。


TDragControlObject.Finished
TDragControlObject.Finished3168008

TDragControlObject	参照

Finished メソッドは，ドラッグアンドドロップ操作を終了して，OnEndDrag イベントハンドラを呼び出します。

procedure Finished(Target: TObject; X, Y: Integer; Accepted: Boolean)

説明

Accepted パラメータは，「X, Y」の位置にある Target のコントロールがドラッグアンドドロップ操作を受け入れたかどうかを示します。コントロールがドラッグアンドドロップを受け入れなかった場合は，OnEndDrag イベントハンドラの前にコントロールの DragCanceled メソッドが呼び出されます。


TDragControlObject.GetDragCursor
TDragControlObject.GetDragCursor3168009

TDragControlObject	参照

GetDragCursor メソッドは，ドラッグアンドドロップ操作の「X, Y」の位置に表示する適切なドラッグカーソルを返します。

function GetDragCursor(Accepted: Boolean; X, Y: Integer): TCursor

説明

「X, Y」の位置にあるコントロールが OnDragOver イベントハンドラでドラッグを受け入れた場合には，ドラッグオブジェクトはドラッグカーソルをコントロールの DragCursor プロパティに設定します。コントロールがドラッグを受け入れなかった場合には，crNoDrop カーソルが表示されます。


TDragControlObject.GetDragImages
TDragControlObject.GetDragImages3168010

TDragControlObject	参照

GetDragImages メソッドは，ドラッグ操作中に表示するイメージが含まれているコントロールのイメージリストを返します。

function GetDragImages: TCustomImageList

説明

GetDragImages メソッドはコントロールの GetDragImages メソッドを呼び出します。通常，イメージリストにはイメージが 1 つだけ含まれています。また，VCL は自動的にイメージリストを作成し，保持します。TCustomTreeView のようにメソッドをオーバーライドして別の値を返すように設定した場合を除いて，GetDragImages は VCL のほとんどのコントロールに対して nil を返します。


TDragControlObject.HideDragImage
TDragControlObject.HideDragImage3168011

TDragControlObject	参照

HideDragImage メソッドは，ドラッグカーソルに使われたイメージを隠します。

procedure HideDragImage; override;

説明

ドラッグ用のイメージがあるイメージリストを保持しているコントロールをドラッグすると，コントロールは隠れます。これにより，ドラッグイメージをいつ表示するかを制御できます。


TDragControlObject.ShowDragImage
TDragControlObject.ShowDragImage3168012

TDragControlObject	参照

ShowDragImage メソッドは，ドラッグカーソルに使われたイメージを表示します。

procedure ShowDragImage; override;

説明

ドラッグ用のイメージがあるイメージリストを保持しているコントロールをドラッグすると，コントロールが表示されます。これにより，ドラッグイメージをいつ表示するかを制御できます。


読み出し／書き込み3168013

読み出し専用


スコープ3168014

protected


継承3168015

TObject

TDragObject


TDragControlObject 例3168016

TDragControlObject


TDriveComboBox
TDriveComboBox3169001

継承	プロパティ	メソッド	イベント	参照

TDriveComboBox はアプリケーションの実行中に利用できるドライブをすべて表示する専用のコンボボックスです。

ユニット

filectrl

説明

TDriveComboBox をフォームに追加すると，ユーザーがドライブを選択できます。TDriveComboBox を TFileListBox，TFilterComboBox，および TDirectoryListBox とともに使うと，完全なファイル選択機能がフォームに追加できます。

ファイルを開いたり，保存したりする Windows 95 標準のダイアログボックスをアプリケーションに追加するには，かわりに TOpenDialog または TSaveDialog を使います。


TDriveComboBox プロパティ3169002

TDriveComboBox	アルファベット順	凡例

TDriveComboBox

DirList

Drive

TextCase

TCustomComboBox からの継承

Canvas

DroppedDown

ItemIndex

Items

SelLength

SelStart

SelText

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Text

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDriveComboBox プロパティ3169003

TDriveComboBox	オブジェクト順	凡例

Align

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DirList

DragCursor

DragMode

Drive

DroppedDown

Enabled

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

ItemIndex

Items

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

TextCase

Top

VCLComObject

Visible

Width

WindowProc


TDriveComboBox.DirList
TDriveComboBox.DirList3169004

TDriveComboBox	参照

DirList プロパティは，ドライブコンボボックスとディレクトリリストボックスを接続します。

property DirList: TDirectoryListBox;

説明

DirList プロパティは，ユーザーがドライブを変更したときに更新されなければならないディレクトリリストボックスコントロールを設定します。ドライブコンボボックスで新しいドライブを選択すると，指定したディレクトリリストボックスは新しいドライブのディレクトリ構造とカレントディレクトリを表示するように更新されます。

注意

フォームにファイルリストボックスも含まれている場合には，ディレクトリリストボックスオブジェクトの FileList プロパティを使ってファイルリストボックスを自動的に更新することができます。


TDriveComboBox.Drive
TDriveComboBox.Drive3169005

TDriveComboBox	参照

Drive プロパティは，コンボボックスの編集部分に表示されている現在選択されているドライブを示します。

property Drive: Char;

説明

Drive プロパティを設定して，コンボボックスを特定のドライブに初期化できます。Drive プロパティは，ユーザーによって選択されたドライブを取得できます。

ユーザーがドライブコンボボックスを使って新しいドライブを選択すると，選択したドライブが Drive プロパティの値になります。Drive プロパティの値が変わると Text プロパティの値も新しいボリューム名に変わります。


TDriveComboBox.TextCase
TDriveComboBox.TextCase3169006

TDriveComboBox	参照

TextCase プロパティは，Text プロパティのボリューム名が大文字小文字どちらで表示されるかを決めます。

TTextCase = (tcLowerCase, tcUpperCase);

property TextCase: TTextCase;

説明

TextCase プロパティにはドライブ名に大文字と小文字のどちらを使うかを指定します。次の値があります。

値	意味

tcLowerCase	Text プロパティに指定されたボリューム名は小文字で表示される

tcUpperCase	Text プロパティに指定されたボリューム名は大文字で表示される

注意

TextCase プロパティに対する設計時の変更はアプリケーションが実行されるまで表示されません。


TDriveComboBox イベント3169007

TDriveComboBox	アルファベット順	凡例

TCustomComboBox からの継承

OnChange

OnDropDown

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnStartDrag


TDriveComboBox イベント3169008

TDriveComboBox	オブジェクト順	凡例

OnChange

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnDropDown

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnStartDrag


TDriveComboBox メソッド3169009

TDriveComboBox	アルファベット順

TDriveComboBox

Create

Destroy

TCustomComboBox からの継承

Clear

SelectAll

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDriveComboBox メソッド3169010

TDriveComboBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDriveComboBox.Create
TDriveComboBox.Create3169011

TDriveComboBox	参照

Create メソッドは，TDriveComboBox のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TDriveComboBox オブジェクトを作成できます。設計時にフォーム上に配置されたドライブコンボボックスは自動的に作成されます。

コンボボックスにメモリを割り当ててから，Create メソッドはシステム上のすべてのドライブをコンボボックスに表示し，Drive プロパティをカレントドライブに初期化します。


TDriveComboBox.Destroy
TDriveComboBox.Destroy3169012

TDriveComboBox	参照

Destroy メソッドは，TDriveComboBox のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドはドライブコンボボックスが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。


スコープ3169013

published

読み出し／書き込み

読み出し専用


スコープ3169014

published


継承3169015

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomComboBox


TDriveComboBox 例3169016

TDriveComboBox


TDataSetTableProducer
TDataSetTableProducer3170001

継承	プロパティ	メソッド	イベント	参照

TDataSetTableProducer は一連の HTML コマンドを解釈して，TDataSet オブジェクトのレコードをテーブル形式で表示します。

ユニット

dbweb

説明

TDataSetTableProducer を使うと，TDataSet オブジェクトのレコードを表示する HTML テーブルを作成できます。データセットが問い合わせで，HTTP 要求メッセージから入力パラメータを要求する場合は，かわりに TQueryTableProducer を使ってください。

TDataSetTableProducer を使うと，アプリケーションは HTTP 応答メッセージに対するデータセットのイメージを作成できます。


TDataSetTableProducer プロパティ3170002

TDataSetTableProducer	アルファベット順	凡例

TDataSetTableProducer

DataSet

TDSTableProducer からの継承

Caption

CaptionAlignment

Columns

Editor

Footer

Header

MaxRows

RowAttributes

TableAttributes

TCustomContentProducer からの継承

Dispatcher

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDataSetTableProducer プロパティ3170003

TDataSetTableProducer	オブジェクト順	凡例

Caption

CaptionAlignment

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DataSet

DesignInfo

Dispatcher

Editor

Footer

Header

MaxRows

Name

Owner

RowAttributes

TableAttributes

Tag

VCLComObject


TDataSetTableProducer.DataSet
TDataSetTableProducer.DataSet3170004

TDataSetTableProducer	参照

DataSet プロパティは TDataSet オブジェクトで，データセットテーブル作成オブジェクトはこのプロパティから HTML テーブルに表示するレコードを検索します。

property DataSet: TDataSet;

説明

DataSet を設定すると，HTML テーブルに表示するレコードがあるデータセットを指定できます。TDataSetTableProducer のデータセットを設定するには，DataSource プロパティではなく DataSet プロパティを使います。データセットテーブル作成オブジェクトはアプリケーション内の他のデータオブジェクトとの間でレコードの現在の状態を維持しないため，外部の TDataSource オブジェクトを使いません。

Columns プロパティ内の THTMLTableColumn オブジェクトが指定する各項目の結合は DataSet 内の項目を参照します。


TDataSetTableProducer イベント3170005

TDataSetTableProducer	アルファベット順	凡例

TDSTableProducer からの継承

OnCreateContent

OnFormatCell

OnGetTableCaption


TDataSetTableProducer イベント3170006

TDataSetTableProducer	オブジェクト順	凡例

OnCreateContent

OnFormatCell

OnGetTableCaption


TDataSetTableProducer メソッド3170007

TDataSetTableProducer	アルファベット順

TDataSetTableProducer

Content

TDSTableProducer からの継承

BeginUpdate

Create

Destroy

EndUpdate

TCustomContentProducer からの継承

ContentFromStream

ContentFromString

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDataSetTableProducer メソッド3170008

TDataSetTableProducer	オブジェクト順

Assign

BeginUpdate

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Content

ContentFromStream

ContentFromString

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

EndUpdate

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TDataSetTableProducer.Content
TDataSetTableProducer.Content3170009

TDataSetTableProducer	参照

Content メソッドはデータセット内のレコードを HTML で記述して返します。

function Content: string; override;

説明

Content を呼び出すと，TDataSetTableProducer オブジェクトのプロパティで指定される HTML 記述を取り出すことができます。Content は OnCreateContent イベントハンドラを呼び出します。OnCreateContent イベントハンドラが Content メソッドを継続するよう指示している場合，Content は，Header プロパティ，データセット内のレコードの HTML テーブルイメージ，そして Footer プロパティを順番に返します。OnCreateContent イベントハンドラが Content メソッドを継続しないよう指示している場合，Content は空の文字列を返します。

Content が返す文字列は，HTTP 要求メッセージに対する応答の Content プロパティとして使うことができます。


スコープ3170010

published

読み出し／書き込み

読み出し専用


スコープ3170011

published


継承3170012

TObject

TPersistent

TComponent

TCustomContentProducer

TDSTableProducer


TDataSetTableProducer 例3170013

TDataSetTableProducer


TDSTableProducer
TDSTableProducer3171001

継承	プロパティ	メソッド	イベント	参照

TDSTableProducer は，データセットのレコードをテーブル形式で表示する HTML コマンドを生成するすべてのオブジェクトの抽象基本クラスです。

ユニット

dbweb

説明

TDSTableProducer は，データセットのレコードを表す HTML テーブルを生成するクラスを定義するときに基本クラスとして使います。TDSTableProducer は，HTML テーブルの外観やデータの結合を説明する多くのプロパティを提供します。アプリケーションは TDSTableProducer のイベントやメソッドを使うことで，アプリケーションはデータベース情報を取り出したり，テーブルを説明する HTML コマンドを作成したりできます。


TDSTableProducer プロパティ3171002

TDSTableProducer	アルファベット順	凡例

TDSTableProducer

Caption

CaptionAlignment

Columns

DataLink

DataSet

DataSource

Editor

Footer

Header

InternalDataSource

MaxRows

RowAttributes

TableAttributes

TCustomContentProducer からの継承

Dispatcher

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDSTableProducer プロパティ3171003

TDSTableProducer	オブジェクト順	凡例

Caption

CaptionAlignment

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DataLink

DataSet

DataSource

DesignInfo

Dispatcher

Editor

Footer

Header

InternalDataSource

MaxRows

Name

Owner

RowAttributes

TableAttributes

Tag

VCLComObject


TDSTableProducer.Caption
TDSTableProducer.Caption3171004

TDSTableProducer	参照

Caption プロパティは，HTML テーブルとともに表示されるキャプション文字列を指定します。

property Caption: string;

説明

Caption プロパティを設定すると，データセットを表す HTML テーブルにキャプションを追加できます。Caption は HTML の CAPTION タグ内に表示されるテキストを示します。


TDSTableProducer.CaptionAlignment
TDSTableProducer.CaptionAlignment3171005

TDSTableProducer	参照

CaptionAlignment プロパティは，HTML テーブルに対してどの位置に Caption 文字列を表示するかを指定します。

THTMLCaptionAlignment = (caDefault, caTop, caBottom);

property CaptionAlignment: THTMLCaptionAlignment;

説明

CaptionAlignment プロパティを設定すると，Caption 文字列を HTML テーブルの上に表示するか下に表示するかを指定できます。以下に CaptionAlignment に設定される値を示します。

値	意味

caDefault	Web ブラウザはどの位置にでもキャプションを配置できる

caTop	キャプションは HTML テーブルの上に表示される

caBottom	キャプションは HTML テーブルの下に表示される

CaptionAlignment は HTML の CAPTION タグにおける ALIGN オプションの値です。


TDSTableProducer.Columns
TDSTableProducer.Columns3171006

TDSTableProducer	参照

Columns プロパティは，HTML テーブル内の列の結合や表示属性を記述する THTMLTableColumn オブジェクトのインデックス付きコレクションです。

property Columns: THTMLTableColumns;

説明

Columns プロパティは，HTML テーブルの項目の結合および列の表示属性を読み出したり設定したりできます。各 THTMLTableColumn オブジェクトは，対応する列の表示属性を指定します。また，各列オブジェクトは，列が表す項目の名前も指定します。列の項目の結合は DataSet プロパティで指定されるデータセット内の項目を指定します。

Columns は設計時にはプロパティエディタを使って設定し，実行時にはプログラムで設定します。


TDSTableProducer.DataLink
TDSTableProducer.DataLink3171007

TDSTableProducer	参照

DataLink プロパティは，データセットへのリンクを管理する内部的なヘルパーオブジェクトです。

property DataLink: THTTPDataLink;

説明

アプリケーションは DataLink プロパティを使うことはできません。DataLink プロパティは，下位 HTML 手続きがデータイベントに対する応答をカスタマイズするできるように，プロテクトプロパティとしてエクスポーズされます。


TDSTableProducer.DataSet
TDSTableProducer.DataSet3171008

TDSTableProducer	参照

DataSet プロパティは，HTML テーブルのデータの取得元となるデータセットです。

property DataSet: TDataSet;

説明

DataSet を設定すると，TDSTableProducer が HTML テーブルに表示するデータをどこから検索するかを指定できます。Columns プロパティ内の THTMLTableColumn オブジェクトが指定する個々の項目の結合は DataSet 内の項目を参照します。

TDSTableProducer のデータの結合を指定するには，DataSource プロパティではなく DataSet プロパティを使います。TDSTableProducer オブジェクトはアプリケーション内のほかのデータオブジェクトとの間にレコードの通用性を維持しないので，外部の TDataSource オブジェクトを使いません。


TDSTableProducer.DataSource
TDSTableProducer.DataSource3171009

TDSTableProducer	参照

DataSource プロパティは，TDSTableProducer の DataSet プロパティへのリンクを表します。

property DataSource: TDataSource;

説明

DataSource プロパティは使用しないでください。TDSTableProducer オブジェクトの DataSource は内部的に生成された TDataSource オブジェクトで，直接的には TDataSet オブジェクトを操作しない内部的なインターフェースに使われます。

InternalDataSource プロパティは DataSource が表すデータソースに対する読み出し専用のアクセスを提供します。


TDSTableProducer.Editor
TDSTableProducer.Editor3171010

TDSTableProducer	参照

Editor プロパティは，設計時にプロパティエディタで TDSTableProducer オブジェクトに対して行われた変更を書き込むためのヘルパーオブジェクトです。

property Editor: TDSTableProducerEditor;

説明

TDSTableProducer の派生オブジェクトは，共通のプロパティエディタを使ってそれらを実現できるように設計された TDSTableProducerEditor オブジェクトに Editor を設定します。Editor プロパティは，1 つのプロパティエディタで複数のテーブル作成オブジェクトのプロパティを表すことができます。


TDSTableProducer.Footer
TDSTableProducer.Footer3171011

TDSTableProducer	参照

Footer プロパティは，HTML ドキュメント内にある HTML コマンドのセットで，DataSet を表す HTML テーブルの後に表示されます。

property Footer: TStrings;

説明

Footer プロパティを設定すると，大きなドキュメントに DataSet の説明を埋め込むことができます。TDSTableProducer の Content メソッドは，Header コマンド，DataSet を表す HTML テーブル，および Footer コマンドを順番に返します。


TDSTableProducer.Header
TDSTableProducer.Header3171012

TDSTableProducer	参照

Header プロパティは，HTML ドキュメント内にある HTML コマンドのセットで，DataSet を表す HTML テーブルの前に表示されます。

property Header: TStrings;

説明

Header プロパティを設定すると，大きなドキュメントに DataSet の説明を埋め込むことができます。TDSTableProducer の Content メソッドは，Header コマンド，DataSet を表す HTML テーブル，および Footer コマンドを順番に返します。


TDSTableProducer.InternalDataSource
TDSTableProducer.InternalDataSource3171013

TDSTableProducer	参照

InternalDataSource プロパティは，TDSTableProducer が DataSet へのリンクを表すために内部的に生成する DataSource オブジェクトです。

property InternalDataSource: TDataSource;

説明

TDSTableProducer の派生オブジェクトは InternalDataSource を読み出してデータソースのプロパティとメソッドにアクセスします。TDSTableProducer はアプリケーション内でほかのデータオブジェクトとの間にレコードの通用性を維持しないため，外部の TDataSource オブジェクトを使いません。


TDSTableProducer.MaxRows
TDSTableProducer.MaxRows3171014

TDSTableProducer	参照

MaxRows プロパティは，DataSet を表す HTML テーブルに表示される最大の行数です。

property MaxRows: Integer;

説明

MaxRows プロパティを設定すると，DataSet を表すために作成される HTML テーブルのサイズの上限を変更できます。MaxRows の初期値は 20 です。

DataSet にあるレコード数が MaxRows より多い場合，Content が作成する HTML コマンドには最初のレコードから MaxRows の数だけのレコードが表示されます。DataSet にあるレコード数が MaxRows より少ない場合，TDSTableProducer が作成する HTML テーブルには DataSet のすべてのレコードを表示できるだけの行が作成されます。


TDSTableProducer.RowAttributes
TDSTableProducer.RowAttributes3171015

TDSTableProducer	参照

RowAttributes プロパティは，TDSTableProducer が作成する HTML テーブル内のすべての行について表示属性を指定します。

property RowAttributes: THTMLTableRowAttributes;

説明

HTML テーブル内の行の表示属性を記述する THTMLTableRowAttributes オブジェクトを RowAttributes に設定します。RowAttributes を設定すると，TDSTableProducer によって内部的に格納された THTMLTableRowAttributes オブジェクトの Assign メソッドが呼び出されます。したがって，RowAttributes プロパティに割り当てられた行属性オブジェクトのメモリは TDSTableProducer によって所有されたり解放されたりすることはありません。

注意

行属性オブジェクトが別の行属性オブジェクトに割り当てられる場合，すべてのプロパティがコピーされるわけではありません。RowAttributes によって表されるすべての属性を正しく設定したい場合は，RowAttributes を読み出して THTMLTableRowAttributes オブジェクトの個々のプロパティを設定してください。


TDSTableProducer.TableAttributes
TDSTableProducer.TableAttributes3171016

TDSTableProducer	参照

TableAttributes プロパティは，TDSTableProducer が作成する HTML テーブル全体に対する表示属性を指定します。

property TableAttributes: THTMLTableAttributes;

説明

HTML の TABLE タグの表示属性を記述する THTMLTableAttributes オブジェクトを TableAttributes に設定します。TableAttributes を設定すると，TDSTableProducer によって内部的に格納された THTMLTableAttributes オブジェクトの Assign メソッドが呼び出されます。したがって，TableAttributes プロパティに割り当てられたテーブル属性オブジェクトのメモリは TDSTableProducer によって所有されたり解放されたりすることはありません。

注意

テーブル属性オブジェクトが別のテーブル属性オブジェクトに割り当てられる場合，すべてのプロパティがコピーされるわけではありません。TableAttributes が表すすべての属性を正しく設定したい場合は，TableAttributes を読み出して THTMLTableAttributes オブジェクトの個々のプロパティを設定してください。


TDSTableProducer イベント3171017

TDSTableProducer	アルファベット順	凡例

TDSTableProducer

OnCreateContent

OnFormatCell

OnGetTableCaption


TDSTableProducer イベント3171018

TDSTableProducer	オブジェクト順	凡例

OnCreateContent

OnFormatCell

OnGetTableCaption


TDSTableProducer.OnCreateContent
TDSTableProducer.OnCreateContent3171019

TDSTableProducer	参照

OnCreateContent イベントは，Content メソッドが HTML テーブルイメージを生成する必要がある場合に TDSTableProducer の派生オブジェクト内で発生します。

TCreateContentEvent = procedure (Sender: TObject; var Continue: Boolean) of object;

property OnCreateContent: TCreateContentEvent;

説明

OnCreateContent イベントハンドラを記述すると，条件によって Content メソッドが HTML コマンドを作成するのを防ぐことができます。Continue パラメータに False を設定すると，Content は空の文字列を返します。


TDSTableProducer.OnFormatCell
TDSTableProducer.OnFormatCell3171020

TDSTableProducer	参照

OnFormatCell イベントは，CellRow パラメータと CellColumn パラメータで指定されたセルに対して HTML が生成されようとするときに発生します。

THTMLFormatCellEvent = procedure (Sender: TObject; CellRow, CellColumn: Integer; var BgColor: THTMLBgColor; var Align: THTMLAlign; var VAlign: THTMLVAlign; var CustomAttrs, CellData: string) of object;

property OnFormatCell: THTMLFormatCellEventl;

説明

OnFormatCell イベントハンドラを記述すると，HTML テーブル内の個々のセルの外観や内容を，TDSTableProducer が作成したデフォルトの値から変更できます。CellRow と CellColumn は生成されようとしているセルを指定しており，テーブルヘッダーは CellRow 0，最初の列は CellColumn 0 です。

BgColor，Align，VAlign，および CustomAttrs は，セルのデフォルトの表示プロパティを表します。これらのプロパティは，セルを表示する列の THTMLTableColumn オブジェクトから取得されます。CellData はセル内に表示されるテキストで，列の項目オブジェクトから取得されます。OnFormatCell イベントハンドラはこれらの値のいずれかまたはすべてを変更して，最終的な HTML テーブル内でのセルの表示方法を指定できます。


TDSTableProducer.OnGetTableCaption
TDSTableProducer.OnGetTableCaption3171021

TDSTableProducer	参照

OnGetTableCaption イベントは，HTML テーブル作成オブジェクトがテーブルキャプションの HTML を生成しようとするときに発生します。

THTMLGetTableCaptionEvent = procedure (Sender: TObject; var Caption: string; var Alignment: THTMLCaptionAlignment) of object;

property OnGetTableCaption: THTMLGetTableCaptionEvent;

説明

OnGetTableCaption イベントハンドラを記述すると，HTML テーブルキャプションの値や位置を変更できます。最初は， Caption と Alignment パラメータにはそれぞれ Caption と CaptionAlignment プロパティの値が設定されています。OnGetTableCaption イベントハンドラはこれらの値を変更して，Content メソッドが返す HTML テーブルのキャプションを変更できます。


TDSTableProducer メソッド3171022

TDSTableProducer	アルファベット順	凡例

TDSTableProducer

AcquireLayoutLock

BeginLayout

BeginUpdate

Create

DefineFieldMap

Destroy

DoCreateContent

DoFormatCell

DoGetCaption

EndLayout

EndUpdate

GetDataSet

GetDataSource

LayoutChanged

LinkActive

Notification

SetColumns

SetDataSet

SetDataSource

StoreColumns

TCustomContentProducer からの継承

Content

ContentFromStream

ContentFromString

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDSTableProducer メソッド3171023

TDSTableProducer	オブジェクト順	凡例

AcquireLayoutLock

Assign

BeginLayout

BeginUpdate

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Content

ContentFromStream

ContentFromString

Create

DefaultHandler

DefineFieldMap

Destroy

DestroyComponents

Destroying

Dispatch

DoCreateContent

DoFormatCell

DoGetCaption

EndLayout

EndUpdate

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetDataSet

GetDataSource

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

LayoutChanged

LinkActive

MethodAddress

MethodName

NewInstance

Notification

RemoveComponent

SafeCallException

SetColumns

SetDataSet

SetDataSource

StoreColumns


TDSTableProducer.AcquireLayoutLock
TDSTableProducer.AcquireLayoutLock3171024

TDSTableProducer	参照

AcquireLayoutLock メソッドは，HTML テーブルがレイアウトされていないときに BeginLayout メソッドを呼び出します。

function AcquireLayoutLock: Boolean;

説明

アプリケーションはこのプロテクトメソッドを呼び出すことはできません。AcquireLayoutLock は，データセット内の項目が変更されたときや，Columns プロパティが変更されたときに Columns が再計算される前に呼び出されます。AquireLayoutLock は HTML テーブルがレイアウト済みでない場合に True を返し，Columns の計算を続行しなければならないことを示します。AquireLayoutLock を使うと，計算中に生じた変更によって Columns の計算が無限にループすることを防ぐことができます。


TDSTableProducer.BeginLayout
TDSTableProducer.BeginLayout3171025

TDSTableProducer	参照

BeginLayout メソッドは，開始されたが完了していない列順の計算回数を示すカウンタをインクリメントします。

procedure BeginLayout;

説明

アプリケーションはこのプロテクトメソッドを呼び出すことはできません。TDSTableProducer は，Columns プロパティまたは Columns 内の個々の THTMLTableColumn オブジェクトを変更する前に BeginLayout を内部的に呼び出します。変更が完了すると，TDSTableProducer は EndLayout を呼び出します。

すべての BeginLayout の呼び出しが 1 つの EndLayout の呼び出しと対応している場合，データセット内の項目に対して DataLink が保持している項目マッピングは，Columns プロパティの項目の結合とデータセット内で使用可能な項目の両方に一致するように更新されます。これに対応して，Columns プロパティは DataLink 内の項目の結合に一致するように更新されます。これにより，Columns プロパティは指定された列の結合とデータセット内で使用可能な項目の両方に一致することが保証されます。


TDSTableProducer.BeginUpdate
TDSTableProducer.BeginUpdate3171026

TDSTableProducer	参照

BeginUpdate メソッドは，HTML テーブルの内容に対する，開始されたが完了していない変更の回数を示すカウンタをインクリメントします。

procedure BeginUpdate;

説明

アプリケーションでは BeginUpdate メソッドを呼び出さないでください。BeginUpdate は HTML テーブルの内容に影響する変更が行われる前に内部的に呼び出されます。変更が完了すると，EndUpdate が呼び出されます。TDSTableProducer の派生オブジェクトは BeginUpdate と EndUpdate を使うことで，データセットへの変更が完了するまで待ってから，テーブルの HTML イメージのレコードを取り出すことができます。


TDSTableProducer.Create
TDSTableProducer.Create3171027

TDSTableProducer	参照

Create メソッドは，TDSTableProducer のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，HTTP 要求メッセージに応答してデータセットの HTML イメージを作成する必要がある TWebActionItem の OnAction イベントハンドラの内部からテーブル作成オブジェクトを作成できます。

Create は継承コンストラクタを呼び出した後，TDSTableProducer が使うすべてのヘルパーオブジェクトを割り当て，MaxRows プロパティを 20 に初期化します。


TDSTableProducer.DefineFieldMap
TDSTableProducer.DefineFieldMap3171028

TDSTableProducer	参照

DefineFieldMap メソッドは，DataLink 内に Fields 配列を構築します。

procedure DefineFieldMap;

説明

アプリケーションはこのプロテクトメソッドを呼び出すことはできません。DefineFieldMap は DataLink が保持しているデータセットに対する項目マッピングを再構築します。このマッピングには，Columns プロパティの列の結合とデータセット内で使用可能な項目の両方が反映されます。DefineFieldMap を呼び出した後，Columns プロパティは DataLink 内の項目の結合に一致するように更新されなければなりません。これにより，Columns プロパティにデータセットの変更が反映されることが保証されます。


TDSTableProducer.Destroy
TDSTableProducer.Destroy3171029

TDSTableProducer	参照

Destroy メソッドは，TDSTableProducer のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TDSTableProducer オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy は TDSTableProducer が使うすべてのヘルパーオブジェクトを解放します。


TDSTableProducer.DoCreateContent
TDSTableProducer.DoCreateContent3171030

TDSTableProducer	参照

DoCreateContent メソッドは，Content メソッドが HTML コマンドの文字列を作成しなければならないかどうかを示します。

function DoCreateContent: Boolean;

説明

アプリケーションはこのプロテクトメソッドを呼び出すことはできません。DoCreateContent メソッドは Content メソッドによって内部的に呼び出され，OnCreateContent イベントハンドラが HTML コマンドの作成をブロックできるようにします。DoCreateContent が True を返す場合，Content は HTML 文字列をアセンブルしてデータセットを記述します。DoCreateContent が False を返す場合，Content は空の文字列を返します 。

DoCreateContent は，OnCreateContent イベントハンドラ（割り当てられている場合）を呼び出します。OnCreateContent イベントハンドラが割り当てられていない場合，DoCreateContent は True を返します。TDSTableProducer の派生オブジェクトは，DataSet を記述する HTML を作成する時期についての制限を追加するか，OnCreateContent イベントをブロックするために，DoCreateContent をオーバーライドできます。


TDSTableProducer.DoFormatCell
TDSTableProducer.DoFormatCell3171031

TDSTableProducer	参照

DoFormatCell メソッドは OnFormatCell イベントハンドラを呼び出して，HTML テーブル内の個々のセルの内容や表示属性を変更できるようにします。

procedure DoFormatCell(CellRow, CellColumn: Integer; var BgColor: THTMLBgColor;

  var Align:THTMLAlign; var VAlign: THTMLVAlign; var CustomAttrs, CellData: string); dynamic;

説明

アプリケーションはこのプロテクトメソッドを呼び出すことはできません。DoFormatCell メソッドは Content メソッドによって内部的に呼び出され，OnFormatCell イベントハンドラが HTML テーブル内のセルの内容や表示属性をカスタマイズできるようにします。CellRow と CellColumn は HTML テーブルとして表現されるセルを示し，テーブルヘッダーの CellRow は 0，最初の列の CellColumn は 0 です。BgColor，Align，Valign，および CustomAttrs は変更可能な表示属性です。CellData はセル内に入るテキストです。

TDSTableProducer の派生オブジェクトは，セルが表現されるときにセルに対する変更を追加したり，OnFormatCell イベントをブロックしたりするために DoFormatCell をオーバーライドできます。


TDSTableProducer.DoGetCaption
TDSTableProducer.DoGetCaption3171032

TDSTableProducer	参照

DoGetCaption メソッドは OnGetCaption イベントハンドラを呼び出して，テーブルキャプションが表現されるときにその値や配置を変更できるようにします。

procedure DoGetCaption(var TableCaption: string; var CaptionAlign: THTMLCaptionAlignment);

   dynamic;

説明

アプリケーションはこのプロテクトメソッドを呼び出すことはできません。DoGetCaption メソッドは Content メソッドによって内部的に呼び出され，テーブルキャプションが HTML で表現されるときに OnGetCaption イベントハンドラが Caption と CaptionAlignment プロパティを変更できるようにします。

TDSTableProducer の派生オブジェクトは，キャプションが表現されるときに追加の変更を行ったり，OnCreateCaption イベントをブロックしたりするために DoCreateCaption をオーバーライドできます。


TDSTableProducer.EndLayout
TDSTableProducer.EndLayout3171033

TDSTableProducer	参照

EndLayout メソッドは，開始されたが完了していない列順計算の回数を示すカウンタをデクリメントします。

procedure EndLayout;

説明

アプリケーションはこのプロテクトメソッドを呼び出すことはできません。TDSTableProducer オブジェクトは，Columns プロパティを変更をした後や，DataSet 内の項目が変更されたときに EndLayout を内部的に呼び出します。

EndLayout の呼び出しは必ず BeginLayout の呼び出しと対応していなければなりません。すべての BeginLayout の呼び出しが 1 つの EndLayout の呼び出しに対応している場合，EndLayout は DefineFieldMap を呼び出して DataLink が保持しているデータセットに対する項目マッピングを再生成します。次に，Columns プロパティが DataLink 内の項目マップと一致するように更新されます。これにより，Columns プロパティは指定された列の結合とデータセット内で使用可能な項目の両方に一致することが保証されます。


TDSTableProducer.EndUpdate
TDSTableProducer.EndUpdate3171034

TDSTableProducer	参照

EndUpdate メソッドは，HTML テーブルの内容に対する変更の数を示すカウンタをデクリメントします。

procedure EndUpdate;

説明

アプリケーションでは EndUpdate メソッドを呼び出さないでください。EndUpdate メソッドは，列の結合や TDSTableProducer の DataSet が変更された後に内部的に呼び出されます。TDSTableProducer の派生オブジェクトは BeginUpdate と EndUpdate を使うことで，データセットへの変更が完了するまで待ってから，テーブルの HTML イメージのレコードを取り出すことができます。


TDSTableProducer.GetDataSet
TDSTableProducer.GetDataSet3171035

TDSTableProducer	参照

GetDataSet メソッドは，DataSet プロパティにアクセスするメソッドの抽象プロトタイプです。

function GetDataSet: TDataSet; virtual; abstract;

説明

TDSTableProducer の派生オブジェクトは，特定の DataSet プロパティにアクセスするために GetDataSet メソッドを実装します。これらの派生オブジェクトは，DataSet プロパティを TDataSet オブジェクトの異なるクラスに限定します。


TDSTableProducer.GetDataSource
TDSTableProducer.GetDataSource3171036

TDSTableProducer	参照

GetDataSource メソッドは，DataSource プロパティ用のプロテクトされたプロパティアクセスメソッドです。

function GetDataSource: TDataSource;

説明

GetDataSource はプロテクトメソッドとしてエクスポーズされるので，TDSTableProducer の派生オブジェクトは DataSource プロパティの実現をオーバーライドできます。

TDSTableProducer の DataSource プロパティは内部的に作成された TDataSource オブジェクトで，ほかのオブジェクトと共有可能な外部コンポーネントではありません。このプロパティは，直接 TDataSet オブジェクトを操作せずに TDataSource オブジェクトを要求する内部 API のためにだけ用意されています。


TDSTableProducer.LayoutChanged
TDSTableProducer.LayoutChanged3171037

TDSTableProducer	参照

LayoutChanged メソッドは，データセットや個々の列オブジェクトが変更されたときに Columns プロパティが再計算されるようにします。

procedure LayoutChanged;

説明

アプリケーションはこのプロテクトメソッドを呼び出すことはできません。LayoutChanged は Columns プロパティやデータセット内の項目が変更されたときに呼び出されます。LayoutChanged は，計算中に Columns プロパティを変更することで再帰が生じないように保護してから Columns プロパティを再計算します。

LayoutChanged は AcquireLayoutLock を呼び出して Columns の変更を開始します。AcquireLayoutLock が LayoutChanged への呼び出しが再帰的でないことを示していれば，LayoutChanged は EndLayout を呼び出して実際に計算を実行します。


TDSTableProducer.LinkActive
TDSTableProducer.LinkActive3171038

TDSTableProducer	参照

LinkActive メソッドは，データセットがアクティブになったときに Columns プロパティを再計算します。

procedure LinkActive(Value: Boolean);

説明

アプリケーションはこのプロテクトメソッドを呼び出すことはできません。LinkActive は DataSource プロパティが変更されたときや，データセットがアクティブになったときに呼び出されます。このメソッドは Columns を再計算して，アクティブになる前にデータセットの項目内で発生した可能性のある変更を反映します。


TDSTableProducer.Notification
TDSTableProducer.Notification3171039

TDSTableProducer	参照

Notification メソッドは，TDSTableProducer の DataSource や列が参照している項目オブジェクトが破棄されたときに，TDSTableProducer のプロパティを調整します。

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

Notification は継承メソッドをオーバーライドして，DataSource や項目オブジェクトが破棄されるというメッセージに応答します。Notification は DataSource プロパティを nil に設定するか，項目コンポーネントを参照している列の結合を解除します。


TDSTableProducer.SetColumns
TDSTableProducer.SetColumns3171040

TDSTableProducer	参照

SetColumns メソッドは，Columns プロパティを設定します。

procedure SetColumns(Value: THTMLTableColumns);

説明

SetColumns は，Columns プロパティを設定するためのプロテクトメソッドです。SetColumns は TDSTableProducer によって内部的に格納された THTMLTableColumns オブジェクトの Assign メソッドを呼び出します。したがって，Columns プロパティに割り当てられた列オブジェクトのメモリは TDSTableProducer によって所有されたり解放されたりすることはありません。


TDSTableProducer.SetDataSet
TDSTableProducer.SetDataSet3171041

TDSTableProducer	参照

SetDataSet メソッドは，DataSet プロパティを設定するメソッドの抽象プロトタイプです。

procedure SetDataSet(ADataSet: TDataSet); virtual; abstract;

説明

TDSTableProducer の派生オブジェクトは SetDataSet をオーバーライドして，DataSet プロパティが適切な TDataSet の派生オブジェクトにのみ設定されることを保証します。


TDSTableProducer.SetDataSource
TDSTableProducer.SetDataSource3171042

TDSTableProducer	参照

SetDataSource メソッドは，DataSource プロパティを設定します。

procedure SetDataSource(Value: TDataSource);

説明

SetDataSource はプロテクトメソッドとして定義されているので，TDSTableProducer の派生オブジェクトは DataSource プロパティの実現をオーバーライドできます。

TDSTableProducer の DataSource プロパティは内部的に生成された TDataSource オブジェクトで，ほかのオブジェクトと共有可能な外部コンポーネントではありません。このプロパティは，直接 TDataSet オブジェクトを操作せずに TDataSource オブジェクトを要求する内部 API 呼び出しのためにだけ用意されています。


TDSTableProducer.StoreColumns
TDSTableProducer.StoreColumns3171043

TDSTableProducer	参照

StoreColumns メソッドは，TDSTableProducer を保存するときに Columns プロパティを格納するかどうかを示します。

function StoreColumns: Boolean;

説明

StoreColumns メソッドは，Columns プロパティの State プロパティが csCustom のときにだけ Columns プロパティを格納するよう指示します。Columns の State プロパティは，列がデータセット内にある全項目のデフォルトの表示属性を表すかどうかや，列の表示属性または項目の結合がプログラムと列エディタのどちらでカスタマイズされたかを示します。


スコープ3171044

protected

published

読み出し／書き込み

読み出し専用


スコープ3171045

protected


スコープ3171046

protected


継承3171047

TObject

TPersistent

TComponent

TCustomContentProducer


TDSTableProducer 例3171048

TDSTableProducer


TDSTableProducerEditor
TDSTableProducerEditor3172001

継承	プロパティ	メソッド	参照

TDSTableProducer は，設計時にプロパティエディタと通信するために TDSTableProducer が使うヘルパーオブジェクトの基本クラスです。

ユニット

dbweb

説明

コンポーネント開発者は TDSTableProducer からオブジェクトを派生させることができ，その結果，TDSTableProducer の新しい派生オブジェクトは IDE のプロパティエディタを利用できるようになります。TDSTableProducerEditor は，TDSTableProducer オブジェクトとプロパティエディタ間で設定の変更をやりとりするためのメソッドを提供します。


TDSTableProducerEditor プロパティ3172002

TDSTableProducerEditor	アルファベット順	凡例

TDSTableProducerEditor

DataSource

DSTableProducer


TDSTableProducerEditor プロパティ3172003

TDSTableProducerEditor	オブジェクト順	凡例

DataSource

DSTableProducer


TDSTableProducerEditor.DataSource
TDSTableProducerEditor.DataSource3172004

TDSTableProducerEditor	参照

DataSource プロパティは，TDSTableProducer の DataSource です。

property DataSource: TDataSource;

説明

アプリケーションでは直接 DataSource プロパティを変更しないでください。DataSource を使うと，プロパティエディタで TDSTableProducer オブジェクトの内部のデータソースを取得および設定することが可能になります。


TDSTableProducerEditor.DSTableProducer
TDSTableProducerEditor.DSTableProducer3172005

TDSTableProducerEditor	参照

DSTableProducer は，設計時に TDSTableProducerEditor を使ってプロパティエディタと通信する TDSTableProducer オブジェクトです。

property DSTableProducer: TDSTableProducer;

説明

TDSTableProducer は，TDSTableProducerEditor を使う TDSTableProducer オブジェクトに直接アクセスします。


TDSTableProducerEditor メソッド3172006

TDSTableProducerEditor	アルファベット順

TDSTableProducerEditor

Changed

Create

Destroy

PostChange

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDSTableProducerEditor メソッド3172007

TDSTableProducerEditor	オブジェクト順

Changed

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

PostChange

SafeCallException


TDSTableProducerEditor.Changed
TDSTableProducerEditor.Changed3172008

TDSTableProducerEditor	参照

Changed メソッドは，TDSTableProducer オブジェクトからの変更通知に応答するメソッドとのインターフェースを提供します。

procedure Changed; virtual;

説明

TDSTableProducerEditor の Changed メソッドは何も処理を行いません。このメソッド は，TDSTableProducer オブジェクトが変更されたときに TDSTableProducerEditor の派生オブジェクトが必要な更新処理を行うために用意されています。TDSTableProducer のプロパティが変更されると，TDSTableProducer が Changed を呼び出します。


TDSTableProducerEditor.Create
TDSTableProducerEditor.Create3172009

TDSTableProducerEditor	参照

Create メソッドは，TDSTableProducerEditor のインスタンスを作成します。

constructor Create(DSTableProducer: TDSTableProducer);

説明

アプリケーションで直接 Create を呼び出さないでください。TDSTableProducerEditor は設計時に必要に応じて作成されます。Create は DSTableProducer プロパティ を初期化し，DSTableProducer のパラメータとして渡された TDSTableProducer オブジェクトの Editor プロパティを設定します。


TDSTableProducerEditor.Destroy
TDSTableProducerEditor.Destroy3172010

TDSTableProducerEditor	参照

Destroy メソッドは，TDSTableProducerEditor のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションから Destroy を呼び出さないでください。TDSTableProducerEditor オブジェクトは設計時に自動的に解放されます。Destroy は関連する DSTableProducer オブジェクトの Editor プロパティを nil に設定します。


TDSTableProducerEditor.PostChange
TDSTableProducerEditor.PostChange3172011

TDSTableProducerEditor	参照

PostChange メソッドは，TDSTableProducer オブジェクトの列からの更新通知に応答するメソッドとのインターフェースを提供します。

procedure PostChange; virtual;

説明

TDSTableProducerEditor の PostChange メソッドは何も処理を行いません。このメソッドは，TDSTableProducer オブジェクトの列が変更されたときに TDSTableProducerEditor の派生オブジェクトが必要な更新処理を行うために用意されています。THTMLTableColumns の Update メソッドが呼び出されると，THTMLTableColumns が PostChange を呼び出します。


読み出し／書き込み3172012

読み出し専用


継承3172013

TObject


TDSTableProducerEditor 例3172014

TDSTableProducerEditor


TDataSetUpdateObject
TDataSetUpdateObject3173001

継承	プロパティ	メソッド	参照

キャッシュアップデートが使用可能なときに更新不可の問い合わせを更新するのに使う更新オブジェクトのための基本クラスを実装します。

ユニット

dbtables

説明

TDataSetUpdateObject は TUpdateSQL オブジェクトの基本クラスです。 TDataSetUpdateObject は，TUpdateSQL に再実装される，1 つのプロパティと 1 つのメソッドをプロテクトにしたプロパティおよびメソッドを宣言しています。独自の更新オブジェクトを作成する場合，TDataSetUpdateObject のソースコードを調べるとそのオブジェクトの機能を評価できます。


TDataSetUpdateObject プロパティ3173002

TDataSetUpdateObject	アルファベット順	凡例

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDataSetUpdateObject プロパティ3173003

TDataSetUpdateObject	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TDataSetUpdateObject メソッド3173004

TDataSetUpdateObject	アルファベット順

TComponent からの継承

Create

Destroy

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDataSetUpdateObject メソッド3173005

TDataSetUpdateObject	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


スコープ3173006

published

読み出し／書き込み

読み出し専用


継承3173007

TObject

TPersistent

TComponent


TDataSetUpdateObject 例3173008

TDataSetUpdateObject


TDateTimeColors
TDateTimeColors3174001

継承	プロパティ	メソッド	参照

TDateTimeColors は，TDateTimePicker のドロップダウンカレンダーに使う色を定義します。

ユニット

comctrls

説明

TDateTimePicker の CalColors プロパティは TDateTimeColors オブジェクトを保持します。TDateTimePicker がドロップダウンカレンダーの絵を表示するとき（Kind = dtkDate で DateMode が dmComboBox のとき），TDateTimeColors がカレンダーの色を決定します。


TDateTimeColors のプロパティ3174002

TDateTimeColors	アルファベット順	凡例

TDateTimeColors

BackColor

MonthBackColor

TextColor

TitleBackColor

TitleTextColor

TrailingTextColor


TDateTimeColors のプロパティ3174003

TDateTimeColors	オブジェクト順	凡例

BackColor

MonthBackColor

TextColor

TitleBackColor

TitleTextColor

TrailingTextColor


TDateTimeColors.BackColor
TDateTimeColors.BackColor3174004

TDateTimeColors	参照

BookColor プロパティは，カレンダーの月と月の間に表示される背景色です。

property BackColor: TColor;

説明

BackColor プロパティは，Windows のバージョンによっては機能しないことがあります。


TDateTimeColors.MonthBackColor
TDateTimeColors.MonthBackColor3174005

TDateTimeColors	参照

MonthBackColor プロパティは，カレンダーの背景色です。

property MonthBackColor: TColor;

説明

MonthBackColor プロパティは，カレンダーの主要部分（日付が表示されるところ）の背景色を決定します。


TDateTimeColors.TextColor
TDateTimeColors.TextColor3174006

TDateTimeColors	参照

TextColor プロパティは，表示されている月の日付に使われているフォントの色です。

property TextColor: TColor;

説明

TextColor プロパティは，表示されている月の日付（数字）の色を決定します。前月の最終週と，次月の第一週の日付の色を設定するには，TrailingTextColor を使います。


TDateTimeColors.TitleBackColor
TDateTimeColors.TitleBackColor3174007

TDateTimeColors	参照

TitleBackColor プロパティは，カレンダーのタイトルバーの背景色です。

property TitleBackColor: TColor;

説明

TitleBackColor プロパティは，タイトルバー（カレンダーの主要部分の上にあたる）の色を決定します。タイトルバーには年と月が表示されます。


TDateTimeColors.TitleTextColor
TDateTimeColors.TitleTextColor3174008

TDateTimeColors	参照

TitleTextColor プロパティは，カレンダーのタイトルバーに使われるフォントの色です。

property TitleTextColor: TColor;

説明

TitleTextColor プロパティは，カレンダーのタイトルバーに表示される年と月の色を決定します。


TDateTimeColors.TrailingTextColor
TDateTimeColors.TrailingTextColor3174009

TDateTimeColors	参照

TrailingTextColor プロパティは，現在の表示月でない月の日付に使われているフォントの色です。

property TrailingTextColor: TColor;

説明

TrailingTextColor プロパティは，前月の最終週または次月の第一週の日付（数字）の色を決定します。


TDateTimeColors のメソッド3174010

TDateTimeColors	アルファベット順

TDateTimeColors

Assign

Create

TPersistent からの継承

Destroy

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDateTimeColors のメソッド3174011

TDateTimeColors	オブジェクト順

Assign

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TDateTimeColors.Assign
TDateTimeColors.Assign3174012

TDateTimeColors	参照

Assign メソッドは，別の TDateTimePicker のインスタンスからプロパティをコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドを呼び出すと，別の TDateTimePicker の内容を新しいオブジェクトにコピーすることができます。


TDateTimeColors.Create
TDateTimeColors.Create3174013

TDateTimeColors

Create メソッドは，TDateTimeColors のインスタンスを作成し初期化します。

constructor Create(AOwner: TDateTimePicker);

説明

Create メソッドは TDateTimeColor オブジェクトを作成し，そのプロパティを初期化します。


スコープ3174014

published


継承3174015

TObject

TPersistent


TDateTimeColors の例3174016

TDateTimeColors


TDateTimePicker
TDateTimePicker3175001

継承	プロパティ	メソッド	イベント	参照

TDateTimePicker は日付または時刻を入力するリストボックスを表示します。

ユニット

comctrls

説明

TDateTimePicker は，特に日付と時刻を入力するために設計されたビジュアルコンポーネントです。DateMode プロパティが dmComboBox の場合は，カレンダーのイラストが付いたドロップダウンリストが配置されている点を除けばリストボックスやコンボボックスに似ています。ユーザーはそのカレンダーから日付を選択できます。日付または時刻も矢印キーでスクロールするかタイプすることで選択することができます。


TDateTimePicker プロパティ3175002

TDateTimePicker	アルファベット順	凡例

TDateTimePicker

CalAlignment

CalColors

Checked

Date

DateFormat

DateMode

Kind

MaxDate

MinDate

ParseInput

ShowCheckbox

Time

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ImeMode

ImeName

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TDateTimePicker プロパティ3175003

TDateTimePicker	オブジェクト順	凡例

Align

BoundsRect

Brush

CalAlignment

CalColors

Checked

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

Date

DateFormat

DateMode

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

Kind

Left

MaxDate

MinDate

Name

Owner

Parent

ParentColor

ParentFont

ParentShowHint

ParentWindow

ParseInput

PopupMenu

ShowCheckbox

ShowHint

Showing

TabOrder

TabStop

Tag

Time

Top

VCLComObject

Visible

Width

WindowProc


TDateTimePicker.CalAlignment
TDateTimePicker.CalAlignment3175004

TDateTimePicker	参照

CalAlignment プロパティは，ドロップダウンカレンダーの配置を決めます。

TDTCalAlignment = (dtaLeft, dtaRight);

property CalAlignment: TDTCalAlignment;

説明

CalAlignment プロパティを dtaLeft または dtaRight に設定すると，ドロップダウンカレンダーをコンポーネントの左側または右側に位置揃えできます。このプロパティは Kind = dtkDate かつ DateMode = dmComboBox の場合にのみ適用可能で，TDateTimePicker コンポーネントがドロップダウンカレンダーより大きい場合を除いてはほとんど違いがありません。


TDateTimePicker.CalColors
TDateTimePicker.CalColors3175005

TDateTimePicker	参照

CalColors プロパティは，ドロップダウンカレンダーの色を決めます。

property CalColors: TDateTimeColors;

説明

CalColors プロパティはドロップダウンカレンダーの色を定義する TDateTimeColors オブジェクトを指します。カレンダーの色を最も簡単に選択するには，オブジェクトインスペクタで CalColors を編集します。このプロパティは Kind = dtkDate かつ DateMode = dmComboBox の場合にのみ適用できます。


TDateTimePicker.Checked
TDateTimePicker.Checked3175006

TDateTimePicker	参照

Checked プロパティは，日付または時刻の前のチェックボックスが選択されたかどうかを示します。

property Checked: Boolean;

説明

Checked は TDateTimePicker コンポーネントのチェックボックスが選択された場合に True を返します。設計時に Checked を True に設定すると，デフォルトで選択されたチェックボックスが表示されます。


TDateTimePicker.Date
TDateTimePicker.Date3175007

TDateTimePicker	参照

Date プロパティは，ユーザーが入力した日付です。

TDate = type TDateTime;

property Date: TDate;

説明

Date プロパティは，ユーザーが入力した日付を表します。プログラムコードまたはオブジェクトインスペクタで Date を設定すると，日付がデフォルトで選択されたかどうかを判別できます（Kind = dtkDate の場合にのみ適用可能）。


TDateTimePicker.DateFormat
TDateTimePicker.DateFormat3175008

TDateTimePicker	参照

DateFormat プロパティは，日付を表す書式です。

TDTDateFormat = (dfShort, dfLong);

property DateFormat: TDTDateFormat;

説明

DateFormat を dfShort に設定すると，日付は 97/3/21 のように表示されます。DateFormat を dfLong に設定すると日付は 1997年3月21日のように表示されます（Windows の日付形式が使用されます）。


TDateTimePicker.DateMode
TDateTimePicker.DateMode3175009

TDateTimePicker	参照

DateMode プロパティは，コンポーネントが日付の選択に使うメソッドを決めます。

TDTDateMode = (dmComboBox, dmUpDown);

property DateMode: TDTDateMode;

説明

DateMode プロパティが dmComboBox の場合，コンポーネントは日付を選択できるドロップダウンカレンダーを持ちます（Kind = dtkDate の場合のみ）。DateMode が dmUpDown の場合，コンポーネントには日付を調整するための上下の矢印が付きます。


TDateTimePicker.Kind
TDateTimePicker.Kind3175010

TDateTimePicker	参照

Kind プロパティは，コンポーネントが日付を扱うか時刻を扱うかを決めます。

TDateTimeKind = (dtkDate, dtkTime);

property Kind: TDateTimeKind;

説明

Kind が dtkDate ならばコンポーネントは日付を選択するのに使い，Kind が dtkTime ならば時刻を選択するのに使います。


TDateTimePicker.MaxDate
TDateTimePicker.MaxDate3175011

TDateTimePicker	参照

Maxdate プロパティは，入力できる一番新しい日付です。

TDate = type TDateTime;

property MaxDate: TDate;

説明

MaxDate プロパティに値を代入するとユーザーが入力できる日付の範囲を制限できます。範囲を超えた日付を入力すると EDateTimeError 例外が生成されます（Kind = dtkDate の場合のみ）。


TDateTimePicker.MinDate
TDateTimePicker.MinDate3175012

TDateTimePicker	参照

MinDate プロパティは，入力できる一番古い日付です。

TDate = type TDateTime;

property MinDate: TDate;

説明

MinDate プロパティに値を代入するとユーザーが入力できる日付の範囲を制限できます。範囲を超えた日付を入力すると EDateTimeError 例外が生成されます（Kind = dtkDate に場合のみ）。


TDateTimePicker.ParseInput
TDateTimePicker.ParseInput3175013

TDateTimePicker	参照

ParseInput プロパティは，OnUserInput イベントを使用可能にします。

property ParseInput: Boolean;

説明

ParseInput プロパティが True の場合，OnUserInput イベントはユーザーがコンポーネントの編集ボックスに入力したときに発生します。


TDateTimePicker.ShowCheckbox
TDateTimePicker.ShowCheckbox3175014

TDateTimePicker	参照

ShowCheckbox プロパティは，日付または時刻の前にチェックボックスを表示します。

property ShowCheckbox: Boolean;

説明

ShowCheckbox プロパティを True に設定すると TDateTimePicker コンポーネントにチェックボックスを表示できます。


TDateTimePicker.Time
TDateTimePicker.Time3175015

TDateTimePicker	参照

Time プロパティは，ユーザーが入力した時刻です。

TTime = type TDateTime;

property Time: TTime;

説明

Time はユーザーが入力した時刻を表します（Kind = dtkTime の場合にのみ）。


TDateTimePicker イベント3175016

TDateTimePicker	アルファベット順	凡例

TDateTimePicker

OnChange

OnCloseUp

OnDropDown

OnUserInput

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnStartDrag


TDateTimePicker イベント3175017

TDateTimePicker	オブジェクト順	凡例

OnChange

OnClick

OnCloseUp

OnDblClick

OnDragDrop

OnDragOver

OnDropDown

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnStartDrag

OnUserInput


TDateTimePicker.OnChange
TDateTimePicker.OnChange3175018

TDateTimePicker	参照

OnChange イベントは，日付または時刻が入力されると発生します。

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラを記述するとコンポーネントで入力された日付または時刻が変更されたときに特定のアクションを実行できます。


TDateTimePicker.OnCloseUp
TDateTimePicker.OnCloseUp3175019

TDateTimePicker	参照

OnCloseUp イベントは，ドロップダウンカレンダーが閉じると発生します。

property OnCloseUp: TNotifyEvent;

説明

OnCloseUp イベントハンドラを記述するとドロップダウンカレンダー閉じるときにのみ発生する必要がある特別な処理を実現できます。


TDateTimePicker.OnDropDown
TDateTimePicker.OnDropDown3175020

TDateTimePicker	参照

OnDropDown イベントは，ユーザーがコントロールの右側の矢印をクリックしてドロップダウンカレンダーを開いたときに発生します。

property OnDropDown: TNotifyEvent;

説明

OnDropDown を記述するとドロップダウンカレンダーを開いたときにだけ必要な特別な処理を実装できます。


TDateTimePicker.OnUserInput
TDateTimePicker.OnUserInput3175021

TDateTimePicker	参照

OnUserInput イベントは，ユーザーが直接コンポーネントの編集ボックスに入力したときに発生します。

TDTParseInputEvent = procedure(Sender: TObject; const UserString: string;

var DateAndTime: TDateTime; var AllowChange: Boolean) of object;

property OnUserInput: TDTParseInputEvent;

説明

OnUserInput イベントは，ParseInput が True に設定されている場合にのみ発生します。OnUserInput イベントハンドラを記述すると，ユーザーが（ドロップダウンカレンダーから選択したり矢印をスクロールしたりするのではなく）TDateTimePicker に直接入力した場合に処理する必要があるコードを実装できます。UserString はユーザーが入力する文字列です。


TDateTimePicker メソッド3175022

TDateTimePicker	アルファベット順

TDateTimePicker

Create

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TDateTimePicker メソッド3175023

TDateTimePicker	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TDateTimePicker.Create
TDateTimePicker.Create3175024

TDateTimePicker	参照

Create メソッドは，TDateTimePicker のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは，継承されたコンストラクタを呼び出して Date プロパティと Time プロパティを現在の日付と時刻に初期化します。また、ControlStyle のフラグ（csCaptureMouse，csOpaque，csClickEvents，csDoubleClicks，および csFixedHeight）を設定します。


TDateTimePicker.Destroy
TDateTimePicker.Destroy3175025

TDateTimePicker	参照

Destroy メソッドは，TDateTimePicker のインスタンスを破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはコントロールが破棄されていないことを確認してからのみ Destroy メソッドを呼び出します。


スコープ3175026

published

読み出し／書き込み

読み出し専用


スコープ3175027

published


継承3175028

TObject

TPersistent

TComponent

TControl

TWinControl


TDateTimePicker 例3175029

TDateTimePicker


EAbort
EAbort3176001

継承	プロパティ	メソッド	参照

EAbort はサイレント例外クラスです。エラーが生成されても，その旨を伝えるメッセージボックスは表示されません。

ユニット

sysutils

説明

EAbort を呼び出すと，例外が生成された場合でもダイアログボックスにエラーメッセージは表示されません。こうした「サイレント」例外がアプリケーションプログラムでトラップされない場合には，EAbort 例外は TApplication.HandleException に渡されます。

また，EAbort 例外を生成するもっとも容易な方法は Abort 手続きを呼び出すことです。


EAbort プロパティ3176002

EAbort	アルファベット順

Exception からの継承

HelpContext

Message


EAbort プロパティ3176003

EAbort	オブジェクト順

HelpContext

Message


EAbort メソッド3176004

EAbort	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EAbort メソッド3176005

EAbort	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3176006

TObject

Exception


EAbort 例3176007

EAbort


EAbstractError
EAbstractError3177001

継承	プロパティ	メソッド

EAbstractError は，抽象メソッドを呼び出そうとした場合の例外クラスです。

ユニット

sysutils

説明

EAbstractError は，アプリケーションが抽象メソッドを呼び出そうとすると生成されます。また，設計時に抽象メソッドを持つコンポーネントをフォームに配置した場合にも生成されます。

抽象メソッドは，abstract 疑似命令を使って宣言し，インスタンスオブジェクトが作成される前に派生クラスでオーバーライドされなければなりません。


EAbstractError のプロパティ3177002

EAbstractError	アルファベット順

Exception からの継承

HelpContext

Message


EAbstractError のプロパティ3177003

EAbstractError	オブジェクト順

HelpContext

Message


EAbstractError のメソッド3177004

EAbstractError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EAbstractError のメソッド3177005

EAbstractError	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3177006

TObject

Exception


EAbstractError の例3177007

EAbstractError


EAccessViolation
EAccessViolation3178001

継承	プロパティ	メソッド	参照

EAccessViolation は，メモリ領域への無効なアクセスが検出されたときに生成される例外クラスです。

ユニット

sysutils

説明

EAccessViolation 例外は，アプリケーションで次のような動作を実行した場合に生成されます。

・	nil ポインタを逆参照した場合

・	コードページに書き込もうとした場合

・	そのアプリケーションに対して仮想メモリが割り当てられていないメモリアドレスにアクセスしようとした場合

注意

EAccessViolation 例外をアプリケーションから生成することはせず，例外の生成はランタイムライブラリに任せるようにしてください。


EAccessViolation プロパティ3178002

EAccessViolation	アルファベット順

Exception からの継承

HelpContext

Message


EAccessViolation プロパティ3178003

EAccessViolation	オブジェクト順

HelpContext

Message


EAccessViolation メソッド3178004

EAccessViolation	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EAccessViolation メソッド3178005

EAccessViolation	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3178006

TObject

Exception


EAccessViolation 例3178007

EAccessViolation


EAssertionFailed
EAssertionFailed3179001

継承	プロパティ	メソッド	参照

EAssertionFailed は，False を返す Boolean 式で実行された Assert 手続きの例外クラスです。

ユニット

sysutils

説明

EAssertionFailed は，アプリケーションが Assert 手続きに False の値を持つ Boolean 式を渡すと Assert 手続きによって生成されます。例外が生成されるのは，$ASSERTIONS ON コンパイラ疑似命令が有効な場合だけです。


EAssertionFailed のプロパティ3179002

EAssertionFailed	アルファベット順

Exception からの継承

HelpContext

Message


EAssertionFailed のプロパティ3179003

EAssertionFailed	オブジェクト順

HelpContext

Message


EAssertionFailed のメソッド3179004

EAssertionFailed	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EAssertionFailed のメソッド3179005

EAssertionFailed	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3179006

TObject

Exception


EAssertionFailed の例3179007

EAssertionFailed


EBitsError
EBitsError3180001

継承	プロパティ	メソッド	参照

EBitsError は，論理値の配列に無効なアクセスを行うと生成される例外クラスです。

ユニット

classes

説明

EBitsError 例外は，アプリケーションが大きすぎるか小さすぎるインデックス値を使って論理値の配列（TBits クラスのインスタンス）にアクセスしようとしたときに生成されます。これは，Bits プロパティの Index パラメータが次の値のときに発生します。

・	ゼロ未満の値

・	Size プロパティ以上の値


EBitsError プロパティ3180002

EBitsError	アルファベット順

Exception からの継承

HelpContext

Message


EBitsError プロパティ3180003

EBitsError	オブジェクト順

HelpContext

Message


EBitsError メソッド3180004

EBitsError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EBitsError メソッド3180005

EBitsError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3180006

TObject

Exception


EBitsError 例3180007

EBitsError


EClassNotFound
EClassNotFound3181001

継承	プロパティ	メソッド	参照

EClassNotFound は，ストリームからの読み出しを行っているときに指定のコンポーネントが見つからなかった場合に生成される例外クラスです。

ユニット

classes

説明

EClassNotFound 例外は，ストリームからの読み出しを行っているときに，現在のアプリケーションにリンクされていないクラス名が読み込まれた場合に生成されます。これは，フォーム上にはコンポーネントがあるのに，その型宣言からはコンポーネントが削除されているという場合に発生します。


EClassNotFound プロパティ3181002

EClassNotFound	アルファベット順

Exception からの継承

HelpContext

Message


EClassNotFound プロパティ3181003

EClassNotFound	オブジェクト順

HelpContext

Message


EClassNotFound メソッド3181004

EClassNotFound	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EClassNotFound メソッド3181005

EClassNotFound	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3181006

TObject

Exception

EStreamError

EFilerError


EClassNotFound 例3181007

EClassNotFound


EConvertError
EConvertError3182001

継承	プロパティ	メソッド	参照

EConvertError は，文字列やオブジェクトを正しく変換できなかったときに生成される例外クラスです。

ユニット

sysutils

説明

EConvertError は，次のような場合に生成されます。

・	アプリケーションで，整数，浮動小数点値，日付，または時間を文字列に変換できなかった場合，またはその逆の変換ができなかった場合

・	アプリケーションから書式化ルーチンに無効な引数を渡した場合

・	アプリケーションで TPersistent から派生したコンポーネントを，TPersistent から派生した別のコンポーネントに割り当てようとしたが，そうした割り当てができない場合。たとえば，TButton コントロールを TEdit コントロールに割り当てようとすると，EConvertError 例外が生成される


EConvertError プロパティ3182002

EConvertError	アルファベット順

Exception からの継承

HelpContext

Message


EConvertError プロパティ3182003

EConvertError	オブジェクト順

HelpContext

Message


EConvertError メソッド3182004

EConvertError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EConvertError メソッド3182005

EConvertError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3182006

TObject

Exception


EConvertError 例3182007

EConvertError


EComponentError
EComponentError3183001

継承	プロパティ	メソッド	参照

EComponentError は，コンポーネントを登録したりコンポーネント名を変更したときに生成される例外クラスです。

ユニット

classes

説明

EComponentError 例外は，次のような場合に生成されます。

・	Delphi でコンポーネントを登録できない場合

・	アプリケーションでコンポーネント名を変更できない場合

・	COM をサポートしていないコンポーネントの COM インターフェースを検出するように要求された場合

コンポーネントを登録するには，そのコンポーネントのユニットファイルのインターフェースセクションに「Register」という手続きが必要です。この手続きでは，登録するコンポーネントごとに RegisterComponents を呼び出さなければなりません。

アプリケーションが実行時にコンポーネント名を別のコンポーネントと同じ名前や無効なObject Pascal 識別子に変更した場合には，コンポーネント名は変更できません。


EComponentError プロパティ3183002

EComponentError	アルファベット順

Exception からの継承

HelpContext

Message


EComponentError プロパティ3183003

EComponentError	オブジェクト順

HelpContext

Message


EComponentError メソッド3183004

EComponentError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EComponentError メソッド3183005

EComponentError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3183006

TObject

Exception


EComponentError 例3183007

EComponentError


EControlC
EControlC3184001

継承	プロパティ	メソッド

EControlC は，コンソールモードのアプリケーションを実行中に〔Ctrl〕+〔C〕を押したときに生成される例外クラスです。

ユニット

sysutils

説明

EControlC 例外は，〔Ctrl〕+〔C〕を押してコンソールモードのアプリケーションを終了したときに生成されます。


EControlC プロパティ3184002

EControlC	アルファベット順

Exception からの継承

HelpContext

Message


EControlC プロパティ3184003

EControlC	オブジェクト順

HelpContext

Message


EControlC メソッド3184004

EControlC	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EControlC メソッド3184005

EControlC	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3184006

TObject

Exception


EControlC 例3184007

EControlC


EDatabaseError
EDatabaseError3185001

継承	プロパティ	メソッド	参照

EDatabaseError はデータベースエラー例外クラスです。

ユニット

db

説明

EDatabaseError 例外は，コンポーネントがデータベースエラーを検出したときに生成されます。EDatabaseError 例外は，例外処理ブロックや，データベース例外の作成に使います。


EDatabaseError プロパティ3185002

EDatabaseError	アルファベット順

Exception からの継承

HelpContext

Message


EDatabaseError プロパティ3185003

EDatabaseError	オブジェクト順

HelpContext

Message


EDatabaseError メソッド3185004

EDatabaseError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EDatabaseError メソッド3185005

EDatabaseError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3185006

TObject

Exception


EDatabaseError 例3185007

EDatabaseError


EDBClient
EDBClient3186001

継承	プロパティ	メソッド	参照

EDBClient は，クライアントデータセットエラーの例外クラスです。

ユニット

dbclient

説明

EDBClient は，アプリケーションが TClientDataSet を使っているときにエラーが発生すると生成されます。


EDBClient のプロパティ3186002

EDBClient	アルファベット順	凡例

EDBClient

ErrorCode

Exception からの継承

HelpContext

Message


EDBClient のプロパティ3186003

EDBClient	オブジェクト順	凡例

ErrorCode

HelpContext

Message


EDBClient.ErrorCode
EDBClient.ErrorCode3186004

EDBClient	参照

ErrorCode プロパティは，BDE が返すエラーコードを示します。

property ErrorCode: DBIResult;

説明

ErrorCode プロパティは，BDE が返すエラーコードを示します。

DBIResult は，DBIError 手続きが BDE のエラーコードを保持するのに使う特殊な整数型です。


EDBClient のメソッド3186005

EDBClient	アルファベット順

EDBClient

Create

Exception からの継承

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EDBClient のメソッド3186006

EDBClient	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EDBClient.Create
EDBClient.Create3186007

EDBClient

Create メソッドは，BDE が返すエラー情報を使って EDBClient のインスタンスを初期化します。

constructor Create(Message: string; ErrorCode: DBIResult);

説明

Create メソッドは，EDBClient オブジェクトを生成します。


アクセス種別3186008

読み出し専用


継承3186009

TObject

Exception

EDatabaseError


EDBClient の例3186010

EDBClient


EDBEditError
EDBEditError3187001

継承	プロパティ	メソッド	参照

EDBEditError は，指定したマスクとデータの間に互換性がない場合に生成される例外クラスです。

ユニット

mask

説明

EDBEditError 例外は，フィールドに指定したマスクと互換性がないデータをアプリケーションで使用すると生成されます。

マスクは，編集ボックスやデータフィールドに挿入できるデータを制限します。マスクを指定するには，EditMask プロパティを使用します。


EDBEditError プロパティ3187002

EDBEditError	アルファベット順

Exception からの継承

HelpContext

Message


EDBEditError プロパティ3187003

EDBEditError	オブジェクト順

HelpContext

Message


EDBEditError メソッド3187004

EDBEditError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EDBEditError メソッド3187005

EDBEditError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3187006

TObject

Exception


EDBEditError 例3187007

EDBEditError


EDBEngineError
EDBEngineError3188001

継承	プロパティ	メソッド	参照

EDBEngineError は，ボーランドデータベースエンジンのエラーによって生成される例外クラスです。

ユニット

dbtables

説明

EDBEngineError 例外は，BDE エラーが発生するたびに生成されます。この例外の Errors プロパティには，TDBError オブジェクトが含まれています。


EDBEngineError プロパティ3188002

EDBEngineError	アルファベット順	凡例

EDBEngineError

ErrorCount

Errors

Exception からの継承

HelpContext

Message


EDBEngineError プロパティ3188003

EDBEngineError	オブジェクト順	凡例

ErrorCount

Errors

HelpContext

Message


EDBEngineError.ErrorCount
EDBEngineError.ErrorCount3188004

EDBEngineError

ErrorCount プロパティは，Errors プロパティに含まれるエラーの総数を示します。

property ErrorCount: Integer;


EDBEngineError.Errors
EDBEngineError.Errors3188005

EDBEngineError	参照

Errors プロパティは，ボーランドデータベースエンジンのエラースタックの全リストを示します。

property Errors[Index: Integer]: TDBError;

説明

Errors プロパティは TDBError オブジェクトのインデックスです。最初のエラーのインデックス値は 0 になります。


EDBEngineError メソッド3188006

EDBEngineError	アルファベット順

EDBEngineError

Create

Destroy

Exception からの継承

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EDBEngineError メソッド3188007

EDBEngineError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EDBEngineError.Create
EDBEngineError.Create3188008

EDBEngineError	参照

Create メソッドは，指定した BDE エラーコードを使って EDBEngineError のインスタンスを作成します。

constructor EDBEngineError.Create(ErrorCode: DBIResult);

説明

Create メソッドは，Exception オブジェクトから継承された Create メソッドを呼び出し（空白の文字列を使用），EDBEngineError の初期化済みのインスタンスを作成します。次に，BDE エラースタックの各エラーの TDBError インスタンスを作成し，すべてのエラーメッセージが含まれた文字列を 1 つ作成します。Create を呼び出したときに BDE が初期化されていない場合には，汎用エラーメッセージが 1 つと TDBError インスタンスが 1 つだけ生成されます。


EDBEngineError.Destroy
EDBEngineError.Destroy3188009

EDBEngineError	参照

Destroy メソッドは，EDBEngineError インスタンスと各 TDBError インスタンスを廃棄します。

destructor EDBEngineError.Destroy;

説明

Destroy メソッドは，Errors プロパティで参照された各 TDBError インスタンスを最初に廃棄します。次に，継承された Destroy メソッドが呼び出され，EDBEngineError インスタンス自体が廃棄されます。


読み出し／書き込み3188010

読み出し専用


継承3188011

TObject

Exception

EDatabaseError


EDBEngineError 例3188012

EDBEngineError


TEdit
TEdit3189001

継承	プロパティ	メソッド	イベント	参照	例

TEdit オブジェクトは Windows の 1 行編集コントロールのラッパーです。

ユニット

stdctrls

説明

TEdit オブジェクトを使うと，標準的な Windows 編集コントロールをフォーム上に配置できます。編集コントロールを使うと，入力されたテキストを取り出すことができます。編集コントロールはテキストを表示することもできます。

テキストを表示するだけの場合，そのテキストを選択してクリップボードにコピーできるようにするには編集コントロールを使います。このような編集コントロールの機能が不要の場合は，ラベルオブジェクトを使ってテキストを表示します。

TEdit オブジェクトは，TCustomEdit オブジェクトで導入される汎用の動作を実現しています。TEdit オブジェクトは TCustomEdit オブジェクトからの継承プロパティの多くをパブリッシュしますが，新しい動作を導入することはありません。特殊な編集コントロールについては，TCustomEdit オブジェクトの下位クラスを使うか，TCustomEdit オブジェクトからクラスを派生させます。


TEdit プロパティ3189002

TEdit	アルファベット順	凡例

TCustomEdit からの継承

AutoSelect

AutoSize

BorderStyle

CharCase

HideSelection

MaxLength

Modified

OEMConvert

PasswordChar

ReadOnly

SelLength

SelStart

SelText

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Text

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TEdit プロパティ3189003

TEdit	オブジェクト順	凡例

Align

AutoSelect

AutoSize

BorderStyle

BoundsRect

Brush

CharCase

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

HideSelection

Hint

ImeMode

ImeName

Left

MaxLength

Modified

Name

OEMConvert

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PasswordChar

PopupMenu

ReadOnly

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

Width

WindowProc


TEdit イベント3189004

TEdit	アルファベット順	凡例

TCustomEdit からの継承

OnChange

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TEdit イベント3189005

TEdit	オブジェクト順	凡例

OnChange

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TEdit メソッド3189006

TEdit	アルファベット順

TCustomEdit からの継承

Clear

ClearSelection

CopyToClipboard

Create

CutToClipboard

GetSelTextBuf

PasteFromClipboard

SelectAll

SetSelTextBuf

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TEdit メソッド3189007

TEdit	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClearSelection

ClientToScreen

ContainsControl

ControlAtPos

CopyToClipboard

Create

CreateParented

CutToClipboard

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetSelTextBuf

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

PasteFromClipboard

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetSelTextBuf

SetTextBuf

Show

Update

UpdateControlState


スコープ3189008

published

読み出し／書き込み

読み出し専用


スコープ3189009

published


継承3189010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomEdit


TEdit 例3189011

TEdit


EDivByZero
EDivByZero3190001

継承	プロパティ	メソッド	参照

EDivByZero は，整数のゼロ除算エラーによって生成される例外クラスです。

ユニット

sysutils

説明

EDivByZero 例外は，アプリケーションが整数型を 0 で除算しようとすると発生します。実際には，このエラーは簡単にトラップでき，try...except ブロックで修正できます。

注意

浮動小数点値のゼロ除算エラーの場合は，EZeroDivide 例外が生成されます。


EDivByZero プロパティ3190002

EDivByZero	アルファベット順

Exception からの継承

HelpContext

Message


EDivByZero プロパティ3190003

EDivByZero	オブジェクト順

HelpContext

Message


EDivByZero メソッド3190004

EDivByZero	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EDivByZero メソッド3190005

EDivByZero	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3190006

TObject

Exception

EIntError


EDivByZero 例3190007

EDivByZero


EDateTimeError
EDateTimeError3191001

継承	プロパティ	メソッド	参照

EDateTimeError は，無効な日付時刻の入力に対する例外クラスです。

ユニット

comctrls

説明

EDateTimeError は，無効な日付時刻が入力されると TDateTimePicker によって生成されます。


EDateTimeError のプロパティ3191002

EDateTimeError	アルファベット順

Exception からの継承

HelpContext

Message


EDateTimeError のプロパティ3191003

EDateTimeError	オブジェクト順

HelpContext

Message


EDateTimeError のメソッド3191004

EDateTimeError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EDateTimeError のメソッド3191005

EDateTimeError	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3191006

TObject

Exception


EDateTimeError の例3191007

EDateTimeError


EExternalException
EExternalException3192001

継承	プロパティ	メソッド

EExternalException は，無効な例外コードによって生成される例外クラスです。

ユニット

sysutils

説明

EExternalException 例外は，Delphi が認識されない例外コードを検出したときに生成されます。認識される例外コードは次のとおりです。

・	STATUS_INTEGER_DIVIDE_BY_ZERO

・	STATUS_ARRAY_BOUNDS_EXCEEDED

・	STATUS_FLOAT_OVERFLOW

・	STATUS_FLOAT_INEXACT_RESULT

・	STATUS_FLOAT_INVALID_OPERATION

・	STATUS_FLOAT_STACK_CHECK

・	STATUS_FLOAT_DIVIDE_BY_ZERO

・	STATUS_INTEGER_OVERFLOW

・	STATUS_FLOAT_UNDERFLOW

・	STATUS_FLOAT_DENORMAL_OPERAND

・	STATUS_ACCESS_VIOLATION

・	STATUS_PRIVILEGED_INSTRUCTION

・	STATUS_CONTROL_C_EXIT

・	STATUS_STACK_OVERFLOW

上記以外の例外コードが検出されると，EExternalException 例外が生成されます。


EExternalException プロパティ3192002

EExternalException	アルファベット順

Exception からの継承

HelpContext

Message


EExternalException プロパティ3192003

EExternalException	オブジェクト順

HelpContext

Message


EExternalException メソッド3192004

EExternalException	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EExternalException メソッド3192005

EExternalException	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3192006

TObject

Exception


EExternalException 例3192007

EExternalException


EFCreateError
EFCreateError3193001

継承	プロパティ	メソッド	参照

EFCreateError は，ストリーミングファイルの作成時にエラーが発生すると生成される例外クラスです。

ユニット

classes

説明

EFCreateError 例外は，アプリケーションでファイルを作成できなかったときに生成されます。たとえば，無効なファイル名を指定したり，適切なアクセス権がないため上書きできない既存のファイル名を指定すると，このエラーが発生します。


EFCreateError プロパティ3193002

EFCreateError	アルファベット順

Exception からの継承

HelpContext

Message


EFCreateError プロパティ3193003

EFCreateError	オブジェクト順

HelpContext

Message


EFCreateError メソッド3193004

EFCreateError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EFCreateError メソッド3193005

EFCreateError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3193006

TObject

Exception

EStreamError


EFCreateError 例3193007

EFCreateError


EFilerError
EFilerError3194001

継承	プロパティ	メソッド	参照

EFilerError は，ファイルストリームのエラーによって生成される例外クラスです。

ユニット

classes

説明

EFilerError 例外は，同じクラスを 2 回登録しようとすると生成されます。

ストリームの読み書き時に発生する次の例外の親でもあります。

例外	説明

EReadError	指定したバイト数を読み出せない

EWriteError	指定したバイト数を書き込めない

EClassNotFound	コンポーネントがアプリケーションにリンクしていない

EInvalidImage	リソースファイルを読み出せない

EMethodNotFound	メソッドの実装コードが見つからない


EFilerError プロパティ3194002

EFilerError	アルファベット順

Exception からの継承

HelpContext

Message


EFilerError プロパティ3194003

EFilerError	オブジェクト順

HelpContext

Message


EFilerError メソッド3194004

EFilerError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EFilerError メソッド3194005

EFilerError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3194006

TObject

Exception

EStreamError


EFilerError 例3194007

EFilerError


EFOpenError
EFOpenError3195001

継承	プロパティ	メソッド	参照

EFOpenError は，ストリーミング時のファイルのオープンエラーによって生成される例外クラスです。

ユニット

classes

説明

EFOpenError 例外は，アプリケーションが指定のファイルを開けない場合に生成されます。たとえば，ファイルが存在しない場合や検索しているディレクトリにファイルがない場合にこのエラーは発生します。


EFOpenError プロパティ3195002

EFOpenError	アルファベット順

Exception からの継承

HelpContext

Message


EFOpenError プロパティ3195003

EFOpenError	オブジェクト順

HelpContext

Message


EFOpenError メソッド3195004

EFOpenError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EFOpenError メソッド3195005

EFOpenError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3195006

TObject

Exception

EStreamError


EFOpenError 例3195007

EFOpenError


EIntfCastError
EIntfCastError3196001

継承	プロパティ	メソッド	参照

ユニット

sysutils

説明

EIntfCastError はインターフェースのキャスト例外の例外クラスです。

EIntfCastError は，アプリケーションが演算子を使ってインターフェースを不正に型キャストしようとすると生成されます。


EIntfCastError のプロパティ3196002

EIntfCastError	アルファベット順

Exception からの継承

HelpContext

Message


EIntfCastError のプロパティ3196003

EIntfCastError	オブジェクト順

HelpContext

Message


EIntfCastError のメソッド3196004

EIntfCastError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EIntfCastError のメソッド3196005

EIntfCastError	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3196006

TObject

Exception


EIntfCastError の例3196007

EIntfCastError


EInOutError
EInOutError3197001

継承	プロパティ	メソッド	参照

EInOutError は，ファイルの入出力エラーによって生成される例外クラスです。

ユニット

sysutils

説明

EInOutError 例外は，ファイル入出力オペレーティングシステムエラーが発生するたびに生成されます。ただし，$I+ コンパイラ指令が設定されている場合に限ります。結果のエラーコードはローカルな ErrorCode 変数として返され，次のような値となります。

エラーコード	意味

2	ファイルが見つからない

3	ファイル名が無効

4	開いているファイルが多すぎる

5	アクセスできない

100	ファイルの最後に到達した

101	ディスクに空き容量がない

106	入力値が無効

注意

アプリケーションが $I- 状態にあるときに入出力エラーが発生した場合，アプリケーションはエラーをクリアするため IOResult 関数を呼び出さなくてはなりません。


EInOutError プロパティ3197002

EInOutError	アルファベット順

Exception からの継承

HelpContext

Message


EInOutError プロパティ3197003

EInOutError	オブジェクト順

HelpContext

Message


EInOutError メソッド3197004

EInOutError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


EInOutError メソッド3197005

EInOutError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


継承3197006

TObject

Exception


EInOutError 例3197007

EInOutError


EIntError
EIntError3198001

継承	プロパティ	メソッド	参照

EIntError は，整数値演算エラー例外の基本となるクラスです。

ユニット

sysutils

説明

EIntError は，汎用的な整数値演算例外です。ランタイムライブラリでは生成されませんが，この例外からそれ以外の整数値演算例外が派生します。次の整数値演算例外があります。

例外	意味

EDivByZero	ゼロで除算しようとした

ERangeError	範囲外の数値または式

EIntOverflow	整数値演算がオーバーフローした


EIntError プロパティ3198002

EIntError	アルファベット順

Exception からの継承

HelpContext

Message


EIntError プロパティ3198003

EIntError	オブジェクト順

HelpContext

Message


EIntError メソッド3198004

EIntError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EIntError メソッド3198005

EIntError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3198006

TObject

Exception


EIntError 例3198007

EIntError


EIntOverflow
EIntOverflow3199001

継承	プロパティ	メソッド	参照

EIntOverflow は，整数値演算の結果が大きすぎて割り当てたレジスタに収容しきれない場合に生成される例外クラスです。

ユニット

sysutils

説明

EIntOverflow は整数値演算例外です。計算結果が大きすぎて割り当てたレジスタに収容しきれずデータを紛失した場合に発生します。

EIntOverflow 例外は，オーバーフローチェックがオンになっている場合だけ発生します。オーバーフローチェックをオンにするには，プロジェクトソースコードに $Q+ 指令を含めるか，または［プロジェクト(P)｜オプション(O)］で表示されるダイアログボックスの［コンパイラ］ページで［オーバーフローチェック(Q)］オプションを設定します。

注意

オーバーフローの発生はマシンのレジスタサイズに左右されます。Delphi の場合，16 ビットバージョンでも 32 ビットバージョンでもオーバーフローが発生することはまずありません。16 ビットプログラムで発生するような計算のオーバーフローが 32 ビットプログラムで発生することは少ないでしょう。32 ビットプログラムでは，そのかわりに範囲チェック例外が発生します。たとえば，割り当て前にオーバーフローが発生すると EIntOverflow エラーが発生します。割り当て時点でエラーがチェックされると，ERangeError が生成されます。

浮動小数点レジスタでオーバーフローが発生すると，EOverflow 例外が生成されます。


EIntOverflow プロパティ3199002

EIntOverflow	アルファベット順

Exception からの継承

HelpContext

Message


EIntOverflow プロパティ3199003

EIntOverflow	オブジェクト順

HelpContext

Message


EIntOverflow メソッド3199004

EIntOverflow	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EIntOverflow メソッド3199005

EIntOverflow	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3199006

TObject

Exception

EIntError


EIntOverflow 例3199007

EIntOverflow


EInvalidOp
EInvalidOp3200001

継承	プロパティ	メソッド	参照

EInvalidOp は，未定義の浮動小数点数値演算によって生成される例外クラスです。

ユニット

sysutils

説明

EInvalidOp 例外は，プロセッサが未定義の命令，無効な演算，または浮動小数点プロセッサスタックオーバーフローを検出すると発生します。

注意

このオブジェクトを EInvalidOperation オブジェクトと混同しないようにしてください。


EInvalidOp プロパティ3200002

EInvalidOp	アルファベット順

Exception からの継承

HelpContext

Message


EInvalidOp プロパティ3200003

EInvalidOp	オブジェクト順

HelpContext

Message


EInvalidOp メソッド3200004

EInvalidOp	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EInvalidOp メソッド3200005

EInvalidOp	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3200006

TObject

Exception

EMathError


EInvalidOp 例3200007

EInvalidOp


EInvalidCast
EInvalidCast3201001

継承	プロパティ	メソッド	参照

EInvalidCast は，型キャストエラーによって生成される例外クラスです。

ユニット

sysutils

説明

EInvalidCast 例外は，アプリケーションで as 演算子を使ってオブジェクトを別の型にキャストする場合，指定した型キャストが不当なときに発生します。たとえば次の式で AnObject が TObjectType と互換性のない型の場合，EInvalidCast 例外が生成されます。

AnObject as TObjectType


EInvalidCast プロパティ3201002

EInvalidCast	アルファベット順

Exception からの継承

HelpContext

Message


EInvalidCast プロパティ3201003

EInvalidCast	オブジェクト順

HelpContext

Message


EInvalidCast メソッド3201004

EInvalidCast	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

Tobject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EInvalidCast メソッド3201005

EInvalidCast	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3201006

TObject

Exception


EInvalidCast 例3201007

EInvalidCast


EInvalidGridOperation
EInvalidGridOperation3202001

継承	プロパティ	メソッド	参照

EInvalidGridOperation は，不当なグリッド操作によって生成される例外クラスです。

ユニット

grids

説明

EInvalidGridOperation 例外は，グリッドで不当な処理を試みると生成されます。たとえば，アプリケーションがグリッド内に存在しないセルやカラムにアクセスしようとすると生成されます。


EInvalidGridOperation プロパティ3202002

EInvalidGridOperation	アルファベット順

Exception からの継承

HelpContext

Message


EInvalidGridOperation プロパティ3202003

EInvalidGridOperation	オブジェクト順

HelpContext

Message


EInvalidGridOperation メソッド3202004

EInvalidGridOperation	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EInvalidGridOperation メソッド3202005

EInvalidGridOperation	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3202006

TObject

Exception


EInvalidGridOperation 例3202007

EInvalidGridOperation


EInvalidGraphicOperation
EInvalidGraphicOperation3203001

継承	プロパティ	メソッド	参照

EInvalidGraphicOperation は，グラフィックでの不当な処理によって生成される例外クラスです。

ユニット

graphics

説明

EInvalidGraphicOperation 例外は，グラフィックで不当な処理を試みると生成されます。たとえば，アプリケーションがアイコンのサイズを変更したり，アイコンをクリップボードにコピーしようとしたりすると，この例外が生成されます。


EInvalidGraphicOperation プロパティ3203002

EInvalidGraphicOperation	アルファベット順

Exception からの継承

HelpContext

Message


EInvalidGraphicOperation プロパティ3203003

EInvalidGraphicOperation	オブジェクト順

HelpContext

Message


EInvalidGraphicOperation メソッド3203004

EInvalidGraphicOperation	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EInvalidGraphicOperation メソッド3203005

EInvalidGraphicOperation	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3203006

TObject

Exception


EInvalidGraphicOperation 例3203007

EInvalidGraphicOperation


EInvalidGraphic
EInvalidGraphic3204001

継承	プロパティ	メソッド	参照

EInvalidGraphic は，認識されないグラフィックファイルによって生成される例外クラスです。

ユニット

graphics

説明

EInvalidGraphic 例外は，次のような場合に生成されます。

・	アプリケーションが，有効なビットマップ，アイコン，メタファイル，ユーザー定義のグラフィック型のいずれでもないファイルを画像として読み込もうとした場合

・	アプリケーションが認識されない拡張子のファイルを読み込もうとした場合

・	LoadFromClipboardFormat または SaveToClipboardFormat を呼び出すときに指定した形式と画像が一致しない場合。


EInvalidGraphic プロパティ3204002

EInvalidGraphic	アルファベット順

Exception からの継承

HelpContext

Message


EInvalidGraphic プロパティ3204003

EInvalidGraphic	オブジェクト順

HelpContext

Message


EInvalidGraphic メソッド3204004

EInvalidGraphic	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EInvalidGraphic メソッド3204005

EInvalidGraphic	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3204006

TObject

Exception


EInvalidGraphic 例3204007

EInvalidGraphic


EInvalidArgument
EInvalidArgument3205001

継承	プロパティ	メソッド	参照

EInvalidArgument は，数値演算や財務専用の関数のパラメータが範囲外であったときに生成される例外クラスです。

ユニット

math

説明

Math ユニットにある関数の一部（財務関数など）は，ルーチンに渡すパラメータの 1 つが範囲外であったり計算を未解決にしていると EInvalidArgument 例外を生成します。


EInvalidArgument プロパティ3205002

EInvalidArgument	アルファベット順

Exception からの継承

HelpContext

Message


EInvalidArgument プロパティ3205003

EInvalidArgument	オブジェクト順

HelpContext

Message


EInvalidArgument メソッド3205004

EInvalidArgument	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EInvalidArgument メソッド3205005

EInvalidArgument	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3205006

TObject

Exception

EMathError


EInvalidArgument 例3205007

EInvalidArgument


EInvalidImage
EInvalidImage3206001

継承	プロパティ	メソッド	参照

EInvalidImage は，リソースファイルを読み出せなかったときに生成される例外クラスです。

ユニット

classes

説明

EInvalidImage 例外は，アプリケーションがリソースファイルを読み出せない場合に生成されます。このエラーはほとんどの場合，指定したファイルがリソースファイルではないために発生します。

リソースファイルの読み出しエラーは，TStream オブジェクトの読み書きメソッドを正しく使わなかったときに発生します。WriteComponentRes メソッドで書き込んだコンポーネントを読み出すときは ReadComponentRes メソッドを使用し，WriteComponent メソッドで書き込んだコンポーネントを読み出すときは ReadComponent メソッドを使用します。読み書きの際に対になったメソッドを使用しないと，EInvalidImage 例外が生成されます。


EInvalidImage プロパティ3206002

EInvalidImage	アルファベット順

Exception からの継承

HelpContext

Message


EInvalidImage プロパティ3206003

EInvalidImage	オブジェクト順

HelpContext

Message


EInvalidImage メソッド3206004

EInvalidImage	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EInvalidImage メソッド3206005

EInvalidImage	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3206006

TObject

Exception

EStreamError

EFilerError


EInvalidImage 例3206007

EInvalidImage


EInvalidOperation
EInvalidOperation3207001

継承	プロパティ	メソッド	参照

EInvalidOperation は，コンポーネントに無効な処理を行ったときに生成される例外クラスです。

ユニット

classes

説明

ウィンドウハンドルを必要とする処理をアプリケーションが行い，コンポーネントに親がない（Parent = nil の）場合，EInvalidOperation 例外が生成されます。Form1.BeginDrag などのフォームでドラッグアンドドロップを行った場合も例外が生成されます。

注意

このオブジェクトを EInvalidOp オブジェクトと混同しないようにしてください。


EInvalidOperation プロパティ3207002

EInvalidOperation	アルファベット順

Exception からの継承

HelpContext

Message


EInvalidOperation プロパティ3207003

EInvalidOperation	オブジェクト順

HelpContext

Message


EInvalidOperation メソッド3207004

EInvalidOperation	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EInvalidOperation メソッド3207005

EInvalidOperation	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3207006

TObject

Exception


EInvalidOperation 例

EInvalidOperation


EInvalidPointer
EInvalidPointer3208001

継承	プロパティ	メソッド

EInvalidPointer は，無効なポインタ操作によって生成される例外クラスです。

ユニット

sysutils

説明

EInvalidPointer 例外は，アプリケーションが無効なポインタ操作をすると生成されます。たとえば同じポインタを 2 回破棄したり，すでに破棄したポインタを参照したりすると生成されます。


EInvalidPointer プロパティ3208002

EInvalidPointer	アルファベット順

Exception からの継承

HelpContext

Message


EInvalidPointer プロパティ3208003

EInvalidPointer	オブジェクト順

HelpContext

Message


EInvalidPointer メソッド3208004

EInvalidPointer	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EInvalidPointer メソッド3208005

EInvalidPointer	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3208006

TObject

Exception


EInvalidPointer 例3208007

EInvalidPointer


EListError
EListError3209001

継承	プロパティ	メソッド	参照

EListError は，リストや文字列のエラーによって生成される例外クラスです。

ユニット

classes

説明

EListError 例外は，リスト，文字列，TStringList のいずれかのオブジェクトでエラーが発生すると生成されます。リストエラー例外は，アプリケーションがリストの範囲外のリスト項目を参照すると発生します。

EListError 例外は，Duplicates プロパティの値が dupError のときに，アプリケーションが TStringList オブジェクトに重複文字列を追加した場合にも発生します。

また，ソートされた文字列リストに文字列を挿入するとき，指定された位置に文字列を挿入するとソート順が乱れる場合にも EListError 例外が生成されます。


EListError プロパティ3209002

EListError	アルファベット順

Exception からの継承

HelpContext

Message


EListError プロパティ3209003

EListError	オブジェクト順

HelpContext

Message


EListError メソッド3209004

EListError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EListError メソッド3209005

EListError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3209006

TObject

Exception


EListError 例3209007

EListError


EMathError
EMathError3210001

継承	プロパティ	メソッド	参照

EMathError は，浮動小数点数値演算エラーによって生成される例外クラスです。

ユニット

sysutils

説明

すべての浮動小数点数値演算例外は EMathError 例外クラスから派生します。EMathError 例外が単独で生成されることはありません。

EMathError から派生する浮動小数点数値演算例外は次のとおりです。

例外	意味

EInvalidArgument	範囲外のパラメータを指定した

EInvalidOp	プロセッサが未定義の命令を検出した

EOverflow	浮動小数点数値演算がオーバーフローした

EUnderflow	浮動小数点数値演算がアンダーフローした

EZeroDivide	ゼロで除算しようとした


EMathError プロパティ3210002

EMathError	アルファベット順

Exception からの継承

HelpContext

Message


EMathError プロパティ3210003

EMathError	オブジェクト順

HelpContext

Message


EMathError メソッド3210004

EMathError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EMathError メソッド3210005

EMathError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3210006

TObject

Exception


EMathError 例3210007

EMathError


EMCIDeviceError
EMCIDeviceError3211001

継承	プロパティ	メソッド	参照

EMCIDeviceError は，Media Control Interface (MCI) ドライバーを提供するデバイスに関する例外クラスです。

ユニット

mplayer

説明

EMCIDeviceError 例外は，マルチメディアデバイスにアクセスしたときにエラーが発生すると生成されます。最も一般的な原因は，TMediaPlayer.Open メソッドでマルチメディアデバイスをオープンする前のアクセスによるものです。


EMCIDeviceError プロパティ3211002

EMCIDeviceError	アルファベット順

Exception からの継承

HelpContext

Message


EMCIDeviceError プロパティ3211003

EMCIDeviceError	オブジェクト順

HelpContext

Message


EMCIDeviceError メソッド3211004

EMCIDeviceError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EMCIDeviceError メソッド3211005

EMCIDeviceError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3211006

TObject

Exception


EMCIDeviceError 例3211007

EMCIDeviceError


EMenuError
EMenuError3212001

継承	プロパティ	メソッド	参照

EMenuError は，メニュー項目に関するエラーによって生成される例外クラスです。

ユニット

menus

説明

EMenuError 例外は，アプリケーションがメニュー項目を処理中にエラーが発生すると生成されます。たとえば，アプリケーションが存在しないメニュー項目を削除しようとすると，EMenuError 例外が発生します。


EMenuError プロパティ3212002

EMenuError	アルファベット順

Exception からの継承

HelpContext

Message


EMenuError プロパティ3212003

EMenuError	オブジェクト順

HelpContext

Message


EMenuError メソッド3212004

EMenuError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EMenuError メソッド3212005

EMenuError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3212006

TObject

Exception


EMenuError 例3212007

EMenuError


TEnumPropDesc
TEnumPropDesc3213001

継承	メソッド	参照

TEnumPropDesc は，OLE コントロールオブジェクトでプロパティの値を表している文字列とそれらの値自体のマッピングを提供します。

ユニット

olectrls

説明

TEnumPropDesc を使うと，OLE コントロールオブジェクトで使われている文字列を解釈して，そのプロパティの 1 つの値を表すことができます。TEnumPropDesc はコールバック関数に対して考えられる値文字列のリストを提供するか，またはプロパティ値の文字列名とそれらの値自体のマップを提供できます。TEnumPropDesc オブジェクトは OLE コントロールオブジェクトの GetEnumPropDesc メソッドを介して利用できます。


TEnumPropDesc メソッド3213002

TEnumPropDesc	アルファベット順

TEnumPropDesc

Create

Destroy

GetStrings

StringToValue

ValueToString

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TEnumPropDesc メソッド3213003

TEnumPropDesc	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetStrings

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

StringToValue

ValueToString


TEnumPropDesc.Create
TEnumPropDesc.Create3213004

TEnumPropDesc	参照

Create メソッドは，TEnumPropDesc のインスタンスを作成します。

 constructor Create(DispID, ValueCount: Integer;

    const TypeInfo: ITypeInfo);

説明

Create メソッドは，OLE コンポーネントオブジェクトによって呼び出され，そのプロパティの 1 つの値を表すために TEnumPropDesc のインスタンスを作成します。アプリケーションでは TEnumPropDesc のインスタンスを作成する必要はありません。OLE のプロパティを扱うときは，OLE コントロールオブジェクトから TEnumPropDesc オブジェクトを取得します。

DispID は OLE オブジェクトのプロパティを識別します。ValueCount はプロパティがとりうる異なる値の数です。TypeInfo は，コンストラクタが値とその文字列を取得するために使うことができる ITypeInfo オブジェクトです。


TEnumPropDesc.Destroy
TEnumPropDesc.Destroy3213005

TEnumPropDesc	参照

Destroy メソッドは，TEnumPropDesc のインスタンスを破棄します。

 destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。TEnumPropDesc オブジェクトを所有する TOleControl オブジェクトが自動的に TEnumPropDesc を破棄します。

Destroy メソッドは，値文字列をプロパティ値にマップするための内部リストを破棄します。


TEnumPropDesc.GetStrings
TEnumPropDesc.GetStrings3213006

TEnumPropDesc	参照

GetStrings メソッドは，プロパティの値文字列ごとにコールバック手続き Proc を呼び出します。

 TGetStrProc = procedure(const S: string) of object;

procedure GetStrings(Proc: TGetStrProc);

説明

GetStrings メソッドを使うと，TEnumPropDesc オブジェクトで表されているプロパティの値文字列ごとにコードを実行できます。S パラメータが値の文字列表現とそれに先行する整数値からなる文字列に設定され，コールバック手続き Proc が値ごとに呼び出されます。

たとえば，TColor 値と等しい数の値を持つ色プロパティを表す TEnumPropDesc オブジェクトの場合，�255 - clRed� という形の文字列が設定され，コールバック Proc が組み込まれている色の名前ごとに呼び出されます。


TEnumPropDesc.StringToValue
TEnumPropDesc.StringToValue3213007

TEnumPropDesc	参照

StringToValue メソッドは，プロパティ値の文字列表現を整数値にマップします。

 function StringToValue(const S: string): Integer;

説明

StringToValue メソッドは，OLE コントロールオブジェクトで使われているプロパティ値の文字列表現をプロパティ値のより正確な表現形態である整数値にマップできます。プロパティ値が整数ではない場合，文字列に関連付けられている整数が値へのポインタになります。


TEnumPropDesc.ValueToString
TEnumPropDesc.ValueToString3213008

TEnumPropDesc	参照

ValueToString メソッドは，プロパティの値を示す整数を OLE コントロールオブジェクトで使われている値の文字列表現にマップします。

function ValueToString(V: Integer): string;

説明

ValueToString メソッドは，プロパティ値の整数値を OLE コントロールオブジェクトで使われている文字列表現にマップできます。


継承3213009

TObject


TEnumPropDesc 例3213010

TEnumPropDesc


ENoResultSet
ENoResultSet3214001

継承	プロパティ	メソッド	参照

ENoResultSet は，データセット問い合わせを実行できなかった場合の例外クラスです。

ユニット

dbtables

説明

ENoResultSet は，SELECT 文なしで問い合わせを行おうとすると TQuery によって生成されます。


ENoResultSet のプロパティ3214002

ENoResultSet	アルファベット順

Exception からの継承

HelpContext

Message


ENoResultSet のプロパティ3214003

ENoResultSet	オブジェクト順

HelpContext

Message


ENoResultSet のメソッド3214004

ENoResultSet	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


ENoResultSet のメソッド3214005

ENoResultSet	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3214006

TObject

Exception

EDatabaseError


ENoResultSet の例3214007

ENoResultSet


EOleCtrlError
EOleCtrlError3215001

継承	プロパティ	メソッド	参照

EOleCtrlError は，ActiveX コントロールに関する例外クラスです。

ユニット

olectrls

説明

EOleCtrlError 例外は，アプリケーションが ActiveX コントロールにリンクできなかったときに生成されます。


EOleCtrlError プロパティ3215002

EOleCtrlError	アルファベット順

Exception からの継承

HelpContext

Message


EOleCtrlError プロパティ3215003

EOleCtrlError	オブジェクト順

HelpContext

Message


EOleCtrlError メソッド3215004

EOleCtrlError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


EOleCtrlError メソッド3215005

EOleCtrlError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


継承3215006

TObject

Exception


EOleCtrlError 例3215007

EOleCtrlError


EOleException
EOleException3216001

継承	プロパティ	メソッド	参照

ユニット

comobj

説明

EOleException は，オブジェクトのメソッドまたはプロパティ内で発生した OLE オートメーションエラーの例外クラスです。

EOleException は，OLE IDispatch インターフェース固有の例外に対する例外クラスです。EOleException は，IDispatch からメソッドを呼び出している最中にエラーが起こると生成されます。Delphi サーバーが，IDispatch インターフェースの Invoke メソッドとともに呼び出されるプロパティやメソッドから失敗の戻り値を受け取ると，EOleException が生成されます。

エラーが発生すると，IDispatch を通じて呼び出されたオブジェクトはエラーのソース，エラーコード，説明，ヘルプファイル，状況感知型ヘルプの ID 番号など，例外に関する重要な情報を返すことができます。EOleException はこの情報を取得し，エラーの説明と ID 番号（取得できる場合）が CreateHelp の生成するメッセージに入っています。その他の情報は，EOleException 用に定義された Source プロパティおよび HelpFile プロパティと，EOleSysError から継承された ErrorCode プロパティに格納されます。


EOleExceptionのプロパティ3216002

EOleException	アルファベット順

EOleException

HelpFile

Source

EOleSysError からの継承

ErrorCode

Exception からの継承

HelpContext

Message


EOleException のプロパティ3216003

EOleException	オブジェクト順

ErrorCode

HelpContext

HelpFile

Message

Source


EOleException.HelpFile
EOleException.HelpFile3216004

EOleException

HelpFile プロパティは，発生したエラー情報を記述したヘルプファイルの名前と場所です。

property HelpFile: string ;

説明

HelpFile プロパティは，エラー情報が記述されているヘルプファイルの名前と絶対パスを示します


EOleException.Source
EOleException.Source3216005

EOleException

Source プロパティは，例外が発生したアプリケーションプログラムの名前です。

property Source:string;

説明

Source プロパティは例外のソースを示します。通常はアプリケーションプログラム名です。


EOleException のメソッド3216006

EOleException	アルファベット順

EOleException

Create

Exception からの継承

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EOleException のメソッド3216007

EOleException	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EOleException.Create
EOleException.Create3216008

EOleException	参照

Create メソッドは，OLE 例外オブジェクトをインスタンス化します。

constructor Create(const Message: string; ErrorCode: Integer; const Source, HelpFile: string; HelpContext: Integer);

説明

Create メソッドは，実行時に OLE 例外オブジェクトをインスタンス化します。

Create は OLE 例外オブジェクトにメモリを割り当て，OLE EXCEPINFO 構造体に渡される情報を使って，ErrorCode，HelpFile，および Source の各プロパティを初期化します。

それから，継承された CreateHelp メソッドを呼び出して，EXCEPINFO から取得したエラーの説明と ID 番号を表示します


継承3216009

TObject

Exception

EOleError

EOleSysError


EOleException の例3216010

EOleException


EOleError
EOleError3217001

継承	プロパティ	メソッド	参照

ユニット

comobj

説明

EOleError は，低レベル OLE エラーの例外クラスです。

EOleError は，システムがゼロでない低レベル OLE 2 エラーおよび古い OLE 2 エラーを RESULT に返すと生成されます。Delphi は，これらの型の例外を調べますが，生成はしません。


EOleError のプロパティ3217002

EOleError	アルファベット順

Exception からの継承

HelpContext

Message


EOleError のプロパティ3217003

EOleError	オブジェクト順

HelpContext

Message


EOleError のメソッド3217004

EOleError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EOleError のメソッド3217005

EOleError	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3217006

TObject

Exception


EOleError の例3217007

EOleError


EOleSysError
EOleSysError3218001

継承	プロパティ	メソッド

EOleSysError は，OLE オートメーションエラー，つまり OLE IDispatch インターフェース固有のエラーのための例外クラスです。

ユニット

comobj

説明

EOleSysError は，OLE オートメーションオブジェクトのメソッドまたはプロパティを呼び出そうとしてエラーが発生すると生成されます。IDispatch Invoke メソッドが失敗した場合，EOleSysError が生成されます。

エラーが発生すると，IDispatch を通して呼び出されたオブジェクトはエラーコード（OLE ステータスコードまたはSCODE）を返し，そのエラーの理由を示します。


EOleSysError のプロパティ3218002

EOleSysError	アルファベット順

EOleSysError

ErrorCode

Exception からの継承

HelpContext

Message


EOleSysError のプロパティ3218003

EOleSysError	オブジェクト順

ErrorCode

HelpContext

Message


EOleSysError.ErrorCode
EOleSysError.ErrorCode3218004

EOleSysError	参照

ErrorCode プロパティはステータスコードで，メソッドの呼び出しが失敗すると返され，その失敗の理由を示します。

property ErrorCode: Integer;

説明

ErrorCode プロパティは，OLE オートメーションオブジェクトのメソッドまたはプロパティの呼び出しが失敗したときに返される数値エラーコードです。

ErrorCode はコンストラクタで初期化されます。


EOleSysError のメソッド3218005

EOleSysError	アルファベット順

EOleSysError

Create

Exception からの継承

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EOleSysError のメソッド3218006

EOleSysError	オブジェクト順t

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EOleSysError.Create
EOleSysError.Create3218007

EOleSysError	参照

Create メソッドは，OLE システムエラーオブジェクトをインスタンス化します。

constructor Create(const Message: string; ErrorCode: Integer; HelpContext: Integer);

説明

Create メソッドは実行時に OLE システムエラーオブジェクトをインスタンス化します。

Create は OLE システムエラーオブジェクトにメモリを割り当ててから，OLE エラーコード（ErrorCode）をメッセージ文字列に変えるために SysErrorMessage を呼び出します。次に，Create はこの文字列を CreateHelp メソッドに渡し，ErrorCode プロパティを ErrorCode 文字列に初期化します。


継承3218008

TObject

Exception

EOleError


EOleSysError の例3218009

EOleSysError


EOutlineError
EOutlineError3219001

継承	プロパティ	メソッド	参照

EOutlineError は，アウトラインコンポーネントに関する例外クラスです。

ユニット

outline

説明

EOutlineError 例外は，アプリケーションがアウトラインコンポーネントを処理するときにエラーが発生すると生成されます。たとえば，アプリケーションが次のような処理を行うと，EOutlineError 例外が発生します。

・	無効なノードインデックスを使ってアウトラインコンポーネントにアクセスしようとした

・	親が展開されていないノードを展開しようとした

・	無効な拡張子を指定してファイルから項目を読み込もうとした

注意

EOutlineError は，TOutline コンポーネントによって生成されます。


EOutlineError プロパティ3219002

EOutlineError	アルファベット順

Exception からの継承

HelpContext

Message


EOutlineError プロパティ3219003

EOutlineError	オブジェクト順

HelpContext

Message


EOutlineError メソッド3219004

EOutlineError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EOutlineError メソッド3219005

EOutlineError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3219006

TObject

Exception


EOutlineError 例3219007

EOutlineError


EOutOfMemory
EOutOfMemory3220001

継承	プロパティ	メソッド	参照

EOutOfMemory は，メモリ割り当てによって生成される例外クラスです。

ユニット

sysutils

説明

EOutOfMemory 例外は，アプリケーションが動的メモリを割り当てようとしたときに空きメモリがシステムで不足していると発生します。

なお，EOutOfMemory 例外が使用するメモリは，Delphi アプリケーションの起動時にあらかじめ割り当てられていて，アプリケーションの起動中は割り当てられたままの状態となります。

注意

EOutOfMemory 例外は直接生成せずに，OutOfMemoryError 手続きを使って生成してください。


EOutOfMemory プロパティ3220002

EOutOfMemory	アルファベット順

Exception からの継承

HelpContext

Message


EOutOfMemory プロパティ3220003

EOutOfMemory	オブジェクト順

HelpContext

Message


EOutOfMemory メソッド3220004

EOutOfMemory	アルファベット順

EOutOfMemory

Destroy

FreeInstance

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EOutOfMemory メソッド3220005

EOutOfMemory	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EOutOfMemory.Destroy
EOutOfMemory.Destroy3220006

EOutOfMemory

EOutOfMemory 例外に対しては，Destroy メソッドは無効です。

destructor Destroy; override;

説明

EOutOfMemory 例外は，継承された Destroy メソッドをオーバーライドします。また，EOutOfMemory 例外用のメモリは，アプリケーションの起動時にあらかじめ割り当てられていて，アプリケーションの起動中は割り当てられたままの状態となります。このため，Destroy メソッドは無効になるので，Destroy メソッドを呼び出しても EOutOfMemory オブジェクトには影響はありません。


EOutOfMemory.FreeInstance
EOutOfMemory.FreeInstance3220007

EOutOfMemory

EOutOfMemory 例外に対しては，FreeInstance メソッドは無効です。

procedure FreeInstance; override;

説明

EOutOfMemory 例外は，継承された FreeInstance メソッドをオーバーライドします。また，EOutOfMemory 例外用のメモリは，アプリケーションの起動時にあらかじめ割り当てられていて，アプリケーションの起動中は割り当てられたままの状態となります。このため，FreeInstance メソッドは無効になるので，FreeInstance メソッドを呼び出しても EOutOfMemory オブジェクトには影響はありません。


継承3220008

TObject

Exception


EOutOfMemory 例3220009

EOutOfMemory


EOutOfResources
EOutOfResources3221001

継承	プロパティ	メソッド	参照

EOutOfResources は，Windows ハンドルを割り当てることができなかったときに生成される例外クラスです。

ユニット

classes

説明

EOutOfResources 例外は，アプリケーションが Windows ハンドルを作成しようとしたときに Windows に割り当てられるハンドルがないと発生します。


EOutOfResources プロパティ3221002

EOutOfResources	アルファベット順

Exception からの継承

HelpContext

Message


EOutOfResources プロパティ3221003

EOutOfResources	オブジェクト順

HelpContext

Message


EOutOfResources メソッド3221004

EOutOfResources	アルファベット順

EOutOfMemory からの継承

Destroy

FreeInstance

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EOutOfResources メソッド3221005

EOutOfResources	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3221006

TObject

Exception

EOutOfMemory


EOutOfResources 例3221007

EOutOfResources


EOverflow
EOverflow3222001

継承	プロパティ	メソッド	参照

EOverflow は，浮動小数点レジスタのオーバーフローによって生成される例外クラスです。

ユニット

sysutils

説明

EOverflow 例外は，計算結果が大きすぎて割り当てた浮動小数点レジスタに収まりきらないためデータが失われる場合に発生します。

注意

整数レジスタでオーバーフローが発生すると，EIntOverflow 例外が生成されます。


EOverflow プロパティ3222002

EOverflow	アルファベット順

Exception からの継承

HelpContext

Message


EOverflow プロパティ3222003

EOverflow	オブジェクト順

HelpContext

Message


EOverflow メソッド3222004

EOverflow	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EOverflow メソッド3222005

EOverflow	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3222006

TObject

Exception

EMathError


EOverflow 例3222007

EOverflow


EParserError
EParserError3223001

継承	プロパティ	メソッド	参照

EParserError は，テキストからバイナリへのストリーム変換でエラーが発生したときに生成される例外クラスです。

ユニット

classes

説明

EParserError 例外は，テキストからバイナリへストリームを変換するときに，ソーステキストの構文エラーによってエラーが発生した場合に生成されます。


EParserError プロパティ3223002

EParserError	アルファベット順

Exception からの継承

HelpContext

Message


EParserError プロパティ3223003

EParserError	オブジェクト順

HelpContext

Message


EParserError メソッド3223004

EParserError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EParserError メソッド3223005

EParserError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3223006

TObject

Exception


EParserError 例3223007

EParserError


EPackageError
EPackageError3224001

継承	プロパティ	メソッド

EPackageError はパッケージ関連のエラーの例外クラスです。

ユニット

sysutils

説明

EPackageError は，パッケージのロードまたは利用に関してエラーが発生した場合にのみ設計時に生成されます。


EPackageError のプロパティ3224002

EPackageError	アルファベット順

Exception からの継承

HelpContext

Message


EPackageError のプロパティ3224003

EPackageError	オブジェクト順

HelpContext

Message


EPackageError のメソッド3224004

EPackageError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EPackageError のメソッド3224005

EPackageError	オブジェクト

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3224006

TObject

Exception


EPackageError の例3224007

EPackageError


EPrinter
EPrinter3225001

継承	プロパティ	メソッド

EPrinter は，印刷エラーによって生成される例外クラスです。

ユニット

printers

説明

EPrinter 例外は，印刷エラーが発生すると生成されます。たとえば存在しないプリンタにアプリケーションが出力しようとしたり，印刷ジョブを何らかの理由でプリンタに送信できないと，EPrinter 例外が発生します。


EPrinter プロパティ3225002

EPrinter	アルファベット順

Exception からの継承

HelpContext

Message


EPrinter プロパティ3225003

EPrinter	オブジェクト順

HelpContext

Message


EPrinter メソッド3225004

EPrinter	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EPrinter メソッド3225005

EPrinter	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3225006

TObject

Exception


EPrinter 例3225007

EPrinter


EPrivilege
EPrivilege3226001

継承	プロパティ	メソッド

EPrivilege は，プロセッサが特権を逸脱した命令を実行したときに生成される例外クラスです。

ユニット

sysutils

説明

EPrivilege は，現在のプロセッサの特権レベルでは無効なプロセッサ命令をユーザープログラムが実行しようとしたときに生成されます。


EPrivilege プロパティ3226002

EPrivilege	アルファベット順

Exception からの継承

HelpContext

Message


EPrivilege プロパティ3226003

EPrivilege	オブジェクト順

HelpContext

Message


EPrivilege メソッド3226004

EPrivilege	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EPrivilege メソッド3226005

EPrivilege	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3226006

TObject

Exception


EPrivilege 例3226007

EPrivilege


EPropertyError
EPropertyError3227001

継承	プロパティ	メソッド	参照

EPropertyError は，プロパティの値を設定できなかったときに生成される例外クラスです。

ユニット

dsgnintf

説明

EPropertyError 例外は，プロパティエディタオブジェクトの SetValue (または Edit) メソッドで，要求されたプロパティの値を設定できなかったときに生成されます。通常，このエラーは要求された値が範囲外であるか無効なデータ型であるために発生します。


EPropertyError プロパティ3227002

EPropertyError	アルファベット順

Exception からの継承

HelpContext

Message


EPropertyError プロパティ3227003

EPropertyError	オブジェクト順

HelpContext

Message


EPropertyError メソッド3227004

EPropertyError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EPropertyError メソッド3227005

EPropertyError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3227006

TObject

Exception


EPropertyError 例3227007

EPropertyError


EPropReadOnly
EPropReadOnly3228001

継承	プロパティ	メソッド

EPropReadOnly は，OLE オートメーションを使ってプロパティに無効な書き込みを行ったときに生成される例外クラスです。

ユニット

sysutils

説明

EPropReadOnly 例外は，OLE オートメーションを使って読み出し専用プロパティに書き込もうとしたときに生成されます。


EPropReadOnly プロパティ3228002

EPropReadOnly	アルファベット順

Exception からの継承

HelpContext

Message


EPropReadOnly プロパティ3228003

EPropReadOnly	オブジェクト順

HelpContext

Message


EPropReadOnly メソッド3228004

EPropReadOnly	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EPropReadOnly メソッド3228005

EPropReadOnly	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3228006

TObject

Exception


EPropReadOnly 例3228007

EPropReadOnly


EPropWriteOnly
EPropWriteOnly3229001

継承	プロパティ	メソッド

EPropWriteOnly は，OLE オートメーションを使ってプロパティの無効な読み出しを行ったときに生成される例外クラスです。

ユニット

sysutils

説明

EPropWriteOnly 例外は OLE オートメーションを使って書き込み専用プロパティを読み出そうとしたときに生成されます。


EPropWriteOnly プロパティ3229002

EPropWriteOnly	アルファベット順

Exception からの継承

HelpContext

Message


EPropWriteOnly プロパティ3229003

EPropWriteOnly	オブジェクト順

HelpContext

Message


EPropWriteOnly メソッド3229004

EPropWriteOnly	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EPropWriteOnly メソッド3229005

EPropWriteOnly	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3229006

TObject

Exception


EPropWriteOnly 例3229007

EPropWriteOnly


ERangeError
ERangeError3230001

継承	プロパティ	メソッド	参照

ERangeError は，整数値が割り当てられた整数型の範囲を超えていると生成される例外クラスです。

ユニット

sysutils

説明

ERangeError は整数値演算例外です。ERangeError 例外は次の場合に生成されます。

・	整数式の計算結果が割り当てられている整数型の範囲を超える場合

・	ソースコードが，定義されている配列の範囲を超えたインデックス値を使って，配列項目にアクセスしようとした場合

ERangeError 例外は，範囲チェックがオンになっている場合にのみ生成されます。範囲チェックをオンにするには，プロジェクトソースコードに $R+ 指令を含めるか，または［オプション(O)｜プロジェクト(P)］で表示されるダイアログボックスの［Pascal］タブで［範囲チェック(R)］オプションを設定します。


ERangeError プロパティ3230002

ERangeError	アルファベット順

Exception からの継承

HelpContext

Message


ERangeError プロパティ3230003

ERangeError	オブジェクト順

HelpContext

Message


ERangeError メソッド3230004

ERangeError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


ERangeError メソッド3230005

ERangeError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3230006

TObject

Exception

EIntError


ERangeError 例3230007

ERangeError


EReadError
EReadError3231001

継承	プロパティ	メソッド	参照

EReadError は，ストリームからデータを読み出せないときに生成される例外クラスです。

ユニット

classes

説明

EReadError 例外は，アプリケーションがストリームからデータを読み出したときに，指定したバイト数を読み出せないと生成されます。

EReadError 例外は，フォームの作成中にコンポーネントがフォームリソースの不正な読み出しを行ったため，あるいは読み出したリソースが壊れているために，Delphi がプロパティを読み出せないときにも発生します。


EReadError プロパティ3231002

EReadError	アルファベット順

Exception からの継承

HelpContext

Message


EReadError プロパティ3231003

EReadError	オブジェクト順

HelpContext

Message


EReadError メソッド3231004

EReadError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EReadError メソッド3231005

EReadError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3231006

TObject

Exception

EStreamError

EFilerError


EReadError 例3231007

EReadError


EReconcileError
EReconcileError3232001

継承	プロパティ	メソッド	参照

EReconcileError は，クライアントデータセットエラーの例外クラスです。

ユニット

dbclient

説明

EReconcileError は，TClientDataset から更新を実行しているときにエラーが発生すると生成されます。


EReconcileError のプロパティ3232002

EReconcileError	アルファベット順	凡例

EReconcileError

Context

EDBClient からの継承

ErrorCode

Exception からの継承

HelpContext

Message


EReconcileError のプロパティ3232003

EReconcileError	オブジェクト順	凡例

Context

ErrorCode

HelpContext

Message


EReconcileError.Context
EReconcileError.Context3232004

EReconcileError	参照

エラースタックからのコンテキスト情報です。

property Context: string read FContext;

説明

Context プロパティには，エラーメッセージと一緒に返された追加情報が入っています。


EReconcileError のメソッド3232005

EReconcileError	アルファベット順

EReconcileError

Create

Exception からの継承

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EReconcileError のメソッド3232006

EReconcileError	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EReconcileError.Create
EReconcileError.Create3232007

EReconcileError

Create メソッドは，BDE が返したエラー情報を使って EReconcileError のインスタンスを初期化します。

constructor Create(NativeError, Context: string; ErrorCode: DBIResult);

説明

Create メソッドは，EReconcileError オブジェクトを生成します。


アクセス種別3232008

読み出し専用


継承3232009

TObject

Exception

EDatabaseError

EDBClient


EReconcileError の例3232010

EReconcileError


ERegistryException
ERegistryException3233001

継承	プロパティ	メソッド	参照

ERegistryException は，レジストリの読み書きによって生成される例外クラスです。

ユニット

registry

説明

ERegistryException 例外は，アプリケーションが次の処理を実行できなかったときに生成されます。

・	レジストリでの新しいキーの作成

・	キーに対応するデータ値の読み出し

・	キーに対応するバイナリデータ値のローカルバッファへの読み出し

・	キーへのデータ値の書き込み

アプリケーションがキーの KEY_CREATE_SUB_KEY セキュリティアクセスを取得していないときに，そのキーの下にサブキーを作成しようとした場合には，キーを作成することはできません。

アプリケーションが KEY_READ セキュリティアクセスを取得していない場合や，キーとは関係のないデータを読み出そうとした場合（整数データ値から文字列データを読み出そうとした場合など）には，キーに対応するデータ値を読み出すことはできません。

アプリケーションがデータのサイズに合ったバッファを割り当てていない場合には，ローカルバッファにバイナリデータ値を読み出すことはできません。

アプリケーションが現在のキーの KEY_WRITE セキュリティアクセスを取得していない場合には，キーにデータ値を書き込むことはできません。


ERegistryException プロパティ3233002

ERegistryException	アルファベット順

Exception からの継承

HelpContext

Message


ERegistryException プロパティ3233003

ERegistryException	オブジェクト順

HelpContext

Message


ERegistryException メソッド3233004

ERegistryException	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


ERegistryException メソッド3233005

ERegistryException	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3233006

TObject

Exception


ERegistryException 例3233007

ERegistryException


EReportError
EReportError3234001

継承	プロパティ	メソッド	参照

EReportError は，データベースにレポートコンポーネントを接続できなかったときに生成される例外クラスです。

ユニット

report

説明

EReportError 例外は，無効なサーバーを指定したために，レポートコンポーネント (TReport) がデータベースに接続できなかったときに生成されます。


EReportError プロパティ3234002

EReportError	アルファベット順

Exception からの継承

HelpContext

Message


EReportError プロパティ3234003

EReportError	オブジェクト順

HelpContext

Message


EReportError メソッド3234004

EReportError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EReportError メソッド3234005

EReportError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3234006

TObject

Exception


EReportError 例3234007

EReportError


EResNotFound
EResNotFound3235001

継承	プロパティ	メソッド	参照

EResNotFound は，リソースが見つからなかったときに生成される例外クラスです。

ユニット

classes

説明

EResNotFound 例外は，指定したリソース（フォーム，ビットマップ，アイコンなど）が .DFM または .RES ファイルで見つからないときや，リソースがアプリケーションにリンクされていないときに生成されます。

アプリケーションの起動時あるいはフォームの作成中にこの例外が発生する場合は，フォームの .PAS ファイル内のコンパイラ指令 {$R *.DFM} をチェックしてください。この指令がない場合やコメントアウトされている場合には，.DFM ファイルは .EXE ファイルに取り込まれないので EResNotFound 例外が生成されます。


EResNotFound プロパティ3235002

EResNotFound	アルファベット順

Exception からの継承

HelpContext

Message


EResNotFound プロパティ3235003

EResNotFound	オブジェクト順

HelpContext

Message


EResNotFound メソッド3235004

EResNotFound	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EResNotFound メソッド3235005

EResNotFound	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3235006

TObject

Exception


EResNotFound 例3235007

EResNotFound


ESocketError
ESocketError3236001

継承	プロパティ	メソッド	参照

ESocketError は，Windows ソケットオブジェクトの作成，使用，またはシャットダウンで失敗したときに生成される例外クラスです。

ユニット

scktcomp

説明

ESocketError は以下の場合に生成されます。

・	ソケットを作成できない

・	ソケットを初期化できない

・	ソケットを開くことができない

・	アプリケーションがすでに開いているソケットのプロパティを変更しようとした

・	ソケットからの読み出しまたはソケットへ書き込みに失敗した

・	ソケットを正常に閉じることができない


ESocketError プロパティ3236002

ESocketError	アルファベット順

Exception からの継承

HelpContext

Message


ESocketError プロパティ3236003

ESocketError	オブジェクト順

HelpContext

Message


ESocketError メソッド3236004

ESocketError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


ESocketError メソッド3236005

ESocketError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3236006

TObject

Exception


ESocketError 例3236007

ESocketError


EStackOverflow
EStackOverflow3237001

継承	プロパティ	メソッド

EStackOverflow は，スタックオーバーフローによって生成される例外クラスです。

ユニット

sysutils

説明

EStackOverflow 例外は，現在のスレッドのスタックが増大して最終ガードページに達したときに生成されます。システムは動的にはそのスタックサイズを大きくできません。スタックオーバーフローは，ローカル変数が大きすぎる場合，ルーチンの再帰を多用しすぎた場合，またはアセンブリ言語コードが無効な場合に発生します。


EStackOverflow プロパティ3237002

EStackOverflow	アルファベット順

Exception からの継承

HelpContext

Message


EStackOverflow プロパティ3237003

EStackOverflow	オブジェクト順

HelpContext

Message


EStackOverflow メソッド3237004

EStackOverflow	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EStackOverflow メソッド3237005

EStackOverflow	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3237006

TObject

Exception


EStackOverflow 例3237007

EStackOverflow


EStringListError
EStringListError3238001

継承	プロパティ	メソッド	参照

EStringListError は，リストボックスで範囲外の項目を参照すると生成される例外クラスです。

ユニット

classes

説明

EStringListError 例外は，アプリケーションが無効なインデックスを使ってリストボックスにアクセス（項目の追加など）すると発生します。


EStringListError プロパティ3238002

EStringListError	アルファベット順

Exception からの継承

HelpContext

Message


EStringListError プロパティ3238003

EStringListError	オブジェクト順

HelpContext

Message


EStringListError メソッド3238004

EStringListError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EStringListError メソッド3238005

EStringListError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3238006

TObject

Exception


EStringListError 例3238007

EStringListError


EStreamError
EStreamError3239001

継承	プロパティ	メソッド	参照

EStreamError は，ストリームのエラーによって生成される例外クラスです。

ユニット

classes

説明

EStreamError は，すべてのストリーム例外の親となる例外クラスです。EStreamError 例外は，メモリストリームにリソースを割り当てることができなかったときに生成されます。


EStreamError プロパティ3239002

EStreamError	アルファベット順

Exception からの継承

HelpContext

Message


EStreamError プロパティ3239003

EStreamError	オブジェクト順

HelpContext

Message


EStreamError メソッド3239004

EStreamError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EStreamError メソッド

EStreamError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3239006

TObject

Exception


EStreamError 例3239007

EStreamError


EThread
EThread3240001

継承	プロパティ	メソッド	参照

EThread は，スレッド同期エラーによって生成される例外クラスです。

ユニット

classes

説明

EThread 例外は，マルチスレッドアプリケーションで競合が発生すると生成されます。前に呼び出した Synchronize メソッドが完了していないのに，新たに Synchronize メソッドを呼び出すと，このエラーが発生します。


EThread プロパティ3240002

EThread	アルファベット順

Exception からの継承

HelpContext

Message


EThread プロパティ3240003

EThread	オブジェクト順

HelpContext

Message


EThread メソッド3240004

EThread	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EThread メソッド3240005

EThread	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3240006

TObject

Exception


EThread 例3240007

EThread


ETreeViewError
ETreeViewError3241001

継承	プロパティ	メソッド	参照

ETreeViewError は，ツリービューノードにアクセスできなかったときに生成される例外クラスです。

ユニット

comctrls

説明

ETreeViewError 例外は，無効なインデックスが TTreeView コンポーネントに要求されたときに生成されます。


ETreeViewError プロパティ3241002

ETreeViewError	アルファベット順

Exception からの継承

HelpContext

Message


ETreeViewError プロパティ3241003

ETreeViewError	オブジェクト順

HelpContext

Message


ETreeViewError メソッド3241004

ETreeViewError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


ETreeViewError メソッド3241005

ETreeViewError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3241006

TObject

Exception


ETreeViewError 例3241007

ETreeViewError


EUnderflow
EUnderflow3242001

継承	プロパティ	メソッド	参照

EUnderflow は，値が小さすぎて浮動小数点変数で表すことができないときに生成される例外クラスです。

ユニット

sysutils

説明

浮動小数点計算の結果が小さすぎて浮動小数点変数で表せない場合には，結果はゼロに丸められます。アンダーフローハードウェア例外のマスクを解除するようにアプリケーションが数値演算コプロセッサのコントロールワードを変更した場合，数値演算コプロセッサがアンダーフローハードウェア例外を報告した時点で EUnderflow 例外が生成されます。コントロールワードは，例外の処理が済むとリセットされます。


EUnderflow プロパティ3242002

EUnderflow	アルファベット順

Exception からの継承

HelpContext

Message


EUnderflow プロパティ3242003

EUnderflow	オブジェクト順

HelpContext

Message


EUnderflow メソッド3242004

EUnderflow	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EUnderflow メソッド3242005

EUnderflow	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3242006

TObject

Exception

EMathError


EUnderflow 例3242007

EUnderflow


EUpdateError
EUpdateError3243001

継承	プロパティ	メソッド	参照

EUpdateError はデータセットプロバイダの更新エラーのための例外クラスです。

ユニット

bdeprov

説明

EUpdateError は，TProvider から更新を実行しているときにエラーが発生すると生成されます。


EUpdateError のプロパティ

EUpdateError	アルファベット順	凡例

EUpdateError

Context

ErrorCode

PreviousError

Exception からの継承

HelpContext

Message


EUpdateError のプロパティ3243003

EUpdateError	オブジェクト順	凡例

Context

ErrorCode

HelpContext

Message

PreviousError


EUpdateError.Context
EUpdateError.Context3243004

EUpdateError	参照

エラースタックからのコンテキスト情報です。

property Context: string read FContext;

説明

Context には，エラーメッセージとともに返された追加情報が入っています。


EUpdateError.ErrorCode
EUpdateError.ErrorCode3243005

EUpdateError	参照

BDE が返すエラーコードです。

property ErrorCode: DBIResult;

説明

ErrorCode は BDE が返すエラーコードです。

DBIResult は，BDE のエラーコードを保持するために DBIError 手続きが使う特殊な整数型です。


EUpdateError.PreviousError
EUpdateError.PreviousError3243006

EUpdateError	参照

BDE が返した前のエラーコードです。

property PreviousError: DBIResult;

説明

PreviousError は BDE 返した前のエラーコードです。


EUpdateError のメソッド3243007

EUpdateError	アルファベット順

EUpdateError

Create

Exception からの継承

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EUpdateError のメソッド3243008

EUpdateError	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EUpdateError.Create
EUpdateError.Create3243009

EUpdateError

BDE が返すエラー情報を使って EUpdateError のインスタンスを初期化します。

constructor Create(NativeError, Context: string; ErrCode, PrevError: DBIResult);

説明

Create は EUpdateError オブジェクトを生成します。


アクセス種別3243010

読み出し専用


継承3243011

TObject

Exception

EDatabaseError


EUpdateError の例3243012

EUpdateError


EVariantError
EVariantError3244001

継承	プロパティ	メソッド	参照

EVariantError は，バリアントデータ型に関するエラーが発生したときに生成される例外クラスです。

ユニット

sysutils

説明

EVariantError 例外は以下の場合に生成されます。

・	アプリケーションがバリアントに無効な型キャストや操作を行おうとした

・	バリアントに OLE の IDispatch オブジェクトがない

・	VarArrayCreate 関数で，要求したバリアント配列を作成できない

・	配列でないバリアントをパラメータとしてバリアント配列演算を行おうとした

・	バリアント配列の添字が範囲外の値である


EVariantError プロパティ3244002

EVariantError	アルファベット順

Exception からの継承

HelpContext

Message


EVariantError プロパティ3244003

EVariantError	オブジェクト順

HelpContext

Message


EVariantError メソッド3244004

EVariantError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EVariantError メソッド3244005

EVariantError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3244006

TObject

Exception


EVariantError 例3244007

EVariantError


TEvent
TEvent3245001

継承	プロパティ	メソッド	参照

TEvent は Windows イベントのラッパーです。

ユニット

syncobjs

説明

TEvent オブジェクトは，イベントが発生したことや，ある状態に達したことを通知できます。

マルチスレッドのアプリケーションで TEvent を使うと，あるスレッドからほかのスレッドにイベントの発生を知らせることができます。

TEvent オブジェクトのハンドルはほかの処理との通信にも使えるので，アプリケーションはほかのアプリケーションとの間でイベントのタイミングを調整できます。たとえば，TEvent オブジェクトのハンドルを使うと，別の処理で Windows API を呼び出して情報を転送できるようになるまで待つことができます。

シングルスレッドのアプリケーションで TEvent を使うと，Windows メッセージなどの非同期イベントに応答するコードのセクション間の調整を行うことができます。


TEvent プロパティ3245002

TEvent	アルファベット順	凡例

THandleObject からの継承

Handle

LastError


TEvent プロパティ3245003

TEvent	オブジェクト順	凡例

Handle

LastError


TEvent メソッド3245004

TEvent	アルファベット順

TEvent

Create

ResetEvent

SetEvent

WaitFor

THandleObject からの継承

Destroy

TSynchroObject からの継承

Acquire

Release

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TEvent メソッド3245005

TEvent	オブジェクト順

Acquire

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Release

ResetEvent

SafeCallException

SetEvent

WaitFor


TEvent.Create
TEvent.Create3245006

TEvent	参照

Create メソッドは，Windows イベントオブジェクトを作成またはアクセスし，そのイベントを表す TEvent オブジェクトをインスタンス化します。

PSecurityAttributes = ^TSecurityAttributes;

  TSecurityAttributes = record

    nLength: DWORD;

    lpSecurityDescriptor: Pointer;

    bInheritHandle: BOOL;

  end;

constructor Create(EventAttributes: PSecurityAttributes; ManualReset, InitialState: Boolean;

   const Name: string);

説明

Create を呼び出すと，TEvent オブジェクトを作成できます。Create は Windows イベントオブジェクトを新しく生成したり，既存の名前付きイベントオブジェクトへのアクセス権を提供したりします。

EventAttributes パラメータを設定すると，アクセス権を指定したり，新しい Windows イベントオブジェクトに継承する機能を指定したりできます。EventAttributes を nil に設定して Create を呼び出すと，デフォルトのセキュリティ属性が設定されたイベントオブジェクトが作成されます。既存の名前付きイベントオブジェクトにアクセスするために TEvent オブジェクトを作成する場合は，EventAttributes の bInheritHandle 項目のみが使われます。これは Windows イベントオブジェクトが作成されたときにアクセス権がすでに決定されているからです。

ManualReset を設定すると，ResetEvent メソッドを呼び出したときにだけに TEvent オブジェクトのシグナル通知がオフになるようにするかどうか，あるいは 1 つの待ちスレッドが解放されたときにシグナル通知が自動的にリセットされるようにするかどうかを指定できます。ManualReset が True の場合，ResetEvent メソッドが TEvent のシグナル通知をオフにするまで，シグナル通知は設定されたままになります。ManualReset が False の場合，シグナル通知を待っているスレッドが 1 つだけで，そのスレッドが解放されたときにシグナル通知は自動的にオフになります。既存の名前付きイベントオブジェクトにアクセスするために TEvent オブジェクトを作成する場合は，ManualReset パラメータは無視されます。

InitialState を設定すると，シグナル通知を設定した状態とオフにした状態のどちらで TEvent オブジェクトを作成するかを指定できます。InitialState が True の場合，シグナル通知を設定した状態で TEvent オブジェクトが作成されます。既存の名前付きイベントオブジェクトにアクセスするために TEvent オブジェクトを作成する場合は，InitialState パラメータは無視されます。

Name を設定すると，新しい Windows イベントオブジェクトに名前を提供したり，既存の名前付きイベントオブジェクトを指定したりできます。イベントオブジェクトにアクセスしてシグナル通知を待つスレッドや処理がない場合には，Name を空白にしておくこともできます。Name はバックスラッシュ記号（\）を含まない 260 字までの文字列です。Name で既存のイベントオブジェクトを指定する場合，Name の値は既存のイベントの名前と一致していなければなりません（大文字と小文字が区別されます）。Name が既存の Windows のセマフォ，ミューテックス，またはファイルマッピングオブジェクトの名前と一致した場合，Handle を 0 に設定した状態で TEvent オブジェクトが作成され，メソッドの呼び出しはすべて失敗します。


TEvent.ResetEvent
TEvent.ResetEvent3245007

TEvent	参照

ResetEvent メソッドは，イベントオブジェクトのシグナル通知をオフにします。

procedure ResetEvent;

説明

ResetEvent を呼び出すと，イベントが発生しなかったことや，目的の状態に達しなかったことを通知できます。そのイベントを待っているほかのスレッドや処理は，SetEvent メソッドがシグナル通知を再びオンにするか，イベントオブジェクトが破棄されるか，あるいは待機中の処理がタイムアウトになるまで待つことになります。


TEvent.SetEvent
TEvent.SetEvent3245008

TEvent	参照

SetEvent メソッドは，イベントオブジェクトのシグナル通知をオンにします。

procedure SetEvent;

説明

SetEvent を呼び出すと，イベントが発生したことや，目的の状態に達したことを通知できます。そのイベントを待っているほかのスレッドや処理は，シグナル通知が設定されたことを示す戻り値を受け取って実行を再開します。


TEvent.WaitFor
TEvent.WaitFor3245009

TEvent	参照

WaitFor メソッドは，別のスレッドや処理がイベントオブジェクトのシグナル通知をオンにするのを待ちます。

TWaitResult = (wrSignaled, wrTimeout, wrAbandoned, wrError);

function WaitFor(Timeout: Longint): TWaitResult;

説明

WaitFor を呼び出すと，イベントオブジェクトのシグナル通知がオンになるのを待つことができます。Timeout ミリ秒後にシグナル通知が設定されない場合でも，WaitFor は値を返します。WaitFor が返す値は以下のとおりです。

値	意味

wrSignaled	イベントオブジェクトのシグナル通知が設定された

wrTimeout	Timeout パラメータで指定された時間が経過したがシグナル通知は設定されなかった

wrAbandoned	Timeout 期間が経過する前にイベントオブジェクトが破棄された

wrError	待機中にエラーが発生した。詳細は LastError プロパティのエラーコードを参照


読み出し／書き込み3245010

読み出し専用


継承3245011

TObject

TSynchroObject

THandleObject


TEvent 例3245012

TEvent


EWin32Error
EWin32Error3246001

継承	プロパティ	メソッド	参照

ユニット

sysutils

説明

EWin32Error は，Windows エラーの例外クラスです。

EWin32Error は，Windows がエラーコードを返すと RaiseLastWin32Error 手続きによって生成されます。例外ダイアログには，エラー番号とそのエラーに関連付けられたメッセージが入っています。


EWin32Error のプロパティ3246002

EWin32Error	アルファベット順

Exception からの継承

HelpContext

Message


EWin32Error のプロパティ3246003

EWin32Error	オブジェクト順

HelpContext

Message


EWin32Error のメソッド3246004

EWin32Error	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EWin32Error のメソッド3246005

EWin32Error	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3246006

TObject

Exception


EWin32Error の例3246007

EWin32Error


EWriteError
EWriteError3247001

継承	プロパティ	メソッド	参照

EWriteError は、ストリームにデータを書き込めないときに生成される例外クラスです。

ユニット

classes

説明

EWriteError 例外は，次のような場合に生成されます。

・	指定したバイト数をストリームオブジェクトの WriteBuffer メソッドが書き込めない場合

・	設計時にフォームを保存したために，IDE がコンポーネントのプロパティの 1 つをストリームに書き込めない場合


EWriteError プロパティ3247002

EWriteError	アルファベット順

Exception からの継承

HelpContext

Message


EWriteError プロパティ3247003

EWriteError	オブジェクト順

HelpContext

Message


EWriteError メソッド3247004

EWriteError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EWriteError メソッド3247005

EWriteError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3247006

TObject

Exception

EStreamError

EFilerError


EWriteError 例3247007

EWriteError


Exception
Exception3249001

継承	プロパティ	メソッド

Exception は，実行時に生成されるすべての例外の基本となるクラスです。

ユニット

sysutils

説明

Exception クラスは，すべての例外の基本的なプロパティとメソッドをカプセル化しています。このクラスを基本にして独自のカスタム例外を作成します。

Exception オブジェクトで用意しているメソッドはすべてコンストラクタで，そのコンストラクタを使うと，いくつかの方法で例外メッセージを作成できます。また，ヘルプコンテキスト ID を作成するコンストラクタもあります。通常は例外が発生すると，アプリケーションはこれらのコンストラクタを動的に呼び出します。

例外メッセージは，ハードコーディングされた文字列，書式付き文字列，またはアプリケーションリソースから読み込んだ文字列（書式付き文字列を含む）として作成できます。

例外は，アプリケーションでゼロ除算などの実行時エラーが発生すると作成されます。通常は例外が発生すると，例外インスタンスによってエラー状態を説明するダイアログボックスが表示されます。アプリケーションがこの例外を処理しない場合には，デフォルトの例外ハンドラが呼び出されます。例外ハンドラを呼び出した場合にもダイアログボックスが表示されます。通常，このダイアログボックスで［OK］をクリックすると，アプリケーションで処理を続けることができます。

Exception オブジェクトは様々なエラー状態に対して統一されたインターフェースを提供するので，アプリケーションは適切な方法でエラーを処理できます。アプリケーションが実行できる処理は次のとおりです。

・	try...except ブロックにある特定の例外をトラップおよび処理する

・	リソースの割り当てを行うコードを try...finally ブロックに埋め込んで，コードが例外の影響を受けないようにする

・	プログラムの状態に応じて，通常の例外やカスタム例外を生成する

注意

標準的な慣例として，Exeption オブジェクトから派生した例外には「E」で始まる説明的な略称を付けることになっています。


Exception プロパティ3249002

Exception	アルファベット順

Exception

HelpContext

Message


Exception プロパティ3249003

Exception	オブジェクト順

HelpContext

Message


Exception.HelpContext
Exception.HelpContext3249004

Exception	参照

HelpContext プロパティは，例外に対応する状況感知型オンラインヘルプのコンテキスト ID 番号を指定します。

property HelpContext: THelpContext;

説明

HelpContext プロパティは，例外オブジェクトに対応するヘルプコンテキスト ID 番号を保持します。このコンテキスト番号によって，ヘルプ画面に表示される内容が決まります（例外エラーメッセージにしたがって〔F1〕を押すと，ヘルプ画面が表示されます）。

注意

Exception オブジェクトのすべてのコンストラクタで HelpContext プロパティの値が指定できるわけではありません。例外に対して独自のヘルプコンテキストを指定できるのは，以下の「参照」に挙げたコンストラクタだけです。


Exception.Message
Exception.Message3249005

Exception	参照

Message プロパティは，例外の発生時に例外ダイアログボックスに表示されるテキスト文字列を指定します。

property Message: string

説明

Message プロパティは，例外の発生時に表示されるエラーメッセージ文字列を保持します。Exception オブジェクトのすべてのコンストラクタは，Message プロパティに文字列パラメータが格納されることを想定します。メッセージテキストは，Exception オブジェクトのコンストラクタのパラメータとしてハードコーディングする，動的なパラメータとして作成する，あるいは静的なパラメータまたは動的な書式付きパラメータとしてリソースファイルから読み込むという 3 通りの方法で作成できます。


Exception メソッド3249006

Exception	アルファベット順

Exception

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


Exception メソッド3249007

Exception	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


Exception.Create
Exception.Create3249008

Exception	参照

Create メソッドは，単純なメッセージ文字列を持つ例外のインスタンスを生成します。

constructor Create (const Msg: string);

説明

Create メソッドを呼び出すと，単純なメッセージ文字列を持つ例外を作成できます。Msg は，例外ダイアログボックスで表示される実行時エラーメッセージとなる文字列です。Msg にはハードコード文字列を指定するか，文字列を返す関数呼び出しを指定できます。


Exception.CreateFmt
Exception.CreateFmt3249009

Exception	参照

CreateFmt メソッドは，書式付きメッセージ文字列を持つ例外のインスタンスを生成します。

constructor CreateFmt (const Msg: string; const Args: array of const)

説明

CreateFmt メソッドを呼び出すと，書式付きメッセージ文字列を持つ例外を作成できます。Msg は，Args の値で置き換えられる書式指定子を含む文字列定数です。Args は，Msg の書式指定子にしたがって書式化され，Msg に挿入される定数の配列です。CreateFmt メソッドは Format 関数を呼び出して，Args を含む Msg の値を変換します。


Exception.CreateFmtHelp
Exception.CreateFmtHelp3249010

Exception	参照

CreateFmtHelp メソッドは，書式付きメッセージ文字列とヘルプコンテキスト ID を持つ例外のインスタンスを生成します。

constructor CreateFmtHelp (const Msg: string; const Args: array of const; AHelpContext:
Integer);

説明

CreateFmtHelp メソッドを呼び出すと，書式付きメッセージ文字列とヘルプコンテキスト ID を持つ例外を作成できます。Msg は，Args の値で置き換えられる書式指定子を含む文字列定数です。Args は，Msg の書式指定子にしたがって書式化され，Msg に挿入される定数の配列です。CreateFmt メソッドは Format 関数を呼び出して，Args を含む Msg の値を変換します。

AHelpContext パラメータは，例外に対する状況感知型のヘルプ ID を指定する整数です。


Exception.CreateHelp
Exception.CreateHelp3249011

Exception	参照

CreateHelp メソッドは，単純なメッセージ文字列とヘルプコンテキスト ID を持つ例外のインスタンスを作成します。

constructor CreateHelp (const Msg: string; AHelpContext: Integer);

説明

CreateHelp メソッドを呼び出すと，単純なメッセージ文字列とヘルプコンテキスト ID を持つ例外を作成できます。Msg は，例外ダイアログボックスで表示される実行時エラーメッセージとなる文字列です。Msg にはハードコード文字列を指定するか，文字列を返す関数呼び出しを指定できます。

AHelpContext パラメータは，例外に対する状況感知型のヘルプ ID を指定する整数です。


Exception.CreateRes
Exception.CreateRes3249012

Exception	参照

CreateRes メソッドは，アプリケーションのリソースから読み込んだ単純なメッセージ文字列を持つ例外のインスタンスを作成します。

constructor CreateRes (Ident: Integer);

説明

CreateRes メソッドを呼び出すと，アプリケーションのリソースから読み込んだ単純なメッセージ文字列を持つ例外を作成できます。リソースはコンパイル時には実行可能なアプリケーションに結合されますが，設計時には独立した RES ファイルにあります。

Ident パラメータは，RES ファイルに指定したリソース固有の ID です。Ident パラメータに無効なリソース ID が指定されている場合には，CreateRes メソッドは例外に対して空のメッセージ文字列を作成します。


Exception.CreateResFmt
Exception.CreateResFmt3249013

Exception	参照

CreateResFmt メソッドは，アプリケーションのリソースから読み込んで，書式化されたメッセージ文字列を持つ例外のインスタンスを作成します。

constructor CreateResFmt(Ident: Integer; const Args: array of const);

説明

CreateResFmt メソッドを呼び出すと，アプリケーションのリソースから読み込んで，追加情報で書式化されたメッセージ文字列を持つ例外を作成できます。リソースはコンパイル時には実行可能なアプリケーションに結合されますが，設計時には独立した RES ファイルに入っています。

Ident パラメータは，RES ファイルに指定したリソース固有の ID です。Ident パラメータに無効なリソース ID が指定されている場合には，CreateResFmt メソッドは空のメッセージ文字列を作成します。

Args は定数の配列です。次のように処理されます。

1.	文字列に埋め込まれた書式指定子にしたがって書式化される

2.	メッセージ文字列に挿入される

CreateResFmt メソッドは Format 関数を呼び出して，Args の値を含むメッセージ文字列を変換します。


Exception.CreateResFmtHelp
Exception.CreateResFmtHelp3249014

Exception	参照

CreateResFmtHelp メソッドは，ヘルプコンテキスト ID とアプリケーションのリソースから読み込んだ書式付きメッセージ文字列を持つ例外のインスタンスを作成します。

constructor CreateResFmtHelp(Ident: Integer; const Args: array of const;
AHelpContext: Integer);

説明

CreateResFmtHelp メソッドを呼び出すと，次の値を持つ例外を作成できます。

1.	アプリケーションのリソースから読み込んで，追加情報で書式化されたメッセージ文字列

2.	ヘルプコンテキスト ID

リソースはコンパイル時には実行可能なアプリケーションに結合されますが，設計時には独立した RES ファイルに入っています。Ident パラメータは，RES ファイルに指定したリソース固有の ID です。Ident パラメータに無効なリソース ID が指定されている場合には，CreateResFmtHelp メソッドは空のメッセージ文字列を作成します。

Args は定数の配列です。次のように処理されます。

1.	文字列に埋め込まれた書式指定子にしたがって書式化される

2.	メッセージ文字列に挿入される

CreateResFmtHelp メソッドは Format 関数を呼び出して，Args の値を含むメッセージ文字列を変換します。

AHelpContext パラメータは，例外に対する状況感知型のヘルプ ID を指定する整数です。


Exception.CreateResHelp
Exception.CreateResHelp3249015

Exception	参照

CreateResHelp メソッドは，ヘルプコンテキスト ID とアプリケーションのリソースから読み込んだ単純なメッセージ文字列を持つ例外のインスタンスを作成します。

constructor CreateResHelp(Ident: Integer; AHelpContext: Integer);

説明

CreateResHelp メソッドを呼び出すと，ヘルプコンテキスト ID とアプリケーションのリソースから読み込んだ単純なメッセージ文字列を持つ例外を作成できます。リソースはコンパイル時には実行可能なアプリケーションに結合されますが，設計時には独立した RES ファイルに入っています。

Ident パラメータは，RES ファイルに指定したリソース固有の ID です。Ident パラメータに無効なリソース ID が指定されている場合には，CreateResHelp メソッドは例外に対して空のメッセージ文字列を作成します。

AHelpContext パラメータは，例外に対する状況感知型のヘルプ ID を指定する整数です。


継承3249016

TObject


Exception 例3249017

Exception


EZeroDivide
EZeroDivide3250001

継承	プロパティ	メソッド	参照

EZeroDivide は，浮動小数点値のゼロ除算エラーによって生成される例外クラスです。

ユニット

sysutils

説明

EZeroDivide 例外は，アプリケーションが浮動小数点値を 0 で除算しようとすると発生します。

注意

整数値のゼロ除算エラーの場合は，EDivByZero 例外が生成されます。


EZeroDivide プロパティ3250002

EZeroDivide	アルファベット順

Exception からの継承

HelpContext

Message


EZeroDivide プロパティ3250003

EZeroDivide	オブジェクト順

HelpContext

Message


EZeroDivide メソッド3250004

EZeroDivide	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EZeroDivide メソッド3250005

EZeroDivide	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3250006

TObject

Exception

EMathError


EZeroDivide 例3250007

EZeroDivide


TField
TField3251001

継承	プロパティ	メソッド	イベント	参照

TField コンポーネントはデータセット内のすべての項目コンポーネントの共通の上位コンポーネントです。

ユニット

db

説明

TField は，すべての項目コンポーネントに共通な基本的な機能をカプセル化します。TField は以下の処理を行うのに使用するプロパティ，イベント，メソッドを導入します。

・	データセット内の項目の値を変更する

・	項目の値を 1 つのデータ型から別のデータ型へ変換する

・	ユーザーが項目に入力したデータを検証する

・	データを表示または編集するときの項目内のデータの表示方法を定義する

・	データセットの OnCalcFields イベントに記述したコードから項目の値を計算する

・	別のデータセットから項目の値を参照する

TField のインスタンスは作成しないでください。TField の下位コンポーネントはデータセットがアクティブなったときに自動的に作成されます。これらの下位コンポーネントは動的（デフォルト）なものの場合と静的なものの場合とがあります。動的な項目コンポーネントは，データセットをオープンした時点での，基になる物理テーブルの実際の列を反映します。静的な項目コンポーネントは，設計時に，項目エディタを使ってデータセット内の項目，プロパティ，順序を指定して作成されます。

静的な項目コンポーネントを作成すれば，基になるデータベースの物理的な構造に変更があっても，アプリケーションでは同じ列が同じ順番で使われ表示されることが保証されます。静的な TField コンポーネントの基になる列が削除または変更されると，Delphi は例外を生成し，存在しない列や該当しないデータのためにテーブルがオープンされることはありません。その場合は，項目エディタを使って存在しない項目の項目コンポーネントを削除します。

データセットのフィールドは TField から派生した以下の下位コンポーネントのいずれかになります。

TStringField	TBlobField	TTimeField

TSmallintField	TIntegerField	TBytesField

TFloatField	TWordField	TVarBytesField

TCurrencyField	TAutoIncField	TGraphicField

TBooleanField	TBCDField	TMemoField

TDateField	TDateTimeField


TField プロパティ3251002

TField	アルファベット順	凡例

TField

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Value

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TField プロパティ3251003

TField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TField.Alignment
TField.Alignment3251004

TField	参照

Alignment プロパティは，データベース対応コントロール内での項目のデータの表示方法を決めます。

property Alignment: TAlignment;

説明

Alignment プロパティは，データベース対応コントロール内での項目のデータの位置を指定できます。次の値を指定できます。

値	意味

taLeftJustify	データをコントロールの左端で揃える

taCenter	データをコントロールの横方向に中央揃えする

taRightJustify	データをコントロールの右端で揃える


TField.AsBoolean
TField.AsBoolean3251005

TField	参照

AsBoolean プロパティは，項目のネイティブな型と論理値との間での変換を行うプロパティを導入します。

property AsBoolean: Boolean;

説明

AsBoolean プロパティは，項目のデータの値を取得て論理値に変換するか，論理値を項目の内容に設定するプロパティを提供します。TField は論理値をサポートしていないので，AsBoolean プロパティを取得または設定しようとすると例外が生成されます。

論理型項目を表すか，または項目の Value プロパティと論理値との間の変換をサポートしている TField の下位コンポーネントは，AsBoolean をオーバーライドして，項目の値を論理値として読み書きします。


TField.AsCurrency
TField.AsCurrency3251006

TField	参照

AsCurrency プロパティは，項目のネイティブな型と Currency 値との間での変換を行うプロパティを導入します。

property AsCurrency: Currency;

説明

AsCurrency プロパティは，項目のデータの値を取得して Currency 型のオブジェクトまたは変数に変換するか，Currency 値を項目の内容に設定するプロパティを提供します。TField は Currency 値をサポートしていないので，AsCurrency プロパティを取得または設定しようとすると例外が生成されます。

通貨型項目を表すか，または項目の Value プロパティと Currency 値との間の変換をサポートしている TField の下位コンポーネントは，AsCurrency をオーバーライドして，項目の値を Currency 値として読み書きします。


TField.AsDateTime
TField.AsDateTime3251007

TField	参照

AsDateTime プロパティは，項目のネイティブな型と TDateTime 値との間での変換を行うプロパティを導入します。

TDateTime= type Double;

property AsDateTime: TDateTime;

説明

AsDateTime プロパティは，項目のデータの値を取得して TDateTime 型のオブジェクトまたは変数に変換するか，TDateTime 値を項目の内容に設定するプロパティを提供します。TField は TDateTime 値をサポートしていないので，AsDateTime プロパティを取得または設定しようとすると例外が生成されます。

時刻日付（タイムスタンプ）型項目を表すか，または項目の Value プロパティと TDateTime 値との間の変換をサポートしている TField の下位コンポーネントは，AsDateTime をオーバーライドして，項目の値を TDateTime 値として取得および設定します。


TField.AsFloat
TField.AsFloat3251008

TField	参照

AsFloat プロパティは，項目のネイティブな型と Double 値との間での変換を行うプロパティを導入します。

property AsFloat: Double;

説明

AsFloat プロパティは，項目のデータの値を取得して Double 型に変換するか，Double 値を項目の内容に設定するプロパティを提供します。TField は浮動小数点値をサポートしていないので，AsFloat プロパティを取得または設定しようとすると例外が生成されます。

浮動小数数値型項目を表すか，または項目の Value プロパティと Double 値との間の変換をサポートしている TField の下位コンポーネントは，AsFloat をオーバーライドして，項目の値を Double 値として取得および設定します。


TField.AsInteger
TField.AsInteger3251009

TField	参照

AsInteger プロパティは，項目のネイティブな型と 32ビット整数との間での変換を行うプロパティを導入します。

property AsInteger: Integer;

説明

AsInteger は，項目のデータの値を取得して整数に変換するか，整数値を項目の内容に設定するプロパティを提供します。TField は整数値をサポートしていないので，AsInteger プロパティを取得または設定しようとすると例外が生成されます。

整数項目を表すか，または項目の Value プロパティと整数値のと間の変換をサポートしている TField の下位コンポーネントは，AsFloat をオーバーライドして，項目の値を整数値として取得および設定します。


TField.AsString
TField.AsString3251010

TField	参照

AsString プロパティは，項目コンポーネントの省略クラス名です。

property AsString: string;

説明

AsString プロパティは，項目コンポーネントの省略クラス名がかっこに入れられて返されます。省略クラス名は，クラス名から先頭の「T」と最後の「FIELD」を取り除いたものになります。少なくとも現在はそうならない（空文字列になる）。この動作にするには，DBPAS のTField.GetString で if(L>=5)and～ というところを if((L-1)>=5)and～ とすること。AsString プロパティを設定しようとすると，例外が生成されます。

文字列項目を表すか，または項目の Value プロパティと文字列との間の変換をサポートしている TField の下位コンポーネントは，AsString をオーバーライドして，項目の値を別のわかりやすい文字列として取得および設定します。


TField.AsVariant
TField.AsVariant3251011

TField	参照

AsVariant プロパティは，Variant 型として表される項目の Value です。

property AsVariant: Variant;

説明

AsVariant プロパティは，項目のデータの値を取得して Variant 型に変換するか，Variant 値を項目の内容に設定するプロパティを提供します。TField は Variant 値をサポートしていないので，AsVariant プロパティを読み出そうとすると例外が生成されます。また，Variant が varNull 型の場合を除いて，AsVariant プロパティを設定しようとすると，TField は例外を生成します。Variant が varNull 型の場合，TField は Clear メソッドを呼び出します。

TField の下位コンポーネントは，AsVariant メソッドを実現して，項目の値を Variant として取得または設定します。


TField.AttributeSet
TField.AttributeSet3251012

TField	参照

AttributeSet プロパティは，項目コンポーネントに適用するデータディクショナリ内の属性セットの名前です。

property AttributeSet: string;

説明

属性セットは，設計時にデータベース対応コントロールに表示される項目コンポーネントの表示および形式プロパティを定義します。また，項目コンポーネントの制約およびデフォルトプロパティも定義します。

属性セットをデータディクショナリに保存しておけば，設計時に同じ属性のセットを作成して 1 つまたは複数のデータセット内の別の項目コンポーネントに適用することができます。設計時に属性セットが項目コンポーネントに割り当てられていて，そのコンポーネントが TQuery または TStoredProc データセットによって所有されているときは，AttributeSet には割り当てられているその属性セットの名前が入ります。


TField.Calculated
TField.Calculated3251013

TField	参照

Calculated プロパティは，項目の値がデータセットの OnCalcFields イベントハンドラによって計算されるかどうかを判別します。

property Calculated: Boolean;

説明

Calculated プロパティは，その項目が計算項目であるかどうかを取得できます。Calculated が True のときに OnCalcFields イベントが発生すると，OnCalcFields イベントハンドラが項目の値を更新します。デフォルト値は False です。

計算項目の値はデータセットの基になる物理テーブルには格納されず，そこから直接取り出すことはできません。計算項目の値は，テーブルの各レコードについてデータセットの OnCalcFields イベントハンドラによって，通常はレコードの他の項目の値から計算されます。

たとえば Quantity と UnitPrice の計算されない項目と，OnCalcFields イベントハンドラでこれらの項目の値を乗算して求められる ExtendedPrice の計算項目を持つテーブルが考えられます。

アプリケーションのコードで Calculated の設定を変更したりしないでください。項目の値が計算項目として指定されていれば，Calculated は設計時に項目エディタによって自動的に True に設定されます。

注意

Calculated プロパティと項目定義の InternalCalcField プロパティとを混同しないでください。計算項目の値は OnCalcFields イベントハンドラで計算されます。内部的に計算される項目の値は SQL サーバーまたはボーランドデータベースエンジンによって計算されます。


TField.CanModify
TField.CanModify3251014

TField	参照

CanModify プロパティは，項目を変更できるかどうかを示します。

property CanModify: Boolean;

説明

CanModify プロパティは，項目のデータが編集可能かどうかを取得できます。CanModify は，ReadOnly プロパティが False で，項目コンポーネントのデータセットが対応するデータベース項目への書き込みアクセスを許可している場合にのみ True になります。


TField.ConstraintErrorMessage
TField.ConstraintErrorMessage3251015

TField	参照

ConstraintErrorMessage プロパティは，ユーザーが項目のデータ制約に違反する値を設定しようとしたときに表示するカスタムエラーメッセージです。

property ConstraintErrorMessage: string;

説明

ConstraintErrorMessage プロパティを設定すると，ユーザーが項目に入力した値がサーバーによって設定されている制約や CustomConstraint プロパティで指定されている制約に適合しなかったときに表示されるメッセージを指定できます。


TField.CurValue
TField.CurValue3251016

TField	参照

CurValue プロパティは，他のデータベースユーザーが加えた変更も含めて，項目コンポーネントの現在の値を示します。

property CurValue: Variant;

説明

CurValue プロパティは，データベースへの値の登録で問題が生じたときに項目の値を取得できます。データベースへの値の登録で，キー違反など，現在の項目値が原因で問題が起こった場合は，アプリケーションがその問題に応答できるようにするイベントが生成されます。クライアントデータセットは OnReconcileError イベントを生成します。サーバー側では，TProvider オブジェクトが OnUpdateError イベントを生成します。イベントハンドラでは，NewValue は問題の原因となった未登録の値です。OldValue は，編集を行う前にその項目に割り当てられていた値で，CurValue は現在その項目に割り当てられている値です。OldValue を読み出した後で他のユーザーが項目の値を変更していれば，CurValue は OldValue と異なることもあります。

注意

CurValue は，データセットが TClientDataSet または TProvider のソースデータセットである場合にのみサポートされます。


TField.CustomConstraint
TField.CustomConstraint3251017

TField	参照

CustomConstraint プロパティは，項目の値に対して設定するアプリケーション固有の制約を指定する SQL 文字列です。

property CustomConstraint: string;

説明

CustomConstraint プロパティを設定すると，ユーザーが項目に入力できる値を制限できます。CustomConstraint は，次のような，有効な SQL 検索式でなければなりません。

x > 0 and x < 100

項目の値を参照するのに使う名前は，予約済みの SQL キーワードでなければ，どのような文字列でもかまいません。ただし，制約式を通じて一貫している必要があります。

カスタム制約は，サーバーによる項目値の制約に加えて働きます。サーバーによって設定されている制約を確認するには，ImportedConstraint プロパティを読み出します。

注意

CustomConstraint プロパティを設定するときは，必ず ConstraintErrorMessage プロパティも設定してください。そうすれば，カスタム制約に違反する値が入力されたときにユーザーにメッセージを表示できます。


TField.DataSet
TField.DataSet3251018

TField	参照

DataSet プロパティは，項目コンポーネントの所属するデータセットを識別します。

property DataSet: TDataSet;

説明

DataSet プロパティは，項目コンポーネントを使って項目を表示しているデータセットを取得できます。アプリケーションは項目の DataSet プロパティを直接割り当ててはなりません。項目の DataSet プロパティは，TFieldDef オブジェクトから項目が作成されるときに自動的に割り当てられます。


TField.DataSize
TField.DataSize3251019

TField	参照

DataSize プロパティは，項目コンポーネントの値を格納するときに必要なメモリの量です。

property DataSize: Word;

説明

DataSize プロパティは，項目コンポーネントの値を格納するのに必要なバイト数を取得できます。DataSize を使えば，ネイティブ形式で項目の値を使うのに必要なバッファサイズを取得できます。たとえば，DataSize を使って，GetData および SetData メソッドで必要なバッファサイズを判定できます。

TField の場合，DataSize の値は 0 です。ほとんどの TField の派生オブジェクトはこのプロパティをオーバーライドして，それらのオブジェクトが表す特定の項目型で必要なサイズを指定します。ただし，BLOB 項目はサイズが未定のデータを表します。BLOB 項目は継承メソッドをオーバーライドせず，BLOB 項目の DataSize は 0 です。0 の値は項目値がメモリを必要としないことを意味するのではなく，項目に必要なメモリが未定であることを示します。


TField.DataType
TField.DataType3251020

TField	参照

DataType は項目コンポーネントのデータ型を識別します。

TFieldType = (ftUnknown, ftString, ftSmallint, ftInteger, ftWord, ftBoolean, ftFloat, ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftBytes, ftVarBytes, ftAutoInc, ftBlob, ftMemo, ftGraphic, ftFmtMemo, ftParadoxOle, ftDBaseOle, ftTypedBinary, ftCursor);

property DataType: TFieldType;

説明

DataType プロパティを読み出すと，項目に入っているデータのデータ型を調べることができます。DataType プロパティは次の値のいずれかです。

値	説明

ftUnkown	未知または未定

ftString	文字または文字列項目

ftSmallint	16 ビット整数項目

ftInteger	32 ビット整数項目

ftWord	16 ビット符号なし整数項目

ftBoolean	論理型項目

ftFloat	浮動小数点数値型項目

ftCurrency	金額型項目

ftBCD	2 進化 10 進数型項目

ftDate	日付型項目

ftTime	時刻型項目

ftDateTime	日付時刻型項目

ftBytes	固定長バイト型項目 (バイナリ格納)

ftVarBytes	可変長バイト型項目 (バイナリ格納)

ftAutoInc	自動インクリメント 32 ビット整数カウンタ型項目

ftBlob	バイナリラージオブジェクト項目

ftMemo	テキストメモ項目

ftGraphic	ビットマップ項目

ftFmtMemo	書式付きメモ項目

ftParadoxOle	Paradox OLE 項目

ftDBaseOle	dBASE OLE 項目

ftTypedBinary	型付きバイナリ項目

ftCursor	項目コンポーネントに適用しない


TField.DefaultExpression
TField.DefaultExpression3251021

TField	参照

DefaultExpression プロパティは，ユーザーが値を入力しない場合に項目に割り当てられるデフォルト値を表す SQL 式です。

property DefaultExpression: string;

説明

DefaultExpression プロパティを設定すると，項目のデフォルト値を指定できます。DefaultExpression には，項目の値を参照しない，有効な SQL 値式を指定できます。式に数値以外のリテラル文字が含まれる場合は，それらの文字を引用符で囲む必要があります。たとえば，時刻型項目の正午の値のデフォルト値の場合は，次のようにリテラル値を引用符で囲みます。

�12:00:00�


TField.DisplayLabel
TField.DisplayLabel3251022

TField	参照

DisplayLabel プロパティは，データグリッドの対応する列見出しに表示するテキストです。

property DisplayLabel: string;

説明

DisplayLabel プロパティは，データグリッドに列見出しを割り当てることができます。データグリッドの列見出しは値を表す項目の DisplayName プロパティを使用します。DisplayLabel を設定すると，DisplayName プロパティが FieldName から DisplayLabel に指定した文字列に変更されます。


TField.DisplayName
TField.DisplayName3251023

TField	参照

DisplayName プロパティは，表示用の項目の名前を返します。

property DisplayName: string;

説明

DisplayName プロパティは，その項目を表す文字列をユーザーに表示するときに使います。たとえば，項目に関して例外を生成するときに，DisplayName を含むエラー文字列をフォーマットして，その項目を参照できるようにします。DisplayName は読み出し専用のプロパティです。DisplayName の値を変更するには，DisplayLabel プロパティを使います。

DisplayLabel が定義されていれば，DisplayName は DisplayLabel と同じになります。定義されていなければ，DisplayName は FieldName プロパティと同じになります。


TField.DisplayText
TField.DisplayText3251024

TField	参照

DisplayText プロパティは，データベース対応コントロールで項目の値を表示するときの文字列値です。

property DisplayText: string;

説明

DisplayText プロパティはデータベース対応コントロールで項目の値を表示するときの読み出し専用の文字列値です。OnGetText イベントハンドラが割り当てられている場合は，DisplayText プロパティは， DisplayText パラメータが True のときに，OnGetText イベントハンドラの Text パラメータに返される値です。それ以外の場合は，DisplayText は AsString プロパティの値です。

DisplayText は，項目が編集中でないときは，その項目の Value プロパティの文字列値です。項目が編集中のときは Text プロパティを使います。


TField.DisplayWidth
TField.DisplayWidth3251025

TField	参照

DisplayWidth プロパティは，項目の値を表示するために，対応するデータベース対応コントロールが使用する文字数を指定します。

property DisplayWidth: Integer;

説明

DisplayWidth プロパティを設定すると，項目が TDBLookupListBox オブジェクトまたは TCustomDBGrid の場合は，下位オブジェクトによって表示されるときに項目の列幅を算定するのに使用される文字数を制御できます。実際の列幅は平均的な文字幅で決まります。項目を表示するデータベース対応コントロールが固定ピッチフォントを使用していない場合は，DisplayWidth には，所定の文字列に対して列にぴったり収まる文字数よりも多くのまたは少ない文字数が示されることがあります。

注意

DisplayWidth プロパティは，TDBGrid オブジェクト内の項目で明示的に Columns 値を指定している場合には無効です。


TField.EditMask
TField.EditMask3251026

TField	参照

EditMask プロパティは，データ項目に入力できるデータを制限するのに使うマスクです。

property EditMask: string;

説明

EditMask プロパティは，ユーザーが入力できる文字を有効な文字および形式だけに制限できます。ユーザーが無効な文字を入力しようとしても，その文字は受け付けられません。EditMask プロパティを使った場合，検証は 1 文字ずつされます。入力全体を検証するには，データベースに入力内容を登録する直前に OnValidate イベントを使います。

マスクはセミコロンで区切った 3 つのフィールドから構成されます。最初の部分はマスク本体です。2 番目の部分はマスクのリテラル文字をデータの一部として保存するかどうかを指定する文字です。3 番目の部分はマスク内の空白を表す文字です。

次はマスクの最初のフィールドで使う特殊文字です。

文字	意味

     !	! があれば，EditText で省略可能な文字が先頭部分の空白として表される。! がなければ，EditText で省略可能な文字が末尾部分の空白として表される

     >	> があれば，マスク内または < までのすべての後続文字が大文字で表される

     <	< があれば，マスク内または > までのすべての後続文字が小文字で表される

     <>	<> の 2 文字がいっしょにあれば，大文字と小文字は区別されず，入力するとおりにデータが構成される

     \	\ に続く 1 文字はリテラル文字である。マスクで使う特殊文字をデータとして使う

     L	この文字の位置には英字を 1 字だけ指定しなくてはならない。A ～ Z, a ～ z のいずれかを指定できる

     l	この文字の位置には英字を 1 字だけ指定できるが指定しなくてもよい

     A	この文字の位置には英数字を 1 字だけ指定しなくてはならない。A ～ Z, a ～ z, 0 ～ 9 のいずれかを指定できる

     a	この文字の位置には英数字を 1 字だけ指定できるが指定しなくてもよい

     C	この文字の位置には任意の文字を 1 字だけ指定しなくてはならない

     c	この文字の位置には任意の文字を 1 字だけ指定できるが指定しなくてもよい

     0	この文字の位置には数字を 1 字だけ指定しなくてはならない

     9	この文字の位置には数字を 1 字だけ指定できるが指定しなくてもよい

     #	この文字の位置には数字，正符号，負符号のいずれかを 1 字指定できるが指定しなくてもよい

     :	時刻表示の時，分，秒を区切るのに使う。システムのコントロールパネルユーティリティの各国対応設定で時，分，秒を異なる文字で区切っている場合はその文字を使う

     /	/ は日付の月，日，年を区切るのに使う。システムのコントロールパネルユーティリティの各国対応設定で月，日，年を異なる文字で区切っている場合はその文字を使う

     ;	; はマスクを区切るのに使う

     _	_ は編集ボックスに自動的に空白を挿入する。フィールドに文字を入力するとカーソルは空白文字をスキップする。

これ以外の文字はリテラル文字としてマスクの最初の部分に表示できます。リテラル文字は，項目にデータを入力するときにきちんと照合されなければなりません。リテラル文字は自動的に挿入され，編集時にはカーソルはそれらの文字をスキップします。また，バックスラッシュ文字（\）を前に付ければマスク文字をリテラル文字として表示することもできます。

マスクの 2 番目のフィールドはマスクのリテラル文字を項目の Value プロパティの一部として保存するかどうかを指定する文字です。たとえば，市外局番付きの電話番号用のマスクなら，次のような文字列になります。

(000)_000-0000;0;*

2 番目のフィールドの 0 は，項目の Value プロパティは，ユーザーに表示されるとおりの，電話番号を構成する 14 個の文字ではなく，入力された 10 個の数字から成ることを示します。

2 番目のフィールドの 0 はリテラル文字を含めないことを示し，0 以外の文字はリテラル文字を含めることを示します。リテラル文字を含めるかどうかを示す文字は，EditMask プロパティエディタまたはプログラムで，Mask ユニットで定義される MaskNoSave 型付き定数を変更することによって変更できます

マスクの 3 番目のフィールドは，編集コントロールで空白（入力されていない文字）を表す文字です。デフォルトでは，リテラルスペースを表す文字と同じです。2 つの文字は編集ウィンドウでは同じように表示されます。ただし，ユーザーが項目のデータを入力するときには，カーソルは各空白文字を順番に選択しますが，スペース文字はスキップします。

EditMask に空の文字列を設定すると，マスクが除去されます。

注意

日本語シフト JIS などの多バイト文字セットを使うとき，それぞれの特殊マスク文字は単バイトを表します。L，l，A，a，C，c 指定子を使って 2 バイト文字を指定するには，マスク文字も 2 つ使う必要があります。たとえば，LL と指定すれば，単バイトの英数字 2 文字か，または，2 バイト文字 1 文字を表せます。単バイトのリテラル文字のみがサポートされています。


TField.EditMaskPtr
TField.EditMaskPtr3251027

TField	参照

EditMaskPtr プロパティは，EditMask プロパティへの読み出し専用アクセスを提供します。

property EditMaskPtr: string;

説明

EditMaskPtr プロパティは，EditMask プロパティを読み出すときに使います。EditMaskPtr は，読み出し専用プロパティなので，読み出しのみを行うコードでマスクの値を誤って変更してしまうのを防げます。


TField.FieldKind
TField.FieldKind3251028

TField	参照

FieldKind プロパティは，その項目がデータセット内の列を表しているのか，それとも計算項目や参照項目であるのかを示します。

TFieldKind = (fkData, fkCalculated, fkLookup, fkInternalCalc);

property FieldKind: TFieldKind;

説明

FieldKind プロパティを使うと，その項目がデータ項目であるのか，あるいは計算項目や参照項目であるのかを判別できます。FieldKind の値はプログラムで変更できますが，実際には，FieldKind は，設計時に項目エディタを使って項目コンポーネントを作成するときに自動的に設定されます。

FieldKind プロパティは次の値のいずれかをとります。

値	説明

fkData	項目はデータベーステーブルの物理項目を表す

fkCalculated	項目は OnCalcFields イベントハンドラで計算される

fkLookup	項目は参照項目である

fkInternalCalc	項目は計算されるが，値はデータセットに格納されない

注意

ライブデータセットを返す問い合わせの結果を表示するために SQL サーバーまたはボーランドデータベースエンジンによって計算される項目の場合，FieldKind は fkCalculated ではなく fkInternalCalc になります。これは，項目値がデータセットに格納されるためです。クライアントデータセットの計算項目は OnCalcFields イベントハンドラで計算されますが，データセットに内部的に格納されます。それらの計算項目でも FieldKind は fkCalculated ではなく fkInternalCalc になります。通常の計算項目とは異なり，これらの項目はフィルタ式で使うことができます。また，編集することもできますが，変更内容は破棄されます。編集できないようにするには，ReadOnly プロパティを True に設定します。


TField.FieldName
TField.FieldName3251029

TField	参照

FieldName プロパティは，項目コンポーネントが結び付けられているデータセットの物理的な列の名前です。

property FieldName: string;

説明

項目コンポーネント作成時に TFieldDef オブジェクトは，FieldName プロパティを使ってその項目コンポーネントが基になるデータセット内のどの項目を表すかを指定します。DisplayLabel が設定されていなければ，FieldName はユーザーに対して項目への参照を表示するときに使用されます。計算項目の FieldName は項目を定義するときに指定します。計算されない項目の場合，FieldName が物理テーブルの列の名前でないと EDatabaseError の例外が生成されます。


TField.FieldNo
TField.FieldNo3251030

TField	参照

FieldNo プロパティは，データセットの基になる物理テーブル内での項目コンポーネントの実際の列の順序です。

property FieldNo: Integer;

説明

FieldNo プロパティを読み出すと，データセットの基になるテーブル内での項目コンポーネントの位置を調べることができます（1 が 1 番目の項目）。ボーランドデータベースエンジン API を直接呼び出すことにより，FieldNo プロパティを使って項目を指定できます

注意

FieldNo と Index とを混同しないようにしてください。FieldNo は項目コンポーネントの物理データベーステーブル内での位置であり，Index はデータセットの Fields プロパティ内での項目コンポーネントの位置です。


TField.HasConstraints
TField.HasConstraints3251031

TField	参照

HasConstraints プロパティは，項目値に制約が設定されているかどうかを示します。

property HasConstraints: Boolean;

説明

HasConstraints プロパティは，項目コンポーネントでカスタム制約，インポートされる制約，またはデフォルト式が設定されているかどうかを取得できます。HasConstraints プロパティは，CustomConstraint，DefaultExpression，または ImportedConstraint プロパティが設定されている場合は True です。それ以外の場合は，HasConstraints は False で，サーバーまたはデータベースエンジンが項目値に対して制約を設定していないことを示します。

HasConstraints が False でも，項目値は制限できます。たとえば，編集マスクまたは OnValidate イベントハンドラで項目値を制約することができます。ただし，これらの制約は Delphi アプリケーションによるものであり，サーバーまたはデータベースエンジンによるものではありません。


TField.ImportedConstraint
TField.ImportedConstraint3251032

TField	参照

ImportedConstraint プロパティは，サーバーによって項目の値に対して設定されている制約を示す SQL 節です。

property ImportedConstraint: string;

説明

ImportedConstraint プロパティは，サーバーにより項目で有効な値について設定されている制限を取得できます。ImportedConstraint は次のような SQL 検索式です。

Value > 0 and Value < 100

ImportedConstraint の値は変更しないでください。項目値に制約を追加するには，かわりに CustomConstraint プロパティを使います。カスタム制約は，インポートされる制約に追加して設定されます。サーバー制約が変更された場合，ImportedConstraint の値は変更されますが，CustomConstraint プロパティで導入された制約は存続します。

ImportedConstraint プロパティから制約を削除しても，それらの制約に違反する項目値の有効性は変更されません。制約を削除すると，ローカルでではなくサーバーによって制約のチェックが行われるようになります。制約のチェックがローカルで行われるときは，違反が見つかると，サーバーからのエラーメッセージではなく，ConstraintErrorMessage プロパティで指定したエラーメッセージが表示されます。


TField.Index
TField.Index3251033

TField	参照

Index プロパティは，データセットの Fields プロパティでのインデックス番号です。

property Index: Integer;

説明

Index プロパティを使うと，次のことができます。

・	データセット内での項目の位置を調べる

・	Index 値を変更することにより，データセット内での項目の位置の順序を変更する。Index 値を変更すると，項目がデータグリッドに表示される順序は変更されるが，物理データベーステーブル内での項目の位置は変更されない

注意

設計時に項目エディタで項目をドラッグアンドドロップすることによっても，項目の順序を変更することができます。


TField.IsIndexField
TField.IsIndexField3251034

TField	参照

IsIndexField プロパティは，項目がインデックス付けされているかどうかを示します。

property IsIndexField: Boolean;

説明

IsIndexField プロパティは，項目がインデックス項目であるかどうかを取得できます。IsIndexField が True なら，その項目は基になるデータベーステーブルのインデックスとなる項目です。IsIndexField が False なら，その項目はインデックス項目ではありません。参照テーブル内の LookupKeyFields 用の項目コンポーネントとして使用する場合は，項目コンポーネントはインデックス項目でなければなりません。


TField.IsNull
TField.IsNull3251035

TField	参照

IsNull プロパティは，項目に割り当てられている値があるかどうかを判定します。

property IsNull: Boolean;

説明

IsNull プロパティは，その項目に値が入っているかどうかを判別できます。IsNull が True ならば，その項目は空白です。IsNull が False ならば，その項目には値があります。


TField.KeyFields
TField.KeyFields3251036

TField	参照

KeyFields プロパティは，項目のデータセット内の 1 つまたは複数の項目を識別し，それらの項目は参照を実行するときに参照データセット内で突き合わされます。

property KeyFields: string;

説明

KeyFields プロパティは参照項目（FieldKind が fkLookup で，Lookup が True の項目）でのみ設定します。KeyFields は参照を実行するときに照合する項目を指定します。複数の項目を使う場合には，項目名をセミコロンで区切ります。KeyFields に指定した項目は LookupKeyFields 内の対応する項目と同じ型でなければなりません。そうでない場合，参照は機能しません。

DataSet 内の KeyFields の値を LookupDataSet 内の LookupKeyFields の値と照合して参照テーブル内の特定のレコードが判別されます。そのレコードの LookupResultField 値がその項目コンポーネントの Value プロパティになります。


TField.Lookup
TField.Lookup3251037

TField	参照

Lookup プロパティは，参照項目として指定されているかどうかを決めます。

property Lookup: Boolean;

説明

Lookup プロパティは下位互換性のために提供されています。項目が参照項目であるかどうかを調べるには，かわりに FieldKind プロパティを使います。

項目が参照項目の場合，KeyFields プロパティは，LookupDataSet 内のレコードを識別するために，LookupDataSet 内の LookupKeyFields と照合させるための，データセット内の項目を示します。そのレコードの LookupResultField 値がその項目コンポーネントの Value プロパティになります。


TField.LookupCache
TField.LookupCache3251038

TField	参照

LookupCache プロパティは，データセット内のカレントレコードが変更されるたびに参照項目の値がキャッシュされるかまたは動的に参照されるかを決めます。

property LookupCache: Boolean;

説明

LookupCache プロパティを True に設定すると，LookupDataSet が変更されそうになく，異なる参照値の数が少ないときに参照項目の値がキャッシュされます。参照値をキャッシュすると，DataSet が開いたときにすべての LookupKeyFields 値のセットの参照値が事前にロードされるので，処理効率を向上できます。DataSet 内のカレントレコードが変更されるとき，項目オブジェクトは LookupDataSet にアクセスしないで，キャッシュ内で Value を見つけることができます。このようにすると，特にアクセスに時間がかかるネットワーク上に LookupDataSet がある場合には大幅に処理効率が改善されます。

DataSet のすべてのレコードの KeyFields の値が異なる場合は，キャッシュで値を見つけるオーバーヘッドは，キャッシュによってもたらされる利点よりも大きくなります。キャッシュで値を見つけるオーバーヘッドは KeyFields がとることのできる異なる値の数に比例して増加します。

LookupDataSet が変動する場合，参照値のキャッシュの結果が正確にならないことがあります。RefreshLookupList メソッドを呼び出すと，参照キャッシュの値を更新できます。RefreshLookupList メソッドは，すべての LookupKeyFields 値のセットの LookupResultField の値が保持されている LookupList プロパティを再生成します。

実行時に LookupCache を設定するときは，RefreshLookupList メソッドを呼び出してキャッシュを初期化します。

注意

LookupCache は，FieldKind の値が fkLookup である場合にのみ有効です。


TField.LookupDataSet
TField.LookupDataSet3251039

TField	参照

LookupDataSet プロパティは，項目値を参照するために使われるデータセットを識別します。

property LookupDataSet: TDataSet;

説明

LookupDataSet プロパティは，FieldKind プロパティが fkLookup に設定されている項目で項目値を参照するのに使うデータセットを指定できます。

項目コンポーネントが参照項目なら，その項目コンポーネントの Value は LookupDataSet 内の LookupResultField の値です。正しい値が入っている LookupDataSet 内のレコードは，LookupDataSet 内の LookupKeyFields と DataSet 内の KeyFields の現在の値とを照合することによって見つけることができます。


TField.LookupKeyFields
TField.LookupKeyFields3251040

TField	参照

LookupKeyFields プロパティは，参照を実行するときに照合する参照データセット内の 1 つまたは複数の項目を識別します。

property LookupKeyFields: string;

説明

LookupKeyFields プロパティは FieldKind プロパティが fkLookup に設定されている項目コンポーネントでのみ使用します。LookupKeyFields は LookupDataSet のインデックス内の項目で，その値が項目コンポーネントの DataSet 内の KeyFields と照合されます。

複数の項目を指定するには，個々の項目名をセミコロンで区切ります。LookupKeyFields に指定する項目は LookupSourceFields 内の対応する項目と同じでなければなりません。そうでない場合，参照は機能しません。

LookupDataSet 内の LookupKeyFields の値と，DataSet 内の KeyFields の値とを照合することにより，LookupDataSet 内の特定のレコードが判別されます。項目コンポーネントの Value プロパティは，示されたレコード内の LookupResultField の値です。


TField.LookupList
TField.LookupList3251041

TField	参照

LookupList プロパティは，KeyFields プロパティの値のセットによってインデックス付けされた LookupDataSet の値のキャッシュです。

property LookupList: TLookupList;

説明

LookupList プロパティは，KeyFields で指定した項目の任意の値のセット用に項目に割り当てられたキャッシュ値を見つけることができます。LookupList の値は，データセットが開かれたとき，または RefreshLookupList メソッドが呼び出されたときに設定されます。また，参照データセットが実際に存在しないとき，アプリケーションは LookupList をプログラムで設定して，参照値を提供することもできます。

LookupList の ValueOfKey メソッドは，LookupKeyFields の値のセット用の LookupResultField の値を返します。このため，参照項目オブジェクトの値は次のように計算できるようになります。

Value := LookupList.ValueOfKey(DataSet.FieldValues[KeyFields]);

注意

LookupList は FieldKind の値が fkLookpup で，LookupCache プロパティが True の場合にのみ有効です。


TField.LookupResultField
TField.LookupResultField3251042

TField	参照

LookupResultField プロパティは，項目コンポーネントの Value プロパティになる値を持つ参照データセットから項目を識別します。

property LookupResultField: string;

説明

LookupResultField プロパティは，項目コンポーネントの値となる値を持つ LookupDataSet 内の 1 つの項目を指定できます。項目コンポーネントの FieldKind プロパティは fkLookup で，DataType プロパティは LookupResultField のデータ型と同じでなければなりません。

項目コンポーネントが参照項目なら，その項目コンポーネントの Value は LookupDataSet 内の LookupResultField の値です。正しい値が入っている LookupDataSet 内のレコードは，LookupDataSet 内の LookupKeyFields と DataSet 内の KeyFields の現在の値とを照合することによって見つけることができます。


TField.NewValue
TField.NewValue3251043

TField	参照

NewValue プロパティは，キャッシュされている項目の現在の値を表します。

property NewValue: Variant;

説明

NewValue プロパティは，複数のレコードの登録を処理しているときに項目の現在値を取得および設定することができます。現在の項目値が原因で，キー違反など，キャッシュアップデートの適用に問題がある場合，データセットは OnUpdateError イベントを生成します。同様に，TProvider オブジェクトはクライアントからのレコードを登録するときに問題が起こると OnUpdateError イベントを生成し，クライアントデータセットはサーバーにより問題が通知されると OnReconcileError イベントを生成します。イベントハンドラで，NewValue に新しい値を割り当てて問題を修正できます。

レコードの登録中にエラーが発生したときを除いて，NewValue は Value と同じです。OnUpdateError イベントハンドラ，OnUpdateRecord イベントハンドラまたは OnReconcileError イベントハンドラで NewValue を設定すると，基になるデータベーステーブルへのレコードの登録が完了するまでは，NewValue と Value とが別の値になります。


TField.Offset
TField.Offset3251044

TField	参照

Offset プロパティは，計算項目または BLOB 項目用にキャッシュされる値を格納するためにデータセットのカレントレコードバッファの最後に追加されるバイト数です。

property Offset: word;

説明

Offset プロパティは，計算項目または BLOB 項目についてのキャッシュ情報用に割り当てられている TClientDataSet オブジェクトのレコードバッファ内の予備スペースを取得できます。Offset は，新たに TClientDataSet の下位オブジェクトを開発するときにのみ使用します。


TField.OldValue
TField.OldValue3251045

TField	参照

OldValue プロパティは，元の項目値を (Variant として) 表します。

property OldValue: Variant;

説明

OldValue プロパティは，新しい値がレコードバッファに書き込まれるされる前の，データセットから取得した元の項目値を調べたり，取り出したりすることができます。たとえば，次のコードは現在ペンディング中の変更内容を元の項目値に置換します。

NewValue := OldValue;

いったんレコードが正常に登録されると，古い項目値は取り出せなくなります。


TField.Origin
TField.Origin3251046

TField	参照

Origin プロパティは，元のデータセット内での項目名です。

property Origin: string;

説明

Origin プロパティは，データセット内での項目名とその項目の元になっている項目名を区別できます。たとえば，次の SQL 文を使う問い合わせでは，Origin の値は CUSTOMER.CUSTNO です。

SELECT CUSTNO AS ID FROM CUSTOMER

ここでは FieldName プロパティは ID です。

Origin は，どのテーブルの項目かを識別するので，マルチテーブル結合を使うときに特に便利です。

注意

Origin は，設計時に項目エディタによってのみ，および項目コンポーネントが TQuery オブジェクトによって使われるときにのみ設定されます。


TField.ReadOnly
TField.ReadOnly3251047

TField	参照

ReadOnly プロパティは，その項目が変更可能であるかどうかを決めます。

property ReadOnly: Boolean;

説明

ReadOnly プロパティを True に設定すると，その項目は変更できなくなります。データグリッドで〔Tab〕キーを押して項目から項目に移動するとき，ReadOnly 項目にはカーソルは入りません。

項目が変更可能かどうかを調べるには，ReadOnly ではなく，CanModify プロパティを使います。CanModify は，ReadOnly プロパティの値だけでなく, 元になるデータセットによる制限も反映します。


TField.Required
TField.Required3251048

TField	参照

Required プロパティは，項目に nil 以外の値が必要かどうかを指定します。

property Required: Boolean;

説明

Required プロパティは，項目に値が必要か，空にしておいてよいかを判定できます。

項目が項目エディタで作成された場合，このプロパティは基になるテーブルに従って設定されます。アプリケーションで値（たとえばパスワード，部品番号など）が必要な項目について Required を True に設定したが，基になるテーブルがその項目を必要としていない場合は，このプロパティを評価するように OnValidate イベントハンドラを記述する必要があります。

Required プロパティが基になるデータベーステーブルのプロパティを反映していれば，ヌル値を登録しようとすると例外が生成されます。基になるテーブルがその項目を必要としていないときに，Required プロパティを True に設定するアプリケーションは，同じ結果が得られるように，OnValidate イベントハンドラの nil 値に対して例外を生成する必要があります。


TField.Size
TField.Size3251049

TField	参照

Size プロパティは，異なるサイズをサポートするデータ型に対する物理データベース項目の定義で使用されるサイズを示します。

property Size: Word;

説明

Size の意味はデータ型によって異なります。Size はボーランドデータベースエンジンによって項目に関連付けられているサイズです。それぞれのデータ型での Size の意味は次のとおりです。

データ型	Size の意味

ftBoolean	Size は使用されない。値は常に 0

ftSmallInt	Size は使用されない。値は常に 0

ftWord	Size は使用されない。値は常に 0

ftAutoInc	Size は使用されない。値は常に 0

ftDate	Size は使用されない。値は常に 0

ftInteger	Size は使用されない。値は常に 0

ftTime	Size は使用されない。値は常に 0

ftCurrency	Size は使用されない。値は常に 0

ftDateTime	Size は使用されない。値は常に 0

ftFloat	Size は使用されない。値は常に 0

ftBCD	Size は小数点以下の桁数

ftString	Size は文字列内の文字の最大数

ftVarBytes	Size はデータの最大バイト数。ただし，使用されたデータの実際のバイト数を示す最初の 2 バイトは含まない

ftBytes	Size はデータの最大バイト数

ftBlob	Size はレコードバッファ内に格納されている BLOB からのバイト数

ftDBaseOle	Size はレコードバッファ内に格納されている dBASE OLE BLOB からのバイト数

ftFmtMemo	Size はレコードバッファ内に格納されているメモからのバイト数

ftGraphic	Size はレコードバッファ内に格納されているイメージからのバイト数

ftMemo	Size はレコードバッファ内に格納されているメモからの文字数

ftParadoxOle	Size はレコードバッファ内に格納されている Paradox OLE BLOB からのバイト数

ftTypedBinary	Size はレコードバッファ内に格納されている BLOB からのバイト数

ftUnknown	Size は使用されない。値は常に 0

ftCursor	Size は使用されない。値は常に 0


TField.Text
TField.Text3251050

TField	参照

Text プロパティは，編集モードにあるデータベース対応コントロールで項目を表示するときの文字列値です。

property Text: string;

説明

データベース対応コントロールは Text プロパティに基づいて，各項目に編集形式を提供します。たとえば，デフォルトで，通貨型項目の Text プロパティは千の位の区切り記号と通貨記号を省略します。

項目に，値の編集時用の文字列値が別にある場合，Text は DisplayText プロパティと別にすることができます。1 つの項目値に対して 2 通りの文字列値を実現するには，OnGetText イベントハンドラを使います。OnGetText イベントハンドラが割り当てられている場合は，Text は DisplayText パラメータが False のときに OnGetText イベントハンドラの Text で返される値です。それ以外の場合は，Text は AsString プロパティの値です。


TField.ValidChars
TField.ValidChars3251051

TField	参照

ValidChars プロパティは，項目の値のテキスト値を構成する文字のセットです。

TFieldChars = set of Char;

property ValidChars: TFieldChars;

説明

ValidChars プロパティを設定すると，項目の値のテキスト値の一部として入力するのに有効な文字を制限できます。ValidChars は， IsValidChar メソッドによって，データ対応編集コントロールに入力された文字が項目値の一部になることができるかどうかを判定するのに使われます。特定の位置にどの文字がくるかを指定する EditMask プロパティとは異なり，ValidChars プロパティは項目の値の中のどこにくる文字でも制限します。

TField は ValidChars を初期化して，すべての文字が含まれるようにします。TField の数値型下位オブジェクトは数値を示す文字だけが含まれるようにデフォルト値を変更します。アプリケーションはこの値を変更して，項目で制限される文字の集合を別の集合に変更したり，デフォルトでは使えない文字を有効にしたりすることができます。


TField.Value
TField.Value3251052

TField	参照

Value プロパティには，項目コンポーネント内の実際のデータが入ります。

property Value: Variant

説明

Value プロパティは実行時に項目コンポーネントのデータを直接読み出したり書き込んだりするときに使います。たとえば，Value プロパティを使うと，Visible でない項目の内容を変更することができます。


TField.Visible
TField.Visible3251053

TField	参照

Visible プロパティは，項目をデータグリッドに表示するかどうかを決めます。

property Visible: Boolean;

説明

項目をデータグリッドに表示しないようにするには，Visible を False に設定します。Visible が True ならば，その項目はデータグリッドに表示されます。

注意

Visible プロパティは，データグリッドで項目の Columns 値を明示的に指定している場合には無効です。また，TDBEdit など，TDBGrid 以外のコントロールに対しても無効です。


TField イベント3251054

TField	アルファベット順	凡例

TField

OnChange

OnGetText

OnSetText

OnValidate


TField イベント3251055

TField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TField.OnChange
TField.OnChange3251056

TField	参照

OnChange イベントは，項目内のデータがレコードバッファに書き込まれた直後に発生します。

TFieldNotifyEvent = procedure(Sender: TField) of object;

property OnChange: TFieldNotifyEvent;

説明

OnChange イベントハンドラを記述すると，項目のデータのどのような変更に対しても応答することができます。OnChange は，データがレコードバッファに正しく書き込まれたら，応答を許可します。

項目の値を現在のレコードバッファに書き込むときには，以下の処理が行われます。

1.	OnValidate イベントハンドラが呼び出されてデータが検証される

2.	OnValidate イベントハンドラが現在の Value を受け入れる場合，データがレコードバッファに書き込まれる

3.	データの書き込みで例外が生成されない場合は，OnChange イベントハンドラが呼び出され，変更に対する応答が許可される


TField.OnGetText
TField.OnGetText3251057

TField	参照

OnGetText イベントは，項目の DisplayText または Text プロパティが参照されたときに発生します。

TFieldGetTextEvent = procedure(Sender: TField; var Text: string; DisplayText: Boolean) of object;

property OnGetText: TFieldGetTextEvent;

説明

OnGetText イベントハンドラを記述すると，DisplayText および Text プロパティに対して特別の処理が実行されるようにすることができます。OnGetText を使うと，編集時に，項目の Value を単に値を表示するだけのときに使用される形式とは別の形式にフォーマットしたり，表示の際に項目の値以外のものを表示したりすることができます。

Sender パラメータは項目コンポーネント自身です。Text パラメータは DisplayText または Text プロパティによって使用される形式付きのテキストを受け取ります。DisplayText パラメータは，テキストが表示の目的のみで使用されるかどうか，あるいはその文字列が編集の目的でも使用されるかどうかを示します。

OnGetText イベントハンドラがない場合は，DisplayText および Text プロパティの値は AsString プロパティの値になります。


TField.OnSetText
TField.OnSetText3251058

TField	参照

OnSetText イベントは，Text プロパティに値が割り当てられたときに発生します。

TFieldSetTextEvent = procedure(Sender: TField; const Text: string) of object;

property OnSetText: TFieldSetTextEvent;

説明

OnSetText イベントハンドラを記述すると，Text が新しい値を受け取ったときに実行される処理を指定できます。編集の目的で特別な方法で項目の Value をフォーマットする OnGetText イベントハンドラがある場合，OnSetText は編集された文字列を解析するときにその処理を元に戻す必要があります。

OnSetText イベントハンドラがない場合は，Text プロパティは，AsString プロパティを設定することで設定されます。


TField.OnValidate
TField.OnValidate3251059

TField	参照

OnValidate イベントは，データがレコードバッファに書き込まれる直前に発生します。

TFieldNotifyEvent = procedure(Sender: TField) of object;

property OnValidate: TFieldNotifyEvent;

説明

OnValidate イベントハンドラを記述すると，項目内のデータに対して加えられた変更内容を，現在のレコードバッファに書き込まれる直前に検証することができます。EditMask プロパティを使うと，ユーザーがデータを入力しているときに 1 文字単位でのデータの検証を行えますが，OnValidate を使えば，アプリケーションはデータを全体として検証することができます。

項目コンポーネントの値がプログラムで割り当てられるときは，マスクへの準拠を強制するデータベース対応コントロールはないので，EditMask による検証はバイパスされてしまいます。OnValidate により，そのようなデータをデータベーステーブルに登録する前にアプリケーションで検証することができます。

OnValidate イベントハンドラからの項目の現在値を受け付けないようにするには，例外を生成します。

項目値を現在のレコードバッファに書き込むときには，以下の処理が行われます。

1.	OnValidate イベントハンドラが呼び出され，データが検証される

2.	OnValidate イベントハンドラが例外を生成しない場合は，データが現在のレコードバッファに書き込まれる

3.	データの書き込みで例外が生成されなければ，OnChange イベントハンドラが呼び出されて，変更に対する応答が許可される


TField メソッド3251060

TField	アルファベット順

TField

Assign

AssignValue

Clear

Create

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TField メソッド3251061

TField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TField.Assign
TField.Assign3251062

TField	参照

Assign メソッドは，1 つの項目の Value プロパティを別の項目に割り当てるか，別のオブジェクトをその項目コンポーネントに割り当てます。

procedure Assign(Source: TPersistent);

説明

Assign メソッドを呼び出すと，Value プロパティを 1 つの項目から別の項目にコピーできます。その場合，項目のデータ型には互換性がなければなりません。

Source が別の項目オブジェクトのとき，Assign は Source 項目の Value プロパティを使って AssignValue メソッドを呼び出します。Source パラメータを nil に設定して Assign を呼び出すと，その項目コンポーネントには空の値が割り当てられます。他のオブジェクト型を指定して Assign を呼び出すと，継承するメソッドが呼び出され，このメソッドにより，AssignTo メソッドで TField オブジェクトを実現するオブジェクトからの代入が可能になります。


TField.AssignValue
TField.AssignValue3251063

TField	参照

AssignValue メソッドは，項目を Value に設定します。このとき Value の型によって AsInteger，AsBoolean，AsString，AsFloat のプロパティのいずれかが使われます。

procedure AssignValue(const Value: TVarRec);

説明

AssignValue メソッドを呼び出すと，As... 変換プロパティを使って値を項目に割り当てることができます。使用される変換プロパティは Value パラメータの型によって異なります。

値	使用される As... プロパティ

vtInteger	AsInteger

vtBoolean	AsBoolean

vtChar	AsString

vtExtended	AsFloat

vtString	AsString

vtPChar	AsString

vtAnsiString	AsString

vtCurrency	AsCurrency

vtVariant	AsVariant

TObject 型または TObject の下位オブジェクト型である場合は，AssignValue は Assign メソッドを使って値を項目に割り当てます。


TField.Clear
TField.Clear3251064

TField	参照

Clear メソッドは，項目の値をヌルに設定します。

procedure Clear;

説明

Clear メソッドを呼び出すと，項目の値を空にすることができます。


TField.Create
TField.Create3251065

TField	参照

Create メソッドは，項目コンポーネントを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，TField インスタンスを新たに作成して初期化し，新しく作成したコントロールを，AOwner パラメータによって指定されるオーナーに挿入することができます。継承されたコンストラクタを呼び出した後で，Create は Visible プロパティを True に初期化します。

TField に対しては Create を呼び出さないでください。TField は，直接インスタンス化できない抽象基本クラスです。通常は，設計時に項目エディタを使って静的な項目コンポーネントを作成することにより，下位クラスの Create メソッドを間接的に呼び出します。また，データセットオブジェクトも，動的な項目コンポーネントを作成するために自動的に Create メソッドを呼び出します。


TField.Destroy
TField.Destroy3251066

TField	参照

Destroy メソッドは，TField のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。Destroy メソッドは，項目コンポーネントを所有するデータセットによって自動的に呼び出されるので，アプリケーションが明示的に呼び出す必要はありません。アプリケーションがオーナーを設定せずに TField の下位オブジェクトを作成した場合は，Destroy のかわりに Free メソッドを呼び出す必要があります。Free メソッドは項目オブジェクトが解放されていないことを確認してからのみ Destroy を呼び出します。

Destroy はデータセットを閉じ，データセットから TField のインスタンスを削除して，継承されたデストラクタを呼び出します。


TField.FocusControl
TField.FocusControl3251067

TField	参照

FocusControl メソッドは，その項目オブジェクトに関連付けられている最初のデータベース対応コンポーネントにフォームのフォーカスを設定します。

function FocusControl;

説明

FocusControl メソッドを呼び出すと，フォームのフォーカスを項目に関連付けられているデータベース対応コンポーネントに移動させることができます。項目の値は，関連付けられているデータベース対応コントロールにフォーカスがない場合でも変更されることがあるので，FocusControl を呼び出すことにより，検証に失敗したときに新しい値に対する注意を喚起できます。


TField.GetData
TField.GetData3251068

TField	参照

GetData メソッドは，項目から形式が設定されていないデータを返します。

function GetData(Buffer: Pointer): Boolean;

説明

GetData メソッドを呼び出すと，項目内の形式が設定されていない，変換されていないデータをバッファに返すことができます。

DisplayText，Text，AsXXX の各プロパティとは違い，GetData ではデータを変換しません。Buffer にはデータの格納に十分な領域が割り当てられていなくてはなりません。必要な領域を調べるには DataSize プロパティを使います。データがヌルの場合，GetData は False を返し，Buffer にはデータは転送されません。それ以外の場合は True を返します。

注意

GetData は BLOB 項目からデータを読み出す場合には使用できません。


TField.IsBlob
TField.IsBlob3251069

TField	参照

IsBlob メソッドは，項目がバイナリラージオブジェクト（BLOB）項目でデータを表示するかどうかを示します。

class function IsBlob: Boolean; virtual;

説明

IsBlob メソッドを呼び出すと，項目が BLOB データを表示するかどうかを判定できます。たとえば，GetData または SetData メソッドを使う前に IsBlob メソッドを呼び出せば，そのメソッドが使えるかどうかがわかります。TField の IsBlob メソッドは常に False を返します。blob 項目を実現する TField の下位オブジェクトは，BLOB データを表示することを示すようにこのメソッドをオーバーライドします。


TField.IsValidChar
TField.IsValidChar3251070

TField	参照

IsValidChar メソッドは，項目に入力された特定の文字が有効であるかどうかを示します。

function IsValidChar(InputChar: Char): Boolean; virtual;

説明

IsValidChar メソッドを呼び出すと，InputChar の値として指定した文字が項目の値のテキスト値で表示できるかどうかを判定できます。多くのデータベース対応コントロールは IsValidChar メソッドを使って，ユーザーによって入力された文字が有効かどうかをチェックします。IsValidChar は InputChar が項目に表示できる場合は True を返します。IsValidChar は InputChar が項目型に対して有効でない文字の場合は False を返します。

項目オブジェクトで有効な文字は ValidChars プロパティで決まります。各データ型のデフォルトで有効な文字を以下に示します。

データ型	有効な文字

ftBoolean	すべての文字

ftSmallInt	0 ～ 9 の数字，正符号（+）と負符号（-）

ftWord	0 ～ 9 の数字，正符号（+）と負符号（-）

ftAutoInc	0 ～ 9 の数字，正符号（+）と負符号（-）

ftDate	すべての文字

ftInteger	0 ～ 9 の数字，正符号（+）と負符号（-）

ftTime	すべての文字

ftCurrency	0 ～ 9 の数字，正符号（+）と負符号（-），文字 E （E または e），Windows コントロールパネルの地域設定での小数点区切り文字

ftDateTime	すべての文字

ftFloat	0 ～ 9 の数字，正符号（+）と負符号（-），文字 E （E または e），Windows コントロールパネルの地域設定での小数点区切り文字

ftBCD	0 ～ 9 の数字，正符号（+）と負符号（-），Windows コントロールパネルの地域設定での小数点区切り文字

ftString	すべての文字

ftVarBytes	すべての文字

ftBytes	すべての文字

ftBlob	すべての文字

ftDBaseOle	すべての文字

ftFmtMemo	すべての文字

ftGraphic	すべての文字

ftMemo	すべての文字

ftParadoxOle	すべての文字

ftTypedBinary	すべての文字

ftUnknown	すべての文字

ftCursor	すべての文字

注意

ftGraphic，IsValidChar など一部のデータ型はすべての文字に対して True を返しますが，項目に有効でない文字もあります。IsValidChar では入力文字が大まかに検証されるだけです。より厳密に 1 文字ごとでの検証を行うには，編集マスクを使います。また，項目の値はデータベースレコードに書き込まれるときに全体として検証されます。


TField.RefreshLookupList
TField.RefreshLookupList3251071

TField	参照

RefreshLookupList メソッドは，LookupKeyFields の異なる値に一致するすべての LookupResultField の値とともに LookupList をロードします。

procedure RefreshLookupList;

説明

RefreshLookupList メソッドを呼び出すと，実行時に LookupCache プロパティを設定するとき，または LookupResultField または LookupDataSet の LookupKeyFields の値が変更された可能性があるときに，参照キャッシュをロードできます。


TField.SetData
TField.SetData3251072

TField	参照

SetData メソッドは，形式が設定されていないデータを項目に代入します。

procedure SetData(Buffer: Pointer);

説明

SetData メソッドを使うと，基になるデータベーステーブルで使用されていた形式のままでデータを項目に代入できます。項目コンポーネントのデータを設定するどのようなメソッドも，データがデータベーステーブルで指定されている物理形式に解析されたら，最終的に SetData を呼び出します。

SetData は OnValidate イベントハンドラを呼び出してから，データを現在のレコードバッファに書き込みます。データの書き込みが正しく行われたら，SetData は OnChange イベントハンドラを呼び出します。

注意

SetData は BLOB 項目型を実現する TField の下位コンポーネントでは使用しないでください。


TField.SetFieldType
TField.SetFieldType3251073

TField	参照

SetFieldType メソッドは，項目に DataType を設定できるメソッドにインターフェースを提供します。

TFieldType = (ftUnknown, ftString, ftSmallint, ftInteger, ftWord, ftBoolean, ftFloat, ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftBytes, ftVarBytes, ftAutoInc, ftBlob, ftMemo, ftGraphic, ftFmtMemo, ftParadoxOle, ftDBaseOle, ftTypedBinary, ftCursor);

procedure SetFieldType(Value: TFieldType);

説明

SetFieldType メソッドは，オーバーライドして項目コンポーネントに DataType を設定するメソッドを実現するためのインターフェースを派生クラスに提供する以外は何もしません。SetFieldType は複数の基になるデータ型をサポートできる派生クラスにとって有用です。たとえば，TBlobField は ftBlob，ftFmtMemo，ftParadoxOle，ftDBaseOle，ftTypedBinary をサポートすることがあります。


TField.Validate
TField.Validate3251074

TField	参照

Validate メソッドは，OnValidate イベントハンドラが割り当てられていれば，OnValidate イベントハンドラを呼び出します。

procedure Validate(Buffer: Pointer);

説明

Validate メソッドは，Buffer パラメータが指す，形式が設定されていないデータを検証できます。Validate は，新しい値をカレントレコードに書き込むときにデータセットによって呼び出されます。

OnValidate イベントハンドラを呼び出す前に，Validate は，項目の値を表すプロパティがこの値の形式設定済みの値を返すように，形式が設定されていない Buffer 内のデータをセットアップします。Buffer の値は OnValidate イベントハンドラの外部で項目の値に影響しません。


スコープ3251075

published

読み出し／書き込み

読み出し専用


スコープ3251076

published


継承3251077

TObject

TPersistent

TComponent


TField 例3251078

TField


TFieldDef
TFieldDef3252001

継承	プロパティ	メソッド

TFieldDef オブジェクトは，データセットの基本となるテーブルのレコードの物理項目に対応する項目定義です。

ユニット

db

説明

項目定義はデータセット内の項目ごとに自動的に作成されます。項目の定義には必ず対応する TField オブジェクトがありますが，すべての TField オブジェクトに対応する項目定義オブジェクトがあるわけではありません。たとえば，計算項目には項目定義オブジェクトはありません。

TFieldDef オブジェクトは，主に次の 2 つのことを行うのに使用します。

・	テーブルを開かずにテーブル内の項目型についての情報を得る

・	新規にテーブル作成する

各項目定義は，データセットのすべての項目定義が入っている TFieldDefs オブジェクトの Items プロパティに保持されます。

TFieldDef オブジェクトのプロパティとメソッドを使うと，データセット内の対応する物理項目の特性を調べることができます。

参照

TFieldDefs オブジェクト


TFieldDef プロパティ3252002

TFieldDef	アルファベット順	凡例

TFieldDef

DataType

FieldClass

FieldNo

InternalCalcField

Name

Precision

Required

Size


TFieldDef プロパティ3252003

TFieldDef	オブジェクト順	凡例

DataType

FieldClass

FieldNo

InternalCalcField

Name

Precision

Required

Size


TFieldDef.DataType
TFieldDef.DataType3252004

TFieldDef	参照

DataType プロパティは，物理項目の型を判定します。

TFieldType = (ftUnknown, ftString, ftSmallint, ftInteger, ftWord, ftBoolean, ftFloat, ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftBytes, ftVarBytes, ftAutoInc, ftBlob, ftMemo, ftGraphic, ftFmtMemo, ftParadoxOle, ftDBaseOle, ftTypedBinary, ftCursor);

TFieldType = (ftUnknown, ftString, ftSmallint, ftInteger, ftWord, ftBoolean, ftFloat,

  ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftBytes, ftVarBytes, ftAutoInc,

  ftBlob, ftMemo, ftGraphic, ftFmtMemo, ftParadoxOle, ftDBaseOle, ftTypedBinary, ftCursor);

property DataType: TFieldType;

説明

DataType プロパティを使うと，項目内のデータの型を調べることができます。各値は次の表のとおりです。

値	意味

ftUnkown	未知または未定

ftString	文字または文字列項目

ftSmallint	16 ビット整数項目

ftInteger	32 ビット整数項目

ftWord	16 ビット符号なし整数項目

ftBoolean	論理型項目

ftFloat	浮動少数点数値型項目

ftCurrency	金額型項目

ftBCD	2 進化 10 進数型項目

ftDate	日付型項目

ftTime	時刻型項目

ftDateTime	日付時刻型項目

ftBytes	固定長バイト型項目（バイナリ格納）

ftVarBytes	可変長バイト型項目（バイナリ格納）

ftAutoInc	自動インクリメント 32 ビット整数カウンタ型項目

ftBlob	BLOB 項目

ftMemo	テキストメモ項目

ftGraphic	ビットマップ項目

ftFmtMemo	書式付きメモ項目

ftParadoxOle	Paradox OLE 項目

ftDBaseOle	dBASE OLE 項目

ftTypedBinary	型付きバイナリ項目

ftCursor	TFieldDef では使われない

DataType は読み出し専用プロパティです。


TFieldDef.FieldClass
TFieldDef.FieldClass3252005

TFieldDef	参照

FieldClass プロパティは，項目定義オブジェクトに対応する項目オブジェクトのクラスを判定します。

TFieldClass = class of TField;

TFieldClass = class of TField;

property FieldClass: TFieldClass;

説明

FieldClass プロパティは，項目定義オブジェクトに対応する項目オブジェクトのクラスを取得できます。FieldClass は項目の DataType によって決まります。たとえば，DataType が ftString の場合，FieldClass は TStringField になります。

CreateField メソッドで項目定義から作成した項目オブジェクトは FieldClass のインスタンスです。

FieldClass は読み出し専用のプロパティです。


TFieldDef.FieldNo
TFieldDef.FieldNo3252006

TFieldDef	参照

FieldNo プロパティは，項目の参照に使う物理項目番号を識別します。

property FieldNo: Integer;

説明

FieldNo プロパティは，項目定義が参照している物理項目がテーブル内の項目のセットのどこにあるかを取得できます。たとえば，FieldNo の値が 2 の場合は，その項目はテーブル内の 2 番目の項目です。

FieldNo は読み出し専用のプロパティです。


TFieldDef.InternalCalcField
TFieldDef.InternalCalcField3252007

TFieldDef	参照

InternalCalcField プロパティは，項目が，データソースによって値が計算される項目であるかどうかを示します。

property InternalCalcField: Boolean;

説明

InternalCalcField プロパティは，項目が物理データベーステーブル内の項目でないデータソースによって提供される計算項目かどうかを取得できます。内部的に計算される項目はライブ問い合わせビューで SQL サーバーまたはボーランドデータベースエンジンによって計算されます。

たとえば次の SQL 文では，データセットには計算値 ONHAND * COST の項目が含まれています。

SELECT PARTNO, DESCRIPTION, ONHAND, COST, (ONHAND * COST) FROM PARTS

TQuery オブジェクトで RequestLive プロパティが True に設定されているとき，その計算値の項目定義では InternalCalcField が True に設定されています。

InternalCalcField は読み出し専用のプロパティです。


TFieldDef.Name
TFieldDef.Name3252008

TFieldDef	参照

Name プロパティは，基本となるテーブル内の物理項目の名前です。

property Name: string;

説明

Name プロパティは，テーブル内の物理項目の名前を取得できます。


TFieldDef.Precision
TFieldDef.Precision3252009

TFieldDef	参照

Precision プロパティは，項目値を格納するのに使う精度を示す桁数です。

property Precision: Integer;

説明

BCD 項目を定義するとき，Precision プロパティを各項目値用に格納される総桁数に設定します。Precision の値は，DataType が ftBCD でなければ無視されます。


TFieldDef.Required
TFieldDef.Required3252010

TFieldDef	参照

Required プロパティは，基本となるテーブル内の物理項目に値が必要かどうかを示します。

property Required: Boolean;

説明

Required プロパティは，テーブル内の項目に値が必要かどうかを取得できます。Required が True の場合，その項目には値が必要です。Required が False の場合は，その項目は空白にしておくことができます。

Required は読み出し専用のプロパティです。


TFieldDef.Size
TFieldDef.Size3252011

TFieldDef	参照

Size プロパティは，物理データベーステーブル内の項目に関連付けられているサイズを示します。

property Size: Integer;

説明

Size プロパティは，対応する物理項目に関連付けられているサイズを取得できます。

Size は，TFieldType の値が ftString，ftBCD，ftBytes，ftVarBytes，ftBlob，ftMemo，ftGraphic の項目定義オブジェクトの場合にだけ意味があります。文字型項目やバイト型項目の場合，Size はテーブル内にその項目用に予約されたバイト数です。BCD 型項目の場合，Size は小数点以下の桁数です。BLOB，メモ，グラフィック型項目の場合，Size は実際のデータベーステーブル内に格納されている項目の値のバイト数です。

Size は読み出し専用プロパティです。


TFieldDef メソッド3252012

TFieldDef	アルファベット順

TFieldDef

Create

CreateField

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TFieldDef メソッド3252013

TFieldDef	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateField

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TFieldDef.Create
TFieldDef.Create3252014

TFieldDef	参照

Create メソッドは，TFieldDef のインスタンスを作成します。

constructor Create(Owner: TFieldDefs; const Name: string; DataType: TFieldType; Size: Word; Required: Boolean; FieldNo: Integer);

説明

Create メソッドを呼び出すと，新しいテーブルをプログラムで作成するときに項目定義を作成できます。

Create メソッドに渡された Owner パラメータが nil でない場合は，指定した TFieldDefs オブジェクトがこの項目定義のオーナーになります。Name，DataType，Size，Required，および FieldNo の各パラメータで渡された値は，同じ名前のプロパティにそれぞれ割り当てられます。


TFieldDef.CreateField
TFieldDef.CreateField3252015

TFieldDef	参照

CreateField メソッドは，TFieldDef オブジェクトの仕様に適合する適切な型の TField コンポーネントを作成します。

function CreateField(Owner: TComponent): TField;

説明

データセットオブジェクトは，CreateField メソッドを呼び出して項目定義オブジェクトから項目コンポーネントを作成します。アプリケーションは直接 CreateField メソッドを呼び出す必要はありません。


TFieldDef.Destroy
TFieldDef.Destroy3252016

TFieldDef	参照

Destroy メソッドは TFieldDef のインスタンスを破棄します。

destructor Destroy; override;

説明

TFieldDef の Destroy メソッドは呼び出さないでください。TFieldDef のインスタンスは，それらを所有しているオブジェクトが Free メソッドを呼び出したときに破棄されます。


読み出し／書き込み3252017

読み出し専用


継承3252018

TObject


TFieldDef 例3252019

TFieldDef


TFieldDefs
TFieldDefs3253001

継承	プロパティ	メソッド	参照

TFieldDefs にはデータセットの基になる物理項目を示す項目定義（TFieldDef）オブジェクトが入っています。

ユニット

db

説明

TFieldDefs は，データセットがデータベーステーブル内の項目に対応する項目オブジェクトの作成に使用する項目定義の管理に使用します。また TTable オブジェクトも，新しいデータベーステーブルの作成の際に TFieldDefs オブジェクトを使用します。

TFieldDefs のメソッドとプロパティを使うと以下のことができます。

・	特定の項目定義へアクセスする

・	項目定義をリストに追加またはリストから削除する

・	定義されている項目数を調べる

・	項目定義のセットを別のテーブルにコピーする


TFieldDefs プロパティ3253002

TFieldDefs	アルファベット順	凡例

TFieldDefs

Count

Items


TFieldDefs プロパティ3253003

TFieldDefs	オブジェクト順	凡例

Count

Items


TFieldDefs.Count
TFieldDefs.Count3253004

TFieldDefs	参照

Count は，TFieldDefs オブジェクトが所有している TFieldDef オブジェクトの総数を示します。

property Count: Integer;

説明

Count は，TFieldDefs オブジェクト内に含まれている項目定義の数を取得できます。たとえば，Count プロパティを使って Items 配列内のすべての項目定義に対して繰り返し処理を行うことができます。

Count は読み出し専用のプロパティです。Count の値は，項目定義を追加または削除すると，間接的に変更されます。


TFieldDefs.Items
TFieldDefs.Items3253005

TFieldDefs	参照

Items プロパティは，データセット内の各項目を記述した項目定義のポインタ配列です。

property Items[Index: Integer]: TFieldDef; default;

説明

Items プロパティは，特定の項目定義へアクセスできます。アクセスする項目定義は Index パラメータで指定します。Index は項目定義のリスト内での項目定義の位置を識別する 0～Count - 1 の範囲の整数です。

Items は読み出し専用のプロパティです。Items の値は，項目定義を追加または削除すると，間接的に変更されます。


TFieldDefs メソッド3253006

TFieldDefs	アルファベット順

TFieldDefs

Add

Assign

Clear

Create

Destroy

Find

IndexOf

Update

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TFieldDefs メソッド3253007

TFieldDefs	オブジェクト順

Add

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Find

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

IndexOf

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

Update


TFieldDefs.Add
TFieldDefs.Add3253008

TFieldDefs	参照

Add メソッドは，新しい項目定義オブジェクトを作成して，TFieldDefs オブジェクトの Items プロパティに追加します。

TFieldType = (ftUnknown, ftString, ftSmallint, ftInteger, ftWord, ftBoolean, ftFloat, ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftBytes, ftVarBytes, ftAutoInc, ftBlob, ftMemo, ftGraphic, ftFmtMemo, ftParadoxOle, ftDBaseOle, ftTypedBinary, ftCursor);

TFieldType = (ftUnknown, ftString, ftSmallint, ftInteger, ftWord, ftBoolean, ftFloat, ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftBytes, ftVarBytes, ftAutoInc, ftBlob, ftMemo, ftGraphic, ftFmtMemo, ftParadoxOle, ftDBaseOle, ftTypedBinary, ftCursor);

procedure Add(const Name: string; DataType: TFieldType; Size: Word; Required: Boolean);

説明

Add メソッドを呼び出すと，新しいテーブルを作成できます。データセットを開くときには Items プロパティの配列は自動的に入力されます。

Add メソッドは，Name，DataType，Size，Required パラメータで渡された値を，新しい項目定義オブジェクトの個々のプロパティに割り当てます。

同じ名前の項目定義がすでにある場合は，EDatabaseError 例外が生成されます。


TFieldDefs.Assign
TFieldDefs.Assign3253009

TFieldDefs	参照

Assign メソッドは，項目定義オブジェクトのセットを別の TFieldDefs オブジェクトから Items プロパティの配列へコピーします。

procedure Assign(FieldDefs: TFieldDefs);

説明

Assign メソッドを呼び出すと，1 つの TFieldDefs オブジェクトを別の TFieldDefs オブジェクトにコピーできます。項目定義は Items プロパティの配列にコピーされます。この場合，TFieldDefs オブジェクトを FieldDefs パラメータの値として指定します。

Items に項目定義のポインタがすでにある場合，それらのポインタは Items が再入力される前に解放されます。


TFieldDefs.Clear
TFieldDefs.Clear3253010

TFieldDefs	参照

Clear メソッドは，Items プロパティのすべてのエントリを解放します。

procedure Clear;

説明

Clear メソッドを呼び出すと，TFieldDefs オブジェクトからすべての項目定義オブジェクトを削除できます。


TFieldDefs.Create
TFieldDefs.Create3253011

TFieldDefs	参照

Create メソッドは TFieldDefs のインスタンスを作成します。

constructor Create(DataSet: TDataSet);

説明

アプリケーションが直接 Create メソッドを呼び出す必要はありません。TFieldDefs は，データベース内の項目を指定するためにデータセットによって自動的に作成されます。

継承するコンストラクタを呼び出した後，Create メソッドは Items プロパティの配列を作成します。


TFieldDefs.Destroy
TFieldDefs.Destroy3253012

TFieldDefs	参照

Destroy メソッドは TFieldDefs のインスタンスを破棄します。

destructor Destroy; override;

説明

直接 Destroy メソッドを呼び出さないでください。TFieldDefs オブジェクトを所有しているデータセットは Free メソッドを呼び出して TFieldDefs オブジェクトを破棄します。Free メソッドは TFieldDefs オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは Items プロパティの配列からすべての項目定義オブジェクトを削除し，Items を解放してから継承デストラクタを呼び出します。


TFieldDefs.Find
TFieldDefs.Find3253013

TFieldDefs	参照

Find メソッドは，項目名に対する Items 配列内の項目定義を見つけます。

function Find(const Name: string): TFieldDef;

説明

Find メソッドを呼び出すと，特定の項目定義に関する情報を入手できます。Name パラメータの値として項目名を指定します。


TFieldDefs.IndexOf
TFieldDefs.IndexOf3253014

TFieldDefs	参照

IndexOf メソッドは，項目名に対する Items 配列内の項目定義のインデックス番号を見つけます。

function IndexOf(const Name: string): Integer;

説明

IndexOf メソッドを使うと，項目定義の Items プロパティの配列内での位置を調べることができます。IndexOf メソッドは，0（1 番目の位置）～Count - 1 の範囲の値を返します。この場合，項目名を Name パラメータの値として指定します。


TFieldDefs.Update
TFieldDefs.Update3253015

TFieldDefs	参照

Update メソッドは，データセットの基本となる物理項目の現在の状態が反映されるように Items プロパティの配列の項目定義を更新します。

procedure Update;

説明

Update メソッドを呼び出すと，基本となるデータセットの構造が変更されたときに項目定義を更新できます。Update メソッドはデータセットを開かずに項目定義を更新します。


読み出し／書き込み3253016

読み出し専用


継承3253017

TObject


TFieldDefs 例3253018

TFieldDefs


TFileListBox
TFileListBox3254001

継承	プロパティ	メソッド	イベント	参照

TFileListBox は，指定されたディレクトリにあるすべてのファイルを表示する専用のリストボックスです。

ユニット

filectrl

説明

TFileListBox をフォームに追加すると，ユーザーがファイルを選択できるようになります。TFileListBox を TDriveComboBox，TFilterComboBox，および TDirectoryListBox とともに使うと，完全なファイル選択機能がフォームに追加されます。

標準の Windows 95 ファイルを開いたり，保存したりするダイアログボックスをアプリケーションに追加するには，TOpenDialog または TSaveDialog を使います。


TFileListBox プロパティ3254002

TFileListBox	アルファベット順	凡例

TFileListBox

Directory

Drive

FileEdit

FileName

FileType

Mask

ShowGlyphs

TCustomListBox からの継承

Canvas

ExtendedSelect

IntegralHeight

ItemHeight

ItemIndex

Items

MultiSelect

SelCount

Selected

TopIndex

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TFileListBox プロパティ3254003

TFileListBox	オブジェクト順	凡例

Align

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

Directory

DragCursor

DragMode

Drive

Enabled

ExtendedSelect

FileEdit

FileName

FileType

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

IntegralHeight

ItemHeight

ItemIndex

Items

Left

Mask

MultiSelect

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

SelCount

Selected

ShowGlyphs

ShowHint

Showing

TabOrder

TabStop

Tag

Top

TopIndex

VCLComObject

Visible

Width

WindowProc


TFileListBox.Directory
TFileListBox.Directory3254004

TFileListBox	参照

Directory プロパティは，ファイルリストボックスにリストされているすべてのファイルがあるディレクトリを示します。

property Directory: string;

説明

Directory プロパティを設定すると，ファイルリストボックスが更新されて新しいディレクトリのファイルが表示されます。フォームに TDirectoryListBox オブジェクトがある場合には，そのディレクトリリストボックスの FileList プロパティを設定すると，ユーザーが新しいディレクトリを選択したときに Directory プロパティが自動的に更新されます。


TFileListBox.Drive
TFileListBox.Drive3254005

TFileListBox	参照

Drive プロパティは，リストボックスにリストされているファイルがあるドライブを示します。

property Drive: Char;

説明

Drive プロパティの値には，リストボックスが表示するファイルがあるドライブを設定します。Drive プロパティの値が変更されると，Directory プロパティの値も指定されたドライブのカレントディレクトリに変更されます。

フォームに TDirectoryListBox がある場合には，そのディレクトリリストボックスの FileList プロパティを設定すると，ディレクトリリストボックスの Drive プロパティが変更されたときに Drive プロパティが自動的に更新されます。


TFileListBox.FileEdit
TFileListBox.FileEdit3254006

TFileListBox	参照

FileEdit プロパティは，ディレクトリリストボックスを現在選択されているファイルを表示する編集コントロールにリンクします。

property FileEdit: TEdit;

説明

FileEdit には，［ファイルを開く］ダイアログボックスと［名前を付けて保存］ダイアログボックスでの通常の操作と同様に，ファイルリストボックスから選択されたファイルを表示する編集コントロールを設定します。ファイルリストボックスでファイルが選択されていない場合，編集コントロールのテキストはファイルリストボックスの Mask プロパティの現在の値になります。

注意

ユーザーが編集コントロールのテキストを変更すると，その結果は自動的にファイルリストボックスで反映されます。ApplyFilePath メソッドを使うと，編集コントロールのテキストが変更されたときにファイルリストボックスを更新できます。


TFileListBox.FileName
TFileListBox.FileName3254007

TFileListBox	参照

FileName プロパティは，リストボックスで選択されたファイルの名前とそのパス名を示します。

property FileName: string;

説明

FileName を設定すると，ファイルリストボックスを特定のファイルに初期化できます。FileName を呼び出すと，ユーザーが選択したファイルの名前を取得できます。

FileEdit プロパティが設定されている場合，FileName プロパティが変更されるとリンクしている編集コントロールが FileName の値を表示します。


TFileListBox.FileType
TFileListBox.FileType3254008

TFileListBox	参照

FileType プロパティは，ファイルの属性に基づいてファイルリストボックスに表示するファイルを決めます。

TFileAttr = (ftReadOnly, ftHidden, ftSystem, ftVolumeID, ftDirectory, ftArchive, ftNormal);

TFileType = set of TFileAttr;

property FileType: TFileType;

説明

FileType にはリストボックスが表示するファイルの種類を設定します。FileType は複数のファイルの種類を指定できます。たとえば FileType に ftReadOnly と ftHidden が設定されている場合，読み出し専用属性と非表示属性を持つファイルがリストボックスに表示されます。FileType プロパティには次の値を指定できます。

値	意味

ftReadOnly	リストボックスは読み出し専用属性を持つファイルを表示する

ftHidden	リストボックスは非表示属性を持つファイルを表示する

ftSystem	リストボックスはシステムファイルを表示する

ftVolumeID	リストボックスはボリューム名を表示する

ftDirectory	リストボックスはディレクトリを表示する

ftArchive	リストボックスはアーカイブ属性を持つファイルを表示する

ftNormal	リストボックスは属性を持たないファイルを表示する

オブジェクトインスペクタを使って FileType プロパティを設定するには，FileType プロパティをクリックして属性値を表示します。各値ごとに True または False を設定して，FileType に含めるかどうかを指定します。

注意

表示するファイルはファイル名の形式で制限することもできます。表示するファイルを特定の名前に制限するには，Mask プロパティを使うか，フォームで TFilterComboBox を使います。


TFileListBox.Mask
TFileListBox.Mask3254009

TFileListBox	参照

Mask メソッドは，ファイルリストボックスに表示するファイルを制限します。

property Mask: string;

説明

Mask に正規表現を設定して，リストボックスで表示するファイルをマスクと一致するファイルだけに制限できます。マスクの値はワイルドカードを含むファイル名です。アスタリスク（*）は任意の数の文字数と一致するワイルドカードです。疑問符（?）は任意の 1 文字と一致するワイルドカードです。デフォルトのファイルマスク *.* はすべてのファイルを表示します。

複数のファイルマスクを指定するには，*.PAS; *.EXE のようにファイルマスクをセミコロンで区切ります。

フォームに TFilterComboBox オブジェクトがある場合，フィルタコンボボックスの FileList プロパティを設定すると，フィルタコンボボックスの Mask プロパティが変更されたときに Mask プロパティが自動的に更新されます。


TFileListBox.ShowGlyphs
TFileListBox.ShowGlyphs3254010

TFileListBox

ShowGlyphs プロパティは，ファイルリストボックスに表示されるファイル名の隣にグリフ（ビットマップ）を表示するかどうかを決めます。

property ShowGlyphs: Boolean;

説明

ShowGlyphs を True に設定すると，リストのファイル名の隣にファイルの種類を示すアイコンが表示され，False に設定するとファイル名だけが表示されます。


TFileListBox イベント3254011

TFileListBox	アルファベット順	凡例

TFileListBox

OnChange

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TFileListBox イベント3254012

TFileListBox	オブジェクト順	凡例

OnChange

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TFileListBox.OnChange
TFileListBox.OnChange3254013

TFileListBox	参照

OnChange イベントは，ユーザーがリストでファイルの選択を変更した直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラを記述すると，FileName プロパティが変更されたときに特別なアクションを実行できます。FileEdit プロパティが設定されている場合，編集コントロールは OnChange イベントの前に更新されます。


TFileListBox メソッド3254014

TFileListBox	アルファベット順

TFileListBox

ApplyFilePath

Create

Destroy

Update

TCustomListBox からの継承

Clear

ItemAtPos

ItemRect

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TFileListBox メソッド3254015

TFileListBox	オブジェクト順

ApplyFilePath

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

ItemAtPos

ItemRect

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TFileListBox.ApplyFilePath
TFileListBox.ApplyFilePath3254016

TFileListBox	参照

ApplyFilePath メソッドは，ファイルリストボックスを更新して完全に条件を満たしたファイル名を表します。

procedure ApplyFilePath(const EditText: string);

説明

ApplyFilePath メソッドを呼び出すと，EditText パラメータで示されている値と一致するように Directory，Drive，FileName，および Mask プロパティを変更できます。たとえば，編集コントロールが FileEdit プロパティを使ってファイルリストボックスとリンクされている場合，編集コントロールの OnChange イベントハンドラから ApplyFilePath を呼び出すと，ユーザーが編集コントロールに値を入力したときにファイルリストボックスを更新できます。

ApplyFilePath は，EditText パラメータにワイルドカードが含まれている場合だけ Mask プロパティを更新します。フォームに FileList プロパティでこのファイルリストボックスオブジェクトを指定している TDirectoryListBox オブジェクトがある場合，ディレクトリリストボックスオブジェクトの Directory と Drive プロパティも更新されます。フォームに DirList プロパティでそのディレクトリリストボックスを指定している TDriveComboBox オブジェクトがある場合，コンボボックスの Drive プロパティも更新されます。しかし，TFilterComboBox の Mask プロパティは更新されません。


TFileListBox.Create
TFileListBox.Create3254017

TFileListBox	参照

Create メソッドは，TFileListBox のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TFileListBox オブジェクトを作成できます。設計時にフォームに配置されたファイルリストボックスは自動的に作成されます。

リストボックスにメモリを割り当てた後，Create は以下の処理を実行します。

・	Mask プロパティを *.* に初期化する

・	FileType プロパティを [ftNormal] に初期化する

・	Drive および Directory プロパティをカレントディレクトリに初期化し，リストボックスにそのディレクトリのすべてのファイルを表示する

・	MultiSelect プロパティを False に初期化する

・	Sorted プロパティを True に設定する

・	Width プロパティを 145 に設定する


TFileListBox.Destroy
TFileListBox.Destroy3254018

TFileListBox	参照

Destroy メソッドは，TFileListBox のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドはファイルリストボックスが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。


TFileListBox.Update
TFileListBox.Update3254019

TFileListBox	参照

Update メソッドは，ファイルリストボックスのディレクトリリストを更新します。

procedure Update;

説明

ファイルリストボックスに表示されているファイルの情報が最新ではないときに Update メソッドを呼び出します。たとえば，アプリケーションがファイルの作成，名前変更，削除を実行した場合，Update を呼び出してその変更をファイルリストボックスに反映します。

Drive，Directory，FileType，または Mask プロパティが変更されるとリストボックスは自動的に更新されます。


スコープ3254020

published

読み出し／書き込み

読み出し専用


スコープ3254021

published


継承3254022

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomListBox


TFileListBox 例3254023

TFileListBox


TFiler
TFiler3255001

継承	プロパティ	メソッド	参照

TFiler オブジェクトは，フォームおよび継承フォームにコンポーネントとそのプロパティをストリーム出力するのに使うリーダーオブジェクトとライターオブジェクトの基本となる抽象クラスです。

ユニット

classes

説明

TFiler オブジェクトは，ストリームオブジェクトおよびコンポーネントオブジェクトとともに使用されます。TFiler オブジェクトは，コンポーネントに関連付けられているデータをストリームオブジェクトとの間で読み書きする際の Delphi におけるストリーミングシステムの内部構造を定義します。TReader と TWriter は，それぞれの目的のために，ファイラが定義しているものを実現します。

ファイラ型は，リーダーオブジェクトとライターオブジェクトのいずれかを必要とするコンポーネントメソッドのパラメータとして使用します。ストリームからデータを読み出すのかストリームにデータを書き込むのかによって異なります。どのファイラオブジェクトも関連付けられたストリームオブジェクトを持ち，パラメータとしてそのコンストラクタに渡されます。ファイラの派生オブジェクトを作成するのは，通常はこの関連付けられているストリームオブジェクトです。

TFiler のプロパティは，所有コンポーネントのストリームの管理に役立ちます。ファイラオブジェクトを使用すれば，コンポーネントオブジェクトのプロパティをデータとしてストリームとの間で読み書きが行えます。ファイラオブジェクトは読み書きの処理速度を上げるためデータをバッファリングします。

TFiler オブジェクトは，派生リーダーオブジェクトおよびライターオブジェクトによってカスタマイズ可能な抽象メソッドを実装します。その中にはプロパティを定義するメソッドがあり，このメソッドを使うとオブジェクトは非表示データまたは複雑なデータをオブジェクトの実際のプロパティであるかのように格納できます。これらのメソッドはコンポーネントおよびストリームオブジェクトのメソッドと対話します。

注意

ファイラオブジェクトのプロパティおよびメソッドのほとんどは，Delphi のストリーミングシステム内で便利なように Public の可視性を持ちます。これらの大半は，ユーザーによってアプリケーション内で直接呼び出されることはありません。


TFiler プロパティ3255002

TFiler	アルファベット順

TFiler

Ancestor

IgnoreChildren

Root


TFiler プロパティ3255003

TFiler	オブジェクト順

Ancestor

IgnoreChildren

Root


TFiler.Ancestor
TFiler.Ancestor3255004

TFiler	参照

Ancestor プロパティは，継承フォームにコンポーネントを書き込むときに，継承コンポーネントのプロパティを書き込むかどうかを決めるために使います。

property Ancestor: TPersistent;

説明

Ancestor プロパティは直接呼び出さないでください。Ancestor プロパティは継承フォームにコンポーネントを書き込むときに，ライターオブジェクトのメソッドによって内部的に使用されます。

フォームの継承機能を使用した場合，ライターオブジェクトは継承したものと異なるプロパティの値だけを書き込まなければならないので，継承した各コンポーネントを Ancestor に記録し，書き込む前にプロパティを比較します。Ancestor が nil の場合，対応する継承コンポーネントはなく，ライターオブジェクトはコンポーネントをストリームに完全に書き出さなければなりません。

Ancestor は，継承機能を使って作成したフォームを記述する場合を除いて，常に nil です。このようなフォームは，WriteDescendent や WriteDescendentRes によりストリームに書き込まれます。これは，これらのメソッドが，Ancestor オブジェクトを持つ派生オブジェクトにとって必要だからです。

DefineProperties メソッドを記述またはオーバーライドする場合，Ancestor が設定されることを意識しなければならず，それに応じてプロパティを記述しなければならない場合と記述する必要のない場合があります。通常は，DefineProperty の読み出し手続きは Ancestor に対して明示的です。


TFiler.IgnoreChildren
TFiler.IgnoreChildren3255005

TFiler	参照

IgnoreChildren プロパティは，ライターオブジェクトはコンポーネントが所有している子のコンポーネントを保存しないで親コンポーネントだけを保存できます。

property IgnoreChildren: Boolean;

説明

ユーザーが IgnoreChildren プロパティを呼び出すことはめったにありません。IgnoreChildren プロパティは，コンポーネントをストリームするときに所有コンポーネントを書き込むかどうかを指定するために内部的に使用されます。一部のコンポーネントはストリーミング中に Root を変更することがありますが，まれなケースです。

IgnoreChildren が True の場合，ライターオブジェクトはコンポーネントを書き込み，そのコンポーネントが所有している子コンポーネントの方は書き込みません。IgnoreChildren が False の場合，ライターオブジェクトは所有しているすべてのオブジェクトをストリームに書き込みます。


TFiler.Root
TFiler.Root3255006

TFiler	参照

Root プロパティは，ファイラオブジェクトにファイラが読み出した，または書き込んだオブジェクトのルートつまり最終オーナーはどのオブジェクトか示します。

property Root: TComponent;

説明

Root プロパティは直接呼び出さないでください。Root プロパティは，所有コンポーネントをストリームするとき，ルートオブジェクトを見つけるために内部的に使用されます。Root プロパティは，現在のストリーミング処理でストリームされているすべてのコンポーネントの最終オーナーを示します。

メソッド ReadRootComponent と WriteRootComponent はコンポーネントと所有コンポーネントを読み書きする前に Root を設定します。


TFiler メソッド3255007

TFiler	アルファベット順

TFiler

Create

DefineBinaryProperty

DefineProperty

Destroy

FlushBuffer

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TFiler メソッド3255008

TFiler	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

DefineBinaryProperty

DefineProperty

Destroy

Dispatch

FieldAddress

FlushBuffer

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TFiler.Create
TFiler.Create3255009

TFiler	参照

Create メソッドは，ファイラオブジェクトをインスタンス化します。

constructor Create(Stream: TStream; BufSize: Integer);

説明

Create メソッドを呼び出すと，実行時に必要であればファイラの派生オブジェクトをインスタンス化できます。ただし Create メソッドは，ファイラオブジェクトを必要とするメソッドやルーチンによって自動的に呼び出されます。ファイラオブジェクトは，ストリームオブジェクトのメソッドでもっとも頻繁に作成されます。

Create メソッドはファイラオブジェクトにメモリを割り当て，Stream パラメータで指定したストリームに BufSize で指定するサイズのバッファを関連付けます。


TFiler.DefineBinaryProperty
TFiler.DefineBinaryProperty3255010

TFiler	参照

TFiler メソッドは，抽象メソッドとして DefineBinaryProperty を宣言します。

type

TStreamProc = procedure(Stream: TStream) of object;

procedure DefineBinaryProperty(const Name: string; ReadData, WriteData: TStreamProc; HasData: Boolean); virtual; abstract;

説明

派生した各ファイラオブジェクトは，派生オブジェクトが読み書きするバイナリデータをプロパティであるかのように定義する DefineBinaryProperty メソッドを宣言します。


TFiler.DefineProperty
TFiler.DefineProperty3255011

TFiler	参照

TFiler メソッドは，抽象メソッドとして DefineProperty を宣言します。

type

TReaderProc = procedure(Reader: TReader) of object;

TWriterProc = procedure(Writer: TWriter) of object;

procedure DefineProperty(const Name: string; ReadData: TReaderProc; WriteData: TWriterProc; HasData: Boolean); virtual; abstract;

説明

派生した各ファイラオブジェクトは，派生オブジェクトが読み書きするデータをプロパティであるかのように定義する DefineProperty メソッドを宣言します。


TFiler.Destroy
TFiler.Destroy3255012

TFiler	参照

Destroy メソッドは，ファイラオブジェクトを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドはファイラオブジェクトが解放されていないことを確認してから Destroy メソッドを呼び出します。

ファイラオブジェクトの Destroy メソッドはバッファに関連付けられているメモリを解放します。オブジェクトインスタンスへのメモリの再割り当ては，Destroy が呼び出されたときに自動的に処理されます。TFiler の Destroy メソッドは対応するデストラクタで下位オブジェクトによって呼び出されます。


TFiler.FlushBuffer
TFiler.FlushBuffer3255013

TFiler

TFiler は，抽象メソッドとして FlushBuffer を宣言します。

procedure FlushBuffer; virtual; abstract;

説明

下位の各ファイラオブジェクトは，関連付けられたストリームとファイラオブジェクトのバッファとの同期を実際に実現するために FlushBuffer メソッドを定義します。


継承3255014

TObject


TFiler 例3255015

TFiler


TFileStream
TFileStream3256001

継承	プロパティ	メソッド	参照

TFileStream オブジェクトは，アプリケーションによるディスクファイルの読み書きを可能にするストリームオブジェクトです。

ユニット

classes

説明

TFileStream オブジェクトを使うと，ディスクファイル内の情報にアクセスできます。TFileStream は指定したファイルを開き，そのファイルを読み書きするためのメソッドを提供します。アプリケーションがファイルへのハンドルをすでに取得しており，ファイルが適切なモードで開かれている場合は，THandleStream オブジェクトを使用します。


TFileStream プロパティ3256002

TFileStream	アルファベット順	凡例

THandleStream からの継承

Handle

TStream からの継承

Position

Size


TFileStream プロパティ3256003

TFileStream	オブジェクト順	凡例

Handle

Position

Size


TFileStream メソッド3256004

TFileStream	アルファベット順

TFileStream

Create

Destroy

THandleStream からの継承

Read

Seek

Write

TStream からの継承

CopyFrom

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TFileStream メソッド3256005

TFileStream	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyFrom

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Read

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

SafeCallException

Seek

Write

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes


TFileStream.Create
TFileStream.Create3256006

TFileStream	参照

Create メソッドは，TFileStream のインスタンスを作成します。

constructor Create(const FileName: string; Mode: Word);

説明

Create メソッドを呼び出すと，指定したファイルを読み書きするためにファイルストリームをインスタンス化できます。ファイルを開くモードは，ファイルストリームの作成時に指定する必要があります。

ファイルを開くモードは，Mode パラメータで指定します。Mode パラメータには，オープンモードと共有モードを表す識別子を or で結んで指定します。オープンモードには次のいずれかの値を指定します。

値	意味

fmCreate	指定した名前でファイルを作成する。指定した名前のファイルがある場合は，書き込みモードでファイルを開く

fmOpenRead	読み出し用にファイルを開く

fmOpenWrite	書き込み用にファイルを開く。ファイルへ書き込みを行うと，ファイルの内容はすべて置き換えられる

fmOpenReadWrite	ファイルを開き，内容に変更を加える。現在の内容がすべて置き換えられるのではない

共有モードには次のいずれかの値を指定します。

値	意味

fmShareCompat	共有モードは FCB を開く方法と互換性がある

fmShareExclusive	他のアプリケーションはファイルを開くことができない

fmShareDenyWrite	他のアプリケーションは読み出し用にファイルを開くことはできるが，書き込み用に開くことはできない

fmShareDenyRead	他のアプリケーションは書き込み用にファイルを開くことはできるが，読み出し用に開くことはできない

fmShareDenyNone	他のアプリケーションからのファイルの読み出しおよび書き込みを妨げる処理は行われない

ファイルを開くことができない場合，Create メソッドは例外を生成します。


TFileStream.Destroy
TFileStream.Destroy3256007

TFileStream	参照

Destroy メソッドは，TFileStream のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出すことはせずに，Free メソッドを呼び出すようにしてください。Free メソッドは TFileStream オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは，ファイルストリームの Handle プロパティを閉じてから TFileStream オブジェクトを解放します。


読み出し／書き込み3256008

読み出し専用


継承3256009

TObject

TStream

THandleStream


TFileStream 例3256010

TFileStream


TFindDialog
TFindDialog3257001

継承	プロパティ	メソッド	イベント	参照

TFindDialog は，ユーザーがファイル内のテキストを検索するための［検索］ダイアログボックスを表示します。

ユニット

dialogs

説明

TFindDialog コンポーネントはモードなしの Windows ダイアログボックスを表示し、ユーザーに検索文字列の入力を求めます。このダイアログボックスは，実行時に Execute メソッドが呼び出されるまでは表示されません。


TFindDialog プロパティ3257002

TFindDialog	アルファベット順	凡例

TFindDialog

FindText

Left

Options

Position

Top

TCommonDialog からの継承

Ctl3D

Handle

HelpContext

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TFindDialog プロパティ3257003

TFindDialog	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Ctl3D

DesignInfo

FindText

Handle

HelpContext

Left

Name

Options

Owner

Position

Tag

Top

VCLComObject


TFindDialog.FindText
TFindDialog.FindText3257004

TFindDialog

FindText プロパティは，検索文字列を示します。

property FindText: string;

説明

FindText プロパティは，ユーザーが検索するテキスト文字列を示します。ユーザーが［次を検索(F)］ボタンをクリックすると，このダイアログボックスの編集ボックスのテキストが自動的に FindText プロパティに代入されます。このダイアログボックスが表示されるときにデフォルトのテキスト文字列を表示するには，オブジェクトインスペクタまたはプログラムコードで値を FindText に代入します。


TFindDialog.Left
TFindDialog.Left3257005

TFindDialog	参照

Left プロパティは，［検索］ダイアログボックスの左上隅の X 座標（水平方向の位置）を示します。

property Left: Integer;

説明

Left プロパティは Position プロパティの 1 番目の整数と同じ値を保持します。このプロパティは以前のアプリケーションとの互換性を保つためにあります。


TFindDialog.Options
TFindDialog.Options3257006

TFindDialog	参照

Options プロパティは，［検索］ダイアログボックスの外観と動作を決めます。

TFindOption = (frDown, frFindNext, frHideMatchCase, frHideWholeWord, frHideUpDown, frMatchCase, frDisableMatchCase, frDisableUpDown, frDisableWholeWord, frReplace, frReplaceAll, frWholeWord, frShowHelp);

TFindOptions = set of TFindOption;

property Options: TFindOptions;

説明

Options に指定できる値は次のとおりです。

値	意味

frDisableMatchCase	［大文字と小文字を区別］チェックボックスを無効（淡色表示）にする

frDisableUpDown	検索方向を決める［上へ(U)］と［下へ(D)］ボタンを無効（淡色表示）にする

frDisableWholeWord	［単語単位で探す(W)］チェックボックスを無効（淡色表示）にする

frDown	ダイアログボックスが表示されるとデフォルトで［下へ(D)］ボタンを選択する。frDown フラグがオフの場合には，ダイアログボックスが表示されるときに［上へ(U)］ボタンが選択される（デフォルトはオン）

frFindNext	ユーザーが［次を検索(F)］ボタンをクリックするとこのフラグがオンになり，ダイアログボックスが閉じるとオフになる

frHideMatchCase	ダイアログボックスから［大文字と小文字を区別する(C)］チェックボックスを削除する

frHideWholeWord	ダイアログボックスから［単語単位で探す(W)］チェックボックスを削除する

frHideUpDown	ダイアログボックスから［上へ(U)］と［下へ(D)］ボタンを削除する

frMatchCase	このフラグはユーザーが［大文字と小文字を区別する(C)］チェックボックスを選択（選択解除）するとオン（オフ）になる。ダイアログボックスが表示されるとデフォルトで［大文字と小文字を区別する(C)］チェックボックスが選択されるようにするには，設計時に frMatchCase を設定する

frReplace	TReplaceDialog のみに適用される。frReplace はシステムによって設定されるフラグで，現在検出した FindText 文字列をアプリケーションが ReplaceText 文字列に置き換えなくてはならないことを示す。

frReplaceAll	TReplaceDialog のみに適用される。frReplaceAll はシステムによって設定されるフラグで，検出したすべての FindText 文字列をアプリケーションが ReplaceText 文字列に置き換えなくてはならないことを示す。

frShowHelp	ダイアログボックスに［ヘルプ(H)］ボタンを表示する

frWholeWord	このフラグはユーザーが［単語単位で探す(W)］チェックボックスを選択（選択解除）するとオン（オフ）になる。ダイアログボックスが表示されるとデフォルトで［単語単位で探す(W)］チェックボックスが選択されるようにするには，設計時に frWholeWord を設定する

デフォルトでは，frDown 以外のすべてのオプションがオフです。


TFindDialog.Position
TFindDialog.Position3257007

TFindDialog	参照

Position プロパティは，［検索］ダイアログボックスの画面表示位置を指定します。

property Position: TPoint;

説明

Position プロパティは，ダイアログボックスの左上隅のピクセル座標を指定します。


TFindDialog.Top
TFindDialog.Top3257008

TFindDialog	参照

Top プロパティは，［検索］ダイアログボックスの左上隅の Y 座標（垂直位置）を決めます。

property Top: Integer;

説明

Top プロパティは Position プロパティの 2 番目の整数と同じ値を保持します。このプロパティは以前のアプリケーションとの互換性を保つためにあります。


TFindDialog イベント3257009

TFindDialog	アルファベット順

TFindDialog

OnFind

TCommonDialog からの継承

OnClose

OnShow


TFindDialog イベント3257010

TFindDialog	オブジェクト順

OnClose

OnFind

OnShow


TFindDialog.OnFind
TFindDialog.OnFind3257011

TFindDialog	参照

OnFind イベントは，ユーザーが［次を検索(F)］ボタンをクリックしたときに発生します。

property OnFind: TNotifyEvent;

説明

ユーザーが［次を検索(F)］ボタンをクリックすると，OnFind イベントが発生し，Options でfrFindNext が設定されます。FindText で指定されているテキストを検索する OnFind イベントハンドラを Options フラグを利用して記述すると，検索の方法を決めることができます。

たとえば，次のイベントハンドラは Memo1 という名前の TMemo オブジェクトで検索を行い，TMemo の SelStart および SelLength プロパティを使って見つかったテキストを強調表示します。

procedure TForm1.FindDialog1Find(Sender: TObject);

var

  SelPos: Integer;

begin

  with TFindDialog(Sender) do

  begin

    { Memo1 で FindText の検索をグローバルに大文字と小文字を区別して実行します }

    SelPos := Pos(FindText, Memo1.Lines.Text);

    if SelPos > 0 then

    begin

      Memo1.SelStart := SelPos - 1;

      Memo1.SelLength := Length(FindText);

    end

    else MessageDlg(Concat('Could not find "', FindText, '" in Memo1.'), mtError,

      [mbOk], 0);

  end;

end;


TFindDialog メソッド3257012

TFindDialog	アルファベット順

TFindDialog

CloseDialog

Create

Destroy

Execute

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TFindDialog メソッド3257013

TFindDialog	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CloseDialog

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Execute

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TFindDialog.CloseDialog
TFindDialog.CloseDialog3257014

TFindDialog

CloseDialog メソッドは，［検索］ダイアログボックスを閉じます。

procedure CloseDialog;

説明

CloseDialog メソッドはダイアログボックスを閉じて，そのウィンドウハンドルを解放します。しかし，TFindDialog のほとんどプロパティ（FindText を含む）は変更されません。


TFindDialog.Create
TFindDialog.Create3257015

TFindDialog	参照

Create メソッドは，TFindDialog インスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは TFindDialog インスタンスを生成しますが，実行時に Execute メソッドが呼び出されるまで新しいダイアログボックスはフォーム上に表示されません。


TFindDialog.Destroy
TFindDialog.Destroy3257016

TFindDialog	参照

Destroy メソッドは，TFindDialog を破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは［検索］ダイアログボックスが破棄されていないことを確認し，破棄されていなければ Destroy メソッドを呼び出します。


TFindDialog.Execute
TFindDialog.Execute3257017

TFindDialog

Execute メソッドは，［検索］ダイアログボックスを表示します。

function Execute: Boolean; override;

説明

Execute メソッドは［検索］ダイアログボックスを表示し，ウィンドウハンドルの割り当てに成功したときに True を返します。Execute メソッドが呼び出されたときにすでにダイアログボックスが表示されている場合，Execute メソッドはそのダイアログボックスを前面に表示し，その親フォームをアクティブにして True を返します。


スコープ3257018

published

読み出し／書き込み

読み出し専用


継承3257020

TObject

TPersistent

TComponent

TCommonDialog


TFindDialog 例3257021

TFindDialog


TFieldDataLink
TFieldDataLink3258001

継承	プロパティ	メソッド	イベント	参照

TFieldDataLink オブジェクトは，データベース対応ウィンドウコントロールが TField オブジェクトへのリンクを管理したりデータイベントを処理したりするのを助けるヘルパーオブジェクトです。

ユニット

dbctrls

説明

TFieldDataLink オブジェクトは，TField オブジェクトにリンクしてデータイベントの処理やデータベース情報のトラッキングをする必要があるデータベース対応オブジェクトのメンバーオブジェクトとして使います。データベース対応オブジェクトは TWinControl オブジェクトの派生オブジェクトでなければなりません。

データベース対応オブジェクトのコンストラクタは，TFieldDataLink オブジェクトのメンバーのコンストラクタを呼び出して，関連するイベントハンドラをすべて初期化しなければなりません。その後でデータベース対応オブジェクトは TFieldDataLink オブジェクトの FieldName プロパティを使って TField オブジェクトにリンクしたり，TFieldDataLink オブジェクトの DataSource プロパティを使ってデータセットにリンクしたりできます。


TFieldDataLink プロパティ3258002

TFieldDataLink	アルファベット順	凡例

TFieldDataLink

CanModify

Control

Editing

Field

FieldName

TDataLink からの継承

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

ReadOnly

RecordCount


TFieldDataLink プロパティ3258003

TFieldDataLink	オブジェクト順	凡例

Active

ActiveRecord

BufferCount

CanModify

Control

DataSet

DataSource

DataSourceFixed

Editing

Field

FieldName

ReadOnly

RecordCount


TFieldDataLink.CanModify
TFieldDataLink.CanModify3258004

TFieldDataLink	参照

CanModify プロパティは，TFieldDataLink オブジェクトに管理されているデータベーステーブル内の項目を Control プロパティが変更できるかどうかを示します。

property CanModify: Boolean;

説明

CanModify プロパティは，TFieldDataLink オブジェクトのオーナーである Control が，この項目のデータベース内のデータを変更できるかどうかがわかります。CanModify が False の場合は，コントロールが読み出し専用であるか，項目が更新を禁止していることを示します。


TFieldDataLink.Control
TFieldDataLink.Control3258005

TFieldDataLink	参照

Control プロパティは，TFieldDataLink オブジェクトを使って TField オブジェクトへのリンクを管理するデータベース対応コンポーネントです。

property Control: TComponent;

説明

Control プロパティは，TFieldDataLink オブジェクトを使って TField オブジェクトへのリンクを管理するコンポーネントによってのみ設定されます。データベース対応コンポーネントは，自分自身のコンストラクタの中で，TFieldDataLink コンストラクタを呼び出した後，TFieldDataLink の Control プロパティを自分自身に設定できます。Control プロパティは，データイベントの処理時，コンポーネントのメソッドにアクセスするために読みだすことができます。


TFieldDataLink.Editing
TFieldDataLink.Editing3258006

TFieldDataLink	参照

Editing プロパティは，TFieldDataLink オブジェクトに関連付けられた項目を含むデータセットが編集モードであるかどうかを示します。

property Editing: Boolean;

説明

Editing プロパティは，この TDataLink オブジェクトに関連付けられた項目の値を編集できるかどうかを決めることができます。Editing プロパティが False の場合，Edit メソッド呼び出しによってデータセットは編集モードになります。しかし，項目の編集が不可能な場合，この処理は失敗します。たとえば CanModify プロパティが False のとき，Editing プロパティは常に False です。


TFieldDataLink.Field
TFieldDataLink.Field3258007

TFieldDataLink	参照

Field プロパティは，TFieldDataLink オブジェクトによって管理されるデータベーステーブル内の項目を表す TField オブジェクトです。

property Field: TField;

説明

Field プロパティは，TFieldDataLink オブジェクトの Control が結び付けられている項目オブジェクトへのアクセスを得ることができます。

注意

Field プロパティを使って項目の内容を変更する前に，アプリケーションは CanModify プロパティを調べなければなりません。項目オブジェクトでは，TFieldDataLink オブジェクトの編集の制限事項をすべて処理することはできません。


TFieldDataLink.FieldName
TFieldDataLink.FieldName3258008

TFieldDataLink	参照

FieldName プロパティは，TFieldDataLink オブジェクトの Control が結び付けられている項目の名前です。

property FieldName: string;

説明

FieldName プロパティは，TFieldDataLink オブジェクトのオーナーであるデータベース対応コントロールの FieldName プロパティを実装することができます。FieldName プロパティを設定すると，TFieldDataLink オブジェクトおよびそのコントロールを，FieldName プロパティに設定した名前でデータセット内の項目に結び付けることができます。


TFieldDataLink イベント3258009

TFieldDataLink	アルファベット順

TFieldDataLink

OnActiveChange

OnDataChange

OnEditingChange

OnUpdateData


TFieldDataLink イベント3258010

TFieldDataLink	オブジェクト順

OnActiveChange

OnDataChange

OnEditingChange

OnUpdateData


TFieldDataLink.OnActiveChange
TFieldDataLink.OnActiveChange3258011

TFieldDataLink	参照

OnActiveChange イベントは，TFieldDataLink オブジェクトの Active プロパティが変化したときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

TNotifyEvent = procedure(Sender: TObject) of object;

property OnActiveChange: TNotifyEvent;

説明

OnActiveChange イベントハンドラを作成すると，データセットがアクティブ状態になるかアクティブ状態でなくなった直後に，特定の動作を実行できます。OnActiveChange イベントは，データセットが非アクティブ状態の間に発生した変更でオブジェクトを更新するのに便利です。なぜなら，TFieldDataLink オブジェクトが Active でない間は，オブジェクトはイベントを処理できないからです。


TFieldDataLink.OnDataChange
TFieldDataLink.OnDataChange3258012

TFieldDataLink	参照

OnDataChange イベントは，データセットの内容が変化したときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnDataChange: TNotifyEvent;

説明

OnDataChange イベントハンドラを作成すると，項目の内容が変更されたときに特定の動作を実行できます。OnDataChange イベントを使うと，データセットがデータ変更通知を送出した際にコントロールオブジェクトで処理することができます。


TFieldDataLink.OnEditingChange
TFieldDataLink.OnEditingChange3258013

TFieldDataLink	参照

OnEditingChange イベントは，DataSource プロパティが編集状態になったときと，編集状態でなくなったときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnEditingChange: TNotifyEvent;

説明

OnEditingChange イベントハンドラを作成すると，DataSource プロパティが編集状態になったとき，または編集状態でなくなったときに特定の動作を実行できます。このイベントは，TFieldDataLink オブジェクトを使うコントロールの編集状態の変化を視覚的に表示するのに使えます。


TFieldDataLink.OnUpdateData
TFieldDataLink.OnUpdateData3258014

TFieldDataLink	参照

OnUpdateData イベントは，遅延されていた変更をデータセットに登録する時点で発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnUpdateData: TNotifyEvent;

説明

OnUpdateData イベントハンドラを作成すると，項目に表示されているデータをデータベースレコードに書き込むことができます。OnUpdateData イベント内からデータを登録しても，OnDataChange イベントの呼び出しが実行されることはありません。


TFieldDataLink メソッド3258015

TFieldDataLink	アルファベット順	凡例

TFieldDataLink

ActiveChanged

Edit

EditingChanged

FocusControl

LayoutChanged

Modified

RecordChanged

Reset

UpdateData

TDataLink からの継承

Create

Destroy

UpdateRecord

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TFieldDataLink メソッド3258016

TFieldDataLink	オブジェクト順	凡例

ActiveChanged

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

Edit

EditingChanged

FieldAddress

FocusControl

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LayoutChanged

MethodAddress

MethodName

Modified

NewInstance

RecordChanged

Reset

SafeCallException

UpdateData

UpdateRecord


TFieldDataLink.ActiveChanged
TFieldDataLink.ActiveChanged3258017

TFieldDataLink	参照

ActiveChanged メソッドは，OnActiveChanged イベントハンドラが指定されていればそれを呼び出します。

procedure ActiveChanged; override;

説明

Active プロパティが変更されると ActiveChanged メソッドが実行されます。OnActiveChange イベントハンドラが指定されていれば，ActiveChanged メソッドはそのイベントハンドラを呼び出します。アクティブ状態に変化する際に ActiveChanged メソッドが実行された場合は，イベントハンドラを呼び出す前に，ActiveChanged メソッドは TFieldDataLink オブジェクトの使う Field プロパティがまだ有効であることを確認します。


TFieldDataLink.Edit
TFieldDataLink.Edit3258018

TFieldDataLink	参照

Edit メソッドは，DataSource プロパティがまだ編集状態でなければ編集状態にしようとします。

function Edit: Boolean;

説明

Edit メソッドを使うと，項目の内容を変更可能にしようと試みることができます。戻り値が True であれば項目はすでに編集状態であるか，DataSource プロパティが編集状態に変わったことを示します。戻り値が False の場合は，DataSource を編集状態にはできません。たとえば CanModify プロパティが False の場合，Edit メソッドは失敗して False を戻します。


TFieldDataLink.EditingChanged
TFieldDataLink.EditingChanged3258019

TFieldDataLink	参照

EditingChanged メソッドは，項目の結び付きが変化したときの CanModify プロパティの状態を強制的に適用します。

procedure EditingChanged; override

説明

項目のバインディングを変更すると，CanModify プロパティを検証する必要が生じます。なぜなら，個々の項目要素が変更を許可しない場合もあるからです。Field プロパティが変更されたときに TFieldDataLink オブジェクトが編集状態である場合，EditingChanged メソッドは CanModify プロパティを調べます。CanModify が False の場合，編集状態は解除されます。

注意

このメソッドは，TDataLink オブジェクトの EditingChanged 継承メソッドとは大きく異なります。継承メソッドの機能は，TFieldDataLink オブジェクトの中で OnEditingChange イベントハンドラによって置き換えられます。


TFieldDataLink.FocusControl
TFieldDataLink.FocusControl3258020

TFieldDataLink	参照

FocusControl メソッドは，Control への入力フォーカスを設定します。

procedure FocusControl(Field: TFieldRef); override;

説明

FocusControl メソッドを呼び出すと，TFieldDataLink オブジェクトと関連付けられた Control に入力フォーカスを与えることができます。FocusControl メソッドは Control が入力フォーカスを受けることができるかどうかを調べ，受けることができるのであれば，その SetFocus メソッドを呼び出してフォーカスを Control へ移動します。


TFieldDataLink.LayoutChanged
TFieldDataLink.LayoutChanged3258021

TFieldDataLink	参照

LayoutChanged メソッドは，TFieldDataLink オブジェクトが使う Control のコンテナのレイアウトが変更された後でも Field プロパティが有効であるようにします。

procedure LayoutChanged; override;

説明

LayoutChanged メソッドは，TFieldDataLink オブジェクトが使うコントロールのコンテナのレイアウトが変更された後で，項目の結び付きが影響を受けるかもしれないときに呼び出されます。たとえば，Control が TCustomDBGrid オブジェクトに埋め込まれているとき，列が 1 つ削除されると，Control の Field プロパティは無効になることがあります。


TFieldDataLink.Modified
TFieldDataLink.Modified3258022

TFieldDataLink	参照

Modified メソッドは，項目のデータに加えられた変更のうちで，データセット内のレコードにまだ書き込まれていないものを記録します。

procedure Modified;

説明

Modified メソッドは，TFieldDataLink オブジェクトの Control が編集の処理を開始するときに呼び出すようにしてください。


TFieldDataLink.RecordChanged
TFieldDataLink.RecordChanged3258023

TFieldDataLink	参照

RecordChanged メソッドは，データセット内の現在のレコードの内容が変化したときに OnDataChange イベントハンドラを呼び出します。

procedure RecordChanged(Field: TField); override;

説明

アプリケーションはこのprotectedメソッドを呼び出せません。現在のレコードの内容が変化したときにこのメソッドが自動的に呼び出されます。RecordChanged メソッドは OnDataChange イベントハンドラがあればそれを呼び出します。


TFieldDataLink.Reset
TFieldDataLink.Reset3258024

TFieldDataLink	参照

Reset メソッドは OnDataChange イベントハンドラを呼び出して保留中の項目への変更を登録前に取り消します。

procedure Reset;

説明

TFieldDataLink オブジェクトのオーナーである Control がその Reset メソッドを呼び出して項目への変更を取り消す UI 動作を処理します。Reset メソッドは OnDataChange イベントハンドラを呼び出しますが，保留中の変更をデータセット内のレコードに書き込むことはしません。


TFieldDataLink.UpdateData
TFieldDataLink.UpdateData3258025

TFieldDataLink	参照

UpdateData メソッドは OnUpdateData イベントハンドラを呼び出してデータベース対応コントロールが保留中の編集をデータセット内のレコードに書き込めるようにします。

procedure UpdateData; override;

説明

UpdateData メソッドは，デフォルトの UpdateData メソッドをオーバーライドして割り当てられた OnUpdateData イベントハンドラを呼び出します。


読み出し／書き込み3258026

読み出し専用


スコープ3258027

protected


継承3258028

TObject

TPersistent

TDataLink


TFieldDataLink 例3258029

TFieldDataLink


TFloatField
TFloatField3259001

継承	プロパティ	メソッド	イベント	参照	例

TFloatField オブジェクトは浮動小数点値を持つデータセット項目を表します。

ユニット

db

説明

浮動小数点型項目は（正または負の）5.0 * 10-324 から 1.7 * 10306の範囲内の値を 15 から 16 桁の精度で保持できます。

TFloatField オブジェクトは次の処理を行う新しいプロパティを導入します。

・	浮動小数点値と別のデータ型の変換

・	項目の有効値の範囲または精度の制限

・	値の表示形式の設定

TNumericField オブジェクトの下位オブジェクトとして，TFloatField オブジェクトはデータベースの数値型項目の値およびプロパティを管理するのに便利なプロパティ，メソッド，およびイベントを数多く持っています。

TFloatField オブジェクトは TCurrencyField コンポーネントの直接の上位オブジェクトです。


TFloatField プロパティ3259002

TFloatField	アルファベット順	凡例

TFloatField

AsFloat

AsInteger

AsString

AsVariant

Currency

DataSize

MaxValue

MinValue

Precision

Value

TNumericField からの継承

DisplayFormat

EditFormat

TField からの継承

Alignment

AsBoolean

AsCurrency

AsDateTime

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TFloatField プロパティ3259003

TFloatField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

Currency

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayFormat

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditFormat

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

MaxValue

MinValue

Name

NewValue

Offset

OldValue

Origin

Owner

Precision

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TFloatField.AsFloat
TFloatField.AsFloat3259004

TFloatField	参照

AsFloat プロパティは，浮動小数点型項目の値を設定します。

property AsFloat: Double;

説明

浮動小数点型項目は Double 型で保存されるため，浮動小数点値の変換は不要です。AsFloat プロパティは，データの内部保存形式がわからないときでもアプリケーションが汎用の項目コンポーネントに浮動小数点値を取得または設定できるような同型のインターフェースを提供します。

項目に割り当てられた値が MinValue プロパティおよび MaxValue プロパティで指定された範囲の外にある場合，EDatabaseError 例外が生成されます。


TFloatField.AsInteger
TFloatField.AsInteger3259005

TFloatField	参照

AsInteger プロパティは，浮動小数点型項目の値を整数値に変換するか，その逆の変換をします。

property AsInteger: Longint;

説明

AsInteger プロパティは次の処理に使います。

・	浮動小数点型項目に整数値を代入

・	整数に浮動小数点値を代入

AsInteger プロパティは浮動小数点値の小数点以下を切り捨てて整数値に変換します。項目に割り当てられた値が MinValue プロパティおよび MaxValue プロパティで指定された範囲の外にある場合，EDatabaseError 例外が生成されます。


TFloatField.AsString
TFloatField.AsString3259006

TFloatField	参照

AsString プロパティは，浮動小数点値と文字列の間の変換を行います。

property AsString: string;

説明

AsString プロパティは次の処理に使います。

・	文字列に浮動小数点値を代入

・	浮動小数点型項目に文字列値を代入

次のコードは浮動小数点型項目の値に文字列値を代入します。

MyFloatField.AsString := �13.5�;

文字列に浮動小数点型項目の値を代入するには，次のようなコードを使います。

NewString := MyFloatField.AsString;

項目に割り当てられた文字列が MinValue プロパティおよび MaxValue プロパティで指定された有効な浮動小数点値の範囲外の場合，EDatabaseError 例外が生成されます。


TFloatField.AsVariant
TFloatField.AsVariant3259007

TFloatField	参照

AsVariant プロパティは，浮動小数点型項目の値とバリアント値の間の変換を行います。

property AsVariant: Variant;

説明

AsVariant プロパティは次の処理に使います。

・	浮動小数点値をバリアント型変数に代入

・	バリアント値を浮動小数点型項目に代入

バリアントは，項目の型やデータ形式が不明のときに便利です。

項目に割り当てられた値が MinValue プロパティおよび MaxValue プロパティで指定された有効な浮動小数点値の範囲外の場合，EDatabaseError 例外が生成されます。


TFloatField.Currency
TFloatField.Currency3259008

TFloatField	参照

Currency プロパティは，項目の値を通貨形式にするかどうかを決めます。

property Currency: Boolean;

説明

Currency プロパティは，項目をデータ処理コントロールで表示および編集する際の形式を指定することができます。

項目の表示形式は，DisplayFormat プロパティが指定されていればそれによって決まります。DisplayFormat プロパティが指定されていない場合，Currency プロパティが項目の表示形式を決めます。Currency プロパティが True であれば，値の表示形式は FloatToText 関数によって，ffCurrency 形式コードを使って設定されます。Currency プロパティが False の場合は，値は ffGeneral 形式を使います。

編集時の項目の形式は，EditFormat（または DisplayFormat）プロパティが指定されていればそれによって決まります。EditFormat プロパティまたは DisplayFormat プロパティのどちらも指定がない場合，Currency プロパティが編集時の項目の形式を決めます。Currency プロパティが True であれば，編集時の値の形式は FloatToText 関数によって，ffFixed 形式コードを使って設定されます。Currency プロパティが False の場合は，値は ffGeneral 形式を使います。


TFloatField.DataSize
TFloatField.DataSize3259009

TFloatField	参照

DataSize プロパティは，ネイティブなデータベース形式で浮動小数点項目の値を格納するのに必要なメモリの大きさです。

property DataSize: Word;

説明

DataSize プロパティは，浮動小数点項目コンポーネントの値を格納するのに何バイト必要かを取得できます。GetData や SetData メソッドでこのプロパティを使うと，必要なバッファの大きさを決めることができます。

浮動小数点項目の DataSize は常に 8 です。データベーステーブルは Double で浮動小数点項目を格納します。これは TFloatField が使う型と同じです。


TFloatField.MaxValue
TFloatField.MaxValue3259010

TFloatField	参照

MaxValue プロパティは，浮動小数点型項目の最大値を制限します。

property MaxValue: Double;

説明

MaxValue プロパティは，項目に入力できる値の最大値を取得および設定できます。MaxValue プロパティよりも大きい値が入力された場合，EDatabaseError 例外が生成されます。


TFloatField.MinValue
TFloatField.MinValue3259011

TFloatField	参照

MinValue プロパティは，浮動小数点型項目の最小値を制限します。

property MinValue: Double;

説明

MinValue プロパティは，項目に入力できる値の最小値を取得および設定できます。MinValue プロパティよりも小さい値が入力された場合，EDatabaseError 例外が生成されます。


TFloatField.Precision
TFloatField.Precision3259012

TFloatField	参照

Precision プロパティは，浮動小数点型項目で使われる表示形式の精度を決めます。

property Precision: Integer;

説明

Precision プロパティは，値を丸める前に小数点以下何桁まで表示するかを指定できます。Precision プロパティはテキスト文字列として表示される浮動小数点値に影響しますが，項目に格納される浮動小数点値には影響しません。

Precision プロパティのデフォルト値は小数点以下 15 桁です。

注意

Precision の値は 2 以上でなければなりません。2 未満の値を設定しようとしても，値は 2 に変更されます。


TFloatField.Value
TFloatField.Value3259013

TFloatField	参照

Value プロパティは，浮動小数点型項目内のデータです。

property Value: Double;

説明

Value プロパティは，実行時に浮動小数点コンポーネントにデータを直接設定できます。Value プロパティを使うのは，AsFloat プロパティを使うのと同じです。Value プロパティを使うのは，項目コンポーネントが浮動小数点型項目であることがわかっているときです。AsFloat プロパティを使うのは，汎用項目コンポーネントを扱う場合です。


TFloatField イベント3259014

TFloatField	アルファベット順	凡例

Tfield からの継承

OnChange

OnGetText

OnSetText

OnValidate


TFloatField イベント3259015

TFloatField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TFloatField メソッド3259016

TFloatField	アルファベット順

TFloatField

Create

Tfield からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

Tobject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TFloatField メソッド3259017

TFloatField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TFloatField.Create
TFloatField.Create3259018

TFloatField	参照

Create メソッドは，TFloatField のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，TFloatField オブジェクトのインスタンスを作成して初期化できます。継承コンストラクタを呼び出した後で，Create メソッドは DataType プロパティを ftFloat に，Precision プロパティを 15 にそれぞれ設定します。

Create メソッドを直接呼び出す必要はほとんどありません。浮動小数点型項目コンポーネントはデータセット内のすべての浮動小数点型項目に対して自動的にインスタンス化されるからです。


スコープ3259019

published

読み出し／書き込み

読み出し専用


スコープ3259020

published


継承3259021

TObject

TPersistent

TComponent

TField

TNumericField


TFloatField 例3259022

TFloatField


TFilterComboBox
TFilterComboBox3260001

継承	プロパティ	メソッド	イベント	参照

TFilterComboBox は，ユーザーにファイルフィルタの選択を提示する特殊なコンボボックスです。

ユニット

filectrl

説明

フィルタコンボボックスをファイル選択コントロールが入っているフォームに追加すると，定義済みのファイルフィルタのセットを提供できます。TFilterComboBox を TDriveComboBox，TDirectoryListBox，および TFileListBox とともに使うと，完全なファイル選択機能をフォームに追加できます。

標準の Windows 95 ファイルを開いたり，保存したりするダイアログボックスをアプリケーションに追加するには，TOpenDialog または TSaveDialog を使います。


TFilterComboBox プロパティ3260002

TFilterComboBox	アルファベット順	凡例

TFilterComboBox

FileList

Filter

Mask

TCustomComboBox からの継承

Canvas

DroppedDown

ItemIndex

Items

SelLength

SelStart

SelText

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Text

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TFilterComboBox プロパティ3260003

TFilterComboBox	オブジェクト順	凡例

Align

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

DroppedDown

Enabled

FileList

Filter

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

ItemIndex

Items

Left

Mask

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

Width

WindowProc


TFilterComboBox.FileList
TFilterComboBox.FileList3260004

TFilterComboBox	参照

FileList プロパティは，フィルタコンボボックスとファイルリストボックスコントロールをリンクします。

property FileList: TFileListBox;

説明

選択するファイルのリストを表示する TFileListBox オブジェクトがフォームにある場合，FileList を設定するとフィルタコンボボックスはリストボックスに表示するファイルを限定できます。この 2 つのコントロールが接続されていると，フィルタコンボボックスを使って新しいフィルタが選択された場合に，ファイルリストボックスは選択されたフィルタに一致するファイルを表示します。


TFilterComboBox.Filter
TFilterComboBox.Filter3260005

TFilterComboBox	参照

Filter プロパティは，フィルタコンボボックスに表示されるすべてのファイルマスクが入っています。

property Filter: string;

説明

Filter プロパティを設定すると，フィルタコンボボックス内でそれぞれの名前に関連付けられたマスクとともに表示する名前を指定できます。各マスクはワイルドカードを含むファイル名です。アスタリスク（*）は任意の数の文字と一致するワイルドカードです。疑問符（?）は任意の 1 文字と一致するワイルドカードです。アプリケーションが実行されているときに，ユーザーがフィルタコンボボックスで選択するファイルフィルタが Mask プロパティの値になります。

1 つのファイルの種類の Filter の値を作成する手順は次のとおりです。

1.	ファイルの種類を示すテキストを入力する

2.	| 文字（垂直バー）を入力する

3.	ファイルフィルタを入力する

文字列の | 文字の両側にスペースを入れないでください。

次に例を示します。

FilterComboBox1.Filter := 'Text files|*.TXT';

Filter をこの文字列に設定すると，文字列「Text files」がフィルタコンボボックスに表示されます。ユーザーが「Text files」を選択すると，マスクは「*.TXT」に設定されます。

複数のファイルフィルタを指定するには，ファイル名とマスクの各組み合わせを | 文字で区切って Filter の値を拡張します。

次に，Filter プロパティの値に 2 つのファイルフィルタを指定する例を示します。

'Text files (*.TXT)|*.TXT|Pascal files (*.PAS)|*.PAS'

この例では，テキスト部分でファイルフィルタをカッコで囲んであります。カッコは不要ですが，ファイルフィルタを選択するとどうかなるかわかりやすくするためカッコを使うのが一般的な約束事になっています。

マスク部分には，セミコロンで区切って複数のファイル指定子を入れることができます。

'All files|*.TXT;*.PAS;*.WB1'


TFilterComboBox.Mask
TFilterComboBox.Mask3260006

TFilterComboBox	参照

Mask プロパティは，フィルタコンボボックスで選択された文字列と関連付けられているマスクを示します。

property Mask: string;

説明

Mask プロパティは，ユーザーが選択したマスクを取得できます。

ユーザーがフィルタコンボボックスを使って新しいフィルタを選択すると，選択されたファイルの種類に関連付けられているマスクが Mask プロパティの値になります。ファイルリストボックスが FileList プロパティを使ってフィルタリストボックスとリンクされている場合，Mask の値が変更されたときにファイルリストが更新されます。


TFilterComboBox イベント3260007

TFilterComboBox	アルファベット順	凡例

TCustomComboBox からの継承

OnChange

OnDropDown

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnStartDrag


TFilterComboBox イベント3260008

TFilterComboBox	オブジェクト順	凡例

OnChange

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnDropDown

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnStartDrag


OnChange

OnChange イベントは，ユーザーがフィルタコンボボックスを使って新しいフィルタを選択した直後に発生します。

type TNotifyEvent = procedure(Sender: TObject) of object;

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラを記述すると，Mask プロパティが変更されたときに特別なアクションを実行できます。FileList プロパティが設定されている場合，ファイルリストボックスは OnChange イベントの前に更新されます。

たとえば，アプリケーションで 2 つのファイルリストボックスと 1 つのフィルタコンボボックスを同期させる必要がある場合，FileList プロパティのために自動的に更新されないファイルリストボックスを次のような OnChange イベントハンドラを記述することによってフィルタコンボボックスと同期させることができます。

procedure TForm1.FilterComboBox1Change(Sender: TObject);

begin

  FileListBox2.Mask := TFilterComboBox(Sender).Mask;

end;


TFilterComboBox メソッド3260010

TFilterComboBox	アルファベット順

TFilterComboBox

Create

Destroy

TCustomComboBox からの継承

Clear

SelectAll

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TFilterComboBox メソッド3260011

TFilterComboBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TFilterComboBox.Create
TFilterComboBox.Create3260012

TFilterComboBox	参照

Create メソッドは，TFilterComboBox のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TFilterComboBox オブジェクトを作成できます。設計時にフォームに配置されたフィルタコンボボックスは自動的に作成されます。

コンボボックスにメモリを割り当てた後，Create は Mask プロパティを *.* に，Style プロパティを csDropDownList に初期化します。


TFilterComboBox.Destroy
TFilterComboBox.Destroy3260013

TFilterComboBox	参照

Destroy メソッドは，TFilterComboBox のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは，フィルタコンボボックスが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。


スコープ3260014

published

読み出し／書き込み

読み出し専用


スコープ3260015

published


継承3260016

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomComboBox


TFilterComboBox 例3260017

TFilterComboBox


TFont
TFont3261001

継承	プロパティ	メソッド	イベント	参照

TFont は Windows の論理フォントをカプセル化します。

ユニット

graphics

説明

TFont を使うと，テキストの表示に使うフォントの特性を記述できます。TFont は，高さ，フォント（書体）名，属性（太字，斜体など）などを指定することにより文字のセットを定義します。


TFont プロパティ3261002

TFont	アルファベット順	凡例

TFont

Charset

Color

FontAdapter

Handle

Height

Name

Pitch

PixelsPerInch

Size

Style

TGraphicsObject からの継承

OwnerCriticalSection


TFont プロパティ3261003

TFont	オブジェクト順	凡例

Charset

Color

FontAdapter

Handle

Height

Name

OwnerCriticalSection

Pitch

PixelsPerInch

Size

Style


TFont.Charset
TFont.Charset3261004

TFont	参照

Charset プロパティは，フォントの文字セットを指定します。

TFontCharset = 0..255;

property Charset: TFontCharset nodefault;

説明

Charset プロパティを取得すると，フォントの文字セットを識別できます。各書体（Name プロパティで指定）は 1 つまたは複数の文字セットをサポートします。フォントベンダーによって提供される情報を確認すると，Charset で有効な値がわかります。

以下に標準文字セット用に提供されている定義済みの定数を示します。

定数	値	説明

ANSI_CHARSET	0	ANSI 文字

DEFAULT_CHARSET	1	Font は Name と Size のみに基づいて選択される。システムで使用できないフォントの場合は，Windows が別のフォントを代用する

SYMBOL_CHARSET	2	標準記号セット

MAC_CHARSET	77	Macintosh 文字。NT 3.51 では無効

SHIFTJIS_CHARSET	128	日本語シフト JIS 文字

HANGEUL_CHARSET	129	ハングル（Wansung）

JOHAB_CHARSET	130	ハングル（Johab）。NT 3.51 では無効

GB2312_CHARSET	134	漢字（簡体字中国語）

CHINESEBIG5_CHARSET	136	漢字（伝統的中国語）

GREEK_CHARSET	161	ギリシャ文字。NT 3.51 では無効

TURKISH_CHARSET	162	トルコ文字。NT 3.51 では無効

VIETNAMESE_CHARSET	163	ベトナム文字。NT 3.51 では無効

HEBREW_CHARSET	177	ヘブライ文字。NT 3.51 では無効

ARABIC_CHARSET	178	アラビア文字。NT 3.51 では無効

BALTIC_CHARSET	186	バルト文字。NT 3.51 では無効

RUSSIAN_CHARSET	204	キリル文字。NT 3.51 では無効

THAI_CHARSET	222	タイ文字。NT 3.51 では無効

EASTEUROPE_CHARSET	238	東欧諸国の発音区別符号を含む。NT 3.51 では無効

OEM_CHARSET	255	オペレーティングシステムのコードページによる


TFont.Color
TFont.Color3261005

TFont	参照

Color プロパティは，テキストの色を指定します。

property Color: TColor;

説明

次の値を指定できます。

値	意味

clBlack	黒色

clMaroon	栗色

clGreen	緑色

clOlive	黄緑色

clNavy	濃紺色

clPurple	紫色

clTeal	暗青緑色

clGray	灰色

clSilver	銀色

clRed	赤色

clLime	濃緑色

clBlue	青色

clFuchsia	赤紫色

clAqua	空色

clWhite	白色

clBackground	Windows の背景の現在の色

clActiveCaption	アクティブウィンドウのタイトルバーの現在の色

clInactiveCaption	アクティブでないウィンドウのタイトルバーの現在の色

clMenu	メニューの現在の背景色

clWindow	ウィンドウの現在の背景色

clWindowFrame	ウィンドウ枠の現在の色

clMenuText	メニュー上のテキストの現在の色

clWindowText	ウィンドウ内のテキストの現在の色

clCaptionText	アクティブウィンドウのタイトルバー上のテキストの現在の色

clActiveBorder	アクティブウィンドウの現在の境界色

clInactiveBorder	アクティブでないウィンドウの現在の境界色

clAppWorkSpace	アプリケーション作業域の現在の色

clHighlight	選択したテキストの現在の背景色

clHightlightText	選択したテキストの現在の色

clBtnFace	ボタン面の現在の色

clBtnShadow	ボタンのシャドウキャストの現在の色

clGrayText	淡色表示されているテキストの現在の色

clBtnText	ボタンのテキストの現在の色

clInactiveCaptionText	アクティブでないウィンドウのタイトルバーのテキストの現在の色

clBtnHighlight	ボタンの強調表示の現在の色

cl3DDkShadow 	3 次元表示要素の暗い影

cl3DLight 	3 次元表示要素の明るい色 (明るい面の縁用)

clInfoText 	支援機能コントロールのテキストの色

clInfoBk 	支援機能コントロールの背景色

Color がディザカラーに設定されている場合，テキストは一番近い非ディザ値で表示されます。


TFont.FontAdapter
TFont.FontAdapter3261006

TFont	参照

FontAdapter プロパティは，ActiveX コントロールにフォント情報を提供するためのインターフェースです。

property FontAdapter: IChangeNotifier;

説明

FontAdapter プロパティは使わないでください。FontAdapter は ActiveX コントロールが OLE インターフェースを介してフォント情報をやりとりするのに内部的に使います。


TFont.Handle
TFont.Handle3261007

TFont	参照

Handle プロパティは，Windows GDI フォントオブジェクトハンドルです。

property Handle: HFont;

説明

フォントオブジェクトのハンドルが必要な Windows API 関数を使うには，TFont オブジェクトの Handle プロパティでハンドルを指定します。Handle プロパティは，フォントハンドルを必要とする Windows API 関数を呼び出すときにパラメータとして使います。Handle プロパティを設定すると，TFont オブジェクトがフォントハンドルによって表される Windows フォントを表すことができます。Handle を設定すると，現在の Windows フォントリソースが解放されます。

注意

フォントを変更するときは，可能な限り，Handle プロパティを使わないで，TFont の他のプロパティを変更して行ってください。Handle を設定しても，フォントを記述するプロパティはリセットされません。ただし，アプリケーションによって Handle が直接設定されると OnChange イベントが発生します。


TFont.Height
TFont.Height3261008

TFont	参照

Height プロパティは，フォントの高さを指定します。

property Height: Integer;

説明

Height プロパティは，フォントの高さをピクセル数で指定します。値が負の数の場合は，テキストの各行の上に表示される内部レディングは含まれません。値が正の数の場合は，Height は内部レディングを含めた文字の高さを表します。

フォントのサイズをポイント数で指定するときは，Height でなく Size プロパティを使います。ユーザーはポイント単位でフォントサイズを指定するのが一般的ですが，アプリケーションではフォントを画面に表示するときにピクセル単位でのフォントの実際のサイズが必要になります。

ポイントサイズから Height プロパティの値を得るには次の式を使います。

Font.Height = -Font.Size * Font.PixelsPerInch / 72

したがって Height プロパティに正の値を入力すると，フォントの Size プロパティは負の値に変わります。逆に，Size プロパティに正の値を入力すると，フォントの Height プロパティは負数に変わります。


TFont.Name
TFont.Name3261009

TFont	参照

Name プロパティは，フォントの書体を指定します。

TFontName = type string;

property Name: TFontName;

説明

Name プロパティは，フォントの書体を指定します。Name で指定したフォントファミリーに複数の文字セットが含まれている場合は，必ず CharSet プロパティも設定してください。

注意

Name，CharSet，Pitch，Size プロパティの組み合わせにより，システムで使用できないフォントが指定された場合は，Windows は別のフォントを代用します。


TFont.Pitch
TFont.Pitch3261010

TFont	参照

Pitch プロパティは，フォントの文字幅をすべて同じにするかどうかを指定します。

TFontPitch = (fpDefault, fpVariable, fpFixed);

property Pitch: TFontPitch;

説明

書体にはそれぞれのピッチが関連付けられています。固定ピッチフォントの文字はすべて同じ文字幅で，可変ピッチフォントの文字の文字幅はそれぞれ異なります。固定ピッチフォントは，字下げを揃えることができるので，ソースコードを記述するのによく使われます。可変ピッチフォントは，テキストを自然な体裁で表示する場合に使われます。

Pitch には次の値があります。

値	意味

fpDefault	フォントピッチはデフォルト値に設定される。デフォルト値は Name プロパティに指定したフォントによって異なる

fpFixed	フォントピッチは固定ピッチに設定される。フォント内のすべての文字は同じ幅になる.

fpVariable	フォントピッチは可変ピッチに設定される。フォント内の文字は幅が異なる

固定ピッチフォントで Pitch プロパティを fpVariable に設定したり，可変ピッチフォントで Pitch プロパティを fpFixed に設定したりすると，Windows は指定されたすべてのフォント特性にもっともよく一致するものを探します。その場合，フォントの体裁は何も変わらないか，または，別のフォントが適切なピッチで代用されます。たとえば，MS Serif（可変ピッチのフォント）のピッチを fpFixed に設定した場合は，Courier が表示されます。


TFont.PixelsPerInch
TFont.PixelsPerInch3261011

TFont	参照

PixelsPerInch プロパティは，論理インチと，フォントを使うデバイス（プリンタまたは画面）のピクセルとの間の変換係数です。

property PixelsPerInch: Integer;

説明

PixelsPerInch プロパティは，フォントがフォームのキャンバスからプリンタにコピーされるときにフォントのポイント数が同じになるようにするために使います。PixelsPerInch プロパティはプリンタフォントだけに影響を及ぼし，変更してはなりません。

フォントのサイズを変更したい場合は Size プロパティと Height プロパティを使います。


TFont.Size
TFont.Size3261012

TFont	参照

Size プロパティは，フォントの高さをポイント単位で指定します。

property Size: Integer;

説明

Size プロパティは，フォントのポイントサイズを指定します。値が負の数の場合，テキストの各行の上に表示される内部レディングが含まれます。値が正の数の場合，Size は内部レディングを含まない文字の高さを表します。

フォントのサイズをピクセル数で指定するときは，Size でなく Height プロパティを使います。ピクセル単位の高さから Size プロパティの値を得るには次の式を使います。

Font.Size = -Font.Height * 72 / Font.PixelsPerInch

したがって，Size プロパティを使って正のポイントサイズを設定した場合は Height プロパティは負の値に変わります。逆に Height に正の値を入れると Size プロパティが負の値に変わります。


TFont.Style
TFont.Style3261013

TFont	参照

Style プロパティは，フォントを通常書体，斜体，下線付き，太字などに決めます。

TFontStyle = (fsBold, fsItalic, fsUnderline, fsStrikeOut);

TFontStyles = set of TFontStyle;

property Style: TFontStyles;

説明

Style プロパティは，文字に特別な属性を付けることができます。Style は，以下の値からなる集合です。指定しなくてもかまいません。

値	意味

fsBold	太字になる

fsItalic	斜体になる

fsUnderline	下線付きになる

fsStrikeout	打ち消し線付きになる


TFont イベント3261014

TFont	アルファベット順

TGraphicsObject からの継承

OnChange


TFont イベント3261015

TFont	オブジェクト順

OnChange


TFont メソッド3261016

TFont	アルファベット順

TFont

Assign

Create

Destroy

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TFont メソッド3261017

TFont	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TFont.Assign
TFont.Assign3261018

TFont	参照

Assign メソッドは，別の TFont オブジェクトのプロパティをコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドを呼び出すと，フォントのプロパティを Source オブジェクトの属性と同じになるように設定できます。Source が別の TFont ならば，Assign はソースのフォント属性を一致させます。Assign は PixelsPerInch プロパティはコピーしないので，このメソッドはスクリーンフォントからプリンタフォントへの変換またはその逆の変換に使うことができます。

Source パラメータが別の TFont でない場合，AssignTo メソッドでフォントプロパティを代入できる任意のオブジェクトからフォントをコピーできるように，Assign は継承するメソッドを呼び出します。


TFont.Create
TFont.Create3261019

TFont	参照

Create メソッドは，TFont のインスタンスを作成し，初期化します。

constructor Create;

説明

Create メソッドを呼び出すと，実行時にフォントオブジェクトを作成できます。Create はフォントリソースにメモリを割り当て，Color プロパティを clWindowText に初期化します。また，Create は画面の解像度に基づいて PixelsPerInch プロパティも初期化します。


TFont.Destroy
TFont.Destroy3261020

TFont	参照

Destroy メソッドは，TFont のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはフォントオブジェクトが解放されていないことを確認してからのみ，Destroy メソッドを呼び出します。Destroy メソッドは Handle プロパティで指定されるリソースを解放します。


スコープ3261021

published


継承3261022

TObject

TPersistent

TGraphicsObject


TFont 例3261023

TFont


TFontAdapter
TFontAdapter3262001

継承	プロパティ	メソッド	参照

TFontAdapter は，Delphi ネイティブの TFont オブジェクトを OLE フォントオブジェクトに結び付けるために使うヘルパークラスです。

ユニット

axctrls

説明

TFontAdapter のインスタンスを作成するには，TFont オブジェクトと OLE オブジェクトとの結合を作成するために GetOleFont 手続きを呼び出します。


TFontAdapter のプロパティ3262002

TFontAdapter	アルファベット順	凡例

TInterfacedObject からの継承

RefCount


TFontAdapter のプロパティ3262003

TFontAdapter	オブジェクト順	凡例

RefCount


TFontAdapter のメソッド3262004

TFontAdapter	アルファベット順

TFontAdapter

Changed

Create

TCustomAdapter からの継承

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TFontAdapter のメソッド3262005

TFontAdapter	オブジェクト順

Changed

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TFontAdapter.Changed
TFontAdapter.Changed3262006

TFontAdapter	参照

Changed メソッドは，現在 TFont に格納されている内容で IFont を更新します。

procedure Changed; override;

説明

TFont が変更されると IFont を更新するために Changed が呼び出されます。


TFontAdapter.Create
TFontAdapter.Create3262007

TFontAdapter	参照

Create メソッドは，フォントアダプタコントロールのインスタンスを構築します。

constructor Create(Font: TFont);

説明

通常，このクラスのオブジェクトを作成することはありません。かわりに，TFont オブジェクトと OLE オブジェクトとの結合を作成するために GetOleFont 手続きを呼び出します。


アクセス種別3262008

読み出し専用


継承3262009

TObject

TInterfacedObject

TCustomAdapter


TFontAdapter の例3262010

TFontAdapter


TFontDialog
TFontDialog3263001

継承	プロパティ	メソッド	イベント

TFontDialog はフォント選択用のダイアログボックスを表示します。

ユニット

dialogs

説明

TFontDialog はフォントを選択するためのモード付きの Windows ダイアログボックスを表示します。このダイアログボックスは，実行時に Execute メソッドが呼び出されるまで表示されません。ユーザーがフォントを選択して［OK］をクリックすると，ダイアログボックスが閉じて，選択されたフォントが Font プロパティに格納されます。


TFontDialog プロパティ3263002

TFontDialog	アルファベット順	凡例

TFontDialog

Device

Font

MaxFontSize

MinFontSize

Options

TCommonDialog からの継承

Ctl3D

Handle

HelpContext

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TFontDialog プロパティ3263003

TFontDialog	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Ctl3D

DesignInfo

Device

Font

Handle

HelpContext

MaxFontSize

MinFontSize

Name

Options

Owner

Tag

VCLComObject


TFontDialog.Device
TFontDialog.Device3263004

TFontDialog

Device プロパティは，使用可能なフォントのリストをどのデバイスから取り出すかを指定します。

TFontDialogDevice = (fdScreen, fdPrinter, fdBoth);

property Device: TFontDialogDevice;

説明

次の値を指定できます。

値	意味

fdScreen	画面から取り出す

fdPrinter	プリンタから取り出す

fdBoth	画面とプリンタ両方から取り出す


TFontDialog.Font
TFontDialog.Font3263005

TFontDialog	参照

Font プロパティは，選択されたフォントを返します。

property Font: TFont;

説明

ダイアログボックスでユーザーがフォントを選択して［OK］をクリックすると，選択されたフォントが Font プロパティの値になります。ダイアログボックスが表示されたときにデフォルトのフォントを表示するには，オブジェクトインスペクタまたはプログラムコードで値を Font に代入します。


TFontDialog.MaxFontSize
TFontDialog.MaxFontSize3263006

TFontDialog	参照

MaxFontSize プロパティは，［フォントの指定］ダイアログボックスで使える最大のフォントサイズを決めます。

property MaxFontSize: Integer;

説明

MaxFontSize に値を代入して，ダイアログボックスで使えるフォントのサイズを制限します。

注意

MaxFontSize は，Options で fdLimitSize フラグが設定されていない限り無効です。


TFontDialog.MinFontSize
TFontDialog.MinFontSize3263007

TFontDialog	参照

MinFontSize プロパティは，［フォントの指定］ダイアログボックスで使える最小のフォントサイズを決めます。

property MinFontSize: Integer;

説明

MinFontSize に値を代入して，ダイアログボックスで使えるフォントサイズを制限します。

注意

MinFontSize は，Options で fdLimitSize フラグが設定されていない限り無効です。


TFontDialog.Options
TFontDialog.Options3263008

TFontDialog	参照

Options プロパティは，［フォントの指定］ダイアログボックスの外観と動作を決めます。

TFontDialogOption = (fdAnsiOnly, fdTrueTypeOnly, fdEffects, fdFixedPitchOnly, fdForceFontExist, fdNoFaceSel, fdNoOEMFonts, fdNoSimulations, fdNoSizeSel, fdNoStyleSel,  fdNoVectorFonts, fdShowHelp, fdWysiwyg, fdLimitSize, fdScalableOnly, fdApplyButton);

TFontDialogOptions = set of TFontDialogOption;

property Options: TFontDialogOptions;

説明

Options プロパティを使うと，ダイアログボックスの外観と動作をカスタマイズできます。次の値を指定できます。

値	意味

fdAnsiOnly	Windows 文字セットを使うフォントだけを表示する。シンボルフォントはダイアログボックスに表示されない

fdApplyButton	OnApply イベントハンドラに関係なく，ダイアログボックスに［適用(A)］ボタンを表示する

fdEffects	［文字飾り］チェックボックス（取り消し線や下線）および［色(C)］リストボックスをダイアログボックスに表示する

fdFixedPitchOnly	ダイアログボックスに固定幅フォントだけを表示する。プロポーショナルフォントや，スタイルヘッダーで固定ピッチフラグがセットされていない TrueType フォントは表示されない

fdForceFontExist	ダイアログボックスに表示されている（［フォントの指定］コンボボックスのリストにある）フォントの入力だけをユーザーに許可する。それ以外のフォント名をユーザーが入力しようとすると，エラーメッセージが表示される

fdLimitSize	MaxFontSize と MinFontSize プロパティを有効にし，これらのプロパティに値が代入されていれば，ダイアログボックスのフォントサイズの範囲を制限する

fdNoFaceSel	［フォントの指定］コンボボックスに選択済みのフォント名を表示せずにダイアログボックスを開く

fdNoOEMFonts	ダイアログボックスのコンボボックスから OEM フォントを削除する。OEM 以外のフォントだけを表示する

fdScalableOnly	ダイアログボックスにスケーラブルフォントだけを表示する。それ以外の（ビットマップ）フォントはリストから削除される

fdNoSimulations	フォント定義ファイルによって直接サポートされているフォントおよびフォントスタイルのみ表示する。GDI 合成のボールドおよびイタリックスタイル（ビットマップフォントの場合）は表示されない

fdNoSizeSel	［サイズ(S)］コンボボックスに選択済みのサイズを表示せずにダイアログボックスを開く

fdNoStyleSel	［スタイル(Y)］コンボボックスに選択済みのスタイルを表示せずにダイアログボックスを開く

fdNoVectorFonts	ダイアログボックスのコンボボックスからベクタフォントを削除する。ベクタ以外のフォントだけを表示する（ベクタフォントは Roman や Script などの Windows 1.0 フォントで，ペンプロッタの出力に似ている）

fdShowHelp	ダイアログボックスに［ヘルプ(H)］ボタンを表示する

fdTrueTypeOnly	ダイアログボックスに TrueType フォントだけを表示する。他のフォントは表示されない

fdWysiwyg	プリンタと画面の両方に使用可能なフォントだけを表示する。デバイス固有のフォントはダイアログボックスに表示されない

デフォルトでは，fdEffects 以外のすべてのオプションがオフです。


TFontDialog イベント3263009

TFontDialog	アルファベット順	凡例

TFontDialog

OnApply

TCommonDialog からの継承

OnClose

OnShow


TFontDialog イベント3263010

TFontDialog	オブジェクト順	凡例

OnApply

OnClose

OnShow


TFontDialog.OnApply
TFontDialog.OnApply3263011

TFontDialog	参照

OnApply イベントは，ユーザーが［適用(A)］ボタンをクリックしたときに発生します。

TFDApplyEvent = procedure(Sender: TObject; Wnd: HWND) of object;

property OnApply: TFDApplyEvent;

説明

［適用(A)］ボタンは，イベントハンドラが OnApply に割り当てられているとき，または fdApplyButton フラグが Options で設定されている場合にダイアログボックスに表示されます。OnApply イベントハンドラを使うと，［フォントの指定］ダイアログボックスを閉じなくても選択したフォントを適用できます。

たとえば，次のイベントハンドラは TFontDialog インスタンス（FontDialog1）の Font を TForm インスタンス（Form1）の Font に割り当てます。

procedure TForm1.FontDialog1Apply(Sender: TObject; Wnd: Integer);

begin

  Font.Assign(TFontDialog(Sender).Font);

end;

注意

Wnd パラメータは［フォントの指定］ダイアログボックスのウィンドウハンドルです。Wnd は Handle プロパティと同じ値で，Delphi の以前のバージョンとの互換性を保つためのものです。


TFontDialog メソッド3263012

TFontDialog	アルファベット順

TFontDialog

Create

Destroy

Execute

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

TPersisten からの継承

GetNamePath


TFontDialog メソッド3263013

TFontDialog	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Execute

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TFontDialog.Create
TFontDialog.Create3263014

TFontDialog

Create メソッドは，TFontDialog のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは TFontDialog のインスタンスを生成しますが，新しいダイアログボックスは Execute メソッドが呼び出されるまでフォーム上に表示されません。


TFontDialog.Destroy
TFontDialog.Destroy3263015

TFontDialog	参照

Destroy メソッドは，TFontDialog を破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは［フォントの指定］ダイアログボックスが破棄されていないことを確認してから Destroy メソッドを呼び出します。


TFontDialog.Execute
TFontDialog.Execute3263016

TFontDialog

Execute メソッドは，［フォントの指定］ダイアログボックスを表示します。

function Execute: Boolean; override;

説明

Execute メソッドは［フォントの指定］ダイアログボックスを開き，ユーザーがフォントを選択して［OK］をクリックしたときに True を返します。


スコープ3263017

published

読み出し／書き込み

読み出し専用


スコープ3263018

published


継承3263019

TObject

TPersistent

TComponent

TCommonDialog


TFontDialog 例3263020

TFontDialog


TForm
TForm3264001

継承	プロパティ	メソッド	イベント	参照

TForm は，標準アプリケーションウィンドウ（フォーム）用のコンポーネントです。

ユニット

forms

説明

TForm コンポーネントを使うと，メインウィンドウ，ダイアログボックス，MDI 子などのフォームを作成できます。フォームには，TButton，TCheckBox，TComboBox オブジェクトなど，他のオブジェクトを入れることができます。

フォームの例としては，TLoginDialog および TPasswordDialog オブジェクトがあります。


TForm プロパティ3264002

TForm	アルファベット順	凡例

TCustomForm からの継承

Active

ActiveControl

ActiveMDIChild

ActiveOleControl

BorderIcons

BorderStyle

Canvas

ClientHandle

ClientHeight

ClientRect

ClientWidth

Designer

DropTarget

FormStyle

HelpFile

Icon

KeyPreview

MDIChildCount

MDIChildren

Menu

ModalResult

ObjectMenuItem

OleFormObject

Parent

PixelsPerInch

Position

PrintScale

Scaled

TileMode

Visible

WindowMenu

WindowState

TScrollingWinControl からの継承

AutoScroll

HorzScrollBar

VertScrollBar

TWinControl からの継承

Brush

ClientOrigin

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

Color

ControlState

ControlStyle

Cursor

Enabled

Font

Height

Hint

Left

Name

ParentFont

PopupMenu

ShowHint

Top

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TForm プロパティ3264003

TForm	オブジェクト順	凡例

Active

ActiveControl

ActiveMDIChild

ActiveOleControl

Align

AutoScroll

BorderIcons

BorderStyle

BoundsRect

Brush

Canvas

Caption

ClientHandle

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

Designer

DesignInfo

DropTarget

Enabled

Font

FormStyle

Handle

Height

HelpContext

HelpFile

Hint

HorzScrollBar

Icon

KeyPreview

Left

MDIChildCount

MDIChildren

Menu

ModalResult

Name

ObjectMenuItem

OleFormObject

Owner

Parent

ParentFont

ParentWindow

PixelsPerInch

PopupMenu

Position

PrintScale

Scaled

ShowHint

Showing

TabOrder

TabStop

Tag

TileMode

Top

VCLComObject

VertScrollBar

Visible

Width

WindowMenu

WindowProc

WindowState


TForm イベント3264004

TForm	アルファベット順	凡例

TCustomForm からの継承

OnActivate

OnClose

OnCloseQuery

OnCreate

OnDeactivate

OnDestroy

OnHelp

OnHide

OnPaint

OnResize

OnShow

TWinControl からの継承

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnMouseDown

OnMouseMove

OnMouseUp


TForm イベント3264005

TForm	オブジェクト順	凡例

OnActivate

OnClick

OnClose

OnCloseQuery

OnCreate

OnDblClick

OnDeactivate

OnDestroy

OnDragDrop

OnDragOver

OnHelp

OnHide

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnPaint

OnResize

OnShow


TForm メソッド3264006

TForm	アルファベット順

TForm

ArrangeIcons

Cascade

Next

Previous

Tile

TCustomForm からの継承

Close

CloseQuery

Create

CreateNew

DefocusControl

Destroy

FocusControl

GetFormImage

Hide

Print

Release

SendCancelMode

SetFocus

SetFocusedControl

Show

ShowModal

WantChildKey

TScrollingWinControl からの継承

DisableAutoRange

EnableAutoRange

ScrollInView

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TForm メソッド3264007

TForm	オブジェクト順

ArrangeIcons

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

Cascade

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Close

CloseQuery

ContainsControl

ControlAtPos

Create

CreateNew

CreateParented

DefaultHandler

DefocusControl

Destroy

DestroyComponents

Destroying

DisableAlign

DisableAutoRange

Dispatch

DragDrop

Dragging

EnableAlign

EnableAutoRange

EndDrag

FieldAddress

FindComponent

FocusControl

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetFormImage

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Next

PaintTo

Perform

Previous

Print

Realign

Refresh

Release

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

ScrollInView

SendCancelMode

SendToBack

SetBounds

SetFocus

SetFocusedControl

SetTextBuf

Show

ShowModal

Tile

Update

UpdateControlState

WantChildKey


TForm.ArrangeIcons
TForm.ArrangeIcons3264008

TForm	参照

ArrangeIcons メソッドは，最小化した MDI 子フォームのアイコンを整列させます。

procedure ArrangeIcons;

説明

ArrangeIcons メソッドを呼び出すと，最小化した MDI 子フォームのアイコンを重ならないように等間隔に配列できます。

ArrangeIcons メソッドは，FormStyle プロパティが fsMDIForm に設定されている MDI 親フォームだけに有効です。


TForm.Cascade
TForm.Cascade3264009

TForm	参照

Cascade メソッドは，MDI 子フォームを重なり合うように再配置します。

procedure Cascade;

説明

Cascade メソッドを呼び出すと，MDI 子フォームを重なり合うように再配置できます。

Cascade メソッドは，FormStyle プロパティが fsMDIForm に設定されている MDI 親フォームだけに有効です。


TForm.Next
TForm.Next3264010

TForm	参照

Next メソッドは，フォームシーケンスの次の子フォームをアクティブにします。

procedure Next;

説明

たとえば，MDI アプリケーションの親フォームに 3 つの子フォームがあり，Form2 がアクティブフォームの場合，Next メソッドは Form3 をアクティブフォームにします。再度 Next を呼び出すと Form4 がアクティブになります。アプリケーションが次に Next を呼び出すとシーケンスは最初に戻り，再度 Form2 がアクティブになります。

Next メソッドは，FormStyle プロパティが fsMDIForm に設定されている MDI 親フォームだけに有効です。


TForm.Previous
TForm.Previous3264011

TForm	参照

Previous メソッドは，フォームシーケンス内の前の MDI の子フォームをアクティブフォームにします。

procedure Previous;

説明

たとえば，MDI アプリケーションの親フォームに 3 つの子フォームがあり，Form4 がアクティブフォームの場合，Previous メソッドは Form3 をアクティブフォームにします。再度 Previous を呼び出すと Form2 がアクティブになります。アプリケーションが次に Previous を呼び出すとシーケンスは最初に戻り，再度 Form4 がアクティブになります。

Previous メソッドは，FormStyle プロパティが fsMDIForm に設定されている MDI 親フォームだけに有効です。


TForm.Tile
TForm.Tile3264012

TForm	参照

Tile メソッドは，MDI 子フォームをすべて同じサイズになるように配列します。

procedure Tile;

説明

Tile メソッドを呼び出すと，MDI 子フォームをすべて同じサイズになるように配列できます。並べて表示されたフォームで，親フォームのクライアント領域は埋め尽くされます。フォームが並べられる方向は TileMode プロパティの値によって異なります。

Tile メソッドは，FormStyle プロパティが fsMDIForm に設定されている MDI 親フォームだけに有効です。


スコープ3264013

published

読み出し／書き込み

読み出し専用


スコープ3264014

published


継承3264015

TObject

TPersistent

TComponent

TControl

TWinControl

TScrollingWinControl

TCustomForm


TForm 例3264016

TForm


TGraphicField
TGraphicField3265001

継承	プロパティ	メソッド	イベント	参照

TGraphicField コンポーネントはデータセット内のグラフィック型項目を表します。

ユニット

db

説明

グラフィック型項目は，データにグラフィック値の符号化を記述する BLOB ヘッダーが含まれる，バイナリラージオブジェクト（BLOB）項目です。TGraphicField は，DataType が ftGraphic であるという点でのみ，直接の上位オブジェクトの TBlobField と異なります。TGraphicField は TBlobField の下位オブジェクトなので，データベース内の BLOB 項目の値とプロパティの管理に便利な多くのプロパティ，メソッド，およびイベントを提供します。


TGraphicField プロパティ3265002

TGraphicField	アルファベット順	凡例

TBlobField からの継承

AsString

AsVariant

BlobSize

BlobType

IsNull

Modified

Transliterate

Value

TField からの継承

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TGraphicField プロパティ3265003

TGraphicField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

BlobSize

BlobType

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Modified

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

Transliterate

ValidChars

Value

VCLComObject

Visible


TGraphicField イベント3265004

TGraphicField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TGraphicField イベント3265005

TGraphicField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TGraphicField メソッド3265006

TGraphicField	アルファベット順

TGraphicField

Create

TBlobField からの継承

Assign

Clear

IsBlob

LoadFromFile

LoadFromStream

SaveToFile

SaveToStream

SetFieldType

TField からの継承

AssignValue

Destroy

FocusControl

GetData

IsValidChar

RefreshLookupList

SetData

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TGraphicField メソッド3265007

TGraphicField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SaveToFile

SaveToStream

SetData

SetFieldType

Validate


TGraphicField.Create
TGraphicField.Create3265008

TGraphicField	参照

Create メソッドは，グラフィック型項目コンポーネントのコンストラクタです。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは TGraphicField のインスタンスを作成し初期化します。継承コンストラクタを呼び出した後，Create メソッドは DataType を ftGraphic に設定します。

グラフィック型項目コンポーネントはデータセット内のすべてのグラフィック型項目に合わせて自動的にインスタンス化されるので，Create メソッドを呼び出す必要はほとんどありません。


スコープ3265009

published

読み出し／書き込み

読み出し専用


スコープ3265010

published


継承3265011

TObject

TPersistent

TComponent

TField

TBlobField


TGraphicField 例3265012

TGraphicField


TGraphic
TGraphic3266001

継承	プロパティ	メソッド	イベント	参照

TGraphic は，アイコン，ビットマップ，およびメタファイルなどのイメージを格納および表示する Delphi グラフィックオブジェクトの抽象基本クラスです。

ユニット

graphics

説明

TGraphic はインスタンス化することができない抽象クラスです。下位グラフィックオブジェクトは，特定のファイル形式やグラフィック特性のニーズに合うように TGraphic の多くのメソッドをオーバーライドします。また，TGraphic は TPicture オブジェクトおよびクリップボードで使うメソッドを導入します。TGraphic のプロパティはグラフィックイメージの状態とサイズについての情報を提供します。

グラフィックの種類が（ビットマップ，アイコン，メタファイルの）どれであるかわかる場合はグラフィックをその種類のオブジェクト（TBitmap，TIcon，TMetafile）に格納してください。わからない場合は，TGraphic のどの型でも格納できる TPicture オブジェクトを使ってください。


TGraphic プロパティ3266002

TGraphic	アルファベット順	凡例

TGraphic

Empty

Height

Modified

Palette

PaletteModified

Transparent

Width


TGraphic プロパティ3266003

TGraphic	オブジェクト順	凡例

Empty

Height

Modified

Palette

PaletteModified

Transparent

Width


TGraphic.Empty
TGraphic.Empty3266004

TGraphic

Empty プロパティは，グラフィックオブジェクトにグラフィックを含めるかどうかを指定します。

property Empty: Boolean;

説明

各派生グラフィックオブジェクトは独自の「Get」メソッドを定義して Empty プロパティにアクセスします。


TGraphic.Height
TGraphic.Height3266005

TGraphic

Height プロパティは，グラフィックの縦方向のサイズをピクセル単位で指定します。

property Height: Integer;

説明

各派生グラフィックオブジェクトは独自の「Get」と「Set」メソッドを定義して Height プロパティにアクセスします。


TGraphic.Modified
TGraphic.Modified3266006

TGraphic

Modified プロパティは，グラフィックオブジェクトが変更または編集されているかどうかを示します。

property Modified: Boolean;

説明

Modified プロパティが True の場合，グラフィックオブジェクトは変更されています。Modified が False の場合，グラフィックオブジェクトはロードされたときと同じ状態です。

アイコンまたはメタファイルグラフィックを格納しているグラフィックオブジェクトの場合は，たとえそれが変更されていても，Modified は True になりません。

グラフィックオブジェクトが変更されている場合には，SaveToFile メソッドを使って変更をファイルに保存します。アプリケーションでは，LoadFromFile メソッドを使ってファイルからグラフィックをロードできます。


TGraphic.Palette
TGraphic.Palette3266007

TGraphic

Palette プロパティは，グラフィックイメージのカラーパレットを示します。

property Palette: HPALETTE;

説明

Palette プロパティは，グラフィックイメージのカラーパレットを取得できます。グラフィックがパレットを必要としないか，使っていない場合，Palette は 0 です。


TGraphic.PaletteModified
TGraphic.PaletteModified3266008

TGraphic

PaletteModified プロパティは，パレットが変更されているかどうかを示します。

property PaletteModified: Boolean;

説明

PaletteModified プロパティは，グラフィックイメージに使われるパレットが変更されているかどうかを取得できます。PaletteModified は OnChange イベントで使われます。新しいパレットの作成の責任を負うもの（たとえば，TImage）が False に設定するまで，PaletteModified は True のままです。


TGraphic.Transparent
TGraphic.Transparent3266009

TGraphic

Transparent プロパティは，イメージが長方形の領域を覆いつくしているかどうかを示します。

property Transparent: Boolean;

説明

Transparent プロパティは，グラフィックイメージが長方形の領域を完全に覆いつくしているかどうかを取得できます。


TGraphic.Width
TGraphic.Width3266010

TGraphic

Width プロパティは，グラフィックオブジェクトの最大の幅をピクセル単位で決めます。

property Width: Integer;

説明

各派生グラフィックオブジェクトは独自の「Get」と「Set」メソッドを定義して Width プロパティにアクセスします。


TGraphic イベント3266011

TGraphic	アルファベット順

TGraphic

OnChange

OnProgress


TGraphic イベント3266012

TGraphic	オブジェクト順

OnChange

OnProgress


TGraphic.OnChange
TGraphic.OnChange3266013

TGraphic

OnChange イベントは，グラフィックイメージが変更されたときに発生します。

property OnChange: TNotifyEvent;

説明

OnChange イベントを記述すると，グラフィックイメージが変更されたときに処理を行えます。


TGraphic.OnProgress
TGraphic.OnProgress3266014

TGraphic	参照

OnProgress イベントは，グラフィックイメージの変更処理の進行中に発生します。

TProgressEvent = procedure (Sender: TObject; Stage: TProgressStage; PercentDone: Byte; RedrawNow: Boolean; const R: TRect; const Msg: string) of object;

property OnProgress: TProgressEvent;

説明

OnProgress イベントは，TPicture および TImage の OnProgress イベントへの通知を行う，汎用プログレスインジケータイベントです。


TGraphic メソッド3266015

TGraphic	アルファベット順

TGraphic

LoadFromClipboardFormat

LoadFromFile

LoadFromStream

SaveToClipboardFormat

SaveToFile

SaveToStream

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TGraphic メソッド3266016

TGraphic	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LoadFromClipboardFormat

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

SafeCallException

SaveToClipboardFormat

SaveToFile

SaveToStream


TGraphic.LoadFromClipboardFormat
TGraphic.LoadFromClipboardFormat3266017

TGraphic	参照

TGraphic は LoadFromClipboardFormat メソッドを抽象メソッドとして提供します。

procedure LoadFromClipboardFormat(AFormat: Word; AData: THandle; APalette: HPALETTE); virtual; abstract;

説明

各派生グラフィックオブジェクトは，現在のグラフィックイメージを AData で指定したグラフィック（クリップボードからロードされる）に置き換える LoadFromClipboardFormat メソッドを定義します。

新しいグラフィックオブジェクトの形式は RegisterClipboardFormat メソッドでクリップボードに登録する必要があり，それ以外の場合は例外が発生します。


TGraphic.LoadFromFile
TGraphic.LoadFromFile3266018

TGraphic

LoadFromFile メソッドは，ファイルに格納されているグラフィックオブジェクトを読み込みます。

procedure LoadFromFile(const FileName: string); virtual;

説明

LoadFromFile メソッドは FileName で指定されたファイルを読み出し，そのデータをグラフィックオブジェクトにロードします。


TGraphic.LoadFromStream
TGraphic.LoadFromStream3266019

TGraphic

TGraphic は LoadFromStream メソッドを抽象メソッドとして提供します。

procedure LoadFromStream(Stream: TStream); virtual; abstract;

説明

各派生グラフィックオブジェクトは，Stream からグラフィックオブジェクトをロードする LoadFromStream メソッドを定義します。


TGraphic.SaveToClipboardFormat
TGraphic.SaveToClipboardFormat3266020

TGraphic	参照

TGraphic は SaveToClipboardFormat メソッドを抽象メソッドとして提供します。

procedure SaveToClipboardFormat(var AFormat: Word; var AData: THandle; var APalette: HPALETTE); virtual; abstract;

説明

各派生グラフィックオブジェクトは，特定のグラフィックイメージ型をクリップボード形式に保存する SaveToClipboardFormat メソッドを定義します。アプリケーションは RegisterClipboardFormat メソッドを使ってその形式を TGraphic オブジェクトに登録しておく必要があります。


TGraphic.SaveToFile
TGraphic.SaveToFile3266021

TGraphic

SaveToFile メソッドは，グラフィックオブジェクトをファイルに保存します。

procedure SaveToFile(const FileName: string); virtual;

説明

SaveToFile メソッドは FileName で指定したファイルにグラフィックを書き込みます。


TGraphic.SaveToStream
TGraphic.SaveToStream3266022

TGraphic

TGraphic は SaveToStream メソッドを抽象メソッドとして提供します。

procedure SaveToStream(Stream: TStream); virtual; abstract;

説明

各派生グラフィックオブジェクトは，オブジェクトを Stream に保存する SaveToStream メソッドを定義します。


読み出し／書き込み3266023

読み出し専用


継承3266024

TObject

TPersistent


TGraphic 例3266025

TGraphic


TGraphicsObject
TGraphicsObject3267001

継承	プロパティ	メソッド	イベント	参照

TGraphicsObject は Windows グラフィックオブジェクト（TBrush，TFont，および TPen）をカプセル化するオブジェクトの抽象基本クラスです。

ユニット

graphics

説明

キャンバス（TCanvas）にイメージを描画するときに TGraphicsObject の派生オブジェクトを作成します。各 TGraphicsObject オブジェクトは，キャンバスのデバイスコンテキストに選択されているグラフィックオブジェクトを表します。

TGraphicsObject は，グラフィックオブジェクトのプロパティの変更に応答する機構を提供します。


TGraphicsObject プロパティ3267002

TGraphicsObject	アルファベット順

TGraphicsObject

OwnerCriticalSection


TGraphicsObject プロパティ3267003

TGraphicsObject	オブジェクト順

OwnerCriticalSection


TGraphicsObject.OwnerCriticalSection
TGraphicsObject.OwnerCriticalSection3267004

TGraphicsObject	参照

OwnerCriticalSection プロパティは，このグラフィックオブジェクトを描画するキャンバスが他の実行スレッドをロックするために使う TRTLCriticalSection へのポインタです。

PRTLCriticalSection = ^TRTLCriticalSection;

TRTLCriticalSection = record

    DebugInfo: PRTLCriticalSectionDebug;

    LockCount: Longint;

    RecursionCount: Longint;

    OwningThread: THandle;

    LockSemaphore: THandle;

    Reserved: DWORD;

  end;

property OwnerCriticalSection: PRTLCriticalSection;

説明

OwnerCriticalSection プロパティは，このグラフィックオブジェクトを描画するキャンバスのスレッドロック状態についての情報を取得できます。キャンバスオブジェクトはグラフィックオブジェクトの作成時に OwnerCriticalSection を設定します。キャンバスがグラフィックオブジェクトを使っている間はこのプロパティを変更しないでください。

グラフィックオブジェクトがキャンバスでない描画面のかわりに作成された場合は，OwnerCriticalSection を，描画面によって保持されている初期化された TRTLCriticalSection に設定します。

OwnerCriticalSection を使って他の実行スレッドをブロックするには，Lock メソッドを使います。


TGraphicsObject イベント3267005

TGraphicsObject	アルファベット順

TGraphicsObject

OnChange


TGraphicsObject イベント3267006

TGraphicsObject	オブジェクト順

OnChange


TGraphicsObject.OnChange
TGraphicsObject.OnChange3267007

TGraphicsObject	参照

OnChange イベントは，Windows グラフィックオブジェクトが変更された直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnChange: TNotifyEvent;

説明

グラフィックオブジェクトが変更されたときに特別なアクションを実行するために，OnChange イベントハンドラを記述します。グラフィックオブジェクトのプロパティは，OnChange イベントが発生したときに新しい設定を反映します。


TGraphicsObject メソッド3267008

TGraphicsObject	アルファベット順	凡例

TGraphicsObject

Changed

Lock

Unlock

TPersistent からの継承

Assign

Destroy

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TGraphicsObject メソッド3267009

TGraphicsObject	オブジェクト順	凡例

Assign

Changed

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

Lock

MethodAddress

MethodName

NewInstance

SafeCallException

Unlock


TGraphicsObject.Changed
TGraphicsObject.Changed3267010

TGraphicsObject	参照

Changed メソッドは，グラフィックオブジェクトのプロパティが変更されたときに OnChange イベントを生成します。

procedure Changed; dynamic;

説明

TGraphicsObject の派生オブジェクトは，TGraphicsObject オブジェクトによってカプセル化されているプロパティを変更してから Changed メソッドを呼び出します。


TGraphicsObject.Lock
TGraphicsObject.Lock3267011

TGraphicsObject	参照

Lock メソッドは，Unlock メソッドが呼び出されるまで，他のすべての実行スレッドをブロックします。

procedure Lock;

説明

Lock メソッドは，マルチスレッドアプリケーションで，スレッドセーフでないコードのセクションでグラフィックオブジェクトを使う前に呼び出します。Lock は，Unlock メソッドが呼び出されるまで，アプリケーション内の他のすべてのスレッドを実行できないようにします。Lock の呼び出しは，最後のロックが解放されるまではキャンバスのロックが解除されないようにネストすることができます。

Lock は他のすべてのスレッドを実行できなくするので，処理効率に悪影響を及ぼすことがあります。他のスレッドが描画に干渉する危険性がある場合以外は Lock を呼び出さないでください。

注意

描画面が OwnerCriticalSection プロパティを設定していなければ，Lock は何も行いません。TCanvas オブジェクトはグラフィックオブジェクトを使うとき自動的に OwnerCriticalSection プロパティを設定します。


TGraphicsObject.Unlock
TGraphicsObject.Unlock3267012

TGraphicsObject	参照

Unlock メソッドは，Lock メソッドによって設定された実行スレッドのロックを解放します。

procedure Unlock;

説明

Unlock メソッドは，Lock メソッドの呼び出しで始まったコードのスレッド感知セクションの最後で呼び出します。Lock の呼び出しと Unlock の呼び出しが対になったら，他のスレッドは実行を再開できます。


スコープ3267013

protected


継承3267014

TObject

TPersistent


TGraphicsObject 例3267015

TGraphicsObject


TGridDataLink
TGridDataLink3268001

継承	プロパティ	メソッド	参照

TGridDataLink オブジェクトは，データソースへのリンクを管理し，TCustomDBGrid オブジェクトが使う項目マッピングを維持するヘルパーオブジェクトです。

ユニット

dbgrids

説明

TGridDataLink オブジェクトは TCustomDBGrid オブジェクトとともに動作します。TCustomDBGrid クラスのみが使えるオブジェクトです。


TGridDataLink プロパティ3268002

TGridDataLink	アルファベット順	凡例

TGridDataLink

DefaultFields

FieldCount

Fields

SparseMap

TDataLink からの継承

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


TGridDataLink プロパティ3268003

TGridDataLink	オブジェクト順	凡例

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

DefaultFields

Editing

FieldCount

Fields

ReadOnly

RecordCount

SparseMap


TGridDataLink.DefaultFields
TGridDataLink.DefaultFields3268004

TGridDataLink	参照

DefaultFields プロパティは，データセットのオープン時にデータセットの項目コンポーネントが動的に生成されるかどうかを示します。

property DefaultFields: Boolean;

説明

DefaultFields プロパティは，データセットが動的に生成された項目コンポーネントを使うのか，あるいは持続項目コンポーネントを使うのかがわかります。DefaultFields プロパティが True の場合，データセットは動的に割り当てられた項目コンポーネントを使います。DefaultFields プロパティが False の場合は，データセットが持続項目コンポーネントを使うこと，またはこの項目マッピングにはマップされていない項目が含まれている可能性があることを示します。

DefaultFields プロパティが False の場合，TCustomDBGrid オブジェクトはデータベーステーブル中の項目をすべて表示しているとは限りません。


TGridDataLink.FieldCount
TGridDataLink.FieldCount3268005

TGridDataLink	参照

FieldCount プロパティは，項目マップ内のエントリの数を示します。

property FieldCount: Integer;

説明

FieldCount プロパティは，項目マップ内のエントリの数を取得します。Fields プロパティとともに使用すると，マップされた項目をすべて反復処理する必要があるアプリケーションで便利です。

FieldCount プロパティは，TCustomDBGrid に含まれる列の数と同じです。項目マップには，データセットに存在しない未定義の項目を含ませることができます。項目マップ内の未定義のフィールドは，計算フィールドのように，データセットには存在しないけれどもグリッドの列には存在する項目です。


TGridDataLink.Fields
TGridDataLink.Fields3268006

TGridDataLink	参照

Fields プロパティは，項目マップに含まれるすべての項目コンポーネントへのアクセスを提供します。

property Fields[I: Integer]: TField;

説明

Fields プロパティは，項目コンポーネントにインデックス番号を使ってアクセスできます。Fields プロパティは 0 から始まる配列です。SparseMap プロパティが True の場合，項目マップには未定義の項目も含まれる場合があります。これらのエントリについて，Fields プロパティは nil を返します。

アプリケーションがTCustomDBGrid オブジェクトの各列にある項目コンポーネントを順にアクセスする必要がある場合，Fields プロパティを FieldCount プロパティとともに使います。

for I := 0 to FieldCount-1 do

    if Fields[I] <> nil then

    begin

     { Fields[I] は，実行時の次の列用の項目コンポーネント }

    end;


TGridDataLink.SparseMap
TGridDataLink.SparseMap3268007

TGridDataLink	参照

SparseMap プロパティは，TCustomDBGrid オブジェクトが項目マップをカスタマイズしたことと，項目マップが未定義の項目を含んでいるかもしれないことを示します。

property SparseMap: Boolean

説明

SparseMap プロパティを読み出すと，項目マップがデータセットをそのまま反映したものであるかどうかがわかります。TCustomDBGrid オブジェクトは項目マップを構築するときに SparseMap プロパティを設定します。TCustomDBGrid オブジェクトがデータセットから直接デフォルトの項目マップを構築する場合，SparseMap プロパティは False です。各列に関連付けられている項目コンポーネントに何らかの変更が加えられると，TCustomDBGrid オブジェクトは SparseMap プロパティを True に設定します。SparseMap プロパティが True のときに，無効な項目名や割り当てられていない項目コンポーネントを列の属性が示す場合は，項目マップは未定義の項目を含みます。


TGridDataLink メソッド3268008

TGridDataLink	アルファベット順	凡例

TGridDataLink

ActiveChanged

AddMapping

ClearMapping

Create

DataSetChanged

DataSetScrolled

Destroy

EditingChanged

FocusControl

GetMappedIndex

LayoutChanged

Modified

RecordChanged

Reset

UpdateData

TDataLink からの継承

Edit

UpdateRecord

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TGridDataLink メソッド3268009

TGridDataLink	オブジェクト順	凡例

ActiveChanged

AddMapping

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearMapping

Create

DataSetChanged

DataSetScrolled

DefaultHandler

Destroy

Dispatch

Edit

EditingChanged

FieldAddress

FocusControl

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetMappedIndex

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LayoutChanged

MethodAddress

MethodName

Modified

NewInstance

RecordChanged

Reset

SafeCallException

UpdateData

UpdateRecord


TGridDataLink.ActiveChanged
TGridDataLink.ActiveChanged3268010

TGridDataLink	参照

ActiveChanged メソッドは TCustomDBGrid メソッドに Active プロパティの変化を通知します。

procedure ActiveChanged; override;

説明

アプリケーションは ActiveChanged 手続きを直接呼び出せません。Active プロパティに変更を加えると，この手続きが呼び出されます。データセットがアクティブでなくなると，ActiveChanged は，データセットに存在しない項目への参照がグリッドに含まれているかどうか，およびグリッドが不適切にスクロールされていないかどうかを確認します。


TGridDataLink.AddMapping
TGridDataLink.AddMapping3268011

TGridDataLink	参照

AddMapping メソッドは，項目コンポーネントを項目マップの末尾に追加します。

function AddMapping(const FieldName: string): Boolean;

説明

アプリケーションは AddMapping メソッドを直接呼び出してはいけません。項目マップと TCustomDBGrid オブジェクト内の各列との同期が崩れてしまうからです。TCustomDBGrid オブジェクトは AddMapping メソッドの呼び出しを反復して，列と対応する項目マップを構築します。


TGridDataLink.ClearMapping
TGridDataLink.ClearMapping3268012

TGridDataLink	参照

ClearMapping メソッドは，項目マップを空にして関連するメモリをすべて解放します。

procedure ClearMapping;

説明

アプリケーションから直接 ClearMapping メソッドを呼び出してはいけません。項目マップと TCustomDBGrid オブジェクト内の各列との同期が崩れてしまうからです。TCustomDBGrid オブジェクトは項目マップを再生成するときには最初に ClearMapping メソッドを呼び出します。


TGridDataLink.Create
TGridDataLink.Create3268013

TGridDataLink	参照

Create メソッドは，TGridDataLink のインスタンスを作成します。

constructor Create(AGrid: TCustomDBGrid);

説明

アプリケーションは TGridDataLink オブジェクトの Create メソッドを直接呼び出してはいけません。TGridDataLink オブジェクトのオーナーである TCustomDBGrid オブジェクトは Create メソッドを自身のコンストラクタから呼び出します。


TGridDataLink.DataSetChanged
TGridDataLink.DataSetChanged3268014

TGridDataLink	参照

DataSetChanged メソッドは，TCustomDBGrid オブジェクトにデータセットへの変更を通知します。

procedure DataSetChanged; override;

説明

アプリケーションは DataSetChanged メソッドを直接呼び出せません。データセットの内容が変更されると，このメソッドが自動的に呼び出されます。DataSetChanged メソッドによって TCustomDBGrid オブジェクトはデータセットがいつ変更されたかを知ることができます。


TGridDataLink.DataSetScrolled
TGridDataLink.DataSetScrolled3268015

TGridDataLink	参照

DataSetScrolled メソッドは，TCustomDBGrid オブジェクトにデータセットのスクロールの終了を通知します。

procedure DataSetScrolled(Distance: Integer); override;

説明

アプリケーションは DataSetScrolled 手続きを直接呼び出せません。この手続きは TCustomDBGrid オブジェクトのデータセットがスクロールした後で自動的に呼び出されます。TGridDataLink オブジェクトは TCustomDBGrid オブジェクトにデータセットのスクロールを Scroll メソッドの呼び出しで通知します。


TGridDataLink.Destroy
TGridDataLink.Destroy3268016

TGridDataLink	参照

Destroy メソッドは，TGridDataLink のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。TGridDataLink オブジェクトのオーナーである TCustomDBGrid オブジェクトが自身のデストラクタから Free を呼び出して TGridDataLink オブジェクトを破棄します。

Destroy メソッドは，項目マップが使っていたメモリを解放してから継承デストラクタを呼び出します。


TGridDataLink.EditingChanged
TGridDataLink.EditingChanged3268017

TGridDataLink	参照

EditingChanged メソッドは，TCustomDBGrid オブジェクトにデータセットの編集状態の変化を通知します。

procedure EditingChanged; override;

説明

アプリケーションは EdtingChanged 手続きを直接呼び出せません。Editing プロパティへの変更によってこの手続きが呼び出されます。EditingChanged メソッドによって，TCustomDBGrid オブジェクトはデータセットの編集状態をユーザーにビジュアルにフィードバックできます。


TGridDataLink.FocusControl
TGridDataLink.FocusControl3268018

TGridDataLink	参照

FocusControl メソッドは，エディタを表示して TCustomDBGrid オブジェクト内の項目コントロールにフォーカスを与えます。

procedure FocusControl(Field: TFieldRef); override;

説明

FocusControl プロシージャを呼び出すと，TCustomDBGrid オブジェクトの Field にエディタを表示します。FocusControl は TCustomDBGrid オブジェクトの Field を選択してから，TCustomDBGrid オブジェクトにエディタを表示するよう通知します。


TGridDataLink.GetMappedIndex
TGridDataLink.GetMappedIndex3268019

TGridDataLink	参照

GetMappedIndex メソッドは，項目マップ内のインデックスと対応するデータセット内の項目コンポーネントのインデックスを与えます。

function GetMappedIndex(ColIndex: Integer): Integer;

GetMappedIndex メソッドを項目マップのインデックスに対して使用すると，同じ項目コンポーネントが使うデータセット内でのインデックスを取得できます。項目マップおよびデータセットはともに 0 から始まる配列です。項目マップのエントリが未定義の項目である場合，GetMappedIndex メソッドは -1 を返します。


TGridDataLink.LayoutChanged
TGridDataLink.LayoutChanged3268020

TGridDataLink	参照

LayoutChanged メソッドは，レイアウト後の TCustomDBGrid オブジェクトに TCustomDBGrid オブジェクトがデータセットの表示に影響するような変更を受けたことを通知します。

procedure LayoutChanged; override;

説明

アプリケーションは LayoutChanged メソッドを直接呼び出せません。TGridDataLink オブジェクトのオーナーである TCustomDBGrid オブジェクトが，レイアウトの変更がデータセットの表示に影響するときに自動的にこのメソッドを呼び出します。LayoutChanged メソッドによって，TCustomDBGrid オブジェクトは自分の LayoutChanged メソッドを呼び出してレイアウトを再生成することができます。


TGridDataLink.Modified
TGridDataLink.Modified3268021

TGridDataLink	参照

Modified メソッドは，データベースの現在のレコードに書き込まれていないデータへの変更をトラッキングします。

procedure Modified;

説明

アプリケーションは Modified メソッドを直接呼び出してはいけません。Modified メソッドは TCustomDBGrid オブジェクトが項目の編集を開始したときに自動的に呼び出されます。Modified メソッドによって，TGridDataLink オブジェクトは登録されていない編集があるかどうかをトラッキングできます。


TGridDataLink.RecordChanged
TGridDataLink.RecordChanged3268022

TGridDataLink	参照

RecordChanged メソッドは，TCustomDBGrid オブジェクトに DataSource の現在のレコードまたは項目の変更を通知します。

procedure RecordChanged(Field: TField);

説明

アプリケーションは RecordChanged メソッドを直接呼び出せません。このメソッドは現在のレコードの内容が変化したときに自動的に呼び出されます。Field パラメータは現在のレコードのどの項目が変化したかを示します。Field パラメータが nil の場合は，レコード全体が変更されています。

RecordChanged メソッドは TCustomDBGrid オブジェクトにこうした変更を通知して，変更に関連する 1 つまたは複数の列の表示をオブジェクトが更新できるようにします。


TGridDataLink.Reset
TGridDataLink.Reset3268023

TGridDataLink	参照

Reset メソッドは，データベースの現在のレコードに書き込まれていない編集をすべて破棄します。

procedure Reset;

説明

Reset メソッドは，データセットに未登録の編集をすべてキャンセルするユーザー操作によって呼び出されます。


TGridDataLink.UpdateData
TGridDataLink.UpdateData3268024

TGridDataLink	参照

UpdateData メソッドは，TCustomDBGrid オブジェクトがデータセットへの変更を登録できるようにします。

procedure UpdateData;

説明

アプリケーションは UpdateData 手続きを直接呼び出せません。未登録の変更をデータセットに登録する必要があるときに自動的に呼び出されます。UpdateData メソッドは，現在の項目に加えられた未登録の変更を対応する Field コンポーネントにすべて書き込むよう TCustomDBGrid オブジェクトに通知します。


読み出し／書き込み3268025

読み出し専用


スコープ3268026

protected


継承3268027

TObject

TPersistent

TDataLink


TGridDataLink 例3268028

TGridDataLink


TGroupBox
TGroupBox3269001

継承	プロパティ	メソッド	イベント	参照	例

TGroupBox は Windows のグループボックスを作成します。

ユニット

stdctrls

説明

TGroupBox コンポーネントは Windows の標準グループボックスで，フォーム上の関連するコントロールのグループ化に使います。グループボックス内に別のコントロールコンポーネントを入れると，グループボックスはそのコントロールコンポーネントの親になります。


TGroupBox プロパティ3269002

TGroupBox	アルファベット順	凡例

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TGroupBox プロパティ3269003

TGroupBox	オブジェクト順	凡例

Align

BoundsRect

Brush

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TGroupBox イベント3269004

TGroupBox	アルファベット順	凡例

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TGroupBox イベント3269005

TGroupBox	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TGroupBox メソッド3269006

TGroupBox	アルファベット順

TCustomGroupBox からの継承

Create

TCustomControl からの継承

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TGroupBox メソッド3269007

TGroupBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


スコープ3269008

published

読み出し／書き込み

読み出し専用


スコープ3269009

published


継承3269010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomGroupBox


TGroupBox 例3269011

TGroupBox


TGraphicControl
TGraphicControl3270001

継承	プロパティ	メソッド	参照

TGraphicControl コンポーネントは，すべての非ウィンドウカスタムコントロールの基本クラスです。

ユニット

controls

説明

ほとんどのグラフィックコントロールの主要な目的は，テキストまたはグラフィックの表示です。TGraphicControl から派生する Delphi のコントロールには，TBevel，TImage，TPaintBox，TShape，TSpeedButton，TSplitter，TCustomLabel があり，さらに TCustomLabel からは TDBText と TLabel が派生します。

TGraphicControl は，TControl 抽象コンポーネントから継承されるすべての機能のほかに，コントロールの表面への描画を簡単に行うための Canvas プロパティと，親コントロールによって受け取られる WM_PAINT メッセージへの応答として呼び出される仮想 Paint メソッドも提供します。

グラフィックコントロールは入力フォーカスを受け取ったり，中に他のコントロールを入れたりすることはできません。グラフィックコントロールは Windows ハンドルを必要としないため，システムリソースは少なくて済み，ウィンドウコントロールの場合より速くペイントできます。

入力フォーカスを受け取ったり，中に他のコントロールを入れたりすることができ，Canvas プロパティと Paint メソッドを必要とするコントロールを作成するには，TCustomControl からクラスを派生させます。


TGraphicControl プロパティ3270002

TGraphicControl	アルファベット順	凡例

TGraphicControl

Canvas

TControl からの継承

Align

BoundsRect

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TGraphicControl プロパティ3270003

TGraphicControl	オブジェクト順	凡例

Align

BoundsRect

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Height

Hint

Left

Name

Owner

Parent

ShowHint

Tag

Top

VCLComObject

Visible

Width

WindowProc


TGraphicControl.Canvas
TGraphicControl.Canvas3270004

TGraphicControl	参照

Canvas プロパティは，グラフィックコントロールによって描画面として使われる TCanvas オブジェクトです。

property Canvas: TCanvas;

説明

TCanvas オブジェクトのプロパティは，コントロールの表面に描画またはペイントすることができます。キャンバスは，描画およびペイントに必要なすべてのツールとメソッドを提供します。

TGraphicControl はウィンドウハンドルを持たないため，Canvas でデバイスコンテキストのハンドルが必要なときは，コントロールの Parent のウィンドウから得たデバイスコンテキストを使用します。


TGraphicControl メソッド3270005

TGraphicControl	アルファベット順	凡例

TGraphicControl

Create

Destroy

Paint

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Invalidate

Perform

Refresh

Repaint

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TGraphicControl メソッド3270006

TGraphicControl	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DragDrop

Dragging

EndDrag

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTextBuf

GetTextLen

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Paint

Perform

Refresh

RemoveComponent

Repaint

SafeCallException

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update


TGraphicControl.Create
TGraphicControl.Create3270007

TGraphicControl	参照

Create メソッドは，TGraphicControl のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にグラフィックコントロールをインスタンス化および初期化することができます。設計時にフォームに配置したグラフィックコントロールは自動的に作成されます。

Create メソッドは継承されたコンストラクタを呼び出した後で Canvas プロパティ用の TCanvas オブジェクトを作成します。

ほとんどのコントロールは Create をオーバーライドし，そのコントロール独自のプロパティを初期化します。Create メソッドをオーバーライドする場合，継承したコンストラクタを先に呼び出してからコンポーネントを初期化しなくてはなりません。


TGraphicControl.Destroy
TGraphicControl.Destroy3270008

TGraphicControl	参照

Destroy メソッドは，TGraphicControl のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはグラフィックコントロールが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy メソッドを使うと，Create メソッドで割り当てられたすべてのメモリとリソースを解放できます。下位コントロール型で Destroy メソッドを宣言するときには必ず override 指令を追加し，継承された Destroy を再宣言したメソッドの最後の文として呼び出します。


TGraphicControl.Paint
TGraphicControl.Paint3270009

TGraphicControl	参照

Paint メソッドは，グラフィックコントロールのイメージを描画するメソッドへのインターフェースを提供します。

procedure Paint; virtual;

説明

グラフィックコントロールは，親から自身をペイントするように要求されるときに Parent から WM_PAINT メッセージを受け取ります。グラフィックコントロールは WM_PAINT メッセージへの応答としてコントロールのキャンバスを初期化し，Paint メソッドを呼び出します。コントロールのイメージの描画方法を指定するには，Paint メソッドをオーバーライドします。

TGraphicControl の Paint メソッドは，派生オブジェクトによってオーバーライドされるインターフェースを提供するだけのメソッドです。インスタンス化できるすべてのグラフィックコントロールは，コントロールのイメージを描画するために Paint をオーバーライドする必要があります。


スコープ3270010

protected

published

読み出し／書き込み

読み出し専用


スコープ3270011

protected


継承3270012

TObject

TPersistent

TComponent

TControl


TGraphicControl 例3270013

TGraphicControl


THandleObject
THandleObject3271001

継承	プロパティ	メソッド	参照

THandleObject は，ハンドルを使うすべてのスレッド同期オブジェクトの基本クラスです。

ユニット

syncobjs

説明

THandleObject は，マルチスレッドアプリケーションで異なるスレッドの実行を調整する場合にハンドルを使うオブジェクトを定義するときの基本クラスとして使います。ハンドルを取得する同期オブジェクトにはイベントオブジェクトがあります。イベントオブジェクトを使うと，スレッドからクリティカルイベントの発生を通知できます。

THandleObject のインスタンスは作成しないでください。THandleObject は，同期オブジェクトのハンドルを管理するためのプロパティを提供する基本クラスですが，ハンドルを取得する機能は提供しません。このため，THandleObject の派生オブジェクトは適切なハンドルを取得しなくてはなりません。


THandleObject プロパティ3271002

THandleObject	アルファベット順	凡例

THandleObject

Handle

LastError


THandleObject プロパティ3271003

THandleObject	オブジェクト順	凡例

Handle

LastError


THandleObject.Handle
THandleObject.Handle3271004

THandleObject	参照

Handle プロパティは，THandleObject が使う Windows オブジェクトのハンドルです。

THandle = Integer;

property Handle: THandle;

説明

Handle プロパティは，同期オブジェクトの Windows ハンドルを取得できます。Handle は，Windows API の呼び出しに同期オブジェクトへのハンドルが必要な場合に使います。

THandleObject は Handle プロパティを設定する機能を提供しません。THandleObject の派生オブジェクトが対応する Windows 同期オブジェクトのハンドルの Handle プロパティを設定します。


THandleObject.LastError
THandleObject.LastError3271005

THandleObject	参照

LastError プロパティは，Handle プロパティから取得した Windows のエラーコードです。

property LastError: Integer;

説明

LastError は，THandleObject の処理が失敗したときに読み出します。このプロパティは失敗の原因を表す Windows エラーコードを返します。処理が失敗しなかったときには，LastError は 0 になります。


THandleObject メソッド3271006

THandleObject	アルファベット順

THandleObject

Destroy

TSynchroObject からの継承

Acquire

Release

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THandleObject メソッド3271007

THandleObject	オブジェクト順

Acquire

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Release

SafeCallException


THandleObject.Destroy
THandleObject.Destroy3271008

THandleObject	参照

Destroy メソッドは，THandleObject のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは THandleObject オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy はハンドルを解放してからデフォルトのデストラクタを呼び出します。


読み出し／書き込み3271009

読み出し専用


継承3271010

TObject

TSynchroObject


THandleObject 例3271011

THandleObject


THeaderControl
THeaderControl3272001

継承	プロパティ	メソッド	イベント	参照

THeaderControl コンポーネントは THeaderSection オブジェクトのコンテナです。THeaderControl コンポーネントは，サイズ変更可能な列ヘッダーのセットを提供します。

ユニット

comctrls

説明

THeaderControl は，実行時にユーザーがサイズ変更できる列ヘッダーのセットです。個々のヘッダーは，Sections プロパティにリストされる THeaderSection オブジェクトです。

ヘッダーセクションは情報の列または項目の上に配置できます。たとえば，ヘッダーセクションをリストボックス（TListBox）の上に配置することも可能です。THeaderControl は他のほとんどすべてのビジュアルコンポーネントと組み合わせられる汎用ヘッダー要素を提供するので，実行時にヘッダーセクションに行った操作がヘッダーセクションの下のコンポーネントに自動的に適用されることはありません。たとえば，ヘッダーセクションのサイズを変更したらヘッダーセクションの下の列幅も自動的に変更されるようにする場合は，そのための OnSectionResize イベントハンドラを記述する必要があります。


THeaderControl プロパティ3272002

THeaderControl	アルファベット順	凡例

THeaderControl

Canvas

HotTrack

Sections

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


THeaderControl プロパティ3272003

THeaderControl	オブジェクト順	凡例

Align

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

Hint

HotTrack

Left

Name

Owner

Parent

ParentFont

ParentShowHint

ParentWindow

PopupMenu

Sections

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


THeaderControl.Canvas
THeaderControl.Canvas3272004

THeaderControl	参照

Canvas プロパティは，ヘッダーコントロールの描画表面に実行時にアクセスできるようにします。

property Canvas: TCanvas;

説明

読み出し専用のプロパティです。Canvas プロパティは，OnDrawSection イベント用ハンドラを実装するときに使うヘッダーコントロールの描画表面にアクセスできます。


THeaderControl.HotTrack
THeaderControl.HotTrack3272005

THeaderControl	参照

HotTrack プロパティは，マウスポインタが通ったヘッダーセクションを強調表示します。

property HotTrack: Boolean;

説明

HotTrack プロパティを True に設定すると，実行時に，マウスポインタが通ったヘッダーセクション上のテキストが強調表示されます。


THeaderControl.Sections
THeaderControl.Sections3272006

THeaderControl	参照	例

Sections プロパティは，ヘッダーセクション（列見出し）のリストです。

property Sections: THeaderSections;

説明

Sections プロパティは THeaderSections オブジェクト（THeaderSection オブジェクトのコレクション）を保持します。ヘッダーセクションの追加，削除，変更は，設計時にセクションエディタを使って行います。セクションエディタを表示するには，オブジェクトインスペクタで Sections プロパティを選択し，右側の Value 列をダブルクリックするか，省略記号（...）ボタンをクリックします。


THeaderControl イベント3272007

THeaderControl	アルファベット順	凡例

THeaderControl

OnDrawSection

OnResize

OnSectionClick

OnSectionResize

OnSectionTrack

TControl からの継承

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


THeaderControl イベント3272008

THeaderControl	オブジェクト順	凡例

OnDragDrop

OnDragOver

OnDrawSection

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnResize

OnSectionClick

OnSectionResize

OnSectionTrack

OnStartDrag


THeaderControl.OnDrawSection
THeaderControl.OnDrawSection3272009

THeaderControl	参照	例

OnDrawSection イベントは，ヘッダーセクションを再描画する必要があるときに発生します。

TDrawSectionEvent = procedure (HeaderControl: THeaderControl; Section: THeaderSection; const Rect: TRect; Pressed: Boolean) of object;

property OnDrawSection: TDrawSectionEvent;

説明

OnDrawSection イベントはヘッダーセクションを再表示する必要があるときに発生します。たとえば，ユーザーがセクションを選択するかサイズ変更したときに発生します。OnDrawSection イベントはヘッダーセクションの Style プロパティが hsOwnerDraw に設定されているときにだけ発生します。

TDrawSectionEvent は OnDrawSection プロパティの型です。


THeaderControl.OnResize
THeaderControl.OnResize3272010

THeaderControl	参照

OnResize イベントは，ヘッダーコントロールをサイズ変更したときに発生します。

property OnResize: TNotifyEvent;

説明

OnResize イベントは実行時にヘッダーコントロールのサイズが変更されると発生します。


THeaderControl.OnSectionClick
THeaderControl.OnSectionClick3272011

THeaderControl	参照

OnSectionClick イベントは，ヘッダーコントロールのセクションのいずれかをクリックしたときに発生します。

TSectionNotifyEvent = procedure(HeaderControl: THeaderControl; Section: THeaderSection) of object;

property OnSectionClick: TSectionNotifyEvent;

説明

OnSectionClick イベントは実行時にヘッダーセクションがクリックされると発生します。ヘッダーセクションをクリックできないようにするには，ヘッダーセクションの AllowClick プロパティを False に設定します。

TSectionNotifyEvent は，OnSectionClick イベントと OnSectionResize イベントの型です。


THeaderControl.OnSectionResize
THeaderControl.OnSectionResize3272012

THeaderControl	参照

OnSectionResize イベントは，ヘッダーコントロールのセクションのいずれかをサイズ変更したときに発生します。

TSectionNotifyEvent = procedure(HeaderControl: THeaderControl; Section: THeaderSection) of object;

property OnSectionResize: TSectionNotifyEvent;

説明

OnSectionResize イベントは実行時にヘッダーセクションのサイズが変更されると発生します。ユーザーがマウスポインタを 2 つのセクションの間に置いて境界線を右か左にドラッグしたときに発生します。

TSectionNotifyEvent は OnSectionClick イベントと OnSectionResize イベントの型です。


THeaderControl.OnSectionTrack
THeaderControl.OnSectionTrack3272013

THeaderControl	参照

OnSectionTrack イベントは，ヘッダーコントロールのセクションのいずれかをサイズ変更しているときに発生します。

TSectionTrackState = (tsTrackBegin, tsTrackMove, tsTrackEnd);

TSectionTrackEvent = procedure(HeaderControl: THeaderControl; Section: THeaderSection; Width: Integer; State: TSectionTrackState) of object;

property OnSectionTrack: TSectionTrackEvent;

説明

OnSectionTrack イベントはヘッダーセクションの境界線のドラッグをトラッキングします。OnSectionTrack イベントは，マウスポインタを 2 つのヘッダーセクションの間に置いてマウスの左ボタンを押したときに発生します。

OnSectionTrack イベントは TSectionTrackEvent 型で，Width パラメータおよび State パラメータはヘッダーセクションのサイズ（ピクセル単位）とイベントの状態をそれぞれ示します。State パラメータが示す状態には次の 3 つがあります。

値	意味

tsTrackBegin	境界線はまだドラッグされていない

tsTrackMove	境界線をドラッグ中である

tsTrackEnd	境界線はもうドラッグされていない

OnSectionTrack はヘッダーセクションのサイズ変更中に任意の処理を行いたい場合に使います。


THeaderControl メソッド3272014

THeaderControl	アルファベット順

THeaderControl

Create

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


THeaderControl メソッド3272015

THeaderControl	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


THeaderControl.Create
THeaderControl.Create3272016

THeaderControl	参照

Create メソッドは，THeaderControl コンポーネントを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは，ヘッダーコントロールとそのキャンバスおよびヘッダーセクションを作成します。


THeaderControl.Destroy
THeaderControl.Destroy3272017

THeaderControl	参照

Destroy メソッドは，THeaderControl を破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

Destroy メソッドは，ヘッダーコントロールとそのキャンバスおよびヘッダーセクションを破棄します。


スコープ3272018

published

読み出し／書き込み

読み出し専用


スコープ3272019

published


継承3272020

TObject

TPersistent

TComponent

TControl

TWinControl


THeaderControl 例3272021

THeaderControl


THeaderSection
THeaderSection3273001

継承	プロパティ	メソッド	参照

THeaderSection オブジェクトはヘッダーコントロールのセクションです。

ユニット

comctrls

説明

各 THeaderControl オブジェクトは，THeaderSections を使って THeaderSection オブジェクトのコレクションを保持します。


THeaderSection プロパティ3273002

THeaderSection	アルファベット順	凡例

THeaderSection

Alignment

AllowClick

Left

MaxWidth

MinWidth

Right

Style

Text

Width

TCollectionItem からの継承

Collection

DisplayName

ID

Index


THeaderSection プロパティ3273003

THeaderSection	オブジェクト順	凡例

Alignment

AllowClick

Collection

DisplayName

ID

Index

Left

MaxWidth

MinWidth

Right

Style

Text

Width


THeaderSection.Alignment
THeaderSection.Alignment3273004

THeaderSection	参照

Alignment プロパティは，ヘッダーセクション内でどのようにテキストを揃えるかを指定します。

property Alignment: TAlignment;

説明

以下に Alignment プロパティの値を示します。

値	意味

taLeftJustify	テキストをヘッダーセクションの左端で揃える

taCenter	テキストをヘッダーセクションの中央で揃える

taRightJustify	テキストをヘッダーセクションの右端で揃える


THeaderSection.AllowClick
THeaderSection.AllowClick3273005

THeaderSection	参照

AllowClick プロパティは，実行時にセクションをクリックできるようにします。

property AllowClick: Boolean;

説明

AllowClick プロパティを True（デフォルト）に設定すると，実行時にヘッダーセクションをマウスでクリックできるようになります。クリックしたヘッダーセクションは押されたボタンのように見えます。クリックしたときに発生するイベントに機能を付加するには，ヘッダーコントロールの OnSectionClick イベントのイベントハンドラを記述します。


THeaderSection.Left
THeaderSection.Left3273006

THeaderSection	参照

Left プロパティは，ヘッダーセクションの左端の水平方向の位置を指定します。

property Left: Integer;

説明

Left プロパティはヘッダーセクションの左端の水平座標であり，ヘッダーコントロールの左の境界に対する相対距離をピクセル数で示します。


THeaderSection.MaxWidth
THeaderSection.MaxWidth3273007

THeaderSection	参照

MaxWidth プロパティは，ヘッダーセクションの最大幅を指定します。

property MaxWidth: Integer;

説明

ヘッダーセクションの最大幅をピクセル単位で設定します。MaxWidth = MinWidth の場合は，実行時にヘッダーセクションのサイズを変更することはできません。


THeaderSection.MinWidth
THeaderSection.MinWidth3273008

THeaderSection	参照

MinWidth プロパティは，ヘッダーセクションの最小幅を指定します。

property MinWidth: Integer;

説明

ヘッダーセクションの最小幅をピクセル単位で設定します。MinWidth = MaxWidth の場合は，実行時にヘッダーセクションのサイズを変更することはできません。


THeaderSection.Right
THeaderSection.Right3273009

THeaderSection	参照

Right プロパティは，ヘッダーセクションの右端の水平方向の位置を指定します。

property Right: Integer;

説明

Right プロパティはヘッダーセクションの右端の水平座標であり，ヘッダーコントロールの左の境界に対する相対距離をピクセル数で示します。Right プロパティは Left プロパティの値に Width プロパティの値を加算した値になります。


THeaderSection.Style
THeaderSection.Style3273010

THeaderSection	参照

Style プロパティは，ヘッダーセクションのテキストをどのように表示するかを決めます。

property Style: THeaderSectionStyle;

説明

Style プロパティを hsText（デフォルト）に設定すると，ヘッダーセクションに Text プロパティで指定した文字列が Alignment プロパティで指定した位置合わせを使って表示されます。フォントはヘッダーコントロールの Font プロパティで指定します。

Style プロパティを hsOwnerDraw に設定すると，ヘッダーセクションに表示される内容は，実行時に THeaderControl.OnDrawSection イベントハンドラのコードに従ってヘッダーコントロールのキャンバスに描画されます。


THeaderSection.Text
THeaderSection.Text3273011

THeaderSection	参照

Text プロパティは，ヘッダーセクションのキャプションを指定します。

property Text: string;

Text プロパティは，ヘッダーセクションまたはその下の列を識別するための文字列を保持します。Style プロパティを hsText に設定すると，Text プロパティの値がヘッダーセクションに表示されます。


THeaderSection.Width
THeaderSection.Width3273012

THeaderSection	参照

Width プロパティは，ヘッダーセクションの幅を指定します。

property Width: Integer;

説明

Width プロパティは，ヘッダーセクションの幅のデフォルト値をピクセル単位で設定します。ヘッダーセクションのサイズは，実行時に境界をドラッグすると変更できます。


THeaderSection メソッド3273013

THeaderSection	アルファベット順

THeaderSection

Assign

Create

TCollectionItem からの継承

Destroy

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THeaderSection メソッド3273014

THeaderSection	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THeaderSection.Assign
THeaderSection.Assign3273015

THeaderSection	参照

Assign メソッドは，ソースヘッダーセクションの内容を新しいヘッダーセクションにコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドは，ソースオブジェクトと同じ Alignment，AllowClick，MaxWidth，MinWidth，Style，Text，および Width の値を使って新しいヘッダーセクションを作成します。


THeaderSection.Create
THeaderSection.Create3273016

THeaderSection	参照

Create メソッドは，ヘッダーセクションを作成し，初期化します。

constructor Create(Collection: TCollection); override;

説明

Create メソッドは，THeaderSections インスタンスを引数に必要とします。


スコープ3273017

published

読み出し／書き込み

読み出し専用


継承3273018

TObject

TPersistent

TCollectionItem


THeaderSection 例3273019

THeaderSection


THeaderSections
THeaderSections3274001

継承	プロパティ	メソッド	参照

THeaderSections オブジェクトは THeaderSection オブジェクトのコンテナです。

ユニット

comctrls

説明

各 THeaderSections オブジェクトは THeaderControl コンポーネントの THeaderSection オブジェクトのコレクションを保持します。THeaderSections は Items 配列にあるヘッダーセクションのインデックスを保持します。Count プロパティには，THeaderSections のコレクションに保持されているヘッダーセクションの数が入ります。設計時には，ヘッダーコントロールのセクションエディタを使ってセクションを追加，削除，または変更します。


THeaderSections プロパティ3274002

THeaderSections	アルファベット順	凡例

THeaderSections

Items

TCollection からの継承

Count

ItemClass


THeaderSections プロパティ3274003

THeaderSections	オブジェクト順	凡例

Count

ItemClass

Items


THeaderSections.Items
THeaderSections.Items3274004

THeaderSections	参照

THeaderSections のコレクションに保持しているヘッダーセクションのインデックスを表します。

property Items[Index: Integer]: THeaderSection;

説明

Index パラメータの値は THeaderSection オブジェクトの Index プロパティに対応します。この値はヘッダーにおけるセクションの位置を表します。


THeaderSections メソッド3274005

THeaderSections	アルファベット順

TheaderSections

Add

Create

TCollection からの継承

Assign

BeginUpdate

Clear

Destroy

EndUpdate

FindItemID

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THeaderSections メソッド3274006

THeaderSections	オブジェクト順

Add

Assign

BeginUpdate

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

EndUpdate

FieldAddress

FindItemID

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THeaderSections.Add
THeaderSections.Add3274007

THeaderSections	参照

Add メソッドは，rSection インスタンスを作成して Items 配列に追加します。

function Add: THeaderSection;

説明

Add メソッドは新しいヘッダーセクションを返します。設計時には，ヘッダーコントロールのセクションエディタを使ってヘッダーにセクションを追加します。


THeaderSections.Create
THeaderSections.Create3274008

THeaderSections	参照

Create メソッドは，オブジェクトを作成して初期化します。

constructor Create(HeaderControl: THeaderControl);

説明

Create メソッドは，引数に THeaderControl インスタンスをとります。


読み出し／書き込み3274009

読み出し専用


継承3274010

TObject

TPersistent

TCollection


THeaderSections 例3274011

THeaderSections


THintWindow
THintWindow3275001

継承	プロパティ	メソッド	参照

THintWindow コンポーネントは，ShowHint プロパティが True に設定されているコントロールの上に実行時に表示される小さなポップアップウィンドウを実現します。

ユニット

controls

説明

THintWindow コンポーネントを使うと，アプリケーションから直接ヘルプヒントポップアップウィンドウを表示できます。THintWindow をオーバーライドすると，ShowHint プロパティが True に設定されているコントロールに自動的に表示されるウィンドウをカスタマイズできます。THintWindow をオーバーライドして新しい派生型を作成した後で，新しいヒントウィンドウ型がヘルプヒントに使えるように，アプリケーションの起動時にその新しい型をグローバル HintWindowClass 変数に代入します。


THintWindow プロパティ3275002

THintWindow	アルファベット順	凡例

TCustomControl からの継承

Canvas

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


THintWindow プロパティ3275003

THintWindow	オブジェクト順	凡例

Align

BoundsRect

Brush

Canvas

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentWindow

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


THintWindow メソッド3275004

THintWindow	アルファベット順

THintWindow

ActivateHint

ActivateHintData

CalcHintRect

Create

IsHintMsg

ReleaseHandle

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

TCustomComponent からの継承

Destroy


THintWindow メソッド3275005

THintWindow	オブジェクト順

ActivateHint

ActivateHintData

Assign

BeginDrag

BringToFront

Broadcast

CalcHintRect

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

IsHintMsg

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

ReleaseHandle

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


THintWindow.ActivateHint
THintWindow.ActivateHint3275006

THintWindow	参照

ActivateHint メソッドは，ヒントウィンドウを表示します。

procedure ActivateHint(Rect: TRect; const AHint: string); virtual;

説明

ActivateHint メソッドを呼び出すと，Rect パラメータで指定した座標にヒントウィンドウを表示できます。Rect パラメータが画面の外の値の場合，ActivateHint はヒントウィンドウを Rect で指定した座標に最も近く，画面に全体が表示される位置に移動します。ActivateHint は，AHint 文字列がユーザーに表示されるように，ウィンドウを表示する前に，Caption プロパティを AHint パラメータに設定します。

ヒントウィンドウを表示した後で，一定時間経過するか，またはヒントメッセージを隠すことを要求するメッセージを受け取ると，アプリケーションは自動的にヒントウィンドウを隠します。アプリケーションによって自動的に表示されたヒントウィンドウを隠すには，グローバル Application オブジェクトの HideHint メソッドを使います。ActivateHint を呼び出して直接アクティブ化したヒントウィンドウを隠すには，ReleaseHandle メソッドを使います。


THintWindow.ActivateHintData
THintWindow.ActivateHintData3275007

THintWindow	参照

ActivateHintData メソッドは，指定されたデータ値を使ってヒントウィンドウを表示します。

procedure ActivateHintData(Rect: TRect; const AHint: string; AData: Pointer); virtual;

説明

ActivateHintData メソッドを呼び出すと，Rect パラメータで指定した座標にヒントウィンドウを表示できます。THintWindow の ActivateHintData メソッドは，Caption プロパティを AHint パラメータに設定し，AData パラメータを無視します。下位クラスはこのメソッドをオーバーライドして，AHint パラメータと AData パラメータとをカスタム Hint 値に結合することができます。

ヒントウィンドウを表示した後で，一定時間経過するか，またはヒントメッセージを隠すことを要求するメッセージを受け取ると，アプリケーションは自動的にヒントウィンドウを隠します。アプリケーションによって自動的に表示されたヒントウィンドウを隠すには，グローバル Application オブジェクトの HideHint メソッドを使います。ActivateHint を呼び出して直接アクティブ化したヒントウィンドウを隠すには，ReleaseHandle メソッドを使います。


THintWindow.CalcHintRect
THintWindow.CalcHintRect3275008

THintWindow	参照

CalcHintRect メソッドは，指定されたヒント表示するのに必要なサイズを返します。

function CalcHintRect(MaxWidth: Integer; const AHint: string; AData: Pointer): TRect; virtual;

説明

CalcHintRect メソッドを呼び出すと，AHint および AData パラメータに指定した文字列およびデータのヒントウィンドウを表示するのに必要なサイズを判定できます。MaxWidth パラメータはテキストが次の行に送られるときの Hint ウィンドウの幅を指定します。


THintWindow.Create
THintWindow.Create3275009

THintWindow	参照

Create メソッドは，THintWindow のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にヒントウィンドウをインスタンス化できます。コントロールの ShowHint プロパティに応答してアプリケーションによってアクティブ化されたヒントウィンドウは自動的に作成されます。


THintWindow.IsHintMsg
THintWindow.IsHintMsg3275010

THintWindow	参照

IsHintMsg メソッドは，アプリケーションメッセージがヒントウィンドウを隠すことを要求するかどうかを判別します。

function IsHintMsg(var Msg: TMsg): Boolean; virtual;

説明

IsHintMsg メソッドを呼び出すと，Msg パラメータで指定したメッセージがヒントウィンドウを隠すことを要求するかどうかを判別できます。IsHintMsg はマウス，キーボード，コマンド，アクティブ化のいずれかのメッセージを検出すると True を返します。グローバル Application オブジェクトは，ヒントウィンドウが画面に表示されている間に IsHintMsg メソッドを呼び出してメッセージをチェックし，IsHintMsg が True を返すとウィンドウを隠します。


THintWindow.ReleaseHandle
THintWindow.ReleaseHandle3275011

THintWindow	参照

ReleaseHandle メソッドは，THintWindow によって表示されるウィンドウを破棄します。

procedure ReleaseHandle;

説明

ReleaseHandle メソッドを呼び出すと，直接 ActivateHint メソッドを呼び出してアクティブ化したヒントウィンドウを破棄できます。アプリケーションオブジェクトによって自動的にアクティブ化されたヒントウィンドウは，そのアプリケーションによって非アクティブ化されます。


スコープ3275012

published

読み出し／書き込み

読み出し専用


継承3275013

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl


THintWindow 例3275014

THintWindow


THandleStream
THandleStream3276001

継承	プロパティ	メソッド	参照

THandleStream は，Windows ハンドルが識別する通信リソースに対してアプリケーションが読み書きできるようにするストリームオブジェクトです。

ユニット

classes

説明

THandleStream は，Windows ハンドルを提供するファイル，ソケット，名前を指定したパイプ，メールスロットや，ほかの通信リソースにアクセスできます。たとえば FileOpen 関数はディスク上のファイルに Windows ハンドルを提供します。THandleStream では，アプリケーションが Windows ハンドルを使って入出力を実行する際に統一的なストリームインターフェースを使えるようにします。

ファイルハンドル管理のオーバーヘッドを避けるには，TFileStream を使ってディスクファイルを扱います。


THandleStream のプロパティ3276002

THandleStream	アルファベット順	凡例

THandleStream

Handle

Size

TStream からの継承

Position


THandleStream のプロパティ3276003

THandleStream	オブジェクト順	凡例

Handle

Position

Size


THandleStream.Handle
THandleStream.Handle3276004

THandleStream	参照

Handle プロパティは，ストリームが読み書きする通信リソースのハンドルを示します。

property Handle: Integer;

説明

Handle を読み出すと，Windows API 呼び出しやファイル管理関数のハンドルを取得できます。リソースに対して読み書きを行うには，THandleStream オブジェクトのメソッドを使います。

Handle は読み出し専用プロパティです。このハンドルプロパティは，ハンドルストリームに読み書きの切り替えを行わせるために変更できません。たとえば読み出し専用モードで開いたファイルハンドルを書き込みモードで開いたものに変更する手順は以下のとおりです。

1.	ストリームオブジェクトを解放します。

2.	FileClose を呼び出してファイルを閉じます。

3.	ファイルを書き込みモードで再び開き，ハンドルを使ってハンドルストリームの新しいインスタンスを作成します。この場合，ファイルの TFileStream オブジェクトを開いて，ストリームの書き込みモードを指定してもかまいません。

注意

THandleStream オブジェクトの破棄後まで，Handle についての FileClose 関数を呼び出さないでください。


THandleStream.Size
THandleStream.Size3276005

THandleStream	参照

Size プロパティは，Handle プロパティが識別するリソースのバイト長を示します。

property Size: Longint;

説明

Size プロパティは，リソースのバイト数を示します。Size を設定して，リソースの情報を切り捨てます。THandleStream オブジェクトを使ってアクセス可能な通信リソースのすべてが Size プロパティをサポートできるわけではありません。たとえば，Size プロパティは名前を指定したパイプと一緒に使わないでください。


THandleStream のメソッド3276006

THandleStream	アルファベット順	凡例

THandleStream

Create

Read

Seek

SetSize

Write

TStream からの継承

CopyFrom

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THandleStream のメソッド3276007

THandleStream	オブジェクト順	凡例

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

CopyFrom

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadBuffer

ReadComponentRes

ReadComponent

ReadResHeader

Read

SafeCallException

Seek

SetSize

WriteBuffer

WriteComponentRes

WriteComponent

WriteDescendentRes

WriteDescendent

Write


THandleStream.Create
THandleStream.Create3276008

THandleStream	参照

Create メソッドは，ThandleStream のインスタンスを作成します。

constructor Create(AHandle: Integer);

説明

Create メソッドを呼び出すと，指定したハンドル用の THandleStream のインスタンスを作成できます。このハンドルを取得するには，適切なモードでリソースを開くか作成しなければなりません。たとえばファイルから読み出すためのハンドルストリームを作成するには，fmOpenRead モードか fmOpenReadWrite モードでファイルを開いてファイルハンドルを取得します。ファイルに書き込むためのハンドルストリームを作成するには，fmOpenWrite モードか fmOpenReadWrite モードでファイルを開いてファイルハンドルを取得します。


THandleStream.Read
THandleStream.Read3276009

THandleStream	参照

Read メソッドは，Count バイトまでのデータをハンドルストリームに関連付けられたリソースから Buffer へ読み出します。

function Read(var Buffer; Count: Longint): Longint; override;

説明

Read メソッドを呼び出すと，ファイル中のバイト数がわからないときに，ハンドルストリームに関連付けられたリソースからデータを読み出せます。Read は，現在の位置から Count バイトまでをリソースから転送し，現在の位置を実際に転送したバイト数だけリソース内で前進させます。Read は実際に転送されたバイト数を返します。ただし，ファイル終了マーカーが検出された場合，その数値は Count より小さくなることがあります。

ハンドルストリームのほかのすべてのデータ読み出しメソッド（ReadBuffer，ReadComponent）は，実際の読み出しを行うために Read を呼び出します。


THandleStream.Seek
THandleStream.Seek3276010

THandleStream	参照

Seek メソッドは，ハンドルストリームの現在の位置をリセットします。

function Seek(Offset: Longint; Origin: Word): Longint; override;

説明

Seek メソッドを呼び出すと，ハンドルストリームに関連付けられたリソース内の現在の位置を指示されたオフセット分だけ移動できます。Seek メソッドでは，アプリケーションにリソース内の特定位置での読み書きを実行させることができます。

Origin パラメータは，Offset パラメータの解釈方法を示します。以下に Origin の値を示します。

値	意味

soFromBeginning	Offset の起点はリソースの先頭。Seek は Offset の位置まで移動する。Offset の値は >= 0 でなければならない

soFromCurrent	Offset の起点はリソース内の現在の位置。Seek は Position + Offset に移動する

soFromEnd	Offset の起点はリソースの末尾。Offset は <= 0 で，ファイル末尾からのバイト数をマイナスで示す

Seek は Position プロパティの新しい値，つまりリソース内の新しい現在の位置を返します。


THandleStream.SetSize
THandleStream.SetSize3276011

THandleStream	参照

SetSize メソッドは，示された位置でリソースを切り捨てるようにファイル終了マーカーを設定します。

procedure SetSize(NewSize: Longint); override;

説明

SetSize メソッドを呼び出すと，リソースのサイズを設定できます。Size はハンドルが識別するリソースのサイズを変更できるように，継承メソッドをオーバーライドします。SetSize は示された位置にジャンプするように Seek を呼び出し，その後にファイル終了マーカーを書き込みます。リソースのサイズを変更できないときは，例外が発生します。たとえば fmOpenRead モードで開いたファイルハンドルの SetSize を呼び出すと，例外が発生します。


THandleStream.Write
THandleStream.Write3276012

THandleStream	参照

Write メソッドは，Buffer からリソース内の現在の位置に Count バイトを書き込みます。

function Write(const Buffer; Count: Longint): Longint; override;

説明

Write メソッドを呼び出すと，ハンドルストリームに関連付けられたリソースに現在の位置を起点として Count バイトを書き込むことができます。リソースへの書き込み後は，Write は書き込んだバイト数だけ現在の位置を前進させて，書き込んだバイト数を返します。

ハンドルストリームのほかのすべてのデータ書き込みメソッド（WriteBuffer，WriteComponent）は，実際の書き込みを行うために Write を呼び出します。


アクセス種別3276013

読み出し専用


スコープ3276014

protected


継承3276015

TObject

TStream


THandleStream の例3276016

THandleStream


THotKey
THotKey3277001

継承	プロパティ	メソッド	イベント

THotKey コンポーネントは，ホットキー Windows コモンコントロールのラッパーです。

ユニット

comctrls

説明

THotKey コンポーネントは，TCustomHotKey で導入されている汎用動作を実装しています。THotKey コンポーネントは TCustomHotKey から多くのプロパティを継承していますが，新しい動作は導入していません。

THotKey コンポーネントを使うと，ショートカットとして使うことのできるキーの組み合わせを作成できます。


THotKey プロパティ3277002

THotKey	アルファベット順	凡例

TCustomHotKey からの継承

AutoSize

HotKey

InvalidKeys

Modifiers

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


THotKey プロパティ3277003

THotKey	オブジェクト順	凡例

Align

AutoSize

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

HotKey

InvalidKeys

Left

Modifiers

Name

Owner

Parent

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


THotKey イベント3277004

THotKey	アルファベット順

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnMouseDown

OnMouseMove

OnMouseUp


THotKey イベント3277005

THotKey	オブジェクト順

OnEnter

OnExit

OnMouseDown

OnMouseMove

OnMouseUp


THotKey メソッド3277006

THotKey	アルファベット順

TCustomHotKey からの継承

Create

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


THotKey メソッド3277007

THotKey	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


スコープ3277008

published

読み出し／書き込み

読み出し専用


継承3277010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomHotKey


THotKey 例3277011

THotKey


TIconOptions
TIconOptions3278001

継承	プロパティ	メソッド	参照

TIconOptions オブジェクトはリストビュー内でどのようにアイコンを配置するかを表します。

ユニット

comctrls

説明

TIconOptions は，ViewStyle が vsIcon または vsSmallIcon に設定されているリストビューオブジェクトに使います。リストビューが所有しているアイコンオプションオブジェクトのプロパティを設定して，リストビュー内でどのようにアイコンを配置するかを指定します。

リストビューオブジェクトが TIconOptions オブジェクトを所有していない場合には，TIconOptions のプロパティは無効です。

注意

関連しているリストビューの ViewStyle が vsIcon または vsSmallIcon でない場合には，TIconOptions を指定しても効果はありません。


TIconOptions プロパティ3278002

TIconOptions	アルファベット順

TIconOptions

Arrangement

AutoArrange

WrapText


TIconOptions プロパティ3278003

TIconOptions	オブジェクト順

Arrangement

AutoArrange

WrapText


TIconOptions.Arrangement
TIconOptions.Arrangement3278004

TIconOptions	参照

Arrangement プロパティは，項目をリストビューのどこに合わせるかを指定します。

property Arrangement: TIconArrangement;

説明

Arrangement を設定すると，リストビュー内でアイコンエントリを横と縦のどちらの方向に並べて表示するかを指定できます。ViewStyle が vsIcon または vsSmallIcon でない場合には，リストビュー内のエントリの配置は変わりません。以下に Arrangement の値を示します。

値	意味

iaTop	項目を，リストビューコントロールの最上行に左から右へ並べる

iaLeft	項目を，リストビューコントロールの左端の列に上から下へ並べる


TIconOptions.AutoArrange
TIconOptions.AutoArrange3278005

TIconOptions	参照

AutoArrange プロパティは，リスト項目の追加，削除，移動を行うときに，リストビュー内でアイコンが自動的に整列されるかどうかを指定します。

property AutoArrange: Boolean;

説明

AutoArrange を設定すると，リスト内の項目に変更があったときにリストビューオブジェクトが項目を整列しなおすかどうかを指定できます。AutoArrange が True の場合には，アイコンは自動的に整列されます。AutoArrange が False の場合には，リストビューの Arrange メソッドが呼び出されるまでアイコンは整列されません。


TIconOptions.WrapText
TIconOptions.WrapText3278006

TIconOptions	参照

WrapText プロパティは，リストビュー内のアイコンのキャプションをすべて 1 行で表示するかラップするかを指定します。

property WrapText: Boolean;

説明

WrapText を True に設定すると，アイコンのキャプションがアイコンの幅を超える場合に，次の行以降に折り返されて表示されます。


TIconOptions メソッド3278007

TIconOptions	アルファベット順

TIconOptions

Create

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIconOptions メソッド3278008

TIconOptions	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIconOptions.Create
TIconOptions.Create3278009

TIconOptions	参照

Create メソッドは，TIconOptions のインスタンスを作成します。

constructor Create(AOwner: TCustomListView);

説明

アプリケーションで直接 Create メソッドを呼び出さないでください。TIconOptions のプロパティは，リストビューオブジェクトが TIconOptions を所有している場合にのみ有効です。リストビューオブジェクトは，アイコンビューの配置プロパティを表す TIconOption オブジェクトをインスタンス化します。

Create は継承されたコンストラクタを呼び出した後，以下のようにプロパティを初期化します。

・	Arrangement は iaTop

・	AutoArrange は False

・	WrapText は True


継承3278011

TObject

TPersistent


TIconOptions 例3278012

TIconOptions


TIcon
TIcon3279001

継承	プロパティ	メソッド	イベント	参照

TIcon は Windows アイコンがカプセル化されたものです。

ユニット

graphics

説明

TIcon を使ってイメージリストにあるアイコンの 1 つを表します。Icon プロパティを持つオブジェクト（TForm や TPicture など）にアイコンを割り当てます。

アイコンオブジェクトは，Windows アイコンファイル（.ICO ファイル）からロードされた値を表します。TCanvas オブジェクトの Draw メソッドを使ってキャンバスにアイコンを描画します。アイコンは伸張しないので，アイコンに対して TCanvas.StretchDraw は使わないでください。


TIcon プロパティ3279002

TIcon	アルファベット順	凡例

TIcon

Empty

Handle

Height

Width

TGraphic からの継承

Modified

Palette

PaletteModified

Transparent


TIcon プロパティ3279003

TIcon	オブジェクト順	凡例

Empty

Handle

Height

Modified

Palette

PaletteModified

Transparent

Width


TIcon.Empty
TIcon.Empty3279004

TIcon	参照

Empty プロパティは，アイコンオブジェクトがアイコンを含んでいるかどうかを示します。

property Empty: Boolean;

説明

Empty プロパティが True の場合，アイコンオブジェクトにアイコンはロードされていません。Empty プロパティが False の場合，アイコンオブジェクトはアイコンを含んでいます。


TIcon.Handle
TIcon.Handle3279005

TIcon	参照

Handle プロパティは，Windows GDI アイコンハンドルへのアクセスを提供します。

property Handle: HIcon;

説明

アイコンオブジェクトのハンドルが必要な Windows API 関数を使う場合には，Handle プロパティを使ってアイコンを指定します。アイコンがロードされていない場合の Handle プロパティの値は nil です。

Handle プロパティを設定してアイコンイメージを変更する場合は，その前に ReleaseHandle メソッドを呼び出します。他のアイコンオブジェクトを割り当てたり，LoadFromClipboardFormat，LoadFromFile，または LoadFromStream メソッドを使ってアイコンイメージをロードすることもできます。


TIcon.Height
TIcon.Height3279006

TIcon	参照

Height プロパティはアイコンの縦方向のサイズをピクセル単位で示します。

property Height: Integer;

説明

アプリケーションのすべてのアイコンは，Windows で決められている同じ高さを持ちます。Height プロパティを読み出すとこの共通の高さがわかります。

Height プロパティを設定しようとすると例外が発生します。


TIcon.Width
TIcon.Width3279007

TIcon	参照

Width プロパティはアイコンの横方向のサイズをピクセル単位で示します。

property Width: Integer;

説明

アプリケーションのすべてのアイコンは，Windows で決められている同じ幅を持ちます。Width プロパティを読み出すとこの共通の幅がわかります。

Width プロパティを設定しようとすると例外が発生します。


TIcon イベント3279008

TIcon	アルファベット順

Tgraphic からの継承

Onchange

OnProgress


TIcon イベント3279009

TIcon	オブジェクト順

Onchange

OnProgress


TIcon メソッド3279010

TIcon	アルファベット順

TIcon

Assign

Create

Destroy

LoadFromStream

ReleaseHandle

SaveToStream

TGraphic からの継承

LoadFromClipboardFormat

LoadFromFile

SaveToClipboardFormat

SaveToFile

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIcon メソッド3279011

TIcon	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LoadFromClipboardFormat

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

ReleaseHandle

SafeCallException

SaveToClipboardFormat

SaveToFile

SaveToStream


TIcon.Assign
TIcon.Assign3279012

TIcon	参照

Assign メソッドは，他の TIcon オブジェクトからアイコンイメージをコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドを呼び出して他のアイコンオブジェクトをコピーします。Assign メソッドは，Source パラメータが他の TIcon オブジェクトを指定している場合にそのオブジェクトからアイコンイメージをコピーします。それ以外の場合，Assign メソッドは継承メソッドを呼び出して，AssignTo メソッドで TIcon へのコピーの方法を指定するソースオブジェクトからアイコンイメージをコピーします。


TIcon.Create
TIcon.Create3279013

TIcon	参照

Create メソッドは，TIcon のインスタンスを作成します。

constructor Create; override;

説明

Create メソッドを呼び出して空のアイコンオブジェクトを作成します。ファイルまたはストリームからイメージがアイコンに読み出されるか，他のアイコンオブジェクトが割り当てられると，そのアイコンはキャンバスに描画されるか，またはイメージリストに追加されます。フォームまたは画像のアイコンプロパティを設定するためにアイコンオブジェクトを作成しないでください。これらのオブジェクトでは独自のコンストラクタが TIcon オブジェクトを作成します。そのかわりに，Icon プロパティを読み出したときに返される TIcon オブジェクトで LoadFromFile，LoadFromStream，または LoadFromClipboardFormat メソッドを使ってください。


TIcon.Destroy
TIcon.Destroy3279014

TIcon	参照

Destroy メソッドは，TIcon のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TIcon オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは Windows アイコンハンドルを解放してからオブジェクトを解放します。


TIcon.LoadFromStream
TIcon.LoadFromStream3279015

TIcon	参照

LoadFromStream メソッドは，ストリームからアイコンをロードします。

procedure LoadFromStream(Stream: TStream);

説明

LoadFromStream メソッドは，ストリームからアイコンイメージを読み出します。Stream パラメータには，アイコンのメモリイメージへのアクセスを提供するストリームオブジェクトを指定します。.ICO ファイルからアイコンをロードするには LoadFromFile メソッドを使います。クリップボードからアイコンをロードするには LoadFromClipboardFormat メソッドを使います。


TIcon.ReleaseHandle
TIcon.ReleaseHandle3279016

TIcon	参照

ReleaseHandle メソッドは，アイコンが表している Windows GDI オブジェクトを解放します。

function ReleaseHandle: HIcon;

説明

ReleaseHandle メソッドを呼び出して，アイコンが使用しているリソースを解放します。ReleaseHandle メソッドは Handle プロパティを nil に設定します。

ReleaseHandle メソッドは，アイコンハンドルを破棄する必要はないことを TIcon インスタンスに通知します。


TIcon.SaveToStream
TIcon.SaveToStream3279017

TIcon	参照

SaveToStream メソッドはアイコンをストリームに保存します。

procedure SaveToStream(Stream: TStream);

説明

SaveToStream メソッドを使ってアイコンイメージをストリームに書き込みます。Stream パラメータには，アイコンのメモリイメージを受け取るストリームオブジェクトを指定します。アイコンを .ICO ファイルに書き込むには SaveToFile メソッドを使います。アイコンをクリップボードに書き込むには SaveToClipboardFormat メソッドを使います。


読み出し／書き込み3279018

読み出し専用


継承3279019

TObject

TPersistent

TGraphic


TIcon 例3279020

TIcon


TIconImage
TIconImage3280001

継承	メソッド	参照

TIconImage は，TIcon オブジェクトのビットマップイメージを内部的に表現したオブジェクトです。

ユニット

graphics

説明

TIconImage は Delphi の内部表現にのみ使われるオブジェクトで，TIcon オブジェクトによってカプセル化されたビットマップの内部イメージを表します。TIconImage で実装されているデータとメソッドはすべて Private で，特定の HICON についての情報（Windows で定義される標準の HICON 構造体へのポインタなど）を保持します。TIconImage はアイコンイメージの作成時に TIcon オブジェクトのコンストラクタ内で参照されます。


TIconImage メソッド3280002

TIconImage	アルファベット順

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIconImage メソッド3280003

TIconImage	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3280004

TObject

TSharedImage


TIconImage 例3280005

TIconImage


TImage
TImage3281001

継承	プロパティ	メソッド	イベント	参照	例

TImage コンポーネントは，フォーム上にグラフィックイメージを表示します。

ユニット

extctrls

説明

TImage を使うとフォーム上にグラフィックイメージを表示できます。TPicture オブジェクトを使うと，TImage が表示する実際のビットマップ，アイコン，メタファイル，他のグラフィックオブジェクトを指定できます。 TImage は，イメージを TImage オブジェクトの境界内でどのように表示するかを決めるいくつかのプロパティを提供します。

イメージを他のコントロールに表示できるように，フォームやデータモジュールにイメージを追加するには，かわりに TImageList を使います。


TImage プロパティ3281002

TImage	アルファベット順	凡例

TImage

AutoSize

Canvas

Center

IncrementalDisplay

Picture

Stretch

Transparent

TControl からの継承

Align

BoundsRect

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Height

Hint

Left

Name

Parent

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TImage プロパティ3281003

TImage	オブジェクト順	凡例

Align

AutoSize

BoundsRect

Canvas

Center

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlState

ControlStyle

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Height

Hint

IncrementalDisplay

Left

Name

Owner

Parent

ParentShowHint

Picture

PopupMenu

ShowHint

Stretch

Tag

Top

Transparent

VCLComObject

Visible

Width

WindowProc


TImage.AutoSize
TImage.AutoSize3281004

TImage	参照

AutoSize プロパティは，イメージコントロールがイメージを収容できるようにサイズ変更するかどうかを決めます。

property AutoSize: Boolean;

説明

AutoSize プロパティに True を設定すると，イメージコントロールの中にイメージ全体が確実に表示されるようにします。AutoSize が True ならば，イメージコントロールのサイズが変更され，Picture プロパティが指定するイメージがイメージコントロール内に収まるようになります。AutoSize が False ならば，イメージのサイズに関係なくイメージコントロールのサイズは変わりません。イメージコントロールがイメージより小さい場合，イメージコントロールに収まる分の画像だけが表示されます。

イメージコントロールをイメージに合わせてサイズ変更するのではなく，イメージコントロールに合わせてイメージのサイズ変更をするには，Stretch プロパティを使います。


TImage.Canvas
TImage.Canvas3281005

TImage	参照

Canvas プロパティは，イメージを表示する描画表面です。

property Canvas: TCanvas;

説明

Canvas プロパティは，Picture プロパティで指定したイメージを追加できます。たとえば，TCanvas オブジェクトの TextOut メソッドを使うと，イメージ部分にラベルを追加できます。

注意

Canvas は，Picture プロパティがビットマップを表しているときのみ有効です。Picture が他の画像タイプを表しているときに Canvas を読み出そうとすると，EInvalidOperation 例外が発生します。


TImage.Center
TImage.Center3281006

TImage	参照

Center プロパティは，イメージコントロールの中央にイメージを配置します。

property Center: Boolean;

説明

イメージコントロール内にイメージが完全に入っていないとき，Center プロパティを使うとイメージをどのように配置するかを指定できます。Center が True の場合，イメージはコントロールの中央に表示されます。Center が False の場合，イメージの左上隅がコントロールの左上隅に合わせて表示されます。

注意

AutoSize プロパティが True の場合，または Stretch プロパティが Trueで，Picture でアイコンを指定していない場合，Center を指定しても効果はありません。


TImage.IncrementalDisplay
TImage.IncrementalDisplay3281007

TImage	参照

IncrementalDisplay プロパティは，時間のかかる処理中に，近似イメージを逐次描画するかどうかを指定します。

property IncrementalDisplay: Boolean;

説明

IncrementalDisplay を True に設定すると，ロードするのに時間のかかる大きな圧縮イメージか時間のかかる計算処理を行って変更されるイメージを一定時間ごとに部分的に描画できます。IncrementalDisplay を False に設定すると，全処理が完了するまでイメージは描画されません。

グラフィックオブジェクトのクラスの中には，時間のかかる処理をしている間，さまざま時点で OnProgress イベントが発生するものがあります。IncrementalDisplay が True の場合，近似イメージが描画された直後に，OnProgress イベントが発生します。IncrementalDisplay が False の場合，OnProgress は発生しますが，イメージは更新されません。


TImage.Picture
TImage.Picture3281008

TImage	参照

Picture プロパティは，イメージコントロール上に表示されるイメージを指定します。

property Picture: TPicture;

説明

Picture プロパティを TPicture オブジェクトに設定します。TPicture オブジェクトには，イメージコントロールが表示するアイコン，メタファイル，ビットマップ，グラフィック，ユーザー定義のグラフィックが入っています。設計時に Picture を設定すると，画像の設定ダイアログが起動され，イメージを含むファイルを指定できます。


TImage.Stretch
TImage.Stretch3281009

TImage	参照

Stretch プロパティは，Picture プロパティで指定されたイメージのサイズを変更し，イメージコントロールの枠に完全にはめ込みます。

property Stretch: Boolean;

説明

Stretch プロパティに True を設定すると，イメージをイメージコントロールのサイズと形状とみなすことができます。イメージコントロールをサイズ変更すると，イメージもサイズ変更されます。Stretch を使うとイメージの高さと幅を独立して変更します。したがって，イメージコントロールとイメージの形が違う場合，単にイメージを拡大させるのではなく，イメージを歪めることができます。

イメージをイメージコントロールに合わせてサイズを変更するのではなく，イメージに合わせてイメージコントロールのサイズを変更をするには，かわりに AutoSize プロパティを使います。

注意

Picture プロパティにアイコンが入っているとき，Stretch を指定しても効果はありません。


TImage.Transparent
TImage.Transparent3281010

TImage	参照

Transparent プロパティは，イメージの背景でイメージオブジェクトの下にあるオブジェクトを隠すかどうかを指定します。

property Transparent: Boolean;

説明

Transparent プロパティに True を設定すると，TImage オブジェクトの下にあるオブジェクトを，上にあるビットマップの背景を透かして表示できます。Transparent に False を設定すると，ビットマップの背景は不透明になります。Transparent を設定すると，Picture の Transparent プロパティが設定されます。

注意

Picure プロパティにビットマップが設定されていなければ，Transparent を設定しても効果はありません。


TImage イベント3281011

TImage	アルファベット順	凡例

TImage

OnProgress

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TImage イベント3281012

TImage	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnProgress

OnStartDrag


TImage.OnProgress
TImage.OnProgress3281013

TImage	参照

OnProgress イベントは，イメージに影響を及ぼすような時間のかかる処理をしている間，一定時間ごとに発生します。

TProgressStage = (psStarting, psRunning, psEnding);

TProgressEvent = procedure (Sender: TObject; Stage: TProgressStage;

    PercentDone: Byte; RedrawNow: Boolean; const R: TRect; const Msg: string) of object;

property OnProgress: TProgressEvent

説明

OnProgress イベントハンドラを記述すると，大きな圧縮イメージのロードなどの時間のかかる処理を行っている間，ユーザーにフィードバックを行うことができます。

Stage パラメータは，処理が始まっているか，継続しているか，終了しているかどうかを示します。OnProgress イベントハンドラでプログレスバーなどのインジケータを表示させている場合，インジケータは Stage が psStarting のときに作成され，psRunning の間に更新され，psEnding のときに削除されます。PercentDone パラメータは処理がどの程度終わっているかを示す近似値です。PercentDone を使うと，プログレスバーや他のインジケータの位置を更新できます。

RedrawNow パラメータは，イメージを現時点でスクリーンに安全に描画できるかどうかを示します。IncrementalDisplay プロパティが True の場合，RedrawNow が True ならば OnProgress イベントの直後に近似イメージが描画されます。R パラメータは，変更されたために再描画が必要なイメージ部分を指定します。

Msg パラメータは，どの処理が発生しているかを記述する 1 ワードか 2 ワードが入っています。たとえば，Meg の値に Loading，Storing，Reducing colors などを設定します。Msg 文字列は空でもかまいません。

注意

PercentDone パラメータは単なる近似値です。画像形式によっては，グラフィックオブジェクトがより多くの処理をしなければならなくなると， パラメータの値が前のイベントでの値より小さくなることがあります。


TImage メソッド3281014

TImage	アルファベット順

TImage

Create

Destroy

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Invalidate

Perform

Refresh

Repaint

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TImage メソッド3281015

TImage	オブジェクト順

Assign

BeginDrag

BringToFront

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DragDrop

Dragging

EndDrag

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTextBuf

GetTextLen

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Perform

Refresh

RemoveComponent

Repaint

SafeCallException

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update


TImage.Create
TImage.Create3281016

TImage	参照

Create メソッドは，TImage のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TImage オブジェクトをインスタンス化できます。設計時にフォーム上に配置されたイメージの場合，TImage オブジェクトは自動的に作成されます。


TImage.Destroy
TImage.Destroy3281017

TImage	参照

Destroy メソッドは，TImage のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはイメージが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。


スコープ3281018

published

読み出し／書き込み

読み出し専用


スコープ3281019

published


継承3281020

TObject

TPersistent

TComponent

TControl

TGraphicControl


TImage 例3281021

TImage


TImageList
TImageList3282001

継承	プロパティ	メソッド	イベント	参照

TImageList コンポーネントは，同じサイズのイメージのコレクションです。各イメージはインデックスで参照されます。

ユニット

controls

説明

イメージリストは多くのアイコンまたはビットマップを効率的に管理するために利用されます。イメージリストにあるすべてのイメージは，単一の大きなビットマップに画面デバイス形式で格納されています。イメージリストには，イメージを透過的に描画するために使われるマスクを含むモノクロビットマップが入っている場合もあります（アイコンスタイル）。

イメージリストには同じサイズの多くのイメージを保持でき，それらを 0 から n - 1 のインデックスで取り出すことができます。またイメージリストには，イメージの格納や，格納されているイメージの取り出しと描画に使用できるメソッドが用意されています。

TImageList コンポーネントは TCustomImageList から派生し，TCustomImageList コンポーネントの保護されているプロパティとメソッドの多くをエクスポーズします。


TImageList プロパティ3282002

TImageList	アルファベット順	凡例

TCustomImageList からの継承

AllocBy

BkColor

BlendColor

Count

DragCursor

Dragging

DrawingStyle

Handle

Height

ImageType

Masked

ShareImages

Width

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TImageList プロパティ3282003

TImageList	オブジェクト順	凡例

AllocBy

BkColor

BlendColor

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Count

DesignInfo

DragCursor

Dragging

DrawingStyle

Handle

Height

ImageType

Masked

Name

Owner

ShareImages

Tag

VCLComObject

Width


TImageList イベント3282004

TImageList	アルファベット順	凡例

TCustomImageList からの継承

OnChange


TImageList イベント3282005

TImageList	オブジェクト順	凡例

OnChange


TImageList メソッド3282006

TImageList	アルファベット順

TCustomImageList からの継承

Add

AddIcon

AddImages

AddMasked

Assign

BeginDrag

Clear

Create

CreateSize

Delete

Destroy

DragLock

DragMove

DragUnlock

Draw

DrawOverlay

EndDrag

FileLoad

GetBitmap

GetHotSpot

GetIcon

GetImageBitmap

GetInstRes

GetMaskBitmap

GetResource

HandleAllocated

HideDragImage

Insert

InsertIcon

InsertMasked

Move

Overlay

RegisterChanges

Replace

ReplaceIcon

ReplaceMasked

ResInstLoad

ResourceLoad

SetDragImage

ShowDragImage

UnRegisterChanges

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TImageList メソッド3282007

TImageList	オブジェクト順

Add

AddIcon

AddImages

AddMasked

Assign

BeginDrag

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

CreateSize

DefaultHandler

Delete

Destroy

DestroyComponents

Destroying

Dispatch

DragLock

DragMove

DragUnlock

Draw

DrawOverlay

EndDrag

FieldAddress

FileLoad

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetBitmap

GetHotSpot

GetIcon

GetImageBitmap

GetInstRes

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetMaskBitmap

GetNamePath

GetParentComponent

GetResource

HandleAllocated

HasParent

HideDragImage

InheritsFrom

InitInstance

Insert

InsertComponent

InsertIcon

InsertMasked

InstanceSize

MethodAddress

MethodName

Move

NewInstance

Overlay

RegisterChanges

RemoveComponent

Replace

ReplaceIcon

ReplaceMasked

ResInstLoad

ResourceLoad

SafeCallException

SetDragImage

ShowDragImage

UnRegisterChanges


スコープ3282008

published

読み出し／書き込み

読み出し専用


スコープ3282009

published


継承3282010

TObject

TPersistent

TComponent

TCustomImageList


TImageList 例3282011

TImageList


TIndexDef
TIndexDef3283001

継承	プロパティ	メソッド	参照

TIndexDef オブジェクトはデータベーステーブルのインデックスを記述するインデックス定義です。

ユニット

db

説明

インデックス定義のプロパティとメソッドの用途は次のとおりです。

・	インデックスの名前を入手する

・	インデックスを構成する項目またはインデックスを順序付ける dBASE 式を識別する

・	インデックスの特性を調べる

物理データベーステーブルを示すデータセットは，データベーステーブルのインデックスを作成/管理するために，TIndexDef を使用します。


TIndexDef プロパティ3283002

TIndexDef	アルファベット順	凡例

TIndexDef

Expression

Fields

Name

Options

Source


TIndexDef プロパティ3283003

TIndexDef	オブジェクト順	凡例

Expression

Fields

Name

Options

Source


TIndexDef.Expression
TIndexDef.Expression3283004

TIndexDef	参照

Expression プロパティは，dBASE のキー式を示す文字列が入ります。.

property Expression: string;

説明

Expression プロパティは，dBASE の式インデックスのキー式を取得できます。

dBASE テーブルのキー式は項目名，または項目名，関数，およびインデックスがテーブルでレコードを順序付ける方法を指定する演算子の組み合わせです。テーブルが dBASE テーブルではない場合，Expression プロパティは空文字列です。

Options プロパティに ixExpression が設定されていない場合，返される Expression プロパティの文字列は空の文字列になります。dBASE の式インデックス以外のインデックスの項目を調べるには，Fields プロパティを使います。

注意

キー式についての詳細は，dBASE のマニュアルを参照してください。


TIndexDef.Fields
TIndexDef.Fields3283005

TIndexDef	参照

Fields プロパティは，インデックスを構成する項目を読み出します。

property Fields: string;

説明

Fields プロパティは，インデックスを構成する項目を取得できます。返される文字列は項目の名前または項目の番号です。番号が使われる場合，その番号はテーブル内の物理項目番号です。文字列に項目が複数ある場合，それぞれの項目はセミコロンで（;）で区切られます。

インデックスが dBASE のキー式を元にしている場合，Fields プロパティではインデックスを構成する項目を示しません。Options プロパティに ixExpression が設定されている場合，Fields プロパティは空の文字列を返します。dBASE の式インデックスの仕様を調べるには，かわりに Expression プロパティを使います。


TIndexDef.Name
TIndexDef.Name3283006

TIndexDef	参照

Name プロパティは，インデックス定義の名前です。

property Name: string;

説明

Name プロパティは，インデックスの名前を取得できます。この値はインデックスを識別するために物理データベーステーブルで使われる名前です。

注意

dBASE の保守されるインデックスの場合，Name プロパティはインデックスのタグ名を表します。Paradox テーブルの場合，キーの Name プロパティは空文字列になります。


TIndexDef.Options
TIndexDef.Options3283007

TIndexDef	参照

Options プロパティは，インデックスの特性を示します。

TIndexOptions = set of (ixPrimary, ixUnique, ixDescending, ixExpression, ixCaseInsensitive);

property Options: TIndexOptions;

説明

Options プロパティは，インデックスの属性を取得できます。Options プロパティは空になる場合もあり，複数の値を持つこともできます。

値	意味

ixPrimary	インデックスはテーブルの一次インデックス

ixUnique	インデックスの各値はユニークで，同じものはない

ixDescending	インデックスは降順でソートされる

ixExpression	インデックスの順番は dBASE のキー式に依存する

ixCaseInsensitive	インデックスは大文字と小文字を区別しない

注意

個々のデータベースドライバではこれらオプションの一部しかサポートされない場合があります。たとえば，dBASE テーブルでは CaseInsensitive はサポートされません。


TIndexDef.Source
TIndexDef.Source3283008

TIndexDef	参照

Source プロパティは，dBASE の保守されるインデックスの名前が入っています。

property Source: string;

説明

テーブルが dBASE の .MDX インデックスを使っている場合，Name プロパティはインデックスのタグ名を示し，Source プロパティはインデックスファイルの名前を示します。Source プロパティは dBASE テーブルのインデックスのみに適用できます。


TIndexDef メソッド3283009

TIndexDef	アルファベット順

TIndexDef

Create

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIndexDef メソッド3283010

TIndexDef	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIndexDef.Create
TIndexDef.Create3283011

TIndexDef	参照

Create メソッドは，TIndexDef オブジェクトのインスタンスを作成します。

constructor Create(Owner: TIndexDefs; const Name, Fields: string; Options: TIndexOptions);

説明

アプリケーションから直接に Create メソッドを呼び出さないでください。リストに新しいインデックスを追加する場合には，TIndexDef オブジェクトのコンストラクタが TIndexDefs オブジェクトによって呼び出されます。新しい TIndexDef オブジェクトを作成するには，適切な TIndexDefs オブジェクトの Add メソッドを呼び出します。

Create メソッドは Name，Fields，および Options のパラメータ値を同じ名前のプロパティに代入します。Owner パラメータは，テーブルのすべてのインデックス定義を含む TIndexDefs オブジェクトです。


TIndexDef.Destroy
TIndexDef.Destroy3283012

TIndexDef	参照

Destroy メソッドは，TIndexDef オブジェクトのインスタンスを破棄します。

destructor Destroy; override;

説明

TIndexDef オブジェクトに対して Destroy メソッドを呼び出さないでください。インデックス定義を所有する TIndexDefs オブジェクトが Free メソッドを呼び出してそれを破棄します。Free メソッドは TIndexDef オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは，オーナーである TIndexDefs オブジェクトの Items プロパティからインデックス定義を削除してから，継承デストラクタを呼び出します。


読み出し／書き込み3283013

読み出し専用


継承3283014

TObject


TIndexDef 例3283015

TIndexDef


TIndexDefs
TIndexDefs3284001

継承	プロパティ	メソッド	参照

TIndexDefs オブジェクトにはテーブルで使用できるインデックス定義のリストが保持されます。

ユニット

db

説明

TIndexDefs オブジェクトのプロパティとメソッドの用途は次のとおりです。

・	特定のインデックス定義にアクセスする

・	TIndexDefs オブジェクトに含まれるインデックス定義の数を取得する

・	インデックス定義を追加または削除する

・	TIndexDefs オブジェクト間ですべてのインデックス定義をコピーする

物理データベーステーブルを表すデータセットは，TIndexDefs を使ってデータベーステーブルのインデックスを作成または保守します。


TIndexDefs プロパティ3284002

TIndexDefs	アルファベット順	凡例

TIndexDefs

Count

Items

Updated


TIndexDefs プロパティ3284003

TIndexDefs	オブジェクト順	凡例

Count

Items

Updated


TIndexDefs.Count
TIndexDefs.Count3284004

TIndexDefs	参照

Count プロパティは，TIndexDefs オブジェクト内のインデックス定義数を示します。

property Count: Integer;

説明

Count プロパティは，データセットと関連付けられているインデックスの数を取得します。Items 配列のすべてのインデックス定義を処理するには，Count プロパティを使ってループ変数を制御します。

Count プロパティは読み出し専用です。Count プロパティの値はインデックス定義を追加または削除すると間接的に変更されます。


TIndexDefs.Items
TIndexDefs.Items3284005

TIndexDefs	参照

Items プロパティは，テーブルの各インデックスを記述したインデックス定義へのポインタの配列です。

property Items[Index: Integer]: TIndexDef;

説明

Items プロパティは，特定のインデックス定義にアクセスできます。Index パラメータでアクセスするインデックス定義を指定します。Index パラメータには，リスト内のインデックス定義の位置を識別する整数（0 から Count - 1）が入ります。

Items プロパティは読み出し専用です。Items プロパティの値はインデックス定義が追加または削除されると間接的に変更されます。


TIndexDefs.Updated
TIndexDefs.Updated3284006

TIndexDefs	参照

Updated プロパティは，Items 配列内のインデックス定義が基になるデータベース内のインデックスと正確に一致することがわかっていることを示します。

property Updated: Boolean;

説明

Updated プロパティは，インデックス定義が古くなっているかどうかを取得できます。Updated が False のときは，Update メソッドを呼び出して，基になるインデックス定義からインデックス定義を読み出し直します。


TIndexDefs メソッド3284007

TIndexDefs	アルファベット順

TIndexDefs

Add

Assign

Clear

Create

Destroy

FindIndexForFields

GetIndexForFields

IndexOf

Update

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIndexDefs メソッド3284008

TIndexDefs	オブジェクト順

Add

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FindIndexForFields

Free

FreeInstance

GetIndexForFields

GetInterface

GetInterfaceEntry

GetInterfaceTable

IndexOf

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

Update


TIndexDefs.Add
TIndexDefs.Add3284009

TIndexDefs	参照

Add メソッドは，新しいインデックス定義オブジェクトを作成し，TIndexDefs オブジェクトの Items プロパティに追加します。

TIndexOptions = set of (ixPrimary, ixUnique, ixDescending, ixExpression, ixCaseInsensitive);

procedure Add(const Name, Fields: string; Options: TIndexOptions);

説明

Add メソッドを呼び出すと，新しいテーブルを定義するときに Items 配列に値を入れることができます。既存のテーブルにインデックスを追加するには，TTable オブジェクトの AddIndex メソッドを使います。新しいインデックスがデータセットに追加されたときにインデックスの配列を変更するには，Update メソッドを使います。

Add メソッドはインデックス定義を作成し，Name，Fields，および Options パラメータに渡されている値を同じ名前の TIndexDef オブジェクトのプロパティに代入します。

同じ名前のインデックス定義がすでに存在する場合，EDatabaseError 例外が発生します。

TIndexOptions 型は新しいインデックスを作成するときに使われる値のセットです。Options は空の場合もあり，複数の値を持つこともあります。

値	意味

ixPrimary	インデックスはテーブルの一次インデックス

ixUnique	インデックスの各値はユニークで，同じものはない

ixDescending	インデックスは降順で並ぶ

ixExpression	インデックスは順番は dBASE のキー式に依存する

ixCaseInsensitive	インデックスは大文字と小文字を区別しない

注意

個々のデータベースドライバではオプションの一部しかサポートされない場合があります。たとえば dBASE テーブルの場合，ixCaseInsensitive はサポートされていません。


TIndexDefs.Assign
TIndexDefs.Assign3284010

TIndexDefs	参照

Assign メソッドは，IndexDefs パラメータを使って新しい TIndexDefs オブジェクトのセットを Items 配列に作成します。

procedure Assign(IndexDefs: TIndexDefs);

説明

Assign メソッドを呼び出すと，TIndexDefs オブジェクトをもう 1 つの TIndexDefs オブジェクトにコピーします。

Assign メソッドは Items プロパティ配列のすべてのインデックス定義を削除し，そのインデックス定義を Items プロパティにコピーします。TIndexDefs オブジェクトを IndexDefs パラメータの値として指定します。


TIndexDefs.Clear
TIndexDefs.Clear3284011

TIndexDefs	参照

Clear メソッドは，Items プロパティのすべてのインデックス定義を削除および解放します。

procedure Clear;

説明

Clear メソッドを呼び出すと，Items 配列に保持されているインデックス定義のリストからすべてのインデックス定義を削除します。


TIndexDefs.Create
TIndexDefs.Create3284012

TIndexDefs	参照

Create メソッドは，TIndexDefs オブジェクトのインスタンスを作成します。

constructor Create(Table: TTable);

説明

アプリケーションから直接に Create メソッドを呼び出さないでください。TIndexDefs は，テーブルのインデックスを指定するためにデータセットによって自動的に作成されます。

Create は，継承したコンストラクタを呼び出してから Items プロパティ配列を作成します。


TIndexDefs.Destroy
TIndexDefs.Destroy3284013

TIndexDefs	参照

Destroy メソッドは，TIndexDefs のインスタンスを破棄します。

destructor Destroy: override;

説明

直接に Destroy メソッドを呼び出さないでください。TIndexDefs オブジェクトを所有するデータセットが Free メソッドを呼び出して破棄します。Free メソッドは，TIndexDefs オブジェクトがまだ解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy は，継承したデストラクタを呼び出してから，Item プロパティ配列からすべてのインデックス定義を削除し，Items プロパティを解放します。


TIndexDefs.FindIndexForFields
TIndexDefs.FindIndexForFields3284014

TIndexDefs	参照

FindIndexForFields メソッドは，Item プロパティ配列でインデックス定義を検索します。

function FindIndexForFields(const Fields: string): TIndexDef;

説明

FindIndexForFields メソッドを呼び出すと，Fields パラメータで指定した項目で始まるインデックスを検索します。複数項目のインデックスの場合，各項目はセミコロンで区切ります。

FindIndexForFields メソッドは，指定の項目が指定の順序で正確に一致するインデックス定義を返します。正確に一致するものがない場合，FindIndexForFields メソッドは指定の項目で始まる最初のインデックスを返します。それでも一致するものがない場合，FindIndexForFields メソッドは例外を生成します。

大文字小文字を区別しないインデックスに検索を制限するには，GetIndexForFields メソッドを使います。


TIndexDefs.GetIndexForFields
TIndexDefs.GetIndexForFields3284015

TIndexDefs	参照

GetIndexForFields メソッドは，Item プロパティ配列でインデックス定義を検索します。

function GetIndexForFields(const Fields: string; CaseInsensitive: Boolean): TIndexDef;

説明

GetIndexForFields メソッドを呼び出すと，Fields パラメータで指定した項目で始まるインデックスを検索します。複数項目のインデックスの場合，各項目はセミコロンで区切ります。CaseInsensitive パラメータを True に設定すると，Item 配列内の大文字小文字を区別しないインデックスだけに検索を制限できます。

GetIndexForFields メソッドは，指定の項目が指定の順序で正確に一致するインデックス定義を返します。正確に一致するものがない場合，GetIndexForFields メソッドは指定の項目で始まる最初のインデックスを返します。それでも一致するものがない場合，GetIndexForFields メソッドは nil を返します。

注意

CaseInsensitive が True のときは，大文字小文字を区別するインデックスであっても，降順インデックスは検索対象になります。


TIndexDefs.IndexOf
TIndexDefs.IndexOf3284016

TIndexDefs	参照

IndexOf メソッドは，Item プロパティ配列におけるインデックス定義の位置を返します。

function IndexOf(const Name: string): Integer;

説明

IndexOf メソッドを呼び出すと，Item プロパティ配列におけるインデックス定義の位置がわかります。IndexOf メソッドは 0（最初のインデックス定義）から Count - 1 までの値を返します。Name パラメータにインデックスの名前を指定します。

指定した名前のインデックス定義がない場合，戻り値は -1 になります。

注意

IndexOf メソッドはインデックスの名前（Name）を基準にインデックスを検索します。FindIndexForFields メソッドはインデックスを構成する項目の名前を基準にインデックスを検索します。


TIndexDefs.Update
TIndexDefs.Update3284017

TIndexDefs	参照

Update メソッドは，テーブルの現在の状態を反映して Items プロパティのインデックス定義を更新します。

procedure Update;

説明

テーブルのインデックスのセットに変更がある場合に Update メソッドを呼び出します。Update メソッドはテーブルを開かずにインデックス定義を更新します。


読み出し／書き込み3284018

読み出し専用


継承3284019

TObject


TIndexDefs 例3284020

TIndexDefs


TIniFile
TIniFile3285001

継承	プロパティ	メソッド	参照

TIniFile オブジェクトは 16 ビット Windows 3.x INI ファイルシステム向けの低レベルラッパです。特定アプリケーションの INI ファイルにある情報および設定の保存や読み出しを可能にします。

ユニット

inifiles

説明

TIniFile オブジェクトは，Windows 3.x INI ファイルにある特定アプリケーションの情報および設定の保存と読み出しを可能にします。INI ファイルテキスト形式は，Windows 3.x アプリケーションが複数のセッションに渡ってアプリケーションの設定を保存したり，読み出したりするための標準的な方法です。INI ファイルには情報がセクションと呼ばれる論理的なグループで格納されています。たとえば，WIN.INI ファイルには [Desktop] というセクションがあります。各セクション内では，実際のデータは指定のキーに格納されます。キーは次の形式をとります。

<keyname>=<value>

TIniFile オブジェクトの作成時に渡される FileName プロパティには，そのアプリケーションの INI ファイルの名前が入っています。

TIniFile オブジェクトでは，特定の INI ファイルを読み書きするため，そして INI ファイルのセクション全体を削除するためのプロパティおよびメソッドが提供されます。これらのプロパティやメソッドに加えて，TIniFile オブジェクトは TObject のメソッドを継承しています。

注意

TIniFile オブジェクトは移行目的および下位互換性のためにのみサポートされています。Windows 95 および NT では，INI ファイルがシステムレジストリに置き換えられています。このシステムレジストリでは，すべてのアプリケーションがそれぞれの設定の保存および取り出しを行います。Windows 95 および NT 向けのアプリケーションは INI ファイルのかわりにシステムレジストリを使います。Delphi ではシステムレジストリを処理する 2 つのオブジェクトが提供されます。TRegistry オブジェクトはシステムレジストリをカプセル化します。TRegIniFile オブジェクトもシステムレジストリをカプセル化しますが，Windows 95 および NT 向けにアップグレードされる既存の Windows 3.1 アプリケーションに容易な仕組みを提供します。


TIniFile プロパティ3285002

TIniFile	アルファベット順	凡例

TIniFile

FileName


TIniFile プロパティ3285003

TIniFile	オブジェクト順	凡例

FileName


TIniFile.FileName
TIniFile.FileName3285004

TIniFile	参照

FileName プロパティは，特定アプリケーションの情報が読み書きされる INI ファイルの名前が入ります。

property FileName: string;

説明

FileName プロパティは，アプリケーションで使われている INI ファイルの名前がわかります。INI ファイルの情報を読み書きするメソッドは，FileName プロパティで指定されたファイルを自動的にオープンおよびクローズします。

注意

通常，INI ファイルは \WINDOWS ディレクトリに格納されています。他の場所で INI ファイルを扱うには，TIniFile オブジェクトの Create メソッドに渡される FileName パラメータにファイルのフルパス名を指定します。


TIniFile メソッド3285005

TIniFile	アルファベット順

TIniFile

Create

DeleteKey

EraseSection

ReadBool

ReadInteger

ReadSection

ReadSections

ReadSectionValues

ReadString

WriteBool

WriteInteger

WriteString

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIniFile メソッド3285006

TIniFile	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

DeleteKey

Destroy

Dispatch

EraseSection

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadBool

ReadInteger

ReadSection

ReadSections

ReadSectionValues

ReadString

SafeCallException

WriteBool

WriteInteger

WriteString


TIniFile.Create
TIniFile.Create3285007

TIniFile	参照

Create メソッドは，アプリケーションの TIniFile オブジェクトを作成します。

constructor Create(const FileName string;

説明

Create メソッドを呼び出すと，アプリケーションの TIniFile オブジェクトを作成できます。Create メソッドは TObject オブジェクトから Create を継承しており，INI ファイルの名前を指定するために使われる追加の FileName プロパティを作成します。

注意

通常，INI ファイルは \WINDOWS ディレクトリに格納されています。他の場所で INI ファイルを扱うには，FileName パラメータにファイルのフルパス名を指定します。


TIniFile.DeleteKey
TIniFile.DeleteKey3285008

TIniFile	参照

DeleteKey メソッドは，INI ファイルのエントリと関連付けられているデータ値を削除します。

procedure DeleteKey(const Section, Ident: string);

説明

DeleteKey メソッドを呼び出すと，INI ファイルのエントリと関連付けられているデータ値が削除されます。Section には INI ファイルのセクションの名前を示す文字列が入り，Ident には，値を削除するキーの名前を示す文字列が入ります。

注意

存在しないセクションのデータ値を削除しようとしたり，存在しないキーからデータを削除しようとしてもエラーにはなりません。この場合，DeleteKey メソッドはそのセクションおよびキーを作成し，初期値を空の値に設定します。


TIniFile.EraseSection
TIniFile.EraseSection3285009

TIniFile	参照

EraseSection メソッドは，INI ファイルのセクション全体を削除します。

procedure EraseSection(const Section: string);

説明

EraseSection メソッドを呼び出すと，セクションとそのすべてのキー，およびデータ値が INI ファイルから削除されます。Section は削除する INI ファイルのセクションを指定します。セクションが削除できない場合には例外が発生します。


TIniFile.ReadBool
TIniFile.ReadBool3285010

TIniFile	参照

ReadBool メソッドは，INI ファイルから論理値を取り出します。

function ReadBool (const Section, Ident: string; Default: Boolean): Boolean;

説明

ReadBool メソッドを呼び出すと，INI ファイルから論理値を読み出せます。Section は目的のキーがあるファイル内のセクションを指定します。Ident は論理値を取り出すキーの名前です。Default は以下のような場合に返される論理値です。

・	セクションが存在しない

・	キーが存在しない

・	キーにデータ値が代入されていない


TIniFile.ReadInteger
TIniFile.ReadInteger3285011

TIniFile	参照

ReadInteger メソッドは，INI ファイルから整数値を取り出します。

function ReadInteger(const Section, Ident: string; Default: Longint): Longint;

説明

ReadInteger メソッドを呼び出すと，INI ファイルから整数値を読み出せます。Section は目的のキーがあるファイル内のセクションを指定します。Ident は値を取り出すキーの名前です。Default は以下のような場合に返される整数値です。

・	セクションが存在しない

・	キーが存在しない

・	キーにデータ値が代入されていない


TIniFile.ReadSection
TIniFile.ReadSection3285012

TIniFile	参照

ReadSection メソッドは，INI ファイルの指定のセクションからすべてのキーの名前を文字列リストに読み出します。

procedure ReadSection (const Section: string; Strings: TStrings);

説明

ReadSection メソッドを呼び出すと，INI ファイルの指定のセクションにあるすべてのキーの名前を文字列リストオブジェクトに取り出すことができます。

Section はキーの名前のリストが取り出されるセクションを指定します。Strings は，取り出した名前を保持する文字列オブジェクトを指定します。Strings は文字列リストのような TStringList オブジェクトまたは TListBox コンポーネントの Items のようなコンポーネントプロパティ（TString オブジェクト自体）を指定します。


TIniFile.ReadSections
TIniFile.ReadSections3285013

TIniFile	参照

ReadSections メソッドは，INI ファイルにあるすべてのセクションの名前を文字列リストに読み出します。

procedure ReadSections(Strings: TStrings);

説明

ReadSections メソッドを読み出すと，INI ファイルにあるすべてのセクションの名前を文字列リストオブジェクトに読み出すことができます。

Strings は取り出された名前を保持する文字列オブジェクトを指定します。Strings には TStringList オブジェクトまたは TListBox コンポーネントの Items のようなコンポーネントプロパティ（TString オブジェクト自体）を示すことができます。


TIniFile.ReadSectionValues
TIniFile.ReadSectionValues3285014

TIniFile	参照

ReadSectionValues メソッドは，INI ファイルのセクションにあるすべてのキーから値を文字列リストに読み出します。

procedure ReadSectionValues(const Section: string; Strings: TStrings);

説明

ReadSectionValues メソッドを読み出すと，INI ファイルの指定のセクションにあるすべてのキーから値を文字列リストオブジェクトに読み出せます。Section はキーの値を読み出すファイル内のセクションを指定します。Strings は値を読み出す文字列リストオブジェクトです。

Strings は取り出された名前を保持する文字列オブジェクトを指定します。Strings には TStringList オブジェクトまたは TListBox コンポーネントの Items のようなコンポーネントプロパティ（TString オブジェクト自体）を示すことができます。


TIniFile.ReadString
TIniFile.ReadString3285015

TIniFile	参照

ReadString メソッドは，INI ファイルから文字列値を取り出します。

function ReadString(const Section, Ident, Default: string): string;

説明

ReadString メソッドを呼び出すと，INI ファイルから文字列値を読み出せます。Section は目的のキーが含まれているファイル内のセクションを指定します。Ident は値を取り出すキーの名前です。Default は以下の場合に返される文字列値です。

・	セクションが存在しない

・	キーが存在しない

・	キーにデータが代入されていない


TIniFile.WriteBool
TIniFile.WriteBool3285016

TIniFile	参照

WriteBool メソッドは，INI ファイルに論理値を書き込みます。

procedure WriteBool(const Section, Ident: string; Value: Boolean);

説明

WriteBool メソッドを呼び出すと，INI ファイルに論理値を書き込めます。Section は値が書き込まれるキーのあるファイル内のセクションを指定します。Ident は値を設定するキーの名前です。Value には書き込む論理値が入ります。

注意

存在しないセクションにデータ値を書き込もうとしても，または存在しないキーにデータを書き込もうとしてもエラーにはなりません。この場合，WriteBool メソッドはセクションおよびキーを作成し，初期値を Value に設定します。


TIniFile.WriteInteger
TIniFile.WriteInteger3285017

TIniFile	参照

WriteInteger メソッドは，整数値を INI ファイルに書き込みます。

procedure WriteInteger(const Section, Ident: string; Value: Longint);

説明

WriteInteger メソッドを呼び出すと，整数値を INI ファイルに書き込めます。Section は整数値が書き込まれるキーのあるファイル内のセクションを指定します。Ident は値を設定するキーの名前です。Value には書き込まれる整数値が入ります。

注意

存在しないセクションにデータ値を書き込もうとしても，または存在しないキーにデータを書き込もうとしてもエラーにはなりません。この場合，WriteInteger メソッドはセクションおよびキーを作成し，初期値を Value に設定します。


TIniFile.WriteString
TIniFile.WriteString3285018

TIniFile	参照

WriteString メソッドは，文字列値を INI ファイルに書き込みます。

procedure WriteString(const Section, Ident, Value: string);

説明

WriteString メソッドを呼び出すと，INI ファイルに文字列値を書き込めます。Section は文字列値が書き込まれるキーのあるファイル内のセクションを指定します。Ident は値を設定するキーの名前です。Value には書き込まれる文字列値が入ります。

注意

存在しないセクションにデータ値を書き込もうとしても，または存在しないキーにデータを書き込もうとしてもエラーにはなりません。この場合，WriteString メソッドはセクションおよびキーを作成し，初期値を Value に設定します。


読み出し／書き込み3285019

読み出し専用


継承3285020

TObject


TIniFile 例3285021

TIniFile


TInplaceEdit
TInplaceEdit3286001

継承	プロパティ	メソッド	参照

TInplaceEdit オブジェクトは，グリッドコントロールにテキスト編集機能を追加します。

ユニット

grids

説明

TInplaceEdit はグリッドコントロールを処理するためのヘルパーオブジェクトです。このオブジェクトはグリッドコントロールの適切なセルに表示される複数行の編集ウィンドウを提供します。TInplaceEdit オブジェクトを使うと，グリッドはユーザーのアクションに対するコントロールの応答を制御でき，またセルの移動またはサイズ変更に合わせて編集ウィンドウを移動またはサイズ変更できます。TInplaceEdit ウィンドウは境界を持たないので，独立したコントロールのようには見えません。TInplaceEdit はデータベース対応のコントロールではありませんが，TDBGrid のようなデータベース対応のグリッドを扱うことができ，グリッドでテキストを取り出したり，記入したりすることや，マスクを使って編集コントロールのテキストを有効なデータに制限することが可能です。


TInplaceEdit プロパティ3286002

TInplaceEdit	アルファベット順	凡例

TInplaceEdit

Grid

TCustomMaskEdit からの継承

EditText

IsMasked

Text

TCustomEdit からの継承

Modified

SelLength

SelStart

SelText

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TInplaceEdit プロパティ3286003

TInplaceEdit	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

EditText

Enabled

Grid

Handle

Height

HelpContext

Hint

IsMasked

Left

Modified

Name

Owner

Parent

ParentWindow

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

Width

WindowProc


TInplaceEdit.Grid
TInplaceEdit.Grid3286004

TInplaceEdit	参照

Grid プロパティは，TInplaceEdit オブジェクトを所有および制御するグリッドオブジェクトを示します。

property  Grid: TCustomGrid;

説明

Grid プロパティは，TInplaceEdit オブジェクトが編集サービスを提供するグリッドオブジェクトが取得できます。TInplaceEdit オブジェクトは Grid プロパティを使って，編集するテキストについての情報を受け取り，関連イベントを渡すことができます。


TInplaceEdit メソッド3286005

TInplaceEdit	アルファベット順	凡例

TInplaceEdit

BoundsChanged

Create

CreateParams

DblClick

Deselect

EditCanModify

Hide

Invalidate

KeyDown

KeyPress

KeyUp

Move

PosEqual

SetFocus

UpdateContents

UpdateLoc

WndProc

TCustomMaskEdit からの継承

Clear

GetTextLen

ValidateEdit

TCustomEdit からの継承

ClearSelection

CopyToClipboard

CutToClipboard

GetSelTextBuf

PasteFromClipboard

SelectAll

SetSelTextBuf

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TInplaceEdit メソッド3286006

TInplaceEdit	オブジェクト順	凡例

Assign

BeginDrag

BoundsChanged

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClearSelection

ClientToScreen

ContainsControl

ControlAtPos

CopyToClipboard

Create

CreateParams

CreateParented

CutToClipboard

DblClick

DefaultHandler

Deselect

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EditCanModify

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetSelTextBuf

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

KeyDown

KeyPress

KeyUp

MethodAddress

MethodName

Move

NewInstance

PaintTo

PasteFromClipboard

Perform

PosEqual

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetSelTextBuf

SetTextBuf

Show

Update

UpdateContents

UpdateControlState

UpdateLoc

ValidateEdit

WndProc


TInplaceEdit.BoundsChanged
TInplaceEdit.BoundsChanged3286007

TInplaceEdit	参照

BoundsChanged メソッドは，グリッドが編集コントロールを再配置した後にウィンドウのテキスト領域でわずかなインデントを設定します。

procedure BoundsChanged; virtual;

説明

BoundsChanged メソッドは，コントロールが移動またはサイズ変更された後に編集ウィンドウを再初期化します。テキスト領域でわずかなインデントが作成されるので，エディタの内容がセルの端に密集することはありません。

BoundsChanged はプロテクトメソッドとしてエクスポーズされるので，派生オブジェクトは編集ウィンドウがサイズおよび位置を変更した場合にさらに改良を加えることができます。


TInplaceEdit.Create
TInplaceEdit.Create3286008

TInplaceEdit	参照

Create メソッドは，TInplaceEdit オブジェクトのコンストラクタです。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドはデフォルトのコンストラクタをオーバーライドして，コントロールがその存在を視覚的に示す境界を持たないようにします。


TInplaceEdit.CreateParams
TInplaceEdit.CreateParams3286009

TInplaceEdit	参照

CreateParams メソッドは，Params パラメータに渡されるウィンドウ作成パラメータレコードを初期化します。

type

  TCreateParams = record

    Caption: PChar;

    Style: Longint;

    ExStyle: Longint;

    X, Y: Integer;

    Width, Height: Integer;

    WndParent: HWND;

    Param: Pointer

    WindowClass: TWndClass;

    WinClassName: array[0..63] of Char;

  end;

procedure CreateParams( var Params: TCreateParams); override;

説明

CreateWnd メソッドは CreateParams メソッドを呼び出して，CreateWindowHandle メソッドに渡すパラメータを初期化します。TInplaceEdit オブジェクトは継承メソッドをオーバーライドして，複数行の編集コントロールを指定します。


TInplaceEdit.DblClick
TInplaceEdit.DblClick3286010

TInplaceEdit	参照

DblClick メソッドは，ユーザーが編集ウィンドウでダブルクリックしたことをグリッドに通知します。

procedure DblClick; override;

説明

DblClick メソッドは，ユーザーが編集ウィンドウでダブルクリックしたときに呼び出されます。DblClick メソッドは単純にそのイベントをグリッドに渡すだけです。グリッドはダブルクリックを解釈して応答しなければなりません。編集ウィンドウがダブルクリックに応答する必要がある場合，グリッドは TInplaceEdit のメソッドを呼び出すか，またはプロパティを設定して応答をトリガしなければなりません。


TInplaceEdit.Deselect
TInplaceEdit.Deselect3286011

TInplaceEdit	参照

Deselect メソッドは，編集ウィンドウで選択を解除します。

procedure Deselect;

説明

Deselect メソッドを呼び出すと，編集ウィンドウのすべてのテキストの選択を解除できます。Deselect メソッドは単純に選択を変更するだけで，実際のテキストは変更しません。


TInplaceEdit.EditCanModify
TInplaceEdit.EditCanModify3286012

TInplaceEdit	参照

EditCanModify メソッドは，ユーザーが Text を編集できるかどうかを示します。

function EditCanModify: Boolean; override;

説明

EditCanModify メソッドは，ユーザーが Text の値を編集しようとしたときに自動的に呼び出されます。EditCanModify メソッドはグリッドの CanEditModify メソッドを呼び出して，グリッドの現在のセルが編集できるかどうかを判定します。EditCanModify が True を返せば，ユーザーはテキストの編集を行えます。EditCanModify が False を返したときは，ユーザーはテキストの編集を行えません。


TInplaceEdit.Hide
TInplaceEdit.Hide3286013

TInplaceEdit	参照

Hide メソッドは，編集コントロールウィンドウを隠し，入力フォーカスをグリッドに移動します。

 procedure Hide;

説明

Hide メソッドは，編集ウィンドウを破棄することなく非表示にします。また，Hide メソッドは編集ウィンドウからグリッドに入力フォーカスを移動するので，非表示のウィンドウがキーボードイベントを受け取ることはありません。

グリッドは編集モードから抜けるときに Hide メソッドを呼び出して編集ウィンドウを隠します。また，グリッドはグリッドウィンドウ外で編集されているセルをスクロールする場合にも Hide メソッドを呼び出します。


TInplaceEdit.Invalidate
TInplaceEdit.Invalidate3286014

TInplaceEdit	参照

Invalidate メソッドは，編集ウィンドウおよびグリッドの対応する位置を無効にします。

procedure Invalidate;

説明

Invalidate メソッドは，編集コントロールの下にあるグリッドウィンドウの一部が編集ウィンドウと同時に無効になるようにします。これは，編集ウィンドウが隠されるか，または破棄される場合に重要で，グリッドウィンドウが編集ウィンドウで隠されていたセルを再描画できるようになります。


TInplaceEdit.KeyDown
TInplaceEdit.KeyDown3286015

TInplaceEdit	参照

KeyDown メソッドは，継承メソッドをオーバーライドして多くのキー入力をグリッドに渡します。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

procedure KeyDown(var Key: Word; Shift: TShiftState); override;

説明

ユーザーがキーを押すと，KeyDown メソッドは KeyDown イベントが編集コントロールまたはグリッドのどちらで処理されるべきかをチェックします。〔Enter〕キーは必ずグリッドに渡されます。〔F2〕キーは Deselect メソッドを呼び出して，現在の選択を解除します。ナビゲータキー入力は，その移動がテキストウィンドウ内に止まらない場合にグリッドに渡されます。たとえば，カーソルがすでに編集ウィンドウの左端にあるときにユーザーが「Left」と入力すると，そのキー入力はフォーカスを 1 つ前のセルに移動するグリッドに渡されます。カーソルが行の中央にある場合，そのキー入力は編集ウィンドウによって処理され，編集ウィンドウは 1 文字だけカーソルを左に移動します。

KeyDown メソッドは，編集コントロールで継承された KeyDown メソッドを呼び出す前に，（もしあれば）グリッドの OnKeyDown イベントハンドラを呼び出します。


TInplaceEdit.KeyPress
TInplaceEdit.KeyPress3286016

TInplaceEdit	参照

KeyPress メソッドは，継承メソッドをオーバーライドしてグリッドが最初にキー入力を処理するようにします。

procedure KeyPress(var Key: Char); override;

説明

KeyPress メソッドはグリッドにキー入力を処理させ，グリッドが処理できないキー入力だけを処理します。キー入力の処理後にグリッドが編集モードにない場合，KeyPress メソッドはそのキー入力を破棄します。KeyPress メソッドは〔Enter〕キーを処理し，継承メソッドを呼び出してほかの処理されていないすべてのキー入力を処理します。

〔Enter〕キーを押すと，KeyPress メソッドはすべてのテキストを選択し，すでに選択されている場合は，すべてのテキストの選択を解除します。


TInplaceEdit.KeyUp
TInplaceEdit.KeyUp3286017

TInplaceEdit	参照

KeyUp メソッドは，継承メソッドをオーバーライドしてすべての KeyUp イベントをグリッドに渡します。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

procedure KeyUp(var Key: Word; Shift: TShiftState); override;

説明

インプレース編集コントロールは KeyUp イベントを処理しません。単純にイベントをグリッドに渡すだけです。グリッドはそのイベントを処理する場合も，処理しない場合もあります。


TInplaceEdit.Move
TInplaceEdit.Move3286018

TInplaceEdit	参照

Move メソッドは，編集ウィンドウの位置を変更し，その内容を再描画します。

procedure Move(const Loc: TRect);

説明

グリッドは Move メソッドを呼び出し，対応するセルが移動またはサイズ変更された場合に指定の四角形の領域に編集ウィンドウを移動します。Loc の位置はグリッドのクライアント領域に対応します。


TInplaceEdit.PosEqual
TInplaceEdit.PosEqual3286019

TInplaceEdit	参照

PosEqual メソッドは，編集ウィンドウのサイズと位置が Rect と一致するかどうかを示します。

function PosEqual(const Rect: TRect): Boolean;

説明

PosEqual メソッドを呼び出すと，Rect がグローバル座標で示している特定の四角形に編集ウィンドウがあるかどうかがわかります。PosEqual メソッドを使って，セルの境界となっている四角形をチェックすることで，インプレース編集コントロールがグリッド内の特定のセルを表しているかを判断できます。


TInplaceEdit.SetFocus
TInplaceEdit.SetFocus3286020

TInplaceEdit	参照

SetFocus メソッドは，編集ウィンドウが表示されていれば，そこに入力フォーカスを設定します。

procedure SetFocus;

説明

SetFocus メソッドを呼び出すと，キーボードイベントを編集ウィンドウに渡すことができます。Hide メソッドの呼び出しによってウィンドウが隠されている場合，フォーカスはウィンドウに設定されません。


TInplaceEdit.UpdateContents
TInplaceEdit.UpdateContents3286021

TInplaceEdit	参照

UpdateContents メソッドは EditMask および Text プロパティをグリッドで指定された値に設定します。

procedure UpdateContents; virtual;

説明

UpdateContents メソッドは，グリッドの GetEditMask および GetEditText メソッドを呼び出し，それに応じて EditMask および Text プロパティを設定します。UpdateContents メソッドを使うと，グリッドは特定のセルの内容を持つインプレース編集コントロールを起動でき，また特定のセルで有効な入力だけに制限するためにマスクを使うことができます。


TInplaceEdit.UpdateLoc
TInplaceEdit.UpdateLoc3286022

TInplaceEdit	参照

UpdateLoc メソッドは，編集ウィンドウの位置を変更しますが，内容は再描画しません。

 procedure UpdateLoc(const Loc: TRect);

説明

グリッドは UpdateLoc メソッドを呼び出して，グリッドが移動した場合に編集ウィンドウを移動します。Move メソッドとは違って，UpdateLoc メソッドでは編集ウィンドウの内容が再描画されません。


TInplaceEdit.WndProc
TInplaceEdit.WndProc3286023

TInplaceEdit	参照

WndProc メソッドは，継承メソッドを補足して，いくつかの Windows メッセージに対する特別な処理を追加します。

procedure WndProc(var Message: TMessage); override;

説明

Delphi コントロールの場合，WndProc がメッセージを受け取る最初のメソッドです。

TInplaceEdit オブジェクトの WndProc メソッドはフォーカスイベントをグリッドに渡します。このメソッドは，ほかのすべての Windows メッセージでは継承メソッドを呼び出します。WndProc メソッドは，ダブルクリックの時間間隔内で最初のクリックがグリッドによって受け取られた場合にマウスクリックをダブルクリックに変換します。


スコープ3286024

protected

published

読み出し／書き込み

読み出し専用


スコープ3286025

protected


継承3286026

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomEdit

TCustomMaskEdit


TInplaceEdit 例3286027

TInplaceEdit


TIntegerField
TIntegerField3287001

継承	プロパティ	メソッド	イベント	参照	例

TIntegerField オブジェクトはデータセット内の符号付き 32 ビット整数項目を表します。

ユニット

db

説明

整数項目は -2,147,483,648 から 2,147,483,647 の範囲の値を保持でき，値の大きな符号付き整数値を保持するのによく使われます。

TIntegerField オブジェクトは，整数値と他のデータ形式との変換，および項目に格納できる整数値の範囲の制限のための新しいプロパティを導入します。TNumericField の下位オブジェクトとして，TIntegerField オブジェクトはデータベースの数値項目の値およびプロパティの管理に便利なプロパティ，メソッド，およびイベントを数多く用意しています。

TIntegerField オブジェクトは整数を表す項目型 TAutoIncField，TSmallIntField，および TWordField の直接の上位オブジェクトです。


TIntegerField プロパティ3287002

TIntegerField	アルファベット順	凡例

TIntegerField

AsFloat

AsInteger

AsString

AsVariant

DataSize

MaxValue

MinValue

Value

TNumericField からの継承

DisplayFormat

EditFormat

TField からの継承

Alignment

AsBoolean

AsCurrency

AsDateTime

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIntegerField プロパティ3287003

TIntegerField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayFormat

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditFormat

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

MaxValue

MinValue

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TIntegerField.AsFloat
TIntegerField.AsFloat3287004

TIntegerField	参照

AsFloat プロパティは，整数項目の値と浮動小数点値の間の変換を行います。

property AsFloat: Double;

説明

AsFloat プロパティは次の処理に使います。

・	整数値を浮動小数点変数に代入する

・	浮動小数点値を整数値に丸めて整数項目に代入する

次のコードは浮動小数点値を 12 に丸めて整数項目値に代入します。

MyIntegerField.AsFloat := 12.23;

整数値を浮動小数点値に代入するには，次のようなコードを使います。

FloatVariable := MyIntegerField.AsFloat;

項目に代入された値が MinValue および MaxValue プロパティで指定された範囲の外である場合，EDatabaseError 例外が生成されます。


TIntegerField.AsInteger
TIntegerField.AsInteger3287005

TIntegerField	参照

AsInteger プロパティは，整数項目の値を 32 ビット整数として取得または設定します。

property AsInteger: Longint;

説明

AsInteger プロパティは，整数項目の値を 32 ビット整数として扱うことができます。整数項目コンポーネントは値を 32 ビット整数として格納および処理するので，AsInteger は Value プロパティと同じです。

Longint 型の値は，整数項目の保存形式が 32 ビット整数なので変換の必要はありません。TIntegerField の下位オブジェクトが他の型の整数項目の場合，物理的なデータベース項目の値を 32 ビット整数に変換します。

項目に代入された値が MinValue および MaxValue プロパティで指定された範囲の外である場合，EDatabaseError 例外が生成されます。


TIntegerField.AsString
TIntegerField.AsString3287006

TIntegerField	参照

AsString プロパティは，整数項目の値と文字列値の間の変換を行います。

property AsString: string;

説明

AsString プロパティは次の処理に使います。

・	整数項目の値を文字列変数に代入する

・	文字列値を整数項目に代入する

次のコードは文字列値を整数項目の値に代入します。

MyIntegerField.AsString := �27�;

整数項目の値を文字列に代入するには，次のようなコードを使います。

NewString := MyIntegerField.AsString;

項目に代入された文字列値が有効な整数値を表さない場合，EDatabaseError 例外が生成されます。また，項目に代入された文字列が MinValue および MaxValue プロパティで指定された範囲の整数値に変換されない場合，EDatabaseError 例外が生成されます。


TIntegerField.AsVariant
TIntegerField.AsVariant3287007

TIntegerField	参照

AsVariant プロパティは，整数項目の値とバリアント値の間の変換を行います。

property AsVariant: Variant;

説明

AsVariant プロパティは次の処理に使います。

・	整数項目の値をバリアント値に代入する

・	バリアント値を整数項目に代入する

バリアントは，項目型が不明で項目の値を変換するのに他の As... プロパティを使えないときに使うと便利です。

また，項目に代入された値が有効な整数値に変換されなかったり，MinValue および MaxValue プロパティで指定された範囲の外にある場合，EDatabaseError 例外が生成されます。


TIntegerField.DataSize
TIntegerField.DataSize3287008

TIntegerField	参照

DataSize プロパティは，ネイティブなデータベース形式で整数項目の値を格納するのに必要なメモリの大きさです。

property DataSize: Word;

説明

DataSize プロパティは，整数項目コンポーネントの値を格納するのに何バイト必要かを取得できます。GetData や SetData メソッドでこのプロパティを使うと，必要なバッファの大きさを決めることができます。

整数項目の DataSize は常に 4 です。TIntegerField の下位オブジェクト（TSmallintField など）の中には，データベース項目の DataSize の値が 4 より小さいものもあります。


TIntegerField.MaxValue
TIntegerField.MaxValue3287009

TIntegerField	参照

MaxValue プロパティは，整数項目の最大値を制限します。

property MaxValue: Longint;

説明

MaxValue プロパティは，項目に入力できる値の最大値を取得および設定できます。MaxValue プロパティよりも大きい値が入力された場合，EDatabaseError 例外が生成されます。

MaxValue の値が 0 の場合，ネイティブなデータベース型の最大値が整数項目の最大値になります。32 ビット整数項目の場合，この値は 2147483647 です。


TIntegerField.MinValue
TIntegerField.MinValue3287010

TIntegerField	参照

MinValue プロパティは，整数項目の最小値を制限します。

property MinValue: Longint;

説明

MinValue プロパティは，項目に入力できる値の最小値を取得および設定できます。MinValue プロパティよりも小さい値が入力された場合，EDatabaseError 例外が生成されます。

MinValue の値が 0 の場合，ネイティブなデータベース型の最小値が整数項目の最小値になります。32 ビット整数項目の場合，この値は -2147483648です。


TIntegerField.Value
TIntegerField.Value3287011

TIntegerField	参照

Value プロパティは，整数項目の実際のデータです。

property Value: Longint;

説明

Value プロパティは，整数項目のデータを直接設定できます。Value プロパティを使うのは，AsInteger プロパティを使うのと同じです。Value プロパティは，項目コンポーネントが 32 ビット整数項目であるとわかっているときに使います。AsInteger プロパティは，汎用項目コンポーネントを扱うときに使います。


TIntegerField イベント3287012

TIntegerField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TIntegerField イベント3287013

TIntegerField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TIntegerField メソッド3287014

TIntegerField	アルファベット順

TIntegerField

Create

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIntegerField メソッド3287015

TIntegerField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TIntegerField.Create
TIntegerField.Create3287016

TIntegerField	参照

Create メソッドは，TIntegerField のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，TIntegerField オブジェクトを作成および初期化できます。継承コンストラクタを呼び出した後で，Create メソッドは DataType プロパティの値を ftInteger に，MinValue プロパティの値を -2147483648 に，MaxValue を 2147483647 にそれぞれ設定します。

Create メソッドを直接呼び出す必要はほとんどありません。データセット内のすべての整数項目について，整数項目コンポーネントは自動的に初期化されるからです。


スコープ3287017

published

読み出し／書き込み

読み出し専用


スコープ3287018

published


継承3287019

TObject

TPersistent

TComponent

TField

TNumericField


TIntegerField 例3287020

TIntegerField


TInterfacedObject
TInterfacedObject3288001

継承	プロパティ	メソッド

TInterfacedObject は IUnknown インターフェースを実現するクラスで，単純な COM 互換クラスの基本クラスとして使うことができます。TInterfacedObject は IUnknown メソッドを実現するので，COM 互換クラスにとって有用なクラスです。

ユニット

system

説明

TInterfacedObject は，クラスファクトリまたは登録された CLSID を持っていない単純な COM クラスの基本クラスとして使われます。つまり，コンストラクタを直接呼び出して TInterfacedObject をインスタンス化しなければなりません。

TInterfacedObject は IUnknown のメソッドを実装するので，インターフェースを実現する便利な基本クラスとして機能します。TInterfacedObject 型として宣言された変数は，実行時に下位クラスのインスタンスをその変数に割り当てることができる動的結合を持ちます。これは TInterfacedObject が QueryInterface を実現するからです。QueryInterface は実行時に呼び出され，インスタンス化したオブジェクトが要求されたインターフェースをサポートしているかどうかを問い合わせます。オブジェクトがサポートしていれば，下位オブジェクトが変数に割り当てられます。基本クラス型として宣言された変数に下位の COM オブジェクトを同じように割り当てる場合，その基本クラスが IUnKnown を実現しなければ，コンパイル時にエラーが発生します。

TInterfacedObject のクラスファクトリはありません。

IUnknown の実装済みメソッド

QueryInterface および AddRef，Release


TInterfacedObject のプロパティ3288002

TInterfacedObject	アルファベット順	凡例

TInterfacedObject

RefCount


TInterfacedObject のプロパティ3288003

TInterfacedObject	オブジェクト順	凡例

RefCount


TInterfacedObject.RefCount
TInterfacedObject.RefCount3288004

TInterfacedObject

RefCount プロパティは，現在 COM オブジェクトに依存しているインターフェースポインタの数についての参照カウントを保持します。

property RefCount: Integer;

説明

RefCount プロパティは，実質的にオブジェクトの寿命を定義します。RefCount が 0 になると，オブジェクトは破棄されます。

RefCount は実現された IUnknown メソッドの AddRef を呼び出すとインクリメントされ，実現された IUnknown メソッドの Release を呼び出すとデクリメントされます。


TInterfacedObject のメソッド3288005

TInterfacedObject	アルファベット順

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TInterfacedObject のメソッド3288006

TInterfacedObject	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


アクセス種別3288007

読み出し専用


継承3288008

TObject


TInterfacedObject の例3288009

TInterfacedObject


TISAPIApplication
TISAPIApplication3289001

継承	プロパティ	メソッド	参照

TISAPIApplication オブジェクトは，ISAPI サーバーまたは NSAPI サーバーのアプリケーションをカプセル化します。

ユニット

isapiapp

説明

TISAPIApplication は ISAPI サーバーまたは NSAPI サーバーのアプリケーションの基本動作を提供します。HTTP サーバーは，HTTP の要求メッセージを受け取ると TISAPIApplication のメソッドを呼び出します。TISAPIApplication は要求メッセージを管理するためにスレッドを作成し，そのスレッドのためにウェブモジュールの新しいインスタンスを作成するか，前の応答が送られた後で非アクティブになった作成済みのインスタンスを再利用します。

TISAPIApplication は，要求メッセージとそれに対する応答を表す TISAPIRequest オブジェクトおよび TISAPIResponse オブジェクトを作成し，応答が入力されるようにそれらをディスパッチャに渡してから， TWebActionItem で送られていない場合に応答を送ります。

各 ISAPI サーバープロジェクトは自動的に TISAPIApplication 型の Application 変数をアプリケーションのインスタンスとして宣言します。この宣言によって，ISAPIApp ユニットがプロジェクトファイルの使用リストで宣言されている場合に Forms ユニットで宣言された Application 変数はオーバーライドされます。すべての ISAPI サーバーのアプリケーションには ISAPIApp ユニットが入っていなければなりません。

CGI サーバーを操作する場合は TCGIApplication オブジェクトを使ってください。


TISAPIApplication プロパティ3289002

TISAPIApplication	アルファベット順	凡例

TWebApplication からの継承

ActiveCount

CacheConnections

InactiveCount

MaxConnections

Title

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TISAPIApplication プロパティ3289003

TISAPIApplication	オブジェクト順	凡例

ActiveCount

CacheConnections

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

InactiveCount

MaxConnections

Name

Owner

Tag

Title

VCLComObject


TISAPIApplication メソッド3289004

TISAPIApplication	アルファベット順

TISAPIApplication

GetExtensionVersion

HttpExtensionProc

TerminateExtension

TWebApplication からの継承

Create

CreateForm

Destroy

Initialize

Run

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TISAPIApplication メソッド3289005

TISAPIApplication	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateForm

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetExtensionVersion

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

HttpExtensionProc

InheritsFrom

Initialize

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

Run

SafeCallException

TerminateExtension


TISAPIApplication.GetExtensionVersion
TISAPIApplication.GetExtensionVersion3289006

TISAPIApplication	参照

GetExtensionVersion メソッドは，アプリケーションの名前とバージョン番号を返します。

THSE_VERSION_INFO = packed record

    dwExtensionVersion: DWORD;

    lpszExtensionDesc: array [0..HSE_MAX_EXT_DLL_NAME_LEN-1] of Char;

  end;

function GetExtensionVersion(var Ver: THSE_VERSION_INFO): BOOL;

説明

HTTP サーバーはアプリケーションの名前とバージョン番号を取得するために GetExtensionVersion を呼び出します。GetExtensionVersion はランタイムライブラリに入っている HTTP 関数のバージョン番号と ISAPI アプリケーションオブジェクトの Title プロパティを返します。


TISAPIApplication.HttpExtensionProc
TISAPIApplication.HttpExtensionProc3289007

TISAPIApplication	参照

HttpExtensionProc メソッドは，HTTP 要求メッセージに応答します。

TEXTENSION_CONTROL_BLOCK = packed record

    cbSize: DWORD;                    // 構造体のサイズ

    dwVersion: DWORD;                 // 仕様のバージョン情報

    ConnID: HCONN;                    // 変更されないコンテキスト番号

    dwHttpStatusCode: DWORD;          // HTTP ステータスコード

    lpszLogData: array [0..HSE_LOG_BUFFER_LEN-1] of Char; // DLL ログ情報

    lpszMethod: PChar;                // REQUEST_METHOD

    lpszQueryString: PChar;           // QUERY_STRING

    lpszPathInfo: PChar;              // PATH_INFO

    lpszPathTranslated: PChar;        // PATH_TRANSLATED

    cbTotalBytes: DWORD;              // クライアントから指定された合計バイト数

    cbAvailable: DWORD;               // 利用可能なバイト数

    lpbData: Pointer;                 // cbAvailable バイトへのポインタ

    lpszContentType: PChar;           // クライアントデータの Content 型

    GetServerVariable: TGetServerVariableProc;

    WriteClient: TWriteClientProc;

    ReadClient: TReadClientProc;

    ServerSupportFunction: TServerSupportFunctionProc;

  end;

function HttpExtensionProc(var ECB: TEXTENSION_CONTROL_BLOCK): DWORD;

説明

HTTP サーバーは HTTP の要求メッセージを受け取ると HttpExtensionProc を呼び出します。HttpExtensionProc はその HTTP の要求メッセージに対して TISAPIRequest オブジェクトと TISAPIResponse オブジェクトを作成し，応答が入力され送られるように HandleRequest を呼び出します。次に HttpExtensionProc はその要求と応答メソッドを解放します。

応答が入力され送られると，HttpExtensionProc は HSE_STATUS_SUCCESS を返します。それ以外は HSE_STATUS_ERROR を返します。


TISAPIApplication.TerminateExtension
TISAPIApplication.TerminateExtension3289008

TISAPIApplication

TerminateExtension メソッドは，True を返します。

function TerminateExtension(dwFlags: DWORD): BOOL;

説明

HTTP サーバーは ISAPI アプリケーションを終了したいときに TerminateExtension を呼び出します。TerminateExtension は常に True を返してサーバーの終了を許可します。


スコープ3289009

published

読み出し／書き込み

読み出し専用


継承3289010

TObject

TPersistent

TComponent

TWebApplication


TISAPIApplication 例3289011

TISAPIApplication


TISAPIRequest
TISAPIRequest3290001

継承	プロパティ	メソッド	参照

TISAPIRequest コンポーネントは，サーバーアプリケーション DLL に渡されるクライアント要求情報を表します。

ユニット

isapiapp

説明

TISAPIRequest コンポーネントを使うと，サーバーアプリケーション DLL に対するクライアント要求を知ることができます。

ISAPI アプリケーションは，クライアントの要求をキャプチャするために TISAPIRequest オブジェクトを作成します。TISAPIRequest オブジェクトのプロパティは，Web サーバーから取得します。ISAPI アプリケーションは，TISAPIRequest オブジェクトを使って，それに対応する TISAPIResponse オブジェクトを作成します。次に，アプリケーションの TWebDispatcher は，TISAPIRequest オブジェクトの URL のパス部分を処理する TWebActionItem を呼び出します。


TISAPIRequest プロパティ3290002

TISAPIRequest	アルファベット順	凡例

TISAPIRequest

Accept

Authorization

CacheControl

Connection

Content

ContentEncoding

ContentLength

ContentType

ContentVersion

Cookie

Date

DerivedFrom

ECB

Expires

From

Host

IfModifiedSince

Method

PathInfo

PathTranslated

ProtocolVersion

Query

Referer

RemoteAddr

RemoteHost

ScriptName

ServerPort

Title

URL

UserAgent

TWebRequest からの継承

ContentFields

CookieFields

MethodType

QueryFields


TISAPIRequest プロパティ3290003

TISAPIRequest	オブジェクト順	凡例

Accept

Authorization

CacheControl

Connection

Content

ContentEncoding

ContentFields

ContentLength

ContentType

ContentVersion

Cookie

CookieFields

Date

DerivedFrom

ECB

Expires

From

Host

IfModifiedSince

Method

MethodType

PathInfo

PathTranslated

ProtocolVersion

Query

QueryFields

Referer

RemoteAddr

RemoteHost

ScriptName

ServerPort

Title

URL

UserAgent


TISAPIRequest.Accept
TISAPIRequest.Accept3290004

TISAPIRequest	参照

Accept プロパティは，HTTP 要求メッセージの Accept ヘッダーの値です。

property Accept: string;

説明

Accept プロパティを読み出すと，Web クライアントが応答メッセージを受取れる媒体の種類がわかります。すべての要求メッセージに Accept ヘッダーがあるわけではありません。Accept プロパティが設定されていない場合は，すべての媒体の種類が受取り可能になります。

Accept ヘッダーは通常，応答メッセージを受け取れる望ましい媒体が限られていることを示しています。たとえば，オーディオ応答を要求するクライアントは，Accept プロパティに次の文字列を設定した TISAPIRequest オブジェクトを作成します。

audio/*; q=0.2, audio/basic

この要求は，望ましい媒体の種類がオーディオ／ベーシックであるが，性能が 80% ダウンした後に利用して最善なのであれば，どんなオーディオ媒体でもかまわないということを示しています。

Accept ヘッダーの形式については，現在のインターネット規格文書を参照してください。


TISAPIRequest.Authorization
TISAPIRequest.Authorization3290005

TISAPIRequest	参照

Authorization プロパティは，HTTP 要求メッセージの Authorization ヘッダーの値です。

property Authorization: string;

説明

Authorization プロパティを読み出すと，要求メッセージを送ったクライアントが正しい認証情報を提供したかどうかがわかります。Authorization を使うと，Web アプリケーションは URL プロパティで指定したリソースへのアクセスを制限できます。

HTTP 認証スキームについての詳細は，インターネット規格文書を参照してください。


TISAPIRequest.CacheControl
TISAPIRequest.CacheControl3290006

TISAPIRequest	参照

CacheControl プロパティは，HTTP 要求メッセージの Cache-Control ヘッダーの値を示します。

property CacheControl: string;

説明

CacheControl プロパティを読み出すと，要求／応答チェーンにおいてすべてのキャッシュメカニズムに従わなければならない Web クライアント疑似命令がすべてわかります。要求の CacheControl 疑似命令を，対応する応答に適用する必要はありません。

HTTP 1.1 規格では，次の CacheControl 疑似命令を定義しています。

値	意味

no-cache	要求をキャッシュできない。Web サーバーは要求を確認してから TISAPIRequest を作成する

no-store	要求に微妙な情報があり，バックアップデープなどの永久的媒体に格納できない。この要求がファイル内に一時的に保存されている場合は，そのファイルを削除しなければならない

max-age=ss	要求は，ss 秒以上，古いものであれば無効とされる。Expires プロパティの方が制限時間が短いとしても，その Expires プロパティよりもこの疑似命令の方が優先する。Web サーバーが無効な要求を確認した後，TISAPIRequest オブジェクトを作成する

max-stale or max-stale=ss	クライアントは，満了時間を超えた応答を受けとる用意がある。オプションの max-stale 疑似命令で，満了時間を何秒，超過してもよいかを示す

min-fresh=ss	クライアントは，ss 秒以内に満了になる応答を受け取らない


TISAPIRequest.Connection
TISAPIRequest.Connection3290007

TISAPIRequest	参照

Connection プロパティは，HTTP 要求メッセージの Connection ヘッダーの値を示します。

property Connection: string;

説明

Connection プロパティを読み出すと，Web クライアントが要求するサーバーアプリケーションとの接続オプションがわかります。HTTP 1.1 規格では，Connection ヘッダーに 1 つしか値を指定しません。このプロパティの値が close の場合，応答処理完了後，接続を切断しないといけません。


TISAPIRequest.Content
TISAPIRequest.Content3290008

TISAPIRequest	参照

Content プロパティは，HTTP 要求メッセージのまだ分解されていない内容を表します。

property Content: stringe;

説明

Content プロパティを使うと，サーバーに情報を送る HTTP 要求メッセージの内容を読み出すことができます。このプロパティの値は，HTTP 要求メッセージの Method によって決まります。Method が POST のとき，Content プロパティはまだ分解されていない文字列で，関連項目とともに登録される値を示します。Method が PUT のとき，Content プロパティは，URL プロパティによって指定された URL を置換する値になります。

注意

Method が POST の場合，分解済みの登録要求は ContentFields プロパティで得られます。


TISAPIRequest.ContentEncoding
TISAPIRequest.ContentEncoding3290009

TISAPIRequest	参照

ContentEncoding プロパティは，HTTP 要求メッセージの Content-Encoding ヘッダーの値を示します。

property ContentEncoding: string;

説明

ContentEncoding プロパティを読み出すと，HTTP 要求の Content に適用されたコード化メカニズムがある場合，それを知ることができます。コード化メカニズムは，Web クライアントが適用した順番で並び，コンマで区切られています。一般にこのプロパティは，拡張 ASCII 文字をネット上で転送するための圧縮方式ないしコード化方式を示しています。

ContentEncoding メカニズムを逆に使用すると，Content プロパティの値を復元して，ContentType プロパティが指定するフォームに設定できます。


TISAPIRequest.ContentLength
TISAPIRequest.ContentLength3290010

TISAPIRequest	参照

ContentLength プロパティは，HTTP 要求メッセージの Content-Length ヘッダーの値を示します。

property ContentLength: Integer;

説明

ContentLength プロパティを読み出すと，Content プロパティの長さがわかります。ContentType がテキストでも HTML でもないとき，ContentLength プロパティで Content プロパティの末尾を知ることができます。ContentLength プロパティがゼロの場合，Content プロパティの長さはわかりません。要求にまったく Content がない場合もあれば，Web クライアントが Content プロパティの長さを知らなかった場合もあるからです。

注意

分割転送によって Content プロパティが渡されたとき，Content プロパティの長さは ContentLength 未満の場合があります。


TISAPIRequest.ContentType
TISAPIRequest.ContentType3290011

TISAPIRequest	参照

ContentType プロパティは，HTTP 要求メッセージの Content-Type ヘッダーの値を示します。

property ContentType: string;

説明

ContentType プロパティを読み出すと，HTTP 要求メッセージの Content の媒体タイプがわかります。このプロパティは，Type/SubType フォームの文字列です。

ほとんどの HTTP 要求はまったく Content を要求しません。これを要求する Method を持った要求は大部分，ContentType がテキストか HTML です。ただし，サーバー固有の Method 値を持った HTTP 要求は，その要求に適したどんな媒体でも使用できます。


TISAPIRequest.ContentVersion
TISAPIRequest.ContentVersion3290012

TISAPIRequest	参照

ContentVersion プロパティは，HTTP 要求メッセージの Content-Version ヘッダーの値を示します。

property ContentVersion: string;

説明

ContentVersion プロパティを読み出すと，HTTP 要求メッセージの Content のバージョンがわかります。ほとんどの HTTP 要求はまったく Content を要求しません。Method が Content の値を要求するときは，ContentVersion に内容のソースのバージョンを設定できます。ContentVersion の形式は要求の ContentType によって決まります。


TISAPIRequest.Cookie
TISAPIRequest.Cookie3290013

TISAPIRequest	参照

Cookie プロパティは，HTTP 要求メッセージの Cookie ヘッダーの値を示します。

property Cookie: string;

説明

Cookie プロパティを使うと，Web クライアント要求内に指定されている「cookie」文字列を読み出すことができます。cookie 文字列を使えばどんな情報でもコード化できますが，この文字列は一般に Web アプリケーション内の状態情報を追跡するのに使用されます。Cookie プロパティは Cookie ヘッダーの分解されていない値です。Cookie ヘッダーには複数の項目をセミコロン（;）で区切って設定できます。項目単位で Cookie ヘッダーを処理するには，CookieFields プロパティを使います。


TISAPIRequest.Date
TISAPIRequest.Date3290014

TISAPIRequest	参照

Date プロパティは，HTTP 要求メッセージの Date ヘッダーの値を示します。

property Date: TDateTime;

説明

Date プロパティを読み出すと，HTTP 要求メッセージが発生した日付と時間がわかります。このプロパティを使うと，要求の Content がまだ有効かどうかがわかります。このプロパティの値は，Web クライアントが設定した時間単位から，Windows のコントロールパネルで指定される地方時間に変換されます。

たとえば，HTTP 要求メッセージの MethodType 指定が mtPost で，Date プロパティが登録中の項目の最近値より古い場合，サーバーアプリケーションは，もっと新しい値に書き換えるのではなく，エラーを示すステータスコードを返します。

Date プロパティは TDateTime 型で表わされます。TDateTime の整数部は 1899 年 12 月 30 日からの経過日数で，小数部はその日の経過時間です。


TISAPIRequest.DerivedFrom
TISAPIRequest.DerivedFrom3290015

TISAPIRequest	参照

DerivedFrom プロパティは，HTTP 要求メッセージの Derived-From ヘッダーの値を示します。

property DerivedFrom: string;

説明

DerivedFrom プロパティを読み出すと，Content の値が発生した URI がわかります。このプロパティが意味を持つのは，要求に Content プロパティがあり，かつその Content プロパティが当該 Web クライアントから発生していないときだけです。


TISAPIRequest.ECB
TISAPIRequest.ECB3290016

TISAPIRequest	参照

ECB プロパティは，Web サーバーと通信するためにサーバーアプリケーションが使用する拡張コントロールブロック構造です。

TEXTENSION_CONTROL_BLOCK = packed record

    cbSize: DWORD;                    // この構造体のサイズ

    dwVersion: DWORD;                 // この仕様のバージョン情報

    ConnID: HCONN;                    // 変更されないコンテキスト番号

    dwHttpStatusCode: DWORD;          // HTTP ステータスコード

    lpszLogData: array [0..HSE_LOG_BUFFER_LEN-1] of Char; // ログ情報

    lpszMethod: PChar;                // REQUEST_METHOD

    lpszQueryString: PChar;           // QUERY_STRING

    lpszPathInfo: PChar;              // PATH_INFO

    lpszPathTranslated: PChar;        // PATH_TRANSLATED

    cbTotalBytes: DWORD;              // クライアントから指定された合計バイト数

    cbAvailable: DWORD;               // 利用可能なバイト数

    lpbData: Pointer;                 // cbAvailable バイトへのポインタ

    lpszContentType: PChar;           // クライアントデータの Content 型

    GetServerVariable: TGetServerVariableProc;

    WriteClient: TWriteClientProc;

    ReadClient: TReadClientProc;

    ServerSupportFunction: TServerSupportFunctionProc;

  end;

PEXTENSION_CONTROL_BLOCK = ^TEXTENSION_CONTROL_BLOCK;

property ECB: PEXTENSION_CONTROL_BLOCK;

説明

ECB プロパティを読み出すと，クライアント要求メッセージを表すためにサーバーアプリケーション DLL が使用する拡張コントロールブロックに直接アクセスできます。ヘッダーの各項目は GetFieldByName メソッドを使って読み出せるので，ほとんどのアプリケーションは ECB プロパティを使う必要はありません。


TISAPIRequest.Expires
TISAPIRequest.Expires3290017

TISAPIRequest	参照

Expires プロパティは，HTTP 要求メッセージの Expires ヘッダーの値を示します。

property Expires: TDateTime;

説明

Expires プロパティを使うと，要求が「古く無効なもの」かどうかがわかります。このプロパティは，要求が無効になる日付と時間を表しています。このプロパティの値は，Web クライアントが設定した時間の単位から，Windows のコントロールで示されるような地方時間に変換されます。

要求に max-age 疑似命令付きの CacheControl がある場合，この max-age 疑似命令で Expires プロパティの値がオーバーライドされます。

Expires プロパティは TDateTime 型で表わされます。TDateTime の整数部は 1899 年 12 月 30 日からの経過日数で，小数部はその日の経過時間です。


TISAPIRequest.From
TISAPIRequest.From3290018

TISAPIRequest	参照

From プロパティは，HTTP 要求メッセージの From ヘッダーの値を示します。

property From: string;

説明

From プロパティを読み出すと，Web クライアントから HTTP 要求メッセージを送った人のインターネット e-mail アドレスがわかります。このプロパティの値は，ロギング用に使ったり，あるいは問題が発生した場合に要求の発信者と連絡するために使ったりできます。


TISAPIRequest.Host
TISAPIRequest.Host3290019

TISAPIRequest	参照

Host プロパティは，HTTP 要求メッセージの Host ヘッダーの値を示します。

property Host: string;

説明

Host プロパティを読み出すと，要求されたリソースのインターネット上のホストとポート番号がわかります。たとえば，クライアントの要求が次の URL を指定しているとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

Host プロパティの値は次のものになります。

www.TSite.com

Host プロパティの値を使えば，内部的にあいまいな URL を区別できます。たとえば，1 つの IP アドレスに複数のホスト名があるサーバーのルート（/）URL などを区別できます。


TISAPIRequest.IfModifiedSince
TISAPIRequest.IfModifiedSince3290020

TISAPIRequest	参照

IfModifiedSince プロパティは，HTTP 要求メッセージの If-Modified-Since ヘッダーの値を示します。

property IfModifiedSince: TDateTime;

説明

MethodType が mtGet である要求の IfModifiedSince プロパティを読み出すと，その要求が条件付き要求かどうかがわかります。Web クライアントが要求した情報が IfModifiedSince プロパティによって指定された時間以降，変更されていない場合，応答メッセージは，URL プロパティによって示される情報ではなく，変更なしエラーとなるはずです。

IfModifiedSince プロパティの値は，Web クライアントのクロックではなく，Windows コントロールパネル内に示されたローカルクロックによって指定されます。

Modified プロパティは TDateTime 型で表わされます。TDateTime の整数部は 1899 年 12 月 30 日からの経過日数で，小数部はその日の経過時間を示します。


TISAPIRequest.Method
TISAPIRequest.Method3290021

TISAPIRequest	参照

Method プロパティは，HTTP 要求メッセージの Method ヘッダーの値を示します。

property Method: string;

説明

Method プロパティを読み出すと，Web クライアントが要求したメソッドがわかります。HTTP 1.1 規格では，以下の値を定義しています。

値	意味

OPTIONS	利用できる通信オプションに関する情報を求める

GET	URL プロパティによって示される情報を求める

HEAD	HTTP 応答のプロパティ情報（応答の内容以外）を求める

POST	サーバーアプリケーションに，Content プロパティ内のデータを登録するよう求める

PUT	サーバーアプリケーションに，URL プロパティが示すリソースを Content プロパティ内のデータで置き換えるよう求める

DELETE	サーバーアプリケーションに，URL プロパティが示すリソースを削除または隠すよう求める

TRACE	要求が受取られたかどうかを確認するために，サーバーアプリケーションにループバックを返信するよう求める

Method プロパティは，Web クライアントがサーバーに要求した他のメソッドを示すことがあります。このプロパティが TISAPIResponse オブジェクトの Allow プロパティと一致しない場合，その要求は処理できません。

MethodType プロパティは，Method プロパティの値が GET，HEAD，POST，PUT，あるいは他の文字列のいずれかであることを示します。できる限り，Method プロパティではなく MethodType プロパティを使って，文字列比較の負荷を減らしてください。

注意

HTTP アプリケーションは，メソッドのすべての種類に対処できる必要はありません。ただし，Get メソッドと HEAD メソッドの要求には応答しなければなりません。


TISAPIRequest.PathInfo
TISAPIRequest.PathInfo3290022

TISAPIRequest	参照

PathInfo プロパティは，HTTP 要求メッセージ内に指定された URL のパス情報（存在する場合）の値を示します。

property PathInfo: string;

説明

PathInfo プロパティを読み出すと，要求のターゲットが存在するサーバーマシン上のパスがわかります。たとえば，次の URL があるとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

/gallery.dll が Web サーバーアプリケーションとすると，PathInfo は次のようになります。

/mammals

TWebDispatcher オブジェクトは，PathInfo を使って，要求メッセージを処理する適切な TWebActionItem を決定します。


TISAPIRequest.PathTranslated
TISAPIRequest.PathTranslated3290023

TISAPIRequest	参照

PathTranslated プロパティは，PathInfo プロパティの値をフルパスに変換した値です。

property PathTranslated: string;

説明

PathTranslated を使って，HTTP 応答メッセージ内で要求ターゲットの場所を参照します。


TISAPIRequest.ProtocolVersion
TISAPIRequest.ProtocolVersion3290024

TISAPIRequest	参照

ProtocolVersion プロパティは，HTTP 要求メッセージの開始ヘッダ内に指定された HTTP プロトコルのバージョン番号です。

property ProtocolVersion: string;

説明

ProtocolVersion プロパティを使うと，Web クライアントが HTTP 要求メッセージを作成するときに使用するプロトコルがわかります。

HTTP 要求メッセージのプロパティには，ProtocolVersion プロパティの値によって解釈が異なるものがあります。たとえば，ProtocolVersion が 1.0 の場合，Connection プロパティが close オプションでなくても，接続は一時的とみなされます。


TISAPIRequest.Query
TISAPIRequest.Query3290025

TISAPIRequest	参照

Query プロパティは，HTTP 要求メッセージ内に指定された URL の問い合わせ情報（存在する場合）の値を示します。

property Query: string;

説明

Query プロパティを読み出すと，要求メッセージの URL 内に指定された問い合わせの詳細な内容がわかります。たとえば，次の URL があるとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

/gallery.dll が Web サーバーアプリケーションとすると，Query は次のようになります。

animal=dog&color=black

Query プロパティは，URL の分解前の問い合わせ部分です。問い合わせには複数の項目があり，アンド記号（&）で区切られます。QueryFields プロパティを使うと，項目単位で問い合わせを処理できます。


TISAPIRequest.Referer
TISAPIRequest.Referer3290026

TISAPIRequest	参照

Referer プロパティは，HTTP 要求メッセージの Referer ヘッダーの値です。

property Referer: string;

説明

Referer プロパティを読み出すと，HTTP 要求メッセージが発生したリソースの URI がわかります。このプロパティを使ってサーバーアプリケーションは，要求ソースへのバックリンクを作成できます。このプロパティが URI の一部である場合，これは URL プロパティへの相対パスとみなさないといけません。

HTTP 要求メッセージの URL が，ユーザーキーボードからの入力のように自分の URI を持っていないソースから取得したものであるとき，Referer プロパティは設定されません。


TISAPIRequest.RemoteAddr
TISAPIRequest.RemoteAddr3290027

TISAPIRequest	参照

RemoteAddr プロパティは，HTTP 要求メッセージを送ったクライアントのリモート IP アドレスです。

property RemoteAddr: string;

説明

RemoteAddr プロパティを読み出すと，クライアント要求が発生したソースの IP アドレスを取得できます。


TISAPIRequest.RemoteHost
TISAPIRequest.RemoteHost3290028

TISAPIRequest	参照

RemoteHost プロパティは，HTTP 要求メッセージを送ったクライアントの逆ドメイン参照（フルパス）を示します。

property RemoteHost: string;

説明

RemoteHost プロパティを使うと，Referer プロパティが指定されていないときに要求ソースへのバックリンクを示す URI 値を生成できます。このプロパティにはパス情報が含まれていません。


TISAPIRequest.ScriptName
TISAPIRequest.ScriptName3290029

TISAPIRequest	参照

ScriptName プロパティは，HTTP 要求メッセージ内に指定された URL のスクリプト情報（存在する場合）です。

property ScriptName: string;

説明

ScriptName プロパティを読み出すと，要求メッセージによって指定された Web サーバーアプリケーションへのフルパスがわかります。たとえば，次の URL があるとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

/gallery.dll が Web サーバーアプリケーションとすると，ScriptName は次のようになります。

/art/gallery


TISAPIRequest.ServerPort
TISAPIRequest.ServerPort3290030

TISAPIRequest	参照

ServerPort プロパティは，Web サーバー上で HTTP 要求メッセージを受け取るポートのポート番号です。

property ServerPort: Integer;

説明

ServerPort プロパティを読み出すと，Web サーバーの接続に使用されたポートの番号がわかります。ServerPort が URL の一部として指定された場合，Host プロパティは ServerPost を含みます。


TISAPIRequest.Title
TISAPIRequest.Title3290031

TISAPIRequest	参照

Title プロパティは，HTTP 要求メッセージの Title ヘッダーの値を示します。

property Title: string;

説明

Title プロパティを読み出すと，要求内で要求された情報のタイトルがわかります。


TISAPIRequest.URL
TISAPIRequest.URL3290032

TISAPIRequest	参照

URL プロパティは，要求のターゲットを示すために HTTP 要求メッセージが指定した Uniform Resource Identifier（URI）です。

property URL: string;

説明

URL プロパティを使うと，要求メッセージのターゲットとして Web クライアントが指定したリソースがわかります。URL は，返すべき HTML ページ，作成または削除するリソース，Web クライアントに他のサービスを提供するオブジェクトのいずれかです。

TISAPIRequest オブジェクトは，URL を各構成要素に分解して，Host，ScriptName，PathInfo，および Query の各プロパティを生成します。

注意

通常，URL プロパティは，ホスト，スクリプト，パス，および問い合わせに分解できる Uniform Resource Locator（URL）です。しかし，HTTP 要求メッセージでは，Uniform Resource Identifier（URI）のように一般的な用語でターゲットを指定することもできます。


TISAPIRequest.UserAgent
TISAPIRequest.UserAgent3290033

TISAPIRequest	参照

UserAgent プロパティは，HTTP 要求メッセージの User-Agent ヘッダーの値を示します。

property UserAgent: string;

説明

UserAgent プロパティを読み出すと，クライアント要求を発生したユーザーエージェントに関する情報を取得できます。この情報は，統計目的やプロトコル違反の検出に使ったり，クライアントアプリケーションの知られている制限にあわせて応答メッセージを変えるために使います。UserAgent 文字列には 1 つまたは複数のデスクリプタが含まれ，重要度の順番に並んでいます。各デスクリプタは，要求を発した製品やアプリケーションの名前，あるいはユーザーエージェントに関する注釈を表しています。


TISAPIRequest メソッド3290034

TISAPIRequest	アルファベット順	凡例

TISAPIRequest

Create

GetDateVariable

GetFieldByName

GetIntegerVariable

GetStringVariable

ReadClient

ReadString

TranslateURI

WriteClient

WriteString

TWebRequest からの継承

Destroy

ExtractContentFields

ExtractCookieFields

ExtractFields

ExtractQueryFields

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TISAPIRequest メソッド3290035

TISAPIRequest	オブジェクト順	凡例

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

ExtractContentFields

ExtractCookieFields

ExtractFields

ExtractQueryFields

FieldAddress

Free

FreeInstance

GetDateVariable

GetFieldByName

GetIntegerVariable

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetStringVariable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadClient

ReadString

SafeCallException

TranslateURI

WriteClient

WriteString


TISAPIRequest.Create
TISAPIRequest.Create3290036

TISAPIRequest	参照

Create メソッドは，AECB パラメータに含まれる要求メッセージ情報を指定するために，TISAPIRequest のインスタンスを作成します。

TEXTENSION_CONTROL_BLOCK = packed record

    cbSize: DWORD;                    // この構造体のサイズ

    dwVersion: DWORD;                 // この仕様のバージョン情報

    ConnID: HCONN;                    // 変更されないコンテキスト番号

    dwHttpStatusCode: DWORD;          // HTTP ステータス番号

    lpszLogData: array [0..HSE_LOG_BUFFER_LEN-1] of Char; // ログ情報

    lpszMethod: PChar;                // REQUEST_METHOD

    lpszQueryString: PChar;           // QUERY_STRING

    lpszPathInfo: PChar;              // PATH_INFO

    lpszPathTranslated: PChar;        // PATH_TRANSLATED

    cbTotalBytes: DWORD;              // クライアントから指定された合計バイト数

    cbAvailable: DWORD;               // 利用可能なバイト数

    lpbData: Pointer;                 // cbAvailable バイトへのポインタ

    lpszContentType: PChar;           // クライアントデータの Content 型

    GetServerVariable: TGetServerVariableProc;

    WriteClient: TWriteClientProc;

    ReadClient: TReadClientProc;

    ServerSupportFunction: TServerSupportFunctionProc;

  end;

PEXTENSION_CONTROL_BLOCK = ^TEXTENSION_CONTROL_BLOCK;

constructor Create(AECB: PEXTENSION_CONTROL_BLOCK);

説明

ISAPI 要求オブジェクトをインスタンス化するために，アプリケーションで Create メソッドを呼び出す必要はありません。TISAPIApplication は，要求を受け取るたびに TISAPIRequest オブジェクトを作成します。


TISAPIRequest.GetDateVariable
TISAPIRequest.GetDateVariable3290037

TISAPIRequest	参照

GetDateVariable メソッドは，拡張コントロールブロックから日付を抽出します。

function GetDateVariable(Index: Integer): TDateTime; override;

説明

GetDateVariable メソッドは，ECB プロパティによって定義された拡張コントロールブロックから日付と時間を読み出します。ISAPIRequest オブジェクトは，このメソッドを使うことで，HTTP 要求ヘッダーから日付を表すプロパティを取得します。


TISAPIRequest.GetFieldByName
TISAPIRequest.GetFieldByName3290038

TISAPIRequest	参照

GetFieldByName メソッドは，Name パラメータによって指定された HTTP ヘッダー変数の値を返します。

function GetFieldByName(const Name: string): string; override;

説明

GetFieldByName メソッドを使うと，TISAPIRequest のプロパティとして表に示されていない HTTP ヘッダー変数の値を読み出すことができます。利用できる HTTP 要求ヘッダー変数については，現在のインターネット規格文書を参照してください。


TISAPIRequest.GetIntegerVariable
TISAPIRequest.GetIntegerVariable3290039

TISAPIRequest	参照

GetIntegerVariable メソッドは，拡張コントロールブロックから整数値を抽出します。

function GetIntegerVariable(Index: Integer): Integer; override;

説明

GetIntegerVariable メソッドは，ECB プロパティによって定義された拡張コントロールブロックから整数値を読み出します。ISAPIRequest オブジェクトは，このメソッドを使って，HTTP 要求ヘッダーから整数値を持つプロパティを取得します。


TISAPIRequest.GetStringVariable
TISAPIRequest.GetStringVariable3290040

TISAPIRequest	参照

GetStringVariable メソッドは，拡張コントロールブロックから文字列値を抽出します。

function GetStringVariable(Index: Integer): string; override;

説明

GetStringVariable メソッドは，ECB プロパティによって定義された拡張コントロールブロックから文字列値を読み出します。ISAPIRequest オブジェクトは，このメソッドを使って，HTTP 要求ヘッダーから文字列値を表すプロパティを取得します。


TISAPIRequest.ReadClient
TISAPIRequest.ReadClient3290041

TISAPIRequest	参照

ReadClient メソッドは，HTTP 要求から Count バイトのデータを Buffer に読み出します。

function ReadClient(var Buffer; Count: Integer): Integer; override;

説明

ReadClient メソッドを使うと，HTTP 要求の内容から，情報を小分けにしてバッファにロードできます。要求メッセージの内容が Content プロパティで読み出すには大きすぎる場合，このメソッドを使うと，サーバーアプリケーションは，何回かに分けて情報を取得できます。ReadClient は実際に読み出したバイト数を返します。読み出すべき情報がなくなったときは，-1 を返します。


TISAPIRequest.ReadString
TISAPIRequest.ReadString3290042

TISAPIRequest	参照

ReadString メソッドは，HTTP 要求から Count バイトのデータを文字列に読み出します。

function ReadString(Count: Integer): string; override;

説明

ReadString メソッドを使うと，HTTP 要求の内容から，情報を小分けにして文字列にロードできます。要求メッセージの内容が Content プロパティで読み出すには大きすぎる場合，このメソッドを使うと，サーバーアプリケーションは，何回かに分けて情報を取得できます。


TISAPIRequest.TranslateURI
TISAPIRequest.TranslateURI3290043

TISAPIRequest	参照

TranslateURI メソッドは，Uniform Resource Identifier（URI）を，サーバー上の場所を示す内部表現に変換します。

function TranslateURI(const URI: string): string; virtual; abstract;

説明

TranslateURI メソッドは，要求内に指定された URI を，サーバーアプリケーションが使用できる形式に変換します。


TISAPIRequest.WriteClient
TISAPIRequest.WriteClient3290044

TISAPIRequest	参照

WriteClient メソッドは，Count バイトのデータを Buffer から元の HTTP クライアントに書き込みます。

function WriteClient(var Buffer; Count: Integer): Integer; override;

説明

WriteClient メソッドを使うと，元の Web クライアントに応答の内容を書き込むことができます。


TISAPIRequest.WriteString
TISAPIRequest.WriteString3290045

TISAPIRequest	参照

WriteString メソッドは，元の HTTP クライアントに文字列 AString を書き込みます。

function WriteString(const AString: string): Boolean; virtual; override;

説明

WriteString メソッドを使うと，元の Web クライアントに応答の内容を書き込むことができます。


読み出し／書き込み3290046

読み出し専用


スコープ3290047

protected


継承3290048

TObject

TWebRequest


TISAPIRequest 例3290049

TISAPIRequest


TISAPIResponse
TISAPIResponse3291001

継承	プロパティ	メソッド	参照

TISAPIResponse コンポーネントは，HTTP 要求メッセージに対して ISAPI アプリケーションが返す HTTP メッセージです。

ユニット

isapiapp

説明

TISAPIResponse コンポーネントは，HTTP 要求メッセージへの応答メッセージです。

ISAPI アプリケーションは，入力された HTTP 要求メッセージを表す TISAPIRequest オブジェクトを基に TISAPIResponse オブジェクトを作成します。次いで，TWebDispatcher はこの TISAPIResponse オブジェクトを，TISAPIRequest オブジェクトに関連する TWebActionItem オブジェクトに渡します。TWebActionItem オブジェクトは，TISAPIResponse オブジェクトのプロパティを設定します。


TISAPIResponse プロパティ3291002

TISAPIResponse	アルファベット順	凡例

TISAPIResponse

Allow

Content

ContentEncoding

ContentLength

ContentType

ContentVersion

Date

DerivedFrom

Expires

LastModified

Location

LogMessage

Realm

ReasonString

Server

StatusCode

Title

Version

WWWAuthenticate

TWebResponse からの継承

ContentStream

Cookies

CustomHeaders

HTTPRequest


TISAPIResponse プロパティ3291003

TISAPIResponse	オブジェクト順	凡例

Allow

Content

ContentEncoding

ContentLength

ContentStream

ContentType

ContentVersion

Cookies

CustomHeaders

Date

DerivedFrom

Expires

HTTPRequest

LastModified

Location

LogMessage

Realm

ReasonString

Server

StatusCode

Title

Version

WWWAuthenticate


TISAPIResponse.Allow
TISAPIResponse.Allow3291004

TISAPIResponse	参照

Allow プロパティは，TISAPIResponse オブジェクトが対応できる HTTP 要求メソッドのリストを表します。

property Allow: string;

説明

Allow プロパティは，HTTPRequest プロパティに指定された URL に対してサーバーアプリケーションがどのようなタイプの要求メソッドに応答できるかを指定できます。このプロパティは，コンマで区切られたメソッド名からなる文字列です。これらのメソッド名には，HTTP 準拠の定義済みメソッドまたはサーバーアプリケーション作成の追加メソッドをすべて含めることができます。最低，TISAPIResponse オブジェクトは，GET 要求と HEAD 要求に対応できなければなりません。


TISAPIResponse.Content
TISAPIResponse.Content3291005

TISAPIResponse	参照

Content プロパティは，HTTP 要求メッセージの応答で Web クライアントに送られる情報です。

property Content: string;

説明

Content プロパティは，要求された情報を Web クライアントに送信できます。すべての HTTP 要求メッセージに対して情報を返す必要はありません。たとえば，OPTIONS，HEAD，POST，PUT，DELETE，または TRACE のメソッドを持った要求に対する応答メッセージには，Content を含めてはいけません。これらの場合にはいずれも，応答情報は完全に応答ヘッダに含まれ，このヘッダは TISAPIResponse オブジェクトが持つ Content 以外のプロパティから作成されます。

応答内容は，HTML コマンドの文字列，HTML ファイル名，ビットストリームなどのグラフィックコンテンツ，または他の MIME コンテンツです。

注意

ContentStream プロパティ が設定されている場合，それが Content プロパティの値に取って代わります。Content と ContentStream の両方が設定されている場合，Web クライアントは，Content プロパティの値ではなく，ContentStream の値を受け取ります。


TISAPIResponse.ContentEncoding
TISAPIResponse.ContentEncoding3291006

TISAPIResponse	参照

ContentEncoding プロパティは，HTTP 応答メッセージの内容をコード化するためのメカニズム（存在する場合）をリストに表示します。

property ContentEncoding: string;

説明

ContentEncoding プロパティは，Content プロパティの値を Web クライアントに送る前にコード化したときに設定します。コード化メカニズムは，適用される順序でリストに表示され，カンマで区切られます。一般に，このプロパティは，ネット上で拡張 ASCII 文字を転送するのに使われる圧縮方式またはコード化方式を表します。


TISAPIResponse.ContentLength
TISAPIResponse.ContentLength3291007

TISAPIResponse	参照

ContentLength プロパティは，Content プロパティの長さ（バイト単位）です。

property ContentLength: Integer;

説明

ContentLength プロパティは，Content プロパティの長さがわかっている場合，その値を設定します。わかっていない場合，または HTTP 応答メッセージにまったく内容がない場合は，0 を設定します。Web クライアントは，ContentLength プロパティを使って，HTTP 応答メッセージの内容を読み出します。

応答メッセージの内容をストリームから得る場合は，ContentLength プロパティの値はそのストリームから設定されます。


TISAPIResponse.ContentType
TISAPIResponse.ContentType3291008

TISAPIResponse	参照

ContentType プロパティは，HTTP 応答メッセージに設定された Content のメディアタイプの値です。

property ContentType: string;

説明

ContentType プロパティを設定すると，HTTP 応答メッセージの Content のメディアタイプを指定できます。このプロパティの値には，有効な MIME コンテンツタイプを指定しなくてはなりません。ContentType 文字列のフォームは Type/SubType です。

たとえば，GET 要求に対して HTML コマンドからなる文字列を応答メッセージとして Web クライアントに返す場合，ContentType は text/html になります。

注意

HTTP 要求メッセージに Accept ヘッダが含まれている場合，ContentType プロパティは，TISAPIRequest.Accept プロパティに一覧表示されたコンテンツタイプのいずれかでなければなりません。


TISAPIResponse.ContentVersion
TISAPIResponse.ContentVersion3291009

TISAPIResponse	参照

ContentVersion プロパティは，HTTP 応答メッセージの Content に関連付けられたバージョンを示す文字列です。

property ContentVersion: string;

説明

ContentVersion プロパティは，HTTP 応答の Content に関連付けられたバージョンを指定できます。このプロパティの意味は，HTTP 応答として送る情報の種類によって変わります。たとえば，HTTP 応答の Content に text/html という ContentType が含まれている場合，ContentVersion プロパティの値は使用される HTML のバージョンになるはずです。

ContentVersion プロパティの意味を規定するサーバーアプリケーションは，その意味を明確に記述しておかなければなりません。


TISAPIResponse.Date
TISAPIResponse.Date3291010

TISAPIResponse	参照

Date プロパティは，HTTP 応答メッセージを Web クライアントに送る日時です。

property Date: TDateTime;

説明

HTTP 応答メッセージを Web クライアントに送る直前に，Date プロパティに現在の日時を設定します。Web クライアントは，このプロパティを使って，返された情報の新しさを判断します。

Date プロパティは TDateTime 型で表します。TDateTime 値の整数部は 1899 年 12 月 30 日以降の経過日数です。小数部はその日の経過時間（24 時間制）です。


TISAPIResponse.DerivedFrom
TISAPIResponse.DerivedFrom3291011

TISAPIResponse	参照

DerivedFrom プロパティは，HTTP 応答の Content が発生したリソースの URI です。

property DerivedFrom: string;

説明

DerivedFrom プロパティは，Content の値が発生した URI を設定します。この設定が特に重要になるのは，HTTP 要求メッセージの URL プロパティが示すリソースから HTTP 応答の Content が発生しなかったときです。


TISAPIResponse.Expires
TISAPIResponse.Expires3291012

TISAPIResponse	参照

Expires プロパティは，HTTP 応答メッセージの Content についてそれ以降を無効とみなす日時を指定します。

property Expires: TDateTime;

説明

Expires プロパティは，時間が経過すると無効になる可能性がある情報が，HTTP 応答メッセージの Content に含まれているときに設定します。このプロパティを設定しても，設定した日時になったら，必ずメッセージの情報やソースが変わったりなくなったりするわけではありません。Web クライアントは，Expires プロパティが示す日時以降，情報の新しさをチェックするよう警告されるだけです。

Expires プロパティの値は，マシンの地方時間で指定されます。HTTP 応答メッセージは，この値を HTTP が使う日付コードに変換します。

Expires プロパティは TDateTime 型で表します。TDateTime 値の整数部は 1899 年 12 月 30 日以降の経過日数です。小数部はその日の経過時間（24 時間制）です。


TISAPIResponse.LastModified
TISAPIResponse.LastModified3291013

TISAPIResponse	参照

LastModified プロパティは，Content プロパティの値が最後に更新された日時を示します。

property LastModified: TDateTime;

説明

LastModified プロパティは，HTTP 応答の Content プロパティが最後に変更された時間を設定します。この値によって Web クライアントは，情報のローカルバージョンが最新のものかどうかを知ることができます。HTTP 要求が HEAD メッセージの場合，Web クライアントとサーバーは，転送するとコストがかかりそうな情報をスキップできます。

LastModified プロパティの値は，マシンの地域時間で指定されます。 HTTP 応答メッセージは，この値を HTTP が使う日付コードに変換します。

LastModified プロパティは TDateTime 型で表します。TDateTime 値の整数部は 1899 年 12 月 30 日以降の経過日数です。小数部はその日の経過時間（24 時間制）です。


TISAPIResponse.Location
TISAPIResponse.Location3291014

TISAPIResponse	参照

Location プロパティは，要求を完了するために Web クライアントが指さなくてはならないリソースの URI です。

property Location: string;

説明

Location プロパティは，HTTPResponse が HTTP 要求メッセージに対応する新しいリソースを作成したとき，または応答の処理を HTTP 要求メッセージ内で指定された URI 以外の URI に代行させなくてはならないときに設定します。


TISAPIResponse.LogMessage
TISAPIResponse.LogMessage3291015

TISAPIResponse	参照

LogMessage プロパティは，処理の内容を記述した文字列で，イベントログ用に HTTP 応答メッセージ内に含めるものです。

property LogMessage: string;

説明

LogMessage プロパティは，HTTP 応答処理を行なう TWebActionItem オブジェクトが実行したアクションの内容を設定します。通常，このプロパティには，HTTP 要求メッセージを扱った URI と日時情報が含まれます。


TISAPIResponse.Realm
TISAPIResponse.Realm3291016

TISAPIResponse	参照

Realm プロパティはprotectedアクセス URI 群で，HTTP 要求メッセージによって指定された URI を含みます。

property Realm: string;

説明

Realm プロパティは，HTTP 応答メッセージが 401（Unauthorized）または 402（Payment required）を返したときに設定します。このプロパティは，Web クライアントがパスワードを指定したり，対価を払ったりしないとアクセスできない URI 群の名前です。HTTP 要求メッセージ内の URI を含めて，プロパティ内の URI はすべて，Web クライアントがパスワードを指定したり対価を払ったりすればすぐにアクセスできるようになります。サーバーアプリケーションは，TISAPIRequest オブジェクトによるクライアント情報を使って，クライアントのパスワードや対価支払いについて内部的に継続して観察していかなくてはなりません。


TISAPIResponse.ReasonString
TISAPIResponse.ReasonString3291017

TISAPIResponse	参照

ReasonString プロパティは，Web クライアントの要求に対する応答のステータスを示すテキスト文字列です。

property ReasonString: string;

説明

ReasonString プロパティを設定すると，HTTP 要求メッセージの成功または失敗を Web クライアントに通知できます。この原因文字列は応答のステータスを示す 3 桁のステータスコードに関連付けられています。HTTP ではあらかじめ，多くのステータスコードと，それに対応する原因文字列を規定しています。これ以外に，サーバーアプリケーションは新しい原因文字列を定義して，未使用のステータスコードに関連付けることができます。


TISAPIResponse.Server
TISAPIResponse.Server3291018

TISAPIResponse	参照

Server プロパティは，要求を処理するためにサーバーアプリケーションが使用するソフトウェアについての情報を提供します。

property Server: string;

説明

Server プロパティは，HTTP 応答メッセージの Content を提供するアプリケーションの名前とバージョン番号からなる文字列を設定します。Server プロパティの値には，複数の製品識別子とコメントを含めることができます。この場合，製品識別子とコメントは空白で区切られ，重要度の順に一覧表示されます。製品識別子は ProductName/VersionNumber の形式を取ります。


TISAPIResponse.StatusCode
TISAPIResponse.StatusCode3291019

TISAPIResponse	参照

StatusCode プロパティは，3 桁の整数値で，HTTP 要求メッセージに対する応答のステータスを示します。

property StatusCode: Integer;

説明

StatusCode プロパティを設定すると，HTTP 要求メッセージのステータスを Web クライアントに通知できます。ステータスコードは，Web クライアントならば理解できる標準的な戻り値です。各ステータスコードには対応する原因文字列があり，これによって Web クライアントはステータスの意味を理解しやすくなります。

以下に，利用できるステータスコードとそれに対応する原因文字列を示します。

StatusCode	ReasonString

100	Continue

101	Switching Protocols

200	OK

201	Created

202	Accepted

203	Non-Authoritative Information

204	No Content

205	Reset Content

206	Partial Content

300	Multiple Choices

301	Moved Permanently

302	Moved Temporarily

303	See Other

304	Not Modified

305	Use Proxy

400	Bad Request

401	Unauthorized

402	Payment Required

403	Forbidden

404	Not Found

405	Method Not Allowed

406	Not Acceptable

407	Proxy Authentication Required

408	Request Time-out

409	Conflict

410	Gone

411	Length Required

412	Precondition Failed

413	Request Entity Too Large

414	Request-URI Too Large

415	Unsupported Media Type

500	Internal Server Error

501	Not Implemented

502	Bad Gateway

503	Service Unavailable

504	Gateway Time-out

505	HTTP Version not supported

上記のテーブルにないステータスコードは，サーバーアプリケーションで作成できます。新しいステータスコードを作成するときは，最上位桁に以下の応答クラスを指定しなくてはなりません。

・	1xx: 情報（要求受信済み，処理続行中）

・	2xx: 成功（要求受信済み，了解済み，受け入れ済み）

・	3xx: 転送（要求処理を終了するにはさらに処理が必要）

・	4xx: クライアントエラー（要求に不正な構文があるか，要求のサービスができない）

・	5xx: サーバーエラー（サーバーが有効な要求を処理できなかった）


TISAPIResponse.Title
TISAPIResponse.Title3291020

TISAPIResponse	参照

Title プロパティは HTTP 応答メッセージの Content のタイトルを指定します。

property Title: string;

説明

Title プロパティ を設定すると，HTTP 応答メッセージに Title ヘッダーを追加できます。このプロパティは，応答メッセージに含まれている情報に関連付けられたアプリケーション固有のオプションタイトルです。


TISAPIResponse.Version
TISAPIResponse.Version3291021

TISAPIResponse	参照

Version プロパティは，Web クライアントが使用している HTTP プロトコルのバージョン番号です。

property Version: string;

説明

Version プロパティは，Web クライアントは TISAPIResponse オブジェクトに設定されたプロパティを確実に理解できるようになります。Version プロパティの値は，HTTPRequest プロパティの ProtocolVersion プロパティから取得されます。

HTTP プロトコルの各種バージョンについては，インターネット規格を参照してください。


TISAPIResponse.WWWAuthenticate
TISAPIResponse.WWWAuthenticate3291022

TISAPIResponse	参照

WWWAuthenticate プロパティは，カンマで区切られた 1 つまたは複数の未処理アクセスからなるリストで，StatusCode 401（Unauthorized）で要求が失敗したときに提供されます。

property WWWAuthenticate: string;

説明

WWWAuthenticate プロパティは，Web クライアントにパスワードが提供されていない realm 内の URI へのアクセスを要求したために HTTP 要求が失敗したときに設定します。このプロパティは，認証方式名と，認証方式にパラメータを与えるためのカンマで区切られたパラメータ/値の組み合せのリストから構成されます。最初のパラメータ/値の組み合せは realm を示します。

HTTP 認証方式の詳細については，インターネットの規格を参照してください。


TISAPIResponse メソッド3291023

TISAPIResponse	アルファベット順	凡例

TISAPIResponse

Create

GetContent

GetDateVariable

GetIntegerVariable

GetLogMessage

GetStatusCode

GetStringVariable

SendRedirect

SendResponse

SendStream

Sent

SetContent

SetDateVariable

SetIntegerVariable

SetLogMessage

SetStatusCode

SetStringVariable

TWebResponse からの継承

Destroy

GetCustomHeader

SetCookieField

SetCustomHeader

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TISAPIResponse メソッド3291024

TISAPIResponse	オブジェクト順	凡例

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetContent

GetCustomHeader

GetDateVariable

GetIntegerVariable

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetLogMessage

GetStatusCode

GetStringVariable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

SendRedirect

SendResponse

SendStream

Sent

SetContent

SetCookieField

SetCustomHeader

SetDateVariable

SetIntegerVariable

SetLogMessage

SetStatusCode

SetStringVariable


TISAPIResponse.Create
TISAPIResponse.Create3291025

TISAPIResponse	参照

Create メソッドは，TISAPIResponse のインスタンスを作成して，HTTPRequest パラメータに対する応答メッセージを生成します。

constructor Create(HTTPRequest: TWebRequest);

説明

ISAPI 応答オブジェクトをインスタンス化するために，アプリケーションで Create を呼び出す必要はありません。TISAPIApplication が各 TISAPIRequest に対して TISAPIResponse を作成します。


TISAPIResponse.GetContent
TISAPIResponse.GetContent3291026

TISAPIResponse	参照

GetContent メソッドは，Content プロパティの値を読み出します。

function GetContent: string; override;

説明

GetContent メソッドは，Content プロパティのためのアクセス機能です。


TISAPIResponse.GetDateVariable
TISAPIResponse.GetDateVariable3291027

TISAPIResponse	参照

GetDateVariable メソッドは，HTTP ヘッダー変数の内部テーブルから日付を抽出します。

function GetDateVariable(Index: Integer): TDateTime; override;

説明

ISAPI 応答オブジェクトは GetDateVariable メソッドを使って，日付を表すプロパティにアクセスします。


TISAPIResponse.GetIntegerVariable
TISAPIResponse.GetIntegerVariable3291028

TISAPIResponse	参照

GetIntegerVariable メソッドは，HTTP ヘッダー変数の内部テーブルから整数値を抽出します。

function GetIntegerVariable(Index: Integer): Integer; override;

説明

ISAPI 応答オブジェクトは GetIntegerVariable メソッドを使って，整数を表すプロパティにアクセスします。


TISAPIResponse.GetLogMessage
TISAPIResponse.GetLogMessage3291029

TISAPIResponse	参照

GetLogMessage メソッドは，LogMessage プロパティの値を読み出します。

function GetLogMessage: string; override;

説明

GetLogMessage メソッドは，LogMessage プロパティのためのアクセス機能です。


TISAPIResponse.GetStatusCode
TISAPIResponse.GetStatusCode3291030

TISAPIResponse	参照

GetStatusCode メソッドは，StatusCode プロパティの値を読み出します。

function GetStatusCode: Integer; override;

説明

GetStatusCode メソッドは，StatusCode プロパティのためのアクセス機能です。


TISAPIResponse.GetStringVariable
TISAPIResponse.GetStringVariable3291031

TISAPIResponse	参照

GetStringVariable メソッドは，HTTP ヘッダー変数の内部テーブルから文字列値を抽出します。

function GetStringVariable(Index: Integer): string; override;

説明

ISAPI 応答オブジェクトは GetStringVariable メソッドを使って，文字列値を表すプロパティにアクセスします。


TISAPIResponse.SendRedirect
TISAPIResponse.SendRedirect3291032

TISAPIResponse	参照

SendRedirect メソッドは，StatusCode が 301（Moved Permanently）で URI パラメータに Location が設定されている応答を送ります。

procedure SendRedirect(const URI: string); override;

説明

SendRedirect を呼び出すと，Web クライアント要求が，その要求の正しいターゲットである URI に転送されます。このメソッドは，StatusCode が 301 で URI に Location が設定されている状態で SendResponse を呼び出した場合とまったく同じように機能します。


TISAPIResponse.SendResponse
TISAPIResponse.SendResponse3291033

TISAPIResponse	参照

SendResponse メソッドは，Web クライアントに ISAPI 応答メッセージを送ります。

procedure SendResponse; override;

説明

HTTP 応答オブジェクトのプロパティを設定した後に SendResponse メソッドを呼び出すと，Web クライアントに送らなければならない応答を指定できます。要求を別の URI に転送しなければならないときは，SendRedirect メソッドを呼び出す方が便利です。


TISAPIResponse.SendStream
TISAPIResponse.SendStream3291034

TISAPIResponse	参照

SendStream メソッドは，AStream の内容を設定した ISAPI 応答メッセージを送ります。

procedure SendStream(AStream: TStream); override;

説明

最初に SendResponse メソッドを呼び出した後にだけ，SendStream メソッドを呼び出してください。SendStream メソッドと違って，SendResponse メソッドは TISAPIResponse オブジェクトのプロパティを基にして HTTP 応答メッセージのヘッダーを設定します。最初に SendResponse を呼び出して HTTP 応答メッセージのヘッダーを設定したのでない場合は，ContentStream プロパティを AStream に設定して SendResponse を呼び出してください。


TISAPIResponse.Sent
TISAPIResponse.Sent3291035

TISAPIResponse	参照

Sent メソッドは，ISAPI 応答メッセージがすでに送られたかどうかを示す論理値を返します。

function Sent: Boolean; override;

説明

Sent メソッドは，SendRedirect メソッドまたは SendStream メソッドが呼び出された場合に True を返します。TISAPIApplication オブジェクトは Sent メソッドを読み出して，SendRedirect メソッドまたは SendStream メソッドが Web クライアントに応答を送るべきかどうかを判断します。


TISAPIResponse.SetContent
TISAPIResponse.SetContent3291036

TISAPIResponse	参照

SetContent メソッドは Content プロパティを設定します。

procedure SetContent(const Value: string); override;

説明

SetContent メソッドは，ISAPI 応答オブジェクトが Content プロパティを設定するために使う Protected メソッドです。


TISAPIResponse.SetDateVariable
TISAPIResponse.SetDateVariable3291037

TISAPIResponse	参照

SetDateVariable メソッドは，HTTP ヘッダープロパティに日時を設定します。

procedure SetDateVariable(Index: Integer; const Value: TDateTime); override;

説明

SetDateVariable メソッドは，HTTP ヘッダー変数を格納するために使われる内部テーブルに日時を書き込みます。ISAPI 応答オブジェクトは SetDateVariable を使って，日付を表すプロパティを設定します。


TISAPIResponse.SetIntegerVariable
TISAPIResponse.SetIntegerVariable3291038

TISAPIResponse	参照

SetIntegerVariable メソッドは，HTTP ヘッダープロパティに整数値を設定します。

procedure SetIntegerVariable(Index: Integer; Value: Integer); override;

説明

SetIntegerVariable メソッドは，HTTP ヘッダー変数を格納するために使われる内部テーブルに整数値を書き込みます。ISAPI 応答オブジェクトは SetIntegerVariable を使って，整数を表すプロパティを設定します。


TISAPIResponse.SetLogMessage
TISAPIResponse.SetLogMessage3291039

TISAPIResponse	参照

SetLogMessage メソッドは，LogMessage プロパティの値を設定します。

procedure SetLogMessage(const Value: string); virtual; abstract;

説明

SetLogMessage メソッドは，ISAPI 応答オブジェクトが LogMessage プロパティを設定するために使う Protected メソッドです。


TISAPIResponse.SetStatusCode
TISAPIResponse.SetStatusCode3291040

TISAPIResponse	参照

SetStatusCode メソッドは，StatusCode プロパティを設定します。

procedure SetStatusCode(Value: Integer); override;

説明

SetStatusCode メソッドは，ISAPI 応答オブジェクトが StatusCode プロパティを設定するために使う Protected メソッドです。


TISAPIResponse.SetStringVariable
TISAPIResponse.SetStringVariable3291041

TISAPIResponse	参照

SetStringVariable メソッドは，HTTP ヘッダープロパティに文字列値を設定します。

procedure SetStringVariable(Index: Integer; const Value: string); override;

説明

SetStringVariable メソッドは，HTTP ヘッダー変数を格納するために使われる内部テーブルに文字列値を書き込みます。ISAPI 応答オブジェクトは SetStringVariable を使って，文字列を表すプロパティを設定します。


読み出し／書き込み3291042

読み出し専用


スコープ3291043

protected


継承3291044

TObject

TWebResponse


TISAPIResponse 例3291045

TISAPIResponse


TJPEGData
TJPEGData3292001

継承	メソッド	参照

TJPEGData は，TJPEGImage オブジェクトで使う，JPEG 圧縮イメージファイルをカプセル化します。

ユニット

jpeg

説明

TJPEGData は Delphi が内部的に使うオブジェクトで，TJPEGImage オブジェクトが使う JPEG データソースを表します。TJPEGData は，TJPEGImage オブジェクトが作成されると自動的に作成されます。

TJPEGData は，JPEG データソースに対するファイルハンドルの実際のオーナーです。したがって TJPEGData は，TJPEGImage がどのように参照カウントとハンドルの共有を行っているかを示します。Assign メソッドを使って JPEG イメージオブジェクトをコピーすると，イメージオブジェクトの複数のインスタンスが，１つのTJPEGData オブジェクトを参照し共有します。

TJPEGData が参照しているファイル自体が変更されることはありません。TJPEGData を共有している各 TJPEGImage のインスタンスは，どのようにデータを内部ローカルビットマップ表現に展開するかを決定するためのプロパティを持っています。TJPEGImage が参照している JPEG 画像データを変更しねければならないときには，参照先の TJPEGData オブジェクトインスタンスとのリンクを解除して，新しい TJPEGData オブジェクトを作成します。


TJPEGData のメソッド3292002

TJPEGData	アルファベット順

TJPEGData

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TJPEGData のメソッド3292003

TJPEGData	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TJPEGData.Destroy
TJPEGData.Destroy3292004

TJPEGData	参照

Destroy メソッドは，JPEG データオブジェクトのインスタンスを破棄します。

destructor Destroy; override;

説明

JPEG データオブジェクトは，JPEG データオブジェクトを使う JPEG イメージオブジェクトによって自動的に破棄されます。Destroy を呼び出したり，JPEG データオブジェクトに直接アクセスする必要はありません。JPEG データオブジェクトの Destroy メソッドはデータを解放してから，継承された Destroy を呼び出します。

アプリケーションでオブジェクトのインスタンスを破棄する必要がある場合は，Destroy のかわりに Free を呼び出してください。Free はオブジェクトが解放されていないことを確認してから Destroy を呼び出します。


階層3292005

TObject

TSharedImage


TJPEGData の例3292006

TJPEGData


TJPEGImage
TJPEGImage3293001

継承	プロパティ	メソッド	イベント	参照

TJPEGImage は JPEG グラフィックをカプセル化したものです。

ユニット

jpeg

説明

TJPEGImage は JPEG 圧縮イメージデータの読み書きをサポートします。TJPEGImage は，自然画像をコンピュータで使用する場合に適したディジタル圧縮および伸長に使います。JPEGImage オブジェクトは TJPEGData オブジェクトのインスタンスからのデータを使います。TJPEGData オブジェクトには実際の JPEG データソースが入っていて，このオブジェクトが直接変更されることはありません。各 JPEG イメージオブジェクトは１つのデータソースオブジェクトを，Assign メソッドを使って作成される，そのオブジェクトのコピーである別の JPEG イメージインスタンスと共有することができます。JPEG データソースはリンクされている PJEG イメージオブジェクトの参照をカウントします。

TJPEGImage は JPEG イメージから作られた内部ビットマップを持っています。この内部イメージと元の JPEG イメージのデータソースは読み出し専用です。TJPEGImage オブジェクトには，各インスタンスが色の変換，圧縮，伸長，パフォーマンスなどをどのように処理するかを決めるプロパティがあり，それらはデータソースの圧縮または伸長に適用されます。したがって，TJPEGImage のプロパティおよびメソッドは，圧縮，伸長，またはその両方に関わるものであり，JPEG データの読み込み，書き出し，またはその両方の方法を決めるものです。

TJPEGImage オブジェクトには以下の特徴があります。

・	キャンバスを持たない（したがってキャンバスに描画できない）。TJPEGImage オブジェクトは TGraphic の Draw メソッドを実現することで自分自身を描画します

・	JPEG イメージに対して作成する内部ビットマップイメージへのアクセスはできない

・	TJPEGImage は TJPEGData オブジェクトを介して参照のカウントおよびハンドル共有を行う。これにより，複数のインスタンスが同一の TJPEGData イメージを参照できる。これは Assign メソッドを使って JPEG イメージオブジェクトがコピーされることで管理される。JPEG データソースのファイルハンドルの実際の所有者は TJPEGData である


TJPEGImage のプロパティ3293002

TJPEGImage	アルファベット順	凡例

TJPEGImage

CompressionQuality

Empty

Grayscale

Height

Palette

Performance

PixelFormat

ProgressiveDisplay

ProgressiveEncoding

Scale

Smoothing

Width

TGraphic からの継承

Modified

PaletteModified

Transparent


TJPEGImage のプロパティ3293003

TJPEGImage	オブジェクト順	凡例

CompressionQuality

Empty

Grayscale

Height

Modified

PaletteModified

Palette

Performance

PixelFormat

ProgressiveDisplay

ProgressiveEncoding

Scale

Smoothing

Transparent

Width


TJPEGImage.CompressionQuality
TJPEGImage.CompressionQuality3293004

TJPEGImage

CompressionQuality プロパティは，画質とファイルサイズとのトレードオフの比率を示します。

TJPEGQualityRange = 1..100;

property CompressionQuality: TJPEGQualityRange;

説明

CompressionQuality プロパティは，JPEG イメージを書き出すときの JPEG イメージの圧縮率を設定できます。このプロパティはファイルの読み込みでは使いません。圧縮率を高くすると，画質は悪くなりますが，ファイルサイズは小さくなります。

TJPEGQualityRange は CompressionQuality プロパティの型です。TJPEGQualityRange の値が大きければ，画質はよくなりますが，ファイルサイズは大きくなります。TJPEGQualityRange の値が小さければ，ファイルサイズは小さくなりますが，画質は犠牲になります。


TJPEGImage.Empty
TJPEGImage.Empty3293005

TJPEGImage

Empty プロパティは，JPEG イメージオブジェクトにグラフィックが入っているかどうかを示します。

property Empty: Boolean;

説明

Empty プロパティは，イメージが JPEG イメージオブジェクトにロードされているかどうかを取得できます。JPEG イメージにイメージが入っていれば，Empty は True で，入っていなければ False です。


TJPEGImage.Grayscale
TJPEGImage.Grayscale3293006

TJPEGImage

GrayScale プロパティは，JPEG イメージのイメージ出力がモノクロであるかカラーであるかを決めます。

property Grayscale: Boolean;

説明

GrayScale プロパティは，JPEG イメージの読み込みと書き出し，ないしは伸長と圧縮に使います。このプロパティはイメージの表示のしかたを決めます。

GrayScale プロパティは，出力のスピードを向上するために使われます。GrayScale が True に設定されると，色情報が取り除かれます。色情報の伸長は時間がかかるので，イメージのプレビューでは GrayScale を True に設定することで処理速度を向上できます。その場合，イメージは 256 階調のグレースケールで表示されます。


TJPEGImage.Height
TJPEGImage.Height3293007

TJPEGImage

Height プロパティは，JPEG イメージの垂直方向のサイズをピクセル数で示します。

property Height: Integer;

説明

Height プロパティは，JPEG イメージの垂直方向のサイズ（ピクセル数）を調べることができます。


TJPEGImage.Palette
TJPEGImage.Palette3293008

TJPEGImage	参照

Palette プロパティは，JPEG イメージのカラーパレットです。

property Palette: HPALETTE;

説明

Palette プロパティは，JPEG イメージのカラーパレットを取得または設定できます。JPEG イメージがパレットを必要としないか，または使っていない場合，Palette プロパティは 0 になります。Palette プロパティを変更すると，イメージが TJPEGImage オブジェクトにロードされている場合にのみ，PaletteModified が True に設定されます。


TJPEGImage.Performance
TJPEGImage.Performance3293009

TJPEGImage

Performance プロパティは，色の質と伸長のスピードとのトレードオフの比率を示します。

TJPEGPerformance = (jpBestQuality, jpBestSpeed);

property Performance: TJPEGPerformance;

説明

Performance プロパティは，ファイルを読み込む，ないしは伸長するときの JPEG イメージのパフォーマンスを設定できます。このプロパティはファイルの書き出しには使いません。

Performance は内部ビットマップイメージの表示に影響します。内部ビットマップイメージは 256 色ビットマップです。Performance を jpBestSpeed に設定すると，ビットマップイメージに多少のディザリングが起こります。


TJPEGImage.PixelFormat
TJPEGImage.PixelFormat3293010

TJPEGImage

PixelFormat プロパティは，JPEG イメージが 24 ビット形式で表示されるか，8 ビット形式で表示されるかを決めます。

TJPEGPixelFormat = (jf24Bit, jf8Bit);

property PixelFormat: TJPEGPixelForm;

説明

PixelFormat プロパティは，JPEG イメージのピクセル形式を，24 ビット表示ができないビデオドライバ用に 8 ビットに設定できます。JPEG イメージのネイティブ形式は 24 ビットです。PixelFormat はファイルの伸長，ないしは読み込みで使います。また，PixelFormat は，イメージがビットマップにコピーされた場合にそのビットマップにも適用されます。


TJPEGImage.ProgressiveDisplay
TJPEGImage.ProgressiveDisplay3293011

TJPEGImage	参照

ProgressiveDisplay プロパティは，ファイルを伸長するときのイメージの表示方法を制御します。

property ProgressiveDisplay: Boolean;

説明

ProgressiveDisplay を使うと，ファイルを読み込むときのイメージのインクリメンタル表示のオン／オフを切り替えることができます。たとえば，ファイルをダウンロードする必要があり，ダウンロード処理にイメージを段階的に表示するのと同じくらい時間がかかる場合は，ProgressiveDisplay を True に設定すると，ユーザーの体感時間が短くなるでしょう。JPEG データソースファイルが HD 上にある場合，段階的に表示してゆくようにすると，かえって表示に時間がかかります。この場合，ProgressiveDisplay を False に設定すると，イメージの表示をスピードアップできます。

ProgressiveDisplay は伸長でのみ使いますが，イメージの圧縮のしかたの影響を受けます。ProgressiveEncoding を False に設定して圧縮したイメージでは，ProgressiveDisplay を利用できません。そのようなイメージの場合，ProgressiveDisplay を True に設定しても無効です。


TJPEGImage.ProgressiveEncoding
TJPEGImage.ProgressiveEncoding3293012

TJPEGImage	参照

ProgressiveEncoding プロパティは，イメージの伸長時に段階的にイメージを表示できるかどうかを決めます。

property ProgressiveEncoding: Boolean;

説明

ProgressiveEncoding プロパティは，伸長の際に段階的にファイルを表示できるようにする圧縮方法でイメージを圧縮できます。イメージの圧縮時に ProgressiveEncoding が True に設定されていなければ，ProgressiveDisplay プロパティを True に設定しても無効です。


TJPEGImage.Scale
TJPEGImage.Scale3293013

TJPEGImage

Scale プロパティは，JPEG イメージの表示サイズを決めます。

TJPEGScale = (jsFullSize, jsHalf, jsQuarter, jsEighth);

property Scale: TJPEGScale;

説明

Scale を使うと，イメージのプレビューのパフォーマンスを最適化できます。jsFullSize を指定すると，イメージは元のサイズで表示されます。jsEight を指定するとイメージのサイズの 8 分の 1 になります。

TJPEGScale は Scale プロパティの型です。以下に TJPEGScale の値を示します。

値	意味

jsFullSize	フルサイズで表示

jsHalf	半分のサイズで表示。フルサイズの場合に比べて表示にかかる時間は半分になる

jsQuarter	4 分の 1 のサイズで表示。

jsEighth	8 分の 1 のサイズで表示。

Scale はファイルの読み込み，ないしは伸長で使います。


TJPEGImage.Smoothing
TJPEGImage.Smoothing3293014

TJPEGImage	参照

Smoothing プロパティは，JPEG イメージをブロックで表示するか，端をぼやかして表示するかを決めます。

property Smoothing: Boolean;

説明

Smoothing プロパティは，ProgressiveDisplay が True の場合に，JPEG イメージを小さなブロックで表示するか，端をぼやかして表示するかを決めるのに使われます。Smoothing が True ならば，イメージを段階的に表示するときに端がぼやけた状態で表示されます。Smoothing が False ならば，イメージの表示にカラーのローブロックが使われます。


TJPEGImage.Width
TJPEGImage.Width3293015

TJPEGImage

Width プロパティは，JPEG イメージの水平方向のサイズをピクセル数で指定します。

property Width: Integer;

説明

Width プロパティは，JPEG イメージの水平方向のサイズ（ピクセル数）を調べることができます。


TJPEGImage のイベント3293016

TJPEGImage	アルファベット順

TGraphic からの継承

OnChange

OnProgress


TJPEGImage のイベント3293017

TJPEGImage	オブジェクト順

OnChange

OnProgress


TJPEGImage のメソッド3293018

TJPEGImage	アルファベット順

TJPEGImage

Assign

Compress

Create

Destroy

DIBNeeded

JPEGNeeded

LoadFromClipboardFormat

LoadFromStream

SaveToClipboardFormat

SaveToStream

TGraphicからの継承

LoadFromFile

SaveToFile

TPersistentからの継承

GetNamePath

TObjectからの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TJPEGImage のメソッド3293019

TJPEGImage	オブジェクト順

Assign

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Compress

Create

DefaultHandler

Destroy

DIBNeeded

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

JPEGNeeded

LoadFromClipboardFormat

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

SafeCallException

SaveToClipboardFormat

SaveToFile

SaveToStream


TJPEGImage.Assign
TJPEGImage.Assign3293020

TJPEGImage	参照

Assign メソッドは，JPEG イメージオブジェクトをコピーし，内部データソースオブジェクトへの新しい参照を作成します。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドは，Source 内の JPEG イメージを JPEG イメージオブジェクトにコピーしてから，継承する Assign を呼び出します。Assign は，JPEG イメージオブジェクトが参照カウントとハンドル共有を行うのに使う内部 JPEG データソースへの新しいリンクを作成します。

注意

JPEG イメージを描画するには，JPEG イメージをビットマップに代入してから，その上で描画します。

注意

ある型のオブジェクトは常に同じ型の別のオブジェクトに代入できます。また，Source は，Graphic プロパティが JPEG イメージまたはビットマップである TPicture 型でもかまいません。


TJPEGImage.Create
TJPEGImage.Create3293021

TJPEGImage	参照

Create メソッドは，JPEG イメージオブジェクトをインスタンス化します。

type

TJPEGDefaults = record

    CompressionQuality: TJPEGQualityRange;

    Grayscale: Boolean;

    Performance: TJPEGPerformance;

    PixelFormat: TJPEGPixelFormat;

    ProgressiveDisplay: Boolean;

    ProgressiveEncoding: Boolean;

    Scale: TJPEGScale;

    Smoothing: Boolean;

end;

constructor Create; override;

説明

Create メソッドを呼び出すと，実行時に JPEG イメージオブジェクトをインスタンス化できます。

Create は JPEG イメージオブジェクトにメモリを割り当て，継承する Create を呼び出します。次に Create は TJPEGDefaults 型のレコードを使って以下のプロパティの値を初期化します。

・	CompressionQuality

・	Grayscale

・	Performance

・	PixelFormat

・	ProgressiveDisplay

・	ProgressiveEncoding

・	Scale

・	Smoothing

JPEG がファイルからロードされた後で，そのイメージの内部ビットマップが作成されます。


TJPEGImage.Compress
TJPEGImage.Compress3293022

TJPEGImage	参照

Compress メソッドは，圧縮処理を実行します。

procedure Compress;

説明

Compress メソッドは，ビットマップを JPEG に代入するために圧縮が必要なときに呼び出します。CompressionQuality などのプロパティを変更しても，圧縮は実行されません。圧縮の実行が必要なときには，Compress を呼び出さなければなりません。


TJPEGImage.DIBNeeded
TJPEGImage.DIBNeeded3293023

TJPEGImage	参照

DIBNeeded メソッドは，JPEG イメージからビットマップを伸長するために使います。

procedure DIBNeeded;

説明

DIBNeeded メソッドは，ビットマップへの伸長が必要なときに使います。たとえば，描画速度を上げるために，描画のをはじめる前に DIBNeeded を呼び出しておくことができます。


TJPEGImage.Destroy
TJPEGImage.Destroy3293024

TJPEGImage	参照

Destroy メソッドは，JPEG イメージオブジェクトのインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy を呼び出さないでください。アプリケーションで，かわりに Free を呼び出します。Free は JPEG イメージオブジェクトが解放されていないことを確認してから Destroy を呼び出します。

Destroy は，内部ビットマップイメージの解放を処理し，リンクされている JPEG データソースの参照カウントを減らしてから，継承する Destroy を呼び出します。


TJPEGImage.JPEGNeeded
TJPEGImage.JPEGNeeded3293025

TJPEGImage	参照

JPEGNeeded メソッドは，JPEG イメージがビットマップだけを持っていて，JPEG が必要な場合に新しい TJPEGData オブジェクトを作成します。

procedure JPEGNeeded;

説明

JPEGNeeded を呼び出すと，JPEG イメージが JPEG データを破棄し，内部ビットマップだけを持っているときに，新しい JPEG データソースを作成します。JPEG イメージオブジェクトは新しい JPEG データソースを作成します。JPEGNeeded は SaveToStream から呼ばれます。


TJPEGImage.LoadFromClipboardFormat
TJPEGImage.LoadFromClipboardFormat3293026

TJPEGImage	参照

LoadFromClipboardFormat メソッドは，JPEG イメージをクリップボードから JPEG イメージオブジェクトへ読み込みます。

procedure LoadFromClipboardFormat(AFormat: Word; AData: THandle; APalette: HPALETTE); override;

説明

LoadFromClipboardFormat メソッドは，JPEG イメージが RegisterClipboardFormat メソッドにより TPicture オブジェクトに登録されている場合に呼び出されます。また，LoadFromClipboardFormat はクリップボード上のビットマップ形式を認識およびサポートできます。

LoadFromClipboardFormat は現在のイメージを AData パラメータによって示されるデータに置換します。JPEG イメージのパレットは APalette パラメータで指定されます。


TJPEGImage.LoadFromStream
TJPEGImage.LoadFromStream3293027

TJPEGImage	参照

LoadFromStream メソッドは，ストリームから JPEG イメージをロードします。

procedure LoadFromStream(Stream: TStream); override;

説明

LoadFromStream メソッドは，JPEG イメージのロード元のストリームを Stream の値として指定して使います。LoadFromStream はストリームから JPEG データソースを読み出して，現在のイメージを置換します。


TJPEGImage.SaveToClipboardFormat
TJPEGImage.SaveToClipboardFormat3293028

TJPEGImage	参照

SaveToClipboardFormat メソッドは，JPEG イメージをクリップボード形式に書き出します。

procedure SaveToClipboardFormat(var AFormat: Word; var AData: THandle; var APalette: HPALETTE); override;

説明

SaveToClipboardFormat メソッドを呼び出すと，パレットを APalette パラメータの値として，形式を AFormat の値として，保存するデータを AData の値としてそれぞれ指定して，JPEG イメージをクリップボード形式に保存できます。イメージを保存するには，その前にアプリケーションは RegisterClipboardFormat メソッドを使って TJPEG オブジェクトに形式を登録しておく必要があります。


TJPEGImage.SaveToStream
TJPEGImage.SaveToStream3293029

TJPEGImage	参照

SaveToStream メソッドは，JPEG データをストリームに書き出します。

procedure SaveToStream(Stream: TStream); override;

説明

SaveToStream メソッドを呼び出すと，JPEG データを Stream パラメータで指定するストリームに保存できます。SaveToStream は JPEG イメージデータを予期しているので，データソースが JPEG イメージをまだ持っていないときには JPEG 圧縮のためのオーバーヘッドが生じることがあります。


アクセス種別3293030

読み出し専用


継承3293031

TObject

TPersistent

TGraphic


TJPEGImage の例3293032

TJPEGImage


TLabel
TLabel3294001

継承	プロパティ	メソッド	イベント	参照	例

説明

ユニット

stdctrls

TLabel は，フォーム上にテキストを表示する非ウィンドウコントロールです。

TLabel を使用して,フォームにテキストを追加します。このテキストは他のコントロールのラベルとして使うことができ，また，ユーザーがアクセラレータキーを入力したときに，そのコントロールにフォーカスを設定することができます。

TLabel は TWinControl の下位オブジェクトではないので，独自のウィンドウを持たず，キーボードから直接の入力を受け取ることはできません。テキストの表示に加えて，キーボード入力に応答（アクセラレータキーを入力したときに他のオブジェクトにフォーカスを設定する以外）できるオブジェクトをフォームに追加するには，TStaticText を使います。

ユーザーがスクロールまたは編集可能なテキストを表示するオブジェクトをフォームに追加するには，TEdit を使います。


TLabel プロパティ3294002

TLabel	アルファベット順	凡例

TCustomLabel からの継承

Alignment

AutoSize

FocusControl

Layout

ShowAccelChar

Transparent

WordWrap

TGraphicControl からの継承

Canvas

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TLabel プロパティ3294003

TLabel	オブジェクト順	凡例

Align

Alignment

AutoSize

BoundsRect

Canvas

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlState

ControlStyle

Cursor

DesignInfo

DragCursor

DragMode

Enabled

FocusControl

Font

Height

Hint

Layout

Left

Name

Owner

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowAccelChar

ShowHint

Tag

Top

Transparent

VCLComObject

Visible

Width

WindowProc

WordWrap


TLabel イベント3294004

TLabel	アルファベット順	凡例

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TLabel イベント3294005

TLabel	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TLabel メソッド3294006

TLabel	アルファベット順

TCustomLabel からの継承

Create

TGraphicControl からの継承

Destroy

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Invalidate

Perform

Refresh

Repaint

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TLabel メソッド3294007

TLabel	オブジェクト順

Assign

BeginDrag

BringToFront

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DragDrop

Dragging

EndDrag

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTextBuf

GetTextLen

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Perform

Refresh

RemoveComponent

Repaint

SafeCallException

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update


スコープ3294008

published

読み出し／書き込み

読み出し専用


スコープ3294009

published


継承3294010

TObject

TPersistent

TComponent

TControl

TGraphicControl

TCustomLabel


TLabel 例3294011

TLabel


TList
TList3295001

継承	プロパティ	メソッド	参照

TList オブジェクトにはオブジェクトへのポインタのリストが保持されます。

ユニット

classes

説明

TList オブジェクトを使って，オブジェクトのリストを保存および管理します。TList オブジェクトのプロパティとメソッドの用途は次のとおりです。

・	リストのオブジェクトを追加または削除する

・	リストのオブジェクトを配列し直す

・	リストにあるオブジェクトを検索およびアクセスする

・	リストにあるオブジェクトをソートする


TList プロパティ3295002

TList	アルファベット順	凡例

TList

Capacity

Count

Items

List


TList プロパティ3295003

TList	オブジェクト順	凡例

Capacity

Count

Items

List


TList.Capacity
TList.Capacity3295004

TList	参照

Capacity プロパティは，TList オブジェクトがポインタの配列を保持する割り当てサイズです。

property Capacity: Integer;

説明

Capacity プロパティには，リストに保持するポインタの数を設定します。Capacity プロパティを設定して，指定されたサイズにリストを拡張するために必要なメモリがない場合には EOutOfMemory 例外が発生します。

Capacity プロパティは，メモリを割り当て直さなくても，リストが保持できるオブジェクト数を取得できます。Capacity プロパティと Count プロパティを混同しないでください。Count プロパティは使用されているリスト内のエントリ数です。Capacity プロパティの値は必ず Count プロパティの値と等しいかまたはそれ以上になります。Capacity プロパティが Count プロパティより大きい場合，Capacity プロパティを Count プロパティと同じ値に設定するとメモリの無駄を防げます。

すでに容量がいっぱいのリストにオブジェクトを追加すると，Capacity プロパティの値は自動的に増えます。オブジェクトを追加する前に Capacity プロパティを設定しておくと，メモリ再割り当ての回数が減り，結果として性能が向上します。たとえば次のようにします。

List.Clear;

List.Capacity := Count;

for I := 1 to Count do List.Add(...);

for ループの前に Capacity プロパティへの代入を行うことによって，以降の Add 演算のたびにリストの再割り当てをしないで済みます。Add メソッドの呼び出しで再割り当てを回避すると，性能が向上し，また Add 演算が例外を発生することもなくなります。


TList.Count
TList.Count3295005

TList	参照

Count プロパティは，リスト内の使用されているエントリ数です。

property Count: Integer;

説明

Count プロパティは，Items 配列のエントリ数を取得できます。

Count プロパティのサイズを増やすと，必要な数の nil ポインタが Items 配列の最後に追加されます。Count プロパティのサイズを減らすと，必要な数のエントリが Items 配列の最後から削除されます。

Count プロパティは必ずしもリスト内で参照されるオブジェクト数と一致しません。Items 配列のエントリのいくつかには nil ポインタが含まれています。nil ポインタを削除し，Count プロパティをオブジェクトへの参照を含むエントリの数に設定するには，Pack メソッドを呼び出します。


TList.Items
TList.Items3295006

TList	参照

Items プロパティは，オブジェクト参照の配列です。

property Items[Index: Integer]: Pointer;

説明

Items プロパティは，配列内の特定のオブジェクトへのポインタが取得できます。Index パラメータはオブジェクトのインデックスを示します。0 が最初のオブジェクトのインデックス，1 が 2 番目のオブジェクトのインデックス，というようになっています。Items プロパティを設定して，特定の位置の参照を変更できます。

Items プロパティを Count プロパティと一緒に使うと，リスト内のすべてのオブジェクトを処理できます。

必ずしも Items 配列のすべてのエントリにオブジェクトへの参照が含まれているわけではありません。いくつかのエントリは nil ポインタの可能性があります。nil ポインタを削除し，Items 配列のサイズをオブジェクトの数まで削減するには，Pack メソッドを呼び出します。


TList.List
TList.List3295007

TList	参照

List プロパティは，Items 配列を構成するポインタの配列へのポインタです。

TPointerList = array[0..MaxListSize-1] of Pointer;

PPointerList = ^TPointerList;

property List: PPointerList;

説明

List プロパティは Items 配列に直接にアクセスできます。


TList メソッド3295008

TList	アルファベット順

TList

Add

Clear

Delete

Destroy

Error

Exchange

Expand

First

IndexOf

Insert

Last

Move

Pack

Remove

Sort

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TList メソッド3295009

TList	オブジェクト順

Add

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Delete

Destroy

Dispatch

Error

Exchange

Expand

FieldAddress

First

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

IndexOf

InheritsFrom

InitInstance

Insert

InstanceSize

Last

MethodAddress

MethodName

Move

NewInstance

Pack

Remove

SafeCallException

Sort


TList.Add
TList.Add3295010

TList	参照

Add メソッドは，リストの最後に新しい項目を追加します。

function Add(Item: Pointer): Integer;

説明

Add メソッドを呼び出すと，Items 配列の最後に新しいオブジェクトを追加できます。Add メソッドは新しい項目のインデックスを返します。リストの最初の項目のインデックスは 0 です。

Add メソッドは，Item 配列がリストオブジェクトの Capacity プロパティの容量をすでに使い切っている場合にさらにメモリを割り当てます。また，Add メソッドは新しいポインタの追加を反映して Count プロパティの値を増やします。

注意

Add メソッドは，Item 配列に nil ポインタが含まれていても，必ず Item ポインタを Item 配列の最後に挿入します。


TList.Clear
TList.Clear3295011

TList	参照

Clear メソッドは，リストからすべての項目を削除します。

procedure Clear;

説明

Clear メソッドを呼び出すと，Items 配列が空になり，Count プロパティが 0 に設定されます。また，Clear メソッドは Item 配列を格納するために使われていたメモリを解放し，Capacity プロパティを 0 に設定します。


TList.Delete
TList.Delete3295012

TList	参照

Delete メソッドは，Index パラメータで指定された位置にある項目を削除します。

procedure Delete(Index: Integer);

説明

Delete メソッドを呼び出すと，リストから特定の位置にある項目が削除されます。インデックスはどの場合も 0 で始まるので，最初の項目の Index 値 0，2 番目の項目の Index 値は 1 になります。Delete メソッドを呼び出すと，削除された項目にしたがって Items 配列のすべての項目が押し上げられ，Count. プロパティの値が減少します。

Items 配列からエントリを削除することなく，そして Count プロパティの値を変更することなく項目への参照を削除するには，Index の Items プロパティを nil に設定します。

注意

Delete メソッドは項目に関連付けられたメモリを解放しません。削除された項目を格納するために使われていたメモリを解放するには，Capacity プロパティを設定します。


TList.Destroy
TList.Destroy3295013

TList	参照

Destroy メソッドは，TList のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接に Destroy メソッドを呼び出さないでください。代わりに Free メソッドを呼び出します。Free メソッドは，TList オブジェクトに割り当てられたメモリがまだ解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは項目のリストを格納するために使われていたメモリを解放します。


TList.Error
TList.Error3295014

TList	参照

Error メソッドは，EListError 例外を生成します。

class procedure Error(const Msg: string; Data: Integer); virtual;

説明

Error メソッドを呼び出すと，TList オブジェクトでエラーが発生したときに例外を生成することができます。Error は Msg パラメータで渡された形式設定文字列と Data パラメータで渡されたデータ値からエラーメッセージを解釈して，EListError 例外を生成します。

次のような行を追加するかわりに Error を呼び出せば，アプリケーションのコードサイズを小さくすることができます。

raise EListError.CreateFmt(MyMsg, iBadValue);


TList.Exchange
TList.Exchange3295015

TList	参照

Exchange メソッドは Itetms 配列内の 2 つの項目の位置を入れ替えます。

procedure Exchange(Index1, Index2: Integer);

説明

Exchange メソッドを呼び出すと，Items 配列の Index1 および Index2 の位置にある項目を入れ替えることができます。インデックスは必ず 0 から始まるので，最初の項目のインデックス値は 0，2 番目の項目のインデックス値は 1 となります。


TList.Expand
TList.Expand3295016

TList	参照

Expand メソッドは，リストの Capacity プロパティの値を拡張します。

function Expand: TList;

説明

Expand メソッドを呼び出すと，リストに項目を追加するために容量を拡大します。Expand メソッドは，リストがまだ Capacity の設定をいっぱいに使っていない場合は無効です。

Count = Capacity の場合，Expand メソッドはリストの Capacity プロパティの値を次のように増やします。Capacity プロパティの値が 8 より大きい場合，Expand メソッドはリストの Capacity プロパティを 16 増やします。Capacity の値が 4 より大きく 9 より小さい場合，リストの Capacity を 8 増やします。Capacity の値が 4 より小さい場合，リストの Capacity の値を 4 増やします。

戻り値は拡張されたリストオブジェクトです。


TList.First
TList.First3295017

TList	参照

First メソッドは，Items[0] を返します。

function First: Pointer;

説明

First メソッドを呼び出すと，Items 配列の最初のポインタを取得できます。


TList.IndexOf
TList.IndexOf3295018

TList	参照

IndexOf メソッドは，Items 配列内で Item の値を持つ最初のエントリのインデックスです。

function IndexOf(Item: Pointer): Integer;

説明

IndexOf メソッドを呼び出すと，Items 配列内のポインタのインデックスが取得できます。配列の最初の項目のインデックスは 0，2 番目の項目のインデックスは 1 です。項目がリストにない場合，IndexOf メソッドは -1 を返します。配列内でポインタが 2 回以上現れる場合，IndexOf メソッドは最初のインデックスを返します。


TList.Insert
TList.Insert3295019

TList	参照

Insert メソッドは，Items 配列の Index で指定された位置にオブジェクトを追加します。

procedure Insert(Index: Integer; Item: Pointer);

説明

Insert メソッドを呼び出すと，Items 配列に項目を追加できます。Index パラメータには 0 から始まるインデックスを指定するので，配列の最初の位置のインデックスは 0 です。Insert メソッドは指定の位置に項目を追加し，その位置に以前にあった項目およびそれ以降の項目を移動します。Insert メソッドは，必要ならリストの Capacity プロパティの値を拡張し，Count プロパティの値を増やします。

Items 配列を大きくせずに配列内の nil ポインタを新しい項目で置き換えるには，Items プロパティを設定します。


TList.Last
TList.Last3295020

TList	参照

Last メソッドは，Items[Count - 1] を返します。

function Last: Pointer;

説明

Last メソッドを呼び出すと，Items 配列の最後のポインタを取り出せます。


TList.Move
TList.Move3295021

TList	参照

Move メソッドは，Items 配列内の項目の位置を変更します。

procedure Move(CurIndex, NewIndex: Integer);

説明

Move メソッドを呼び出すと，CurIndex の位置にある項目を NewIndex の位置に移動できます。CurIndex と NewIndex には 0 から始まるインデックスが入ります。


TList.Pack
TList.Pack3295022

TList	参照

Pack メソッドでは，Items 配列からすべての nil 項目を削除します。

procedure Pack;

説明

Pack メソッドを呼び出すと，nil 項目以外のすべての項目を Items 配列の前の方に移動し，Count プロパティの値を実際に使われている項目数に設定します。Pack メソッドは nil ポインタを格納するために使われていたメモリを解放しません。Pack メソッドによって削除された未使用のエントリのメモリを解放するには，Capacity プロパティを Count プロパティの新しい値に設定します。


TList.Remove
TList.Remove3295023

TList	参照

Remove メソッドは，Item パラメータへの最初の参照を Items 配列から削除します。

function Remove(Item: Pointer): Integer;

説明

Remove メソッドを呼び出すと，インデックスが未知の場合に特定の項目を Items 配列から削除します。戻り値は削除される前の項目のインデックスです。項目が削除されると，それに以降のすべての項目のインデックス位置が繰り上がり，Count プロパティが 1 減ります。

Items 配列にポインタの複数のコピーがある場合，最初のコピーだけが削除されます。


TList.Sort
TList.Sort3295024

TList	参照

Sort メソッドは，比較関数 Compare に基づいてリストのクイックソートを行います。

TListSortCompare = function (Item1, Item2: Pointer): Integer;

procedure Sort(Compare: TListSortCompare);

説明

Sort メソッドを呼び出すと，Items 配列の項目がソートされます。Compare は項目の並び順を指定する比較関数です。Compare は，Item1 が Item2 より小さい場合に < 0，Item1 と Item2 が等しければ 0，Item1 が Item2 より大きい場合に > 0 を返します。


読み出し／書き込み3295025

読み出し専用


継承3295026

TObject


TList 例3295027

TList


TListBox
TListBox3296001

継承	プロパティ	メソッド	イベント	参照

TListBox コンポーネントは Windows リストボックスコントロールのラッパーです。

ユニット

stdctrls

説明

TListBox コンポーネントは，TCustomListbox で導入されている汎用動作を実装しています。TListBox コンポーネントは TCustomListbox から多くのプロパティを継承していますが，新しい動作は導入していません。

TListBox コンポーネントを使うと，ユーザーが選択，追加，および削除を行える項目のスクロール可能なリストを表示できます。専門化したリストボックスを表示するには，TCustomListBox の他の下位クラスを使うか，または TCustomListBox から継承します。


TListBox プロパティ3296002

TListBox	アルファベット順	凡例

TCustomListBox からの継承

BorderStyle

Canvas

Columns

ExtendedSelect

IntegralHeight

ItemHeight

ItemIndex

Items

MultiSelect

SelCount

Selected

Sorted

Style

TabWidth

TopIndex

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TListBox プロパティ3296003

TListBox	オブジェクト順	凡例

Align

BorderStyle

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

Enabled

ExtendedSelect

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

IntegralHeight

ItemHeight

ItemIndex

Items

Left

MultiSelect

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

SelCount

Selected

ShowHint

Showing

Sorted

Style

TabOrder

TabStop

TabWidth

Tag

Top

TopIndex

VCLComObject

Visible

Width

WindowProc


TListBox イベント3296004

TListBox	アルファベット順	凡例

TCustomListBox からの継承

OnDrawItem

OnMeasureItem

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TListBox イベント3296005

TListBox	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnDrawItem

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMeasureItem

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TListBox メソッド3296006

TListBox	アルファベット順

TCustomListBox からの継承

Clear

Create

Destroy

ItemAtPos

ItemRect

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TListBox メソッド3296007

TListBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

ItemAtPos

ItemRect

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


スコープ3296008

published

読み出し／書き込み

読み出し専用


スコープ3296009

published


継承3296010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomListBox


TListBox 例3296011

TListBox


TListItem
TListItem3297001

継承	プロパティ	メソッド	参照

TListItem オブジェクトは TListView コントロールの個々の項目です。

ユニット

comctrls

説明

TListItem を使うと，リストビューでの項目の体裁およびデータの関連付けを指定できます。リストビューのすべてのリスト項目は TListItems オブジェクトによって集められ，TListView コントロールの Items プロパティになります。


TListItem プロパティ3297002

TListItem	アルファベット順	凡例

TListItem

Caption

Checked

Cut

Data

DropTarget

Focused

Handle

ImageIndex

Index

Left

ListView

OverlayIndex

Owner

Selected

StateIndex

SubItems

Top


TListItem プロパティ3297003

TListItem	オブジェクト順	凡例

Caption

Checked

Cut

Data

DropTarget

Focused

Handle

ImageIndex

Index

Left

ListView

OverlayIndex

Owner

Selected

StateIndex

SubItems

Top


TListItem.Caption
TListItem.Caption3297004

TListItem	参照

Caption プロパティは，リストの項目のラベルになるテキストを指定します。

property Caption: string;

説明

Caption プロパティは，リスト項目に名前を付けることができます。Caption はリストビューの ViewStyle プロパティに基づく関連付けられているイメージとともに表示されます。

リストビューの ReadOnly プロパティが False の場合，ユーザーはキャプションを編集できます。


TListItem.Checked
TListItem.Checked3297005

TListItem	参照

Checked プロパティは，リスト項目の隣にチェックマークが表示されるかどうかを決めます。

property Checked: Boolean;

説明

Checked プロパティは，リスト項目が，選択されているオプションをリストビューでリスト項目の隣にチェックマークを付けて表示するかどうかを指定できます。Checked が True ならば，項目の隣にチェックマークが表示されます。Checked が False ならば，チェックマークは表示されません。


TListItem.Cut
TListItem.Cut3297006

TListItem	参照

Cut プロパティは，リスト項目が切り取り操作で選択された場合と同じように表示されるかどうかを決めます。

property Cut: Boolean;

説明

Cut プロパティを設定すると，リスト項目に，Windows のエクスプローラで切り取りのために選択されている項目のような淡色表示の外観を与えることができます。Cut は実際に項目をクリップボードにコピーしたり，リストから削除したりはしないので，アプリケーションはそれらの処理を自身で行う必要があります。


TListItem.Data
TListItem.Data3297007

TListItem	参照

Data プロパティは，リスト項目に関連付けられているアプリケーション固有のデータを指定します。

property Data: Pointer;

説明

Data プロパティは，任意のデータ構造をリスト項目に関連付けることができます。ユーザーがリスト項目を選択または選択解除したとき，Data はアプリケーションがリスト項目の意味についての情報にすばやくアクセスして，適切な応答を実現できるようにします。


TListItem.DropTarget
TListItem.DropTarget3297008

TListItem	参照

DropTarget プロパティは，リスト項目がドラッグアンドドロップのターゲットとして選択された状態で表示されるかどうかを決めます。

property DropTarget: Boolean;

説明

DropTarget プロパティは，リスト項目を，ユーザーがドラッグしているオブジェクトの現在のドロップ先として表示できます。DropTarget を True に設定すると，リストビューの他のすべての項目の DropTarget プロパティが False に設定されます。


TListItem.Focused
TListItem.Focused3297009

TListItem	参照

Focused プロパティは，リスト項目に入力フォーカスが設定されているかどうかを示します。

property Focused: Boolean;

説明

Focused プロパティを True に設定すると，ユーザーが Caption を編集できるようになります。Focused を True に設定すると，リストビューの他のすべての項目の Focused プロパティが False に設定されます。リスト項目にフォーカスがあるときは，その項目はハイライト表示されます。


TListItem.Handle
TListItem.Handle3297010

TListItem	参照

Handle プロパティは，リスト項目を所有するリストビューのウィンドウハンドルです。

property Handle: HWND;

説明

Handle プロパティは，リストビューウィンドウへのハンドルを必要とする Windows API 関数呼び出しでパラメータとして使います。


TListItem.ImageIndex
TListItem.ImageIndex3297011

TListItem	参照

ImageIndex プロパティは，リスト項目のアイコンとしてどのイメージを表示するかを決めます。

property ImageIndex: Integer;

説明

ImageIndex プロパティを設定すると，リスト項目を，リストビューの LargeImages または SmallImages プロパティのイメージのいずれかに関連付けることができます。リストビューの ViewStyle が vsIcon ならば，ImageIndex はリストビューの LargeImages プロパティのイメージのインデックスになり，0 で 1 番目のイメージが指定されます。リストビューの ViewStyle が vsSmallIcon，vsList または vsReport ならば，ImageIndex はリストビューの SmallImages プロパティのイメージのインデックスになります。


TListItem.Index
TListItem.Index3297012

TListItem	参照

Index プロパティは TListItems コレクション内でのリスト項目の位置です。

property Index: Integer;

説明

Index プロパティは，リストビュー内の項目を検索することができます。1 番目の項目のインデックスが 0 になり，2 番目の項目のインデックスが 1 になります。


TListItem.Left
TListItem.Left3297013

TListItem	参照

Left プロパティは，リストビューの左端からリスト項目の左端までの距離（ピクセル数）です。

property Left: Integer;

説明

Left プロパティは，リストビュー内でのリスト項目の水平方向の位置を決めることができます。Left プロパティは，リストビューの ViewStyle プロパティが vsIcon または vsSmallIcon のときにのみ使います。


TListItem.ListView
TListItem.ListView3297014

TListItem	参照

ListView プロパティは，リスト項目を表示するリストビューコントロールです。

property ListView: TCustomListView;

説明

ListView プロパティは，リスト項目を表示するリストビューオブジェクトにアクセスできます。リストビューオブジェクトのプロパティとメソッドを使うと，リスト項目に影響する変更を行ったり，リスト内の他の項目を操作したりすることができます。

リスト項目を表示する ListView と，項目の Owner とを混同しないでください。Owner はすべてのリスト項目のコレクションを管理する TListItems オブジェクトです。リストビューは Owner の Owner です。


TListItem.OverlayIndex
TListItem.OverlayIndex3297015

TListItem	参照

OverlayIndex プロパティは，イメージリストのどのイメージをオーバーレイマスクとして使うかを決めます。

property OverlayIndex: Integer;

説明

OverlayIndex プロパティは，リストビューの ViewStyle が vsIcon または vsSmallIcon のとき，リスト内の項目にオーバーレイマスクを表示できます。OverlayIndex はリストビューの StateImages プロパティのオーバーレイイメージのインデックスです。

オーバーレイマスクはリストビューの項目のアイコンの上に透過的に描画されるイメージです。たとえば，現在の項目のイメージ上に X のオーバーレイイメージを描画して，その項目が使用可能でなくなったことを表すことができます。


TListItem.Owner
TListItem.Owner3297016

TListItem	参照

Owner プロパティは，リスト項目を所有する TListItems オブジェクトをを示します。

property Owner: TListItems;

説明

Owner プロパティは，リストビューのすべてのリスト項目を管理する TListItems オブジェクトにアクセスできます。Owner オブジェクトのメソッドを使うと，リスト項目を変更している間，またはリスト項目を追加または削除するために，一時的にリスト項目のイメージを更新できないようにすることができます。

Owner プロパティとリスト項目を表示するリストビューコントロールとを混同しないでください。ListView プロパティはリストビューコントロールを指定します。


TListItem.Selected
TListItem.Selected3297017

TListItem	参照

Selected プロパティは，リスト項目が選択されているかどうかを指定します。

property Selected: Boolean;

説明

Selected プロパティは，リスト項目を選択または選択解除できます。リストビューの MultiSelect プロパティが False の場合，Selected を True に設定すると，リストビューの他のすべてのリスト項目の Selected プロパティが False に設定されます。選択されている項目の外観は，フォーカスがあるかどうか，選択にシステムカラーが使われているかどうかによって異なります。


TListItem.StateIndex
TListItem.StateIndex3297018

TListItem	参照

StateIndex プロパティは，項目に対して表示するイメージを StateImages のイメージリストから指定します。

property StateIndex: Integer;

説明

StateIndex プロパティを設定すると，リスト項目を，リストビューの StateImages プロパティのイメージのいずれかに関連付けることができます。0 は 1 番目のイメージを示します。StateIndex プロパティを変更すると，項目の状態が変更されたときに別のイメージを表示できます。

状態イメージは通常のリスト項目の左に表示されます。


TListItem.SubItems
TListItem.SubItems3297019

TListItem

SubItems プロパティは，リスト項目の下位項目として表示される文字列を示します。

property SubItems: TStrings;

説明

SubItems プロパティは，リストビューの ViewStyle プロパティが vsReport のときに，リストビュー項目の右側の列に表示される文字列を追加することができます。SubItems プロパティを実現する TStrings オブジェクトはリスト項目の作成時に作成されます。下位項目を追加または削除するには，SubItems のメソッドを使います。

注意

リストビューの ViewStyle プロパティが vsReport に設定されている場合のみ下位項目が表示されます。

参照TCustomListView.ViewStyle プロパティ，TStrings オブジェクト


TListItem.Top
TListItem.Top3297020

TListItem	参照

Top プロパティは，リストビューの上端からリスト項目の上端までの距離（ピクセル数）です。

property Top: Integer;

説明

Top プロパティは，リストビュー内でのリスト項目の垂直方向の位置を設定できます。Top プロパティは，リストビューの ViewStyle プロパティが vsIcon または vsSmallIcon のときにのみ使います。


TListItem メソッド3297021

TListItem	アルファベット順

TListItem

CancelEdit

Create

Delete

Destroy

DisplayRect

EditCaption

GetPosition

MakeVisible

SetPosition

Update

TPersistent からの継承

 	Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TListItem メソッド3297022

TListItem	オブジェクト順

 	Assign

CancelEdit

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Delete

Destroy

Dispatch

DisplayRect

EditCaption

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetPosition

InheritsFrom

InitInstance

InstanceSize

MakeVisible

MethodAddress

MethodName

NewInstance

SafeCallException

SetPosition

Update


TListItem.CancelEdit
TListItem.CancelEdit3297023

TListItem	参照

CancelEdit メソッドは，リスト項目のキャプションの編集をキャンセルします。

procedure CancelEdit;

説明

CancelEdit メソッドを呼び出すと，リスト項目のキャプションの編集を終了させることができます。ユーザーが行った変更はすべて破棄されます。


TListItem.Create
TListItem.Create3297024

TListItem	参照

Create メソッドは，TListItem のインスタンスを作成します。

constructor Create(AOwner: TListItems);

説明

Create メソッドを呼び出すと，実行時に TListItem オブジェクトをインスタンス化できます。設計時にリストビューに追加したリスト項目は自動的に作成されます。実行時には，TListItems オブジェクトの Add メソッドを使ってリスト項目を作成し，リストビューに追加します。


TListItem.Delete
TListItem.Delete3297025

TListItem	参照

Delete メソッドは，リストビューからリスト項目を削除します。

procedure Delete;

説明

Delete メソッドを呼び出すとリスト項目を削除できます。Delete メソッドは，リストビューのイメージから項目を削除してから，Free メソッドを呼び出して関連付けられているメモリをすべて解放します。


TListItem.Destroy
TListItem.Destroy3297026

TListItem	参照

Destroy メソッドは，TListItem のインスタンスを破棄します。

destructor Destroy; override;

説明

直接 Destroy メソッドを呼び出さないでください。かわりに Delete メソッドを使います。Delete メソッドはリストビューウィンドウから項目を削除してから，関連付けられているメモリを解放します。


TListItem.DisplayRect
TListItem.DisplayRect3297027

TListItem	参照

DisplayRect メソッドは，リスト項目の境界となる長方形を返します。

function DisplayRect(Code:TDisplayCode): TRect;

説明

DisplayRect メソッドを呼び出すと，リスト項目の表示座標を取得できます。Code パラメータは，項目のどの部分を境界となる長方形で囲むかを指定します。Code パラメータに使える値は次のとおりです。

値	意味

drBounds	アイコンとラベルも含めたリスト項目全体の境界となる長方形を返す

drIcon	アイコンまたは小型アイコンの境界となる長方形を返す

drLabel	項目テキストの境界となる長方形を返す

drSelectBounds	アイコンとラベルも含めたリスト項目全体の境界となる長方形を返すが，レポートビューの場合は列が除外される


TListItem.EditCaption
TListItem.EditCaption3297028

TListItem	参照

EditCaption メソッドは，リスト項目の Caption のインプレース編集を開始します。

function EditCaption: Boolean;

説明

EditCaption メソッドを呼び出すと，リスト項目を編集モードにすることができます。項目の Caption のインプレースエディタを起動する前に，EditCaption はその項目をリストビュー内の唯一の選択項目にし，入力フォーカスを設定します。


TListItem.GetPosition
TListItem.GetPosition3297029

TListItem	参照

GetPosition メソッドは，リスト項目の位置を点で返します。

function GetPosition: TPoint;

説明

GetPosition メソッドを呼び出すと，リスト項目の左上の座標を取得できます。GetPosition は x 座標が Left の値に設定され，y 座標が Top の値に設定された点を返します。


TListItem.MakeVisible
TListItem.MakeVisible3297030

TListItem	参照

MakeVisible メソッドは，必要なときにリストビューをスクロールしてリスト項目が表示されるようにします。

procedure MakeVisible(PartialOK: Boolean);

説明

MakeVisible メソッドを呼び出すと，ユーザーがリストビュー内のリスト項目を見ることができるようになります。PartialOK パラメータは項目の全体を表示しなければならないかどうかを指定します。PartialOK が True の場合，少なくともその項目の一部分が見えていれば，スクロールは起こりません。PartialOK が False の場合，MakeVisible はリストビューで項目の全体が表示されるようにします。


TListItem.SetPosition
TListItem.SetPosition3297031

TListItem	参照

SetPosition メソッドは，リストビューコントロールでリスト項目を配置します。

procedure SetPosition(const Value: TPoint);

説明

SetPosition メソッドを呼び出すと，リスト項目を指定した位置に移動できます。Value パラメータには移動した後のリスト項目の左上隅の位置を示す座標を指定します。

注意

リストビューコントロールの ViewStyle プロパティは vsIcon または vsSmallIcon に設定されている必要があります。


TListItem.Update
TListItem.Update3297032

TListItem	参照

Update メソッドは，リストビュー表示でリスト項目のイメージを更新します。

procedure Update;

説明

Update メソッドを呼び出すと，リスト項目の変更が反映されるようにリストビューのイメージを更新できます。リスト項目の Caption，位置，または状態を変更すると，自動的にリスト項目のイメージが更新されます。


読み出し／書き込み3297033

読み出し専用


継承3297034

TObject

TPersistent


TListItem 例3297035

TListItem


TListView
TListView3298001

継承	プロパティ	メソッド	イベント	参照

TListView コンポーネントはさまざまな方法で項目のリストを表示します。

ユニット

comctrls

説明

TListView を使うと，フォーム内の項目のリストを管理および表示できます。項目は，列に並べて列見出しと下位項目を付けて表示するか，または垂直または水平に小さなアイコンか大きなアイコンを付けて表示することができます。TListView コンポーネントは多くの TCustomListView のプロパティ，イベント，メソッドを継承していますが，新しい動作は導入していません。


TListView プロパティ3298002

TListView	アルファベット順	凡例

TCustomListView からの継承

AllocBy

BorderStyle

BoundingRect

Checkboxes

Column

ColumnClick

Columns

DropTarget

GridLines

HideSelection

HotTrack

IconOptions

ItemFocused

Items

LargeImages

MultiSelect

ReadOnly

RowSelet

SelCount

Selected

ShowColumnHeaders

SmallImages

SortType

StateImages

TopItem

ViewOrigin

ViewStyle

VisibleRowCount

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TListView プロパティ3298003

TListView	オブジェクト順	凡例

Align

AllocBy

BorderStyle

BoundingRect

BoundsRect

Brush

Checkboxes

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

Column

ColumnClick

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

DropTarget

Enabled

Font

GridLines

Handle

Height

HelpContext

HideSelection

Hint

HotTrack

IconOptions

ItemFocused

Items

LargeImages

Left

MultiSelect

Name

Owner

Parent

ParentColor

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ReadOnly

RowSelet

SelCount

Selected

ShowColumnHeaders

ShowHint

Showing

SmallImages

SortType

StateImages

TabOrder

TabStop

Tag

Top

TopItem

VCLComObject

ViewOrigin

ViewStyle

Visible

VisibleRowCount

Width

WindowProc


TListView イベント3298004

TListView	アルファベット順	凡例

TCustomListView からの継承

OnChange

OnChanging

OnColumnClick

OnCompare

OnDeletion

OnEdited

OnEditing

OnInsert

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TListView イベント3298005

TListView	オブジェクト順	凡例

OnChange

OnChanging

OnClick

OnColumnClick

OnCompare

OnDblClick

OnDeletion

OnDragDrop

OnDragOver

OnEdited

OnEditing

OnEndDrag

OnEnter

OnExit

OnInsert

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TListView メソッド3298006

TListView	アルファベット順

TCustomListView からの継承

AlphaSort

Arrange

Create

CustomSort

Destroy

FindCaption

FindData

GetItemAt

GetNearestItem

GetNextItem

GetSearchString

IsEditing

Scroll

StringWidth

UpdateItems

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TListView メソッド3298007

TListView	オブジェクト順

AlphaSort

Arrange

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

CustomSort

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindCaption

FindComponent

FindData

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetItemAt

GetNamePath

GetNearestItem

GetNextItem

GetParentComponent

GetSearchString

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

IsEditing

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

Scroll

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

StringWidth

Update

UpdateControlState

UpdateItems


スコープ3298008

published

読み出し／書き込み

読み出し専用


スコープ3298009

published


継承3298010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomListView


TListView 例3298011

TListView


TLookupList
TLookupList3299001

継承	メソッド	参照

TLookupList は，1 組のキー項目値に関連付けられた参照値のリストを保持します。

ユニット

db

説明

TLookupList は TField が参照値のキャッシュを実装するときに使います。参照リスト内の各値は，参照データセット内のキー項目上の 1 組の値に関連付けられます。参照項目は，KeyFields プロパティで指定された項目の値を，参照データセットのキー項目の値と照合します。各値が一致すると，参照項目の値は TLookupList からの関連した値に設定されます。

TLookupListを使うと，参照データセットが実在しない場合にプログラム的に参照リストを生成できます。プログラム的に作成された TLookupList オブジェクトに参照項目の LookupList プロパティを設定し，その項目の LookupCache プロパティを True に設定します。項目のその他の参照プロパティを設定しないと，提供された参照リストが参照データセットの値で上書きされずにそのまま使われます。


TLookupList のメソッド3299002

TLookupList	アルファベット順

TLookupList

Add

Clear

Create

Destroy

ValueOfKey

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TLookupList のメソッド3299003

TLookupList	オブジェクト順

Add

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

ValueOfKey


TLookupList.Add
TLookupList.Add3299004

TLookupList	参照

Add は与えられたキー値に対する参照リストに参照値を追加します。

procedure Add(const AKey, AValue: Variant);

説明

参照項目は，参照データセット内のキー項目値を参照値に関連付けるための参照キャッシュを構築する際に Add を呼び出します。AKey パラメータはキー項目の値を示すバリアントまたはバリアント配列です。AValue はキー項目値に関連付けられた参照項目の値を示すバリアントです。

Add を使うと，参照データセットが実在しない場合に参照リストを最初から構築できます。


TLookupList.Clear
TLookupList.Clear3299005

TLookupList	参照

Clear は参照リストを空にして，関連するメモリを解放します。

procedure Clear;

説明

Clear を呼び出すと，参照リストをプログラムで構築する際に参照リスト内の現在の値を空にすることができます。参照リストが参照データセット内の値を示している場合，参照項目は参照キャッシュを再生成する前に Clear を自動的に呼び出します。


TLookupList.Create
TLookupList.Create3299006

TLookupList	参照

Create は TLookupList のインスタンスを作成します。

constructor Create;

説明

アプリケーションは Create を呼び出す必要はありません。TLookupList のインスタンスは専用の参照キャッシュのリストを使う参照項目によって作成されます。

Create は，参照値のリストを保持する際に使うヘルパーオブジェクトを割り当てます。


TLookupList.Destroy
TLookupList.Destroy3299007

TLookupList	参照

Destroy は TLookupList のインスタンスを破棄します。

destructor Destroy; override;

説明

Destroy はアプリケーションから直接呼び出してはいけません。TLookupList を使った参照項目は，Free メソッドを呼び出すことで参照リストが破棄される場合に参照リストを破棄します。Free は TLookupList オブジェクトが解放されていないことを確認してからのみ Destroy を呼び出します。

Destroy は参照値のリストを格納するために使っていたすべてのメモリを解放します。


TLookupList.ValueOfKey
TLookupList.ValueOfKey3299008

TLookupList	参照

ValueOfKey はキー項目値に関連付けられた参照値を返します。

function ValueOfKey(const AKey: Variant): Variant;

説明

ValueOfKey を呼び出すと，その KeyFields プロパティで指定される項目に対して AKey パラメータで指定された値の組を持つ参照項目の値が検索されます。AKey はバリアントまたはバリアント配列であり，単独で参照項目値を指定する参照データセット内のキー項目に対する値を格納します。


継承3299009

TObject


TLookupList の例3299010

TLookupList


ELowCapacityError
ELowCapacityError3300001

継承	プロパティ	メソッド	参照

ELowCapacityError は，デシジョンキューブで使用可能なメモリサイズを超えてメモリを割り当てようとした場合の例外クラスです。

ユニット

mxarrays

説明

ELowCapacityError は，デシジョンキューブのキャッシュが大きすぎる場合に生成されます。デシジョンキューブで使用可能なメモリのサイズは，そのデシジョンキューブの Capacity プロパティを変更して増やすことができ，デシジョンキューブのメモリ使用量は，キューブ次元を非アクティブにすることにより減らすことができます。


ELowCapacityError のプロパティ3300002

ELowCapacityError	アルファベット順

Exception からの継承

HelpContext

Message


ELowCapacityError のプロパティ3300003

ELowCapacityError	オブジェクト順

HelpContext

Message


ELowCapacityError のメソッド3300004

ELowCapacityError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


ELowCapacityError のメソッド3300005

ELowCapacityError	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3300006

TObject

Exception


ELowCapacityError の例3300007

ELowCapacityError


TListColumn
TListColumn3301001

継承	プロパティ	メソッド	参照

TListColumn オブジェクトはレポートスタイルのリストビューの個々の列です。

ユニット

comctrls

説明

TListView オブジェクトでは，TListColumns を使って TListColumn オブジェクトのコレクションが保守されます。


TListColumn プロパティ3301002

TListColumn	アルファベット順	凡例

TListColumn

Alignment

Caption

DisplayName

Width

WidthType

TCollectionItem からの継承

Collection

ID

Index


TListColumn プロパティ3301003

TListColumn	オブジェクト順	凡例

Alignment

Caption

Collection

DisplayName

ID

Index

Width

WidthType


TListColumn.Alignment
TListColumn.Alignment3301004

TListColumn	参照

Alignment プロパティは，リスト列内でどのようにすべてのテキストを揃えるか指定します。

property Alignment: TAlignment default taLeftJustify;

説明

Alignment プロパティは，列内でのテキストの水平方向の配置を指定することができます。テキストには，列の一番上に表示される Caption と，列内に表示される個々のリスト項目のテキストラベルがあります。以下に Alignment の値を示します。

値	意味

taLeftJustify	テキストを見出しの左端で揃える

taCenter	テキストを列の中央で揃える

taRightJustify	テキストを見出しの右端で揃える


TListColumn.Caption
TListColumn.Caption3301005

TListColumn	参照

Caption プロパティは，列の一番上に表示されるテキストです。

property Caption: string;

説明

Caption プロパティは，列内に表示する項目の種類をラベルにして表示することができます。リストビューコントロールの ViewStyle および ShowColumnHeaders プロパティが vsReport および True にそれぞれ設定されている場合，Caption プロパティの値は列の最上段に表示されます。


TListColumn.DisplayName
TListColumn.DisplayName3301006

TListColumn	参照

DisplayName プロパティは，列のコレクション内の個々のリストビュー列の名前になる文字列です。

property DisplayName: string;

説明

DisplayName プロパティは，設計時に列エディタに表示される列の名前を指定できます。Caption プロパティを設定している場合は，DisplayName の値は Caption と同じになります。それ以外の場合は，DisplayName はリスト列クラスの名前です。


TListColumn.Width
TListColumn.Width3301007

TListColumn	参照

Width プロパティは，列の幅を表します。

property Width: TWidth default 50;

説明

Width プロパティは，リスト列の幅をピクセル数で指定できます。Width プロパティに -1 の値が代入されていると，リスト列はテキストに合わせて自動的にサイズが調整されます。Width プロパティが -2 の場合，リスト列は列見出し（Caption プロパティのテキスト）に合わせて自動的にサイズが調整されます。コードの可読性を高めるには，Width プロパティに負の値を代入するときにグローバルな ColumnTextWidth および ColumnHeaderWidth 定数を使います。

定数	値	意味

ColumnTextWidth	-1	項目のテキストに合わせて列のサイズが決まる

ColumnHeaderWidth	-2	見出しに合わせて列のサイズが決まる

たとえば次の文では，ListView1 の一番左の列がテキストに合わせてサイズ変更されます。

ListView1.Columns[0].Width := ColumnTextWidth;

フォームの設計で同じ処理をするには，ListView1 に対して列エディタを開き，最初のリスト列を選択して，オブジェクトインスペクタ の Width に -1 を入力します。

列が自動的にサイズ変更される場合，Width プロパティの値が実際の列幅を反映して変更されます。しかし，読み出し専用の WidthType プロパティの値は -1 または -2 のまま維持されます。


TListColumn.WidthType
TListColumn.WidthType3301008

TListColumn	参照

WidthType プロパティは，列が自動的にサイズ変更されるかどうかを示します。

property WidthType: TWidth;

説明

読み出し専用の WidthType プロパティは列幅がどのように決まるかを示します。WidthType は Width プロパティと同じ値に設定されます。しかし，WidthType プロパティは Width プロパティの値が自動的に変更されたとき負の値をそのまま維持します。

WidthType プロパティが -1 を返す場合，リスト列はテキストに合わせて自動的にサイズ変更されます。WidthType プロパティが -2 を返す場合，リスト列は列見出しに合わせて自動的にサイズ変更されます。WidthType プロパティが負でない値を返す場合は，リスト列は自動的にはサイズ変更されず，この場合には Width と WidthType の値は同じであるはずです。

自動的な列のサイズ変更を有効にするには，-1 または -2 の値を直接 Width プロパティに代入します。


TListColumn メソッド3301009

TListColumn	アルファベット順

TListColumn

Assign

Create

Destroy

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TListColumn メソッド3301010

TListColumn	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TListColumn.Assign
TListColumn.Assign3301011

TListColumn	参照

Assign メソッドは，ソースリスト列のプロパティをコピーします。

procedure Assign(Source: TPersistent); override;

Assign メソッドを呼び出すと，別のリスト列の表示属性をコピーできます。Assign は Alignment，Width，および Caption の値をソースオブジェクトと同じになるように設定します。Source パラメータがリスト列でない場合，Assign は AssignTo メソッドでリスト列にコピーできる任意のオブジェクトから代入できるように，継承するメソッドを呼び出します。


TListColumn.Create
TListColumn.Create3301012

TListColumn	参照

Create メソッドは，リスト列を作成および初期化します。

constructor Create(Collection: TCollection); override;

説明

Create メソッドを呼び出すと，実行時に TListColumn のインスタンスを作成できます。Collection パラメータは，この列を使うリストビューでリスト列を表す TListColumns オブジェクトを指定します。設計時にリストビューオブジェクトに追加した列は自動的に作成されます。実行時には，TListColumns オブジェクトの Add メソッドを使って間接的にリスト列を作成します。

Create は，Alignment プロパティを taLeftJustify に，Width プロパティを 50 に初期化します。


TListColumn.Destroy
TListColumn.Destroy3301013

TListColumn	参照

Destroy メソッドは，リスト列を破棄し，割り当てられていたメモリを解放します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは，リストビューが解放されていないことを確認してからのみ，Destroy メソッドを呼び出します。Destroy メソッドは TListColumn インスタンスを破棄し，必要ならリストビューコントロールから列を削除します。


スコープ3301014

published

読み出し／書き込み

読み出し専用


継承3301015

TObject

TPersistent

TCollectionItem


TListColumn 例3301016

TListColumn


TListColumns
TListColumns3302001

継承	プロパティ	メソッド	参照

TListColumns オブジェクトは TListColumn オブジェクトのコレクションです。

ユニット

comctrls

説明

各 TListColumns オブジェクトは TListColumn オブジェクトのコレクションを TListView オブジェクトに表示します。設計時には，リストビューコントロールの列エディタを使って列を追加，削除，または変更します。


TListColumns プロパティ3302002

TListColumns	アルファベット順	凡例

TListColumns

Items

Owner

TCollection からの継承

Count

ItemClass


TListColumns プロパティ3302003

TListColumns	オブジェクト順	凡例

Count

ItemClass

Items

Owner


TListColumns.Items
TListColumns.Items3302004

TListColumns	参照

Items プロパティは，保持されているリスト列のインデックス配列です。

property Items[Index: Integer]: TListColumn default;

説明

Items プロパティは，コレクション内のリスト列オブジェクトに直接アクセスできます。Index パラメータの値は TListColumn オブジェクトの Index プロパティに対応します。この値はリストビューにおける列の位置を表します。


TListColumns.Owner
TListColumns.Owner3302005

TListColumns	参照

Owner プロパティは，TListColumns インスタンスが属するリストビューコントロールを示します。

property Owner: TCustomListView;

説明

読み出し専用の Owner プロパティは，どのリストビューコントロールが TListColumns オブジェクトを使って Columns プロパティを実現しているかを示します。


TListColumns メソッド3302006

TListColumns	アルファベット順

TListColumns

Add

Create

TCollection からの継承

Assign

BeginUpdate

Clear

Destroy

EndUpdate

FindItemID

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

TPersitent からの継承

GetNamePath


TListColumns メソッド3302007

TListColumns	オブジェクト順

Add

Assign

BeginUpdate

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

EndUpdate

FieldAddress

FindItemID

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TListColumns.Add
TListColumns.Add3302008

TListColumns	参照

Add メソッドは，新しい TListColumn インスタンスを作成し，それを Items 配列に追加します。

function Add: TListColumn;

説明

Add メソッドを呼び出すと，新しいリスト列を Items 配列の最後に追加できます。Add メソッドは新しいリスト列を返します。設計時には，リストビューコントロールの列エディタを使って列をリストビューに追加します。


TListColumns.Create
TListColumns.Create3302009

TListColumns	参照

Create メソッドは，TListColumns オブジェクトを作成し，初期化します。

constructor Create(AOwner: TCustomListView);

説明

アプリケーションから直接 Create メソッドを呼び出さないでください。TListView のインスタンスは自身のコンストラクタから TListColumns オブジェクトを作成します。AOwner パラメータは TListColumns オブジェクトを使って Columns プロパティを実現する TListVew インスタンスです。


読み出し／書き込み3302010

読み出し専用


継承3302011

TObject

TPersistent

TCollection


TListColumns 例3302012

TListColumns


TListItems
TListItems3303001

継承	プロパティ	メソッド	参照

TListItems オブジェクトは，リストビューコントロールに表示されるリスト項目のリストを保持します。

ユニット

comctrls

説明

TListItems のプロパティとメソッドを使うと，リストビューコントロールに表示される項目のリストを操作できます。TListItems はリストビュー内のメイン項目のみをリストします。下位項目は個々の TListItem オブジェクトのプロパティを使って指定されます。


TListItems プロパティ3303002

TListItems	アルファベット順	凡例

TListItems

Count

Handle

Item

Owner


TListItems プロパティ3303003

TListItems	オブジェクト順	凡例

Count

Handle

Item

Owner


TListItems.Count
TListItems.Count3303004

TListItems	参照

Count プロパティは，Item プロパティ配列内の項目数を示します。

property Count: Integer;

説明

Count プロパティは，リストビューに表示される項目数を取得できます。Count は Item プロパティ配列内の各 TListItem オブジェクトを繰り返すときの最大値となります。


TListItems.Handle
TListItems.Handle3303005

TListItems	参照

Handle プロパティは，TListItems によって管理される項目を表示するリストビューのウィンドウハンドルです。

property Handle; HWND;

説明

Handle プロパティはリストビューのハンドルを必要とする Windows API 関数を呼び出すときにパラメータとして使います。


TListItems.Item

TListItems	参照

Item プロパティは，TListItems オブジェクトによって管理されるすべてのリスト項目のインデックス配列です。

property Item[Index: Integer]: TListItem;

説明

Item プロパティは，リストビュー内の位置を指定してリスト項目に直接アクセスできます。最初の項目のインデックスは 0，2 番目のインデックスは 1 となります。


TListItems.Owner
TListItems.Owner3303007

TListItems	参照

Owner プロパティは，リスト項目オブジェクトを使って表示する項目を管理するリストビューオブジェクトを示します。

property Owner: TCustomListView;

説明

Owner プロパティは，この TListItems オブジェクトを使って Items プロパティを実現するリストビューオブジェクトにアクセスできます。


TListItems メソッド3303008

TListItems	アルファベット順

TListItems

Add

Assign

BeginUpdate

Clear

Create

Delete

Destroy

EndUpdate

IndexOf

Insert

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TListItems メソッド3303009

TListItems	オブジェクト順

Add

Assign

BeginUpdate

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Delete

Destroy

Dispatch

EndUpdate

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

IndexOf

InheritsFrom

InitInstance

Insert

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TListItems.Add
TListItems.Add3303010

TListItems	参照

Add メソッドは，新しいリスト項目を作成し，リストビューコントロールに追加します。

function Add: TListItem;

説明

Add メソッドを呼び出すと，リストの最後に新しいリスト項目を追加できます。Add は新たに作成された TListItem オブジェクトを返します。

項目を作成してリストの先頭または任意の位置に追加する場合は，Insert メソッドを使います。


TListItems.Assign
TListItems.Assign3303011

TListItems	参照

Assign メソッドは，別の TListItems オブジェクトからリスト項目のリストをコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドを呼び出すと，別のオブジェクトから項目のリストをコピーできます。Source パラメータが別の TListItems オブジェクトを指定している場合，Assign は Item の現在値を破棄し，Source によって保持されている項目をコピーしてリストを作り直します。Source が他の型のオブジェクトである場合は，Assign は継承するメソッドを呼び出します。そのメソッドにより，AssignTo メソッドで TListItems オブジェクトにコピーする方法を指定する任意のオブジェクトからリストがコピーされます。


TListItems.BeginUpdate
TListItems.BeginUpdate3303012

TListItems	参照

BeginUpdate メソッドは，EndUpdate メソッドが呼び出されるまでリストビューの更新を抑制します。

procedure BeginUpdate;

説明

BeginUpdate メソッドは，項目のリストを複数回変更する前に呼び出します。すべての変更が完了したら，EndUpdate を呼び出して変更内容を画面に反映させます。BeginUpdate と EndUpdate は，新しい項目を追加，削除，挿入したときの過剰な再描画を抑制し，処理時間を短縮します。


TListItems.Clear
TListItems.Clear3303013

TListItems	参照

Clear メソッドは，リストからすべての項目を削除します。

procedure Clear;

説明

Clear メソッドを呼び出すと，リストビューからすべての項目を削除できます。Clear はリスト項目に関連付けられていたメモリをすべて解放し，リストビューのイメージを更新します。


TListItems.Create
TListItems.Create3303014

TListItems	参照

Create メソッドは，TListItems のインスタンスを作成します。

constructor Create(AOwner: TCustomListView);

説明

Create メソッドを呼び出すと，実行時に TListItems オブジェクトをインスタンス化できます。TListView が Items プロパティを実現するのに使う TListItems オブジェクトは，リストビューのコンストラクタから自動的に作成されます。


TListItems.Delete
TListItems.Delete3303015

TListItems	参照

Delete メソッドは，指定した項目を削除して，リストビューを更新します。

procedure Delete(Index: Integer);

説明

Delete メソッドを呼び出すと，リストビュー内の Index パラメータで指定した項目を削除します。最初の項目のインデックスは 0，2 番目の項目のインデックスは 1 などとなります。


TListItems.Destroy
TListItems.Destroy3303016

TListItems	参照

Destroy メソッドは，TListItems のインスタンスを破棄します。

destructor Destroy; override;

説明

直接 Destroy メソッドを呼び出さないでください。アプリケーションではかわりに Free メソッドを呼び出します。Free メソッドは TListItems コンポーネントが解放されていないことを確認してから Destroy メソッドを呼び出します。

Destroy メソッドは，リストを解放してから継承デストラクタを呼び出します。


TListItems.EndUpdate
TListItems.EndUpdate3303017

TListItems	参照

EndUpdate メソッドは，BeginUpdate メソッドで抑制されていた画面の描画を再び有効にします。

procedure EndUpdate;

説明

EndUpdate メソッドは BeginUpdate メソッドの呼び出しで始まった，リストに対する変更処理が完了した後で呼び出します。すべての BeginUpdate の呼び出しに対になる EndUpdate の呼び出しがその後にあるときは，再描画がオフだった間に行われたすべての変更を反映するためにリストビューのイメージが更新されます。


TListItems.IndexOf
TListItems.IndexOf3303018

TListItems	参照

IndexOf メソッドは，リストビューウィンドウ内でのリスト項目の位置を返します。

function IndexOf(Value: TListItem): Integer;

説明

IndexOf メソッドを呼び出すと，Value パラメータで指定したリスト項目の位置を判定できます。指定したリスト項目がリストビューにない場合，IndexOf は -1 を返します。


TListItems.Insert
TListItems.Insert3303019

TListItems	参照

Insert メソッドは，新しいリスト項目を作成し，リストビューに挿入します。

function Insert(Index: Integer): TListItem;

説明

Insert メソッドを呼び出すと，新しい TListItem オブジェクトを，リストビュー内の Index パラメータで指定した項目の次の位置に挿入できます。Insert メソッドは挿入したリスト項目を返します。


読み出し／書き込み3303020

読み出し専用


継承3303021

TObject

TPersistent


TListItems 例3303022

TListItems


TListSourceLink
TListSourceLink3304001

継承	プロパティ	メソッド	参照

TListSourceLink は，TDBLookupControl の ListSource へのリンクを管理するヘルパーオブジェクトです。

ユニット

dbctrls

説明

TListSourceLink は TDBLookupControl と組み合わせて機能するように設計されています。TDBLookupControl クラスのみが使用できるヘルパーオブジェクトです。


TListSourceLink プロパティ3304002

TListSourceLink	アルファベット順	凡例

TDataLink からの継承

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


TListSourceLink プロパティ3304003

TListSourceLink	オブジェクト順	凡例

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


TListSourceLink メソッド3304004

TListSourceLink	アルファベット順	凡例

TListSourceLink

ActiveChanged

DataSetChanged

TDataLink からの継承

Create

Destroy

Edit

UpdateRecord

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TListSourceLink メソッド3304005

TListSourceLink	オブジェクト順	凡例

ActiveChanged

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DataSetChanged

DefaultHandler

Destroy

Dispatch

Edit

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

UpdateRecord


TListSourceLink.ActiveChanged
TListSourceLink.ActiveChanged3304006

TListSourceLink	参照

ActiveChanged は，TDBLookupControl に ListSource データセットの Active プロパティの変更を通知します。

procedure ActiveChanged; override;

説明

アプリケーションから ActiveChanged 手続きを直接呼び出さないでください。TDBLookupContol のリストに使われているデータセットの Active プロパティが変更されたときに，ActiveChanged 手続きが呼び出されます。ActiveChanged は，TDBLookupControl にその参照リストを再取得させます。


TListSourceLink.DataSetChanged
TListSourceLink.DataSetChanged3304007

TListSourceLink	参照

DataSetChanged は，TDBLookupControl のリストに使われているデータセットのカレントレコードに変更が加えられたことを TDBLookupControl に通知します。

procedure DataSetChanged; override;

説明

アプリケーションから DataSetChanged を直接呼び出さないでください。データセットが変更されたときに，DataSetChanged が自動的に呼び出されます。DataSetChanged は，データセットの変更について TListSourceLink に通知します。これにより，TListSourceLink は，データセット内の適切なレコードに移動することができます。


読み出し／書き込み3304008

読み出し専用


スコープ3304009

protected


継承3304010

TObject

TPersistent

TDataLink


TListSourceLink 例3304011

TListSourceLink


TMainMenu
TMainMenu3305001

継承	プロパティ	メソッド	参照	例 1	例 2

MainMenu コンポーネントは，フォームのメニューバーとそれに付随するドロップダウンメニューをカプセル化します。

ユニット

menus

説明

TMainMenu を使うと，フォームのメインメニューを提供できます。メニューの設計を始めるには，メインメニューをフォームに追加し，そのコンポーネントをダブルクリックします。

TMainMenu は，メインメニューのドロップダウンメニューを別のフォームのメインメニューとマージしたり，OLE コンテナのメニューネゴシエーション処理を支援したりするためのプロパティおよびメソッドを導入します。


TMainMenu プロパティ3305002

TMainMenu	アルファベット順	凡例

TMainMenu

AutoMerge

Handle

TMenu からの継承

Items

WindowHandle

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TMainMenu プロパティ3305003

TMainMenu	オブジェクト順	凡例

AutoMerge

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Handle

Items

Name

Owner

Tag

VCLComObject

WindowHandle


TMainMenu.AutoMerge
TMainMenu.AutoMerge3305004

TMainMenu	参照

AutoMerge プロパティは，実行時にメインフォーム以外のフォームのメインメニューを非 MDI アプリケーションのメインフォームのメインメニューとマージするかどうかを指定します。

property AutoMerge: Boolean;

説明

フォームのメニューをメインフォームのメインメニューとマージするには，マージする各メインメニューの AutoMerge プロパティを True にします。他のメニューとマージするメインフォームのメインメニューの AutoMerge プロパティは False のままにしておきます。メニュー項目の GroupIndex プロパティ値によってメニューのマージ方法が決まります。

アプリケーションが MDI アプリケーション（FormStyle プロパティはメインフォームが親で残りのフォームが子フォームとして設定される）ならば，AutoMerge プロパティを使わなくても，メニューが自動的にマージされます。


TMainMenu.Handle
TMainMenu.Handle3305005

TMainMenu	参照

Handle プロパティは，メニューのウィンドウハンドルにアクセスできるようにします。

property Handle: HMENU;

説明

Handle プロパティを使うと，Windows メニューハンドルを必要とする Windows API 関数を呼び出すことができます。

たとえば，次のコードは Windows API 関数 HiliteMenuItem を使って Form1 にある MainMenu1 の最初のメニュー項目を強調表示します。

HiliteMenuItem(Form1.Handle, MainMenu1.Handle, 0, MF_BYPOSITION+MF_HILITE);

関連付けられている OLE メニューハンドルを持つメニューの場合，Handle は OLE2 メニューハンドルです。それ以外の場合は，Handle は Items プロパティで示されるとおりの要素が入ったメニューの Windows メニューハンドルです。


TMainMenu メソッド3305006

TMainMenu	アルファベット順

TMainMenu

GetOle2AcceleratorTable

Merge

PopulateOle2Menu

SetOle2MenuHandle

Unmerge

TMenu からの継承

Create

Destroy

DispatchCommand

DispatchPopup

FindItem

GetHelpContext

IsShortCut

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TMainMenu メソッド3305007

TMainMenu	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DispatchCommand

DispatchPopup

FieldAddress

FindComponent

FindItem

Free

FreeInstance

FreeNotification

FreeOnRelease

GetHelpContext

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetOle2AcceleratorTable

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsShortCut

Merge

MethodAddress

MethodName

NewInstance

PopulateOle2Menu

RemoveComponent

SafeCallException

SetOle2MenuHandle

Unmerge


TMainMenu.GetOle2AcceleratorTable
TMainMenu.GetOle2AcceleratorTable3305008

TMainMenu	参照

GetOle2AcceleratorTable メソッドは，メインメニューのアクセラレータテーブルを返します。

procedure GetOle2AcceleratorTable(var AccelTable: HAccel; var AccelCount: Integer; Groups: array of Integer);

説明

GetOle2AcceleratorTable メソッドを呼び出すと，Groups パラメータに表示される GroupIndex 値を持つすべてのメニュー項目のアクセラレータテーブルへのハンドルを取得できます。AccelTable パラメータはアクセラレータテーブルハンドルに設定され，AccelCount はテーブル内のエントリ数に設定されます。GetOle2AccleratorTable メソッドはメニューをマージするときに OLE コンテナによって使われます。


TMainMenu.Merge
TMainMenu.Merge3305009

TMainMenu	参照

Merge メソッドは，フォームのメインメニューを非 MDI アプリケーションの別のフォームのメインメニューに結合します。

procedure Merge(Menu: TMainMenu);

説明

Merge メソッドを呼び出すと，別のメインメニューをこのメニューにマージできます。このメニューにマージするメニューを Menu パラメータで指定してください。

たとえば，アプリケーションの 1 番目のフォームのメインメニューをアプリケーションのメインメニューとして使うには，Merge を呼び出してアプリケーションの追加フォームのメインメニューを 1 番目のフォームのメインメニューにマージします。

メインメニューのメニュー項目の GroupIndex プロパティの値に基づき，マージされたメニュー項目でメニューバーのメニュー項目を更新するか，メニューバーにメニュー項目を挿入できます。メニュー項目の更新，追加，挿入の方法については GroupIndex を参照してください。

別のフォームを表示するときに，メインメニューのマージの有無が自動的に切り替えられるようにするには，メニューをマージするすべてのフォームの AutoMerge プロパティの値を True に変更します。


TMainMenu.PopulateOle2Menu
TMainMenu.PopulateOle2Menu3305010

TMainMenu	参照

PopulateOle2Menu メソッドは， OLE メニューにメインメニューの項目を入れます。

procedure PopulateOle2Menu(SharedMenu: HMenu; Groups: array of Integer; var Widths: array of Longint);

説明

PopulateOle2Menu メソッドを呼び出すと，Groups パラメータで指定した GroupIndex 値を持つメニュー項目を SharedMenu ハンドルを使うメニューにマージできます。PopulateOle2Menu は指定したグループ内のすべてのメニュー項目をメニューに追加し，追加されたすべてのメニュー項目に合わせて Widths 配列内のエントリを増加させます。PopulateOle2Menu はメニューをマージするときに OLE コンテナによって使われます。

注意

PopulateOle2Menu は SharedMenu パラメータで指定したメニューにメニュー項目を入れますが，メニューに関連付けられている OLE メニューとして設定するわけではありません。


TMainMenu.SetOle2MenuHandle
TMainMenu.SetOle2MenuHandle3305011

TMainMenu	参照

SetOle2MenuHandle メソッドは，OLE メニューのハンドルをメインメニューに関連付けます。

procedure SetOle2MenuHandle(Handle: HMENU);

説明

SetOle2MenuHandle メソッドを呼び出すと，一時的にフォームのメニューを Handle パラメータによって示されるメニューに置き換えることができます。元のメニューに戻すには，Handle パラメータを 0 に設定して，SetOle2MenuHandle メソッドを呼び出します。SetOle2MenuHandle は，OLE サーバーによって提供されたメニュー項目を OLE コンテナが使えるようにします。


TMainMenu.Unmerge
TMainMenu.Unmerge3305012

TMainMenu	参照

Unmerge メソッドは，非 MDI アプリケーションで 2 つのメニューをマージする処理を取り消します。

procedure Unmerge(Menu: TMainMenu);

説明

Unmerge メソッドを呼び出すと，Merge メソッドを使って追加された別のメインメニューからの項目を削除できます。Menu パラメータには，メインメニューから削除する項目があるマージされたメニューを指定します。


スコープ

published

読み出し／書き込み

読み出し専用


継承3305014

TObject

TPersistent

TComponent

TMenu


TMainMenu 例3305015

TMainMenu


TMask
TMask3306001

継承	メソッド	参照

TMask コンポーネントは，ワイルドカードを含む文字列とマスクを比較します。

ユニット

masks

説明

TMask を使うと，ある文字列がマスク形式で書かれた文字列と一致しているかどうかがわかります。マスクには，リテラル文字，ワイルドカード（どの文字にも対応する），および文字セット（セット内の 1 文字に対応する）が含まれます。

注意

フィールドの EditMask やマスクされた編集オブジェクトと，TMask を混同しないでください。いずれも文字列を有効な値のシンボル記述と比較するために使われますが，特殊なマスクシンボルと照合ルールはまったく違います。


TMask メソッド3306002

TMask	アルファベット順

TMask

Create

Destroy

Matches

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TMask メソッド3306003

TMask	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

Matches

MethodAddress

MethodName

NewInstance

SafeCallException


TMask.Create
TMask.Create3306004

TMask	参照

Create メソッドは，指定したマスクの TMask のインスタンスを作成します。

constructor Create(const MaskValue: string);

説明

Create を呼び出すと，MaskValue パラメータで指定されるマスクと文字列を比較するためのマスクオブジェクトを作成できます。有効なマスクはリテラル文字，文字セット，およびワイルドカードで構成されます。

リテラル文字は文字列内の 1 文字と一致します。リテラル文字との比較では大文字と小文字は区別されません。

文字セットは左角かっこ（[）で始まり右角かっこ（]）で終わります。両かっこの間に文字セットの要素が入ります。要素は 1 つのリテラル文字または範囲です。範囲は開始値，ダッシュ（-），および終了値で指定されます。文字セットの要素はスペースやカンマで区切らないでください。1 つの文字セットは文字列内の 1 文字と一致します。文字列内の文字が文字セット内のいずれかのリテラル文字と一致しているか，あるいは文字セット内のいずれかの範囲にあれば，その文字は文字セットと一致しています。文字列内の文字が文字セットの範囲の開始値，終了値，またはその 2 つの値の間にある文字と一致していれば，その文字は範囲内にあります。文字セットとの比較では大文字と小文字は区別されません。また，文字セットの左角かっこの直後に感嘆符（!）がある場合，文字セットはその文字セットに記述された文字以外のすべての文字と一致します。

ワイルドカードはアスタリスク（*）または疑問符（?）で示されます。アスタリスクは文字数に関係なくどの文字にも対応します。疑問符は任意の 1 文字に対応します。


TMask.Destroy
TMask.Destroy3306005

TMask	参照

Destroy メソッドは，TMask のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはマスクオブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy はマスクの解析後のイメージを格納していたメモリを解放します。


TMask.Matches
TMask.Matches3306006

TMask	参照

Matches メソッドは，文字列をマスクと比較して，一致しているかどうかを示します。

function Matches(const Filename: string): Boolean;

説明

Matches を呼び出すと，有効値を記述したマスクと Filename パラメータを比較できます。Matches は文字列とマスクが一致していれば True を返し，一致していなければ False を返します。マスクの構文が無効である場合，Matches は例外を生成します。

マスクは TMask オブジェクトが作成されたときに設定されます。

注意

TMask は VCL 内部で，ファイル名が有効なディレクトリを指定しているかどうかを調べるために使われています。Filename パラメータには必ずしもファイル名を指定しなくてもかまいません。TMask を使うと，文字列を構文的に正しいマスクとの比較でチェックできます。


継承3306007

TObject


TMask 例3306008

TMask


TMaskEdit
TMaskEdit3307001

継承	プロパティ	メソッド	イベント	参照

TMaskEdit オブジェクトは汎用のマスク編集コントロールを実現します。

ユニット

mask

説明

TMaskEdit オブジェクトを使うと，マスク編集コントロールをフォーム上に配置できます。マスク編集コントロールを使うと，テキストがとりうる有効な形式を記号化したマスクを使ってテキスト入力を検証できます。マスクはテキストの表示形式を決めることもできます。

TMaskEdit オブジェクトは，TCustomMaskEdit オブジェクトによって導入された汎用動作を実現します。TMaskEdit は TCustomMaskEdit オブジェクトから継承されたプロパティおよびメソッドの多くをパブリッシュしますが，新しい動作を導入することはありません。


TMaskEdit プロパティ3307002

TMaskEdit	アルファベット順	凡例

TCustomMaskEdit からの継承

EditMask

EditText

IsMasked

MaxLength

Text

TCustomEdit からの継承

AutoSelect

AutoSize

BorderStyle

CharCase

Modified

PasswordChar

ReadOnly

SelLength

SelStart

SelText

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TMaskEdit プロパティ3307003

TMaskEdit	オブジェクト順	凡例

Align

AutoSelect

AutoSize

BorderStyle

BoundsRect

Brush

CharCase

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

EditMask

EditText

Enabled

Font

Handle

Height

HelpContext

Hint

ImeMode

ImeName

IsMasked

Left

MaxLength

Modified

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PasswordChar

PopupMenu

ReadOnly

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

Width

WindowProc


TMaskEdit イベント3307004

TMaskEdit	アルファベット順	凡例

TCustomEdit からの継承

OnChange

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TMaskEdit イベント3307005

TMaskEdit	オブジェクト順	凡例

OnChange

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TMaskEdit メソッド3307006

TMaskEdit	アルファベット順

TCustomMaskEdit からの継承

Clear

Create

GetTextLen

ValidateEdit

TCustomEdit からの継承

ClearSelection

CopyToClipboard

CutToClipboard

GetSelTextBuf

PasteFromClipboard

SelectAll

SetSelTextBuf

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TMaskEdit メソッド3307007

TMaskEdit	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClearSelection

ClientToScreen

ContainsControl

ControlAtPos

CopyToClipboard

Create

CreateParented

CutToClipboard

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetSelTextBuf

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

PasteFromClipboard

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetSelTextBuf

SetTextBuf

Show

Update

UpdateControlState

ValidateEdit


スコープ3307008

published

読み出し／書き込み

読み出し専用


スコープ3307009

published


継承3307010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomEdit

TCustomMaskEdit


TMaskEdit 例3307011

TMaskEdit


TMediaPlayer
TMediaPlayer3308001

継承	プロパティ	メソッド	イベント

TMediaPlayer コンポーネントは Media Control Interface（MCI）ドライバを提供するデバイスを制御します。

ユニット

mplayer

説明

TMediaPlayer コンポーネントは CD-ROM ドライブ，MIDI シーケンサ，VCR などのマルチメディアデバイスを制御するボタン（［Play］，［Stop］，［Eject］など）のセットです。マルチメディアデバイスはハードウェアの場合もソフトウェアの場合もあります。

メディアプレーヤコンポーネントは複数のボタンからなります。これらのボタンはマウスでクリックできますが，独立したオブジェクトやボタンコンポーネントではありません。

ボタン	値	動作

Play	btPlay	メディアプレーヤを再生する

Pause	btPause	再生または録音を一時停止する。一時停止状態のときにクリックすると，再生または録音を再開する

Stop	btStop	再生または録音を停止する

Next	btNext	次のトラックにスキップする。トラックを使っていないメディアの場合は終わりに移動する

Prev	btPrev	1つ前のトラックにスキップする。トラックを使っていないメディアの場合は先頭に移動する

Step	btStep	数フレーム前方に移動する

Back	btBack	数フレーム後方に移動する

Record	btRecord	録音を開始する

Eject	btEject	メディアをイジェクトする

ユーザーが TMediaPlayer コンポーネント上のボタンをクリックすると，そのボタンに応じてマルチメディアデバイスの再生，一時停止，停止などが起きます。デバイスはボタンに対応するコントロールメソッド（Play，Pause，Stop，Next，Previous，Step，Back，StartRecording，および Eject）によっても制御できます。

マルチメディアデバイスの型（dtWaveAudio や dtVideodisc など）は DeviceType プロパティで指定します。デバイスがそのメディアをファイルに格納する場合，メディアファイルの名前は FileName プロパティで指定します。DeviceType プロパティが dtAutoSelect の場合，メディアプレーヤは FileName プロパティで指定されたファイルの拡張子からデバイスタイプを判断しようとします。

メディアプレーヤコンポーネントが実行時に作成されるときに，自動的にメディアプレーヤが DeviceType プロパティで指定されたデバイスを開くようにするには，AutoOpen プロパティを True に設定します。


TMediaPlayer プロパティ3308002

TMediaPlayer	アルファベット順	凡例

TMediaPlayer

AutoEnable

AutoOpen

AutoRewind

Capabilities

ColoredButtons

DeviceID

DeviceType

Display

DisplayRect

EnabledButtons

EndPos

Error

ErrorMessage

FileName

Frames

Length

Mode

Notify

NotifyValue

Position

Shareable

Start

StartPos

TimeFormat

TrackLength

TrackPosition

Tracks

VisibleButtons

Wait

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TMediaPlayer プロパティ3308003

TMediaPlayer	オブジェクト順	凡例

Align

AutoEnable

AutoOpen

AutoRewind

BoundsRect

Brush

Capabilities

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ColoredButtons

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

DeviceID

DeviceType

Display

DisplayRect

Enabled

EnabledButtons

EndPos

Error

ErrorMessage

FileName

Frames

Handle

Height

HelpContext

Hint

Left

Length

Mode

Name

Notify

NotifyValue

Owner

Parent

ParentShowHint

ParentWindow

PopupMenu

Position

Shareable

ShowHint

Showing

Start

StartPos

TabOrder

TabStop

Tag

TimeFormat

Top

TrackLength

TrackPosition

Tracks

VCLComObject

Visible

VisibleButtons

Wait

Width

WindowProc


TMediaPlayer.AutoEnable
TMediaPlayer.AutoEnable3308004

TMediaPlayer	参照

AutoEnable プロパティは，メディアプレーヤがコンポーネントの各ボタンを自動的に使用可能または使用不可にするかどうかを指定します。

property AutoEnable: Boolean;

説明

AutoEnable プロパティはメディアプレーヤのボタンを自動的に使用可能または使用不可にします。AutoEnable プロパティが True の場合，メディアプレーヤはコントロールボタンを自動的に使用可能または使用不可にします。メディアプレーヤは，Mode プロパティで指定されている現在のモードと，DeviceType プロパティで指定されている現在のマルチメディアデバイスタイプで使用可能または使用不可にするボタンを指定します。

AutoEnable プロパティは，EnabledButtons プロパティに優先します。つまり，メディアプレーヤが自動的に使用可能または使用不可にするボタンは，EnabledButtons プロパティで使用可能または使用不可にされたボタンに優先します。

AutoEnable プロパティが False の場合は，メディアプレーヤはボタンを自動的には使用可能または使用不可にしません。EnabledButtons プロパティを使ってボタンを手動で使用可能または使用不可にしなくてはなりません。

次の表にデバイスモードごとに自動的に使用可能または使用不可にされるボタンを示します。

ボタン	Play	Record	Pause	Stop	Not Open

Back	使用可能	使用可能	使用可能	使用可能	使用不可

Eject	使用可能	使用可能	使用可能	使用可能	使用不可

Next	使用可能	使用可能	使用可能	使用可能	使用不可

Pause	使用可能	使用可能	使用可能	使用不可	使用不可

Play	使用不可	使用不可	使用可能	使用可能	使用不可

Prev	使用可能	使用可能	使用可能	使用可能	使用不可

Record	使用不可	使用不可	使用可能	使用可能	使用不可

Step	使用可能	使用可能	使用可能	使用可能	使用不可

Stop	使用可能	使用可能	使用不可	使用不可	使用不可


TMediaPlayer.AutoOpen
TMediaPlayer.AutoOpen3308005

TMediaPlayer	参照

AutoOpen プロパティは，アプリケーションの実行時にメディアプレーヤを自動的に開くかどうかを指定します。

property AutoOpen: Boolean;

説明

AutoOpen プロパティは実行時にメディアプレーヤを自動的に開くかどうかを指定します。

AutoOpen プロパティが True の場合，実行時にメディアプレーヤコンポーネントを含むフォームを作成すると，DeviceType プロパティ（DeviceType が dtAutoSelect なら FileName）で指定するマルチメディアをメディアプレーヤが開こうとします。

AutoOpen プロパティが False の場合は，デバイスを開くには Open メソッドを呼び出さなければなりません。

デバイスを開いたときにエラーが発生すると，エラーメッセージを持つ EMCIDeviceError 型の例外が生成されます。終了時には数値のエラーコードが Error プロパティに格納され，対応するエラーメッセージが ErrorMessage プロパティに格納されます。

Wait プロパティは，マルチメディアデバイスを開く前にコントロールをアプリケーションに返すかどうかを指定します。Notify プロパティはデバイスを開くときに OnNotify イベントを生成するかどうかを指定します。


TMediaPlayer.AutoRewind
TMediaPlayer.AutoRewind3308006

TMediaPlayer	参照

AutoRewind プロパティは，現在の位置を 1 つ前のトラックの先頭に設定します。

property AutoRewind: Boolean;

説明

AutoRewind プロパティはメディアプレーヤコントロールを再生または録音する前に巻き戻すかどうかを指定します。

AutoRewind プロパティが True でメディアの終わりが現在位置ならば，Play または StartRecording メソッドは，再生または録音の前に現在位置からメディアの先頭に移動します。AutoRewind プロパティが False ならば，先頭に戻るには［Prev］ボタンをクリックするかコードで Previous メソッドを呼び出さなくてはなりません。

注意

StartPos または EndPos プロパティに値が割り当てられている場合，あるいはマルチメディアデバイスがトラッキングを使う場合には，AutoRewind プロパティは再生または録音に対して無効です。Play または StartRecording メソッドを呼び出しても，現在位置はメディアの終わりから移動しません。


TMediaPlayer.Capabilities
TMediaPlayer.Capabilities3308007

TMediaPlayer	参照

Capabilities プロパティは，開くマルチメディアデバイスの機能を指定します。

TMPDevCaps = (mpCanStep, mpCanEject, mpCanPlay, mpCanRecord, mpUsesWindows);

TMPDevCapsSet = set of TMPDevCaps;

property Capabilities: TMPDevCapsSet;

説明

Capabilities プロパティで指定する各種の機能は Open メソッドを使ってデバイスを開くときに決定されます。デバイスには次の機能を指定できます。

値	機能

mpCanEject	メディアをイジェクトする

mpCanPlay	メディアを再生する

mpCanRecord	メディアに記録する

mpCanStep	メディアの先送りまたは巻き戻しを行う

mpUsesWindows	ウィンドウに出力を表示する

注意

現時点では，デバイスを先送りまたは巻き戻しできるかどうか確認する方法はありません。デバイス型（DeviceType プロパティで指定する型）がアニメーション，AVI ビデオ，デジタルビデオ，オーバーレイ，VCR のいずれかであれば mpCanStep 機能を備えています。


TMediaPlayer.ColoredButtons
TMediaPlayer.ColoredButtons3308008

TMediaPlayer	参照

ColoredButtons プロパティは，メディアプレーヤのボタンの色を指定します。

TMPBtnType = (btPlay, btPause, btStop, btNext, btPrev, btStep, btBack, btRecord, btEject);

TButtonSet = set of TMPBtnType;

property ColoredButtons: TButtonSet;

説明

ColoredButtons プロパティはメディアプレーヤのボタンの色を指定します。

ColoredButtons プロパティを使って色を指定していない場合，ボタンは（表示される場合）白黒で表示されます。デフォルトでは，すべてのメディアプレーヤのボタンはカラーで表示されます。

ボタン	値	動作

Play	btPlay	メディアプレーヤを再生する

Record	btRecord	録音を開始する

Stop	btStop	再生または録音を停止する

Next	btNext	次のトラック（メディアがトラックを使っていない場合は最後）へスキップする

Prev	btPrev	直前のトラック（メディアがトラックを使っていない場合は最初）へスキップする

Step	btStep	指定のフレーム数だけ進む

Back	btBack	指定のフレーム数だけ戻る

Pause	btPause	再生または録音を一時停止する。一時停止状態のときにクリックされると，再生または録音を再開する

Eject	btEject	メディアを取り出す


TMediaPlayer.DeviceID
TMediaPlayer.DeviceID3308009

TMediaPlayer	参照

DeviceID プロパティは，現在開いているマルチメディアデバイスのデバイス ID を指定します。

property DeviceID: Word;

説明

DeviceID プロパティは，Open メソッドを使ってデバイスを開くときに指定します。デバイスを開かない場合，DeviceID は 0 です。


TMediaPlayer.DeviceType
TMediaPlayer.DeviceType3308010

TMediaPlayer	参照

DeviceType プロパティは，メディアプレーヤを開くマルチメディアデバイスのタイプを指定します。

TMPDeviceTypes = (dtAutoSelect, dtAVIVideo, dtCDAudio, dtDAT, dtDigitalVideo, dtMMMovie, dtOther, dtOverlay, dtScanner, dtSequencer, dtVCR, dtVideodisc, dtWaveAudio);

説明

DeviceType プロパティは，Open メソッドを使って開くマルチメディアデバイスの種類を指定します。

TMPDeviceTypes 型には，TMediaPlayer コンポーネントで開くことができるマルチメディアデバイスのタイプが入ります。TMPDeviceTypes の有効な値は，dtAutoSelect, dtAVIVideo, dtCDAudio, dtDAT, dtDigitalVideo, dtMMMovie, dtOther, dtOverlay, dtScanner, dtSequencer, dtVCR, dtVideodisc, または dtWaveAudio です。デフォルトは dtAutoSelect です。

DeviceType プロパティが dtAutoSelect ならば，デバイスタイプは FileName プロパティで指定するファイル拡張子によって決まります。拡張子をデバイスタイプに関連付けられない場合は，DeviceType プロパティに dtAutoSelect 以外の値を設定することで正しいデバイスタイプを明示的に指定しなくてはなりません。

マルチメディアデバイスはインストール時に適切なファイル拡張子に関連付けられます。これはレジストリか SYSTEM.INI ファイルで指定されます。デバイスとファイル拡張子を関連付ける方法についてはそれぞれのデバイスのマニュアルを参照してください。


TMediaPlayer.Display
TMediaPlayer.Display3308011

TMediaPlayer

Display プロパティは，出力にウィンドウを使うマルチメディアデバイスの表示ウィンドウを指定します。

property Display: TWinControl;

説明

出力をそのコントロールに表示するには，フォームまたはパネルなどのウィンドウコントロールの名前を Display に指定します。

Display プロパティのデフォルト値は nil です。Display 値が nil ならば，デバイスは出力を表示するため独自のウィンドウを作成します。デバイスを開いた後に Display プロパティに指定したコントロールを解放すると，画像はデバイスのデフォルトウィンドウに出力されます。

出力の表示にウィンドウを使うマルチメディアデバイスには，アニメーション，AVI ビデオ，デジタルビデオ，オーバーレイ，VCR などがあります。


TMediaPlayer.DisplayRect
TMediaPlayer.DisplayRect3308012

TMediaPlayer	参照

DisplayRect プロパティは，マルチメディアデバイスからの出力の表示に使う，Display プロパティで指定するフォーム内の四角形の領域を指定します。

property DisplayRect: TRect;

説明

Display プロパティが nil なら DisplayRect プロパティは無視されます。

フォームの特定の長方形の領域に出力を表示するには TRect レコードを DisplayRect プロパティに指定します。TRect レコードを作成するには Rect 関数を使います。

出力を表示するためウィンドウを使うマルチメディアデバイスには，アニメーション，AVI ビデオ，デジタルビデオ，オーバーレイ，VCR などがあります。

出力の表示に四角形を使うメディアは，デフォルトの DisplayRect サイズを使うと最も効率が上がります。DisplayRect をデフォルトサイズに設定するには右下隅に 0，0 を使います。四角形の位置は左上隅で指定します。

注意

DisplayRect プロパティは，メディアデバイスを開いた後で設定しなくてはなりません。


TMediaPlayer.EnabledButtons
TMediaPlayer.EnabledButtons3308013

TMediaPlayer	参照

EnabledButtons プロパティは，メディアプレーヤのどのボタンを使用可能にするか指定します。

TMPBtnType = (btPlay, btPause, btStop, btNext, btPrev, btStep, btBack, btRecord, btEject);

TButtonSet = set of TMPBtnType;

説明

EnabledButtons プロパティはメディアプレーヤのどのボタンを使用可能にするかを制御します。

使用可能にされたボタンは色が設定され使えます。使用不可にされたボタンは淡色表示になり使えません。EnabledButtons プロパティを使って有効にしないとボタンは使えません。デフォルト設定ではすべてのボタンが使えます。

AutoEnable プロパティが True の場合は，EnabledButtons プロパティは無効になります。ボタンが EnabledButtons プロパティを使って使用可能（または使用不可）にされていても，メディアプレーヤによってボタンが自動的に使用可能（または使用不可）にされた状態が優先します。

ボタン	値	動作

Play	btPlay	メディアプレーヤを再生する

Record	btRecord	録音を開始する

Stop	btStop	再生または録音を停止する

Next	btNext	次のトラック（メディアがトラックを使わない場合は最後）へスキップする

Prev	btPrev	1 つ前のトラック（メディアがトラックを使わない場合は最初）へスキップする

Step	btStep	数フレームだけ進む

Back	btBack	数フレームだけ戻る

Pause	btPause	再生または録音を一時停止する。一時停止状態のときにクリックされると，再生または録音を再開する

Eject	btEject	メディアをイジェクトする


TMediaPlayer.EndPos
TMediaPlayer.EndPos3308014

TMediaPlayer	参照

EndPos プロパティは，現在ロードされているメディアの再生または録音を停止する位置を指定します。

property EndPos: Longint;

説明

EndPos プロパティは TimeFormat プロパティで指定する現在の時刻形式で指定します。

EndPos プロパティは，EndPos プロパティの設定後に呼び出す Play メソッドおよび StartRecording メソッドだけに適用されます。Play メソッドまたは StartRecording メソッドを呼び出すたびに適用するには，呼び出しごとに EndPos プロパティを設定しなくてはなりません。


TMediaPlayer.Error
TMediaPlayer.Error3308015

TMediaPlayer	参照

Error プロパティは，メディアコントロールメソッドによって返される MCI エラーコードを指定します。

property Error: Longint;

説明

Error プロパティはメディアコントロールメソッド（Back，Close，Eject，Next，Open，Pause，PauseOnly，Play，Previous，StartRecording，Resume，Rewind，Step，または Stop）が最後に返す MCI エラーコードを指定します。ErrorMessage プロパティは Error プロパティを説明します。

メディアコントロールメソッドが返すエラーコードは mciSendCommand 関数が返すエラーコードと同じです。エラーコードを説明するメッセージは ErrorMessage プロパティに格納されています。

一番新しいメディアコントロールメソッドがエラーを生成していなければ Error 値は 0 です。メソッドがエラーを生成すると，Error には 0 以外の値が格納されます。デバイスを開いているときにエラーが発生すると EMCIDeviceError 例外が生成されます。


TMediaPlayer.ErrorMessage
TMediaPlayer.ErrorMessage3308016

TMediaPlayer	参照

ErrorMessage プロパティは，Error プロパティに格納されているエラーコードを説明します。

property ErrorMessage: string;

説明

ErrorMessage プロパティはメディアコントロールメソッド（Back，Close，Eject，Next，Open，Pause，PauseOnly，Play，Previous，StartRecording，Resume，Rewind，Step，または Stop）が最後に返したエラーコードを説明するエラーメッセージを示します。

メッセージが説明するエラーコードは Error プロパティに格納されています。


TMediaPlayer.FileName
TMediaPlayer.FileName3308017

TMediaPlayer	参照

FileName プロパティは，開くまたは保存するメディアファイルを指定します。

property FileName: string;

説明

FileName プロパティは，Open メソッドが開くメディアファイルまたは Save メソッドが保存するファイルを指定します。

設計時には，オブジェクトインスペクタの省略記号（...）ボタンをクリックして［ファイルを開く］ダイアログボックスで FileName プロパティを指定できます。


TMediaPlayer.Frames
TMediaPlayer.Frames3308018

TMediaPlayer	参照

Frames プロパティは，前方または後方に進むフレーム数を指定します。

property Frames: Longint;

説明

Frames プロパティは，Step メソッドが前方に進むフレーム数または Back メソッドが後方に進むフレーム数を指定します。

デフォルト値は現在ロードしているメディアの長さ（Length プロパティの値）の 10% です。

注意

フレームの定義はマルチメディアデバイスによって異なります。ディスプレイメディアの場合，1 フレームは 1 つの静止イメージです。


TMediaPlayer.Length
TMediaPlayer.Length3308019

TMediaPlayer	参照

Length プロパティは，開いているマルチメディアデバイスのメディアの長さを表します。

property Length: Longint;

説明

Length プロパティは TimeFormat プロパティで指定する現在の時刻形式を使って表します。


TMediaPlayer.Mode
TMediaPlayer.Mode3308020

TMediaPlayer

Mode プロパティは，現在開いているマルチメディアデバイスのモードを示します。

TMPModes = (mpNotReady, mpStopped, mpPlaying, mpRecording, mpSeeking, mpPaused, mpOpen);

property Mode: TMPModes;

説明

Mode プロパティは現在開いているマルチメディアデバイスのモードを指定します。

TMPModes 型は TMediaPlayer で使われるマルチメディアデバイスのモードを定義します。

以下に TMPModes 型の値を示します。

値	モード

mpNotReady	準備中

mpStopped	停止

mpPlaying	再生中

mpRecording	録音中

mpSeeking	検索中

mpPaused	一時停止

mpOpen	オープン


TMediaPlayer.Notify
TMediaPlayer.Notify3308021

TMediaPlayer	参照

Notify プロパティは，OnNotify イベントを生成するかどうかを指定します。

property Notify: Boolean;

説明

Notify プロパティはメディアコントロールメソッド（Back，Close，Eject，Next，Open，Pause，PauseOnly，Play，Previous，StartRecording，Resume，Rewind，Step，または Stop）を次に呼び出した場合に，そのメソッドの終了で OnNotify イベントを生成するかどうか指定します。

Notify プロパティが True の場合，次にメディアコントロールメソッドを呼び出した場合，そのメソッドが終了したときに OnNotify イベントが生成され，通知メッセージが NotifyValue プロパティに格納されます。Notify プロパティが False の場合は，次にメソッドを呼び出しても OnNotify イベントは生成されず NotifyValue プロパティの値は変更されません。

Notify プロパティは，メディアコントロールメソッドを次に呼び出す場合にだけ有効です。OnNotify イベントの終了後，以降のメディアコントロールメソッドの呼び出しに備えて Notify プロパティを再設定しなくてはなりません。

デフォルトの場合，Play と StartRecording 関数は Notify が True のときと同じ動作をします。再生または録音が終了したときに OnNotify イベントが生成されないようにするには，Play または StartRecording を呼び出す前に Notify プロパティを False に設定しなくてはなりません。デフォルトの場合，Play と StartRecording を除くすべてのメディアコントロールメソッドは Notify プロパティが False のときと同じ動作をします。

次のメディアコントロールに時間が長くかかりそうな場合，Notify プロパティを True に設定して，メディアコントロールメソッドの終了時にアプリケーションに通知するようしてください。Ｎotify プロパティを True に設定すると，Wait プロパティを False に設定して，メディアコントロールメソッドが完了する前にアプリケーションに制御を返すことができます。

注意

Resume メソッドをサポートしないデバイスを再開しようとすると，Play メソッドを呼び出したときと同じにデバイスが再開されます。Resume（またはそれ以外のメディアコントロールメソッド）を呼び出す前に Notify プロパティを True にすると，Resume を呼び出しても Notify プロパティは無効です。終了時に OnNotify イベントを生成せず，NotifyValue プロパティの値はそのままです。


TMediaPlayer.NotifyValue
TMediaPlayer.NotifyValue3308022

TMediaPlayer

NotifyValue プロパティは，通知を最後に要求したメディアコントロールメソッドの結果を報告します。

TMPNotifyValues = (nvSuccessful, nvSuperseded, nvAborted, nvFailure);

property NotifyValue: TMPNotifyValues;

説明

NotifyValue プロパティは通知を最後に要求したメディアコントロールメソッド（Back，Close，Eject，Next，Open，Pause，PauseOnly，Play，Previous，StartRecording，Resume，Rewind，Step，または Stop）の結果を報告します。

通知を要求するには，メディアコントロールメソッドを呼び出す前に Notify プロパティを True に設定します。

TMPNotifyValues 型は，TMediaPlayer で使われるマルチメディアデバイスの通知の値を定義します。以下に TMPNotifyValues 型の値を示します。

値	結果

nvSuccessful	コマンドが正常終了した

nvSuperseded	コマンドが別のコマンドで打ち消された

nvAborted	ユーザーによってコマンドが強制終了された

nvFailure	コマンドが失敗した


TMediaPlayer.Position
TMediaPlayer.Position3308023

TMediaPlayer	参照

Position プロパティは，ロードされているメディアの現在の位置を設定します。

property Position: Longint;

説明

Position プロパティは，TimeFormat プロパティに指定された現在の時刻形式にしたがって設定されます。

Position プロパティのデフォルトはメディアの先頭です。複数のトラックをサポートするメディアの場合，Position プロパティのデフォルトは最初のトラックの先頭になります。


TMediaPlayer.Shareable
TMediaPlayer.Shareable3308024

TMediaPlayer	参照

Shareable プロパティは，複数のアプリケーションがマルチメディアデバイスを共有できるかどうかを指定します。

property Shareable: Boolean;

説明

Shareable プロパティが False ならば，他のコンポーネントやアプリケーションはデバイスにアクセスできません。True ならば，複数のコンポーネントやアプリケーションがデバイスにアクセスできます。デフォルトは False です。

Shareable プロパティはデバイスを開く前に設定します。一部のデバイスは共有できません。共有できないデバイスで Shareable を True に設定して複数のアプリケーションから開こうとすると，Open メソッドが失敗し，Error プロパティにエラーコードが返されます。


TMediaPlayer.Start
TMediaPlayer.Start3308025

TMediaPlayer	参照

Start プロパティは，現在ロードされているメディアの開始位置を指定します。

property Start: Longint;

説明

Start プロパティはトラックを使わないデバイスではメディアの先頭，トラックを使うデバイスでは第 1 トラックの先頭です。Start プロパティはマルチメディアデバイスを Open メソッドで開いたときに定義されます。Start プロパティは TimeFormat プロパティに格納されている現在の時刻形式にしたがって指定します。Start プロパティは実行時のみで読み出し専用のプロパティで，設計時には使えません。


TMediaPlayer.StartPos
TMediaPlayer.StartPos3308026

TMediaPlayer	参照

StartPos プロパティは，現在ロードしているメディアの再生または録音の開始位置を指定します。

property StartPos: Longint;

説明

StartPos プロパティは，TimeFormat プロパティで指定されている現在の時刻形式を使って指定します。

StartPos プロパティは，StartPos プロパティの設定直後に呼び出される Play または StartRecording メソッドにだけ効果を持ちます。それ以後の Play または StartRecording メソッドの呼び出しに対しては，StartPos プロパティを設定し直さなくてはなりません。

StartPos プロパティは次に Play または StartRecording メソッドが呼び出されるまでメディアの（Position プロパティで指定された）現在位置に影響を及ぼしません。


TMediaPlayer.TimeFormat
TMediaPlayer.TimeFormat3308027

TMediaPlayer	参照

TimeFormat プロパティは，位置情報を指定する場合に使う形式を指定します。

TMPTimeFormats = (tfMilliseconds, tfHMS, tfMSF, tfFrames, tfSMPTE24, tfSMPTE25, tfSMPTE30, tfSMPTE30Drop, tfBytes, tfSamples, tfTMSF);

property TimeFormat: TMPTimeFormats;

説明

TimeFormat プロパティは StartPos，Length，Position，Start，EndPos の各プロパティを解釈する方法を指定します。たとえば，Position プロパティが 180，TimeFormat プロパティが tfMilliseconds ならば，現在の位置はメディアに対して 180 ミリ秒です。Position プロパティが 180，TimeFormat プロパティが tfMSF ならば，現在の位置はメディアに対して 180 分です。

すべての形式がすべてのデバイスでサポートされているとは限りません。サポートされていない形式を設定しようとすると，その代入は無視されます。

現在のタイミング情報は必ず 4 バイト整数で渡されます。形式によっては，返されるタイミング情報は実際には 1 つの整数ではなく，倍長整数にパックされた単一バイトの情報になります。

TMPTimeFormats 型は TMediaPlayer.で使われるマルチメディアデバイスの時間形式を定義します。以下に TMPTimeFormats 型の値を示します。

値	時間形式

tfMilliseconds	ミリ秒は 4 バイトの整数型変数として格納される

tfHMS	4 バイト整数にパックされた時，分，秒。最下位バイトから最上位バイトまでのデータ値は次のとおり

  時間（最下位バイト）

  分

  秒

  未使用（最上位バイト）

tfMSF	4 バイト整数にパックされた分，秒，フレーム。最下位はバイトから最上位バイトまでのデータ値は次のとおり

  分（最下位バイト）

  秒

  フレーム

  未使用（最上位バイト）

tfFrames	フレームは 4 バイトの整数型変数として格納される

tfSMPTE24	24 フレーム SMPTE は値を 4 バイト変数にパックする。最下位バイトから最上位バイトまでのデータ値は次のとおり

  時（最下位バイト）

  分

  秒

  フレーム（最上位バイト）

SMPTE（Society of Motion Picture and Television Engineers）時間は時，分，秒，フレームで表現される絶対時刻形式である。標準 SMPTE 除算型の場合，1 秒当たりのフレーム数は 24，25，および 30 である

tfSMPTE25	25 フレーム SMPTE はデータを 24 フレーム SMPTE と同じ順番で 4 バイト変数にパックする

tfSMPTE30	30 フレーム SMPTE はデータを 24 フレーム SMPTE と同じ順番で 4 バイト変数にパックする

tfSMPTE30Drop	30 ドロップフレーム SMPTE はデータを 24 フレーム SMPTE と同じ順番で 4 バイト変数にパックする

tfBytes	バイトは 4 バイトの整数型変数として格納される

tfSamples	サンプルは 4 バイトの整数型変数として格納される

tfTMSF	トラック，分，秒，フレームは 4 バイト変数にパックされる。最下位バイトから最上位バイトまでのデータ値は次のとおり

  トラック（最下位バイト）

  分

  秒

  フレーム（最上位バイト）

MCI では連続トラック番号になることに注意する

注意

所定の時刻形式で指定された 4 バイト整数をデコードしやすくするために MCI で提供される関数については，MMSYSTEM.HLP ヘルプファイルの「時間データのエンコードとデコード用の MCI マクロ」を参照してください。


TMediaPlayer.TrackLength
TMediaPlayer.TrackLength3308028

TMediaPlayer	参照

TrackLength プロパティは，トラックの長さを通知します。

property TrackLength[TrackNum: Integer]: Longint;

説明

TrackLength プロパティは，TrackNum インデックスで指定されたトラックの長さを通知します。

TrackLength プロパティの値は現在の時刻形式に応じて指定します。時刻形式は TimeFormat プロパティで指定します。


TMediaPlayer.TrackPosition
TMediaPlayer.TrackPosition3308029

TMediaPlayer	参照

TrackPosition プロパティは，トラックの開始位置を通知します。

property TrackPosition[TrackNum: Integer]: Longint;

説明

TrackPosition プロパティは，TrackNum インデックスで指定されているトラックの開始位置を通知します。

TrackPosition プロパティの値は現在の時刻形式に応じて指定します。時刻形式は TimeFormat プロパティで指定します。


TMediaPlayer.Tracks
TMediaPlayer.Tracks3308030

TMediaPlayer

Tracks プロパティは，開いているマルチメディアデバイス上の再生可能トラック数を示します。

property Tracks: Longint;

説明

Tracks プロパティは開いているマルチメディアデバイス上にある再生可能なトラックの数を示します。

トラックを使わないデバイスの場合，Tracks は未定義になります。


TMediaPlayer.VisibleButtons
TMediaPlayer.VisibleButtons3308031

TMediaPlayer	参照

VisibleButtons プロパティは，メディアプレーヤ上のどのボタンを表示するかを指定します。

TMPBtnType = (btPlay, btPause, btStop, btNext, btPrev, btStep, btBack, btRecord, btEject);

TButtonSet = set of TMPBtnType;

property VisibleButtons: TButtonSet;

説明

VisibleButtons プロパティはメディアプレーヤ上に表示するボタンを指定します。VisibleButtons プロパティでボタンが可視状態に設定されていないと，そのボタンはメディアプレーヤコントロール上に表示されません。デフォルトの状態では，メディアプレーヤコンポーネントをフォームに追加すると，すべてのボタンが可視状態になります。

ボタン	値	動作

Play	btPlay	メディアプレーヤを再生する

Record	btRecord	録音を開始する

Stop	btStop	再生または録音を停止する

Next	btNext	次のトラックまでスキップする。トラックを使っていないメディアの場合は最後までスキップする

Prev	btPrev	直前のトラックまでスキップする。トラックを使っていないメディアの場合は先頭までスキップする

Step	btStep	数フレームだけ前方に移動する

Back	btBack	数フレームだけ後方に移動する

Pause	btPause	再生または録音を一時停止する。一時停止状態のときにクリックされると，再生または録音を再開する

Eject	btEject	メディアをイジェクトする


TMediaPlayer.Wait
TMediaPlayer.Wait3308032

TMediaPlayer

Wait プロパティは，メディアコントロールメソッドが，その完了後にだけアプリケーションに制御を返すかどうかを指定します。

property Wait: Boolean;

説明

Wait プロパティはメディアコントロールメソッド（Back，Close，Eject，Next，Open，Pause，PauseOnly，Play，Previous，StartRecording，Resume，Rewind，Step，または Stop）が，その完了後にだけアプリケーションに制御を返すかどうかを指定します。

設計時に Wait プロパティは使えません。

Wait プロパティが True ならば，メディアプレーヤコンポーネントは次のメディアコントロールメソッドが完了するまで待ってから，アプリケーションに制御を返します。Wait プロパティが False ならば，アプリケーションは次のメディアコントロールメソッドが完了するのを待たずに先に進みます。

Wait プロパティは Wait プロパティの設定後に呼び出された次のメディアコントロールメソッドだけに影響します。メディアコントロールメソッドへの以降の呼び出しに影響を及ぼすには，Wait プロパティを再設定しなくてはなりません。

デフォルトの状態では，Play と StartRecording メソッドは Wait プロパティが False であるものとして動作します。再生または録音が完了する前にアプリケーションに制御が返されないようにするには，Play または StartRecording メソッドを呼び出す前に Wait プロパティを True に設定しなくてはなりません。デフォルトでは，他のすべてのメディアコントロールメソッドは Wait プロパティが True であるものとして動作します。

注意

通常，次のメディアコントロールに長時間かかることが予測される場合にだけ，Wait プロパティを False に設定し，アプリケーションがメディアコントロールメソッドを完了しないうちに他のコードを実行できるようにします。Wait プロパティを False に設定する場合は，メディアコントロールメソッドの完了時にアプリケーションが通知を受けられるように Notify プロパティを True に設定しておくと便利です。


TMediaPlayer イベント3308033

TMediaPlayer	アルファベット順	凡例

TMediaPlayer

OnClick

OnNotify

OnPostClick

TWinControl からの継承

OnEnter

OnExit


TMediaPlayer イベント3308034

TMediaPlayer	オブジェクト順	凡例

OnClick

OnEnter

OnExit

OnNotify

OnPostClick


TMediaPlayer.OnClick
TMediaPlayer.OnClick3308035

TMediaPlayer	参照

OnClick イベントは，実行時にメディアプレーヤコントロールのいずれかのコントロールボタン上にマウスポインタを置き，マウスボタンを押して指を離したとき，またはメディアプレーヤコントロールにフォーカスがあるときにユーザーが Space を押すと発生します。

EMPNotify = procedure (Sender: TObject; Button: TMPBtnType; var DoDefault: Boolean) of object;

property OnClick: EMPNotify;

説明

メディアプレーヤコントロールにフォーカスがあるときには ← または → キーを使ってどのコントロールボタンをクリックするかを選択できます。

EMPNotify は TMediaPlayer コンポーネント用の OnClick イベントが発生したときに呼び出されるメソッドへのポインタの型です。Button 引数は btBack，btEject，btNext，btPause，btPlay，btPrev，btRecord，btStep，btStop のいずれかの値です。

DoDefault 引数のデフォルト値は True です。DoDefault が True の場合，メディアプレーヤコントロールはクリックされたボタンに対応するメソッドを呼び出します。たとえば，ユーザーが［Play］ボタン（btPlay）をクリックすると，Play メソッドが呼び出されます。

DoDefault が False の場合はメディアプレーヤのコントロールボタンがクリックされたときに実行するコードを OnClick イベントハンドラの中に組み込む必要があります。以下にメディアプレーヤのコントロールボタンに対応するデフォルトメソッドを示します。

コントロールボタン	ボタンの値	呼び出されるメソッド

Play	btPlay	Play

Record	btRecord	StartRecording

Stop	btStop	Stop

Next	btNext	Next

Prev	btPrev	Previous

Step	btStep	Step

Back	btBack	Back

Pause	btPause	Pause

Eject	btEject	Eject


TMediaPlayer.OnNotify
TMediaPlayer.OnNotify3308036

TMediaPlayer	参照

OnNotify イベントは，メディアコントロールメソッドの完了時に発生します。

property OnNotify: TNotifyEvent;

説明

OnNotify イベントは Notify プロパティを True に設定してメディアコントロールメソッド（Back，Close，Eject，Next，Open，Pause，PauseOnly，Play，Previous，Resume，Rewind，StartRecording，Step，または Stop）を呼び出した場合，メディアコントロールメソッドの完了時に発生します。次に OnNotify イベントを発生させるには，OnNotify イベントの後に Notify プロパティを True に再設定しなくてはなりません。


TMediaPlayer.OnPostClick
TMediaPlayer.OnPostClick3308037

TMediaPlayer	参照

OnPostClick イベントは，OnClick イベントハンドラのコードが呼び出された後に生成されます。

EMPPostNotify = procedure (Sender: TObject; Button: TMPBtnType) of object;

property OnPostClick: EMPPostNotify;

説明

OnPostClick イベントは OnClick イベントハンドラのコードが呼び出された後に生成されます。メディアプレーヤがクリックされたときに Wait プロパティが True ならば，OnPostClick イベントは OnClick コードが完了するまで呼び出されません。Wait プロパティが False ならば，OnClick コードが完了する前に制御をアプリケーションへ戻せます。そのため，OnPostClick イベントは OnClick イベントによって開始されたアクションの完了前に発生する場合があります。

たとえば，メディアプレーヤの OnClick イベントハンドラの DoDefault パラメータが True の場合，ユーザーが［Play］ボタンをクリックすればメディアが再生されます。メディアが長時間の場合，Wait プロパティが False なら OnPostClick イベントが生成されたときも再生が続いています。Wait プロパティが True ならば，OnPostClick はメディアの再生が終わるまで発生しません。

EMPostNotify 型は，TMediaPlayer コンポーネントで OnPostClick イベントが発生したときに呼び出されるメソッドへのポインタの型です。Button パラメータがとりえる値は，btBack，btEject，btNext，btPause，btPlay，btPrev，btRecord，btStep，btStop のいずれかです。


TMediaPlayer メソッド3308038

TMediaPlayer	アルファベット順	凡例

TMediaPlayer

AutoButtonSet

Back

Click

Close

Create

Destroy

DoNotify

Eject

Loaded

MMNotify

Next

Notification

Open

Paint

Pause

PauseOnly

Play

PostClick

Previous

Resume

Rewind

Save

StartRecording

Step

Stop

Updated

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TMediaPlayer メソッド3308039

TMediaPlayer	オブジェクト順	凡例

Assign

AutoButtonSet

Back

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Click

ClientToScreen

Close

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DoNotify

DragDrop

Dragging

Eject

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

Loaded

MethodAddress

MethodName

MMNotify

NewInstance

Next

Notification

Open

Paint

PaintTo

Pause

PauseOnly

Perform

Play

PostClick

Previous

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

Resume

Rewind

SafeCallException

Save

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

StartRecording

Step

Stop

Update

UpdateControlState

Updated


TMediaPlayer.AutoButtonSet
TMediaPlayer.AutoButtonSet3308040

TMediaPlayer	参照

AutoButtonSet メソッドは，メディアプレーヤのボタンの使用可能または使用不可を制御します。

type TMPBtnType =  (btPlay, btPause, btStop, btNext, btPrev, btStep, btBack, btRecord, btEject) ;

TButtonSet = set of TMPBtnType;

procedure AutoButtonSet (Btn: TMPBtnType) ; dynamic;

説明

AutoButtonSet メソッドは，AutoEnable プロパティが True の場合に，メディアプレーヤのボタンの使用可能または使用不可を自動的に制御します。Btn パラメータはメディアプレーヤのどのボタンが押されて使われるかを示します。

TMPBtnType は Btn パラメータの型です。以下に TMPBtnType の値を示します。

ボタン	値	動作

Play	btPlay	メディアプレーヤを再生する

Record	btRecord	録音を開始する

Stop	btStop	再生または録音を停止する

Next	btNext	次のトラックへスキップする。トラックを使わないメディアの場合は最後へスキップする

Prev	btPrev	直前のトラックへスキップする。トラックを使わないメディアの場合は最初へスキップする

Step	btStep	数フレームだけ前方へ移動する

Back	btBack	数フレームだけ後方へ移動する

Pause	btPause	再生または録音を一時停止する。一時停止状態のときにクリックされると，再生または録音を再開する

Eject	btEject	メディアをイジェクトする


TMediaPlayer.Back
TMediaPlayer.Back3308041

TMediaPlayer	参照

Back メソッドは，現在ロードしているメディアのフレーム（フレーム数は Frames プロパティの値で指定）を逆向きに移動します。

procedure Back;

説明

実行時にメディアプレーヤコントロールの［Back］ボタンをクリックすると Back メソッドが呼び出されます。

完了後 Back メソッドは数値のエラーコードを Error プロパティに格納し，対応するエラーメッセージを ErrorMessage プロパティに格納します。

Wait プロパティは，Back メソッドが完了する前にアプリケーションに制御を返すかどうか決定します。Notify プロパティは，Back メソッドが OnNotify イベントを生成するかどうか決定します。


TMediaPlayer.Click
TMediaPlayer.Click3308042

TMediaPlayer	参照

Click メソッドは，OnClick イベントが生成されたときに起こる動作を指定します。

procedure Click(Button: TMPBtnType; var DoDefault: Boolean); dynamic;

説明

メディアプレーヤコンポーネントの Click メソッドは OnClick イベントの実装メソッドです。デフォルトでは，Click メソッドはメディアプレーヤの OnClick イベントにアタッチされているイベントハンドラを呼び出すだけです。Click メソッドは，クリックに対する反応をカスタマイズするために下位型でオーバーライドできます。


TMediaPlayer.Close
TMediaPlayer.Close3308043

TMediaPlayer	参照

Close メソッドは，開いているマルチメディアデバイスを閉じます。

procedure Close;

説明

Close メソッドは動作が完了すると，数値のエラーコードを Error プロパティに，対応するエラーメッセージを ErrorMessage プロパティにそれぞれ格納します。

Wait プロパティは Close メソッドが完了する前に制御をアプリケーションに返すかどうかを指定します。Notify プロパティは Close メソッドが OnNotify イベントを生成するかどうかを指定します。

アプリケーションが終了すると，Close メソッドは自動的に呼び出されます。


TMediaPlayer.Create
TMediaPlayer.Create3308044

TMediaPlayer	参照

Create メソッドは，メディアプレーヤオブジェクトをインスタンス化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にメディアプレーヤがインスタンス化されます。設計時に作成されたメディアプレーヤの場合，Create メソッドは自動的に呼び出されます。

Create メソッドはメディアプレーヤにメモリを割り当てて，継承した Create メソッドを呼び出します。

続いて，ボタンに使うビットマップがロードされ，メディアプレーヤに初期値が設定されます。AutoEnable，AutoRewind，Colored，Enabled，および Visible プロパティが True に設定され，AutoOpen プロパティが False，そして DeviceType プロパティが dtAutoSelect に設定されます。


TMediaPlayer.Destroy
TMediaPlayer.Destroy3308045

TMediaPlayer	参照

Destroy メソッドは，メディアプレーヤのインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接に Destroy メソッドを呼び出さないください。かわりに，Free メソッドを呼び出します。Free メソッドは，メディアプレーヤオブジェクトがまだ解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは，開いているデバイスがないことを確認してから，メディアプレーヤで使われるビットマップを破棄し，継承した Destroy メソッドを呼び出します。


TMediaPlayer.DoNotify
TMediaPlayer.DoNotify3308046

TMediaPlayer	参照

DoNotify メソッドは，OnNotify イベントが生成されたときの動作を指定します。

procedure DoNotify; dynamic;

説明

DoNotify メソッドはメディアプレーヤコンポーネントの OnNotify イベントの実装メソッドです。メディアプレーヤの MMNotify メソッドは DoNotify メソッドを呼び出す前に，通知メッセージパラメータに渡されている値からボタンの使用可能と不可能を訂正し，内部フラグを設定します。

デフォルトでは，DoNotify メソッドはメディアプレーヤの OnNotify イベントにアタッチされているイベントハンドラを呼び出すだけです。DoNotify メソッドは，継承したイベントハンドラ呼び出しに加えて，他の反応を提供するためにオーバーライドできます。


TMediaPlayer.Eject
TMediaPlayer.Eject3308047

TMediaPlayer	参照

Eject メソッドは，開いているマルチメディアデバイスからロードされているメディアを強制的に解放します。

procedure Eject;

説明

Eject メソッドは開いているマルチメディアデバイスからロードされているメディアをイジェクトします。

Eject メソッドは，実行時にメディアプレーヤコントロールの［Eject］ボタンをクリックすると呼び出されます。

Eject メソッドは終了すると数値のエラーコードを Error プロパティに，対応するエラーメッセージを ErrorMessage プロパティにそれぞれ格納します。

Wait プロパティは，Eject メソッドが完了する前にアプリケーションに制御を返すかどうかを指定します。Notify プロパティは，Eject メソッドが OnNotify イベントを生成するかどうかを指定します。


TMediaPlayer.Loaded
TMediaPlayer.Loaded3308048

TMediaPlayer	参照

Loaded メソッドは，メディアプレーヤがストリームからロードされた後に初期化の機会を提供します。

procedure Loaded; override;

説明

Loaded メソッドは，すべてのパートがストリームからロードされた後，コンポーネントに初期化の機会を提供します。たとえば，Delphi アプリケーションでフォームファイルからフォームがロードされると，最初に Create コンストラクタが呼び出されてフォームコンポーネントが作成され，続いてストリームであるフォームファイルからプロパティ値が読み出されます。すべてのコンポーネントのすべてのプロパティ値が読み出された後，Delphi は各コンポーネントの Loaded メソッドをコンポーネントが作成された順番で呼び出します。これによって，他のコンポーネントまたはそのコンポーネントの他の部分の値に依存するデータを初期化する機会がコンポーネントに提供されます。


TMediaPlayer.Next
TMediaPlayer.Next3308049

TMediaPlayer	参照

Next メソッドは，現在ロードしているメディアの次のトラックの先頭まで移動します。

procedure Next;

説明

Next メソッドを呼び出したときに現在の位置が最後のトラックにあると，最後のトラックの先頭が現在の位置になります。マルチメディアデバイスがトラックを使っていない場合，Next メソッドはメディアの最後まで移動します。Next メソッドを呼び出すにはメディアプレーヤコントロールで実行時に［Next］ボタンをクリックします。

処理が完了すると，Next メソッドは数値のエラーコードを Error プロパティに，対応するエラーメッセージを ErrorMessage プロパティにそれぞれ格納します。

Wait プロパティは Next メソッドを終了する前に制御をアプリケーションに返すかどうか指定します。Notify プロパティは Next メソッドが OnNotify イベントを生成するかどうか指定します。


TMediaPlayer.MMNotify
TMediaPlayer.MMNotify3308050

TMediaPlayer	参照

MMNotify メソッドは，MCI デバイスが操作を終了したという通知に応答します。

procedure MMNotify(var Message: TMessage); message MM_MCINOTIFY;

説明

MMNotify メソッドは，AutoEnable プロパティが True の場合にボタンの状態を更新し，コマンドの結果を反映して内部フラグを設定し，OnNotify イベントおよび他の特別な反応をトリガするため DoNotify メソッドを呼び出して，マルチメディアコマンドが完了したという Windows からの通知メッセージに応答します。


TMediaPlayer.Notification
TMediaPlayer.Notification3308051

TMediaPlayer	参照

Notification メソッドは，AComponent で指定されたコンポーネントが Operation で指定されているように挿入または除去されることをコンポーネントに通知します。

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

説明

デフォルトでは，コンポーネントは自分が所有しているコンポーネント（もしあれば）に通知を送ります。Notification メソッドは継承した Notification メソッドを呼び出し，Display ウィンドウが実行時に削除されている場合は，画像の表示をオリジナルのウィンドウに設定します。


TMediaPlayer.Open
TMediaPlayer.Open3308052

TMediaPlayer	参照

Open メソッドは，マルチメディアデバイスを開きます。

procedure Open;

説明

Open メソッドはマルチメディアデバイスを開きます。マルチメディアデバイスを開くには，前もってマルチメディアデバイスタイプを DeviceType プロパティに指定しておかなくてはなりません。

Open メソッドの完了時に数値エラーコードが Error プロパティに，対応するエラーメッセージが ErrorMessage プロパティに格納されます。

Wait プロパティは Open メソッドが完了する前に制御をアプリケーションに返すかどうかを指定します。Notify プロパティは Open メソッドが OnNotify イベントを生成するかどうかを指定します。


TMediaPlayer.Paint
TMediaPlayer.Paint3308053

TMediaPlayer

Paint メソッドは，WM_PAINT Windows メッセージに応答します。

procedure Paint; override;

説明

Paint メソッドはメディアプレーヤのイメージをレンダリングします。メディアプレーヤコンポーネントなどのカスタムコントロールは，コントロールのキャンバスを初期化したり，Paint メソッドを呼び出したりして WM_PAINT メッセージに応答します。

下位のメディアプレーヤクラスを作成する場合，Paint メソッドをオーバーライドして対応するメディアプレーヤオブジェクトのイメージを描画できます。


TMediaPlayer.PostClick
TMediaPlayer.PostClick3308054

TMediaPlayer	参照

PostClick メソッドは，OnPostClick イベントが生成されたときに起こる動作を指定します。

procedure PostClick(Button: TMPBtnType); dynamic;

説明

PostClick メソッドは OnPostClick イベントの実装メソッドです。デフォルトでは，PostClick メソッドはメディアプレーヤの OnPostClick イベントにアタッチされているイベントハンドラを呼び出すだけです。PostClick メソッドを下位型でオーバーライドしてクリックに対する応答をカスタマイズできます。


TMediaPlayer.Pause
TMediaPlayer.Pause3308055

TMediaPlayer	参照

Pause メソッドは，開いているマルチメディアデバイスを一時停止します。

procedure Pause;

説明

デバイスがすでに一時停止しているときに Pause メソッドを呼び出すと，デバイスは Resume メソッドを呼び出して再生か記録を再開します。Pause メソッドはメディアプレーヤコントロール上の［Pause］ボタンを実行時にクリックしたときに呼び出されます。

Pause メソッドは完了時に数値エラーコードを Error プロパティに，対応するエラーメッセージを ErrorMessage プロパティに格納します。

Wait プロパティは Pause メソッドの完了前にアプリケーションに制御を返すかどうかを指定します。Notify プロパティは Pause メソッドが OnNotify イベントを生成するかどうかを指定します。


TMediaPlayer.PauseOnly
TMediaPlayer.PauseOnly3308056

TMediaPlayer	参照

PauseOnly メソッドは，開いているマルチメディアデバイスを一時停止します。

procedure PauseOnly;

説明

デバイスがすでに一時停止しているときに PauseOnly メソッドを呼び出しても，デバイスは一時停止したままです。

PauseOnly メソッドは，完了時に数値エラーコードを Error プロパティに，対応するエラーメッセージを ErrorMessage プロパティに格納します。

Wait プロパティは PauseOnly メソッドの完了前にアプリケーションに制御を返すかどうかを指定します。Notify プロパティは PauseOnly メソッドが OnNotify イベントを生成するかどうかを指定します。


TMediaPlayer.Play
TMediaPlayer.Play3308057

TMediaPlayer	参照

Play メソッドは，開いているマルチメディアデバイスにロードされているメディアを再生します。

procedure Play;

説明

Play メソッドはメディアプレーヤコントロール上の［Play］ボタンを実行時にクリックしたときに呼び出されます。

Play メソッドの完了時に，数値エラーコードが Error プロパティに，対応するエラーメッセージが ErrorMessage プロパティに格納されます。

Wait プロパティは Play メソッドが完了する前に制御をアプリケーションに返すかどうかを指定します。Notify プロパティは Play メソッドが OnNotify イベントを生成するかどうかを指定します。

StartPos プロパティが設定されている場合，再生は StartPos プロパティで指定された位置から始まります。それ以外の場合，再生は Position プロパティで指定された現在の位置から始まります。同様に，EndPos プロパティが設定されている場合，再生は EndPos プロパティで指定された位置で終了します。そうでない場合，再生はメディアの終わりで終了します。

再生の前に（Position プロパティで指定された）メディアを巻き戻すかどうかは AutoRewind プロパティによって決まります。


TMediaPlayer.Previous
TMediaPlayer.Previous3308058

TMediaPlayer	参照

Previous メソッドは，現在位置がトラックの先頭にあるときに呼び出された場合には，現在位置を前のトラックの先頭に設定します。

procedure Previous;

説明

現在位置が最初のトラックにあるかトラックの先頭以外のどこかにあるときに呼び出された場合は，現在位置を現在のトラックの先頭に設定します。デバイスがトラックを使わない場合，Previous メソッドは現在位置を Start プロパティで指定されたメディアの先頭に設定します。Previous メソッドはメディアプレーヤコントロール上の［Previous］ボタンを実行時にクリックしたときに呼び出されます。

Previous メソッドの完了時に，数値エラーコードが Error プロパティに，対応するエラーメッセージが ErrorMessage プロパティに格納されます。

Wait プロパティは，Previous メソッドが完了する前に制御をアプリケーションに返すどうかを指定します。Notify プロパティは Previous メソッドが OnNotify イベントを生成するかどうかを指定します。


TMediaPlayer.Resume
TMediaPlayer.Resume3308059

TMediaPlayer	参照

Resume メソッドは，一時停止中のマルチメディアデバイスの再生または録音を再開します。

procedure Resume;

説明

Resume メソッドは実行時にデバイスが一時停止しているとき，メディアプレーヤコントロール上の［Pause］ボタンをクリックすると呼び出されます。

Resume メソッドの完了時に数値エラーコードが Error プロパティに，対応するエラーメッセージが ErrorMessage プロパティに格納されます。

Wait プロパティは Resume メソッドが完了する前に制御をアプリケーションに返すかどうかを指定します。Notify プロパティは Resume メソッドが OnNotify イベントを生成するかどうかを指定します。


TMediaPlayer.Rewind
TMediaPlayer.Rewind3308060

TMediaPlayer	参照

Rewind メソッドは，Start プロパティの中に格納されている現在位置をメディアの先頭に設定します。

procedure Rewind;

説明

Rewind メソッドの完了時に，数値エラーコードが Error プロパティに，対応するエラーメッセージが ErrorMessage プロパティに格納されます。

Wait プロパティは，Rewind メソッドが完了する前に制御をアプリケーションに返すかどうかを指定します。Notify プロパティは Rewind メソッドが OnNotify イベントを生成するかどうかを指定します。


TMediaPlayer.Save
TMediaPlayer.Save3308061

TMediaPlayer	参照

Save メソッドは，現在ロードされているメディアを FileName プロパティに指定したファイルに保存します。

procedure Save;

説明

ファイルに格納されるメディアを使わないデバイス（たとえばビデオディスク）の場合，Save メソッドは無視されます。

Save メソッドの完了時に，数値エラーコードが Error プロパティに，対応するエラーメッセージが ErrorMessage プロパティに格納されます。

Wait プロパティは，Save メソッドが完了する前に制御をアプリケーションに返すかどうかを指定します。Notify プロパティは Save メソッドが OnNotify イベントを生成するかどうかを指定します。


TMediaPlayer.StartRecording
TMediaPlayer.StartRecording3308062

TMediaPlayer	参照

StartRecording メソッドは，録音を現在の Position または StartPos プロパティで指定された位置から開始します。

procedure StartRecording;

説明

StartRecording メソッドは，実行時にメディアプレーヤコントロールの［Record］ボタンをクリックしたときに呼び出されます。

StartRecording メソッドの完了時に，数値エラーコードが Error プロパティに，対応するエラーメッセージが ErrorMessage プロパティに格納されます。

Wait プロパティは，StartRecording メソッドが完了する前に制御をアプリケーションに返すかどうかを指定します。Notify プロパティは StartRecording メソッドが OnNotify イベントを生成するかどうかを指定します。

デフォルトでは StartRecording メソッドの完了時に，Notify プロパティは True に，Wait プロパティは False になります。しかし，StartRecording メソッドを呼び出す前にこれらのプロパティに特定の値を設定した場合，設定した値は変更されずに残ります。


TMediaPlayer.Step
TMediaPlayer.Step3308063

TMediaPlayer	参照

Step メソッドは，現在ロードされているメディアのフレーム（フレーム数は Frames プロパティによって決まる）を前方へ移動します。

procedure Step;

説明

Step メソッドはメディアプレーヤコントロール上の［Step］ボタンを実行時にクリックしたときに呼び出されます。

Step メソッドの完了時に，数値エラーコードが Error プロパティに，対応するエラーメッセージが ErrorMessage プロパティに格納されます。

Wait プロパティは，Step メソッドが完了する前に制御をアプリケーションに返すかどうかを指定します。Notify プロパティは，Step メソッドが OnNotify イベントを生成するかどうかを指定します。


TMediaPlayer.Stop
TMediaPlayer.Stop3308064

TMediaPlayer	参照

Stop メソッドは，再生または録音を停止します。

procedure Stop;

説明

Stop メソッドはメディアプレーヤコントロール上の［Stop］ボタンを実行時にクリックしたときに呼び出されます。

Stop メソッドの完了時に，数値エラーコードが Error プロパティに，対応するエラーメッセージが ErrorMessage プロパティに格納されます。

Wait プロパティは，Stop メソッドが完了する前に制御をアプリケーションに返すかどうかを指定します。Notify プロパティは，Stop メソッドが OnNotify イベントを生成するかどうかを指定します。


TMediaPlayer.Updated
TMediaPlayer.Updated3308065

TMediaPlayer	参照

Updated メソッドは，メディアプレーヤの更新が終了したことを知らせます。

procedure Updated; override;

説明

Updated メソッドは継承した Updated メソッドを呼び出して，メディアプレーヤボタンのレイアウトを更新します。


スコープ3308066

published

読み出し／書き込み

読み出し専用


スコープ3308067

protected


スコープ3308068

published


継承3308069

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl


TMediaPlayer 例3308070

TMediaPlayer


TMemo
TMemo3309001

継承	プロパティ	メソッド	イベント	参照	例

TMemo オブジェクトは Windows 複数行編集コントロールのラッパーです。

ユニット

stdctrls

説明

TMemo オブジェクトを使うと，標準的な Windows 複数行編集コントロールをフォーム上に配置できます。複数行編集ボックスを使えば，2 行以上のテキスト入力を扱えます。複数行編集コントロールは，長い情報の表示に適しています。

TMemo オブジェクトは TCustomMemo で導入される汎用動作を実現します。TMemo オブジェクトは TCustomMemo から継承されたプロパティの多くをパブリッシュしますが，新しい動作を導入することはありません。


TMemo プロパティ3309002

TMemo	アルファベット順	凡例

TCustomMemo からの継承

Alignment

Lines

ScrollBars

WantReturns

WantTabs

WordWrap

TCustomEdit からの継承

BorderStyle

HideSelection

MaxLength

Modified

OEMConvert

ReadOnly

SelLength

SelStart

SelText

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Text

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TMemo プロパティ3309003

TMemo	オブジェクト順	凡例

Align

Alignment

BorderStyle

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

HideSelection

Hint

ImeMode

ImeName

Left

Lines

MaxLength

Modified

Name

OEMConvert

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ReadOnly

ScrollBars

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

WantReturns

WantTabs

Width

WindowProc

WordWrap


TMemo イベント3309004

TMemo	アルファベット順	凡例

TCustomEdit からの継承

OnChange

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TMemo イベント3309005

TMemo	オブジェクト順	凡例

OnChange

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TMemo メソッド3309006

TMemo	アルファベット順

TCustomMemo からの継承

Create

Destroy

TCustomEdit からの継承

Clear

ClearSelection

CopyToClipboard

CutToClipboard

GetSelTextBuf

PasteFromClipboard

SelectAll

SetSelTextBuf

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTeble

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TMemo メソッド3309007

TMemo	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClearSelection

ClientToScreen

ContainsControl

ControlAtPos

CopyToClipboard

Create

CreateParented

CutToClipboard

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTeble

GetNamePath

GetParentComponent

GetSelTextBuf

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

PasteFromClipboard

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetSelTextBuf

SetTextBuf

Show

Update

UpdateControlState


スコープ3309008

published

読み出し／書き込み

読み出し専用


スコープ3309009

published


継承3309010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomEdit

TCustomMemo


TMemo 例3309011

TMemo


TMemoField
TMemoField3310001

継承	プロパティ	メソッド	イベント	参照

TMemoField コンポーネントはデータセットのメモ型項目を表します。

ユニット

db

説明

メモ型項目は BLOB（バイナリラージオブジェクト）型項目のフォームであり，そこではデータが任意の大規模な文字列のテキストで構成されています。TMemoField とその上位コンポーネントである TBlobField との相違点は，DataType プロパティの値です。TBlobField の下位コンポーネントである TMemoField は，データベースの BLOB 型項目の値およびプロパティを管理するのに便利な，数多くのプロパティ，メソッド，およびイベントを備えています。


TMemoField プロパティ3310002

TMemoField	アルファベット順	凡例

TBlobField からの継承

AsString

AsVariant

BlobSize

BlobType

IsNull

Modified

Transliterate

Value

TField からの継承

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TMemoField プロパティ3310003

TMemoField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

BlobSize

BlobType

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Modified

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

Transliterate

ValidChars

Value

VCLComObject

Visible


TMemoField イベント3310004

TMemoField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TMemoField イベント3310005

TMemoField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TMemoField メソッド3310006

TMemoField	アルファベット順

TMemoField

Create

TBlobField からの継承

Assign

Clear

IsBlob

LoadFromFile

LoadFromStream

SaveToFile

SaveToStream

SetFieldType

TField からの継承

AssignValue

Destroy

FocusControl

GetData

IsValidChar

RefreshLookupList

SetData

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TMemoField メソッド3310007

TMemoField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SaveToFile

SaveToStream

SetData

SetFieldType

Validate


TMemoField.Create
TMemoField.Create3310008

TMemoField	参照

Create メソッドは，TMemoField オブジェクトのインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TMemoField オブジェクトがインスタンス化されます。設計時にフォームまたはデータモジュールに配置された TMemoField オブジェクトの場合，Create メソッドは自動的に呼び出されます。

継承したコンストラクタを呼び出した後で，Create は DataType プロパティを ftMemo に設定し，Transliterate プロパティを True に初期化します。


スコープ3310009

published

読み出し／書き込み

読み出し専用


スコープ3310010

published


継承3310011

TObject

TPersistent

TComponent

TField

TBlobField


TMemoField 例3310012

TMemoField


TMemoryStream
TMemoryStream3311001

継承	プロパティ	メソッド	参照

TMemoryStream オブジェクトはデータを動的メモリに格納するストリームオブジェクトです。

ユニット

classes

説明

TMemoryStream オブジェクトを使うと，入出力機能で拡張された動的メモリバッファにデータを格納できます。TMemoryStream オブジェクトは動的メモリバッファを管理するメソッドやプロパティ，またストリームオブジェクトの汎用の入出力機能を提供します。

メモリストリームは情報を保持でき，ほかの記憶媒体を読み書きできる中間オブジェクトとして便利です。メモリストリームはストリームの内容の比較や，アクセスしにくい媒体に格納されているデータの操作などに使用できる機能を提供します。


TMemoryStream プロパティ3311002

TMemoryStream	アルファベット順	凡例

TCustomMemoryStream からの継承

Memory

TStream からの継承

Position

Size


TMemoryStream プロパティ3311003

TMemoryStream	オブジェクト順	凡例

Memory

Position

Size


TMemoryStream メソッド3311004

TMemoryStream	アルファベット順

TMemoryStream

Clear

Destroy

LoadFromFile

LoadFromStream

SetSize

Write

TCustomMemoryStream からの継承

Read

SaveToFile

SaveToStream

Seek

TStream からの継承

CopyFrom

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TMemoryStream メソッド3311005

TMemoryStream	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

CopyFrom

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

Read

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

SafeCallException

SaveToFile

SaveToStream

Seek

SetSize

Write

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes


TMemoryStream.Clear
TMemoryStream.Clear3311006

TMemoryStream	参照

Clear メソッドは，メモリバッファを解放し，メモリストリームに関連付けられているすべてのデータを破棄します。

procedure Clear;

説明

Clear メソッドを呼び出すと，メモリストリーム用のメモリバッファを空にし，関連付けられているすべてのメモリを解放できます。メモリバッファに関連付けられているメモリを解放する以外に，Clear メソッドは以下の処理を実行します。

・	Memory プロパティを nil に設定する

・	Position プロパティを 0 に設定する

・	Size プロパティを 0 に設定する

・	Capacity プロパティを 0 に設定する


TMemoryStream.Destroy
TMemoryStream.Destroy3311007

TMemoryStream	参照

Destroy メソッドは，TMemoryStream のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TMemoryStream オブジェクトがまだ解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

TMemoryStream オブジェクトは，それがデータの保存または書き込みに必要なくなった場合に破棄します。Destroy メソッドは，Clear メソッドを呼び出してメモリバッファを解放してから継承デストラクタを呼び出します。


TMemoryStream.LoadFromFile
TMemoryStream.LoadFromFile3311008

TMemoryStream	参照

LoadFromFile メソッドは，指定ファイルの内容を保持するのに十分なメモリが割り当てられているのを確認してから，ファイルの全内容をメモリバッファにロードします。

procedure LoadFromFile(const FileName: string);

説明

LoadFromFile メソッドを呼び出すと，ファイルの内容をメモリストリームに読み出せます。また，アプリケーションは明示的にファイルストリームオブジェクトを作成および解放する必要なく，ファイルの内容をメモリストリームに読み出すことができます。

LoadFromFile メソッドはファイルの内容に合わせてメモリバッファを再割り当てします。このメソッドは Size および Capacity プロパティを必要に応じて設定し，それからファイルの全内容をメモリバッファに読み出します。このため，LoadFromFile メソッドはメモリストリームに格納されている既存のデータをすべて破棄します。


TMemoryStream.LoadFromStream
TMemoryStream.LoadFromStream3311009

TMemoryStream	参照

LoadFromStream メソッドは，ほかのストリームの内容を保持するのに十分なメモリが割り当てられているのを確認してから，そのストリームの全内容をメモリバッファにロードします。

procedure LoadFromStream(Stream: TStream);

説明

LoadFromStream メソッドを呼び出すと，ほかのストリームオブジェクトの内容をメモリストリームにロードできます。LoadFromStream メソッドは，必ずソースストリームの Position プロパティを 0 に設定してからソースストリームの Size プロパティで示されているバイト数を読み出します。

LoadFromStream メソッドは，ソースストリームの内容に合わせてメモリバッファを再割り当てします。このメソッドは必要に応じて Size および Capacity プロパティを設定し，それからソースストリームの全内容をメモリバッファに読み出します。このため，LoadFromStream メソッドはメモリストリームに格納されている既存のデータをすべて破棄します。

ソースストリームが TFileStream オブジェクトの場合，LoadFromStream メソッドは LoadFromFile メソッドと同じ処理を実行しますが，アプリケーションは TFileStream オブジェクトを作成および解放しなければなりません。また，LoadFromStream メソッドでは，アプリケーションはほかの型のストリームオブジェクトからデータをメモリストリームオブジェクトにロードできます。


TMemoryStream.SetSize
TMemoryStream.SetSize3311010

TMemoryStream	参照

SetSize メソッドは，メモリストリームの Size プロパティを再設定します。

procedure SetSize(NewSize: Longint); override;

説明

SetSize メソッドを使うと，メモリストリームにデータをロードする前にメモリストリームの Size プロパティを設定します。SetSize メソッドは，NewSize バイトのメモリバッファを割り当てます。

SetSize メソッドは，複数のソースからのデータやほかのストリームからのデータをメモリバッファに読み出す前に使います。メモリストリームにあるべき内容がほかのストリームまたはファイルの内容とまったく同じ場合は，LoadFromStream または LoadFromFile を使います。


TMemoryStream.Write
TMemoryStream.Write3311011

TMemoryStream	参照

Write メソッドは，Buffer から Count バイトのデータをメモリバッファの現在の位置に書き込み，Count バイト分だけ現在の位置を更新します。

function Write(const Buffer; Count: Longint): Longint; override;

説明

Write メソッドを呼び出すと，Count バイトのデータをメモリストリームのメモリバッファの現在の位置から書き込むことができます。Write メソッドは，必要であればメモリバッファのサイズを増やしてデータを書き込みます。現在の位置がメモリバッファの最後ではない場合，Write メソッドは現在の位置以降のデータに上書きします。

Write メソッドは，新しいデータを保持するためにさらにメモリを割り当てる必要がある場合には Capacity プロパティを更新します。Write メソッドは Size プロパティを Postion +Count に更新し，Position プロパティを Size プロパティの新しい値に設定します。そのため，メモリストリームの現在の位置以降に格納されていたデータは Write メソッドが呼び出されたときに失われます。

Write メソッドは，メモリエラーがなければ必ず Count バイトのデータを Buffer に書き込みます。したがって，TMemoryStream オブジェクトでは，Write メソッドは WriteBuffer メソッドと同じ働きのメソッドです。

メモリストリームのほかのデータ書き込みメソッド（WriteBuffer，WriteComponent）は Write メソッドを呼び出して実際にデータを書き込みます。


読み出し／書き込み3311012

読み出し専用


継承3311013

TObject

TStream

TCustomMemoryStream


TMemoryStream 例3311014

TMemoryStream


TMenu
TMenu3312001

継承	プロパティ	メソッド	参照	例 1	例 2

TMenu コンポーネントは，TMainMenu や TPopupMenu などのメニューコンポーネントの基本型です。

ユニット

menus

説明

TMenu は，メニュー項目のコレクションを表すコンポーネントを定義するときに基本クラスとして使います。TMenu は，メニュー項目のセットを表す Windows メニューを作成したり，それらのメニュー項目に関連付けられているコマンドをディスパッチしたり，それらのメニュー項目のヘルプコンテキスト ID を見つけたりするためのプロパティおよびメソッドを導入します。


TMenu プロパティ3312002

TMenu	アルファベット順	凡例

TMenu

Handle

Items

WindowHandle

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TMenu プロパティ3312003

TMenu	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Handle

Items

Name

Owner

Tag

VCLComObject

WindowHandle


TMenu.Handle
TMenu.Handle3312004

TMenu	参照

Handle プロパティは，メニューの Windows メニューハンドルです。

property Handle: HMENU;

説明

Handle プロパティは，メニューハンドルが必要な Windows API 関数を呼び出すことができます。Handle プロパティは Items プロパティで示される項目だけが入ったメニューのハンドルです。他のメニューがこのメニューにマージされていない場合は，WindowHandle プロパティと同じです。


TMenu.Items
TMenu.Items3312005

TMenu	参照

Items プロパティは，メニューの要素を示す TMenuItem オブジェクトです。

property Items: TMenuItem;

説明

Items プロパティは，メニュー内の要素についての情報にアクセスできます。Items は，Items プロパティ内のメニューの要素を示す単一の TMenuItem オブジェクトです。Items プロパティは TMenuItem のデフォルトプロパティなので，TMenu の Items プロパティはメニュー内の個々の項目を記述するメニュー項目のインデックス配列として扱うことができます。したがって，

FirstItem := Menu1.Items.Items[0];

と記述するかわりに，

FirstItem := Menu1.Items[0];

を使います。

設計時に Items プロパティを設定するには，プロパティインスペクタで Items プロパティをクリックします。メニューデザイナにより，自動的にメニュー項目が挿入されます。各メニュー項目が入ると，メニュー項目の追加が可能な位置にアウトライン領域が現れます。この領域をクリックすると，追加するメニュー項目を指定できます。実行時には，プログラムでメニューの要素を記述する TMenuItem を作成し，メニューの Items プロパティを設定します。


TMenu.WindowHandle
TMenu.WindowHandle3312006

TMenu	参照

WindowHandle プロパティは，メニューを使うウィンドウのハンドルです。

property WindowHandle: HWnd;

説明

WindowHandle プロパティは，ユーザーがメニュー項目をクリックしたときに WM_COMMAND メッセージを受け取るコントロールのウィンドウハンドルを取得できます。メニュー項目が選択されているとき，OnClick イベントハンドラでこのハンドルを使うと，メニューを使うコントロールにメッセージを送ったり，コントロールに影響を及ぼす Windows API 呼び出しを行ったりすることができます。

WindowHandle を設定すると，メニューにコントロールを関連付けることができます。


TMenu メソッド3312007

TMenu	アルファベット順

TMenu

Create

Destroy

DispatchCommand

DispatchPopup

FindItem

GetHelpContext

IsShortCut

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TMenu メソッド3312008

TMenu	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DispatchCommand

DispatchPopup

FieldAddress

FindComponent

FindItem

Free

FreeInstance

FreeNotification

FreeOnRelease

GetHelpContext

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsShortCut

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TMenu.Create
TMenu.Create3312009

TMenu	参照

Create メソッドは，TMenu のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にメニューを作成できます。設計時にフォームに配置したメニューは自動的に作成されます。Create メソッドは継承した Create メソッドを呼び出し，Items プロパティを作成するとともに，メニューコンポーネントの初期値を設定します。


TMenu.Destroy
TMenu.Destroy3312010

TMenu	参照

Destroy メソッドは，メニューコンポーネントを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはメニューが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。Destroy メソッドは Items プロパティを解放し，継承した Destroy メソッドを呼び出します。


TMenu.DispatchCommand
TMenu.DispatchCommand3312011

TMenu	参照

DispatchCommand メソッドは，Command プロパティに指定した値を使ってメニュー項目の Click メソッドを呼び出します。

function DispatchCommand(ACommand: Word): Boolean;

説明

DispatchCommand メソッドを呼び出すと，コマンド ID に関連付けられているメニュー項目のクリックをシミュレートできます。コマンド ID に一致するメニュー項目を見つけると，DispatchCommand はそのメニュー項目の Click メソッドを呼び出して True を返します。項目がなければ False を返します。


TMenu.DispatchPopup
TMenu.DispatchPopup3312012

TMenu	参照

DispatchPopup メソッドは，ポップアップメニューコマンドをディスパッチします。

function DispatchPopup(AHandle: HMENU): Boolean;

説明

DispatchPopup メソッドを呼び出すと，ポップアップメニューハンドルに関連付けられているメニュー項目のクリックをシミュレートできます。ポップアップメニューハンドルに一致するメニュー項目を見つけると，DispatchPopup はそのメニュー項目の Click メソッドを呼び出して True を返します。項目がなければ False を返します。


TMenu.FindItem
TMenu.FindItem3312013

TMenu	参照

FindItem メソッドは，メニュー項目を検索して返します。

function FindItem(Value: Word; Kind: TFindItemKind): TMenuItem;

説明

FindItem メソッドを呼び出すと，メニュー内のメニュー項目またはサブメニューを検索できます。メニュー項目は，ポップアップメニューハンドル，コマンド ID メニューショートカットの値のいずれかで識別されます。Kind パラメータはメニュー項目を識別する方法を指定します。以下の値を指定できます。

値	意味

fkCommand	Windows の WM_COMMAND メッセージが使うメニューコマンドが Value パラメータと一致する

fkHandle	メニューハンドルが Value パラメータと一致する

fkShortCut	メニューショートカットが Value パラメータと一致する


TMenu.GetHelpContext
TMenu.GetHelpContext3312014

TMenu	参照

GetHelpContext メソッドは，メニュー項目に関連付けられているヘルプコンテキスト ID を返します。

function GetHelpContext(Value: Integer; ByCommand: Boolean): THelpContext;

説明

GetHelpContext メソッドを呼び出すと，特定のメニュー項目の状況感知型ヘルプの ID を取得できます。メニュー項目を Value プロパティに一致する項目として識別します。ByCommand が True の場合，Value は TMenuItem の Command プロパティになります。ByCommand が False の場合は，Value は Handle プロパティになります。


TMenu.IsShortCut
TMenu.IsShortCut3312015

TMenu	参照

IsShortCut メソッドは，キーメッセージがメニューの項目のショートカットキーを表す場合に，キーメッセージをディスパッチします。

function IsShortCut(var Message: TWMKey): Boolean;

説明

キーダウンメッセージを処理するときに IsShortCut メソッドを呼び出すと，ショートカットキーを識別し，対応するメニューアクションをトリガできます。IsShortCut メソッドは Message パラメータに渡されたキーメッセージを解読してから，メニュー項目の ShortCut プロパティを取得するために入力された文字の値を使って〔Shift〕，〔Ctrl〕，〔Alt〕キーの状態を符号化します。ショートカットキーの組み合わせに関連付けられているメニュー項目を見つけると，IsShortCut はその項目の Click メソッドを呼び出して True を返します。メッセージに対応するショートカットがメニュー内の項目にない場合は False を返します。


スコープ3312016

published

読み出し／書き込み

読み出し専用


継承3312017

TObject

TPersistent

TComponent


TMenuItem
TMenuItem3313001

継承	プロパティ	メソッド	イベント	参照	例 1	例 2

TMenuItem コンポーネントはメニューの項目のプロパティを示します。

ユニット

menus

説明

TMenuItem を使うと，メニューの項目の体裁および動作を指定できます。TMainMenu または TPopupMenu の各コンポーネントには複数のメニュー項目を入れることができます。設計時にメニューを定義するときは，メニューデザイナが自動的にメニュー上の各コマンドのメニュー項目オブジェクトを作成します。


TMenuItem プロパティ3313002

TMenuItem	アルファベット順	凡例

TMenuItem

Break

Caption

Checked

Command

Count

Default

Enabled

GroupIndex

Handle

HelpContext

Hint

Items

MenuIndex

Parent

RadioItem

ShortCut

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TMenuItem プロパティ3313003

TMenuItem	オブジェクト順	凡例

Break

Caption

Checked

Command

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Count

Default

DesignInfo

Enabled

GroupIndex

Handle

HelpContext

Hint

Items

MenuIndex

Name

Owner

Parent

RadioItem

ShortCut

Tag

VCLComObject

Visible


TMenuItem.Break
TMenuItem.Break3313004

TMenuItem	参照

Break プロパティは，メニュー項目を新しいメニューの列に置くかどうかを指定します。

property Break: TMenuBreak;

説明

Break プロパティを設定すると，長いメニューを，このメニュー項目によって示される項目で複数の列に分割することができます。次の値を指定できます。

値	意味

mbNone	メニューを分割しない。デフォルト値

mbBarBreak	Parent メニューを分割して別の列を作成し，新しい列の最上部にメニュー項目を表示する。古い列と新しい列をバーで区切る

mbBreak	Parent メニューを分割して別の列を作成し，新しい列の最上部にメニュー項目を表示する。古い列と新しい列の区切りはスペースだけ


TMenuItem.Caption
TMenuItem.Caption3313005

TMenuItem	参照

Caption プロパティは，メニュー項目のテキストを指定します。

property Caption: string;

説明

Caption プロパティは，メニューでこの項目を表す文字列に設定します。文字列の 1 つの文字に下線を付けるには，文字の前にアンド記号（&）を指定します。この形式の文字をアクセラレータ文字といいます。Caption にアクセラレータ文字が指定されている場合は，〔Alt〕キーを押しながら下線付き文字を入力すると，メニュー項目を選択できます。

Caption プロパティを使うと，メニュー項目をメニューを分割する線にすることができます。メニュー項目の Caption 値としてハイフン（-）を指定すると，そのメニュー項目が区切りであることを示すことができます。メニューを複数の列に分割するには，Break プロパティを使います。


TMenuItem.Checked
TMenuItem.Checked3313006

TMenuItem	参照

Checked プロパティは，Caption の横にチェックマークを表示するかどうかを指定します。

property Checked: Boolean;

説明

Checked プロパティは，メニュー項目をチェックボックスのように機能させることができます。Checked が True の場合，メニュー項目の隣にチェックマークが表示されます。Checked が False の場合，メニュー項目にチェックマークは付きません。


TMenuItem.Command
TMenuItem.Command3313007

TMenuItem	参照

Command プロパティは，メニュー項目に関連付けられている Windows のコマンド ID です。

property Command: Word;

説明

Command プロパティは，WM_COMMAND メッセージを直接処理するアプリケーションで使います。ユーザーがメニュー項目を選択すると，Windows はメニューに関連付けられているウィンドウに WM_COMMAND メッセージを送ります。メッセージの ItemID には，選択されたメニュー項目の Command プロパティの値が入ります。

たとえば，次の手続きは WM_COMMAND メッセージハンドラです。これは Msg の ItemID 項目をチェックして，メッセージがメニュー項目の呼び出した MenuThink によって生成されているかどうかを判断し，そうである場合にメッセージボックスを表示します。メッセージハンドラを記述するときは，Inherited を呼び出す必要がある場合にそれを後で呼び出すようにすると，Windows がデフォルトのメッセージ処理を実行できます。

procedure TForm1.WMCommand(var Msg: TWMCommand);

begin

  if Msg.ItemID = MenuThink.Command then

    MessageDlg('This is the Think command', mtInformation, [mbOk], 0);

  Inherited;

end;


TMenuItem.Count
TMenuItem.Count3313008

TMenuItem	参照

Count プロパティは，メニュー項目の下位項目の数です。

property Count: Integer;

説明

Count プロパティは，Items プロパティ配列にリストされる下位項目の数を取得できます。下位項目を持つメニュー項目をクリックすると，下位項目のドロップダウンメニューが表示されます。各下位項目には，さらに下位の項目を入れることができます。Count プロパティでカウントされるのは，メニュー項目の直接の下位項目だけです。


TMenuItem.Default
TMenuItem.Default3313009

TMenuItem	参照

Default プロパティは，親項目がダブルクリックされたときにメニュー項目を呼び出すかどうかを決めます。

property Default: Boolean;

説明

Default プロパティを設定すると，メニュー項目がサブメニュー内のデフォルト項目であるかどうかを指定できます。Default メニュー項目は，親項目をダブルクリックすると実行され，ユーザーはサブメニュー内を移動せずに済みます。

デフォルト項目は太字で表示されます。1 つのサブメニューに指定できるデフォルト項目は 1 つだけです。親メニュー項目の Items リストにすでにデフォルトメニュー項目がある場合，Default プロパティを True に設定すると，以前のデフォルト項目の Default プロパティ がFalse に設定されます。

注意

Default プロパティは，「新しいシェル」がインストールされている場合に限り Windows NT 3.51 で使えます。


TMenuItem.Enabled
TMenuItem.Enabled3313010

TMenuItem	参照

Enabled プロパティは，メニュー項目が使用可能かどうかを指定します。

property Enabled: Boolean;

説明

Enabled プロパティは，メニュー項目を使用可能または使用不可に設定できます。Enabled が True の場合，ユーザーがマウスで項目を選択すると，Click メソッドが呼び出されます。Enabled が False の場合，そのメニュー項目は淡色表示になり，ユーザーはその項目を選択できません。

注意

Click メソッドの呼び出しは Enabled が False のときでも有効です。


TMenuItem.GroupIndex
TMenuItem.GroupIndex3313011

TMenuItem	参照

GroupIndex プロパティは，メニュー項目が所属する論理グループを識別します。

property GroupIndex: Byte;

説明

GroupIndex プロパティは，メニューのマージ方法を制御できます。フォームが複数あるアプリケーションで，フォームがアクティブになったときに，2 番目のフォームのメニューの項目をアプリケーションのメインフォームにマージすることができます。MDI アプリケーションは常に子ウィンドウのメニューを親ウィンドウのメインメニューにマージします。

デフォルトでは，メニューバー（メインメニュー）のすべてのメニュー項目の GroupIndex 値は同じです。GroupIndex を使ってメニューをマージするには，連続しているメニュー項目の GroupIndex 値を 1 つ前のメニュー項目の値と同じかそれより大きい値に設定します。

アプリケーションのメインメニューにマージされるメニューバーのメニュー項目の GroupIndex 値がメインメニューのメニュー項目と同じである場合，アプリケーションのメインメニューのメニュー項目は対応するメニュー項目に置き換えられます。アプリケーションのメインメニューの複数のメニュー項目が同じ GroupIndex 値を持つ場合は，それらのメニュー項目は同じように重複する GroupIndex 値を持つ他のフォームのメニューの各メニュー項目によってのみ置き換えることができます。つまり，ある GroupIndex 値を持つメインメニューの 1 番目の項目は，同じ値を持つ 2 番目のフォームの 1 番目の項目と置き換えられ，メインフォームの 2 番目の項目は 2 番目のフォームの 2 番目のフォームと置き換えられる，などのようになります。

アプリケーションのメインメニューにマージされるメニューバーのメニュー項目の GroupIndex 値がアプリケーションのメインメニューの 2 つの隣接する項目の GroupIndex 値の間に入る場合は,そのメニュー項目は 2 つの隣接する項目の間に挿入されます。項目の GroupIndex 値が アプリケーションのメインメニューの他のすべての GroupIndex 値よりも大きい場合は，その項目はメインメニューの最後の項目になります。GroupIndex 値がアプリケーションのメインメニューの他のすべての GroupIndex 値よりも小さい場合は，その項目はメインメニューバーの最初の項目になります。

OLE 2.0 サーバーアプリケーションで作成したオブジェクトをアクティブにすると，OLE サーバーアプリケーションによってはサーバーがサーバーのメニューをコンテナアプリケーションのメニューとマージしようとします。GroupIndex プロパティを使って，上記の方法で，最大 3 つまでのメインメニュー項目をサーバーからの項目に置き換えます。サーバーアプリケーションは，以下に示す定義済みの GroupIndex 値を使って置き換えるメニュー項目を見つけます。

グループ	インデックス	説明

Edit	1	アクティブな OLE オブジェクトを編集するサーバーメニュー項目

View	3	OLE オブジェクトの表示を変更するサーバーメニュー項目

Help	5	サーバーのオンラインヘルプにアクセスするサーバーメニュー項目

注意

インプレースアクティベーション時に OLE サーバーがメニューのマージを試みるかどうかについては OLE サーバーのマニュアルを参照してください。

また，GroupIndex は，ラジオボタンのように動作するメニュー項目のグループを定義するのにも使うことができます。メニュー項目をラジオボタンのように動作させるには，グループ内のすべてのメニュー項目の RadioItem プロパティを True に設定し，各メニュー項目に同じ GroupIndex 値を割り当てます。グループ内のどれか 1 つのメニュー項目をチェックすると他の項目はチェックがはずれます。


TMenuItem.Handle
TMenuItem.Handle3313012

TMenuItem	参照

Handle プロパティは，メニュー項目に関連付けられているドロップダウンメニューの Windows メニューハンドルです。

property Handle: HMENU;

説明

Handle プロパティは，メニューハンドルが必要な Windows API 関数を呼び出すときに使います。Handle プロパティは Count プロパティが 0 以上の場合にのみ有効です。


TMenuItem.HelpContext
TMenuItem.HelpContext3313013

TMenuItem	参照

HelpContext プロパティは，メニュー項目に関連付けられているヘルプコンテキスト ID です。

property HelpContext: THelpContext;

説明

HelpContext プロパティは，メニュー項目をアプリケーションのヘルプシステムの画面に関連付けることができます。ヘルプシステムの各画面にはユニークなコンテキスト ID がなくてはなりません。キーボードを使ってメニュー項目を選択するとき，〔F1〕キーを押してヘルプ画面を表示します。どのヘルプ画面が表示されるかは HelpContext プロパティの値によって決まります。


TMenuItem.Hint
TMenuItem.Hint3313014

TMenuItem	参照

Hint プロパティは，ユーザーがメニュー項目にマウスポインタを合わせたときに表示されるテキスト文字列を指定します。

property Hint: string;

説明

Hint プロパティは，メニュー項目についての Caption よりも詳しい情報を表示する文字列を設定します。ヒントテキストは，ヘルプヒントが有効な場合に，ユーザーがメニュー項目の上でマウスポインタを止めたときにヘルプヒントウィンドウに表示されます。また，ヒントテキストはアプリケーションの OnHint イベントハンドラのコードにも利用できます。

Hint プロパティの値は，ヘルプヒントウィンドウ用の短い値と OnHint イベントハンドラによって使われる長い文字列との両方を指定できます。長いヒントと短いヒントを両方指定するには，Hint プロパティで，短いほうの文字列に続けて，縦棒（|）続けて長いほうの文字列を指定します。


TMenuItem.Items
TMenuItem.Items3313015

TMenuItem	参照

Items プロパティは，メニュー項目のサブメニュー内のメニュー項目のインデックス配列です。

property Items[Index: Integer]: TMenuItem; default;

説明

Items プロパティは，下位項目のリスト内での位置を指定して下位項目にアクセスできます。Index 値は Items 配列内の下位項目の位置です。たとえばアプリケーションの［ファイル(F)］ドロップダウンメニューにメニュー項目［新規作成(N)］，［開く(O)］，［保存(S)］が順に並んでいるとします。FileMenu.Items[2] は［保存(S)］コマンドを指します。


TMenuItem.MenuIndex
TMenuItem.MenuIndex3313016

TMenuItem	参照

MenuIndex プロパティは，親メニューの中でのメニュー項目のインデックスです。

property MenuIndex: Integer;

説明

MenuIndex プロパティを使うと，親メニュー項目の Items プロパティの中でメニュー項目の位置を取得できます。この値を変更すると，メニュー項目がメニューの中で移動します。

注意

表示されない項目がメニューにある場合は，MenuIndex と，ユーザーに表示されるメニュー内での位置とが対応しないことがあります。


TMenuItem.Parent
TMenuItem.Parent3313017

TMenuItem	参照

Parent プロパティは，メニュー項目の親メニュー項目を示します。

property Parent: TMenuItem;

説明

Parent プロパティは，このメニュー項目があるドロップダウンメニューを表示するメニュー項目を取得できます。メニュー項目がメインメニューまたはポップアップメニューの最上位レベルのメニュー項目である場合，Parent はそのメニューの Items プロパティの値になります。


TMenuItem.RadioItem
TMenuItem.RadioItem3313018

TMenuItem	参照

RadioItem プロパティは，メニュー項目がグループ内の他のメニュー項目と互いに排他的になるかどうかを指定します。

property RadioItem: Boolean;

説明

RadioItem プロパティは，メニュー項目をラジオボタンのように動作させることができます。RadioItem が True の場合は，そのメニュー項目が属するグループ内では 1 度に 1 つのメニュー項目しか選択できません。メニュー項目のグループは，同じ GroupIndex 値を持つ，ポップアップまたはドロップダウンメニュー内のすべてのメニュー項目の集合です。グループ内の選択されているメニューは，Caption の横に丸い点が付いて示されます。

RadioItem プロパティはメインメニューの最上位レベルの項目では無効です。

注意

Windows NT 3.51 では，この丸い点のインジケータは「新しいシェル」がインストールされている場合に限り表示されます。


TMenuItem.ShortCut
TMenuItem.ShortCut3313019

TMenuItem	参照

ShortCut プロパティは，メニュー項目へすばやくアクセスするために入力するキーの組み合わせを指定します。

property ShortCut: TShortCut

説明

ShortCut プロパティは，ユーザーに，メニューを使って項目を選択するかわりに，キーの組み合わせを入力して項目を選択できるようにします。このキーの組み合わせは，メニューのメニュー項目の右に表示されます。

設計時にショートカットを設定するときは，オブジェクトインスペクタが提示する長いキーの組み合わせのリストから選択することができます。実行時にメニューショートカットを作成するには，グローバル ShortCut または TextToShortCut 関数を使います。たとえば，次のコードは〔Ctrl〕+〔C〕キーというショートカットを作成し，CloseCommand というメニュー項目に割り当てます。

CloseCommand.ShortCut := ShortCut(Word('C'), [ssCtrl]);


TMenuItem.Visible
TMenuItem.Visible3313020

TMenuItem	参照

Visible プロパティは，メニュー項目をメニューに表示するかどうかを指定します。

property Visible: Boolean;

説明

Visible プロパティを使うと，メニュー項目がユーザーに表示されないようにすることができます。たとえば，OnPopup イベントハンドラでポップアップメニューの現在のコンポーネントに適用されないメニュー項目を除去する場合などに使います。

Visible が True ならば，メニュー項目が表示されます。Visible が False ならば，メニュー項目は表示されません。


TMenuItem イベント3313021

TMenuItem	アルファベット順	凡例

TMenuItem

OnClick


TMenuItem イベント3313022

TMenuItem	オブジェクト順	凡例

OnClick


TMenuItem.OnClick
TMenuItem.OnClick3313023

TMenuItem	参照

OnClick イベントは，ユーザーがメニュー項目をクリックしたときに発生します。

TNotifyEvent = procedure (Sender: TObject) of object;

property OnClick: TNotifyEvent;

説明

OnClick イベントハンドラを記述すると，ユーザーがメニュー項目を選択したときに希望の動作を実現できます。ユーザーがメニュー項目を選択したときに送られる WM_COMMAND メッセージを直接処理するかわりに OnClick イベントハンドラを使う利点は，Click メソッドが呼び出されたときに Click イベントだけが発生するようになるという点です。


TMenuItem メソッド3313024

TMenuItem	アルファベット順

TMenuItem

Add

Click

Create

Delete

Destroy

IndexOf

Insert

Remove

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCalException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TMenuItem メソッド3313025

TMenuItem	オブジェクト順

Add

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Click

Create

DefaultHandler

Delete

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

IndexOf

InheritsFrom

InitInstance

Insert

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

Remove

RemoveComponent

SafeCalException


TMenuItem.Add
TMenuItem.Add3313026

TMenuItem	参照

Add プロパティは，Item プロパティ配列の最後にメニュー項目を追加します。

procedure Add(Item: TMenuItem);

説明

Add メソッドを呼び出すと，このメニュー項目のドロップダウンメニューに新しいメニュー項目を追加できます。このメニュー項目がメインメニューまたはポップアップメニューの Items プロパティの値である場合，Add メソッドは項目をメニューの最後に追加します。新たに追加するメニュー項目を Item パラメータの値として指定します。

たとえば，次のコードは File で示されているメニューに新しいメニュー項目を追加します。

procedure Form1.Button1Click(Sender: TSender);

var

  NewItem: TMenuItem;

begin

  NewItem := TMenuItem.Create(Self);

  NewItem.Caption := 'New item';

  File.Add(NewItem);

end;


TMenuItem.Click
TMenuItem.Click3313027

TMenuItem	参照

Click メソッドは，マウスのクリックと同じです。

procedure Click; virtual;

説明

Click メソッドは，ユーザーがメニュー項目をクリックしたときと同様に OnClick イベントを生成します。実際のマウスクリックとは異なり，Click メソッドはメニューに関連付けられているウィンドウに WM_COMMAND メッセージを送りません。

コンポーネントを開発する場合は，Click メソッドをオーバーライドして，ユーザーがメニュー項目を選択したときに異なる応答を提供できます。


TMenuItem.Create
TMenuItem.Create3313028

TMenuItem	参照

Create メソッドは，TMenuItem のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にメニュー項目を作成できます。設計時にメニューデザイナを使って定義したメニュー項目は，自動的に作成されます。継承するコンストラクタを呼び出した後で，Create は Visible および Enabled プロパティを True に設定し，Command プロパティにユニークな値を生成します。


TMenuItem.Delete
TMenuItem.Delete3313029

TMenuItem	参照

Delete メソッドは，Items プロパティ配列からメニュー項目を削除します。

Procedure Delete(Index: Integer);

説明

Delete メソッドを呼び出すと，メニューからメニュー項目とその項目のすべてのサブメニューを削除できます。Index パラメータは削除する項目のインデックスで，0 でメニューの 1 番目の項目が指定され，1 で 2 番目の項目が指定されます。


TMenuItem.Destroy
TMenuItem.Destroy3313030

TMenuItem	参照

Destroy メソッドは，TMenuItem のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはメニュー項目が解放されていないことを確認してからのみ Destroy メソッドを呼び出します。


TMenuItem.IndexOf
TMenuItem.IndexOf3313031

TMenuItem	参照

IndexOf メソッドは，Item 配列内でのメニュー項目の位置を返します。

function IndexOf(Item: TMenuItem): Integer;

説明

IndexOf メソッドを呼び出すと，このメニュー項目のサブメニューでのメニュー項目の位置を調べることができます。IndexOf は 1 番目のメニュー項目の場合は 0 を返し，2 番目のメニュー項目の場合は 1 を返します。メニュー項目がサブメニュー内にない場合は，-1 を返します。

注意

表示されない項目がメニューにある場合は，IndexOf が返す値と，ユーザーに表示されるメニュー内での位置とが対応しないことがあります。


TMenuItem.Insert
TMenuItem.Insert3313032

TMenuItem	参照

Insert メソッドは，Items 配列内の指定した位置にメニュー項目を挿入します。

procedure Insert(Index: Integer; Item: TMenuItem);

説明

Insert メソッドを呼び出すと，このメニュー項目のドロップダウンメニューに新しいメニュー項目を挿入できます。このメニュー項目がメインメニューまたはポップアップメニューの Items プロパティの値である場合，Insert はそのメニューに項目を挿入します。新たに追加するメニュー項目を Item パラメータの値として指定し，Items 配列内の位置を Index パラメータの値として指定します。

たとえば，次のコードでは，FileMenu で指定されているメニューの最初の項目の次にメニュー項目を挿入します。

procedure TForm1.Button1Click(Sender: TObject);

var

  NewItem: TMenuItem;

begin

  NewItem := TMenuItem.Create(FileMenu);

  try

    NewItem.Caption := 'Do this';

    FileMenu.Insert(1, NewItem);

  except

    NewItem.Free;

    raise; { 例外を再生成する }

  end;

end;


TMenuItem.Remove
TMenuItem.Remove3313033

TMenuItem	参照

Remove メソッドは，Items プロパティ配列からメニュー項目を削除します。

procedure Remove(Item: TMenuItem);

説明

Remove メソッドを呼び出すと，メニューからメニュー項目とその項目のすべてのサブメニューを削除できます。Item パラメータは削除する項目です。Item が Items 配列内のメニュー項目でない場合は，Remove は例外を生成します。

メニュー項目を削除するのではなく一時的に隠したい場合は Visible プロパティを使います。


スコープ3313034

published

読み出し／書き込み

読み出し専用


スコープ3313035

published


継承3313036

TObject

TPersistent

TComponent


TMenuItem 例3313037

TMenuItem


TMetafile
TMetafile3314001

継承	プロパティ	メソッド	イベント	参照

TMetafile は Win32 のエンハンスドメタファイルグラフィックをカプセル化したものです。

ユニット

graphics

説明

TMetafile はメタファイル（EMF ファイル形式）を格納します。

TMetafile のプロパティはメタファイルのサイズおよび特性を示します。

メタファイルをキャンバスに描画するには，TMetafile をパラメータとして渡して，TCanvas オブジェクトの Draw メソッドまたは StretchDraw メソッドを呼び出します。Enhanced プロパティによってメタファイルをディスクにどのように格納するかが決まります。Enhanced が True の場合はメタファイルは .EMF（Win32 エンハンスドメタファイル）として格納されます。Enhanced が False の場合はメタファイルは .WMF（Windows 3.1 メタファイル，Aldus ヘッダー付き）として格納されます。


TMetafile プロパティ3314002

TMetafile	アルファベット順	凡例

TMetafile

CreatedBy

Description

Empty

Enhanced

Handle

Height

Inch

MMHeight

MMWidth

Palette

Width

TGraphic からの継承

Modified

PaletteModified

Transparent


TMetafile プロパティ3314003

TMetafile	オブジェクト順	凡例

CreatedBy

Description

Empty

Enhanced

Handle

Height

Inch

MMHeight

MMWidth

Modified

Palette

PaletteModified

Transparent

Width


TMetafile.CreatedBy
TMetafile.CreatedBy3314004

TMetafile	参照

CreatedBy プロパティは，作成済みのメタファイルに使い，メタファイルに埋め込まれている作成者またはアプリケーションのオプション名を返します。

property CreatedBy: string;

説明

CreatedBy プロパティは，メタファイルの作者またはメタファイルの作成に使うアプリケーションのオプション名に文字列を設定できます。新しいメタファイルの CreatedBy 文字列を設定するには，TMetafileCanvas の CreateWithComment メソッドを呼び出します。


TMetafile.Description
TMetafile.Description3314005

TMetafile	参照

Description プロパティは，メタファイルに埋め込まれたオプションのテキスト記述を返します。

property Description: string;

説明

新しいメタファイルの Description プロパティの文字列を設定するには，TMetafileCanvas の CreateWithComment メソッドを呼び出します。


TMetafile.Empty
TMetafile.Empty3314006

TMetafile

Empty プロパティは，メタファイルオブジェクトにメタファイルがあるかどうかを示します。

property Empty: Boolean;

説明

メタファイルがメタファイルオブジェクトにロードされていない場合 Empty は True になり，メタファイルオブジェクトがメタファイルを含んでいれば Empty は False になります。


TMetafile.Enhanced
TMetafile.Enhanced3314007

TMetafile

Enhanced プロパティは，メタファイルをディスクに格納する方法を決めます。

property Enhanced: Boolean;

説明

Enhanced プロパティは，メタファイルをディスクに格納する方法を設定できます。Enhanced が True の場合，メタファイルは .EMF（Win32 エンハンスドメタファイル）として格納されます。Enhanced が False の場合，メタファイルは .WMF（Windows 3.1 メタファイル，Aldus ヘッダー付き）として格納されます。メモリ内での形式は常に EMF です。WMF は機能が非常に限られており，WMF として格納すると，EMF では保持される情報の一部は保有されません。このプロパティはストリームまたはファイルからのロード時にメタファイルの種類に一致するように設定されます。これにより，16 ビット Delphi とのフォームファイルの互換性が保たれます。WMF としてロードされた場合は WMF として保存します。


TMetafile.Handle
TMetafile.Handle3314008

TMetafile

Handle プロパティは，GDI メタファイルオブジェクトにアクセスするための Windows GDI メタファイルハンドルへのアクセスを提供します。

property Handle: HMetafile;

説明

メタファイルオブジェクトのハンドルが必要な Windows API 関数を呼び出す場合に Handle を使います。メタファイルオブジェクトの Handle プロパティから関数へハンドルを渡します。


TMetafile.Height
TMetafile.Height3314009

TMetafile	参照

Height プロパティは，メタファイルの縦方向のサイズをピクセル単位で指定します。

property Height: Integer;

説明

Height プロパティは，メタファイルの高さの確認または設定が行えます。


TMetafile.Inch
TMetafile.Inch3314010

TMetafile

Inch プロパティは，メタファイルの座標マップに使う 1 インチ当たりの単位を返します。

property Inch: Word;

説明

Inch プロパティは，メタファイルで想定されている 1 インチ当たりの単位を特定し，WMF として記述するときにスケールを変更できますが，それ以外の場合ではこのプロパティは使われません。エンハンスドメタファイルはすべてのスケール情報を内部的に保守します。たとえば，（MM_TWIPS マップを使って）Twips 座標系でメタファイルが作成されている場合，Inch の値は 1440 です。


TMetafile.MMHeight
TMetafile.MMHeight3314011

TMetafile	参照

MMHeight プロパティは，メタファイルイメージの高さを 0.01 ミリメートル単位（エンハンスドメタファイルが使うネイティブなスケール）で示します。

property MMHeight: Integer;

説明

MMHeight プロパティは，MMHeight を使って寸法を mm 単位で設定するかを取得することによってデバイスのピクセル数と mm との変換で精度が失われるのを避けることができます。MMHeight プロパティは常に画面デバイスのピクセル単位で表されます。


TMetafile.MMWidth
TMetafile.MMWidth3314012

TMetafile	参照

MMWidth プロパティは，メタファイルイメージの幅を 0.01 ミリメートル単位（エンハンスドメタファイルが使うネイティブなスケール）で示します。

property MMWidth: Integer;

説明

MMWidth プロパティは，MMWidth を使って寸法を mm 単位で設定するかを取得することによってデバイスのピクセル数と mm との変換で精度が失われるのを避けることができます。

MMWidth プロパティは常に画面デバイスのピクセル単位で表されます。


TMetafile.Palette
TMetafile.Palette3314013

TMetafile

Palette プロパティは，メタファイルのカラーマッピングを制御します。

property Palette: HPalette;

説明

Palette プロパティは，Windows API の CreatePalette 関数で作成したカスタムパレットを設定できます。

メタファイルの Palette にはメタファイルの画面表示に使える最高 256 色が入っています。256 色ビデオモードを使っているときに，メタファイルがフォアグラウンドで実行されているアプリによって秒がされる場合，Palette のすべての色が Windows システムパレットに追加されます。メタファイルがバックグラウンドで実行されているアプリケーションによって描画され留場合，別のアプリケーションがすでに独自の色のシステムパレットをロードしていると，メタファイルの色はシステムパレットへマップされます。メタファイルに色がない場合は Palette=0 です。


TMetafile.Width
TMetafile.Width3314014

TMetafile	参照

Width プロパティは，メタファイルの横方向のサイズをピクセル単位で指定します。

property Width: Integer;

説明

Width プロパティは，メタファイルの横方向のサイズを示します。


TMetafile イベント3314015

TMetafile	アルファベット順

TGraphic からの継承

OnChange

OnProgress


TMetafile イベント3314016

TMetafile	オブジェクト順

OnChange

OnProgress


TMetafile メソッド3314017

TMetafile	アルファベット順

TMetafile

Assign

Clear

Create

Destroy

LoadFromClipboardFormat

LoadFromStream

ReleaseHandle

SaveToClipboardFormat

SaveToFile

SaveToStream

TGraphic からの継承

LoadFromFile

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TMetafile メソッド3314018

TMetafile	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LoadFromClipboardFormat

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

ReleaseHandle

SafeCallException

SaveToClipboardFormat

SaveToFile

SaveToStream


TMetafile.Assign
TMetafile.Assign3314019

TMetafile	参照

Assign メソッドは，オブジェクトをメタファイルにコピーします。

procedure Assign(Source: TPersistent);

説明

Assign メソッドは，オブジェクトの Enhanced プロパティおよび Palette プロパティをメタファイルにコピーします。メタファイルが nil の場合，Assign は新しく作成します。それ以外の場合，Assign は継承メソッドを呼び出します。割り当てる場合，メタファイルは別の TGraphic オブジェクトで使うときと TPicture で使うときには別の型になります。


TMetafile.Clear
TMetafile.Clear3314020

TMetafile	参照

Clear メソッドは，古いメタファイルイメージを削除します。

procedure Clear;

説明

Clear メソッドを呼び出すと，古いメタファイルイメージを解放し，新しいイメージを作成して参照カウントをインクリメントできます。


TMetafile.Create
TMetafile.Create3314021

TMetafile	参照

Create メソッドは，メタファイルオブジェクトをインスタンス化します。

constructor Create; override;

説明

Create メソッドを呼び出すと，実行時にメタファイルをインスタンス化できます。

Create はメモリをメタファイルオブジェクトに割り当て，継承された Create を呼び出してから，Enhanced プロパティと Transparent プロパティを True に設定します。

メタファイルイメージを作成するには，イメージをメタファイルキャンバスに描画します。メタファイルキャンバスが破棄されるときに，イメージはメタファイルキャンバスコンストラクタに提供されるメタファイルオブジェクトに転送されます。イメージがキャンバスに描画された後，キャンバスは破棄され，そのイメージはメタファイルオブジェクトで再生可能になります。


TMetafile.Destroy
TMetafile.Destroy3314022

TMetafile	参照

Destroy メソッドは，メタファイルオブジェクトのインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで Destroy を直接呼び出さないでください。かわりに，Free を呼び出します。Free はメタファイルオブジェクトが破棄済みでないことを確認してから Destroy を呼び出します。

Destroy はイメージを解放し，そのメタファイルイメージへの参照カウントが 0 になるとイメージとハンドルが解放されます。次に，Destroy は継承された Destroy を呼び出します。


TMetafile.LoadFromClipboardFormat
TMetafile.LoadFromClipboardFormat3314023

TMetafile	参照

LoadFromClipboardFormat メソッドは，クリップボードからメタファイルをロードします。

procedure LoadFromClipboardFormat(AFormat: Word; AData: THandle; APalette: HPALETTE); override;

説明

LoadFromClipboardFormat メソッドは，現在のイメージを AData パラメータで指定した値に置き換えます。メタファイルのパレットは APalette パラメータで指定します。LoadFromClipboardFormat は，メタファイルが RegisterClipboardFormat メソッドを使って TPicture オブジェクトに登録されている場合に呼び出されます。


TMetafile.LoadFromStream
TMetafile.LoadFromStream3314024

TMetafile	参照

LoadFromStream メソッドは，ストリームからメタファイルをロードします。

procedure LoadFromStream(Stream: TStream); override;

説明

LoadFromStream メソッドは，メタファイルを Stream の値としてロードするストリームを指定して使います。LoadFromStream はストリームからメタファイルを読み出して，それを現在のイメージと置き換えます。


TMetafile.ReleaseHandle
TMetafile.ReleaseHandle3314025

TMetafile	参照

ReleaseHandle メソッドは，メタファイルによって表される Windows GDI オブジェクトを解放します。

function ReleaseHandle: HENHMETAFILE;

説明

ReleaseHandle を呼び出すとメタファイルを表すのに使うリソースを解放できます。ReleaseHandle は Handle プロパティを nil に設定します。

メタファイルに関連付けられたリソースが失われないように，ReleaseHandle を呼び出してから Handle プロパティを設定します。


TMetafile.SaveToClipboardFormat
TMetafile.SaveToClipboardFormat3314026

TMetafile	参照

SaveToClipboardFormat メソッドは，メタファイルをクリップボード形式に保存します。

procedure SaveToClipboardFormat(var AFormat: Word; var AData: THandle; var APalette: HPALETTE); override;

説明

SaveToClipboardFormat は，パレットを APalette パラメータの値に，形式を AFormat パラメータの値に，そして保存するデータを AData パラメータの値に指定して使います。メタファイルが保存される前に，アプリケーションは RegisterClipboardFormat メソッドを使ってメタファイルオブジェクトに形式を登録しておかなければなりません。

メタファイルをファイルに保存するには，SaveToFile メソッドを呼び出します。


TMetafile.SaveToFile
TMetafile.SaveToFile3314027

TMetafile	参照

SaveToFile メソッドは，メタファイルをファイルに保存します。

procedure SaveToFile(const Filename: String); override;

説明

SaveToFile メソッドを呼び出すと，メタファイルを Filename で指定したファイルに保存できます。メタファイルをファイルからロードするには，LoadFromFile メソッドを呼び出します。


TMetafile.SaveToStream
TMetafile.SaveToStream3314028

TMetafile	参照

SaveToStream メソッドは，メタファイルをストリームに書き込みます。

procedure SaveToStream(Stream: TStream); override;

説明

SaveToStream メソッドを呼び出すと，メタファイルを Stream パラメータの値で指定されたストリームに保存できます。


読み出し／書き込み3314029

読み出し専用


継承3314030

TObject

TPersistent

TGraphic


TMetafile 例3314031

TMetafile


TMasterDataLink
TMasterDataLink3315001

継承	プロパティ	メソッド	イベント	参照

TMasterDataLink は，データセットがそのレコードを別のデータソースから取得できるようにするヘルパーオブジェクトです。

ユニット

dbcommon

説明

TMasterDataLink は，別のデータソースのレコードを表現できるデータセットオブジェクトのプライベートメンバーとして使います。TMasterDataLink は二次ソースからの項目コンポーネントのリストを管理して，それを所有するデータソースにデータイベントを渡します。別のデータソースにリンクするために TMasterDataLink を使うデータセットのコンストラクタでは，TMasterDataLink オブジェクトを作成してデータイベントに応答するためのイベントハンドラを設定します。

TMasterDataLink の DataSet プロパティの値であるデータセットと，二次ソースからレコードを取得するために TMasterDataLink を使うデータセットとを混同しないでください。DataSet プロパティは，TMasterDataLink オブジェクトを所有するデータセットのサブセットであるソースデータセットです。

TClientDataSet オブジェクトと TTable オブジェクトは，二次データソースにリンクするために TMasterDataLink オブジェクトをすでに保持しています。


TMasterDataLink のプロパティ3315002

TMasterDataLink	アルファベット順	凡例

TMasterDataLink

FieldNames

Fields

TdataLink からの継承

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


TMasterDataLink のプロパティ3315003

TMasterDataLink	オブジェクト順	凡例

ActiveRecord

Active

BufferCount

DataSet

DataSourceFixed

DataSource

Editing

FieldNames

Fields

ReadOnly

RecordCount


TMasterDataLink.FieldNames
TMasterDataLink.FieldNames3315004

TMasterDataLink	参照

FieldNames プロパティは，TMasterDataLink オブジェクトを所有するデータセットによって表されるデータソースからの項目の名前を保持する文字列です。

property FieldNames: string;

説明

FieldNames プロパティは，TMasterDataLink オブジェクトを所有するデータセットが表す項目に設定します。文字列内の各項目名は，セミコロンで区切る必要があります。

FieldNames プロパティを設定すると，TMasterDataLink はソースデータセットの項目コンポーネントから Fields プロパティを再生成します。Fields プロパティがいったん再生成されると，TMasterDatalink が OnMasterChange イベントを発生させます。


TMasterDataLink.Fields
TMasterDataLink.Fields3315005

TMasterDataLink	参照

Fields プロパティは，TmasterDataLink を所有するデータセットによって使われるデータソースのすべての項目コンポーネントのリストです。

property Fields: TList;

説明

Fields プロパティは，ソースデータセットの各項目コンポーネントにアクセスするために使われます。Fields は，TmasterDataLink を所有するデータセットの Fields プロパティに値を提供します。

Fields は読み出し専用プロパティです。Fields は，ソースデータセット内の FieldNames プロパティが参照する項目コンポーネントを特定することで生成されます。


TMasterDataLink のイベント3315006

TMasterDataLink	アルファベット順

TMasterDataLink

OnMasterChange

OnMasterDisable


TMasterDataLink のイベント3315007

TMasterDataLink	オブジェクト順

OnMasterChange

OnMasterDisable


TMasterDataLink.OnMasterChange
TMasterDataLink.OnMasterChange3315008

TMasterDataLink	参照

OnMasterChange イベントは，Fields プロパティが変更されると発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnMasterChange: TNotifyEvent;

説明

OnMasterChange イベントハンドラを記述すると，ソースデータセットまたは FieldNames プロパティで発生した変化を反映するように TMasterSourceLink を所有するデータセットを更新できます。Fields プロパティは，ソースデータセットと FieldNames プロパティの新しい状態を反映しています。FieldNames がソースデータセットから失われた項目を参照している場合，Fields プロパティはそれらの項目を未定義項目コンポーネントとして保持します。


TMasterDataLink.OnMasterDisable
TMasterDataLink.OnMasterDisable3315009

TMasterDataLink	参照

OnMasterDisable イベントは，ソースデータセットが非アクティブになったときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnMasterDisable: TNotifyEvent;

説明

OnMasterDisable イベントハンドラを記述すると，TMasterDataLink を所有するデータセットにデータを提供するソースデータセットが非アクティブになったときに応答できます。ソースデータセットが非アクティブなときは，ソースデータセットのレコードからデータを取得するために Fields プロパティの項目コンポーネントを使うことはできません。このため，OnMasterDisable イベントから次の OnMasterChange イベントが発生するまでの間，TMasterDataLink を所有するデータセットがキャッシュしている情報のみが使えます。


TMasterDataLink のメソッド3315010

TMasterDataLink	アルファベット順	凡例

TMasterDataLink

ActiveChanged

CheckBrowseMode

Create

Destroy

LayoutChanged

RecordChanged

TdataLink からの継承

Edit

UpdateRecord

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TMasterDataLink のメソッド3315011

TMasterDataLink	オブジェクト順	凡例

ActiveChanged

Assign

CheckBrowseMode

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

Edit

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LayoutChanged

MethodAddress

MethodName

NewInstance

RecordChanged

SafeCallException

UpdateRecord


TMasterDataLink.ActiveChanged
TMasterDataLink.ActiveChanged3315012

TMasterDataLink	参照

ActiveChanged メソッドは，Fields プロパティを再生成して OnMasterChange イベントまたは OnMasterDisable イベントを発生させます。

procedure ActiveChanged; override;

説明

アプリケーションは ActiveChanged 手続きを直接呼び出せません。Active プロパティの変更はこの手続きの呼び出しを発生させます。ソースデータセットが非アクティブになると，ActiveChanged は Fields プロパティをクリアして OnMasterDisable イベントを発生させます。データセットがアクティブになると，ActiveChanged はソースデータセットから Fields を再生成して OnMasterChange イベントを生成します。


TMasterDataLink.CheckBrowseMode
TMasterDataLink.CheckBrowseMode3315013

TMasterDataLink	参照

CheckBrowseMode メソッドは，ソースデータセット内のカレントレコードが移動する直前に，TMasterDataLink オブジェクトを所有するデータセットに通知します。

procedure CheckBrowseMode; override;

説明

アプリケーションは CheckBrowseMode 手続きを直接呼び出せません。CheckBrowseMode は，ソースデータセットのカレントレコードが移動する直前に呼び出されます。これは TMasterDataLink オブジェクトを所有するデータセットの CheckBrowseMode メソッドを呼び出すので，レコードが移動する前に保留中の編集内容を登録することができます。


TMasterDataLink.Create
TMasterDataLink.Create3315014

TMasterDataLink	参照

Create メソッドは，TmasterDataLink のインスタンスを作成します。

constructor Create(DataSet: TDataSet);

説明

TMasterDataLink を使うデータセットのコンストラクタから Create メソッドを呼び出すと，二次データソースにリンクできます。TMasterDataLink を使うデータセットは，それ自体を DataSet パラメータとして渡します。

Create メソッドは，TMasterDataLink のインスタンスとそれを所有するデータセットとを関連付け，項目コンポーネントのリストを管理するのにそれが使うヘルパーオブジェクトを作成します。


TMasterDataLink.Destroy
TMasterDataLink.Destroy3315015

TMasterDataLink	参照

Destroy メソッドは，TmasterDataLink のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで Destroy メソッドを直接呼び出さないでください。かわりに，TMasterDataLink オブジェクトを所有するデータセットのデストラクタから Free メソッドを呼び出します。Free は TMasterDataLink オブジェクトが解放済みでないことを確認してからのみ Destroy を呼び出します。

Destroy は，項目コンポーネントのリストを管理するのに使われていたメモリを解放します。


TMasterDataLink.LayoutChanged
TMasterDataLink.LayoutChanged3315016

TMasterDataLink	参照

LayoutChanged メソッドは，データソースがバッファ処理されるレコード数を変更した後に TMasterDataLink オブジェクトを所有するデータセットに通知します。

procedure LayoutChanged; override;

説明

アプリケーションは LayoutChanged メソッドを直接呼び出せません。LayoutChanged は，ソースデータセットがリンクされたコントロールのレイアウト変更をソースデータセットが反映するときに自動的に呼び出されます。LayoutChanged は Fields プロパティを再生成して OnMasterChange イベントを発生させます。


TMasterDataLink.RecordChanged
TMasterDataLink.RecordChanged3315017

TMasterDataLink	参照

RecordChanged メソッドは，現在のレコード内の項目の 1 つの内容が変更されたときに OnMasterChange イベントを生成します。

procedure RecordChanged(Field: TField); override;

説明

アプリケーションは RecordChanged を直接呼び出せません。これは，現在のレコードの内容が変更されたときに自動的に呼び出されます。Field パラメータは，現在のレコードでどの項目が変更されたかを示します。Field が nil の場合，レコード全体が変更されています。

Field パラメータが nil の場合や，Field パラメータが Fields プロパティに記述された項目の 1 つである場合は，RecordChanged は OnMasterChange イベントを発生させます。


アクセス種別3315018

読み出し専用


スコープ3315019

protected


継承3315020

TObject

TPersistent

TDataLink


TMasterDataLink の例3315021

TMasterDataLink


TMetaFileCanvas
TMetaFileCanvas3316001

継承	プロパティ	メソッド	イベント	参照

TMetafileCanvas オブジェクトは，メタファイルイメージを作成するために使います。

ユニット

graphics

説明

TMetafileCanvas オブジェクトは，メタファイルイメージを描画する表面（キャンバス）として使います。TMetaFileCanvas が破棄されると，TMetaFileCanvas のコンストラクタに指定されたメタファイルオブジェクトへキャンバスからイメージが転送されます。次に例を示します。

MyMetafile := TMetafile.Create;

with TMetafileCanvas.Create(MyMetafile, 0) do

try

Brush.Color := clRed;

Ellipse(0,0,100,100);

...

finally

Free;

end;

Form1.Canvas.Draw(0,0,MyMetafile); { 1 つの赤い円 }

既存のメタファイルイメージを拡大するには，メタファイルキャンバスを作成して，ソースメタファイルをそのメタファイルキャンバスに再生します。次に例を示します。

{ 前の例から続いているため，MyMetafile にイメージがあります }

with TMetafileCanvas.Create(MyMetafile, 0) do

try

Draw(0,0,MyMetafile);

Brush.Color := clBlue;

Ellipse(100,100,200,200);

...

finally

Free;

end;

Form1.Canvas.Draw(0,0,MyMetafile); { 1 つの赤い円と 1 つの青い円 }


TMetaFileCanvas プロパティ3316002

TMetaFileCanvas	アルファベット順	凡例

TCanvas からの継承

Brush

ClipRect

CopyMode

Font

Handle

LockCount

Pen

PenPos

Pixels


TMetaFileCanvas プロパティ3316003

TMetaFileCanvas	オブジェクト順	凡例

Brush

ClipRect

CopyMode

Font

Handle

LockCount

Pen

PenPos

Pixels


TMetaFileCanvas イベント3316004

TMetaFileCanvas	アルファベット順

TCanvas からの継承

OnChange

OnChanging


TMetaFileCanvas イベント3316005

TMetaFileCanvas	オブジェクト順

OnChange

OnChanging


TMetaFileCanvas メソッド3316006

TMetaFileCanvas	アルファベット順

TMetafileCanvas

Create

CreateWithComment

Destroy

TCanvas からの継承

Arc

BrushCopy

Chord

CopyRect

Draw

DrawFocusRect

Ellipse

FillRect

FloodFill

FrameRect

LineTo

Lock

MoveTo

Pie

Polygon

Polyline

Rectangle

Refresh

RoundRect

StretchDraw

TextHeight

TextOut

TextRect

TextWidth

TryLock

Unlock

TPersistent からの継承

Assign

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

TextExtent


TMetaFileCanvas メソッド3316007

TMetaFileCanvas	オブジェクト順

Arc

Assign

BrushCopy

Chord

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyRect

Create

CreateWithComment

DefaultHandler

Destroy

Dispatch

Draw

DrawFocusRect

Ellipse

FieldAddress

FillRect

FloodFill

FrameRect

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LineTo

Lock

MethodAddress

MethodName

MoveTo

NewInstance

Pie

Polygon

Polyline

Rectangle

Refresh

RoundRect

SafeCallException

StretchDraw

TextExtent

TextHeight

TextOut

TextRect

TextWidth

TryLock

Unlock


TMetaFileCanvas.Create
TMetaFileCanvas.Create3316008

TMetaFileCanvas	参照

Create メソッドは TMetafileCanvas のインスタンスを作成し，メタファイルデバイスコンテキストへのハンドルを取得します。

constructor Create(AMetafile: TMetafile!ALink(TMetafile_Object,1); ReferenceDevice: HDC);

説明

Create メソッドを呼び出すと，TMetafileCanvas のインスタンスを作成できます。Create メソッドは，MMHeight および MMWidth プロパティがまだ設定されていない場合に，HDC を参照してから TMetafile オブジェクトのサイズを設定します。それから，Create メソッドはメタファイルデバイスコンテキストを作成し，Handle プロパティをそのハンドルに設定します。以降のすべての描画メソッドはこのメタファイルコンテキストに描画することになります。


TMetaFileCanvas.CreateWithComment
TMetaFileCanvas.CreateWithComment3316009

TMetaFileCanvas	参照

CreateWithComment メソッドは，TMetafileCanvas のインスタンスを作成し，コメント文字列を持つメタファイルデバイスコンテキストへのハンドルを取得します。

constructor CreateWithComment(AMetafile: TMetafile; ReferenceDevice: HDC;

      const CreatedBy, Description: String);

説明

CreateWithComment メソッドを呼び出すと，CreatedBy および Description 文字列を受け取るメタファイルの TMetafileCanvas オブジェクトをインスタンス化できます。CreateWithComment メソッドは，MMHeight および MMWidth プロパティがまだ設定されていない場合に，HDC を参照してから TMetafile オブジェクトのサイズを設定します。次に，Create メソッドは CreatedBy および Description 文字列を説明として使ってメタファイルデバイスコンテキストを作成し，Handle プロパティをそのハンドルに設定します。以降の描画メソッドはすべてこのメタファイルデバイスコンテキストに描画することになります。

TMetaFileCanvas オブジェクトが破棄されると，CreatedBy および Description 文字列が TMetafile オブジェクトの同じ名前のプロパティに設定されます。


TMetaFileCanvas.Destroy
TMetaFileCanvas.Destroy3316010

TMetaFileCanvas	参照

Destroy メソッドは，コンストラクタに渡された TMetaFile オブジェクトにイメージを転送してから TMetafileCanvas のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TMetafileCanvas オブジェクトがまだ解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは，コンストラクタに渡された TMetaFile オブジェクトの Handle プロパティを設定してから，オブジェクトに関連付けられているメモリを解放します。


スコープ3316011

published

読み出し／書き込み

読み出し専用


継承3316012

TObject

TPersistent

TCanvas


TMetaFileCanvas 例3316013

TMetaFileCanvas


TMetafileImage
TMetafileImage3317001

継承	メソッド	参照

TMetafileImage プロパティは，TMetafile オブジェクトのメタファイルイメージの内部表現です。

ユニット

graphics

説明

TMetafileImage は Delphi では内部表現にのみ使われ，TMetafile オブジェクトによってカプセル化されたメタファイルの内部イメージを表します。TMetafileImage に導入されるデータとメソッドはすべてプライベートで，Windows で定義される HENHMETAFILE（拡張メタファイルハンドル）構造体や HPALETTE（パレットへのハンドル）構造体へのポインタなどの特定のメタファイルイメージについての情報を保持します。


TMetafileImage メソッド3317002

TMetafileImage	アルファベット順

TMetafileImage

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TMetafileImage メソッド3317003

TMetafileImage	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TMetafileImage.Destroy
TMetafileImage.Destroy3317004

TMetafileImage	参照

Destroy メソッドは，メタファイルイメージのインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで Destroy を直接呼び出さないでください。かわりに Free を呼び出します。Free はメタファイルイメージオブジェクトが破棄済みでないことを確認してから Destroy を呼び出します。

Destroy はメタファイルハンドルとパレットを解放してから継承された Destroy を呼び出します。


継承3317005

TObject

TSharedImage


TMetafileImage の例3317006

TMetafileImage


TNavDataLink
TNavDataLink3318001

継承	プロパティ	メソッド	参照

TNavDataLink は TDBNavigator オブジェクトのデータセットへのリンクを管理するヘルパーオブジェクトです。

ユニット

dbctrls

説明

TNavDataLink オブジェクトは TDBNavigator と組み合わせて機能するように設計されています。TDBNavigator クラスのみが使用できるヘルパーオブジェクトです。


TNavDataLink プロパティ3318002

TNavDataLink	アルファベット順	凡例

TDataLink からの継承

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


TNavDataLink プロパティ3318003

TNavDataLink	オブジェクト順	凡例

Active

ActiveRecord

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


TNavDataLink メソッド3318004

TNavDataLink	アルファベット順	凡例

TNavDataLink

ActiveChanged

Create

DataSetChanged

Destroy

EditingChanged

TDataLink からの継承

Edit

UpdateRecord

TPersistent からの継承

Assign

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetPathName

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TNavDataLink メソッド3318005

TNavDataLink	オブジェクト順	凡例

ActiveChanged

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DataSetChanged

DefaultHandler

Destroy

Dispatch

Edit

EditingChanged

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetPathName

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

UpdateRecord


TNavDataLink.ActiveChanged
TNavDataLink.ActiveChanged3318006

TNavDataLink	参照

ActiveChanged メソッドは，TDBNavigator に Active プロパティの変更を通知します。

procedure ActiveChanged; override;

説明

アプリケーションで直接 ActiveChanged 手続きを呼び出さないでください。Active プロパティが変更されるとこの手続きが呼び出され，必要に応じてボタンを使用可能にしたり不可能にしたりします。


TNavDataLink.Create
TNavDataLink.Create3318007

TNavDataLink	参照

Create メソッドは，TNavDataLink のインスタンスを作成します。

constructor Create(ANav: TDBNavigator);

説明

アプリケーションで TNavDataLink の Create メソッドを直接呼び出さないでください。TNavDataLink のオーナーである TDBNavigator が，そのコンストラクタから Create メソッドを呼び出します。


TNavDataLink.DataSetChanged
TNavDataLink.DataSetChanged3318008

TNavDataLink	参照

DataSetChanged メソッドは，データセットへの変更を TDBNavigator に通知します。

procedure DataSetChanged; override;

説明

アプリケーションが DataSetChanged 手続きを呼び出す必要はありません。DataSetChanged は，データセットの内容が変更されたときに自動的に呼び出されます。TNavDataLink は，TDBNavigator にこれらの変更を通知します。これにより，TDBNavigator は，必要に応じてボタンを使用可能にしたり不可能にしたりできます。


TNavDataLink.Destroy
TNavDataLink.Destroy3318009

TNavDataLink	参照

Destroy メソッドは，TNavDataLink のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで TNavDataLink の Destroy メソッドを直接呼び出さないでください。TNavDataLink のオーナーである TDBNavigator が，そのデストラクタから Free を呼び出して TNavDataLink を破棄します。


TNavDataLink.EditingChanged
TNavDataLink.EditingChanged3318010

TNavDataLink	参照

EditingChanged メソッドは，TDBNavigator に DataSource の編集状態の変更を通知します。

procedure EditingChanged; override;

説明

アプリケーションで直接 EditingChanged 手続きを呼び出さないでください。DataSource の編集状態を変更すると，この手続きが呼び出され，TDBNavigator は必要に応じてボタンを使用可能にしたり不可能にしたりできます。


読み出し／書き込み3318011

読み出し専用


スコープ3318012

protected


継承3318013

TObject

TPersistent

TDataLink


TNavDataLink 例3318014

TNavDataLink


TNumericField
TNumericField3320001

継承	プロパティ	メソッド	イベント	参照

TNumericField コンポーネントは，データセットのすべての数値型項目に共通の上位コンポーネントです。

ユニット

db

説明

TNumericField は，すべての数値型項目コンポーネントに共通の基本動作をカプセル化する抽象基本クラスです。TField コンポーネントで導入されているすべての項目コンポーネントに共通のプロパティ，イベント，およびメソッドに加えて，TNumericField コンポーネントは，数値データの形式を表示または編集用に設定するための新しいプロパティを導入します。


TNumericField プロパティ3320002

TNumericField	アルファベット順	凡例

TNumericField

DisplayFormat

EditFormat

TField からの継承

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Value

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TNumericField プロパティ3320003

TNumericField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayFormat

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditFormat

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TNumericField.DisplayFormat
TNumericField.DisplayFormat3320004

TNumericField	参照

DisplayFormat プロパティは，データベース対応コントロールでの数値型項目の表示用の形式がどのように設定されるかを示します。

property DisplayFormat: string;

説明

DisplayFormat プロパティを使うと，項目の表示用の自動形式設定がオーバーライドされます。

DisplayFormat は，数値データの形式設定を次の表の指定子を使ってコード化する文字列です。

指定子	意味

  0	桁プレースホルダ。形式を設定する値の形式文字列で「0」の位置に桁がある場合，その桁は出力文字列にコピーされる。そうでない場合は，出力文字列のその位置に「0」が格納される

  #	桁プレースホルダ。形式を設定する値の形式文字列で「#」の位置に桁がある場合，その桁は出力文字列にコピーされる。そうでない場合は，出力文字列のその位置には何も格納されない

  .	小数点。形式文字列の最初の「.」文字が，形式を設定する値における整数部と小数部の区切り文字の位置を決める。先頭以外の「.」文字は無視される。出力文字列で整数部と小数部の区切り文字として実際に使われる文字は，グローバル変数 DecimalSeparator で決められる。DecimalSeparator のデフォルト値は，Windows コントロールパネルにある地域の数値パネルで指定する

  ,	3 桁区切り文字。形式文字列に 1 つまたは複数の「,」文字が含まれている場合，出力文字列の小数点から左で 3 桁ごとに 3 桁区切り文字が挿入される。形式文字列の「,」の配置および数は，その出力に影響しない。ただし，3 桁区切り文字の要求を示す場合はある。出力で 3 桁区切り文字として実際に使われる文字列は，グローバル変数 ThousandSeparator で決められる。ThousandSeparator のデフォルト値は，Windows コントロールパネルにある地域の数値パネルで指定する

  E+	指数表現。文字列「E+」，「E-」，「e+」，または「e-」が形式文字列に含まれている場合，該当する数字の形式は指数表現を使って設定される。指数の最少桁数を決めるために，最大で 4 つの「0」文字が「E+」，「E-」，「e+」，または「e-」のすぐ後ろに続けられる。「E+」および「e+」形式は正指数には正符号を，負指数には負符号を出力する。「E-」および「e-」形式は負指数にだけ符号文字を出力する

  'xx'/"xx"	単引用符または二重引用符で囲まれる文字はそのまま出力され，形式設定には影響しない

  ;	形式文字列で正の値，負の値，および 0 のセクションを分離する

形式文字列で小数点より前の最も左にある「0」の位置，および小数点より後ろで最も右にある「0」の位置で，出力文字列に必ず存在する桁数が決まります。

形式を設定する文字列は，小数点の右にある桁プレースホルダ（「0」または「#」）の数と同じ小数の位に丸められます。形式文字列に小数点がない場合，形式を設定する値は最も近い自然数に丸められます。

形式を設定する値の整数部と小数部の区切り文字より左にある桁数が，形式文字列の「.」文字より左にある桁プレースホルダの数より多い場合，その余分な桁は先頭の桁プレースホルダより前に出力されます。

正の値，負の値，および 0 値ごとに異なる形式を指定するために，形式文字列を 1～3 のセクションにセミコロンを使って区切ることができます。

・	1 セクション：形式文字列はすべての値に適用される

・	2 セクション：最初のセクションは正の値および 0 値に適用され，2 番目のセクションは負の値に適用される

・	3 セクション：最初のセクションは正の値に，2 番目のセクションは負の値に，そして 3 番目のセクションは 0 値にそれぞれ適用される

負の値のセクションまたは 0 値のセクションが空の場合，つまりセクションを区切るセミコロンの間に何もない場合，正の値のセクションがかわりに適用されます。

正の値のセクションが空の場合，または形式文字列がまったくない場合，値の形式は有効桁数が 15 の汎用浮動小数点形式を使って設定されます。この汎用浮動小数点形式は，小数点より左に 18 を超える桁数があり，形式文字列が指数表現を指定しない場合にも使われます。

注意

DisplayFormat プロパティは項目のデータの表示にのみ影響します。AsString プロパティを使って数値型項目に代入される文字列の妥当性には影響しません。


TNumericField.EditFormat
TNumericField.EditFormat3320005

TNumericField	参照

EditFormat プロパティは，データベース対応コントロールでの編集用に数値型項目の値の形式がどのように設定されるかを示します。

property EditFormat: string;

説明

EditFormat プロパティは，データベース対応コントロールでの編集用に項目の値の形式設定がオーバーライドされます。

EditFormat に値が代入されていないが，DisplayFormat プロパティに値が設定されている場合，DisplayFormat の文字列が使われます。

EditFormat は，数値データの形式設定を次の表の指定子を使ってコード化する文字列です。

指定子	意味

  0	桁プレースホルダ。形式を設定する値の形式文字列で「0」の位置に桁がある場合，その桁は出力文字列にコピーされる。そうでない場合は，出力文字列のその位置に「0」が格納される

  #	桁プレースホルダ。形式を設定する値の形式文字列で「#」の位置に桁がある場合，その桁は出力文字列にコピーされる。そうでない場合は，出力文字列のその位置には何も格納されない

  .	小数点。形式文字列の最初の「.」文字が，形式を設定する値における整数部と小数部の区切り文字の位置を決める。先頭以外の「.」文字は無視される。出力文字列で整数部と小数部の区切り文字として実際に使われる文字は，グローバル変数 DecimalSeparator で決められる。DecimalSeparator のデフォルト値は，Windows コントロールパネルにある地域の数値パネルで指定する

  ,	3 桁区切り文字。形式文字列に 1 つまたは複数の「,」文字が含まれている場合，出力文字列の小数点から左で 3 桁ごとに 3 桁区切り文字が挿入される。形式文字列の「,」の配置および数は，その出力に影響しない。ただし，3 桁区切り文字の要求を示す場合はある。出力で 3 桁区切り文字として実際に使われる文字列は，グローバル変数 ThousandSeparator で決められる。ThousandSeparator のデフォルト値は，Windows コントロールパネルにある地域の数値パネルで指定する

  E+	指数表現。文字列「E+」，「E-」，「e+」，または「e-」が形式文字列に含まれている場合，該当する数字の形式は指数表現を使って設定される。指数の最少桁数を決めるために，最大で 4 つの「0」文字が「E+」，「E-」，「e+」，または「e-」のすぐ後ろに続けられる。「E+」および「e+」形式は正指数には正符号を，負指数には負符号を出力する。「E-」および「e-」形式は負指数にだけ符号文字を出力する

  'xx'/"xx"	単引用符または二重引用符で囲まれる文字はそのまま出力され，形式設定には影響しない

  ;	形式文字列で正の値，負の値，および 0 のセクションを分離する

形式文字列で小数点より前の最も左にある「0」の位置，および小数点より後ろで最も右にある「0」の位置で，出力文字列に必ず存在する桁数が決まります。

形式を設定する文字列は，小数点の右にある桁プレースホルダ（「0」または「#」）の数と同じ小数の位に丸められます。形式文字列に小数点がない場合，形式を設定する値は最も近い自然数に丸められます。

形式を設定する値の整数部と小数部の区切り文字より左にある桁数が，形式文字列の「.」文字より左にある桁プレースホルダの数より多い場合，その余分な桁は先頭の桁プレースホルダより前に出力されます。

正の値，負の値，および 0 値ごとに異なる形式を指定するために，形式文字列を 1～3 のセクションにセミコロンを使って区切ることができます。

・	1 セクション：形式文字列はすべての値に適用される

・	2 セクション：最初のセクションは正の値および 0 値に適用され，2 番目のセクションは負の値に適用される

・	3 セクション：最初のセクションは正の値に，2 番目のセクションは負の値に，3 番目のセクションは 0 値にそれぞれ適用される

負の値のセクションまたは 0 値のセクションが空の場合，つまりセクションを区切るセミコロンの間に何もない場合，正の値のセクションがかわりに適用されます。

正の値のセクションが空の場合，または形式文字列がまったくない場合，値の形式は有効桁数が 15 の汎用浮動小数点形式を使って設定されます。この汎用浮動小数点形式は，小数点より左に 18 を超える桁数があり，形式文字列が指数表現を指定しない場合にも使われます。

注意

EditFormat プロパティは，編集時の項目の値の表示にのみ影響します。AsString プロパティを使って数値型項目に代入される文字列の妥当性や，編集時以外の項目のデータの表示には影響しません。


TNumericField イベント3320006

TNumericField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TNumericField イベント3320007

TNumericField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TNumericField メソッド3320008

TNumericField	アルファベット順

TNumericField

Create

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TNumericField メソッド3320009

TNumericField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TNumericField.Create
TNumericField.Create3320010

TNumericField	参照

Create メソッドは， TNumericField オブジェクトのインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

TNumericField には直接 Create メソッドを呼び出さないでください。TNumericField オブジェクトは抽象クラスであり，そのコンストラクタは派生クラスのコンストラクタから継承メソッドとしてのみ呼び出されます。

Create メソッドは継承された Create メソッドを呼び出した後，taRightJustify の Alignment プロパティを変更します。


スコープ3320011

published

読み出し／書き込み

読み出し専用


スコープ3320012

published


継承3320013

TObject

TPersistent

TComponent

TField


TNumericField 例3320014

TNumericField


TObject
TObject3321001

メソッド	参照

TObject は Delphi のすべてのオブジェクトおよびコンポーネントの最上位のオブジェクトです。

ユニット

system

説明

TObject オブジェクトは，以下の機能を提供するメソッドのインターフェースを導入して Delphi のすべてのオブジェクトに共通の汎用動作をカプセル化します。

・	オブジェクトに必要なメモリを割り当て，初期化，および解放することによって，オブジェクトのインスタンスを作成，管理，および破棄する

・	オブジェクトのクラス型およびインスタンス情報，そしてパブリッシュプロパティについての実行時型情報（RTTI）を提供および取得する

・	メッセージ処理をサポートする

コンポーネントではなく，ストリーム入出力機能またはメモリ割り当て機能を必要としない単純なオブジェクトを宣言する場合に，TObject オブジェクトを基本クラスとして使います。新しいオブジェクト型を宣言するときに上位の型を指定しない場合，Delphi では自動的に TObject を上位の型として使います。

Delphi オブジェクトの強力な機能の多くは，TObject オブジェクトが導入するメソッドによって実現されています。これらのメソッドの多くは，Delphi 環境で内部的に呼び出されるもので，ユーザーが直接呼び出すものではありません。ほかのいくつかのオブジェクトは，より複雑な動作を持つ下位のオブジェクトおよびコンポーネントでオーバーライドされます。

注意

TObject オブジェクトは技術的には抽象クラスではありませんが，この型のオブジェクトは通常インスタンス化されません。


TObject メソッド3321002

TObject	アルファベット順

TObject

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TObject メソッド3321003

TObject	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TObject.ClassInfo
TObject.ClassInfo3321004

TObject	参照

ClassInfo メソッドは，オブジェクト型の実行時型情報（RTTI）テーブルを指すポインタを返します。

class function ClassInfo: Pointer;

説明

ClassInfo メソッドを呼び出すと，オブジェクト型，その上位オブジェクト型，およびすべてのパブリッシュプロパティについての情報が入っている RTTI テーブルにアクセスできます。

RTTI は主に Delphi 環境の内部で使うためのものです。まれに，ClassInfo メソッドはアプリケーションから直接呼び出されることがあります。TObject オブジェクトは RTTI 情報に簡単にアクセスするための特別なメソッドを提供します。


TObject.ClassName
TObject.ClassName3321005

TObject	参照

ClassName メソッドは，変数の型ではなく変数によって参照されるオブジェクトインスタンスの実際の型の名前を含む文字列を返します。

class function ClassName: ShortString;

説明

ClassName メソッドを呼び出すと，たとえば文字列をパラメータとしてほかのルーチンに渡す場合に，オブジェクトの実際の型を文字列の形式で取得できます。たとえば，上位型の変数はどの下位型のインスタンスでも参照できます。この場合，ClassName メソッドは，宣言された変数の型を含む文字列ではなく，オブジェクトの実際の型を示す文字列を返します。

ClassName メソッドはモジュールに関係なくオブジェクトの情報を提供するので，例外処理には特に便利です。

特定のオブジェクトの例外処理エラーを報告する場合，ClassName メソッドはクラスの文字列比較をする文で使われます。


TObject.ClassNameIs
TObject.ClassNameIs3321006

TObject	参照

ClassNameIs メソッドはオブジェクトが特別な型かどうかを示します。

class function ClassNameIs(const Name: string): Boolean;

説明

ClassNameIs メソッドは，オブジェクトの型に基づく条件コードを書き込む場合，またはモジュールや DLL に関係なくオブジェクトを問い合わせる場合に使います。

ClassNameIs メソッドは，Name パラメータに渡した文字列がクラス名と一致する場合に True を返します。一致しない場合は False を返します。


TObject.ClassParent
TObject.ClassParent3321007

TObject	参照

ClassParent メソッドは 1 つ上位のクラスの型を返します。

class function ClassParent: TClass;

説明

ClassParent メソッドは TObject に対しては nil を返します。TObject には親がないためです。

ClassParent メソッドは，is および as 演算子または InheritsFrom メソッドによって， RTTI を取得するために Delphi 内部で使われます。これはクラスメソッドなので，クラス参照の型を知るために使うこともできます。

注意

アプリケーションから直接 ClassParent メソッドを呼び出すことはほとんどありません。


TObject.ClassType
TObject.ClassType3321008

TObject	参照

ClassType メソッドは，オブジェクトインスタンスの実行時型情報へのポインタを返します。

function ClassType: TClass;

説明

ClassType メソッドを呼び出すと，オブジェクトの実際の型を動的に確認できます。ClassType メソッドは，is および as 演算子によって Delphi 内部で使われます。直接 ClassType メソッドを呼び出さないでください。


TObject.CleanupInstance
TObject.CleanupInstance3321009

TObject	参照

CleanupInstance メソッドは，クラス内の長い文字列とバリアントとインターフェース変数に対する終了処理を実行します。

procedure CleanupInstance;

説明

直接 CleanupInstance メソッドを呼び出さないでください。CleanupInstance メソッドは Free メソッドが呼び出されると自動的に呼び出されます。

CleanupInstance メソッドはすべての長い文字列およびバリアントを解放します。このメソッドは長い文字列を空に設定し，バリアントを Unassigned に設定します。


TObject.Create
TObject.Create3321010

TObject	参照

Create メソッドは，オブジェクトを作成し，そのオブジェクトが最初に使われる前にデータを初期化します。

constructor Create;

説明

Create メソッドは，適切に初期化されたオブジェクトインスタンスを作成します。Delphi のオブジェクトの目的，サイズ，および動作はそれぞれ大きく異なります。TObject で定義されている Create メソッドは特別なことは何もしません。つまり，どのようなデータも初期化しないのです。しかし，メモリ割り当ては Create メソッドが呼び出されたときに自動的に処理されます。

注意

下位オブジェクトは通常，必要な場合にデータを初期化する特定のオブジェクトを作成するためにカスタマイズされたコンストラクタを定義します。

コンストラクタから例外が発生すると，オブジェクトのデストラクタが呼び出されて失敗したインスタンスを破棄します。


TObject.DefaultHandler
TObject.DefaultHandler3321011

TObject	参照

DefaultHandler メソッドは，渡されるメッセージレコードを処理するためのインターフェースを導入します。

procedure DefaultHandler(var Message); virtual;

説明

DefaultHandler メソッドは，Dispatch メソッドが特定のメッセージを処理するメソッドを呼び出せない場合に呼び出されます。DefaultHandler メソッドは，固有のハンドラを持たないオブジェクトのすべてのメッセージを処理するメッセージハンドラを提供します。メッセージを処理する TObject の下位クラスは通常，処理するメッセージの型に応じて DefaultHandler メソッドを定義します。たとえば，TWinControl は DefaultHandler メソッドをオーバーライドして DefWindowProc メソッドを呼び出します。

メッセージ処理メソッドで inherited を呼び出した場合，処理対象メッセージのハンドラが上位オブジェクトで指定されていないと，上位オブジェクトの DefaultHandler メソッドが呼び出されます。それ以外の場合は，そのメッセージを処理する特定のハンドラが呼び出されます。


TObject.Destroy
TObject.Destroy3321012

TObject	参照

Destroy メソッドは，オブジェクトインスタンスを破棄するデストラクタです。

destructor Destroy; virtual;

説明

Destroy メソッドを直接呼び出すようなコーディングスタイルはお勧めできません。Free メソッドを呼び出すようにしてください。Free メソッドは Destroy メソッドを呼び出す前にオブジェクトインスタンスが nil でないことを確認します。

TObject で定義されている Destroy メソッドは特別なことは何もしませんが，メモリ割り当ての解除は Destroy メソッドが呼び出されたときに自動的に処理されます。下位オブジェクトでは通常，特定の種類のオブジェクトを破棄するようにカスタマイズされたデストラクタを定義します。

下位オブジェクト型で Destroy メソッドを宣言するときには必ず override 指令を追加し，継承された Destroy をオーバーライドするメソッドの最後の文として呼び出します。Destroy は仮想メソッドなので，継承された動作が正しく実行されるようにするにはそれをオーバーライドします。

注意

コンストラクタから例外が発生するとデストラクタが呼び出され，初期化が完了せずに部分的に作成されたオブジェクトインスタンスが破棄されます。

Destroy メソッドは，オブジェクトのコンストラクタ内で作成された（つまり，コンストラクタによって割り当てられた）すべてのサブオブジェクトに対して Free メソッドを呼び出すように実現する必要があります。Destroy メソッドと違って，Free メソッドは nil であるオブジェクトを破棄する場合に安全策を講じます。また，値が 0 であることもあるので，デストラクタは，ハンドルなど，その他の割り当てられているリソースを解放するときは，事前にそれらのリソースが実際に割り当てられていることを確認する必要があります。


TObject.Dispatch
TObject.Dispatch3321013

TObject	参照

Dispatch メソッドは，Message パラメータの内容に基づいてオブジェクトのメッセージ処理メソッドを呼び出します。

procedure Dispatch(var Message);

説明

Dispatch メソッドを呼び出すと，メッセージが自動的にオブジェクトの現在のイベントハンドラに渡されます。

Dispatch メソッドを使うと，メッセージがオブジェクトで宣言されているメッセージハンドラのリストにあるかどうかがわかります。メッセージがそのオブジェクトで処理されない場合，Dispatch はハンドラが見つかるまで，または上位オブジェクト型がなくなるまで，その上位のオブジェクト型のメッセージハンドラリストを調べます。上位オブジェクト型がなくなってもメッセージハンドラが見つからない場合は DefaultHandler を呼び出します。

Message パラメータは型なしなので，Dispatch にはどのような型のデータでも渡せますが，通常は TMessage などのメッセージレコードや特定のメッセージレコード型のどれかを渡します。Message のデータについて Dispatch が唯一必要とするのは，最初の 2 バイトにメッセージ ID が入っていることです。メッセージ ID は，Dispatch がメッセージを処理するために呼び出すメッセージハンドラを示す整数型の数値です。


TObject.FieldAddress
TObject.FieldAddress3321014

TObject

FieldAddress メソッドは，パブリッシュオブジェクト項目のアドレスを返します。

function FieldAddress(const Name: ShortString): Pointer;

説明

FieldAddress メソッドは，Delphi ストリーム入出力システムがオブジェクトの指定のパブリッシュフィールドにアクセスするために内部的に使われます。FieldAddress は指定のフォールドがあればそのフィールドへのポインタを返します。オブジェクトに指定の名前のパブリッシュフィールドがない場合，FieldAddress メソッドは nil を返します。

ユーザーがフィールドにアクセスする場合，またはフィールドを操作する場合は，FieldAddress メソッドではなくプロパティを使わなければなりません。


TObject.Free
TObject.Free3321015

TObject	参照

Free メソッドは，オブジェクトを破棄し，必要ならば関連付けられているメモリを解放します。

procedure Free;

説明

Free メソッドを呼び出すと，オブジェクトを破棄できます。Free メソッドは，オブジェクトインスタンスが nil ではない場合には自動的に Destroy メソッドを呼び出します。Create メソッドの呼び出しによってインスタンス化されたすべてのオブジェクトは，Free メソッドを呼び出して破棄しなければなりません。結果として，オブジェクトが適切に破棄され，メモリが解放されます。オブジェクトが nil の場合でも Free メソッドはエラーにはなりません。このため，たとえばオブジェクトが初期化されていない場合に Free メソッドを呼び出してもエラーにはなりません。


TObject.FreeInstance
TObject.FreeInstance3321016

TObject	参照

FreeInstance メソッドは，NewInstance メソッドによるメモリの割り当てを解除します。

procedure FreeInstance; virtual;

説明

すべてのデストラクタは自動的に FreeInstance メソッドを呼び出し，オーバーライドされた NewInstance によって割り当てられていたメモリを解放します。

直接 FreeInstance メソッドを呼び出さないでください。ただし，NewInstance をオーバーライドしてオブジェクトのインスタンスデータの割り当て方法を変更している場合は，FreeInstance メソッドをオーバーライドしなければなりません。

NewInstance メソッドと同様に，FreeInstance メソッドは InstanceSize メソッドから返される値を使ってオブジェクトのメモリ割り当てを解除します。


TObject.GetInterface
TObject.GetInterface3321017

TObject

GetInterface メソッドは，指定した識別子によって識別されるインターフェースを取り出します。

function GetInterface(const IID: TGUID; out Obj): Boolean;

説明

GetInterface メソッドは，オブジェクトによって実現されるインターフェースを取り出すために as 演算子によって内部的に使われます。GetInterface メソッドは TInterfacedObject によって QueryInterface メソッドを実現するのに使われます。コンパイラはインターフェースを関連付けられている GUID に置き換えるので，IUnknown などのインターフェース型名は IID パラメータとして指定できます。

GetInterface メソッドを使うと，インターフェースをサポートしていない可能性があり，失敗したときに例外が生成されない場合に，VCL オブジェクトインスタンスからそのインターフェースを取り出すことができます。as 演算子は失敗すると例外を生成しますが，GetInterface は生成しません。

GetInterface は，out パラメータ Obj として，IID パラメータによって識別されるインターフェースのポインタを返します。インターフェースがオブジェクトによってサポートされている場合，GetInterface は True を返します。サポートされていない場合は， False を返し， Obj パラメータが nil になります。


TObject.GetInterfaceEntry
TObject.GetInterfaceEntry3321018

TObject

GetInterfaceEntry メソッドは，クラスで実現される特定のインターフェースのエントリを返します。

PInterfaceEntry = ^TInterfaceEntry;

  TInterfaceEntry = record

    IID: TGUID;

    VTable: Pointer;

    IOffset: Integer;

  end;

class function GetInterfaceEntry(const IID: TGUID): PInterfaceEntry;

説明

GetInterfaceEntry メソッドは，クラス内の，IID パラメータで指定されるインターフェースインターフェースのエントリを返します。GetInterfaceEntry は内部的に使われます。直接呼び出されることはめったにありません。

注意

このメソッドは，たとえば，デュアル IDispatch インターフェースの呼び出しを自動的にディスパッチする方法を OLE に示すときに使えます。コンパイラはインターフェースを関連付けられている GUID に置き換えるので，IUnknown などのインターフェース型名は IID パラメータとして指定できます。


TObject.GetInterfaceTable
TObject.GetInterfaceTable3321019

TObject	参照

GetInterfaceTable メソッドは，指定したクラスで実現されているすべてのインターフェースが入った構造体のポインタを返します。

PInterfaceTable = ^TInterfaceTable;

  TInterfaceTable = record

    EntryCount: Integer;

    Entries: array[0..9999] of TInterfaceEntry;

  end;

class function GetInterfaceTable: PInterfaceTable;

説明

GetInterfaceTable メソッドは，クラスの TInterfaceEntry のリストを返します。このリストには，このクラスで実現されているインターフェースだけが入っています。上位クラスのインターフェースは入っていません。上位のリストを検索するには，GetParentClass メソッドを呼び出してから，GetInterfaceTable メソッドを呼び出します。特定のインターフェースのエントリを検索するには，かわりに GetInterfaceEntry メソッドを使います。


TObject.InheritsFrom
TObject.InheritsFrom3321020

TObject	参照

InheritsFrom メソッドは，クラスメソッドであり，2 つのオブジェクト型の関係を調べるときに使えます。

class function InheritsFrom(AClass: TClass): Boolean;

説明

InheritsFrom メソッドを使うと，特定のクラス型がオブジェクト型の上位型であるかどうかがわかります。InheritsFrom メソッドは，AClass パラメータに指定されたオブジェクト型がオブジェクト型の上位の型であるかオブジェクト型そのものである場合に True を返します。そうでない場合は False を返します。

注意

is や as の演算子はその実装の際に InheritsFrom メソッドを使います。しかし，is 演算子はインスタンスの継承関係を調べることしかできません。クラスメソッドとして，InheritsFrom メソッドはクラス参照の関係を調べることができます。


TObject.InitInstance
TObject.InitInstance3321021

TObject	参照

InitInstance メソッドは，新しく割り当てられたオブジェクトインスタンスをすべて 0 に初期化し，インスタンスの仮想メソッドテーブルポインタを初期化します。

class procedure InitInstance(Instance: Pointer): TObject;

説明

直接 InitInstance メソッドを呼び出す必要はありません。InitInstance メソッドは，オブジェクトが作成されると NewInstance メソッドによって自動的に呼び出されます。NewInstance メソッドをオーバーライドする場合は，必ず最後の文で InitInstance メソッドを呼び出してください。

InitInstance メソッドは仮想メソッドではないのでオーバーライドできません。オブジェクトのデータはコンストラクタで初期化します。共通のメモリプールから 1 つのクラス型のすべてのインスタンスを割り当てる場合など，特別なメモリ割り当て要求がある場合のみ NewInstance メソッドをオーバーライドします。


TObject.InstanceSize
TObject.InstanceSize3321022

TObject	参照

InstanceSize メソッドは，オブジェクト型の各インスタンスのサイズをバイト数で返します。

class function InstanceSize: Longint;

説明

InstanceSize メソッドを呼び出すと，クラスのインスタンスデータに必要なメモリのバイト数がわかります。Delphi は，メモリの割り当てと解除を行うメソッドのために InstanceSize メソッドを内部的に使います。InstanceSize メソッドは仮想メソッドではないなので，オーバーライドできません。InstanceSize メソッドは，NewInstance のカスタムバージョンを実現する場合にのみ呼び出す必要があります。


TObject.MethodAddress
TObject.MethodAddress3321023

TObject	参照

MethodAddress メソッドは，パブリッシュメソッドのアドレスを返します。

class function MethodAddress(const Name: ShortString): Pointer;

説明

MethodAddress メソッドは，Delphi の内部でストリーム入出力システムによって使われます。MethodAddress メソッドは，ストリームからの読み出し時に，Name で指定されたメソッド名をメソッドのアドレスが含まれているポインタに変換します。直接 MethodAddress メソッドを呼び出さないでください。

Name で指定された名前のパブリッシュメソッドがオブジェクトになければ，MethodAddress メソッドは nil を返します。


TObject.MethodName
TObject.MethodName3321024

TObject	参照

MethodName メソッドは，Address にあるメソッドの名前の文字列を返します。

class function MethodName(Address: Pointer): ShortString;

説明

MethodName メソッドは，Delphi の内部でストリーム入出力システムによって使われます。MethodName メソッドは，イベントプロパティをストリームに書き込むときに，メソッドのアドレスを含むポインタをメソッド名が含まれている文字列に変換します。これは MethodAddress メソッドと逆の動作を行うメソッドです。直接 MethodName メソッドを呼び出す必要はありません。

Address がオブジェクトのパブリッシュメソッドを指定していない場合，MethodName は空文字列を返します。


TObject.NewInstance
TObject.NewInstance3321025

TObject	参照

NewInstance メソッドは，オブジェクト型の各インスタンスにメモリを割り当て，その新しいインスタンスを指すポインタを返します。

class function NewInstance: TObject; virtual;

説明

すべてのコンストラクタは NewInstance メソッドを自動的に呼び出します。NewInstance メソッドは InstanceSize メソッドを呼び出して，特定のインスタンスを保持するためにヒープから割り当てるメモリの量を判断します。直接 NewInstance メソッドを呼び出さないでください。

下位クラスは NewInstance メソッドをオーバーライドして，特定のクラスがメモリを割り当てる方法を変更できます。オブジェクト型のメモリ割り当て方法を変更するために NewInstance をオーバーライドしたときは，そのメモリの割り当てを解除する FreeInstance もオーバーライドしなくてはならない場合があります。たとえば，同時にメモリになくてはならない多数の同一オブジェクトをメモリに割り当てる場合，そのオブジェクト群全体に対して大きなメモリブロックを割り当て，NewInstance をオーバーライドして各インスタンスについてその大きなブロックの一部を使うようにできます。NewInstance メソッドをオーバーライドする場合は，最後の文で InitInstance メソッドを呼び出してください。

注意

デフォルトでは，NewInstance メソッドは InitInstance メソッドを呼び出します。


TObject.SafeCallException
TObject.SafeCallException3321026

TObject

SafeCallException メソッドは，OLE 例外のサポートに使うエラー処理メソッドです。

function SafeCallException(ExceptObject: TObject; ExceptAddr: Pointer): Integer; virtual;

説明

SafeCallException メソッドは OLE 例外処理のサポートに使います。TObject の場合，SafeCallException は E_UNEXPECTED を返します。これはインターフェースをまったくサポートしていないクラスに適しているデフォルトのケースです。COM および OLE インターフェースを実現しているクラスは，発生する可能性のある他のエラーを処理するためにこのメソッドをオーバーライドする必要があります。Delphi の COM および OLE クラスは SafeCallException をオーバーライドします。


継承3321027


TObject 例3321028

TObject


TOleContainer
TOleContainer3322001

継承	プロパティ	メソッド	イベント	参照

TOleContainer コンポーネントは，OLE オブジェクトを埋め込んだりリンクしたりします。

ユニット

olectnrs

説明

TOleContainer コンポーネントは，OLE 2.0 での複雑な処理の多くを扱います。TOleContainer では，InsertObjectDialog メソッドを呼び出すだけで，挿入する OLE オブジェクトをユーザーに選択させることができます。TOleContainer は埋め込み OLE オブジェクト，またはリンク OLE オブジェクトのいずれかを作成できます。

TOleContainer は，自動的にメニューのマージ，つまりコンテナフォームのメニューとインプレースアクティベーション状態の OLE オブジェクトのサーバーアプリケーションのメニューとを結び付けるプロセスを処理します。メニュー項目の GroupIndex プロパティの設定がメニューのマージを制御します。GroupIndex 値が 0，2，4 のメインメニュー項目はそのまま残り，TOleContainer がサーバーアプリケーションのメニューをマージして（存在する場合）GroupIndex 値が 1，3，5 のメインメニュー項目を置き換えます。

インプレースアクティベーション状態の OLE オブジェクトは，そのサーバーのツールバーを直接コンテナアプリケーションのウィンドウに追加します。通常，ツールバーとして使っているパネルは OLE オブジェクトのサーバーのツールバーに置き換えられます。これは，パネルの Locked プロパティを True に設定すれば防止できます。

SDI アプリケーションで TOleContainer を使っている場合（メインフォームの FormStyle プロパティが fsMDIForm ではなく fsNormal の場合）は，その TOleContainer コンポーネントを，Align プロパティが alClient に設定されているパネルの内部に配置します。TOleContainer は SDI フォームのツールバーを上記のように置き換え，パネルを使って自動的に OLE コンテナに使用可能な領域を調整します。


TOleContainer プロパティ3322002

TOleContainer	アルファベット順	凡例

TOleContainer

AllowActiveDoc

AllowInPlace

AutoActivate

AutoVerbMenu

BorderStyle

CanPaste

CopyOnSave

Iconic

Linked

Modified

NewInserted

ObjectVerbs

OldStreamFormat

OleClassName

OleObject

OleObjectInterface

PrimaryVerb

SizeMode

SourceDoc

State

StorageInterface

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Height

Hint

Left

Name

Parent

ParentColor

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TOleContainer プロパティ3322003

TOleContainer	オブジェクト順	凡例

Align

AllowActiveDoc

AllowInPlace

AutoActivate

AutoVerbMenu

BorderStyle

BoundsRect

Brush

CanPaste

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

CopyOnSave

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Handle

Height

HelpContext

Hint

Iconic

Left

Linked

Modified

Name

NewInserted

ObjectVerbs

OldStreamFormat

OleClassName

OleObject

OleObjectInterface

Owner

Parent

ParentColor

ParentCtl3D

ParentShowHint

ParentWindow

PopupMenu

PrimaryVerb

ShowHint

Showing

SizeMode

SourceDoc

State

StorageInterface

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TOleContainer.AllowActiveDoc
TOleContainer.AllowActiveDoc3322004

TOleContainer	参照

AllowActiveDoc プロパティは，OLE コンテナが IOleDocumentSite インターフェースをサポートするかどうかを示します。

property AllowActiveDoc: Boolean;

説明

AllowActiveDoc プロパティを True に設定すると，OLE コンテナに ActiveDoc（DocObject）を入れられるように指定できます。AllowActiveDoc を False に設定すると，OLE コンテナにIOleClientSite などのより一般的なインターフェースを使うホスト OLE コントロールだけが入れられるように制限できます。ActiveDoc 対応コントロールの境界は少し異なります。AllowActiveDoc を False に設定すれば，IOleDocumentSite インターフェースをサポートする必要のないフォームで一様な外観を保てます。


TOleContainer.AllowInPlace
TOleContainer.AllowInPlace3322005

TOleContainer	参照

AllowInPlace プロパティは，OLE コンテナでインプレースアクティベーションを許可するかどうかを決めます。

property AllowInPlace: Boolean;

説明

AllowInPlace プロパティは，ユーザーが OLE オブジェクトをアクティブ化したときに行われる処理を示します。AllowInPlace が True で Iconic が False の場合，OLE オブジェクトのインプレースアクティベーションが行われます。AllowInPlace が False の場合は OLE オブジェクトは別々のウィンドウでアクティブ化されます。デフォルト値は True です。


TOleContainer.AutoActivate
TOleContainer.AutoActivate3322006

TOleContainer	参照

AutoActivate プロパティは，OLE コンテナ内のオブジェクトがアクティブ化される方法を示します。

TAutoActivate = (aaManual, aaGetFocus, aaDoubleClick);

property AutoActivate: TAutoActivate;

説明

AutoActivate プロパティは，OLE オブジェクトをアクティブ化する動作を示します。AutoActivate プロパティには，次の表の値のいずれかを指定します。

値	意味

aaManual	プログラムで DoVerb(ovShow) を呼び出して OLE オブジェクトを起動する必要がある

aaGetFocus	OLE オブジェクトは，OLE コンテナがフォーカスを取得したとき（マウスでクリックするか〔Tab〕キーを押してフォーカスをそこに移動した場合で）に起動する

aaDoubleClick	デフォルト。コンテナにフォーカスがあるときに，ダブルクリックするか〔Enter〕キーを押すと，OLE オブジェクトは起動する


TOleContainer.AutoVerbMenu
TOleContainer.AutoVerbMenu3322007

TOleContainer	参照

AutoVerbMenu プロパティは，OLE オブジェクトの OLE 動詞を含むポップアップメニューを OLE コンテナが自動的に作成するかどうかを示します。

property AutoVerbMenu: Boolean;

説明

AutoVerbMenu プロパティは，OLE オブジェクトが OLE コンテナのポップアップメニューを置き換えることができるかどうかを示します。AutoVerbMenu が True（デフォルト）の場合，OLE オブジェクトは既存の PopupMenu プロパティを置き換えます。AutoVerbMenu が False の場合には，ポップアップメニューは自動的に作成されません。


TOleContainer.BorderStyle
TOleContainer.BorderStyle3322008

TOleContainer	参照

BorderStyle プロパティは，OLE コンテナの周りに一重線を付けるかどうかを示します。

TBorderStyle = bsNone..bsSingle;

property BorderStyle: TBorderStyle;

説明

BorderStyle プロパティは，OLE コンテナの周りを一重線で囲むかどうかを示します。次の値を指定できます。

値	意味

bsNone	非可視境界

bsSingle	一重境界線


TOleContainer.CanPaste
TOleContainer.CanPaste3322009

TOleContainer	参照

CanPaste プロパティは，Windows のクリップボードに，OLE コンテナに貼り付け可能な OLE オブジェクトがあるかどうかを示します。

property CanPaste: Boolean;

説明

CanPaste プロパティは，クリップボードから OLE オブジェクトを貼り付けまたは貼り付けリンクを行う前に読み出します。


TOleContainer.CopyOnSave
TOleContainer.CopyOnSave3322010

TOleContainer	参照

CopyOnSave プロパティは，SaveToFile メソッドおよび SaveToStream メソッドが最初に OLE オブジェクトのコピーを作成するかどうかを示します。

property CopyOnSave: Boolean;

説明

CopyOnSave プロパティが True ならば，SaveToFile メソッドおよび SaveToStream メソッドは一時的な OLE オブジェクトを作成し，冗長なデータを圧縮して領域を節約します。この圧縮されたコピーは後でファイルまたはストリームに保存されます。CopyOnSave プロパティが False ならば，OLE オブジェクトは，冗長なデータを圧縮するための一時的なコピーを使用せずに，直接ファイルまたはストリームに保存されます。

コンテナが非常に大型の埋め込みオブジェクトを保持しており，一時コピーを行うだけの十分なメモリがない場合は，CopyOnSave を False に設定します。デフォルト値は True です。


TOleContainer.Iconic
TOleContainer.Iconic3322011

TOleContainer	参照

Iconic プロパティは，OLE オブジェクトをアイコンとして表示するかどうかを示します。

property Iconic: Boolean;

説明

Iconic プロパティは，OLE コンテナが，オブジェクトのイメージの代わりにサーバーアプリケーションのアイコンを表示するかどうかを示します。Iconic が True の場合，OLE オブジェクトはアイコンとして表示されます。False の場合には，サーバーアプリケーションのように表示されます。


TOleContainer.Linked
TOleContainer.Linked3322012

TOleContainer	参照

Linked プロパティは，OLE オブジェクトがリンクされているか，埋め込まれているかを示します。

property Linked: Boolean;

説明

Linked プロパティは，OLE オブジェクトが OLE サーバーにリンクされているかどうかを示します。Linked が True の場合，その OLE オブジェクトはリンクされています。False の場合は埋め込みオブジェクトです。OLE オブジェクトは，Linked プロパティにアクセスする前にコンテナにロードされていなければなりません。


TOleContainer.Modified
TOleContainer.Modified3322013

TOleContainer	参照

Modified プロパティは，OLE オブジェクトが変更されたかどうかを示します。

property Modified: Boolean;

説明

Modified プロパティは，OLE オブジェクトが変更されたかどうか（別の OLE オブジェクトによる削除や置換も含む）を示します。増分変化を追跡するには，Modified を False に設定して後でそれを調べ，Modified を False に設定してから OLE オブジェクトが変更されたかどうかを確認します。コンテナに OLE オブジェクトがロードされていない場合，Modified は False を返します。


TOleContainer.NewInserted
TOleContainer.NewInserted3322014

TOleContainer	参照

NewInserted プロパティは，OLE オブジェクトが，貼り付けやファイルへのリンクとして作成されたものではなく，新規作成されたものであるかどうかを示します。

property NewInserted: Boolean;

説明

NewInserted プロパティは，OLE オブジェクトが InsertObjectDialog 呼び出しにより新規作成されたものであるかどうかを示します。コンテナに OLE オブジェクトがロードされていない場合，NewInserted は False を返します。InsertObjectDialog の呼び出し後に NewInserted が True の場合は，DoVerb(ovShow) を呼び出してそのオブジェクトを表示します。


TOleContainer.ObjectVerbs
TOleContainer.ObjectVerbs3322015

TOleContainer	参照

ObjectVerbs プロパティは，OLE オブジェクトがサポートしている OLE 動詞のリストです。

property ObjectVerbs: TStrings;

説明

ObjectVerbs プロパティは，OLE オブジェクトで使える OLE 動詞を示します。OLE 動詞の名前には，ショートカットキーを示すアンド記号（&）を埋め込み文字として含むことができます。OLE オブジェクトは，ObjectVerbs プロパティにアクセスする前にコンテナにロードされていなければなりません。


TOleContainer.OldStreamFormat
TOleContainer.OldStreamFormat3322016

TOleContainer	参照

OldStreamFormat プロパティは，OLE オブジェクトが Delphi 1.0 形式でロードおよび保存するかどうかを示します。

property OldStreamFormat: Boolean;

説明

OldStreamFormat プロパティを True に設定すると，Delphi 1.0 を使ってファイルに保存した OLE オブジェクトを読み出したり，Delphi 1.0 によって使われる OLE オブジェクトを保存したりすることができます。OldStreamFormat が False（デフォルト）の場合，LoadFromFile，LoadFromStream，SaveToFile，SaveToStream メソッドは，拡張されたヘッダー情報を含む新しい形式を使います。この拡張ヘッダー情報はファイルまたはストリームを検証するために使われます。このプロパティは，下位互換性のためだけに用意されています。


TOleContainer.OleClassName
TOleContainer.OleClassName3322017

TOleContainer	参照

OleClassName プロパティは，OLE オブジェクトのクラス名を示します。

property OleClassName: string;

説明

OleClassName プロパティを読み出すと，OLE オブジェクトのクラス名（プログラム的な識別子）を示します。クラス名は，Windows レジストリに登録されている，OLE オブジェクトのクラスを示す文字列です。OLE オブジェクトは，OleClassName プロパティにアクセスする前にコンテナにロードされていなければなりません。


TOleContainer.OleObject
TOleContainer.OleObject3322018

TOleContainer	参照

OleObject プロパティは，OLE コンテナがホストしている OLE オブジェクトを示します。

property OleObject: Variant;

説明

OleObject プロパティは，バリアントとして OLE コンテナがホストしている OLE オブジェクトにアクセスするために使われます。IOleObject インターフェースを使って OLE オブジェクトと対話するには，かわりに OleObjectInterface プロパティを使います。OleObject を読み出す前に OLE オブジェクトがコンテナにロードされていない場合は，EOleError 例外が生成されます。


TOleContainer.OleObjectInterface
TOleContainer.OleObjectInterface3322019

TOleContainer	参照

OleObjectInterface プロパティは，OLE オブジェクトの IOleObject インターフェースを示します。

property OleObjectInterface: IOleObject;

説明

OleObjectInterface プロパティは，OLE API への低レベルアクセスに使います。コンテナに OLE オブジェクトがロードされていない場合，OleObjectInterface は nil を返します。


TOleContainer.PrimaryVerb
TOleContainer.PrimaryVerb3322020

TOleContainer	参照

PrimaryVerb プロパティは，OLE オブジェクトの既定値の OLE 動詞のインデックスです。

property PrimaryVerb: Integer;

説明

PrimaryVerb プロパティは，ObjectVerbs リスト内のどの OLE 動詞が OLE オブジェクトのデフォルト動作を指定するかを示します。DoVerb メソッドの呼び出しでは，DoVerb(ovPrimary) は DoVerb(PrimaryVerb) と同じです。OLE オブジェクトは，PrimaryVerb プロパティにアクセスする前にコンテナにロードされていなければなりません。


TOleContainer.SizeMode
TOleContainer.SizeMode3322021

TOleContainer	参照

SizeMode プロパティは，OLE コンテナ内での OLE オブジェクトのサイズを変更する方法を示します。

TSizeMode = (smClip, smCenter, smScale, smStretch, smAutoSize);

property SizeMode: TSizeMode;

説明

SizeMode プロパティは，OLE オブジェクトを OLE コンテナのクライアント領域に表示する方法を示します。以下の値を指定できます。

値	意味

smClip	デフォルト。通常のサイズで OLE オブジェクトを表示し，コンテナ内部に収まらない部分をクリッピングする

smCenter	通常のサイズで OLE オブジェクトを表示し，コンテナ内部で中央に位置を合わせる

smScale	OLE オブジェクトの表示をコンテナにぴったり収まるように拡大または縮小する（幅と高さの割合は一定に保たれる）

smStretch	OLE オブジェクトの表示を OLE コンテナにぴったり収まるように拡大または縮小する（OLE オブジェクトの均整は保たれない）

smAutoSize	通常のサイズで OLE オブジェクトを表示し，OLE オブジェクトのサイズに合わせてコンテナのサイズを自動的に変更する


TOleContainer.SourceDoc
TOleContainer.SourceDoc3322022

TOleContainer	参照

SourceDoc プロパティは，リンクされた OLE オブジェクトのソースファイルの名前です。

property SourceDoc: string;

説明

SourceDoc プロパティは，リンクされた OLE オブジェクトの名前を示します。OLE オブジェクトは，SourceDoc プロパティにアクセスする前にコンテナにロードされていなければなりません。OLE オブジェクトがリンクしていない場合は，SourceDoc は空の文字列を返します。


TOleContainer.State
TOleContainer.State3322023

TOleContainer	参照

State プロパティは，OLE オブジェクトの状態についての情報を示します。

TObjectState = (osEmpty, osLoaded, osRunning, osOpen, osInPlaceActive, osUIActive);

property State: TObjectState;

説明

State プロパティは，OLE オブジェクトとそのサーバーアプリケーションの状態を示します。State プロパティでは以下の値のいずれかを指定できます。

値	意味

osEmpty	コンテナに OLE オブジェクトがない

osLoaded	コンテナに OLE オブジェクトがあるが，そのサーバーアプリケーションが現在実行中でない

osRunning	OLE オブジェクトのサーバーが実行中である

osOpen	OLE オブジェクトが別のウィンドウで開いている

osInPlaceActive	OLE オブジェクトがインプレースアクティベーション状態であるが，そのメニューまたはツールバーはマージされていない。これは中間的な状態で，State プロパティーはメニューまたはツールバーがマージされるとすぐに osUIActive に移る

osUIActive	OLE オブジェクトがインプレースアクティベーション状態であり，メニューとツールバーがマージされている


TOleContainer.StorageInterface
TOleContainer.StorageInterface3322024

TOleContainer	参照

StorageInterface プロパティは，OLE オブジェクトの IStorage インターフェースを示します。

property StorageInterface: IStorage;

説明

StorageInterface プロパティは，OLE API への低レベルアクセスで使います。コンテナに OLE オブジェクトがロードされていない場合は，StorageInterface は nil を返します。


TOleContainer イベント3322025

TOleContainer	アルファベット順	凡例

TOleContainer

OnActivate

OnDeactivate

OnObjectMove

OnResize

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TOleContainer イベント3322026

TOleContainer	オブジェクト順	凡例

OnActivate

OnDeactivate

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnObjectMove

OnResize

OnStartDrag


TOleContainer.OnActivate
TOleContainer.OnActivate3322027

TOleContainer	参照

OnActivate イベントは，OLE オブジェクトがアクティブ化された直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnActivate: TNotifyEvent;

説明

OnActivate イベントハンドラを記述すると，OLE オブジェクトがアクティブ化されたときに特定の処理が行われるようにすることができます。


TOleContainer.OnDeactivate
TOleContainer.OnDeactivate3322028

TOleContainer	参照

OnDeactivate イベントは，OLE オブジェクトが非アクティブ化された直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnDeactivate: TNotifyEvent;

説明

OnDeactivate イベントハンドラを記述すると，OLE オブジェクトが非アクティブ化されたとき応答することができます。


TOleContainer.OnObjectMove
TOleContainer.OnObjectMove3322029

TOleContainer	参照

OnObjectMove イベントは，OLE オブジェクトが移動またはサイズ変更されたことが OLE コンテナに通知されると発生します。

TObjectMoveEvent = procedure(OleContainer: TOleContainer; const Bounds: TRect) of object;

property OnObjectMove: TObjectMoveEvent;

説明

OnObjectMove イベントハンドラを記述すると，OLE オブジェクトが移動またはサイズ変更されたことが OLE コンテナに通知されたときに応答できます。Bounds パラメータは OLE コンテナのクライアント座標でインプレースオブジェクトの境界を指定します。OnObjectMove イベントは，変更内容を反映するために OLE オブジェクトのイメージが更新される前に発生します。


TOleContainer.OnResize
TOleContainer.OnResize3322030

TOleContainer	参照

OnResize イベントは，OLE コンテナウィンドウがサイズ変更された直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnResize: TNotifyEvent;

説明

OnResize イベントハンドラを記述すると，OLE コンテナウィンドウのサイズ変更に応答できます。SizeMode プロパティが smAutoSize の場合は，OLE オブジェクトがサイズ変更されるたびにコンテナウィンドウのサイズが変更されます。


TOleContainer メソッド3322031

TOleContainer	アルファベット順

TOleContainer

ChangeIconDialog

Close

Copy

Create

CreateLinkToFile

CreateObject

CreateObjectFromFile

CreateObjectFromInfo

Destroy

DestroyObject

DoVerb

GetIconMetaPict

InsertObjectDialog

LoadFromFile

LoadFromStream

ObjectPropertiesDialog

Paste

PasteSpecialDialog

Run

SaveAsDocument

SaveToFile

SaveToStream

UpdateObject

UpdateVerbs

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TOleContainer メソッド3322032

TOleContainer	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ChangeIconDialog

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Close

ContainsControl

ControlAtPos

Copy

Create

CreateLinkToFile

CreateObject

CreateObjectFromFile

CreateObjectFromInfo

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DestroyObject

DisableAlign

Dispatch

DoVerb

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetIconMetaPict

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InsertObjectDialog

InstanceSize

Invalidate

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

ObjectPropertiesDialog

PaintTo

Paste

PasteSpecialDialog

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

Run

SafeCallException

SaveAsDocument

SaveToFile

SaveToStream

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState

UpdateObject

UpdateVerbs


TOleContainer.ChangeIconDialog
TOleContainer.ChangeIconDialog3322033

TOleContainer	参照

ChangeIconDialog メソッドは，［アイコンの変更］ダイアログボックスを表示します。

function ChangeIconDialog: Boolean;

説明

ChangeIconDialog メソッドを呼び出すと，ユーザーは OLE オブジェクトをアイコンとして表示するときに使う別のアイコンを.ICO，.DLL，.EXE の各ファイルから選択できます。OLE オブジェクトは，ChangeIconDialog を呼び出す前にロードされていなければなりません。ChangeIconDialog は，ダイアログボックスが正常に表示され，ユーザーが［OK］ボタンを選択した場合は True を返し，それ以外の場合は False を返します。


TOleContainer.Close
TOleContainer.Close3322034

TOleContainer	参照

Close メソッドは，OLE オブジェクトを非アクティブにします。

procedure Close

説明

Close メソッドを呼び出すと，OLE オブジェクトを非アクティブにしてそのサーバーアプリケーションを終了しますが，そのオブジェクトをコンテナからは取り除きません。ユーザーがその OLE オブジェクトに加えた変更は自動的に保存されます。Close の呼び出し後は，そのコンテナの State プロパティは osLoaded になります。

注意

OLE オブジェクトがロードされていないときに Close メソッドが呼び出されると，TOleContainer は例外を生成します。


TOleContainer.Copy
TOleContainer.Copy3322035

TOleContainer	参照

Copy メソッドは，OLE オブジェクトを Windows のクリップボードにコピーします。

procedure Copy;

説明

Copy メソッドを呼び出すと，OLE オブジェクトをクリップボードに書き込むことができます。コンテナに OLE オブジェクトがないと，Copy メソッドは例外を生成します。


TOleContainer.Create
TOleContainer.Create3322036

TOleContainer	参照

Create メソッドは，TOleContainer のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TOleContainer オブジェクトをインスタンス化できます。設計時にフォームに配置した OLE コンテナは自動的に作成されます。継承するコンストラクタを呼び出した後で，Create は以下のプロパティを設定します。

・	ControlStyle を [csClickEvents, csSetCaption, csOpaque, csDoubleClicks]に設定する

・	TabStop を True に設定する

・	ParentColor を False に，BorderStyle を bsSingle に設定する

・	AllowActiveDoc と AllowInPlace を True に設定する

・	AutoActivate を aaDoubleClick に，AutoVerbMenu を True に設定する

・	CopyOnSave を True に設定する


TOleContainer.CreateLinkToFile
TOleContainer.CreateLinkToFile3322037

TOleContainer	参照

CreateLinkToFile メソッドは，ファイルの内容からリンク OLE オブジェクトを作成します。

procedure CreateLinkToFile(const FileName: string; Iconic: Boolean);

説明

CreateLinkToFile メソッドを呼び出すと，FileName パラメータで指定されたファイルからリンク OLE オブジェクトを作成できます。Iconic は，そのオブジェクトがアイコンとして示されるか（True)，サーバーアプリケーションのように表示されるか（False）を示します。コンテナにすでに OLE オブジェクトがある場合はそれが破棄され，ユーザーがそのオブジェクトに加えた変更も破棄されます。


TOleContainer.CreateObject
TOleContainer.CreateObject3322038

TOleContainer	参照

CreateObject メソッドは，そのクラス名（プログラムされた識別子）で指定された埋め込み OLE オブジェクトを作成します。

procedure CreateObject(const OleClassName: string; Iconic: Boolean);

説明

CreateObject メソッドを呼び出すと，OleClassName パラメータで指定したクラス名（プログラムされた識別子）を使って OLE オブジェクトを作成できます。Iconic パラメータは，そのオブジェクトがアイコンとして示されるか（True)，サーバーアプリケーションのように表示されるか（False）を示します。コンテナにすでに OLE オブジェクトがある場合はそれが破棄され，ユーザーがそのオブジェクトに加えた変更も破棄されます。


TOleContainer.CreateObjectFromFile
TOleContainer.CreateObjectFromFile3322039

TOleContainer	参照

CreateObjectFromFile メソッドは，ファイルの内容から埋め込み OLE オブジェクトを作成します。

procedure CreateObjectFromFile(const FileName: string; Iconic: Boolean);

説明

CreateObjectFromFile メソッドを呼び出すと，FileName パラメータで指定されたファイルから OLE オブジェクトを作成できます。Iconic パラメータは，そのオブジェクトがアイコンとして示されるか（True)，サーバーアプリケーションのように表示されるか（False）を示します。コンテナにすでに OLE オブジェクトがある場合はそれが破棄され，ユーザーがそのオブジェクトに加えた変更も破棄されます。


TOleContainer.CreateObjectFromInfo
TOleContainer.CreateObjectFromInfo3322040

TOleContainer	参照

CreateObjectFromInfo メソッドは，指定した TCreateInfo レコードに一致する OLE オブジェクトを作成します。

TCreateType = (ctNewObject, ctFromFile, ctLinkToFile, ctFromData, ctLinkFromData);

TCreateInfo = record

    CreateType: TCreateType;

    ShowAsIcon: Boolean;

    IconMetaPict: HGlobal;

    ClassID: TCLSID;

    FileName: WideString;

    DataObject: IDataObject;

  end;

procedure CreateObjectFromInfo(const CreateInfo: TCreateInfo);

説明

CreateObjectFromInfo メソッドを呼び出すと，CreateInfo パラメータでの指定に基づいて，リンクまたは埋め込み OLE オブジェクトを作成できます。CreateInfo は，オブジェクトをファイル，データ転送オブジェクト，クラス識別子のいずれから作成するかを指定し，必要なサポート情報を提供します。また，CreateInfo は OLE オブジェクトをアイコンとして表示するかどうかも指定し，アイコンを指定できるようにします。コンテナにすでに OLE オブジェクトがある場合はそれが破棄され，ユーザーがそのオブジェクトに加えた変更も破棄されます。

注意

CreateLinkToFile，CreateObject，CreateObjectFromFile の各メソッドは，もっとも一般的な種類の OLE オブジェクト用の呼び出しです。TCreateInfo レコードを埋めるかわりに使われます。


TOleContainer.Destroy
TOleContainer.Destroy3322041

TOleContainer	参照

Destroy メソッドは，TOleContainer のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは OLE コンテナが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。Destroy メソッドは OLE オブジェクトを解放してから，継承するデストラクタを呼び出す前に，。


TOleContainer.DestroyObject
TOleContainer.DestroyObject3322042

TOleContainer	参照

DestroyObject メソッドは，コンテナの OLE オブジェクトを破棄します。

procedure DestroyObject;

説明

DestroyObject メソッドを呼び出すと，OLE オブジェクトを破棄できます。その際，ユーザーがそのオブジェクトに加えた変更は，保存していなければ破棄されます。


TOleContainer.DoVerb
TOleContainer.DoVerb3322043

TOleContainer	参照

DoVerb メソッドは，OLE オブジェクトにアクションの実行を要求します。

procedure DoVerb(Verb: Integer);

説明

DoVerb メソッドを呼び出すと，OLE オブジェクトに対して ObjectVerbs プロパティによってリストされるアクションの 1 つを実行するように要求できます。OLE は ovShow（OLE オブジェクトを表示する）や ovPrimary（デフォルトのアクション，通常は OLE オブジェクトをアクティブにする）などの OLE 動詞をいくつか定義しています。OLE オブジェクトは独自のカスタムの OLE 動詞を定義できます。ObjectVerbs プロパティを使って，このようなカスタムの OLE 動詞のリストを取得できます。


TOleContainer.GetIconMetaPict
TOleContainer.GetIconMetaPict3322044

TOleContainer	参照

GetIconMetaPict メソッドは，OLE オブジェクトのアイコンを含むメタファイルのグローバルメモリハンドルを返します。

function GetIconMetaPict: HGlobal;

説明

GetIconMetaPict を呼び出す前にコンテナに OLE オブジェクトが入っていなければなりません。GetIconMetaPict メソッドを呼び出すと，OLE オブジェクトのアイコンを別のキャンバスに描画するためのメタファイルハンドルを取得できます。グローバル DestroyMetaPict 手続きを使って，そのハンドルを破棄します。OLE コンテナが空の場合，GetIconMetaPict は例外を生成します。


TOleContainer.InsertObjectDialog
TOleContainer.InsertObjectDialog3322045

TOleContainer	参照

InsertObjectDialog メソッドは，［オブジェクトの挿入］ダイアログボックスを表示します。

function InsertObjectDialog: Boolean;

説明

InsertObjectDialog メソッドを呼び出すと，ユーザーは OLE オブジェクトを作成できます。このダイアログボックスを使うと，OLE オブジェクトの埋め込みとリンクを行えます。InsertObjectDialog は，ダイアログボックスが正常に表示され，ユーザーが［OK］ボタンを選択した場合は True を返し，それ以外の場合は False を返します。［OK］を選択したときにコンテナにすでに OLE オブジェクトがある場合はそれが破棄され，ユーザーがそのオブジェクトに加えた変更も破棄されます。


TOleContainer.LoadFromFile
TOleContainer.LoadFromFile3322046

TOleContainer	参照

LoadFromFile メソッドは，指定されたファイルから OLE オブジェクトをロードします。

procedure LoadFromFile(const FileName: string);

説明

LoadFromFile メソッドを呼び出すと，SaveToFile メソッドを使って保存した OLE オブジェクトをロードできます。OldStreamFormat が True の場合には，LoadFromFile は現在の形式を使って保存したファイルだけでなく Delphi 1.0 の TOLEContainer オブジェクトで保存されたファイルもロードします。OldStreamFormat が False の場合，LoadFromFile は Delphi 1.0 で保存されたファイルをロードしません。コンテナにすでに OLE オブジェクトがある場合はそれが破棄され，ユーザーがそのオブジェクトに加えた変更も破棄されます。


TOleContainer.LoadFromStream
TOleContainer.LoadFromStream3322047

TOleContainer	参照

LoadFromStream メソッドは，指定されたストリームから OLE オブジェクトをロードします。

procedure LoadFromStream(Stream: TStream);

説明

LoadFromStream メソッドを呼び出すと，ストリームから OLE オブジェクトをロードできます。OldStreamFormat が True の場合，LoadFromStream は現在の形式を使って保存した OLE オブジェクトだけでなく Delphi 1.0 の TOLEContainer コンポーネントで保存されたストリームもロードします。OldStreamFormat が False の場合は，LoadFromStream は Delphi 1.0 で保存された OLE オブジェクトをロードしません。コンテナにすでに OLE オブジェクトがある場合はそれが破棄され，ユーザーがそのオブジェクトに加えた変更も破棄されます。


TOleContainer.ObjectPropertiesDialog
TOleContainer.ObjectPropertiesDialog3322048

TOleContainer	参照

ObjectPropertiesDialog メソッドは，［オブジェクトのプロパティ］プロパティシートを表示します。

function ObjectPropertiesDialog: Boolean;

説明

ObjectPropertiesDialog メソッドを呼び出すと，ユーザーは OLE オブジェクトのプロパティを表示して編集できます。ユーザーがそのプロパティシートに加えた変更は，自動的に OLE オブジェクトに加えられます。ObjectPropertiesDialog は，プロパティシートが正常に表示され，ユーザーが［OK］ボタンを選択した場合は True を返し，それ以外の場合は False を返します。

OLE コンテナが空の場合は，ObjectPropertiesDialog は例外を生成します。


TOleContainer.Paste
TOleContainer.Paste3322049

TOleContainer	参照

Paste メソッドは，Windows のクリップボードの内容を埋め込みオブジェクトとして貼り付けます。

procedure Paste;

説明

Paste メソッドを呼び出すと，OLE コンテナにクリップボードの内容を埋め込むことができます。コンテナにすでに OLE オブジェクトがある場合はそれが破棄され，ユーザーがそのオブジェクトに加えた変更も破棄されます。


TOleContainer.PasteSpecialDialog
TOleContainer.PasteSpecialDialog3322050

TOleContainer	参照

PasteSpecialDialog メソッドは，［形式を選択して貼り付け］ダイアログボックスを表示します。

function PasteSpecialDialog: Boolean;

説明

PasteSpecialDialog メソッドを呼び出すと，ユーザーは Windows のクリップボードの内容をコンテナに貼り付ける方法を制御できます。［形式を選択して貼り付け］ダイアログボックスを使うと，ユーザーは，データの形式，埋め込みかリンクか，OLE オブジェクトをアイコンとして表示するかどうか（表示する場合は別のアイコンを選択するか）などを選択できます。PasteSpecialDialog は，ダイアログボックスの表示に成功してユーザーが［OK］ボタンを選択した場合には True を返し，それ以外の場合は False を返します。ユーザーが［OK］を選択したときにコンテナにすでに OLE オブジェクトがある場合はそれが破棄され，ユーザーがそのオブジェクトに加えた変更は破棄されます。


TOleContainer.Run
TOleContainer.Run3322051

TOleContainer	参照

Run メソッドは，OLE オブジェクトのサーバーアプリケーションを実行しますが，OLE オブジェクト自体を開いたり起動したりはしません。

procedure Run;

説明

Run メソッドを呼び出すと，確実にサーバーアプリケーションを実行状態にすることができます。いったんサーバーアプリケーションが実行状態になると，OLE オブジェクトはより迅速に開いたり起動したりします。OLE オブジェクトは，Run を呼び出す前にコンテナにロードされていなければなりません。ロードされていないと，Run は例外を生成します。


TOleContainer.SaveToFile
TOleContainer.SaveToFile3322053

TOleContainer	参照

SaveToFile メソッドは，指定されたファイルに OLE オブジェクトを保存します。

procedure SaveToFile(const FileName: string);

説明

SaveToFile メソッドを呼び出すと，OLE オブジェクトを保存できます。CopyOnSave が True の場合，SaveToFile は最初に一時 OLE オブジェクトを作成し，冗長なデータを圧縮して保存するファイルの領域を節約します。OldStreamFormat が True の場合，SaveToFile は Delphi 1.0 の TOLEContainer コンポーネントで読み出せるファイルとして書き込みます。

OLE オブジェクトは，SaveToFile を呼び出す前にコンテナにロードされていなければなりません。ロードされていないと，SaveToFile は例外を生成します。


TOleContainer.SaveToStream
TOleContainer.SaveToStream3322054

TOleContainer	参照

SaveToStream メソッドは，指定されたストリームに OLE オブジェクトを保存します。

procedure SaveToStream(Stream: TStream);

説明

SaveToStream メソッドを呼び出すと，OLE オブジェクトを保存できます。CopyOnSave が True の場合，SaveToStream は最初に一時 OLE オブジェクトを作成し，冗長なデータを圧縮して保存する情報を減らします。OldStreamFormat が True の場合，SaveToStream は Delphi 1.0 の TOLEContainer コンポーネントで読み出せる形式でオブジェクトを書き込みます。

OLE オブジェクトは，SaveToStream を呼び出す前にコンテナにロードされていなければなりません。ロードされていないと，SaveToStream は例外を生成します。


TOleContainer.UpdateObject
TOleContainer.UpdateObject3322055

TOleContainer	参照

UpdateObject メソッドは，OLE オブジェクトを更新します。

procedure UpdateObject;

説明

リンク OLE オブジェクトと，リンク OLE オブジェクトを含む埋め込みオブジェクトは，リンクのソースが更新されると古くなります。UpdateObject はソースを再度読み出して，OLE オブジェクトが最新のデータを確実に持つようにします。コンテナに OLE オブジェクトがロードされていない場合は，UpdateObject は何の効果もありません。


TOleContainer.UpdateVerbs
TOleContainer.UpdateVerbs3322056

TOleContainer	参照

UpdateVerbs メソッドは，OLE オブジェクトが応答する OLE 動詞のリストを更新します。

procedure UpdateVerbs;

説明

TOleContainer は，OjectVerbs プロパティへの最初のアクセス時に自動的に UpdateVerbs を呼び出しますが，何らかのアクションの実行時にその OLE 動詞を変更する OLE オブジェクトもあります。たとえば，メディアクリップ OLE オブジェクトは，実行中にその「要調査」OLE 動詞を「要調査」に変更します。UpdateVerbs を呼び出すと，OLE 動詞のリストが OLE オブジェクトの状態に確実に対応するようにさせることができます。

OLE オブジェクトは，UpdateVerbs を呼び出す前にコンテナにロードされていなければなりません。ロードされていないと，UpdateVerbs は例外を生成します。


スコープ3322057

published

読み出し／書き込み

読み出し専用


スコープ3322058

published


継承3322059

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl


TOleContainer 例3322060

TOleContainer


TOleControl
TOleControl3323001

継承	プロパティ	メソッド	参照

TOleControl は OCX コントロールが派生する基本クラスです。

ユニット

olectrls

説明

TOleControl は TWinControl から派生し，Delphi 環境で OCX コントロールを使うために必要な OLE との対話を処理します。このクラスからコンポーネントを派生させる必要はほとんどありません。


TOleControl プロパティ3323002

TOleControl	アルファベット順	凡例

TOleControl

Name

OleObject

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TOleControl プロパティ3323003

TOleControl	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

Left

Name

OleObject

Owner

Parent

ParentWindow

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TOleControl.Name
TOleControl.Name3323004

TOleControl

Name プロパティは，TOleControl オブジェクトと関連付けられている OCX コントロールです。

property Name: TComponentName;

説明

Name プロパティは，OLE コントロールオブジェクトと関連付けられている OCX コントロールの名前を取得するのに使います。


TOleControl.OleObject
TOleControl.OleObject3323005

TOleControl

OleObject プロパティは，TOleControl オブジェクトと関連付けられている OCX コントロールです。

property OleObject: Variant;

説明

OleObject プロパティは，TOleControl と関連付けられている OCX を取得するのに使います。


TOleControl メソッド3323006

TOleControl	アルファベット順

TOleControl

BrowseProperties

Create

Destroy

DoObjectVerb

GetEnumPropDesc

GetHelpContext

GetObjectVerbs

GetPropDisplayString

GetPropDisplayStrings

IsCustomProperty

SetBounds

SetPropDisplayString

ShowAboutBox

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TOleControl メソッド3323007

TOleControl	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

BrowseProperties

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DoObjectVerb

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetEnumPropDesc

GetHelpContext

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetObjectVerbs

GetParentComponent

GetPropDisplayString

GetPropDisplayStrings

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

IsCustomProperty

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetPropDisplayString

SetTextBuf

Show

ShowAboutBox

Update

UpdateControlState


TOleControl.BrowseProperties
TOleControl.BrowseProperties3323008

TOleControl

BrowseProperties メソッドは，［プロパティ］ダイアログボックスを表示するように OCX コントロールに通知します。

procedure BrowseProperties;

説明

BrowseProperties メソッドを呼び出すと，［プロパティ］ダイアログボックスを表示するように OCX コントロールに通知できます。この［プロパティ］ダイアログボックスには OCX コントロール用のプロパティページがあります。


TOleControl.Create
TOleControl.Create3323009

TOleControl	参照

Create メソッドは，TOleControl オブジェクトの新しいインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，TOleControl オブジェクトの新しいインスタンスを作成できます。Create メソッドは継承した Create メソッドを呼び出し，内部オブジェクトを作成して初期化します。


TOleControl.Destroy
TOleControl.Destroy3323010

TOleControl	参照

Destroy メソッドは，TOleControl オブジェクトのインスタンスに関連付けられているメモリを解放します。

destructor Destroy; override;

説明

Destroy メソッドを直接呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TOleControl オブジェクトのインスタンスが nil ではない場合に Destroy を呼び出します。


TOleControl.DoObjectVerb
TOleControl.DoObjectVerb3323011

TOleControl

DoObjectVerb メソッドは，アクションの 1 つを実行するように OCX コントロールに通知します。

procedure DoObjectVerb(Verb: Integer);

説明

DoObjectVerb メソッドを呼び出すと，アクションの 1 つを実行するように OCX コントロールに通知できます。Verb はアクションに対応する整数です。

Verb についての詳細については，OLE.HLP ファイルまたは最新の Microsoft Developer Network CD を参照してください。


TOleControl.GetEnumPropDesc
TOleControl.GetEnumPropDesc3323012

TOleControl

GetEnumPropDesc メソッドは，OCX コントロールのプロパティの記述を返します。

function GetEnumPropDesc(DispID: Integer): TEnumPropDesc;

説明

GetEnumPropDesc メソッドを呼び出すと，OCX コントロールのプロパティの記述が返されます。

GetEnumPropDesc メソッドは記述を TEnumPropDesc オブジェクトに返します。TEnumPropDesc オブジェクトについての詳細は OLECTRLS.PAS ファイルを参照してください。


TOleControl.GetHelpContext
TOleControl.GetHelpContext3323013

TOleControl

GetHelpContext メソッドは，OCX コントロールのメンバーのヘルプコンテキストを取り出します。

function GetHelpContext(Member: string; var HelpCtx: Integer; var HelpFile: string): Boolean;

説明

GetHelpContext メソッドを呼び出すと，OCX コントロールのメンバーのヘルプコンテキストを取り出せます。

Member は OCX コントロールのプロパティ，メソッド，またはイベントの名前です。OCX コントロール自体のヘルプコンテキストを取り出すには，Member を nil に設定します。

HelpCtx は Member のヘルプコンテキスト識別子が格納される変数です。

HelpFile は HelpCtx を含むヘルプファイルの名前が格納される変数です。

OCX コントロールについての情報は，ITypeInfo インターフェースから取り出されます。詳細は，OLE.HLP ファイルの「ITypeInfo」を参照してください。

GetHelpContext メソッドは Member が見つからない場合に False を返し，見つかった場合は True を返します。


TOleControl.GetObjectVerbs
TOleControl.GetObjectVerbs3323014

TOleControl

GetObjectVerbs メソッドは，OCX コントロールによって実装されるバーブの名前を取り出します。

procedure GetObjectVerbs(List: TStrings);

説明

GetObjectVerbs メソッドを呼び出すと，OCX コントロールによって実装されるバーブの名前を取り出せます。

List にはバーブの名前が格納されます。


TOleControl.GetPropDisplayString
TOleControl.GetPropDisplayString3323015

TOleControl	参照

GetPropDisplayString メソッドは，OCX コントロールのインターフェースの表示文字列を返します。

function GetPropDisplayString(DispID: Integer): string;

説明

GetPropDisplayString メソッドは OCX コントロールのインターフェースの表示文字列を返します。

DispID はインターフェースの識別子です。詳細は，OLE.HLP ファイルの「DISPID」を参照してください。

GetPropDisplayString メソッドについての詳細は，最新の Microsoft Developer Network CD で GetDisplayStrings を参照してください。


TOleControl.GetPropDisplayStrings
TOleControl.GetPropDisplayStrings3323016

TOleControl	参照

GetPropDisplayStrings メソッドは，OCX コントロールのインターフェースの複数の表示文字列を返します。

procedure GetPropDisplayStrings(DispID: Integer; List: TStrings);

説明

GetPropDisplayString メソッドは OCX コントロールのインターフェースの複数の表示文字列を返します。

DispID はインターフェースの識別子です。詳細は，OLE.HLP ファイルの「DISPID」を参照してください。

List には文字列が格納されます。

GetPropDisplayStrings メソッドについての詳細は，最新の Microsoft Developer Network CD で GetDisplayStrings を参照してください。


TOleControl.IsCustomProperty
TOleControl.IsCustomProperty3323017

TOleControl

IsCustomProperty メソッドは，OCX コントロールのインターフェースがカスタムプロパティかどうかを示します。

function IsCustomProperty(DispID: Integer): Boolean;

説明

IsCustomProperty メソッドを呼び出すと，OCX コントロールのインターフェースがカスタムプロパティかどうかがわかります。

DispID はインターフェースの識別子です。詳細は，OLE.HLP ファイルの「DISPID」を参照してください。

IsCustomProperty メソッドは，インターフェースがカスタムプロパティである場合に True を返し，それ以外の場合に False を返します。


TOleControl.SetBounds
TOleControl.SetBounds3323018

TOleControl

SetBounds メソッドは，OCX コントロールの境界を設定します。

procedure SetBounds(ALeft, ATop, AWidth, AHeight: Integer); override;

説明

SetBounds メソッドを呼び出すと，OCX コントロールの境界を設定できます。

ALeft，ATop，AWidth，および AHeight は OCX コントロールの左上隅の x 座標，左上隅の y 座標，幅，および高さです。


TOleControl.SetPropDisplayString
TOleControl.SetPropDisplayString3323019

TOleControl	参照

SetPropDisplayString メソッドは，OCX コントロールのインターフェースの表示文字列を設定します。

procedure SetPropDisplayString(DispID: Integer; const Value: string);

説明

SetPropDisplayString メソッドを呼び出すと，OCX コントロールのインターフェースの表示文字列を設定できます。

DispID はインターフェースの識別子です。詳細は，OLE.HLP ファイルの「DISPID」を参照してください。

Value はインターフェースの新しい表示文字列です。


TOleControl.ShowAboutBox
TOleControl.ShowAboutBox3323020

TOleControl

ShowAboutBox メソッドは，［バージョン情報］ボックスを表示するように OCX コントロールに通知します。

procedure ShowAboutBox;

説明

ShowAboutBox メソッドを使うと，［バージョン情報］ボックスを表示するように OCX コントロールに通知できます。


スコープ3323021

published

読み出し／書き込み

読み出し専用


継承3323022

TObject

TPersistent

TComponent

TControl

TWinControl


TOleControl 例3323023

TOleControl


TOleForm
TOleForm3324001

継承	プロパティ	メソッド

TOleForm は TForm オブジェクトに OLE のサポートを提供するオブジェクトです。

ユニット

olectnrs

説明

TOleForm は，Delphi で内部的に使用するために定義しているインターフェースに加え，IOleForm，IOleWindow，IOleInPlaceUIWindow，および IOleInPlaceFrame インターフェースを実装します。TOleForm オブジェクトの実装は，ビジュアルコンポーネントライブラリにより内部的に使用されます。

TOleForm オブジェクトの実現はビジュアルコンポーネントライブラリで内部的に使われます。


TOleForm プロパティ3324002

TOleForm	アルファベット順	凡例

TInterfacedObject からの継承

RefCount


TOleForm プロパティ3324003

TOleForm	オブジェクト順	凡例

RefCount


TOleForm メソッド3324004

TOleForm	アルファベット順

TOleForm

Create

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TOleForm メソッド3324005

TOleForm	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TOleForm.Create
TOleForm.Create3324006

TOleForm	参照

Create メソッドは，TOleForm オブジェクトの新しいインスタンスを作成します。

constructor Create(Form: TCustomForm);

説明

Create メソッドは，TOleForm オブジェクトの新しいインスタンスを作成できます。

Form は新しい TOleForm オブジェクトの基本となるフォームです。


TOleForm.Destroy
TOleForm.Destroy3324007

TOleForm	参照

Destroy メソッドは，TOleForm オブジェクトのインスタンスに関連付けられているメモリを解放します。

destructor Destroy; override;

説明

直接 Destroy メソッドを呼び出すことはせず，Free メソッドを呼び出すようにしてください。Free メソッドは，TOleForm オブジェクトのインスタンスが nil ではない場合に Destroy メソッドを呼び出します。

Destroy メソッドは，TOleForm オブジェクトのインスタンスに割り当てられ，そして使われているプライベートなオブジェクトを解放します。


読み出し／書き込み3324008

読み出し専用


継承3324009

TObject

TOleFormObject


TOleForm 例3324010

TOleForm


TOleGraphic
TOleGraphic3325001

継承	プロパティ	メソッド	イベント	参照

TOleGraphic は OLE グラフィックインターフェースのラッパーです。

ユニット

axctrls

説明

TOleGraphic は，ActiveX コントロールで使うアイコン，メタファイル，ビットマップのグラフィックコンテナです。これは，IPicture インターフェースを ActiveX コントロールの TPicture プロパティのイメージとしてエクスポーズするために内部的に使います。TOLEGraphic は OLE インターフェースのラッパーなので，情報をファイルにロードまたは保存するためには使えません。


TOleGraphic のプロパティ3325002

TOleGraphic	アルファベット順	凡例

TOleGraphic

Empty

Height

MMHeight

MMWidth

Palette

Picture

Transparent

Width

TGraphic からの継承

Modified

PaletteModified


TOleGraphic のプロパティ3325003

TOleGraphic	オブジェクト順	凡例

Empty

Height

MMHeight

MMWidth

Modified

PaletteModified

Palette

Picture

Transparent

Width


TOleGraphic.Empty
TOleGraphic.Empty3325004

TOleGraphic

Empty プロパティは，OLE グラフィックオブジェクトがグラフィックを保持するかどうかを示します。

property Empty: Boolean;

説明

Empty プロパティは，グラフィックが OLE グラフィックオブジェクトにロードされているかどうかを判別します。OLE グラフィックがグラフィックを保持している場合は True で，保持していない場合は False です。


TOleGraphic.Height
TOleGraphic.Height3325005

TOleGraphic	参照

Height プロパティは，OLE グラフィックの縦サイズをピクセル単位で示します。

property Height: Integer;

説明

Height プロパティは OLE グラフィックの縦の高さをピクセル単位で示します。


TOleGraphic.MMHeight
TOleGraphic.MMHeight3325006

TOleGraphic	参照

MMHeight プロパティは，OLE グラフィックの高さを 0.01 ミリメートル単位で保持します。

property MMHeight: Integer;

説明

MMHeight プロパティは，グラフィックの縦サイズの読み出し精度を高めるために使います。これとは対照的に，Height プロパティは常にスクリーンデバイスのピクセル単位です。デバイスピクセルとミリメートルとの変換誤差を発生させないようにするには，寸法の設定や読み出しを MMHeight によるミリメートル単位で行います。


TOleGraphic.MMWidth
TOleGraphic.MMWidth3325007

TOleGraphic	参照

MMWidth プロパティは，OLE グラフィックの幅を 0.01 ミリメートル単位で保持します。

property MMWidth: Integer;

説明

MMWidth プロパティは，グラフィックの横サイズの読み出し精度を高めるために使います。これとは対照的に，Width プロパティは常にスクリーンデバイスのピクセル単位です。デバイスピクセルとミリメートルとの変換誤差を発生させないようにするには，寸法の設定や読み出しを MMWidth によるミリメートル単位で行います。


TOleGraphic.Palette
TOleGraphic.Palette3325008

TOleGraphic

Palette プロパティは，OLE グラフィックのカラーマッピングを制御します。

property Palette: HPALETTE;

説明

OLE グラフィックの Palette プロパティは，スクリーンにグラフィックを表示するのに使用可能な色を最高 256 色まで保持します。


TOleGraphic.Picture
TOleGraphic.Picture3325009

TOleGraphic

Picture プロパティは，OLE グラフィックがそのコンテナになるインターフェースリファレンスです。

property Picture: IPicture;

説明

Picture プロパティは内部使用専用です。


TOleGraphic.Transparent
TOleGraphic.Transparent3325010

TOleGraphic

Transparent プロパティは，OLE グラフィックイメージがその長方形領域全体を完全に塗りつぶすかどうかを示します。

property Transparent: Boolean;

説明

Transparent プロパティは，OLE グラフィックイメージがその長方形領域全体を塗りつぶすかどうかを示します。Transparent が True の場合，イメージは領域全体を完全には塗りつぶしません。Transparent が False の場合，イメージはその長方形領域全体を塗りつぶします。


TOleGraphic.Width
TOleGraphic.Width3325011

TOleGraphic	参照

Width プロパティは，グラフィックの横サイズをピクセル単位で示します。

property Width: Integer;

説明

Width プロパティは，Ole グラフィックの幅を検出するために使います。

注意

Width はスクリーン解像度を想定しているので，算術変換は正確ではない場合があります。


TOleGraphic のイベント3325012

TOleGraphic	アルファベット順

TGraphic からの継承

OnChange

OnProgress


TOleGraphic のイベント3325013

TOleGraphic	オブジェクト順

OnChange

OnProgress


TOleGraphic のメソッド3325014

TOleGraphic	アルファベット順

TOleGraphic

Assign

LoadFromClipboardFormat

LoadFromFile

LoadFromStream

SaveToClipboardFormat

SaveToStream

TGraphic からの継承

SaveToFile

TPersistent からの継承

Destroy

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TOleGraphic のメソッド3325015

TOleGraphic	オブジェクト順

Assign

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LoadFromClipboardFormat

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

SafeCallException

SaveToClipboardFormat

SaveToFile

SaveToStream


TOleGraphic.Assign
TOleGraphic.Assign3325016

TOleGraphic	参照

Assign メソッドは，IPicture を Ole グラフィックオブジェクトにコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドは，Source が保持する IPicture を Ole グラフィックオブジェクトにコピーします。次に Assign は継承された Assign を呼び出します。IPicture はビットマップ，メタファイル，またはアイコンイメージのいずれかです。


TOleGraphic.LoadFromClipboardFormat
TOleGraphic.LoadFromClipboardFormat3325017

TOleGraphic	参照

LoadFromClipboardFormat メソッドは，Ole グラフィックをクリップボードから Ole グラフィックオブジェクトにロードします。

procedure LoadFromClipboardFormat(AFormat: Word; AData: THandle; APalette: HPALETTE); override;

説明

LoadFromClipboardFormat メソッドは，Ole グラフィックが RegisterClipboardFormat メソッドを使って TPicture オブジェクトに登録されている場合に呼び出されます。

LoadFromClipboardFormat メソッドは，現在のイメージを AData パラメータの示すデータで置き換えます。Ole グラフィックのパレットは，APalette パラメータにより指定されます。


TOleGraphic.LoadFromFile
TOleGraphic.LoadFromFile3325018

TOleGraphic	参照

LoadFromFile メソッドは，OLE グラフィックが何もしないようにオーバーライドされます。

procedure LoadFromFile(const Filename: string); override;

説明

LoadFromFile メソッドは，TOleGraphic でオーバーライドされます。これは IPicture にとって適当でないため，LoadFromFile はグラフィックをファイルからロードしないようになります。


TOleGraphic.LoadFromStream
TOleGraphic.LoadFromStream3325019

TOleGraphic	参照

LoadFromStream メソッドは，IPicture インターフェースをストリームから OLE グラフィックオブジェクトにロードします。

procedure LoadFromStream(Stream: TStream); override;

説明

LoadFromStream には，OLE グラフィックを Stream とするソースストリームを指定します。


TOleGraphic.SaveToClipboardFormat
TOleGraphic.SaveToClipboardFormat3325020

TOleGraphic	参照

SaveToClipboardFormat メソッドは，Ole グラフィックをクリップボード形式に保存します。

procedure SaveToClipboardFormat(var AFormat: Word; var AData: THandle; var APalette: HPALETTE); override;

説明

SaveToClipboardFormat メソッドは，パレットを APalette パラメータの値，ファイル形式を Aformat の値，保存するデータを Adata の値で指定することにより，Ole グラフィックをクリップボード形式に保存します。Ole グラフィックを保存できるようにするには，アプリケーションは RegisterClipboardFormat メソッドを使ってファイル形式を TOleGraphic オブジェクトに登録しておかなければなりません。


TOleGraphic.SaveToStream
TOleGraphic.SaveToStream3325021

TOleGraphic	参照

SaveToClipboardFormat メソッドは，Ole グラフィックをストリームに保存します。

procedure SaveToStream(Stream: TStream); override;

説明

SaveToStream メソッドは，Stream パラメータが指定するストリームに Ole グラフィックを保存します。SaveToStream メソッドは，グラフィックの IPersistStream インターフェースを使ってそのグラフィックをストリームに書き込みます。


アクセス種別3325022

読み出し専用


継承3325023

TObject

TPersistent

TGraphic


TOleGraphic の例3325024

TOleGraphic


TOLEStream
TOLEStream3326001

継承	プロパティ	メソッド	参照

TOleStream は，OLE オブジェクトが提供するストリーミングインターフェースへの情報の読み書きを行います。

ユニット

axctrls

説明

TOleStream を使うと，OLE ストリームインターフェース用の TStream ラッパーを作成できます。TOleStream はOLE ストリームのストリーミングインターフェースを使って情報の読み書きを行います。TActiveXControl オブジェクトは TOleStream を使って，そのオブジェクト自体をストリームからロードしたりストリームに保存したりします。


TOLEStream のプロパティ3326002

TOLEStream	アルファベット順

TStream からの継承

Position

Size


TOLEStream のプロパティ3326003

TOLEStream	オブジェクト順

Position

Size


TOLEStream のメソッド3326004

TOLEStream	アルファベット順

TOleStream

Create

Read

Seek

Write

TStream からの継承

CopyFrom

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TOLEStream のメソッド3326005

TOLEStream	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

CopyFrom

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadBuffer

ReadComponentRes

ReadComponent

ReadResHeader

Read

SafeCallException

Seek

WriteBuffer

WriteComponentRes

WriteComponent

WriteDescendentRes

WriteDescendent

Write


TOLEStream.Create
TOleStream.Create3326006

Create メソッドは，ストリームインターフェースを表す TOleStream オブジェクトをインスタンス化します。

constructor Create(const Stream: IStream);

説明

Create メソッドを呼び出すと，ストリームインターフェースを TOleStream オブジェクトに変換できます。Stream パラメータは TOleStream オブジェクトが読み書きに使うストリームインターフェースです。


TOLEStream.Read
TOleStream.Read3326007

Read メソッドは，現在の位置から Count バイト分をBuffer に読み出します。

function Read(var Buffer; Count: Longint): Longint; override;

説明

利用可能なバイト数が不明の場合に Read メソッドを呼び出すと，OLE ストリームからデータを読み出すことができます。Buffer には，ストリームから読み出されたデータを保持するために少なくとも Count バイトを割り当てる必要があります。

Read は，ストリームインターフェースを使って現在の位置から最大 Count バイト分を Buffer へ転送し，実際に転送されたバイト数を加算して現在の位置を更新します。Read は実際に転送されたバイト数を返します（Count で要求された数よりも少ない場合があります）。

OLE ストリームのその他のすべてのデータ読み出しメソッド（ReadBuffer，ReadComponent）は，Read を呼び出して実際の読み出しを行います。


TOLEStream.Seek
TOleStream.Seek3326008

Seek メソッドは，ストリームの現在の位置をリセットします。

function Seek(Offset: Longint; Origin: Word): Longint; override;

説明

Seek メソッドを呼び出すと，指定されたオフセットで現在の位置を移動できます。Seek はストリームインターフェースを使って現在の位置を Offset および Origin パラメータで指定された値に変更します。

Origin パラメータは Offset パラメータの解釈の方法を示します。Origin に指定できる値は以下のとおりです。

値	意味

soFromBeginning	Offset が OLE ストリームの開始位置から起算される。Seek は位置を Offset に移動する。Offset >= 0 でなければならない

soFromCurrent	Offset が OLE ストリームの現在の位置から起算される。Seek は位置を Position + Offset に移動する

soFromEnd	Offset が OLE ストリームの終了位置から起算される。ストリームの終了前にバイト数を示すためには Offset <= 0 でなければならない

Seek は Position プロパティの新しい値を返します。


TOLEStream.Write
TOleStream.Write3326009

Write メソッドは，Buffer から Count バイト分を OLE ストリームの現在の位置に書き出し，現在の位置を Count バイトで更新します。

function Write(const Buffer; Count: Longint): Longint; override;

説明

Write メソッドを呼び出すと，Count バイト分を OLE ストリームの現在の位置以降に書き出せます。Write はストリームインターフェースを使って Buffer から情報を転送します。

OLE ストリームのその他のすべてのデータ書き出しメソッド（WriteBuffer，WriteComponent）は，Write を呼び出して実際の書き出しを行います。


継承3326010

TObject

TStream


TOLEStream の例3326011

TOLEStream


TOpenDialog
TOpenDialog3327001

継承	プロパティ	メソッド	イベント	参照	例

TOpenDialog はファイル選択用のダイアログボックスを表示します。

ユニット

dialogs

説明

TOpenDialog はファイルを選択したり，ファイルを開いたりするためのモード付きの Windows ダイアログボックスを表示します。このダイアログボックスは，実行時に Execute メソッドの呼び出しによって起動されるまで表示されません。ユーザーが［開く］をクリックすると，ダイアログボックスが閉じて，選択された 1 つまたは複数のファイルが Files プロパティに格納されます。


TOpenDialog プロパティ3327002

TOpenDialog	アルファベット順	凡例

TOpenDialog

DefaultExt

FileEditStyle

FileName

Files

Filter

FilterIndex

HistoryList

InitialDir

Options

Title

TCommonDialog からの継承

Ctl3D

Handle

HelpContext

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TOpenDialog プロパティ3327003

TOpenDialog	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Ctl3D

DefaultExt

DesignInfo

FileEditStyle

FileName

Files

Filter

FilterIndex

Handle

HelpContext

HistoryList

InitialDir

Name

Options

Owner

Tag

Title

VCLComObject


TOpenDialog.DefaultExt
TOpenDialog.DefaultExt3327004

TOpenDialog

DefaultExt プロパティは，デフォルトのファイル拡張子を指定します。

property DefaultExt: string;

説明

DefaultExt プロパティは，選択されたファイル名に登録済みの拡張子が付いていない場合に，そのファイル名に自動的に追加されるファイル拡張子を指定します。ユーザーが登録されていない拡張子を持つファイル名を選択した場合，DefaultExt がその登録されていない拡張子に追加されます。

3 文字を超える拡張子は使えません。ファイル名と拡張子を分けるピリオド（.）は入力しないでください。


TOpenDialog.FileEditStyle
TOpenDialog.FileEditStyle3327005

TOpenDialog

FileEditStyle プロパティは，ファイル選択ダイアログボックスのスタイルを示します（現在は使いません）。

TFileEditStyle = (fsEdit, fsComboBox);

property FileEditStyle: TFileEditStyle;

説明

FileEditStyle プロパティは Delphi の以前のバージョンとの互換性のために残されています。


TOpenDialog.FileName
TOpenDialog.FileName3327006

TOpenDialog	参照

FileName プロパティは，最後に選択されたファイルの名前とディレクトリパスを返します。

TFileName = string;

property FileName: TFileName;

説明

FileName プロパティは，一番最近に選択されたファイルの名前と完全なディレクトリパスを返します。FileName の値は，Files プロパティの 1 番目の項目と同じです。

デフォルトでファイル名をダイアログボックスの編集ボックスに表示するようにするには，オブジェクトインスペクタまたはプログラムコードで値を FileName に代入します。ダイアログボックスがアクティブなときには，プログラムで FileName に変更を加えても無効です。


TOpenDialog.Files
TOpenDialog.Files3327007

TOpenDialog	参照

FileName プロパティは，選択されたファイル名のリストを返します。

property Files: TStrings;

説明

FileName は，選択された各ファイル名とそのフルディレクトリパスを含む TStrings のインスタンスです。ユーザーが複数のファイル名を選択できるようにするには，Options で ofAllowMultiSelect フラグを設定します。


TOpenDialog.Filter
TOpenDialog.Filter3327008

TOpenDialog	参照

ダイアログボックスで使用できるファイルマスク（フィルタ）を決めます。

property Filter: string;

説明

ファイル選択用のダイアログボックスには，編集ボックスの下にファイルの種類のドロップダウンリストがあります。ユーザーがリストからファイルの種類を選択すると，選択した種類のファイルだけがダイアログボックスに表示されます。

設計時にファイルマスクを作成するには，オブジェクトインスペクタで Filter プロパティの右側にある省略記号（...）をクリックします。これでフィルタエディタが開きます。フィルタエディタの左列のフィルタ名の下に，実行時に使用できる各ファイルの種類の簡単な説明を入力します。右の列のフィルタの下には，各説明に対応するファイルマスクを入力します。たとえば，説明「テキストファイル」に対してフィルタマスク「*.TXT」を，あるいは説明「Pascal ソースファイル」に対してフィルタマスク「*.PAS」を設定できます。実行時にはドロップダウンリストに説明が表示されるので，フィルタマスクを明示的に示す方が使いやすくなります（たとえば「テキストファイル (*.TXT)」など）。

プログラムコードでファイルマスクを作成するには，縦棒（パイプ）で区切られた説明とマスクで構成される Filter プロパティに値を代入します。縦棒の両側にはスペースを入れないでください。たとえば次のようになります。

OpenDialog1.Filter := 'Text files (*.txt)|*.TXT'

複数のフィルタは縦棒で区切らなければなりません。たとえば次のようになります。

OpenDialog1.Filter := 'Text files (*.txt)|*.TXT|Pascal files (*.pas)|*.PAS'

1 つのフィルタに複数のマスクを含めるには，マスクをセミコロンで区切ります。これはオブジェクトインスペクタとプログラムコードの両方で機能します。たとえば次のようになります。

OpenDialog1.Filter := 'Pascal files|*.PAS;*.DPK;*.DPR'

Filter に値が代入されていない場合，ダイアログボックスはすべてのファイルの種類を表示します。


TOpenDialog.FilterIndex
TOpenDialog.FilterIndex3327009

TOpenDialog	参照

FilterIndex プロパティは，ダイアログボックスが開いたときに選択されているデフォルトのフィルタを決めます。

property FilterIndex: Integer;

説明

FilterIndex プロパティは，ダイアログボックスが開いたときに Filter のどのファイルの種類がデフォルトで選択されているかを決めます。FilterIndex を 1 に設定すると，リストにある最初のファイルの種類がデフォルトとして選択され，FilterIndex を 2 に設定すると，2 番目のファイルの種類がデフォルトとして選択されます。FilterIndex の値が範囲外の場合，Filter にリストされている最初のファイルの種類がデフォルトになります。


TOpenDialog.HistoryList
TOpenDialog.HistoryList3327010

TOpenDialog	参照

HistoryList プロパティは，以前に選択したファイルのリストを保持します（現在は使いません）。

property HistoryList: TStrings;

説明

HistoryList プロパティは Delphi の以前のバージョンとの互換性のために残されています。


TOpenDialog.InitialDir
TOpenDialog.InitialDir3327011

TOpenDialog

InitialDir プロパティは，ダイアログボックスが開いたときのカレントディレクトリを決めます。

property InitialDir: string;

説明

InitialDir プロパティは，ファイル選択用のダイアログボックスが開いたときに表示されるデフォルトのディレクトリを決めます。たとえば，WINDOWS\SYSTEM ディレクトリをデフォルトにする場合は，InitialDir の値を C:\WINDOWS\SYSTEM に設定します。

InitialDir に値が代入されていない，または指定したディレクトリが存在しない場合は，ダイアログボックスが開くときに現在の作業ディレクトリが表示されます。


TOpenDialog.Options
TOpenDialog.Options3327012

TOpenDialog	参照

Options プロパティは，ファイル選択用のダイアログボックスの外観と動作を決めます。

TOpenOption = (ofReadOnly, ofOverwritePrompt, ofHideReadOnly, ofNoChangeDir, ofShowHelp, ofNoValidate, ofAllowMultiSelect, ofExtensionDifferent, ofPathMustExist, ofFileMustExist, ofCreatePrompt, ofShareAware, ofNoReadOnlyReturn, ofNoTestFileCreate, ofNoNetworkButton, ofNoLongNames, ofOldStyleDialog, ofNoDereferenceLinks);

TOpenOptions = set of TOpenOption;

property Options: TOpenOptions default [];

説明

Options プロパティを使うと，ダイアログボックスの外観と動作をカスタマイズできます。Options には次の値を指定できます。

値	意味

ofAllowMultiSelect	ユーザーがダイアログボックスで複数のファイルを選択できる

ofCreatePrompt	存在しないファイルをユーザーが選択しようとしたときに警告メッセージを生成し，指定の名前で新しいファイルを作成するかどうか尋ねる

ofExtensionDifferent	このフラグは，実行時に DefaultExt と異なる拡張子を持つファイル名が選択された場合に設定される。アプリケーションでこのフラグを使う場合には必ず再設定を行う

ofFileMustExist	存在しないファイルをユーザーが選択しようとしたときにエラーメッセージを生成する

ofHideReadOnly	ダイアログボックスから［読み取り専用ファイルとして開く(R)］チェックボックスを削除する

ofNoChangeDir	ユーザーが［OK］をクリックしたあと，カレントディレクトリを，ファイル選択用のダイアログボックスが開かれる前のディレクトリに再設定する

ofNoDereferenceLinks	Windows ショートカットの逆参照を無効にする。ユーザーがショートカットを選択した場合に，FileName にはそのショートカットとリンクしているファイルではなく，ショートカット自体（.LNK ファイル）のパスとファイル名を代入する

ofNoLongNames	8.3 文字のファイル名だけを表示する

ofNoNetworkButton	ファイル選択用のダイアログボックスから［ネットワーク(E)］ボタン（［ネットワークドライブの割り当て］ダイアログボックスを開く）を削除する。ofOldStyleDialog フラグが設定されている場合だけ有効

ofNoReadOnlyReturn	ユーザーが読み出し専用のファイルを選択しようとしたときにエラーメッセージを生成する

ofNoTestFileCreate	ネットワークファイルが保護されているか，またはディスクドライブにアクセスできるかの検査を無効にする。作成は可能だが，変更はできない共有ネットワークディレクトリにユーザーがファイルを保存しようとしたときだけ有効

ofNoValidate	ファイル名の無効な文字の検査をしない。無効な文字のあるファイル名の選択を許可する

ofOldStyleDialog	古いスタイルの選択用ダイアログボックスを作成する

ofOverwritePrompt	すでに使われているファイル名をユーザーが選択しようとしたときにエラーメッセージを生成し，既存のファイルを上書きするかどうかを尋ねる（TSaveDialog と TSavePictureDialog とともに使う）

ofPathMustExist	存在しないディレクトリパスのファイル名をユーザーが選択しようとしたときにエラーメッセージを生成する

ofReadOnly	ダイアログボックスが開いたときにデフォルトで［読み取り専用ファイルとして開く(R)］チェックボックスを選択する

ofShareAware	共有エラーを無視し，共有違反が発生した場合にもファイルの選択を許可する

ofShowHelp	ダイアログボックスに［ヘルプ(H)］ボタンを表示する

デフォルトでは，ofHideReadOnly 以外のすべてのオプションがオフです。


TOpenDialog.Title
TOpenDialog.Title3327013

TOpenDialog

Title プロパティは，ダイアログボックスのタイトルバーに表示するテキストを指定します。

property Title: string;

説明

Title プロパティを使うと，ファイル選択用のダイアログボックスのタイトルバーに表示されるテキストを指定できます。Title プロパティに値が代入されていない場合，ダイアログボックスのタイトルバーのテキストは「ファイルを開く」になります。


TOpenDialog イベント3327014

TOpenDialog	アルファベット順	凡例

TOpenDialog

OnFolderChange

OnSelectionChange

OnTypeChange

TCommonDialog からの継承

OnClose

OnShow


TOpenDialog イベント3327015

TOpenDialog	オブジェクト順	凡例

OnClose

OnFolderChange

OnSelectionChange

OnShow

OnTypeChange


TOpenDialog.OnFolderChange
TOpenDialog.OnFolderChange3327016

TOpenDialog

OnFolderChange イベントは，ダイアログボックスでディレクトリを開くか，または閉じたときに発生します。

property OnFolderChange: TNotifyEvent;

説明

OnFolderChange イベントは，ユーザーがダイアログボックスで内容が表示されるディレクトリを変更したときに発生します。これは，ユーザーがディレクトリをダブルクリックしたり，上向き矢印をクリックしたり，ダイアログボックスの上にあるリストボックスを使ってディレクトリ構造を移動したりすると起こります。


TOpenDialog.OnSelectionChange
TOpenDialog.OnSelectionChange3327017

TOpenDialog	参照

OnSelectionChange イベントは，ダイアログボックスに表示されているファイルの名前が変更されたときに発生します。

property OnSelectionChange: TNotifyEvent;

説明

OnSelectionChange イベントは，ダイアログボックスに表示されているリストを変更する操作をユーザーが行ったときに発生します。この操作には，ファイル選択用のダイアログボックスを開いたり，ファイルまたはディレクトリを強調表示したり，新しいフィルタを選択したり，新しいディレクトリを選択したり，または新しいフォルダを作成したりといったことが含まれます。


TOpenDialog.OnTypeChange
TOpenDialog.OnTypeChange3327018

TOpenDialog	参照

OnTypeChange イベントは，ダイアログボックスに表示されるファイルの種類が変更されたときに発生します。

property OnSelectionChange: TNotifyEvent;

説明

OnTypeChange イベントは，ユーザーがダイアログボックスの下にある［ファイルの種類(T)］リストボックスから新しいフィルタを選択したときに発生します。


TOpenDialog メソッド3327019

TOpenDialog	アルファベット順	凡例

TOpenDialog

Create

Destroy

Execute

GetStaticRect

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TOpenDialog メソッド3327020

TOpenDialog	オブジェクト順	凡例

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Execute

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetStaticRect

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TOpenDialog.Create
TOpenDialog.Create3327021

TOpenDialog	参照

Create メソッドは，TOpenDialog のインスタンスを作成し初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは TOpenDialog のインスタンスを生成しますが，実行時に Execute メソッドが呼び出されるまで新しいダイアログボックスは表示されません。


TOpenDialog.Destroy
TOpenDialog.Destroy3327022

TOpenDialog	参照

Destroy メソッドは，TOpenDialog を破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドはファイル選択用のダイアログボックスが破棄されていないことを確認してから Destroy メソッドを呼び出します。


TOpenDialog.Execute
TOpenDialog.Execute3327023

TOpenDialog

Execute メソッドは，ファイル選択用のダイアログボックスを表示します。

function Execute: Boolean; override;

説明

Execute メソッドはファイル選択用のダイアログボックスを開き，ユーザーがファイルを選択して［開く］をクリックしたときに True を返します。ユーザーが［キャンセル］をクリックした場合，Execute は False を返します。


TOpenDialog.GetStaticRect
TOpenDialog.GetStaticRect3327024

TOpenDialog	参照

GetStaticRect メソッドは，ダイアログボックスの予約済みの領域の座標を返します。

function GetStaticRect: TRect; virtual;

説明

GetStaticRect メソッドは，TOpenDialog から派生し，親クラスから継承した標準コントロールとともに新しいコントロールの配置が必要なコンポーネント用に提供されます。Windows 95 または NT 4.0で動作するエクスプローラスタイルのダイアログボックスの場合，GetStaticRect はダイアログボックス内の標準コントロールのサイズと位置を返します。以前のバージョンの Windows の場合，または ofOldStyleDialog が Options プロパティで指定している場合，GetStaticRect はダイアログボックス全体のクライアントサイズを返します。

次のコードは TOpenPictureDialog の例で，ダイアログボックスのクライアント領域と標準コントロールのスタティック領域との差を基にしてプレビュー用の四角形を計算します。

procedure TOpenPictureDialog.DoShow;

var

  PreviewRect, StaticRect: TRect;

begin

  { プレビュー領域をダイアログボックス全体に設定します }

  GetClientRect(Handle, PreviewRect);

  StaticRect := GetStaticRect;

  { プレビュー領域をスタティック領域の右側に移動します }

  PreviewRect.Left := StaticRect.Left + (StaticRect.Right - StaticRect.Left);

...


スコープ3327025

published

読み出し／書き込み

読み出し専用


スコープ3327026

protected


スコープ3327027

published


継承3327028

TObject

TPersistent

TComponent

TCommonDialog


TOpenDialog 例3327029

TOpenDialog


TOpenPictureDialog
TOpenPictureDialog3328001

継承	プロパティ	メソッド	イベント	参照

TOpenPictureDialog はグラフィックファイルを選択するダイアログボックスを表示します。

ユニット

extdlgs

説明

TOpenPictureDialog は，グラフィックファイルを選択して開くためにモード付き Windows ダイアログボックスを表示します。このコンポーネントは，長方形のプレビュー領域が含まれる以外は TOpenDialog と同じです。選択された画像が TPicture で読み出せる場合はプレビュー領域に表示されます。サポートされるファイルはビットマップ（.BMP），アイコン（.ICO），Windows メタファイル（.WMF），およびエンハンスト Windows メタファイル（.EMF）です。選択された画像を表示できない場合はプレビュー領域に「（なし）」と表示されます。

注意

TPicture は，認識できないファイルが選択されると EInvalidGraphic 例外を生成します。Exception が使用可能なときに Break でデバッグするとこのようなエラーが発生します。


TOpenPictureDialog プロパティ3328002

TOpenPictureDialog	アルファベット順	凡例

TOpenDialog からの継承

DefaultExt

FileEditStyle

FileName

Files

Filter

FilterIndex

HistoryList

InitialDir

Options

Title

TCommonDialog からの継承

Ctl3D

Handle

HelpContext

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TOpenPictureDialog プロパティ3328003

TOpenPictureDialog	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Ctl3D

DefaultExt

DesignInfo

FileEditStyle

FileName

Files

Filter

FilterIndex

Handle

HelpContext

HistoryList

InitialDir

Name

Options

Owner

Tag

Title

VCLComObject


TOpenPictureDialog イベント3328004

TOpenPictureDialog	アルファベット順	凡例

TOpenDialog からの継承

OnFolderChange

OnSelectionChange

OnTypeChange

TCommonDialog からの継承

OnClose

OnShow


TOpenPictureDialog イベント3328005

TOpenPictureDialog	オブジェクト順	凡例

OnClose

OnFolderChange

OnSelectionChange

OnShow

OnTypeChange


TOpenPictureDialog メソッド3328006

TOpenPictureDialog	アルファベット順

TOpenPictureDialog

Create

Destroy

Execute

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TOpenPictureDialog メソッド3328007

TOpenPictureDialog	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Execute

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TOpenPictureDialog.Create
TOpenPictureDialog.Create3328008

TOpenPictureDialog	参照

Create メソッドは，TOpenPictureDialog のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは TOpenPictureDialog のインスタンスを生成しますが，実行時に Execute メソッドが呼び出されるまでダイアログボックスは表示されません。Create は，TPicture がサポートするすべてのファイルの種類にフィルタを定義することで Filter プロパティを初期化します。


TOpenPictureDialog.Destroy
TOpenPictureDialog.Destroy3328009

TOpenPictureDialog	参照

Destroy メソッドは，TOpenPictureDialog を破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはファイル選択ダイアログボックスが破棄されていないことを確認してから Destroy メソッドを呼び出します。


TOpenPictureDialog.Execute
TOpenPictureDialog.Execute3328010

TOpenPictureDialog

Execute メソッドは，ファイル選択ダイアログボックスを表示します。

function Execute: Boolean; override;

説明

Execute はファイル選択ダイアログボックスを開いて，ユーザーがファイルを選択して［開く(O)］をクリックすると True を返します。ユーザーが［キャンセル］をクリックすると Execute は False を返します。


スコープ3328011

published

読み出し／書き込み

読み出し専用


スコープ3328012

published


継承3328013

TObject

TPersistent

TComponent

TCommonDialog

TOpenDialog


TOpenPictureDialog 例3328014

TOpenPictureDialog


OutlineError
OutlineError3329001

継承	メソッド	参照

OutlineError は，無効なアウトラインノードインデックスによって生成される特殊な例外クラスです。

ユニット

outline

説明

OutlineError 例外は，アプリケーションが指定のアウトラインノードにアクセスできなかったときに生成されます。これはほとんどの場合，指定したインデックスが無効であったために発生します。

OutlineError 例外は，アウトラインコンポーネントの参照を中止するために内部的に生成されます。また，Exception オブジェクトから派生した例外ではないので，デバッグオプションの［例外でデバッガを開く(B)］の設定に影響されません。このため，再帰を多用した処理を中止するのに有効です。

注意

outlineEror は，TOutline コンポーネントによって生成されます。


OutlineError メソッド3329002

OutlineError	アルファベット順

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


OutlineError メソッド3329003

OutlineError	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3329004

TObject


OutlineError 例3329005

OutlineError


TPageControl
TPageControl3330001

継承	プロパティ	メソッド	イベント	参照

TPageControl は，複数ページのダイアログボックスを作成するために使うページセットです。

ユニット

comctrls

説明

TPageControl は，複数ページのダイアログボックスやタブ付きノートブックを作成するために使います。TPageControl は，TTabSheet オブジェクトである，重なり合った複数のページを表示します。ページを選択するには，コントロールの上部にあるページのタブをクリックします。設計時に新しいページを TPageControl オブジェクトに追加するには，TPageControl オブジェクトを右クリックして［ページ新規作成(W)］を選択します。

本体部分（ページ）を 1 つしか使わないタブ付きコントロールを作成するには，TTabControl を使います。


TPageControl プロパティ3330002

TPageControl	アルファベット順	凡例

TPageControl

ActivePage

PageCount

Pages

TCustomTabControl からの継承

HotTrack

MultiLine

ScrollOpposite

TabHeight

TabPosition

TabWidth

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TPageControl プロパティ3330003

TPageControl	オブジェクト順	凡例

ActivePage

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

Hint

HotTrack

Left

MultiLine

Name

Owner

PageCount

Pages

Parent

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ScrollOpposite

ShowHint

Showing

TabHeight

TabOrder

TabPosition

TabStop

TabWidth

Tag

Top

VCLComObject

Visible

Width

WindowProc


TPageControl.ActivePage
TPageControl.ActivePage3330004

TPageControl	参照	例

ActivePage プロパティは，現在ページコントロールが表示しているページです。

property ActivePage: TTabSheet;

説明

ActivePage プロパティは，ユーザーがどのページを選択してるかを示します。ページを選択するには，ページに付いているタブをクリックします。ActivePage を設定するとページを一番手前に表示できます。アクティブになるページは一度に 1 つだけです。

アクティブなページの次または前のページに変更するには，SelectNextPage メソッドを使います。特定のページを位置付けるためにすべてのページを反復するには，FindNextPage メソッドを使います。


TPageControl.PageCount
TPageControl.PageCount3330005

TPageControl	参照	例

PageCount プロパティは，TPageControl オブジェクトに入っているページ数を示します。

property PageCount: Integer;

説明

PageCount プロパティは，Pages プロパティに入っているページの数を調べるために使います。MultiLine プロパティが False の場合，すべてのページが表示されているとはかぎりません。


TPageControl.Pages
TPageControl.Pages3330006

TPageControl	参照	例

Pages プロパティは，TPageControl に入っているすべてのページのインデックス付き配列です。

property Pages[Index: Integer]: TTabSheet;

説明

Pages プロパティは，ページコントロールに入っている特定のページに直接アクセスするために使います。たとえば，Pages を使ってページコントロール内の個々のページを使用不可にします。Index を使ってアクセスするページを指定します。Index を 0 にすれば最初のページを示し，Index を 1 にすれば 2 番目のページを示します。各ページは TTabSheet オブジェクトです。

ページコントロール内で別のページに相対するページの位置を特定するには，FindNextPage メソッドを使います。


TPageControl イベント3330007

TPageControl	アルファベット順	凡例

TCustomTabControl からの継承

OnChange

OnChanging

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TPageControl イベント3330008

TPageControl	オブジェクト順	凡例

OnChange

OnChanging

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TPageControl メソッド3330009

TPageControl	アルファベット順

TPageControl

Create

Destroy

FindNextPage

SelectNextPage

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TPageControl メソッド3330010

TPageControl	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

FindNextPage

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectNextPage

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TPageControl.Create
TPageControl.Create3330011

TPageControl	参照	例

Create メソッドは，PageControl のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にページコントロールをインスタンス化できます。設計時にフォームに追加されたページコントロールは自動的に作成されます。継承されたコンストラクタの呼び出し後，Create は ControlStyle を csDoubleClicks に設定して，そのコントロールのページを保持するために TList オブジェクトを作成します。

実行時にページコントロールを作成する場合，ページをプログラムで追加しなければなりません。 実行時にページコントロールに新しいページを追加するには，そのページのための TTabSheet オブジェクトを作成して，PageControl プロパティを設定します。


TPageControl.Destroy
TPageControl.Destroy3330012

TPageControl	参照

Destroy メソッドは，TPageControl のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは Destroy を直接呼び出さないでください。代わりに Free を呼び出します。Free はページコントロールがすでに解放されていないことを確認してからのみ Destroy を呼び出します。Destroy は，コントロールのページを保持する TList オブジェクトを解放してから，継承されたデストラクタを呼び出します。


TPageControl.FindNextPage
TPageControl.FindNextPage3330013

TPageControl	参照	例

FindNextPage メソッドは，ページコントロール内で指定されたページの前後にあるページを返します。

function FindNextPage(CurPage: TTabSheet; GoForward, CheckTabVisible: Boolean): TTabSheet;

説明

FindNextPage メソッドを呼び出すと，CurPage パラメータで指定されたページに相対する位置を使ってページコントロール内のページを位置付けることができます。GoForward パラメータが True の場合，FindNextPage はページコントロール内で CurPage の後のページを返します。GoForward パラメータが False の場合，FindNextPage は前のページを返します。CurPage がページコントロールに存在しない場合，FindNextPage は，GoForward が True ならば最初のページを返し，GoForward が False ならば，最後のページを返します。GoForward が True で CurPage がページコントロール内で最後のページの場合，FindNextPage はページコントロールで最初のページを返します。GoForward が False で CurPage がページコントロール内で最初のページの場合，FindNextPage がページコントロール内で最後のページを返します。

CheckTabVisible が True の場合，FindNextPage は TabVisible プロパティが True に設定されている次のページを返します。CheckTabVisible が False の場合，FindNextPage は TabVisible が False に設定されているページも含めた次のページを返します。


TPageControl.SelectNextPage
TPageControl.SelectNextPage3330014

TPageControl	参照	例

SelectNextPage メソッドは，ActivePage を現在アクティブなページの前後で表示されている隣のページに変更します。

procedure SelectNextPage(GoForward: Boolean);

説明

SelectNextPage メソッドを呼び出すと，現在アクティブなページの次のページを選択できます。GoForward パラメータが True の場合，SelectNextPage はページコントロール内で ActivePage の直後のページを選択します。GoForward が False の場合，FindNextPage は ActivePage の直前のページを選択します。SelectNextPage が探す対象とするのは，TabVisible プロパティが True に設定されたページだけです。

注意

設計時にページを選択するには，TPageControl を右クリックして［前のページ(P)］または［次のページ(X)］を選択します。


スコープ3330015

published

読み出し／書き込み

読み出し専用


スコープ3330016

published


継承3330017

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomTabControl


TPageControl 例3330018

TPageControl


TPageProducer
TPageProducer3331001

継承	プロパティ	メソッド	イベント	参照

TPageProducer は入力テンプレートに基づいて HTML コマンドの文字列を作成します。

ユニット

httpapp

説明

TPageProducer を使うと，HTML テンプレートを，Web ブラウザなどのクライアントアプリケーションが解釈できる HTML コマンドの文字列に変換できます。HTML テンプレートに含まれる HTML コマンドや HTML 透過タグは，OnHTMLTag イベントでカスタマイズした内容に置き換えられます。


TPageProducer プロパティ3331002

TPageProducer	アルファベット順	凡例

TCustomPageProducer からの継承

HTMLDoc

HTMLFile

TCustomContentProducer からの継承

Dispatcher

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TPageProducer プロパティ3331003

TPageProducer	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Dispatcher

HTMLDoc

HTMLFile

Name

Owner

Tag

VCLComObject


TPageProducer イベント3331004

TPageProducer	アルファベット順	凡例

TPageProducer

OnHTMLTag


TPageProducer イベント3331005

TPageProducer	オブジェクト順	凡例

OnHTMLTag


TPageProducer.OnHTMLTag
TPageProducer.OnHTMLTag3331006

TPageProducer	参照

OnHTMLTag イベントは，ページ作成オブジェクトが HTML テンプレート内の HTML 透過タグの値を提供する必要があるときに発生します。

TTag = (tgCustom, tgLink, tgImage, tgTable, tgImageMap, tgObject, tgEmbed);

THTMLTagEvent = procedure (Sender: TObject; Tag: TTag; const TagString: string; TagParams: TStrings; var ReplaceText: string) of object;

property OnHTMLTag: THTMLTagEvent;

説明

OnHTMLTag イベントハンドラを記述すると，HTML 透過タグを，Web ブラウザが解釈できる HTML コマンドに変換できます。OnHTMLTag イベントが提供されない場合，HTML テンプレート内の HTML 透過タグは空の文字列に置き換えられます。

Tag パラメータは，HTML テンプレートに設定されていた HTML 透過タグの型を示します。以下に Tag に指定できる値を示します。

値	意味

tgLink	TagString パラメータは LINK である。TagParams はハイパーテキストリンクを表す。イベントハンドラは <A> タグで始まり </A> タグで終わる HTML コマンドのシーケンスを返さなければならない

tgImage	TagString パラメータは IMAGE である。TagParams はグラフィックイメージを表す。イベントハンドラは HTML の <IMG> タグを返さなければならない

tgTable	TagString パラメータは TABLE である。TagParams はテーブル形式のイメージを表す。イベントハンドラは <TABLE> タグで始まり </TABLE> タグで終わる HTML コマンドのシーケンスを返さなければならない

tgImageMap	TagString パラメータは IMAGEMAP である。TagParams は関連のホットゾーンを持つグラフィックイメージを表す。イベントハンドラは <MAP> タグで始まり </MAP> タグで終わる HTML コマンドのシーケンスを返さなければならない

tgObject	TagString パラメータは OBJECT である。TagParams は ActiveX コントロールへの参照を含む。イベントハンドラは <OBJECT> タグで始まり </OBJECT> タグで終わる HTML コマンドのシーケンスを返さなければならない

tgEmbed	TagString パラメータは EMBED である。TagParams は Netscape 準拠のアドイン DLL への参照を含む。イベントハンドラは <EMBED> タグで始まり </EMBED> タグで終わる HTML コマンドのシーケンスを返さなければならない

tgCustom	TagString パラメータはアプリケーション定義の文字列である。イベントハンドラはアプリケーション固有の方法で HTML 透過タグを変換できる

TagString パラメータは HTML 透過タグのタグ名です。Tag パラメータが tgCustom の場合，TagString はどの変換を行うかを決めるのに使います。TagParams パラメータは HTML 透過タグのパラメータ部分を提供します。TStrings オブジェクト内の各文字列は ParamName=Value の形式で表されます。TStrings オブジェクトの Names と Values プロパティを使うと，これらのパラメータを解析できます。

OnHTMLTag イベントハンドラは，変換した HTML コマンドを ReplaceText パラメータに返さなければなりません。その戻り値の中に HTML 透過タグを入れて，別のページ作成オブジェクトで変換できるようにすることも可能です。たとえば，あるページ作成オブジェクトが最終的な HTTP 応答の形式を表すテンプレートを持っているとします。そのページ作成オブジェクトは HTTP 要求を読み，要求に基づいて，パラメータを設定した HTML 透過タグのセットを要求のセクションごとにアセンブルできます。別のページ作成オブジェクトは最初のページ作成オブジェクトの内容を取得したり，設定されたパラメータを解釈したりできます。


TPageProducer メソッド3331007

TPageProducer	アルファベット順

TCustomPageProducer からの継承

Content

ContentFromStream

ContentFromString

Create

Destroy

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TPageProducer メソッド3331008

TPageProducer	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Content

ContentFromStream

ContentFromString

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


スコープ3331009

published

読み出し／書き込み

読み出し専用


スコープ3331010

published


継承3331011

TObject

TPersistent

TComponent

TCustomContentProducer

TCustomPageProducer


TPageProducer 例3331012

TPageProducer


TPaintBox
TPaintBox3332001

継承	プロパティ	メソッド	イベント	参照

TPaintBox コンポーネントは，アプリケーションがイメージを描画するために使うキャンバスを提供する簡単なグラフィックコントロールです。

ユニット

extctrls

説明

TPaintBox を使って，フォームに独自のイメージを描画します。ビットマップ，アイコン，またはメタファイルに格納されたイメージを表示する TImage と違い，TPaintBox ではアプリケーションがキャンバスに直接描画する必要があります。OnPaint イベントハンドラを使って，ペイントボックスの Canvas，つまりペイントボックスの表面に描画します。


TPaintBox プロパティ3332002

TPaintBox	アルファベット順	凡例

TGraphicControl からの継承

Canvas

TControl からの継承

Align

BoundsRect

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TPaintBox プロパティ3332003

TPaintBox	オブジェクト順	凡例

Align

BoundsRect

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlState

ControlStyle

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Owner

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Tag

Top

VCLComObject

Visible

Width

WindowProc


TPaintBox イベント3332004

TPaintBox	アルファベット順	凡例

TPaintBox

OnPaint

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TPaintBox イベント3332005

TPaintBox	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnPaint

OnStartDrag


TPaintBox.OnPaint
TPaintBox.OnPaint3332006

TPaintBox	参照

OnPaint イベントは，ペイントボックスが Windows のペイントメッセージを受け取ると発生します。

property OnPaint: TNotifyEvent read FOnPaint write FOnPaint;

説明

OnPaint イベントハンドラを記述すると，ペイントボックスのイメージを描画できます。キャンバスのメソッドを使うと，ペイントボックスがフォーム上で表すイメージを構築できます。OnPaint イベントハンドラを記述しない場合，実行時にペイントボックスをフォームに表示できません。


TPaintBox メソッド3332007

TPaintBox	アルファベット順	凡例

TPaintBox

Create

Paint

TGraphicControl からの継承

Destroy

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Invalidate

Perform

Refresh

Repaint

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TPaintBox メソッド3332008

TPaintBox	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DragDrop

Dragging

EndDrag

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTextBuf

GetTextLen

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Paint

Perform

Refresh

RemoveComponent

Repaint

SafeCallException

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update


TPaintBox.Create
TPaintBox.Create3332009

TPaintBox	参照

Create メソッドは，TPaintBox オブジェクトのインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと実行時に TPaintBox オブジェクトをインスタンス化できます。設計時にフォームに追加された TPaintBox オブジェクトは自動的に作成されます。

Create はメモリを割り当てて TPaintBox オブジェクトのインスタンスのデフォルト値を設定します。


TPaintBox.Paint
TPaintBox.Paint3332010

TPaintBox	参照

Paint メソッドは，OnPaint イベントを発生させます。

procedure Paint; override;

説明

Paint メソッドは，キャンバスを初期化し，OnPaint イベントハンドラを呼び出す（ある場合）ことで Windows からの WM_PAINT メッセージに応答します。


スコープ3332011

published

読み出し／書き込み

読み出し専用


スコープ3332012

protected


スコープ3332013

published


継承3332014

TObject

TPersistent

TComponent

TControl

TGraphicControl


TPaintBox 例3332015

TPaintBox


TPaintControl
TPaintControl3333001

継承	プロパティ	メソッド	参照

TPaintControl はデータベース対応のコントロールをコピーするために TDBCtrlGrid によって使われます。

ユニット

dbctrls

説明

TPaintControl は，複数のデータベース対応のコントロール（TDBCheckBox，TDBComboBox，TDBMemo を含む）が自身をデータコントロールグリッド（TDBCtrlGrid）内でコピーするために使います。


TPaintControl のプロパティ3333002

TPaintControl	アルファベット順	凡例

TPaintControl

Ctl3DButton

Handle


TPaintControl のプロパティ3333003

TPaintControl	オブジェクト順	凡例

Ctl3DButton

Handle


TPaintControl.Ctl3DButton
TPaintControl.Ctl3DButton3333004

TPaintControl

コントロールの外観を 3 次元にするかどうかを決めます。

property Ctl3DButton: Boolean;

Ctl3DButton が True ならば，データベース対応コントロールは 3 次元的な外観のベベル境界を持ちます。


TPaintControl.Handle
TPaintControl.Handle3333005

TPaintControl

ペイントコントロールのウィンドウハンドルです。

property Handle: HWnd;

Handle は TPaintControl インスタンスのウィンドウハンドルです。


TPaintControl のメソッド3333006

TPaintControl	アルファベット順

TPaintControl

Create

Destroy

DestroyHandle

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TPaintControl のメソッド3333007

TPaintControl	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

DestroyHandle

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TPaintControl.Create
TPaintControl.Create3333008

TPaintControl

TPaintControl オブジェクトのインスタンスを作成し，初期化します。

constructor Create(AOwner: TWinControl; const ClassName: string);

説明

Create メソッドは TPaintControl のインスタンスを作成します。


TPaintControl.Destroy
TPaintControl.Destroy3333009

TPaintControl	参照

TPaintControl を破棄してそのメモリを解放します。

destructor Destroy; override;

説明

アプリケーションで Destroy を直接呼び出さないでください。かわりに Free を呼び出します。Free は，コントロールが破棄済みでないことを確認してからのみ Destroy を呼び出します。


TPaintControl.DestroyHandle
TPaintControl.DestroyHandle3333010

TPaintControl	参照

ペイントコントロールのウィンドウハンドルを破棄します。

procedure DestroyHandle;

説明

DestroyHandle はペイントコントロールを破棄し，割り当てられていたメモリを解放します。


アクセス種別3333011

読み出し専用


継承3333012

TObject


TPaintControl の例3333013

TPaintControl


TPanel
TPanel3334001

継承	プロパティ	メソッド	イベント	参照	例

TPanel コンポーネントは汎用パネルコントロールを実現します。

ユニット

extctrls

説明

TPanel コンポーネントを使うと，空のパネルをフォームに配置できます。パネルコンポーネントはコントロールの周囲のベベル境界を提供するプロパティ，およびパネルに埋め込まれる子コントロールの配置の管理を支援するメソッドを提供します。

TPanel が実装している一般的な動作は，TCustomPanel で導入されているものです。TPanel コンポーネントは TCustomPanel から継承したプロパティの多くをパブリッシュにしていますが，新しい動作は導入されていません。


TPanel プロパティ3334002

TPanel	アルファベット順	凡例

TCustomPanel からの継承

Alignment

BevelInner

BevelOuter

BevelWidth

BorderStyle

BorderWidth

FullRepaint

Locked

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TPanel プロパティ3334003

TPanel	オブジェクト順	凡例

Align

Alignment

BevelInner

BevelOuter

BevelWidth

BorderStyle

BorderWidth

BoundsRect

Brush

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Font

FullRepaint

Handle

Height

HelpContext

Hint

Left

Locked

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TPanel イベント3334004

TPanel	アルファベット順	凡例

TCustomPanel からの継承

OnResize

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TPanel イベント3334005

TPanel	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnMouseDown

OnMouseMove

OnMouseUp

OnResize

OnStartDrag


TPanel メソッド3334006

TPanel	アルファベット順

TCustomPanel からの継承

Create

TCustomControl からの継承

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TPanel メソッド3334007

TPanel	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


スコープ3334008

published

読み出し／書き込み

読み出し専用


スコープ3334009

published


継承3334010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomPanel


TPanel 例3334011

TPanel


TParaAttributes
TParaAttributes3335001

継承	プロパティ	メソッド	参照

TParaAttributes は，TRichEdit のパラグラフ属性プロパティを表すヘルパーオブジェクトです。

ユニット

comctrls

説明

TParaAttributes オブジェクトは，書式付きテキストドキュメント内のパラグラフの書式属性を示すプロパティを多数保持しています。TParaAttributes オブジェクトを使うと，選択されたパラグラフの書式属性を TCustomRichEdit の派生オブジェクトで取得できます。TParaAttiributes オブジェクトは，TCustomRichEdit の下位オブジェクトに属していない限り，そのプロパティは使用できません。


TParaAttributes プロパティ3335002

TParaAttributes	アルファベット順

TParaAttributes

Alignment

FirstIndent

LeftIndent

Numbering

RightIndent

Tab

TabCount


TParaAttributes プロパティ3335003

TParaAttributes	オブジェクト順

Alignment

FirstIndent

LeftIndent

Numbering

RightIndent

Tab

TabCount


TParaAttributes.Alignment
TParaAttributes.Alignment3335004

TParaAttributes	参照

Alignment プロパティは，パラグラフ内でテキストを位置合わせする方法を指定します。

property Alignment: TAlignment;

説明

Alignment プロパティは，パラグラフ内のテキストの位置合わせを指定できます。TCustomMemo オブジェクトの Alignment プロパティはテキスト全体に適用されますが，TParaAttiributes オブジェクトの Alignment プロパティは選択されたパラグラフにのみ適用されます。

以下に TParaAttiributes オブジェクトの Alignment プロパティの値を示します。

値	意味

taLeftJustify	テキストをコントロールの左端に揃える

taCenter	テキストをコントロールの横方向に中央揃えする

taRightJustify	テキストをコントロールの右端に揃える


TParaAttributes.FirstIndent
TParaAttributes.FirstIndent3335005

TParaAttributes	参照

FirstIndent プロパティは，パラグラフの 1 行目の左余白からのインデントサイズをピクセル単位で指定します。

property FirstIndent: Longint;

説明

FirstIndent プロパティは，パラグラフの 1 行目をインデントするピクセル数を指定できます。この値は，LeftIndent プロパティの値に関連します。


TParaAttributes.LeftIndent
TParaAttributes.LeftIndent3335006

TParaAttributes	参照

LeftIndent プロパティは，左マージンからのインデントサイズをピクセル単位で指定します。

property LeftIndent: Longint;

説明

LeftIndent プロパティは，パラグラフを本文全体のマージンよりインデントすることができます。LeftIndent プロパティは，テキスト内でパラグラフを目立たせるのに便利です。

注意

Numbering プロパティに nsBullet を指定している場合も，左インデントに影響があります。


TParaAttributes.Numbering
TParaAttributes.Numbering3335007

TParaAttributes	参照

Numbering プロパティは，パラグラフのナンバリングオプションの指定値を示します。

property Numbering: TNumberingStyle;

説明

パラグラフの左側に黒丸を挿入し，黒丸のためのインデントを設定するには，Numbering プロパティの値を nsBullet にします。LeftIndent プロパティが設定されている場合，黒丸は LeftIndent プロパティによるインデント部分に表示され，パラグラフの本文のインデントはさらに深くなります。

Numbering プロパティの値を以下に示します。

値	意味

nsNone	左側をインデントしない

nsBullet	黒丸スタイルのナンバリングを指定する。黒丸用に十分なインデントを施す


TParaAttributes.RightIndent
TParaAttributes.RightIndent3335008

TParaAttributes	参照

RightIndent プロパティは，右マージンからのインデントサイズをピクセル単位で指定します。

property RightIndent: Longint;

説明

RightIndent プロパティは，パラグラフを本文全体の右マージンよりインデントすることができます。RightIndent プロパティは，テキスト内でパラグラフを目立たせるのに便利です。Alignment プロパティの値が taRightJustify のときに特に便利です。


TParaAttributes.Tab
TParaAttributes.Tab3335009

TParaAttributes	参照

Tab プロパティは，タブの位置をピクセル単位で指定します。

property Tab[Index: Byte]: Longint;

説明

Tab プロパティは，タブの絶対位置の配列を示す添字付きプロパティです。1 番目のタブ位置は Tab[0]，2 番目のタブ位置は Tab[1] で，以下 Tab[TabCount - 1] という風に続きます。

Tab プロパティを設定するとき，TabCount の値を元にした Index の値が目的のタブ位置を示します。Index の値が TabCount の値以上であれば，パラグラフ内のタブの数が増え，TabCount プロパティの値が変更されます。

注意

Tab プロパティを設定してもパラグラフのテキストにタブは挿入されません。Tab プロパティは，パラグラフ内のタブを挿入できる位置を設定します。実際のタブ文字を入力するには〔Tab〕を押します。


TParaAttributes.TabCount
TParaAttributes.TabCount3335010

TParaAttributes	参照

TabCount プロパティは，パラグラフに定義されているタブ位置の数を示します。

property TabCount: Integer;

説明

TabCount プロパティを読み出すと，Tab 配列内のタブの数を調べることができます。TabCount プロパティと Tab プロパティを使って，パラグラフに定義されているすべてのタブを反復することができます。


TParaAttributes メソッド3335011

TParaAttributes	アルファベット順

TParaAttributes

Assign

Create

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TParaAttributes メソッド3335012

TParaAttributes	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TParaAttributes.Assign
TParaAttributes.Assign3335013

TParaAttributes	参照

Assign メソッドは，TParaAttributes オブジェクトのすべてのプロパティ値を他の TParaAttributes オブジェクトのプロパティ値に設定します。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドを使うと，書式付き編集コントロールから選択したパラグラフのパラグラフ属性を，別の書式付き編集コントロールで選択したパラグラフの属性と一致させることができます。TParaAttributes オブジェクトのプロパティは TParaAttributes が書式付き編集コントロール内に存在する場合にのみ有効なので，Assign メソッドは書式付き編集コントロール間で属性をコピーするのに便利です。

注意

Assign メソッドは，実行時に Source が TParaAttributes オブジェクトであるか，TParaAttributes オブジェクトで有効な AssignTo メソッドを持つオブジェクトである場合にのみ成功します。他のソースオブジェクトでは EConvertError 例外が生成されます。


TParaAttributes.Create
TParaAttributes.Create3335014

TParaAttributes	参照

Create メソッドは，TParaAttributes のインスタンスを作成します。

constructor Create(AOwner: TCustomRichEdit);

説明

TParaAttributes オブジェクトのコンストラクタを呼び出さないでください。TCustomRichEdit オブジェクトの外側では TParaAttributes オブジェクトのプロパティは無効だからです。Create メソッドは，TParaAttributes オブジェクトを使用する書式付き編集コントロールのコンストラクタから呼び出されます。


継承3335015

TObject

TPersistent


TParaAttributes 例3335016

TParaAttributes


TParam
TParam3336001

継承	プロパティ	メソッド	参照

TParam オブジェクトは項目パラメータを表します。

ユニット

dbtables

説明

TParam オブジェクトのプロパティを使うと，項目の値を表すパラメータの値を設定できます。項目の値としてパラメータを使うオブジェクトは，パラメータを表す TParam オブジェクトを作成します。たとえば，TParams オブジェクトは TQuery オブジェクトおよび TStoredProc オブジェクトによって使われます。

TParam オブジェクトと TField オブジェクトには，データセットの項目の値を記述する多くの同じプロパティがあります。ただし TField オブジェクトには，TParam オブジェクトでは必要のない項目の結合や，項目の表示・編集・演算の方法を記述するプロパティがあります。逆に，TParam オブジェクトには項目の値がどのようにパラメータとして渡されるかを示すプロパティがあります。


TParam のプロパティ3336002

TParam	アルファベット順	凡例

TParam

AsBCD

AsBlob

AsBoolean

AsCurrency

AsDate

AsDateTime

AsFloat

AsInteger

AsMemo

AsSmallInt

AsString

AsTime

AsWord

Bound

DataType

IsNull

Name

ParamType

Text

Value


TParam のプロパティ3336003

TParam	オブジェクト順	凡例

AsBCD

AsBlob

AsBoolean

AsCurrency

AsDate

AsDateTime

AsFloat

AsInteger

AsMemo

AsSmallInt

AsString

AsTime

AsWord

Bound

DataType

IsNull

Name

ParamType

Text

Value


TParam.AsBCD
TParam.AsBCD3336004

TParam	参照

AsBCD プロパティは，2 進化 10 進数（BCD）型項目の値を表す場合のパラメータの値です。

property AsBCD: Currency;

説明

BCD 型項目の値をパラメータに代入するには，AsBCD プロパティを設定します。AsBCD プロパティは実際には BCD 値を取りません。BCD 型項目オブジェクトは Currency 型を使って BCD 項目の値を表すので，AsBCD プロパティは Currency 値をとります。AsBCDプロパティ を設定すると，DataType プロパティが ftBCD に設定されます。

AsBCD プロパティを読み出すと，出力パラメータに代入されていた値が Currency 型で返されます。可能ならば，パラメータの値は Currency 値に変換されます。


TParam.AsBlob
TParam.AsBlob3336005

TParam	参照

AsBlob プロパティは，それがバイナリ大規模オブジェクト（BLOB）項目を表すときのパラメータ値です。

TBlobData = string;

property AsBlob: TBlobData;

説明

AsBlob プロパティを設定すると，BLOB 項目の値をパラメータに代入できます。AsBlob は TBlobData の値を受け取り，その値はバイトの型なし文字列です。AsBlob を設定すると DataType プロパティが ftBlob に設定されます。

BLOB 項目は出力パラメータとして使えないので，アプリケーションで AsBlob を呼び出す必要はほとんどありません。


TParam.AsBoolean
TParam.AsBoolean3336006

TParam	参照

AsBoolean プロパティは，論理型項目の値を表す場合のパラメータの値です。

property AsBoolean: Boolean;

説明

論理型項目の値をパラメータに代入するには，AsBoolean プロパティを設定します。AsBoolean プロパティを設定すると，DataType プロパティが ftBoolean に設定されます。

AsBoolean プロパティは，出力パラメータに代入される値が論理型で取得できます。可能ならば，パラメータの値は論理値に変換されます。


TParam.AsCurrency
TParam.AsCurrency3336007

TParam	参照

AsCurrency プロパティは，金額型項目の値を表す場合のパラメータの値です。

property AsCurrency: Double;

説明

金額型項目の値をパラメータに代入するには，AsCurrency プロパティを設定します。AsCurrency プロパティを設定すると，DataType プロパティが ftCurrency に設定されます。

AsCurrency プロパティは，出力パラメータに代入される値が Double 型で取得できます。可能ならば，パラメータの値は Double 値に変換されます。

注意

AsCurrency プロパティを Currency データ型と混同しないでください。データベーステーブルの通貨型項目は値を Double 型で格納します。AsBCD プロパティはパラメータの値を Currency データ型で表します。


TParam.AsDate
TParam.AsDate3336008

TParam	参照

AsDate プロパティは，日付型項目の値を表す場合のパラメータの値です。

property AsDate: TDateTime;

説明

日付型項目の値をパラメータに代入するには，AsDate プロパティを設定します。AsDate プロパティを設定すると，DataType プロパティが ftDate に設定されます。

AsDate プロパティは，出力パラメータに代入された値が TDateTime 型で取得できます。可能ならば，パラメータの値は TDateTime 値に変換されます。パラメータの DataType が ftDate の場合，TDateTime 値の日付部分だけが有効です。

TDateTime 型は日付型項目オブジェクトによって値を保持するために使われる Double 値です。実際には，TDateTime 型は日付型項目で必要な以上の情報を持っています。日付型項目が必要とするのは，TDateTime 値の日付部分だけです。

TDateTime 値の整数部は 1899年12月30日から経過した日数です。TDateTime 値の小数部は 1 日 24 時間の経過部分です。

注意

Delphi 1.0 では日付を 1899 からではなく 1 から計算していました。Delphi 1.0 の日付から変換するには，Delphi 1.0 の日付から 693594.0 を減算してください。この変更は OLE オートメーションと互換性を確保するためです。


TParam.AsDateTime
TParam.AsDateTime3336009

TParam	参照

AsDateTime プロパティは，日付時刻型項目を表す場合のパラメータの値です。

property AsDateTime: TDateTime;

説明

日付時刻型項目の値をパラメータに代入するには，AsDateTime プロパティを設定します。AsDateTime プロパティを設定すると，DataType プロパティが ftDateTime に設定されます。

AsDateTime プロパティは，出力パラメータに代入された値が TDateTime 型で取得できます。可能ならば，パラメータの値は TDateTime 値に変換されます。

TDateTime 型は日付時刻型項目オブジェクトによって値を保持するために使われる Double 値です。TDateTime 値の整数部は 1899年12月30日から経過した日数です。TDateTime 値の小数部は 1 日 24 時間の経過部分です。

注意

Delphi 1.0 では日付を 1899 からではなく 1 から計算していました。Delphi 1.0 の日付から変換するには，Delphi 1.0 の日付から 693594.0 を減算してください。この変更は OLE オートメーションと互換性を確保するためです。


TParam.AsFloat
TParam.AsFloat3336010

TParam	参照

AsFloat プロパティは，浮動小数点数値型項目の値を表す場合のパラメータの値です。

property AsFloat: Double;

説明

浮動小数点数値型項目の値をパラメータに代入するには，AsFloat プロパティを設定します。AsFloat プロパティを設定すると，DataType プロパティが ftFloat に設定されます。

AsFloat プロパティは，出力パラメータに代入された値が Double 型で取得できます。可能ならば，パラメータの値は Double 値に変換されます。


TParam.AsInteger
TParam.AsInteger3336011

TParam	参照

AsInteger プロパティは，32 ビット整数型項目の値を表す場合のパラメータの値です。

property AsInteger: LongInt;

説明

32 ビット整数型項目の値をパラメータに代入するには，AsInteger プロパティを設定します。AsInteger プロパティを設定すると，DataType プロパティが ftInteger に設定されます。

AsInteger プロパティは，出力パラメータの値が 32 ビット整数型で取得できます。可能ならば，パラメータの値は LongInt 値に変換されます。


TParam.AsMemo
TParam.AsMemo3336012

TParam	参照

AsMemo プロパティは，それがメモ項目を表すときのパラメータ値です。

property AsMemo: string;

説明

AsMemo プロパティを設定するとメモ項目の値をパラメータに代入できます。AsMemo を設定すると DataType プロパティが ftMemo に設定されます。メモ項目は出力パラメータとして使えないので AsMemo を呼び出す必要はほとんどありません。

注意

サーバーによっては，長すぎてレコードバッファに合わない文字列項目型をサポートします。これらの項目は実際には BLOB ではありませんが，メモ項目として表されます。このような「疑似 BLOB 」項目を処理する場合，AsString プロパティを使います。


TParam.AsSmallInt
TParam.AsSmallInt3336013

TParam	参照

AsSmallInt プロパティは，16 ビット整数型項目の値を表す場合のパラメータの値です。

property AsSmallInt: LongInt;

説明

16 ビット整数型項目の値をパラメータに代入するには，AsSmallInt プロパティを設定します。AsSmallInt プロパティを設定すると，DataType プロパティが ftSmallint に設定されます。

AsSmallInt プロパティは，出力パラメータに代入された値が 32 ビット整数型で取得できます。可能ならば，パラメータの値は LongInt 値に変換されます。

注意

AsSmallInt プロパティは 32 ビット整数を扱います。16 ビット整数型項目オブジェクトは，元のデータベースの値が 16 ビット整数であっても，データを 32 ビット整数として格納し，操作します。


TParam.AsString
TParam.AsString3336014

TParam	参照

AsString プロパティは，文字列型項目の値を表す場合のパラメータの値です。

property AsString: string;

説明

文字列型項目の値をパラメータに代入するには，AsString プロパティを設定します。AsString プロパティを設定すると，DataType プロパティが ftString に設定されます。

AsString プロパティは，出力パラメータに代入された値が文字列で取得できます。パラメータの値は文字列に変換されます。

注意

AsSmallInt は 32 ビット整数を扱います。small 型整数項目オブジェクトは，基になるデータベースが 16 ビットの場合でも，データを 32 ビット整数として格納し操作します。


TParam.AsTime
TParam.AsTime3336015

TParam	参照

AsTime プロパティは，時刻型項目の値を表す場合のパラメータの値です。

property AsDate: TDateTime;

説明

時刻型項目の値をパラメータに代入するには，AsTime プロパティを設定します。AsTime プロパティを設定すると，DataType プロパティが ftTime に設定されます。

AsTime プロパティは，出力パラメータに代入された値が TDateTime 型で取得できます。可能ならば，パラメータの値は TDateTime 値に変換されます。パラメータの DataType プロパティが ftTime の場合，TDateTime 値の時刻部分だけが有効です。

TDateTime 型は日付型項目オブジェクトによって値を保持するために使われる Double 値です。実際には，TDateTime 型は時刻型項目で必要な以上の情報を持っています。時刻型項目で必要なのは TDateTime 値の時刻部分だけです。

TDateTime 値の整数部は 1899年12月30日から経過した日数です。TDateTime 値の小数部は 1 日 24 時間の経過部分です。


TParam.AsWord
TParam.AsWord3336016

TParam	参照

AsWord プロパティは 16 ビット符号なし整数項目の値を表す場合のパラメータの値です。

property AsWord: LongInt;

説明

16 ビット符号なし整数項目の値をパラメータに代入するには，AsWord プロパティを設定します。AsWord プロパティを設定すると，DataType プロパティが ftWord に設定されます。

AsWord プロパティは，出力パラメータに代入された値が 32 ビット整数型で取得できます。可能ならば，パラメータの値は LongInt 値に変換されます。

注意

AsWord プロパティは 32 ビット整数を扱います。Word 型項目オブジェクトは，元のデータベースの値が符号なし 16 ビット値であっても，データを 32 ビット整数として格納し，操作します。


TParam.Bound
TParam.Bound3336017

TParam	参照

Bound プロパティは，値（ヌルまたはそれ以外）がパラメータに代入されているかどうかを示します。

property Bound: Boolean;

説明

Bound プロパティは，値がパラメータに代入されているかどうかがわかります。値が TParam オブジェクトに代入されるときには，必ず Bound プロパティが自動的に True に設定されます。Bound プロパティを変更すると値の設定を取り消すことができます。Clear メソッドはパラメータの値をヌルに置き換えますが，Bound プロパティを False に設定することはありません。Clear メソッドを使ってパラメータをヌル値に設定する場合，別に Bound プロパティを True に設定しなければなりません。

TQuery オブジェクトと TStoredProc オブジェクトは，Bound プロパティの値を使ってパラメータにデフォルト値を代入するかどうかを決めます。Bound プロパティが False の場合，TQuery オブジェクトは DataSource プロパティによって示されたデータセットから値を代入します。同様に，Bound プロパティが False の場合，TStoredProc オブジェクトはサーバーから直接に値を供給します。


TParam.DataType
TParam.DataType3336018

TParam

DataType プロパティは，パラメータが値を表す項目の型を示します。

TFieldType = (ftUnknown, ftString, ftSmallint, ftInteger, ftWord, ftBoolean, ftFloat,

  ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftBytes, ftVarBytes, ftAutoInc,

  ftBlob, ftMemo, ftGraphic, ftFmtMemo, ftParadoxOle, ftDBaseOle, ftTypedBinary, ftCursor);

property DataType: TFieldType;

説明

DataType プロパティは，パラメータに値が代入されると自動的に設定されます。結び付きのある項目に DataType プロパティを設定しないでください。代入された値の解釈に間違いが生じる可能性があります。

DataType プロパティを読み出すと，パラメータに代入されたデータの型がわかります。DataType プロパティに使用される各値はデータベース項目の型に対応します。以下に使用される値を示します。

値	意味

ftUnkown	未知または未定

ftString	文字または文字列項目

ftSmallint	16 ビット整数項目

ftInteger	32 ビット整数項目

ftWord	16 ビット符号なし整数項目

ftBoolean	論理項目

ftFloat	浮動小数点数値型項目

ftCurrency	金額型項目

ftBCD	2 進化 10 進数型項目

ftDate	日付型項目

ftTime	時刻型項目

ftDateTime	日付時刻型項目

ftBytes	固定長バイト型項目（バイナリ格納）

ftVarBytes	可変長バイト型項目（バイナリ格納）

ftAutoInc	自動インクリメント 32 ビット整数カウンタ型項目

ftBlob	BLOB 項目

ftMemo	テキストメモ項目

ftGraphic	ビットマップ項目

ftFmtMemo	書式付きメモ項目

ftParadoxOle	Paradox OLE 項目

ftDBaseOle	dBASE OLE 項目

ftTypedBinary	型付きバイナリ項目

ftCursor	ストアドプロシージャからの出力カーソル（Oracle のみ）


TParam.IsNull
TParam.IsNull3336019

TParam	参照

IsNull プロパティは，パラメータに代入されている値がヌル（空白）かどうかを示します。

property IsNull: Boolean;

説明

IsNull プロパティは，パラメータの値がヌル（空白項目の値）かどうか取得できます。ヌル値になるのは以下の場合です。

・	ほかのヌルパラメータの値を代入した

・	空白項目の値を代入した

・	Clear メソッドを呼び出した

注意

ヌルパラメータは，結び付きのないパラメータと同じではありません。結び付きのないパラメータには値が代入されていませんが，ヌルパラメータにはヌル値が代入されています。ヌルパラメータは結び付きのある場合とそうでない場合があります。


TParam.Name
TParam.Name3336020

TParam	参照

Name プロパティは，パラメータの名前を指定します。

property Name: string;

説明

Name プロパティは，TParams オブジェクト内の特定のパラメータを識別できます。Name はパラメータの名前であり，パラメータが値を表す項目の名前ではありません。


TParam.ParamType
TParam.ParamType3336021

TParam

ParamType プロパティは，TParam オブジェクトが表すパラメータの型を示します。

TParamType = (ptUnknown, ptInput, ptOutput, ptInputOutput, ptResult);

property ParamType: TParamType;

説明

項目パラメータを表すために TParam オブジェクトを使うオブジェクトは，ParamType プロパティを設定してパラメータの使い方を示します。以下に ParamType の値を示します。

値	意味

ptUnknown	未知または未定

ptInput	項目値を入力するために使用

ptOutput	項目値を出力するために使用

ptInputOutput	入力および出力の両方で使用

ptResult	戻り値として使用


TParam.Text
TParam.Text3336022

TParam	参照

Text プロパティは，パラメータの値を文字列で表します。

property Text: string;

説明

Text プロパティを設定するには，DataType を変更せずにパラメータの値を文字列に代入します。DataType を変更する AsString プロパティと違って，Text プロパティを設定すると，文字列がパラメータの DataType に変換され，それに応じて値が設定されます。文字列項目の値を表すものとしてパラメータを扱うには AsString プロパティを使います。項目型について何の仮定もしないで，文字列形式の値を代入する場合は，かわりに Text プロパティを使います。たとえば，編集コントロールを使って入力されたユーザーデータを代入する場合に便利です。

Text プロパティを取得することは，AsString プロパティを取得することと同じです。


TParam.Value
TParam.Value3336023

TParam	参照

Value プロパティは，パラメータの値を Variant 型で表します。

property Value: Variant;

説明

パラメータが表す項目の型を知る必要がなく，パラメータの値を操作する汎用コードでは Value プロパティを使います。


TParam メソッド3336024

TParam	アルファベット順

TParam

Assign

AssignField

AssignFieldValue

Clear

Create

Destroy

GetData

GetDataSize

LoadFromFile

LoadFromStream

SetBlobData

SetData

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TParam のメソッド3336025

TParam	オブジェクト順

Assign

AssignField

AssignFieldValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetData

GetDataSize

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

SafeCallException

SetBlobData

SetData


TParam.Assign
TParam.Assign3336026

TParam	参照

Assign メソッドは，ほかの TParam オブジェクトの Name および Value をコピーします。

procedure Assign(Param: TParam);

説明

Assign メソッドを呼び出すと，別のパラメータまたは別の項目コンポーネントからコピーできます。Source パラメータが別のパラメータの場合，Assign メソッドは以下のプロパティの値を転送します。

・	DataType プロパティ

・	Bound プロパティ

・	Value プロパティ

・	Name プロパティ

・	ParamType プロパティ（現在 ftUnknown の場合のみ）

Source パラメータが項目コンポーネントの場合，Assign メソッドは以下のプロパティの値を転送します。

・	DataType プロパティ

・	Value プロパティ

・	Name プロパティ（項目の FieldName）

項目から値を代入するときは，Assign は Bound プロパティを True に設定します。

注意

Assign メソッドはパラメータの使い方を変更せず，その識別子と値だけを変更します。


TParam.AssignField
TParam.AssignField3336027

TParam	参照

AssignField メソッドは，TField オブジェクトから DataType，Name，および Value の各プロパティを代入します。

procedure AssignField(Field: TField);

説明

AssignField メソッドを呼び出すと，パラメータがある特定の TField オブジェクトを表すように設定できます。AssignField メソッドは Bound プロパティを True に設定します。

AssignFieldValue メソッドと違い，AssignField メソッドは，値だけでなくその項目オブジェクトの名前も設定します。


TParam.AssignFieldValue
TParam.AssignFieldValue3336028

TParam	参照

AssignFieldValue メソッドは，TField オブジェクトから DataType および Value プロパティを代入します。

procedure AssignFieldValue(Field: TField; const Value: Variant);

説明

AssignFieldValue を呼び出すと，Value プロパティを Value パラメータとして渡された値に設定できます。AssignFieldValue は，Value が Field パラメータのような項目の値を表しているものとみなし，それに応じて DataType プロパティを割り当てます。AssignFieldValue メソッドは Bound プロパティを True に設定します。

AssignField メソッドと違い，AssignFieldValue メソッドは項目オブジェクトの名前を設定することはありません。


TParam.Clear
TParam.Clear3336029

TParam	参照

Clear メソッドは，パラメータの値をヌルに設定します。

procedure Clear;

説明

Clear メソッドを呼び出すと，パラメータにヌル値を代入できます。Clear メソッドを呼び出しても，Bound プロパティには何の影響もありません。ヌル値をパラメータに代入する場合は，Clear メソッドを呼び出すと同時に Bound プロパティも設定します。


TParam.Create
TParam.Create3336030

TParam	参照

Create メソッドは，TParam オブジェクトのインスタンスを作成し，それをパラメータリストに挿入します。

constructor Create(AParamList: TParams; AParamType: TParamType);

説明

Create メソッドを呼び出すと，TParam オブジェクトをインスタンスを作成できます。TParam オブジェクトは通常，項目パラメータを表すために TQuery や TStoredProc などのオブジェクトによって作成されます。

Create メソッドは，TParam オブジェクトのインスタンスにメモリを割り当ててから以下の処理を行います。

・	新しい TParam オブジェクトを AParamList に追加する

・	ParamType プロパティを AParamType に設定する

・	DataType プロパティを ftUnknown に初期化する

・	Bound プロパティを False に設定する


TParam.Destroy
TParam.Destroy3336031

TParam	参照

Destroy メソッドは，TParam のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TParam オブジェクトがまだ解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

TParam のインスタンスに割り当てられたメモリを解放する前に，Destroy メソッドはパラメータリストから TParam オブジェクトを削除します。


TParam.GetData
TParam.GetData3336032

TParam	参照

GetData メソッドは，適切な型のデータベース項目のネイティブ形式でパラメータの値をバッファにコピーします。

procedure GetData(Buffer: Pointer);

説明

GetData メソッドを呼び出すと，レコードバッファに直接書き込まれる形式でパラメータの値を取得できます。この形式は，DataType に対応する物理データベース項目で使われる形式です。バッファにはその情報を保持するだけの十分なスペースが必要です。GetDataSize メソッドを使うと，必要なサイズが取得できます。

データベース項目のネイティブ形式は，対応する項目オブジェクトで使われるデータ型とは違う場合があります。As... プロパティを使うと，対応する項目オブジェクトで使われるデータ型で値を取得できます。GetData メソッドを使うと，ネイティブデータベース形式で値を取得できます。

たとえば DataType プロパティが ftBCD の場合，GetData メソッドは，TBCDField オブジェクトが Currency を使って値を格納および操作する場合でも，2 進化 10進数値で値を取り出します。AsBCD メソッドは Currency 型で値を取得します。


TParam.GetDataSize
TParam.GetDataSize3336033

TParam	参照

GetDataSize メソッドは，対応する型のデータベース項目で使われている形式でパラメータの値を保持するために必要なバイト数を返します。

function GetDataSize: Integer;

説明

GetDataSize メソッドを呼び出すと，パラメータの値を表すために必要なバイト数を調べられます。GetDataSize メソッドは GetData メソッドを呼び出す前に必要なバッファサイズを示します。GetDataSize メソッドによって返される値はパラメータの Value プロパティに依存します。DataType の値によっては返される値は常に同じです。

データ型	データサイズの値

ftBoolean	2

ftSmallInt	2

ftWord	2

ftAutoInc	4

ftDate	4

ftInteger	4

ftTime	4

ftCurrency	8

ftDateTime	8

ftFloat	8

ftBCD	34

ftString	文字列 + 1 の長さ

ftVarBytes	EDatabaseError 例外を生成する

ftBytes	EDatabaseError 例外を生成する

ftBlob	BLOB データのバイト数

ftDBaseOle	BLOB データのバイト数

ftFmtMemo	BLOB データのバイト数

ftGraphic	BLOB データのバイト数

ftMemo	メモ文字列 + 1 の長さ

ftParadoxOle	BLOB データのバイト数

ftTypedBinary	EDatabaseError 例外を生成する

ftUnknown	EDatabaseError 例外を生成する

ftCursor	0

注意

GetDataSize メソッドによって返されるサイズは，Value をデータベース項目の物理的な表現に必要なサイズです。そのデータベースの物理項目に対応する項目オブジェクトは，異なるバイト数を要するほかの形式でそのデータを格納する場合があります。


TParam.LoadFromFile
TParam.LoadFromFile3336034

TParam	参照

LoadFromFile メソッドは，指定されたファイルから BLOB パラメータの値をロードします。

TBlobType = ftBlob..ftTypedBinary;

procedure LoadFromFile(const FileName: string; BlobType: TBlobType);

説明

LoadFromFile メソッド呼び出すと，FileName で指定されたファイルに格納されている値の BLOB パラメータの値を設定できます。DataType プロパティは，BlobType パラメータとして渡された値に設定されます。


TParam.LoadFromStream
TParam.LoadFromStream3336035

TParam	参照

LoadFromStream メソッドは，ストリームから BLOB パラメータの値をロードします。

TBlobType = ftBlob..ftTypedBinary;

procedure LoadFromStream(Stream: TStream; BlobType: TBlobType);;

説明

LoadFromStream メソッドを呼び出すと，Stream パラメータで指定されたストリームから読み出した値の BLOB パラメータの値を設定できます。たとえば，TBlobStream オブジェクトから直接 BLOB パラメータの値を設定するときに LoadFromStream を使います。DataType プロパティは，BlobType パラメータとして渡された値に設定されます。


TParam.SetBlobData
TParam.SetBlobData3336036

TParam	参照

SetBlobData メソッドは，物理データベース形式でパラメータに新しい値を Buffer からコピーします。

procedure SetBlobData(Buffer: Pointer; Size: Integer);

説明

SetBlobData メソッドを呼び出すと，バイナリ大規模オブジェクト（BLOB）の値を格納するバッファからパラメータの値を設定できます。SetBlobData は Buffer パラメータで指定されたバッファから Size パラメータで指定されたバイト数だけをコピーして，DataType プロパティを ftBlob に設定します。


TParam.SetData
TParam.SetData3336037

TParam	参照

SetData メソッドは，バッファからデータベースの物理形式でパラメータの新しい値をコピーします。

procedure SetData(Buffer: Pointer);

説明

SetData メソッドを呼び出すと，物理データベース形式でデータを格納しているバッファからパラメータの値を設定できます。TField オブジェクトの GetData メソッドは，物理データベース形式でデータを取り出します。また，ボーランドデータベースエンジン（BDE）API 呼び出しも物理データベース形式でデータを提供できます。

注意

DataType プロパティが ftUnknown，ftBytes，ftVarBytes，ftAutoInc，ftBlob，ftGraphic，ftFmtMemo，ftParadoxOle，ftDBaseOle，または ftTypedBinary の場合，SetData は EDatabaseError 例外を生成します。BLOB 項目の場合は，SetBlobData メソッドを使ってください。


読み出し／書き込み3336038

読み出し専用


継承3336039

TObject

TPersistent


TParam の例3336040

TParam


TParams
TParams3337001

継承	プロパティ	メソッド	参照

TParams オブジェクトは項目パラメータのリストを管理します。

ユニット

dbtables

説明

TParams オブジェクトは，項目パラメータを使うオブジェクトのための TParam オブジェクトのリストを管理します。たとえば，TStoredProc オブジェクトと TQuery オブジェクトは TParams オブジェクトを使ってパラメータを作成し，パラメータにアクセスします。

TParams オブジェクトのプロパティとメソッドの用途を以下に示します。

・	特定の項目パラメータにアクセスする

・	リストに項目パラメータを追加，またはリストから項目パラメータを削除する

・	個々の項目パラメータの値を取得または設定する

・	項目パラメータを比較する

・	すべての項目パラメータを処理する

・	項目パラメータのセットを他のパラメータリストにコピーする


TParams プロパティ3337002

TParams	アルファベット順	凡例

TParams

Items

ParamValues


TParams プロパティ3337003

TParams	オブジェクト順	凡例

Items

ParamValues


TParams.Items
TParams.Items3337004

TParams	参照

Items プロパティは，TParams オブジェクトの個々の項目パラメータを保持します。

property Items[Index: Word]: TParam;

説明

Items プロパティを使うと，すべての項目パラメータを処理できます。Index は 0 から Count - 1 の範囲のインデックスです。Items プロパティを使うと特定のパラメータをそのインデックスによって参照できるのに対し，ParamByName メソッドはパラメータの順序に依存したくない場合に適しています。


TParams.ParamValues
TParams.ParamValues3337005

TParams	参照

ParamValues プロパティは，名前で識別される個々の項目パラメータの値を保持するバリアント配列です。

property ParamValues[const ParamName: string]: Variant;

説明

ParamValues プロパティを使うと，名前によって識別される個々の項目パラメータの値を取得または設定できます。ParamName プロパティは個々の項目パラメータの名前で構成される文字列です。複数の項目パラメータにアクセスする場合，それらの名前はセミコロン（;）で区切ります。

ParamValues プロパティを設定すると，ParamName 文字列でリストされている各パラメータの Value プロパティが設定されます。それらの値をバリアントとしてバリアント配列で順番に指定します。

ParamValues プロパティを取得すると，バリアントのバリアント配列が取り出せます。各バリアントは指定のパラメータの 1 つの値を表します。

ParamName プロパティに Items の項目パラメータのどれにも適合しない名前が含まれている場合は例外が生成されます。


TParams メソッド3337006

TParams	アルファベット順

TParams

AddParam

Assign

AssignValues

Clear

Count

Create

CreateParam

Destroy

GetParamList

IsEqual

ParamByName

RemoveParam

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TParams メソッド3337007

TParams	オブジェクト順

AddParam

Assign

AssignValues

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Count

Create

CreateParam

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParamList

InheritsFrom

InitInstance

InstanceSize

IsEqual

MethodAddress

MethodName

NewInstance

ParamByName

RemoveParam

SafeCallException


TParams.AddParam
TParams.AddParam3337008

TParams	参照

AddParam メソッドは，新しい項目パラメータを Items リストに追加します。

procedure AddParam(Value: TParam);

説明

AddParam メソッドを呼び出すと，インスタンス化されたパラメータを Items リストに追加できます。項目パラメータを作成してリストに追加するには，CreateParam メソッドを使います。


TParams.Assign
TParams.Assign3337009

TParams	参照

Assign メソッドは，ほかのオブジェクトからパラメータリストをコピーします。

procedure Assign(Source: TPersistent);

説明

Assign メソッドを呼び出すと，パラメータのセットを保存および復元したり，ほかのオブジェクトの情報をコピーしたりできます。パラメータのコピー元となるオブジェクトを Source の値として指定します。Source がほかの TParams オブジェクトの場合，Assign メソッドは現在のパラメータ情報を破棄し，Source の項目パラメータのリストをコピーします。

単にソースオブジェクトのリストにある項目パラメータの値をコピーする AssignValues メソッドと違い，Assign メソッドは実際の項目パラメータ自体をコピーします。


TParams.AssignValues
TParams.AssignValues3337010

TParams	参照

AssignValues メソッドは，新しい値を Items プロパティのパラメータに代入します。

procedure AssignValues(Value: TParams);

説明

AssignValues メソッドは，Items リストにある項目パラメータの値を，別の TParams オブジェクトの対応する項目パラメータの値に更新します。Items のエントリごとに，AssignValues メソッドは Value 内で同じ Name プロパティを持つパラメータを探します。一致するパラメータが見つかると，Value パラメータからのパラメータ情報（型と現在のデータ）が Items エントリに代入されます。一致するもののない Items のエントリは変更されません。


TParams.Clear
TParams.Clear3337011

TParams	参照

Clear メソッドは，TParams オブジェクトの Items プロパティからすべてのパラメータ情報を削除します。

procedure Clear;

説明

Clear メソッドを呼び出すと，Items リストを空にできます。必要な項目パラメータオブジェクトだけがリストに含まれるようにするために，パラメータリストを作成する前に Clear メソッドを呼び出してください。


TParams.Count
TParams.Count3337012

TParams	参照

Count メソッドは，TParams オブジェクトの Items プロパティにあるエントリ数を返します。

function Count: Integer;

説明

Count メソッドを呼び出すと，TParams オブジェクトによって管理されているパラメータオブジェクトの数が得られます。Count メソッドは，Items リストにあるすべての項目パラメータを処理する場合に使われます。


TParams.Create
TParams.Create3337013

TParams	参照

Create メソッドは，TParams のインスタンスを作成します。

constructor Create; virtual;

説明

Create メソッドを呼び出すと，TParams オブジェクトをインスタンス化できます。ほとんどのアプリケーションでは TParams リストを作成する必要はありません。TParams オブジェクトを使う TQuery または TStoredProc オブジェクトによって作成されるからです。


TParams.CreateParam
TParams.CreateParam3337014

TParams	参照

CreateParam メソッドは，新しい項目パラメータオブジェクトを作成し，それを Items リストに追加します。

TFieldType = (ftUnknown, ftString, ftSmallint, ftInteger, ftWord, ftBoolean, ftFloat, ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftBytes, ftVarBytes, ftAutoInc, ftBlob, ftMemo, ftGraphic, ftFmtMemo, ftParadoxOle, ftDBaseOle, ftTypedBinary, ftCursor);

TParamType = (ptUnknown, ptInput, ptOutput, ptInputOutput, ptResult);

function CreateParam(FldType: TFieldType; const ParamName: string;

   ParamType: TParamType): TParam;

説明

CreateParam メソッドを呼び出すと，新しい TParam オブジェクトをインスタンス化し，TParams オブジェクトによって管理されている Items に追加できます。新しいパラメータの項目型を FldType の値に，パラメータの名前を ParamName の値に，そしてパラメータの型を ParamType の値に指定します。


TParams.Destroy
TParams.Destroy3337015

TParams	参照

Destroy メソッドは，TParams のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出すようにしてください。Free メソッドは TParams オブジェクトがまだ解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは Items リストを解放してから，継承されたデストラクタを呼び出します。


TParams.GetParamList
TParams.GetParamList3337016

TParams	参照

GetParamList メソッドは，ParamNames で指定された個々の TParam オブジェクトを TList オブジェクトにコピーします。

procedure GetParamList(List: TList; const ParamNames: string);

説明

GetParamList メソッドを呼び出すと，名前で識別されている Items リスト内の項目パラメータのサブセットが得られます。ParamNames には対象となるすべての項目パラメータの名前が文字列として入ります。複数のパラメータがある場合はセミコロン（;）で区切ります。

GetParamList メソッドは，項目パラメータを ParamNames の順番で List に追加します。ParamNames に Items のどの項目パラメータとも一致しない名前がある場合は例外が発生します。


TParams.IsEqual
TParams.IsEqual3337017

TParams	参照

IsEqual メソッドは，2 つの TParams オブジェクトが同じ Items を持っているかどうかを判断します。

function IsEqual(Value: TParams): Boolean;

説明

IsEqual メソッドは，Value パラメータの Items プロパティが Items プロパティと厳密に一致する場合に True を返します。一致するためには，各 Items リストに名前，データ型，パラメータ型，および値が一致する同じ数の項目パラメータが同じ順番でリストされていなければなりません。


TParams.ParamByName
TParams.ParamByName3337018

TParams	参照

ParamByName メソッドは，指定の名前でパラメータを検索します。

function ParamByName(const Value: string): TParam;

説明

ParamByName メソッドを呼び出すと，Value に指定された名前でパラメータを検索できます。一致するパラメータがある場合，ParamByName メソッドはそのパラメータを返します。一致するパラメータがない場合は例外が発生します。Items プロパティを直接に参照するよりもこのメソッドを使った方が，エントリの順番に対する依存を避けられます。

名前を使って一度に複数のパラメータを検索するには，かわりに GetParamList メソッドを使います。指定のパラメータの値だけを取得するには，ParamValues プロパティを使います。


TParams.RemoveParam
TParams.RemoveParam3337019

TParams	参照

RemoveParam メソッドは，TParams オブジェクトの Items プロパティから指定のパラメータを削除します。

procedure RemoveParam(Value: TParam);

説明

RemoveParam メソッドを呼び出すと，Items リストから項目パラメータを削除できます。RemoveParam メソッドはリストから Value を削除しますが，Value をメモリから解放することはありません。


読み出し／書き込み3337020

読み出し専用


継承3337021

TObject

TPersistent


TParams 例3337022

TParams


TPasswordDialog
TPasswordDialog3338001

継承	プロパティ	メソッド	イベント	参照

TPasswordDialog オブジェクトは，ユーザーが現在のセッションのパスワードを指定できるダイアログボックスです。

ユニット

dbpwdlg

説明

TPasswordDialog オブジェクトを使うと，ユーザーが現在のセッションのパスワードを指定できます（現在のセッションは TSession オブジェクトによって表される）。パスワードは，パスワードを要求する Paradox テーブルをアプリケーションが開いたときに使われます。テーブルが現在のセッションに追加されていないパスワードを要求する場合，ユーザーはそのパスワードを要求されます。

TPasswordDialog オブジェクトは通常 PasswordDialog 関数で作成されます。しかし，TPasswordDialog オブジェクトはほかの型のパスワードダイアログボックスの基本オブジェクトとしても使われます。


TPasswordDialog プロパティ3338002

TPasswordDialog	アルファベット順	凡例

TCustomForm からの継承

Active

ActiveControl

ActiveMDIChild

ActiveOleControl

BorderIcons

BorderStyle

Canvas

ClientHandle

ClientHeight

ClientRect

ClientWidth

Designer

DropTarget

FormStyle

HelpFile

Icon

KeyPreview

MDIChildCount

MDIChildren

Menu

ModalResult

ObjectMenuItem

OleFormObject

Parent

PixelsPerInch

Position

PrintScale

Scaled

TileMode

Visible

WindowMenu

WindowState

TScrollingWinControl からの継承

AutoScroll

HorzScrollBar

VertScrollBar

TWinControl からの継承

Brush

ClientOrigin

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

Color

ControlState

ControlStyle

Cursor

Enabled

Font

Height

Hint

Left

Name

ParentFont

PopupMenu

ShowHint

Top

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TPasswordDialog プロパティ3338003

TPasswordDialog	オブジェクト順	凡例

Active

ActiveControl

ActiveMDIChild

ActiveOleControl

Align

AutoScroll

BorderIcons

BorderStyle

BoundsRect

Brush

Canvas

Caption

ClientHandle

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

Designer

DesignInfo

DropTarget

Enabled

Font

FormStyle

Handle

Height

HelpContext

HelpFile

Hint

HorzScrollBar

Icon

KeyPreview

Left

MDIChildCount

MDIChildren

Menu

ModalResult

Name

ObjectMenuItem

OleFormObject

Owner

Parent

ParentFont

ParentWindow

PixelsPerInch

PopupMenu

Position

PrintScale

Scaled

ShowHint

Showing

TabOrder

TabStop

Tag

TileMode

Top

VCLComObject

VertScrollBar

Visible

Width

WindowMenu

WindowProc

WindowState


TPasswordDialog イベント3338004

TPasswordDialog	アルファベット順	凡例

TCustomForm からの継承

OnActivate

OnClose

OnCloseQuery

OnCreate

OnDeactivate

OnDestroy

OnHelp

OnHide

OnPaint

OnResize

OnShow

TWinControl からの継承

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnMouseDown

OnMouseMove

OnMouseUp


TPasswordDialog イベント3338005

TPasswordDialog	オブジェクト順	凡例

OnActivate

OnClick

OnClose

OnCloseQuery

OnCreate

OnDblClick

OnDeactivate

OnDestroy

OnDragDrop

OnDragOver

OnHelp

OnHide

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnPaint

OnResize

OnShow


TPasswordDialog メソッド3338006

TPasswordDialog	アルファベット順

TPasswordDialog

AddButtonClick

EditChange

OKButtonClick

RemoveAllButtonClick

RemoveButtonClick

TForm からの継承

ArrangeIcons

Cascade

Next

Previous

Tile

TCustomForm からの継承

Close

CloseQuery

Create

CreateNew

DefocusControl

Destroy

FocusControl

GetFormImage

Hide

Print

Release

SendCancelMode

SetFocus

SetFocusedControl

Show

ShowModal

WantChildKey

TScrollingWinControl からの継承

DisableAutoRange

EnableAutoRange

ScrollInView

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TPasswordDialog メソッド3338007

TPasswordDialog	オブジェクト順

AddButtonClick

ArrangeIcons

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

Cascade

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Close

CloseQuery

ContainsControl

ControlAtPos

Create

CreateNew

CreateParented

DefaultHandler

DefocusControl

Destroy

DestroyComponents

Destroying

DisableAlign

DisableAutoRange

Dispatch

DragDrop

Dragging

EditChange

EnableAlign

EnableAutoRange

EndDrag

FieldAddress

FindComponent

FocusControl

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetFormImage

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Next

OKButtonClick

PaintTo

Perform

Previous

Print

Realign

Refresh

Release

RemoveAllButtonClick

RemoveButtonClick

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

ScrollInView

SendCancelMode

SendToBack

SetBounds

SetFocus

SetFocusedControl

SetTextBuf

Show

ShowModal

Tile

Update

UpdateControlState

WantChildKey


TPasswordDialog.AddButtonClick
TPasswordDialog.AddButtonClick3338008

TPasswordDialog	参照

AddButtonClick メソッドは，［追加］ボタンがクリックされたときに何が起こるかを制御します。

procedure AddButtonClick(Sender: TObject);

説明

AddButtonClick メソッドは，TSession.AddPassword メソッドを呼び出して編集ボックスのパスワードを現在のセッションに追加します。次に AddButtonClick メソッドは編集ボックスをクリアしてフォーカスを設定します。

AddButtonClick メソッドが呼び出されると，その時点で編集ボックスにパスワードがあるかないかに関係なく，OKButton メソッドが使用可能になります。


TPasswordDialog.EditChange
TPasswordDialog.EditChange3338009

TPasswordDialog	参照

EditChange メソッドは，編集ボックスの内容が変更されたときに何が起こるかを制御します。

procedure EditChange(Sender: TObject);

説明

EditChange メソッドは，編集ボックスにパスワードがあるかないかに応じて［追加(A)］，［OK］，および［削除(R)］ボタンを使用可能または使用不可にします。編集ボックスにパスワードがある場合，これらのボタンは使用可能になり，それ以外の場合は使用不可になります。

注意

AddButtonClick メソッドが呼び出されると，編集ボックスにパスワードがあるかないかに関係なく［OK］ボタンが使用可能になります。


TPasswordDialog.OKButtonClick
TPasswordDialog.OKButtonClick3338010

TPasswordDialog	参照

OKButtonClick メソッドは，［OK］ボタンがクリックされたときに何が起こるかを制御します。

procedure OKButtonClick(Sender: TObject);

説明

OKButtonClick メソッドは，TSession.AddPassword メソッドを呼び出して編集ボックスにあるパスワードを現在のセッションに追加します。


TPasswordDialog.RemoveAllButtonClick
TPasswordDialog.RemoveAllButtonClick3338011

TPasswordDialog	参照

RemoveAllButtonClick メソッドは，現在のセッションからすべてのパスワードを削除します。

procedure RemoveAllButtonClick(Sender: TObject);

説明

RemoveAllButtonClick メソッドは，TSession.RemoveAllPasswords メソッドを呼び出して現在のセッションからすべてのパスワードを削除します。次に RemoveAllButtonClick メソッドはフォーカスを編集ボックスに設定します。


TPasswordDialog.RemoveButtonClick
TPasswordDialog.RemoveButtonClick3338012

TPasswordDialog	参照

RemoveButtonClick メソッドは，現在のセッションから編集ボックスのパスワードを削除します。

procedure RemoveButtonClick(Sender: TObject);

説明

RemoveButtonClick メソッドは，TSession.RemovePassword メソッドを呼び出して現在のセッションから編集ボックスのパスワードを削除します。次に RemoveButtonClick メソッドは編集ボックスをクリアしてフォーカスを設定します。


スコープ3338013

published

読み出し／書き込み

読み出し専用


スコープ3338014

published


継承3338015

TObject

TPersistent

TComponent

TControl

TWinControl

TScrollingWinControl

TCustomForm

TForm


TPasswordDialog 例3338016

TPasswordDialog


TPen
TPen3339001

継承	プロパティ	メソッド	イベント	参照

TPen オブジェクトはキャンバス上に線や図形の外枠を描画するために使います。

ユニット

graphics

説明

TPen を使うとキャンバス（TCanvas）にイメージを描画するときに Windows ペンの属性を指定できます。TPen はキャンバスの Pen プロパティの型として使用されています。


TPen プロパティ3339002

TPen	アルファベット順	凡例

TPen

Color

Handle

Mode

Style

Width

TGraphicsObject からの継承

OwnerCriticalSection


TPen プロパティ3339003

TPen	オブジェクト順	凡例

Color

Handle

Mode

OwnerCriticalSection

Style

Width


TPen.Color
TPen.Color3339004

TPen	参照

Color プロパティは，キャンバス上に描画する線の色を指定します。

property Color: TColor;

説明

線または形状アウトラインの描画に使う色を変更するために Color プロパティを設定します。以下に色の値を示します。

値	意味

clBlack	黒色

clMaroon	栗色

clGreen	緑色

clOlive	黄緑色

clNavy	濃紺色

clPurple	紫色

clTeal	暗青緑色

clGray	灰色

clSilver	銀色

clRed	赤色

clLime	濃緑色

clBlue	青色

clFuchsia	赤紫色

clAqua	空色

clWhite	白

clBackground	Windows の背景の現在の色

clActiveCaption	アクティブウィンドウのタイトルバーの現在の色

clInactiveCaption	非アクティブウィンドウのタイトルバーの現在の色

clMenu	メニューの現在の背景色

clWindow	ウィンドウの現在の背景色

clWindowFrame	ウィンドウ枠の現在の色

clMenuText	メニュー上のテキストの現在の色

clWindowText	ウィンドウ内のテキストの現在の色

clCaptionText	アクティブウィンドウのタイトルバー上の現在の色

clActiveBorder	アクティブウィンドウの現在の境界色

clInactiveBorder	非アクティブウィンドウの現在の境界色

clAppWorkSpace	アプリケーション作業領域の現在の色

clHighlight	選択したテキストの現在の背景色

clHightlightText	選択したテキストの現在の色

clBtnFace	ボタン面の現在の色

clBtnShadow	ボタンのシャドウキャストの現在の色

clGrayText	淡色表示されているテキストの現在の色

clBtnText	ボタンのテキストの現在の色

clInactiveCaptionText	アクティブでないウィンドウのタイトルバーのテキストの現在の色

clBtnHighlight	ボタンの強調表示の現在の色

cl3DDkShadow 	Windows 95 のみ。3 次元表示要素の暗い影

cl3DLight 	Windows 95 のみ。3 次元表示要素の明るい色（明るい面の縁用）

clInfoText 	Windows 95 のみ。ツールチップコントロールのテキストの色

clInfoBk 	Windows 95 のみ。ツールチップコントロールの背景色

このカラーリストの後半は Windows のシステムカラーです。どの色が表示されるかはどの色が表示されるかは Windows にどのカラー体系を使っているかで異なります。色はプログラムマネージャのコントロールパネルを使って変更できます。実際に表示される色はシステムによって異なります。たとえば，赤紫色はシステムによっては青に近い色になります。

注意

ペンがどのように色を使うかは Mode プロパティと Style プロパティで指定します。


TPen.Handle
TPen.Handle3339005

TPen	参照

Handle プロパティは，Windows ペンオブジェクトハンドルです。

property Handle: HPen;

説明

ペンオブジェクトハンドルが必要な Windows API 関数を呼び出すときには Handle を使ってください。Handle はキャンバス上のデバイスコンテキストで現在選択されている Windows ハンドルです。


TPen.Mode
TPen.Mode3339006

TPen	参照

Mode プロパティは，キャンバス上に線を描画する方法を指定します。

TPenMode = (pmBlack, pmWhite, pmNop, pmNot, pmCopy, pmNotCopy,

    pmMergePenNot, pmMaskPenNot, pmMergeNotPen, pmMaskNotPen, pmMerge,

    pmNotMerge, pmMask, pmNotMask, pmXor, pmNotXor);

property Mode: TPenMode;

説明

描かれる線の色をキャンバス上の色とどのように対応させるかを指定します。以下に Mode の効果を示します。

モード	ピクセルの色

pmBlack	必ず黒

pmWhite	必ず白

pmNop	変化なし

pmNot	画面色の反転色

pmCopy	Color プロパティで指定するペン色

pmNotCopy	ペン色の反転色

pmMergePenNot	ペン色と画面反転色の組み合わせ

pmMaskPenNot	ペン色と画面反転色のどちらにも共通な色の組み合わせ

pmMergeNotPen	画面色とペン反転色の組み合わせ

pmMaskNotPen	画面色とペン反転色のどちらにも共通な色の組み合わせ

pmMerge	ペン色と画面色の組み合わせ

pmNotMerge	ペン色と画面色の pmMerge 組み合わせの反転

pmMask	ペン色と画面色のどちらにも共通な色の組み合わせ

pmNotMask	ペン色と画面色のどちらにも共通な色の pmMask 組み合わせの反転

pmXor	ペン色または画面色の（両方ではなく）どちらかの色の組み合わせ

pmNotXor	ペン色または画面色の（両方ではなく）どちらかの色の pmXor 組み合わせの反転


TPen.Style
TPen.Style3339007

TPen	参照

Style プロパティは，ペンで線を描画するスタイルを決めます。

TPenStyle = (psSolid, psDash, psDot, psDashDot, psDashDotDot, psClear, psInsideFrame);

property Style: TPenStyle;

説明

Style プロパティは，点線や破線を描画したり，または図形の枠として表示される線を省略したりできます。以下に Style の値を示します。

スタイル	意味

psSolid	実線

psDash	破線

psDot	点線

psDashDot	一点鎖線

psDashDotDot	二点鎖線

psClear	線は描画されない（現在のペンを使って図形の周囲にアウトラインを描画する線を省略するのに使う）

psInsideFrame	実線。ただし Width が 1 より大きい場合には中間色を使う場合がある

注意

psInsideFrame スタイルだけはカラーテーブルにない Color プロパティと一致させるために中間色を作成します。他のスタイルはすべて Windows のカラーテーブルからもっとも近い色を選択します。

注意

Width プロパティが 1 でないときには psDot または psDash は使えません。


TPen.Width
TPen.Width3339008

TPen	参照

Width プロパティは，ペンの幅をピクセル単位で指定します。

property Width: Integer;

説明

Width プロパティは線幅を設定できます。Widthを 1 未満に設定すると，ペンは Width が 1 のときの幅になります。

注意

Width の値は Style の値が有効かどうかを左右します。


TPen イベント3339009

TPen	アルファベット順

TGraphicsObject からの継承

OnChange


TPen イベント3339010

TPen	オブジェクト順

OnChange


TPen メソッド3339011

TPen	アルファベット順

TPen

Assign

Create

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TPen メソッド3339012

TPen	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TPen.Assign
TPen.Assign3339013

TPen	参照

Assign メソッドは，別の Tpen オブジェクトのペンのプロパティを割り当てます。

procedure Assign(Source: TPersistent); override;

説明

Source パラメータが別の TPen オブジェクトであると識別した場合，Assign は Source の Color プロパティ，Width プロパティ，Style プロパティ，および Mode プロパティをコピーします。それ以外の場合には継承メソッドが，AssignTo メソッドの TPen オブジェクトに書き込めるオブジェクトからプロパティをコピーします。


TPen.Create
TPen.Create3339014

TPen	参照

Create メソッドは，TPen のインスタンスを作成します。

constructor Create;

説明

Create を呼び出すとキャンバスの Pen プロパティに割り当てる TPen オブジェクトを作成できます。キャンバスで使うペンは TCanvas オブジェクトのコンストラクタで自動的に作成されます。

Create は TPen オブジェクトにリソースを割り当てて Mode プロパティを pmCopy に初期化します。


TPen.Destroy
TPen.Destroy3339015

TPen	参照

Destroy メソッドは，TPen のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはペンオブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。


スコープ3339016

published


継承3339017

TObject

Tpersistent

TGraphicsObject


TPen 例3339018

TPen


TPersistent
TPersistent3340001

継承	メソッド	参照

TPersistent オブジェクトは，メモリ割り当て機能とストリーム入出力機能を持つ Delphi のすべてのオブジェクトの上位オブジェクトです。

ユニット

classes

説明

TPersistent オブジェクトは，ほかのオブジェクトに割り当てることができ，ストリームに対してプロパティを読み書きできるすべてのオブジェクトに共通の基本動作をカプセル化します。このため，TPersistent オブジェクトのメソッドは以下の目的でオーバーライドできます。

・	非パブリッシュデータをストリームにロードおよび保存するための手続きを定義する

・	値をプロパティに割り当てるための手段を提供する

・	あるオブジェクトの内容をほかのオブジェクトに割り当てる手段を提供する

TPersistent オブジェクトのインスタンスは作成しないでください。コンポーネントではないが，ストリーミング機能または割り当て機能を必要とするオブジェクトを宣言する場合に，基本クラスとして TPersistent オブジェクトを使います。


TPersistent メソッド3340002

TPersistent	アルファベット順	凡例

TPersistent

Assign

AssignTo

DefineProperties

GetNamePath

GetOwner

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TPersistent メソッド3340003

TPersistent	オブジェクト順	凡例

Assign

AssignTo

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

DefineProperties

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetOwner

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TPersistent.Assign
TPersistent.Assign3340004

TPersistent	参照

Assign メソッドは，オブジェクトの内容をほかのオブジェクトにコピーします。

procedure Assign(Source: TPersistent);

説明

Assign メソッドをオーバーライドして，あるオブジェクトのデータを同じ型のほかのオブジェクトにコピーできます。Delphi には違う型のオブジェクト間の割り当てをサポートするクラスもわずかにありますが，それ以外のすべてのケースで，TPersistent オブジェクトを継承した 2 つのオブジェクトでも型が違う場合，Assign メソッドを呼び出すと EConvertError 例外が生成されます。

Assign メソッドを呼び出す標準形式は次のとおりです。

Destination.Assign(Source);

これは，Destination オブジェクトに Source オブジェクトの内容をコピーするように通知します。一般的に，Destination := Source 文は Destination.Assign(Source) と同じではありません。Destination := Source 文は Destination の参照先を Source と同じオブジェクトにします。一方，Destination.Assign(Source) 文は Source で参照するオブジェクトの内容を Destination で参照するオブジェクトにコピーします。

注意

いくつかのプロパティの型もオブジェクトです。これらのプロパティが Assign メソッドを使ってプロパティの値を設定する書き込みメソッドを持っている場合，Destination := Source 文は Destination.Assign(Source) と同じになります。

変換は Assign メソッドまたは AssignTo メソッドのどちらかで行われます。その違いは，何が割り当てを実現するための作業をするかということです。

Source は nil になることもあることに注意してください。


TPersistent.AssignTo
TPersistent.AssignTo3340005

TPersistent	参照

AssignTo メソッドは，オブジェクトに関連付けられたデータをほかのオブジェクトに割り当てる一般的な機構を提供します。

procedure AssignTo(Dest: TPersistent); virtual;

説明

AssignTo は，パブリックメソッド Assign の実際の作業を行うプロテクトメソッドです。デフォルトでは，TPersistent オブジェクトで定義されている AssignTo メソッドは EConvertError 例外を生成します。下位クラスは，そのクラスのオブジェクトの内容をほかのオブジェクトにコピーする AssignTo メソッドを定義できます。AssignTo メソッドの存在によって，異なる型の間でデータをコピーする方法に関する知識が両者に備わっている必要がなくなります。たとえば，A と B がインスタンス変数である次のコードの場合，

A.Assign(B);

A が B の処理方法を知っていればその処理が実行されます。A が B の型を知らない場合は，実行は TPersistent オブジェクトの Assign メソッドに任され，次のコードを呼び出します。

B.AssignTo(A);

B が A を知らない場合は例外が生成されます。


TPersistent.DefineProperties
TPersistent.DefineProperties3340006

TPersistent	参照

DefineProperties メソッドは，TPersistent オブジェクトで定義されていて非パブリッシュデータを読み書きするメソッドのインターフェースを提供します。

procedure DefineProperties(Filer: TFiler); virtual;

説明

TPersistent の派生オブジェクトでは，DefineProperties メソッドをオーバーライドして，フォームファイルなどのストリームにオブジェクトの非パブリッシュデータを格納するためのメソッドを指定できます。デフォルトの場合，ストリームへのオブジェクトの書き込みではすべてのパブリッシュプロパティの値を書き込み，オブジェクトの読み出しではすべてのパブリッシュプロパティの値を読み出してプロパティに割り当てます。オブジェクトは DefineProperties メソッドをオーバーライドすることでプロパティ以外のデータの読み出しと書き込みのメソッドも指定できます。

DefineProperties をオーバーライドする場合，次の一部またはすべてを指定します。

・	継承メソッドの呼び出し

・	ファイラオブジェクトの DefineProperty メソッドの呼び出し

・	ファイラオブジェクトの DefineBinaryProperty メソッドの呼び出し

DefineProperties は仮想メソッドなので，必要ならば下位クラスはそれをオーバーライドでき，再定義する必要はありません。


TPersistent.GetNamePath
TPersistent.GetNamePath3340008

TPersistent	参照

GetNamePath メソッドは，オブジェクトインスペクタによって使われる文字列を返します。

function  GetNamePath: string; dynamic;

説明

GetNamePath メソッドは内部的に使われるだけです。GetNamePath メソッドは，編集するオブジェクトの名前としてオブジェクトインスペクタで表示されるテキストを判定するのに使われます。GetNamePath は，コレクションのような下位オブジェクトがオブジェクトインスペクタで表示できるように TPersistent で導入されます。直接 GetNamePath を呼び出さないでください。

注意

コンポーネントの場合はコンポーネント名です。TCollectionItem オブジェクトの場合は，ホストコンポーネントの名前，プロパティ名，およびカッコで囲まれたコレクションのインデックスです。


TPersistent.GetOwner
TPersistent.GetOwner3340009

TPersistent	参照

GetOwner メソッドは，コンポーネントのオーナーを返します。

function  GetOwner: TPersistent; dynamic;

説明

GetOwner メソッドは，GetNamePath により，コンポーネントのオーナーを見つけるのに使われます。GetNamePath と GetOwner は，コレクションのような下位オブジェクトがオブジェクトインスペクタで表示できるように TPersistent で導入されます。TPersistent の場合，デフォルトでは GetOwner は nil を返します。TCollection の場合はコレクションのオーナーです。TCollectionItem.GetOwner はコレクションオブジェクトにコレクションオブジェクトの挿入先の項目を返します。TComponent の場合は，Owner プロパティの値です。


スコープ3340010

protected


継承3340011

TObject


TPersistent 例3340012

TPersistent


TPictureAdapter
TPictureAdapter3341001

継承	プロパティ	メソッド	参照

TPictureAdapter は，Delphi ネイティブの TPicture オブジェクトを OLE 画像オブジェクトに結合するのに使うヘルパークラスです。

ユニット

axctrls

説明

TPictureAdapter のインスタンスを作成するには，TPicture と OLE 画像オブジェクトとの結合を作成するために GetOlePicture 手続きを呼び出します。


TPictureAdapter のプロパティ3341002

TPictureAdapter	アルファベット順	凡例

TInterfacedObject からの継承

RefCount


TPictureAdapter のプロパティ3341003

TPictureAdapter	オブジェクト順	凡例

RefCount


TPictureAdapter のメソッド3341004

TPictureAdapter	アルファベット順

TPictureAdapter

Create

TCustomAdapter からの継承

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TPictureAdapter のメソッド3341005

TPictureAdapter	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TPictureAdapter.Create
TPictureAdapter.Create3341006

TPictureAdapter	参照

Create メソッドは，画像アダプタコントロールのインスタンスを構築します。

constructor Create(Picture: TPicture);

説明

通常，このクラスのオブジェクトを作成する必要はありません。代わりに，GetOlePicture 手続きを呼び出して TPicture と OLE 画像オブジェクトとの結合を作成します。


アクセス種別3341007

読み出し専用


継承3341008

TObject

TInterfacedObject

TCustomAdapter


TPictureAdapter の例3341009

TPictureAdapter


TPicture
TPicture3342001

継承	プロパティ	メソッド	イベント	参照

TPicture は，ビットマップ，アイコン，メタグラフィック，またはユーザ定義グラフィックを保持します。

ユニット

graphics

説明

TPicture はグラフィックを保持するために使う TGraphic コンテナで，Graphic プロパティにその種類が指定されます。これは，グラフィックが TGraphic クラスのものである可能性がある場合に TGraphic のかわりに使います。LoadFromFile および SaveToFile は，そのクラスに応じたファイルの読み込みおよび書き込みを行います。TPicture の LoadFromFile/SaveToFile は，TPicture がサポートするすべての形式のグラフィックを読み書きできますが，たとえば，TIcon クラスの場合は .ICO ファイルの読み書きのみできます。

TPicture がビットマップグラフィックを保持しているときは，Bitmap プロパティがグラフィックを指定します。同様に，TPicture が保持するものがアイコングラフィックでは Icon プロパティが，TPicture が保持するものがメタファイルグラフィックでは Metafile プロパティが，それぞれグラフィックを指定します。

TPicture のプロパティは，画像オブジェクトが保持するグラフィックの種類とそのサイズを示します。TPicture のメソッドは，グラフィックをロード，保存，操作するために使います。

画像をクリップボードにロードまたは保存するには，TClipboard オブジェクトの Assign メソッドを使います。

画像をキャンバス上に描画するには，TCanvas オブジェクトの Draw メソッドまたは StretchDraw メソッドを呼び出して，TPicture の Graphic プロパティをパラメータとして渡します。


TPicture のプロパティ3342002

TPicture	アルファベット順	凡例

TPicture

Bitmap

Graphic

Height

Icon

Metafile

PictureAdapter

Width


TPicture のプロパティ3342003

TPicture	オブジェクト順	凡例

Bitmap

Graphic

Height

Icon

Metafile

PictureAdapter

Width


TPicture.Bitmap
TPicture.Bitmap3342004

TPicture	参照

Bitmap プロパティは，画像オブジェクトの内容がビットマップグラフィック（.BMP ファイル形式）であることを指定します。

property Bitmap: TBitmap;

説明

Bitmap プロパティは，画像オブジェクトがビットマップを保持しているときにそれを参照できます。画像が Metafile または Icon グラフィックを保持しているときに Bitmap を参照すると，そのグラフィックは変換されません。かわりに，画像の元の内容が破棄され，Bitmap は新しい空白ビットマップを返します。


TPicture.Graphic
TPicture.Graphic3342005

TPicture	参照

Graphic プロパティは，画像が保持するグラフィックを指定します。

property Graphic: TGraphic;

説明

Graphic プロパティは，TPicture オブジェクトの保持するグラフィックが何かを指定できます。グラフィックは，ビットマップ，アイコン，メタファイル，またはユーザー定義グラフィッククラスのいずれかでかまいません。


TPicture.Height
TPicture.Height3342006

TPicture

Height プロパティは，グラフィックの縦サイズをピクセル単位で指定します。

property Height: Integer;

説明

Height プロパティは，画像オブジェクトの保持するグラフィックイメージの縦サイズを取得できます。Height は，画像を拡大縮小していない元の高さです。


TPicture.Icon
TPicture.Icon3342007

TPicture	参照

Icon プロパティは，TPicture オブジェクトの内容をアイコングラフィック（.ICO ファイル形式）で指定します。

property Icon: TIcon;

説明

TPicture が Bitmap または Metafile グラフィックを保持しているときに Icon プロパティを参照すると，そのグラフィックは変換されません。かわりに，TPicture の元の内容が破棄されて，Icon は新しい空白アイコンを返します。


TPicture.Metafile
TPicture.Metafile3342008

TPicture	参照

Metafile プロパティは，画像オブジェクトの内容をエンハンスド Windows メタファイルグラフィック（.EMF ファイル形式）で指定します。

property Metafile: TMetafile;

説明

TPicture が Bitmap または Icon グラフィックを保持しているときに Metafile を参照すると，そのグラフィックは変換されません。かわりに，TPicture の元の内容が破棄され，Metafile は新しい空白メタファイルを返します。


TPicture.PictureAdapter
TPicture.PictureAdapter3342009

TPicture

PictureAdapter プロパティは，フォントを扱っているときに画像オブジェクトが使います。

property PictureAdapter: IChangeNotifier;

説明

PictureAdapter は内部でのみ使われます。


TPicture.Width
TPicture.Width3342010

TPicture	参照

Width プロパティは，画像の横サイズをピクセル単位で指定します。

property Width: Integer;

説明

Width プロパティは，グラフィックイメージの幅を取得できます。Width は，画像を拡大縮小していない元の幅を保持します。


TPicture のイベント3342011

TPicture	アルファベット順

TPicture

OnChange

OnProgress


TPicture のイベント3342012

TPicture	オブジェクト順

OnChange

OnProgress


TPicture.OnChange
TPicture.OnChange3342013

TPicture	参照

OnChange イベントは，画像オブジェクトによりカプセル化される特定のグラフィック項目が変化するときに発生します。

property OnChange: TNotifyEvent

説明

OnChange イベントハンドラを記述すると，グラフィックが変更されるときのアクションを処理できます。


TPicture.OnProgress
TPicture.OnProgress3342014

TPicture	参照

OnProgress イベントは，グラフィックに影響を与えるゆっくりとした処理の間に定期的に発生します。

TProgressStage = (psStarting, psRunning, psEnding);

TProgressEvent = procedure (Sender: TObject; Stage: TProgressStage; PercentDone: Byte; RedrawNow: Boolean; const R: TRect; const Msg: string) of object;

property OnProgress: TProgressEvent;

説明

OnProgress イベントは，画像オブジェクトの保持する特定グラフィックにより生成されます。OnProgress が生成されるかどうかは，Graphic プロパティのグラフィックにより決まります。グラフィックによって，このイベントを生成したりしなかったりします。たとえば，JPeg イメージは OnProgress イベントを生成します。

OnProgress イベントハンドラを記述すると，大きな圧縮イメージをロードするなどの時間のかかる処理の間にユーザーに視覚的なフィードバックを提供できます。たとえば Timage は，TPicture の OnProgress イベントをフックします。

Stage パラメータは，操作の状態が開始中，継続中，終了中のいずれであるかを示します。 OnProgress イベントハンドラがプログレスバーなどの進行状況インジケーターを表示する場合，それを Stage が psStarting のときに作成，Stage が psRunning のときに更新，Stage が psEnding のときに削除できます。PercentDone パラメータは，処理済みのおおよその量を示します。PercentDone を使うと，プログレスバーなどのインジケーターの位置を更新できます。

RedrawNow パラメータは，画面上のこのポイントでイメージを安全に描画できるかどうかを示します。RedrawNow が True の場合，OnProgress イベントの直前におおよそのイメージが描画されます。R パラメータは，イメージが変化したために再描画が必要になった部分を指定します。

Msg パラメータは，どの処理が発生しているかを記述する 1つまたは 2 つのワードを保持します。たとえば Msg の値は，「Loading colors」，「Storing colors」，「Reducing colors」 などの文字列になります。また，Msg 文字列は空でもかまいません。

注意

PercentDone パラメータはおおよその値にすぎません。一部のイメージ形式では，グラフィックオブジェクトが処理対象の作業が残っていることを検出すると，PercentDone の値がそれまでのイベントの値よりも実際に減る場合があります。


TPicture のメソッド3342015

TPicture	アルファベット順

TPicture

Assign

Create

Destroy

LoadFromClipboardFormat

LoadFromFile

RegisterClipboardFormat

RegisterFileFormat

RegisterFileFormatRes

SaveToClipboardFormat

SaveToFile

SupportsClipboardFormat

UnregisterGraphicClass

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TPicture のメソッド3342016

TPicture	オブジェクト順

Assign

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

InheritsFrom

InitInstance

InstanceSize

LoadFromClipboardFormat

LoadFromFile

MethodAddress

MethodName

NewInstance

RegisterClipboardFormat

RegisterFileFormatRes

RegisterFileFormat

SafeCallException

SaveToClipboardFormat

SaveToFile

SupportsClipboardFormat

UnregisterGraphicClass


TPicture.Assign
TPicture.Assign3342017

TPicture	参照

Assign メソッドは，オブジェクトの内容を別のオブジェクトにコピーすることでオブジェクト間のコピーを実行します。

procedure Assign(Source: TPersistent) override;

説明

Source パラメータが Graphic プロパティにとって有効なオブジェクトの種類であるときは，Assign はそのグラフィックを Graphic プロパティの値にします。

Assign メソッドは，TPicture Graphic プロパティと Source の実際の種類に依存します。たとえば Graphic プロパティと Source がビットマップ（TBitmap）の場合，Source の保持するビットマップが Graphic プロパティにコピーされます。たとえば TIcon や TMetafile では，同様の変換が有効です。

Source パラメータが Graphic プロパティにとって有効なオブジェクトではない場合，Assign は継承メソッドを呼び出して画像をそれと矛盾のないオブジェクトからコピーできるようにします。


TPicture.Create
TPicture.Create3342018

TPicture	参照

Create メソッドは，TPicture オブジェクトをインスタンス化します。

constructor Create;

説明

Create メソッドを呼び出すと，TPicture のインスタンスを実行時に作成できます。Create は画像オブジェクトのメモリを割り当てて，その内部形式を初期化します。TPicture オブジェクトを作成した後，LoadFromClipboardFormat または LoadFromFile メソッドを使ってグラフィックイメージを画像に割り当てると，それをアプリケーションで使えるようになります。


TPicture.Destroy
TPicture.Destroy3342019

TPicture	参照

Destroy メソッドは画像オブジェクトのインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで Destroy メソッドを直接呼び出さないでください。アプリケーションはかわりに Free メソッドを呼び出さなければなりません。Free は画像オブジェクトが解放されていないことを確認してから Destroy を呼び出します。

Destroy はそれが保持するグラフィックイメージを解放した後，継承 Destroy を呼び出します。


TPicture.LoadFromClipboardFormat
TPicture.LoadFromClipboardFormat3342020

TPicture	参照

LoadFromClipboardFormat メソッドは，特定のクリップボード形式で指定したハンドルから画像を読み出します。

procedure LoadFromClipboardFormat(AFormat: Word; AData: THandle; APalette: HPALETTE);

説明

LoadFromClipboardFormat メソッドを呼び出すと，クリップボードからグラフィックを取得できます。サポートされていない形式である場合，EInvalidGraphic 例外が発生します。


TPicture.LoadFromFile
TPicture.LoadFromFile3342021

TPicture	参照

LoadFromFile メソッドは，FileName で指定されたファイルを読み出してそのデータを TPicture オブジェクトにロードします。

procedure LoadFromFile(const FileName: string);

説明

LoadFromFile メソッドを呼び出すと，画像をディスクから取得できます。作成される TGraphic クラスはファイルの拡張子で指定されます。ファイル拡張子が認識されない場合，EInvalidGraphic 例外が発生します。


TPicture.RegisterClipboardFormat
TPicture.RegisterClipboardFormat3342022

TPicture	参照

RegisterClipboardFormat メソッドは，LoadFromClipboardFormat メソッドで使うために新しい TGraphic クラスを登録します。

TGraphicClass = class of TGraphic;

class procedure RegisterClipboardFormat(AFormat: Word; AGraphicClass: TGraphicClass);

説明

RegisterClipboardFormat メソッドを呼び出すと，新しいグラフィック形式を TPicture に登録して LoadFromClipboardFormat メソッドで使えるようにできます。


TPicture.RegisterFileFormat
TPicture.RegisterFileFormat3342023

TPicture	参照

RegisterFileFormat メソッドは，LoadFromFile で使うために新しい TGraphic クラスを登録します。

TGraphicClass = class of TGraphic;

class procedure RegisterFileFormat(const AExtension, ADescription: string; AGraphicClass: TGraphicClass);

説明

RegisterFileFormat メソッドを呼び出すと，グラフィックファイル形式を TPicture に登録して，ダイアログボックスで使えるようにできます。

AExtension パラメータは，グラフィッククラスと関連付けるために 3 文字のシステムファイル拡張子を指定します（たとえば「BMP」は TBitmap に関連付けられています）。ADescription パラメータは，ダイアログボックスのドロップダウンリストに表示するグラフィックの記述子を指定します（たとえば「Bitmaps」は TBitmap の記述子です）。AGraphicClass パラメータは，新しいグラフィッククラスを登録してファイル形式に関連付けます。


TPicture.RegisterFileFormatRes
TPicture.RegisterFileFormatRes3342024

TPicture	参照

RegisterFileFormatRes メソッドは，新しい TGraphic クラスを LoadFromFile メソッドで使うために登録します。

TGraphicClass = class of TGraphic;

class procedure RegisterFileFormatRes(const AExtension: String; ADescriptionResID: Integer; AGraphicClass: TGraphicClass);

説明

RegisterFileFormatRes メソッドを呼び出すには，文字列リソース ID を ADescriptionResID パラメータで指定します。


TPicture.SaveToClipboardFormat
TPicture.SaveToClipboardFormat3342025

TPicture	参照

SaveToClipboardFormat メソッドはグローバルハンドルを割り当て，画像をそのネイティブなクリップボード形式（ビットマップでは CF_BITMAP，メタファイルでは CF_METAFILE など）で保存します。

procedure SaveToClipboardFormat(var AFormat: Word; var AData: THandle; var APalette: HPALETTE);

説明

TClipboard の Formats プロパティは，書き込まれた形式を保持します。SaveToClipboardFormat は，AFormat および AData により示された配列に書き込まれたクリップボード項目の数を返します。AFormat または AData のいずれかが nil の場合， SaveToClipboardFormat は保存されるはずだったクリップボード項目の数を返します。


TPicture.SaveToFile
TPicture.SaveToFile3342026

TPicture

SaveToFile メソッドは，画像をディスクに保存します。

procedure SaveToFile(const FileName: string);

説明

SaveToFile メソッドを呼び出すと，TPicture オブジェクトを FileName で指定したファイルに保存できます。


TPicture.SupportsClipboardFormat
TPicture.SupportsClipboardFormat3342027

TPicture	参照

SupportsClipboardFormat メソッドは，指定されたクリップボード形式を LoadFromClipboardFormat メソッドがサポートしているかどうかを示します。

class function SupportsClipboardFormat(AFormat: Word): Boolean;

説明

LoadFromClipboardFormat メソッドが AFormat の値で指定されたクリップボード形式をサポートしている場合，SupportsClipboardFormat は True を返します。その形式がサポートされていない場合，メソッドは False を返します。


TPicture.UnregisterGraphicClass
TPicture.UnregisterGraphicClass3342028

TPicture	参照

UnregisterGraphicClass メソッドは，指定された TGraphic クラスへのすべての参照とそのすべての下位オブジェクトを，ファイル形式およびクリップボード形式の内部リストから削除します。

class procedure UnregisterGraphicClass(AClass: TGraphicClass);

説明

UnregisterGraphicClass メソッドを呼び出すと，グラフィッククラスをすべての画像オブジェクトで使えないようにできます。UnregisterGraphicClass は，RegisterFileFormat，RegisterFileFormatRes，または RegisterClipboardFormat メソッドにより処理された登録を元に戻します。

グラフィッククラスが登録されると，グローバル関数の GraphicFilter，GraphicExtension，GraphicFileMask はグラフィッククラスのダイアログフィルタ文字列，デフォルトファイル拡張子，ファイルフィルタを返すことができます。このような値を使えないときは，UnregisterGraphicClass を呼び出します。たとえばカスタムグラフィッククラスを実現するコンポーネント作成者は，カスタムクラスを実現するユニットの finalization ブロックでそのようなクラスの登録を解除します（カスタムクラスのファイル形式とクリップボード形式は initialization ブロックで登録されます）。


アクセス種別3342029

読み出し専用


継承3342030

TObject

TPersistent


TPicture の例3342031

TPicture


TParamList
TParamList3343001

継承	プロパティ	メソッド	参照

TParamList オブジェクトはセッションパラメータのリストを管理します。

ユニット

dbtables

説明

TParamList を直接使わないでください。TParamList は Delphi が内部的に使うオブジェクトで，TSession コンポーネントのセッションパラメータのリストを管理します。


TParamList のプロパティ3343002

TParamList	アルファベット順	凡例

TParamList

Buffer

FieldCount

FieldDescs


TParamList のプロパティ3343003

TParamList	オブジェクト順	凡例

Buffer

FieldCount

FieldDescs


TParamList.Buffer
TParamList.Buffer3343004

パラメータリストのパラメータ文字列がすべて入っています。

property Buffer: PChar;

説明

Buffer は内部的に使われ，パラメータリストオブジェクトにパラメータを格納します。アプリケーションはこのリストを解析できますが，通常，その必要はありません。


TParamList.FieldCount
TParamList.FieldCount3343005

TParamList	参照

パラメータリスト内にあるセッションパラメータの数を示します。

property FieldCount: Integer;

説明

FieldCount を調べると，1 つのセッションにあるパラメータの数を決定することができます。


TParamList.FieldDescs
TParamList.FieldDescs3343006

TParamList

パラメータリストオブジェクトに保守される各パラメータの項目記述子が入っています。

type

PFieldDescList = ^TFieldDescList;

TFieldDescList = array[0..1023] of FLDDesc;

property FieldDescs: PFieldDescList;

説明

FieldDescs を調べると，パラメータリストオブジェクトが保守している各パラメータの特性を決定することができます。通常，アプリケーションがこのプロパティに直接アクセスする必要はありません。


TParamList のメソッド3343007

TParamList	アルファベット順

TParamList

Create

Destroy

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TParamList のメソッド3343008

TParamList	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TParamList.Create
TParamList.Create3343009

TParamList	参照

Create は TParamList のインスタンスを作成します。

constructor Create (Params: TStrings);

説明

Create を呼び出すと，TParamList のオブジェクトをインスタンス化することができます。TSession が自動的に TParamList を作成するので，通常アプリケーションで TParamList オブジェクトを作成する必要はありません。

Params は，そのセッション用に作成するパラメータの名前が入っている文字列のリストです。これらのパラメータは，ボーランドデータベースエンジン（BDE）の環境設定パラメータに対応しています。


TParamList.Destroy
TParamList.Destroy3343010

TParamList	参照

TParamList のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy を呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TParamList オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します

Destroy は項目記述子に割り当てていたメモリと TParamList が使っていたバッファを解放します。

注意

アプリケーションで TParamList オブジェクトを破棄する必要はありません。TParamList オブジェクトは，親セッションオブジェクトが破棄されるときに自動的に破棄されます。


アクセス種別3343011

読み出し専用


継承3343012

TObject


TParamList の例3343013

TParamList


TPopupMenu
TPopupMenu3344001

継承	プロパティ	メソッド	イベント	参照	例 1	例 2

TPopupMenu コンポーネントは，ポップアップメニューのプロパティ，メソッド，イベント，フォームをカプセル化します。

ユニット

menus

説明

TPopupMenu では，ユーザーがコントロールで右クリックしたときに表示されるポップアップメニューを定義できます。ポップアップを提供するには，TPopupMenu オブジェクトをコントロールの PopupMenu プロパティに割り当てます。


TPopupMenu プロパティ3344002

TPopupMenu	アルファベット順	凡例

TPopupMenu

Alignment

AutoPopup

HelpContext

PopupComponent

TMenu からの継承

Handle

Items

WindowHandle

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TPopupMenu プロパティ3344003

TPopupMenu	オブジェクト順	凡例

Alignment

AutoPopup

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Handle

HelpContext

Items

Name

Owner

PopupComponent

Tag

VCLComObject

WindowHandle


TPopupMenu.Alignment
TPopupMenu.Alignment3344004

TPopupMenu	参照

Alignment プロパティは，ユーザーが右クリックしたときにポップアップメニューが表示される位置を示します。

property Alignment: TPopupAlignment;

説明

Alignment プロパティは，ポップアップメニューの表示位置を制御できます。以下に Alignment の指定値を示します。

値	意味

paLeft	マウスポインタの下にポップアップメニューの左上がくるように表示する

paCenter	マウスポインタの下にポップアップメニューの最上部中央がくるように表示する

paRight	マウスポインタの下にポップアップメニューの右上がくるように表示する

デフォルト値は paLeft です。


TPopupMenu.AutoPopup
TPopupMenu.AutoPopup3344005

TPopupMenu	参照

AutoPopup プロパティは，ユーザーが右クリックしたときに自動的にポップアップメニューを表示するかどうかを指定します。

property AutoPopup: Boolean;

説明

AutoPopup プロパティを True に設定すると，ユーザーがコントロールで右クリックしたときにコントロールの PopupMenu プロパティとして指定されたポップアップメニューが自動的に表示されます。Windows 95 用のキーボードのアプリケーションキーを押したときにもこのメニューが表示されます。

ポップアップメニューの外観をプログラムで制御する場合は AutoPopup を False に設定します。AutoPopup が False の場合にポップアップメニューを表示するには Popup メソッドを使います。


TPopupMenu.HelpContext
TPopupMenu.HelpContext3344006

TPopupMenu	参照

HelpContext プロパティは，ポップアップメニュー全体のためのコンテキスト ID です。

THelpContext = -MaxLongint..MaxLongint;

説明

HelpContext を使うとヘルプ画面をポップアップメニュー全体に関連付けることができます。ヘルプシステムの各画面にはユニークなコンテキスト ID が必要です。アプリケーションでコンポーネントを選択している場合，〔F1〕キーを押すと HelpContext の値に関連付けられたヘルプ画面が表示されます。

ヘルプ画面をポップアップメニューの個々の項目に関連付けるには，TMenuItem オブジェクトに関連付けられた HelpContext プロパティを使います。


TPopupMenu.PopupComponent
TPopupMenu.PopupComponent3344007

TPopupMenu	参照

PopupComponent プロパティは，右クリックに応答して最後にポップアップメニューを表示したコンポーネントです。

property PopupComponent: TComponent;

説明

PopupComponent プロパティは，どのコントロールが現在ポップアップメニューを使っているかを調べるために使われます。同じポップアップメニューを共有するマルチコントロールがあるアプリケーションでは，PopupComponent を使ってどのコントロールがメニューを表示したのかを調べられます。

PopupComponent を設定すると，ポップアップメニューを表示させるための Popup メソッドをプログラムで呼び出す前にコントロールをそのメニューに関連付けることができます。


TPopupMenu イベント3344008

TPopupMenu	アルファベット順	凡例

TPopupMenu

OnPopup


TPopupMenu イベント3344009

TPopupMenu	オブジェクト順	凡例

OnPopup


TPopupMenu.OnPopup
TPopupMenu.OnPopup3344010

TPopupMenu	参照

OnPopup イベントは，ポップアップメニューが表示される直前に発生します。

TNotifyEvent = procedure (Sender: TObject) of object;

property OnPopup: TNotifyEvent;

説明

OnPopup イベントハンドラを記述すると，ポップアップメニューが表示される前に特定のアクションを実行できます。たとえば，OnPopup イベントハンドラを使って，メニューの個々の項目を PopupComponent が正しく処理するように，項目の Checked，Enabled，または Visible プロパティを設定します。


TPopupMenu メソッド3344011

TPopupMenu	アルファベット順

TPopupMenu

Create

Destroy

Popup

TMenu からの継承

DispatchCommand

DispatchPopup

FindItem

GetHelpContext

GetHelpContext

IsShortCut

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TPopupMenu メソッド3344012

TPopupMenu	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DispatchCommand

DispatchPopup

FieldAddress

FindComponent

FindItem

Free

FreeInstance

FreeNotification

FreeOnRelease

GetHelpContext

GetHelpContext

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsShortCut

MethodAddress

MethodName

NewInstance

Popup

RemoveComponent

SafeCallException


TPopupMenu.Create
TPopupMenu.Create3344013

TPopupMenu	参照

Create メソッドは，TPopupMenu のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にポップアップメニューを作成できます。設計時にフォームまたはデータモジュールに配置されたポップアップメニューは自動的に作成されます。


TPopupMenu.Destroy
TPopupMenu.Destroy3344014

TPopupMenu	参照

Destroy メソッドは，TPopupMenu のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは Destroy を直接呼び出さないでください。代わりに Free を呼び出します。Freeは ポップアップメニューがすでに解放されていないことを確認してからのみ Destroy を呼び出します。


TPopupMenu.Popup
TPopupMenu.Popup3344015

TPopupMenu	参照

Popup メソッドは，ポップアップメニューを表示します。

procedure Popup(X, Y: Integer); virtual;

説明

Popup メソッドを呼び出すと，ポップアップメニューを表示できます。メニューは X と Y の値（ピクセル単位）で示された画面上の座標位置に表示されます。


スコープ3344016

published

読み出し／書き込み

読み出し専用


スコープ3344017

published


継承3344018

TObject

TPersistent

TComponent

TMenu


TPopupMenu 例3344019

TPopupMenu


TProgressBar
TProgressBar3345001

継承	プロパティ	メソッド	イベント	例

TProgressBar コンポーネントは Windows プログレスバーのラッパーです。

ユニット

comctrls

説明

TProgressBar は，プログレスバーをフォームに追加します。プログレスバーはアプリケーション内部の処理の進行状況を表示します。処理の進行に伴って長方形のプログレスバーがシステムの強調表示色で左から右に塗りつぶされます。


TProgressBar プロパティ3345002

TProgressBar	アルファベット順	凡例

TProgressBar

Max

Min

Position

Step

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Height

Hint

Left

Name

Parent

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TProgressBar プロパティ3345003

TProgressBar	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Handle

Height

HelpContext

Hint

Left

Max

Min

Name

Owner

Parent

ParentShowHint

ParentWindow

PopupMenu

Position

ShowHint

Showing

Step

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TProgressBar.Max
TProgressBar.Max3345004

TProgressBar	参照	例

Max プロパティは，位置の範囲の上限を指定します。

property Max: Integer;

説明

Min プロパティとともに Max プロパティを使うとプログレスバーの範囲を指定できます。プログレスバーでトラッキングされていた処理が完了すると，Position の値は Max に等しくなります。


TProgressBar.Min
TProgressBar.Min3345005

TProgressBar	参照	例

Min プロパティは，プログレスバー上の範囲の下限を指定します。

property Min: Integer;

説明

Min プロパティとともに Max プロパティを使うとプログレスバーの範囲を指定できます。プログレスバーでトラッキングする処理が開始されるときは，Position の値は Min と等しくなります。


TProgressBar.Position
TProgressBar.Position3345006

TProgressBar	参照	例

Position プロパティは，プログレスバーの現在位置を示します。

property Position: Integer;

説明

Position プロパティは，プログレスバーでトラッキングする処理が Min から Max の方へどれくらい進行したかを示します。Position を設定すると，プログレスバーが Min ～ Max 間の位置を表示します。たとえば，プログレスバーでトラッキングする処理が完了するしたときに，プログレスバーがすべて塗りつぶされるように Position を Max に設定します。

プログレスバーを作成すると，Min と Max は百分率を表し，Min は 0（0% 完了）を示し，Max は 100（100% 完了）を示します。Min と Max の値を変更しない場合，Position は処理がそれくらい完了したかを示す百分率です。


TProgressBar.Step
TProgressBar.Step3345007

TProgressBar	参照	例

Step プロパティは，StepIt メソッドが呼び出されたときの Position の増加量を示します。

property Step: Integer;

説明

Step プロパティは，プログレスバーの細分性を示すために使われます。Step はプログレスバーでトラッキングされるプロセスの各ステップのサイズを，Max および Min で使う論理ユニットに反映します。

プログレスバーを作成すると，Min と Max は百分率を表し，Min は 0（0% 完了）を示し，Max は 100（100% 完了）を示します。Min と Max の値を変更しない場合，Step は，ユーザーに進行状態が表示される前にどのくらい処理が完了したかを示す百分率です。

StepIt メソッドを呼び出すと，Position の値が Step で指定された分だけ増加します。


TProgressBar イベント3345008

TProgressBar	アルファベット順	凡例

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TProgressBar イベント3345009

TProgressBar	オブジェクト順	凡例

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TProgressBar メソッド3345010

TProgressBar	アルファベット順

TProgressBar

Create

StepBy

StepIt

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TProgressBar メソッド3345011

TProgressBar	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

StepBy

StepIt

Update

UpdateControlState


TProgressBar.Create
TProgressBar.Create3345012

TProgressBar	参照	例

Create メソッドは，TProgressBar のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にプログレスバーを作成できます。設計時にフォームには位置されたプログレスバーは自動的に作成されます。継承されたコンストラクタの呼び出し後，Create は次の値を初期化します。

・	Min を 0 に，Max を 100 に設定する

・	Step を 10 に設定する

・	Width を 150 に設定する

・	Height をスクロールバー上の矢印ビットマップの高さに設定する


TProgressBar.StepBy
TProgressBar.StepBy3345013

TProgressBar	参照	例

StepBy メソッドは，指定された量だけプログレスバーを進めます。

procedure StepBy(Delta: Integer);

説明

StepBy メソッドを呼び出すと，Delta パラメータの値だけ Position の値を増加させることができます。プロセスの 1 つのステップを表すデフォルト量だけ Position を進めるには，StepIt メソッドを使います。


TProgressBar.StepIt
TProgressBar.StepIt3345014

TProgressBar	参照	例

StepIt メソッドは，Step プロパティで指定した量だけ Position を進めます。

procedure StepIt;

説明

StepIt メソッドを呼び出すと，Step プロパティの値だけ Position の値を増加させることができます。Step がプログレスバーでトラッキングするプロセス内の 1 つの論理ステップのサイズを表す場合，各論理ステップが完了するたびに Step を呼び出します。


スコープ3345015

published

読み出し／書き込み

読み出し専用


スコープ3345016

published


継承3345017

TObject

TPersistent

TComponent

TControl

TWinControl


TPrintDialog
TPrintDialog3346001

継承	プロパティ	メソッド	イベント	参照

TPrintDialog コンポーネントは，［印刷］ダイアログボックスを表示します。

ユニット

dialogs

説明

TPrintDialog コンポーネントはプリンタへジョブを送るための標準 Windows ダイアログボックスを表示します。このダイアログボックスはモード付きで，実行時には Execute メソッドを呼び出してアクティブにされるまで表示されません。


TPrintDialog プロパティ3346002

TPrintDialog	アルファベット順	凡例

TPrintDialog

Collate

Copies

FromPage

MaxPage

MinPage

Options

PrintRange

PrintToFile

ToPage

TCommonDialog からの継承

Ctl3D

Handle

HelpContext

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TPrintDialog プロパティ3346003

TPrintDialog	オブジェクト順	凡例

Collate

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Copies

Ctl3D

DesignInfo

FromPage

Handle

HelpContext

MaxPage

MinPage

Name

Options

Owner

PrintRange

PrintToFile

Tag

ToPage

VCLComObject


TPrintDialog.Collate
TPrintDialog.Collate3346004

TPrintDialog	参照

Collate プロパティは，［部単位で印刷(O)］チェックボックスが選択されているかどうかを示します。

property Collate: Boolean;

説明

［印刷］ダイアログで［部単位で印刷(O)］チェックボックスがチェックされているときには必ず Collate は True です。チェックボックスをチェックしてダイアログを開くようにするには，オブジェクトインスペクタまたはプログラムコードで Collate を True に設定します。


TPrintDialog.Copies
TPrintDialog.Copies3346005

TPrintDialog	参照

Copies プロパティは，［印刷］ダイアログで選択されている印刷部数を示します。

property Copies: Integer;

説明

Copies が 0 または 1 ならば，ダイアログの［部数(C)］項目の値は 1 です。印刷部数を 2 以上に指定してダイアログを開くには，オブジェクトインスペクタまたはプログラムコードで Copies の値を設定してください。


TPrintDialog.FromPage
TPrintDialog.FromPage3346006

TPrintDialog	参照

FromPage プロパティは，印刷ジョブをどのぺージから開始するかを示します。

property FromPage: Integer;

説明

FromPage プロパティは［印刷］ダイアログの［ページから(F)］項目に対応します。


TPrintDialog.MaxPage
TPrintDialog.MaxPage3346007

TPrintDialog	参照

MaxPage プロパティは，印刷するページを指定するときにユーザーが入力できる最大ページ番号を指定します。

property MaxPage: Integer;

説明

ユーザーが MaxPage より大きな値を指定しようとするとエラーメッセージが表示されます。

注意

ユーザーがページ番号を指定できるのは Options で poPageNums フラグが設定されている場合だけです。poPageNums がオンならば，MaxPage には MinPage より大きな値を指定しないと［印刷］ダイアログが開きません。


TPrintDialog.MinPage
TPrintDialog.MinPage3346008

TPrintDialog	参照

MinPage プロパティは，印刷するページを指定するときにユーザーが入力できる最小ページ番号を指定します。

property MinPage: Integer;

説明

ユーザーが MinPage より小さな値を指定しようとするとエラーメッセージが表示されます。

注意

ユーザーがページ番号を指定できるのは Options で poPageNums フラグが設定されている場合だけです。poPageNums がオンならば，MaxPage には MinPage より大きな値を指定しないと［印刷］ダイアログが開きません。


TPrintDialog.Options
TPrintDialog.Options3346009

TPrintDialog	参照

Options プロパティは，［印刷］ダイアログの表示と動作を指定します。

TPrintDialogOption = (poPrintToFile, poPageNums, poSelection, poWarning, poHelp, poDisablePrintToFile);

TPrintDialogOptions = set of TPrintDialogOption;

property Options: TPrintDialogOptions;

説明

以下に Options の値を示します。

値	意味

poDisablePrintToFile	［ファイルへ出力(L)］チェックボックスを選択不可能（淡色表示）にする（poPrintToFile フラグが設定されている場合のみ適用可能）

poHelp	［ヘルプ(H)］ボタンがダイアログに表示される。Windows 95 のバージョンによっては機能しない場合がある

poPageNums	［ページ指定(G)］ラジオボタンが使用可能になり，ユーザーは印刷するページ範囲を指定できる

poPrintToFile	［ファイルへ出力(L)］チェックボックスをダイアログに表示する

poSelection	［選択した部分(S)］ラジオボタンが使用可能になり，ユーザーは選択したテキスト（強調表示）を印刷できる

poWarning	ユーザーがインストールされていないプリンタに印刷ジョブを送ろうとした場合に警告メッセージが表示される

デフォルト値では，すべてのオプションフラグはオフです。


TPrintDialog.PrintRange
TPrintDialog.PrintRange3346010

TPrintDialog	参照

PrintRange プロパティは，ダイアログで選択されている印刷範囲の種類を決めます。

TPrintRange = (prAllPages, prSelection, prPageNums);

property PrintRange: TPrintRange;

説明

PrintRange の値は［印刷］ダイアログの［すべて(A)］，［選択した部分(S)］，および［ページ指定(G)］ラジオボタンに対応します。

値	意味

prAllPages	［すべて(A)］ラジオボタンが選択される

prSelection	［選択した部分(S)］ラジオボタンが選択される

prPageNums	［ページ指定(G)］ラジオボタンが選択される

ダイアログが開いたときにデフォルトでどのラジオボタンが選択されるかを指定するには，オブジェクトインスペクタまたはプログラムコードで PrintRange の値を設定してください。

注意

［ページ指定(G)］ラジオボタンを使用可能にするには，Options で poPageNums フラグを設定してください。［選択した部分(S)］ラジオボタンを使用可能にするには，Options で poSelection フラグを設定し，MaxPage に MinPage より大きな値を設定してください。


TPrintDialog.PrintToFile
TPrintDialog.PrintToFile3346011

TPrintDialog	参照

PrintToFile プロパティは，［ファイルへ出力(L)］チェックボックスが選択されているかどうかを示します。

property PrintToFile: Boolean;

説明

ダイアログで［ファイルへ出力(L)］チェックボックスが選択されているときには PrintToFile は必ず True です。チェックボックスを選択してダイアログを開くようにするには，オブジェクトインスペクタまたはプログラムコードで PrintToFile を True に設定します。

注意

ダイアログで［ファイルへ出力(L)］チェックボックスを表示するには，Options で poPrintToFile フラグを設定してください。［ファイルへ出力(L)］チェックボックスを選択不可（淡色表示）にするには poDisablePrintToFile フラグを設定してください。


TPrintDialog.ToPage
TPrintDialog.ToPage3346012

TPrintDialog	参照

ToPage プロパティは，印刷ジョブの終了ページを示します。

property ToPage: Integer;

説明

ToPage プロパティは［印刷］ダイアログの［ページまで(T)］項目に対応します。


TPrintDialog イベント3346013

TPrintDialog	アルファベット順	凡例

TCommonDialog からの継承

OnClose

OnShow


TPrintDialog イベント3346014

TPrintDialog	オブジェクト順	凡例

OnClose

OnShow


TPrintDialog メソッド3346015

TPrintDialog	アルファベット順

TPrintDialog

Execute

TCommonDialog からの継承

Create

TComponent からの継承

Destroy

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TPrintDialog メソッド3346016

TPrintDialog	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Execute

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TPrintDialog.Execute
TPrintDialog.Execute3346017

TPrintDialog

Execute メソッドは，［印刷］ダイアログボックスを表示します。

function Execute: Boolean; override;

説明

Execute メソッドは［印刷］ダイアログを開いてユーザーが［OK］をクリックしたときに True を返し，［キャンセル］をクリックすると False を返します。


スコープ3346018

published

読み出し／書き込み

読み出し専用


スコープ3346019

published


継承3346020

TObject

TPersistent

TComponent

TCommonDialog


TPrintDialog 例3346021

TPrintDialog


TPrinter
TPrinter3347001

継承	プロパティ	メソッド	参照

TPrinter オブジェクトは，Windows のプリンタインターフェースをカプセル化します。

ユニット

printers

説明

TPrinter オブジェクトのインスタンスとして Printer 変数が Printers ユニット内で宣言されています。この変数を使ってプリンタを使用します。uses 節に TPrinter オブジェクトのプロパティまたはメソッドを実現するユニット Printers を追加してください。

フォームの印刷イメージをどのように表示するか決めるには，TForm コンポーネントの PrintScale プロパティを使います。

Text 変数またはプリンタのキャンバスを介してレンダリングが終了したときに，印刷ジョブが開始されます。このジョブは EndDoc メソッドが呼び出されるか，または AssignPrn 手続きによって結び付けられた Text 変数が閉じるまで開いたままです。プリントマネージャ（およびネットワークヘッダーページ）に表示されるタイトルは Title プロパティで指定します。印刷ジョブを開始するには BeginDoc メソッドを呼び出します。プリンタに正しく送信された印刷ジョブを終了するには，EndDoc メソッドを呼び出します。問題が発生し，プリンタに正しく送信されなかった印刷ジョブを終了する必要がある場合は，Abort メソッドを呼び出します。


TPrinter プロパティ3347002

TPrinter	アルファベット順	凡例

TPrinter

Aborted

Canvas

Capabilities

Copies

Fonts

Handle

Orientation

PageHeight

PageNumber

PageWidth

PrinterIndex

Printers

Printing

Title


TPrinter プロパティ3347003

TPrinter	オブジェクト順	凡例

Aborted

Canvas

Capabilities

Copies

Fonts

Handle

Orientation

PageHeight

PageNumber

PageWidth

PrinterIndex

Printers

Printing

Title


TPrinter.Aborted
TPrinter.Aborted3347004

TPrinter	参照

Aborted プロパティは，ユーザーが印刷ジョブを（Abort メソッドを呼び出して）強制終了したかどうかを判断するために使います。

property Aborted: Boolean;

説明

Aborted プロパティが True ならば印刷ジョブは強制終了されています。Aborted プロパティが False ならば印刷ジョブは強制終了されていません。


TPrinter.Canvas
TPrinter.Canvas3347005

TPrinter	参照

Canvas プロパティは，現在出力中のページの画面を表します。

property Canvas: TCanvas;

説明

Canvas プロパティは出力中のページの画面を表します。Canvas オブジェクトの Brush，Font，および Pen プロパティを使って，画像やテキストがページ上でどのように表示されるかを決めます。

注意

グラフィック機能のないプリンタもあります。そのようなプリンタでは Draw，StretchDraw，および CopyRect メソッドは無効です。


TPrinter.Capabilities
TPrinter.Capabilities3347006

TPrinter

Capabilities プロパティは，プリンタデバイスドライバの現在の設定です。

TPrinterCapability = (pcCopies, pcOrientation, pcCollation);

TPrinterCapabilities = set of TPrinterCapability;

property Capabilities: TPrinterCapabilities;

説明

Capabilities プロパティは，プリンタの機能として，印刷方向，印刷部数，および照合が選択されているかどうかを示します。


TPrinter.Copies
TPrinter.Copies3347007

TPrinter

Copies プロパティは印刷部数を返します。

property Copies: Integer;

説明

Copies プロパティは，印刷部数を選択するように設定されているデバイスモードからの情報を返します。


TPrinter.Fonts
TPrinter.Fonts3347008

TPrinter

Fonts プロパティは，現在のプリンタがサポートするフォントのリストを保持します。

property Fonts: TStrings;

説明

Fonts プロパティは，プリンタのサポートするフォントのリストが取得できます。プリンタでは本来使えなくても，リストには TrueType フォントが含まれています。印刷ジョブが TrueType フォントを使うと，Windows グラフィックデバイスインターフェース（GDI）が正確に TrueType フォントを印字できるためです。


TPrinter.Handle
TPrinter.Handle3347009

TPrinter

Handle プロパティは，プリンタオブジェクトのハンドルへのアクセスを提供します。

property Handle: HDC;

説明

Handle プロパティを使うと，プリンタオブジェクトのハンドルにアクセスできます。


TPrinter.Orientation
TPrinter.Orientation3347010

TPrinter

Orientation プロパティは，印刷ジョブでページを垂直方向と水平方向のどちらに印刷するかを決めます。

TPrinterOrientation = (poPortrait, poLandscape);

property Orientation: TPrinterOrientation;

説明

Orientation プロパティは，印刷ジョブで水平方向または垂直方向のどちらで印刷するか決めます。

TPrinterOrientation は Orientation プロパティの型です。以下に TPrinterOrientation の値を示します。

値	意味

poPortrait	印刷ジョブでページを垂直方向に印刷する

poLandscape	印刷ジョブでページを水平方向に印刷する


TPrinter.PageHeight
TPrinter.PageHeight3347011

TPrinter	参照

PageHeight プロパティは，現在印刷中のページの高さをピクセル単位で示します。

property PageHeight: Integer;

説明

PageHeight プロパティは，現在印刷中のページの高さがピクセル単位で取得できます。


TPrinter.PageNumber
TPrinter.PageNumber3347012

TPrinter	参照

PageNumber プロパティは，印刷されているページの番号を示します。

property PageNumber: Integer;

説明

PageNumber プロパティは，現在印刷中のページのページ番号を取得できます。NewPage メソッドが呼び出されるたびに，PageNumber プロパティはインクリメントされます。

注意

このプロパティは Text 変数を使用して印刷するとき，ページの最後の行で改行（CR）に達した場合にもインクリメントされます。


TPrinter.PageWidth
TPrinter.PageWidth3347013

TPrinter	参照

PageWidth プロパティは，現在印刷中のページの幅をピクセル単位で示します。

property PageWidth: Integer;

説明

PageWidth プロパティは，現在印刷中のページの幅がピクセル単位で取得できます。


TPrinter.PrinterIndex
TPrinter.PrinterIndex3347014

TPrinter	参照

PrinterIndex プロパティは，Printers プロパティのリストにあるプリンタから現在のプリンタを指定します。

property PrinterIndex: Integer;

説明

PrinterIndex プロパティの値は現在選択されているプリンタです。この値が変更されると，EndDoc メソッドが自動的に呼び出されます。デフォルトのプリンタを選択するには，PrinterIndex プロパティの値を -1 に設定します。

インストールされているプリンタのリストは Printers プロパティで見つかります。現在のプリンタのサポートするフォントのリストは Fonts プロパティで見つかります。


TPrinter.Printers
TPrinter.Printers3347015

TPrinter	参照

Printers プロパティは，Windows にインストールされているすべてのプリンタのリストを示します。

property Printers: TStrings;

説明

インストールされているプリンタのリストは Printers プロパティで見つかります。PrinterIndex プロパティの値は現在選択されているプリンタです。現在のプリンタのサポートするフォントのリストは Fonts プロパティで見つかります。


TPrinter.Printing
TPrinter.Printing3347016

TPrinter	参照

Printing プロパティは，印刷ジョブが実行中かどうか示します。

property Printing: Boolean;

説明

Printing プロパティは，印刷ジョブが実行中かどうかわかります。

Printing プロパティはアプリケーションがすでに BeginDoc メソッドを呼び出しており，EndDoc メソッド（または Abort メソッド）がまだ呼び出されていないときに True になります。


TPrinter.Title
TPrinter.Title3347017

TPrinter

Title プロパティは，プリントマネージャとネットワークヘッダーページに一覧表示するテキストを決めます。

property Title: string;

説明

Title プロパティはプリントマネージャおよびネットワークタイトルページで使われます。


TPrinter メソッド3347018

TPrinter	アルファベット順

TPrinter

Abort

BeginDoc

Create

Destroy

EndDoc

GetPrinter

NewPage

SafeCallException

SetPrinter

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TPrinter メソッド3347019

TPrinter	オブジェクト順

Abort

BeginDoc

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

EndDoc

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetPrinter

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

NewPage

SafeCallException

SetPrinter


TPrinter.Abort
TPrinter.Abort3347020

TPrinter	参照

Abort メソッドは，印刷ジョブを中断し，印刷が終わっていないデータをすべて破棄します。

procedure Abort;

説明

印刷ジョブを強制終了するには Abort メソッドを使い，正常終了するには EndDoc メソッドを使います。

Abort が呼び出されると，デバイスは次の印刷ジョブを実行できます。


TPrinter.BeginDoc
TPrinter.BeginDoc3347021

TPrinter	参照

BeginDoc メソッドは，印刷ジョブをプリンタに送ります。

procedure BeginDoc;

説明

BeginDoc メソッドは印刷ジョブをプリンタに送ります。印刷ジョブを送り終えたら印刷ジョブを終了するための EndDoc メソッドを呼び出さなくてはなりません。EndDoc メソッドを呼び出さないと実際の印刷は始まりません。


TPrinter.Create
TPrinter.Create3347022

TPrinter	参照

Create メソッドは，プリンタをインスタンス化します。

constructor Create;

説明

Create メソッドを直接呼び出さないでください。Create は自動的に呼び出され，プリンタをインスタンス化します。Create メソッドはプリンタにメモリを割り当て，継承した Create メソッドを呼び出します。その後，ドライバ，デバイス，およびポートを適切に設定します。


TPrinter.Destroy
TPrinter.Destroy3347023

TPrinter	参照

Destroy メソッドは，プリンタのインスタンスを破棄します。

destructor Destroy; override;

説明

Destroy を直接呼び出さないでください。プリンタオブジェクトは自動的に作成され破棄されます。

Destroy メソッドは現在の印刷ジョブが終了したかを確認し，ハンドル，フォント，キャンバスなどのリソースを解放してから，プリンタを閉じ，継承した Destroy メソッドを呼び出します。


TPrinter.EndDoc
TPrinter.EndDoc3347024

TPrinter	参照

EndDoc メソッドは，現在の印刷ジョブを終了してテキストファイル変数を閉じます。

procedure EndDoc;

説明

EndDoc メソッドは印刷ジョブを終了し，現在開いている Text を閉じます。印刷ジョブは，EndDoc メソッドが呼び出された後にプリンタで印刷されます。

アプリケーションが EndDoc メソッドを呼び出すとプリンタは印刷を開始します。印刷ジョブをプリンタに正常に送信できたら EndDoc メソッドを使います。印刷ジョブを正常に送信できない場合は Abort メソッドを使います。


TPrinter.GetPrinter
TPrinter.GetPrinter3347025

TPrinter	参照

GetPrinter メソッドは，現在のプリンタを取り出します。

procedure GetPrinter (ADevice, ADriver, APort: PChar; var ADeviceMode: THandle);

説明

直接 GetPrinter メソッドを呼び出す必要はありません。かわりに，Printers プロパティでプリンタにアクセスします。詳細は Windows API の CreateDC 関数を参照してください。


TPrinter.NewPage
TPrinter.NewPage3347026

TPrinter	参照

NewPage メソッドは，新しいページをスタートし，PageNumber プロパティをインクリメントします。

procedure NewPage;

説明

NewPage メソッドは現在の印刷ジョブをプリンタの新しいぺージに出力します。

NewPage メソッドは，PageNumber プロパティの値をインクリメントし，Canvas の Pen プロパティの値を（0，0）にリセットします。


TPrinter.SetPrinter
TPrinter.SetPrinter3347027

TPrinter	参照

SetPrinter メソッドは，現在のプリンタを指定します。

procedure SetPrinter(ADevvice, ADriver, APort: PChar; ADeviceMode: THandle);

説明

直接 SetPrinter メソッドを呼び出さないください。Printers プロパティでプリンタにアクセスしてください。詳細は Windows API の CreateDC 関数を参照してください。


読み出し／書き込み3347028

読み出し専用


継承3347029

TObject


TPrinter 例3347030

TPrinter


TPropertyPage
TPropertyPage3348001

継承	プロパティ	メソッド	イベント	参照

TPropertyPage は，ActiveX コントロールのプロパティページとして使う Delphi のフォームを実装する抽象クラスです。

ユニット

axctrls

説明

TPropertyPage は，ActiveX のプロパティページダイアログボックス内のフォームを埋め込むために必要な機能を追加して TForm を拡張します。プロパティ値をオブジェクトからフォームコントロール（またはその逆）へコピーするためのメソッドも追加します。

ActiveX オブジェクトの独自のプロパティページを実装するには，新しいクラスを TPropertyPage から派生させ，フォームを設計してから，UpdateObject および UpdatePropertyPage メソッドをオーバーライドしてください。Delphi IDE はスケルトンプロパティページも提供します。詳細についてはプログラマーズガイドを参照してください。

TPropertyPage は，ユーザーがフォーム上のコントロールを変更したときにフォームが呼び出せるヘルパーメソッド Modified を提供します。Modified メソッドを呼び出すと，ユーザーがオブジェクトのプロパティを変更したことがプロパティのダイアログボックスに通知されます。通常は，これによってコントロールの変更を適用する処理を行います。

プロパティページは OleObject プロパティを使って編集中のオブジェクトへの接続を保持します。このプロパティは Variant でオブジェクトのプロパティを読み書きするのに使います。


TPropertyPage プロパティ3348002

TPropertyPage	アルファベット順	凡例

TPropertyPage

OleObject

TCustomForm からの継承

Active

ActiveControl

ActiveOleControl

Canvas

ClientHeight

ClientRect

ClientWidth

Designer

DropTarget

HelpFile

KeyPreview

Menu

ModalResult

OleFormObject

Parent

PixelsPerInch

PrintScale

Scaled

Visible

WindowState

TScrollingWinControl からの継承

AutoScroll

HorzScrollBar

VertScrollBar

TWinControl からの継承

Brush

ClientOrigin

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

Color

ControlState

ControlStyle

Cursor

Enabled

Font

Height

Hint

Left

Name

ParentFont

PopupMenu

ShowHint

Top

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TPropertyPage プロパティ3348003

TPropertyPage	オブジェクト順	凡例

Active

ActiveControl

ActiveOleControl

Align

AutoScroll

BoundsRect

Brush

Canvas

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

Designer

DesignInfo

DropTarget

Enabled

Font

Handle

Height

HelpContext

HelpFile

Hint

HorzScrollBar

KeyPreview

Left

Menu

ModalResult

Name

OleFormObject

OleObject

Owner

Parent

ParentFont

ParentWindow

PixelsPerInch

PopupMenu

PrintScale

Scaled

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

VertScrollBar

Visible

Width

WindowProc

WindowState


TPropertyPage.OleObject
TPropertyPage.OleObject3348004

TPropertyPage	参照

OleObject プロパティは，編集される ActiveX コントロールを参照するためのものです。

property OleObject: Variant;

説明

OleObject プロパティは，コントロールのプロパティ値およびメソッドにアクセスするために使われます。


TPropertyPage イベント3348005

TPropertyPage	アルファベット順	凡例

TCustomForm からの継承

OnActivate

OnClose

OnCreate

OnDeactivate

OnDestroy

OnHide

OnPaint

OnResize

OnShow

TWinControl からの継承

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnMouseDown

OnMouseMove

OnMouseUp


TPropertyPage イベント3348006

TPropertyPage	オブジェクト順	凡例

OnActivate

OnClick

OnClose

OnCreate

OnDblClick

OnDeactivate

OnDestroy

OnDragDrop

OnDragOver

OnHide

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnPaint

OnResize

OnShow


TPropertyPage メソッド3348007

TPropertyPage	アルファベット順

TPropertyPage

EnumCtlProps

Modified

UpdateObject

UpdatePropertyPage

TCustomForm からの継承

Close

CloseQuery

Create

CreateNew

DefocusControl

Destroy

FocusControl

GetFormImage

Hide

Print

Release

SendCancelMode

SetFocus

SetFocusedControl

Show

ShowModal

WantChildKey

TScrollingWinControl からの継承

DisableAutoRange

EnableAutoRange

ScrollInView

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TPropertyPage メソッド3348008

TPropertyPage	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Close

CloseQuery

ContainsControl

ControlAtPos

Create

CreateNew

CreateParented

DefaultHandler

DefocusControl

Destroy

DestroyComponents

Destroying

DisableAlign

DisableAutoRange

Dispatch

DragDrop

Dragging

EnableAlign

EnableAutoRange

EndDrag

EnumCtlProps

FieldAddress

FindComponent

FocusControl

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetFormImage

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

Modified

NewInstance

PaintTo

Perform

Print

Realign

Refresh

Release

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

ScrollInView

SendCancelMode

SendToBack

SetBounds

SetFocus

SetFocusedControl

SetTextBuf

Show

ShowModal

Update

UpdateControlState

UpdateObject

UpdatePropertyPage

WantChildKey


TPropertyPage.EnumCtlProps
TPropertyPage.EnumCtlProps3348009

TPropertyPage	参照

EnumCtlProps メソッドは，フォームのコントロールで PropType 型のプロパティを検索します。

procedure EnumCtlProps(PropType: TGUID; PropNames: TStrings);

説明

EnumCtlProps メソッドは，コントロールの同じ型のプロパティのリストを PropNames に保存します。


TPropertyPage.Modified
TPropertyPage.Modified3348010

TPropertyPage	参照

Modified メソッドは，ユーザーがページ上のコントロールを編集したことをプロパティページのコンテナに通知するのに使うヘルパーメソッドです。

procedure Modified;

説明

プロパティダイアログボックスはこのメソッドの呼び出しに応答してコントロールの変更を適用する処理を行います。


TPropertyPage.UpdatePropertyPage
TPropertyPage.UpdatePropertyPage3348011

TPropertyPage	参照

UpdatePropertyPage メソッドは，プロパティ値を ActiveX オブジェクトからフォームのコントロールへコピーするために呼び出されます。

procedure UpdatePropertyPage; virtual;

説明

UpdatePropertyPage メソッドは，通常，プロパティが最初に表示されたときかユーザーがプロパティのダイアログボックスへの変更を取り消したときに呼び出されます。

プロパティ値を ActiveX オブジェクトから作成したフォームのコントロールにコピーするにはこのメソッドをオーバーライドしてください。

UpdatePropertyPage メソッドは UpdateObject の逆のこと，つまりプロパティ値をフォームのコントロールを ActiveX オブジェクトにコピーします。


TPropertyPage.UpdateObject
TPropertyPage.UpdateObject3348012

TPropertyPage	参照

UpdateObject メソッドは，プロパティ値をフォームのコントロールから ActiveX オブジェクトへコピーするために呼び出されます。

procedure UpdateObject; virtual;

説明

データをフォームのコントロールから ActiveX のプロパティにコピーするにはこのメソッドをオーバーライドしてください。

UpdateObject メソッドは UpdatePropertyPage の逆のこと，つまりプロパティ値を ActiveX オブジェクトからフォームのコントロールにコピーします。


スコープ3348013

published

読み出し／書き込み

読み出し専用


スコープ3348014

published


継承3348015

TObject

TPersistent

TComponent

TControl

TWinControl

TScrollingWinControl

TCustomForm


TPropertyPage 例3348016

TPropertyPage


TProvider
TProvider3349001

継承	プロパティ	メソッド	イベント	参照

多層アプリケーションサーバーからクライアントデータセットにデータを提供するための仕組みをデスクトップクライアントアプリケーションでカプセル化します。

ユニット

bdeprov

説明

TProvider は，通常多層アプリケーションサーバーに通常配置されるオブジェクトで，多層のデスクトップクライアントアプリケーションでリモートデータベースアプリケーションサーバーとクライアントデータセット間のデータのブローカーおよびパイプ役として機能します。プロバイダは，クライアント上のクライアントデータセットと，アプリケーションサーバー上の TQuery，TStoredProc，TTable オブジェクトとの間の仲介リンクとなる IProvider インターフェースを提供します。これは，サーバーデータセットからのデータをパッケージ化してデータパケットを作成し，クライアントデータセットに渡します。

クライアントデータセットはこのデータパケットを受け取って再構築し，ユーザーアクセス用にそのデータのローカルなメモリ内コピーを作成します。ユーザーアクセスが完了すると，クライアントデータセットは変更済みデータを再パッケージ化してその更新をアプリケーションサーバー上のプロバイダに送ります。プロバイダは，リモートデータベースサーバーに更新を適用し，可能な箇所ではレコード衝突を解決して，未解決なすべてのレコードをさらに調整するためにクライアントデータセットに送り返します。


TProvider プロパティ3349002

TProvider	アルファベット順	凡例

TProvider

Data

DataSet

TCustomProvider からの継承

Constraints

Provider

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TProvider プロパティ3349003

TProvider	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Constraints

Data

DataSet

DesignInfo

Name

Owner

Provider

Tag

VCLComObject


TProvider.Data
TProvider.Data3349004

TProvider

Data プロパティは，クライアントリクエストへの応答としてデータベースサーバーからデータを取り出します。

property Data: OleVariant;

説明

Data プロパティは読み出し専用で，使えばクライアントデータセットリクエストへの応答としてデータベースからすべてのレコードを取り出すことができます。


TProvider.DataSet
TProvider.DataSet3349005

TProvider	参照

DataSet プロパティは，プロバイダによるデータの取得元であると同時にクライアントアプリケーションの更新の送出先であるアプリケーションサーバー上のボーランドデータベースエンジン（BDE）のデータセットコンポーネントを指定します。

property DataSet: TDBDataSet;

説明

DataSet をアプリケーションサーバー上のデータモジュールでデータセットコンポーネント名に設定します。プロバイダは指定されたデータセットコンポーネントを使って，そのコンポーネントの接続先のデータベースサーバーからデータを取得し，クライアントアプリケーションの更新をデータベースサーバーに書き込みます。

DataSet は BDE 対応データセットコンポーネント，つまり Delphi が提供するコンポーネントライブラリのオブジェクト（TTable，TStoredProc，TQuery）の 1 つか，TDBDataSet から派生したカスタムコンポーネントでなければなりません。


TProvider イベント3349006

TProvider	アルファベット順	凡例

TProvider

OnGetData

OnUpdateData

OnUpdateError

TCustomProvider からの継承

OnDataRequest


TProvider イベント3349007

TProvider	オブジェクト順	凡例

OnDataRequest

OnGetData

OnUpdateData

OnUpdateError


TProvider.OnUpdateError
TProvider.OnUpdateError3349010

TProvider	参照

OnUpdateError は，プロバイダがレコードを更新しようとしてエラー状態のために果たせなかったときに発生します。

type

TUpdateKind = (ukModify, ukInsert, ukDelete);

TResolverResponse = (rrSkip, rrAbort, rrMerge, rrApply, rrIgnore);

TResolverErrorEvent = procedure(DataSet: TClientDataSet; E: EDatabaseError;

UpdateKind: TUpdateKind; var Response: TResolverResponse) of object;

property OnUpdateError: TResolverErrorEvent;

説明

OnUpateError イベントハンドラを記述すると，プロバイダがクライアントデータセットの更新をデータベースサーバーに適用するときに発生するエラー状態に応答できます。レコードを更新できないときは，提供されていれば OnUpdateError が呼び出されます。OnUpdateError エラーハンドラは各レコードの各項目の NewValue，OldValue，CurValue プロパティを使って，エラーの原因を判定し，問題の解決を試みます。

DataSet は，更新処理中にデータにアクセスするのに使う一時的なクライアントデータセットの名前です。データセットの項目コンポーネントの OldValue，NewValue，CurValue プロパティを使って各レコード内の変更された項目を表示します。

E は，アプリケーションがエラーメッセージとエラー状態の実際の原因を含む EDatabaseError オブジェクトを示すポインタです。OnUpdateError ハンドラは，この情報を使ってエラー状態への応答方法を指定できます。

UpdateKind は，エラーを生成した更新のタイプを記述します。以下に UpdateKind の値とその意味を示します。

値	意味

ukModify	エラーの原因になった既存のレコードを編集する

ukInsert	エラーの原因になった新しいレコードを挿入または追加する

ukDelete	エラーを発生させた既存のレコードを削除する

Response は OnUpdateError ハンドラが存在するときに実行するアクションを示します。ハンドラへのエントリでは，Response は OnUpdateError をトリガする ApplyUpdates 関数に渡される MaxErrors に基づいて rrAbort または rrSkip に設定されます。MaxErrors が 0 ならば，Response は rrAbort です。それ以外の場合は rrSkip です。OnUpdateError がエラーを処理または訂正できる場合には，エラーハンドラから抜ける前に Response を rrCorrect に設定します。以下に Response の値とその意味を示します。

値	意味

rrSkip	エラー状態を発生させたレコードの更新を飛ばして，適用していない変更をキャッシュに残しておく

rrAbort	エラーメッセージを表示せずに処理をアボートする

rrMerge	変更済みレコードをデータベースのレコードとマージする

rrCorrect	データベースのレコードをこのレコードで訂正する

rrApply	訂正された更新をデータベースに適用する

rrIgnore	エラー状態を無視し，レコードを更新しない

注意

OnUpdateError ハンドラのコードは，別のレコードを現在のレコードにするいかなるメソッドも呼び出してはいけません。


TProvider メソッド3349011

TProvider	アルファベット順

TProvider

ApplyUpdates

Create

GetRecords

Reset

SetParams

TComponent からの継承

Destroy

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TProvider メソッド3349012

TProvider	オブジェクト順

ApplyUpdates

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetRecords

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

Reset

SafeCallException

SetParams


TProvider.ApplyUpdates
TProvider.ApplyUpdates3349013

TProvider	参照

ApplyUpdates メソッドは，クライアントデータセットから受け取った更新をリモートデータベースサーバーに接続されているデータセットに適用します。

function ApplyUpdates(Delta: OleVarant; MaxErrors: Integer;
out ErrorCount: Integer); OleVariant;

説明

ApplyUpdates メソッドを呼び出すと，クライアントの更新をデータベースサーバーに書き込めます。Delta は，データベースに書き込むためのクライアントの更新済み，挿入済み，削除済みレコードを保持するバリアント配列です。MaxErrors は，更新処理を中止する前に許容されるエラーの最大数を示します。ErrorCount は更新処理で検出された実際のエラー数を示します。ErrorCount が MaxErrors より大きい場合，または解決できなかったレコードで OnUpdateError イベントが rrAbort を返す場合は，それまでに正常に適用された更新はすべてロールバックされ，更新処理は中止されます。

OnUpdateError イベントハンドラをプロバイダに提供すると，Delta 内のレコードを更新できないときにそれが必ず自動的に呼び出されます。OnUpdateError ハンドラは，うまく更新できていないレコードをクライアントデータセットに返す前に，エラー状態を訂正してもう一度やり直す機会を提供してくれます。更新できないレコードは，変換される結果配列に格納されてから，すべてのレコードの処理後にさらに調整するためにクライアントデータセットに返されます。

ApplyUpdates は，データベースに適用できなかったすべてのレコードを保持するデータパケットであるバリアントを返します。


TProvider.Create
TProvider.Create3349014

TProvider	参照

Create メソッドは，TProvider コンポーネントのインスタンスを作成します。

constructor Create(AOwner: TComponent);

説明

Create メソッドを呼び出すと，実行時にプロバイダコンポーネントのインスタンスを作成できます。通常，設計時にアプリケーションサーバーのデータモジュールにプロバイダコンポーネントを配置すると，そのコンポーネントが実行時に自動的に作成されます。

Create は継承 Create メソッドを呼び出し，BDE 対応のデータセットがプロバイダを所有している場合には BDE 対応データセットコンポーネントを指し，Constraints プロパティを True に設定します。


TProvider.GetRecords
TProvider.GetRecords3349015

TProvider	参照

GetRecords メソッドは，プロバイダのデータセットから指定数のレコードを取り出します。

function GetRecords(Count: Integer; out RecsOut: Integer); Variant;;

説明

GetRecords メソッドを呼び出すと，プロバイダのデータセットから指定した数のレコードを取り出せます。Count は取り出すレコードの数を示します。Count が －1 の場合，すべてのレコードが取り出されます。Count が 0 の場合，メタデータレコードのみが取り出されます。RecsOut は，取り出された実際のレコード数を示します。GetRecords データパケットが入ったバリアントを返します。

クライアントアプリケーションは，データセットから利用可能なすべてのレコードの一部を取り出すためにプロバイダの GetRecords メソッドを呼び出します。GetRecords が特に役立つのは，非常に大きなデータセットを処理する場合や，BLOB 項目を持つデータセットを扱う場合です。

注意

すべてのレコードを同時に取り出すには，GetRecords ではなく Get_Data を呼び出します。


TProvider.Reset
TProvider.Reset3349016

TProvider	参照

Reset メソッドは，プロバイダがレコードの連続パケットをデータセットの先頭からフェッチし始めるのを可能にします。

procedure Reset(MetaData: Boolean);

説明

プロバイダは通常，データベースサーバーからレコードの連続パケットをフェッチします。サーバーに 100 個のレコードが入っていて，（クライアントのリクエストに基づいて）プロバイダが一度に 10 個のレコードをフェッチすると，最初のフェッチで 1 から 10 まで，2 度めで 11 から 20 まで、というようにレコードが取り出されます。

MetaData は，レコードのフェッチのための次の呼び出しでメタデータが入るかどうかを示します。MetaData が True ならば，次回のフェッチはメタデータを返します。False ならば，データのみが返されます。

Reset を呼び出すと，プロバイダにもう一度データセットの先頭からレコードパケットのフェッチを開始させることができます。それ以外の場合，GetRecords への前の呼び出しでフェッチされた最後のレコードの次のレコードから各フェッチ処理が開始されます。


スコープ3349017

published

読み出し／書き込み

読み出し専用


スコープ3349018

published


継承3349019

TObject

TPersistent

TComponent

TCustomProvider


TProvider 例3349020

TProvider


TPrinterSetupDialog
TPrinterSetupDialog3350001

継承	プロパティ	メソッド	イベント	参照

TPrinterSetupDialog コンポーネントは，プリンタの環境設定用の［プリンタの設定］ダイアログボックスを表示します。

ユニット

dialogs

説明

TPrinterSetupDialog はプリンタの環境設定用のモード付き Windows ダイアログボックスを表示します。ダイアログの内容は，使用するプリンタドライバによって異なります。

ダイアログボックスは，実行時には Execute メソッドを呼び出してアクティブにされるまで表示されません。


TPrinterSetupDialog プロパティ3350002

TPrinterSetupDialog	アルファベット順	凡例

TCommonDialog からの継承

Ctl3D

Handle

HelpContext

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TPrinterSetupDialog プロパティ3350003

TPrinterSetupDialog	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Ctl3D

DesignInfo

Handle

HelpContext

Name

Owner

Tag

VCLComObject


TPrinterSetupDialog イベント3350004

TPrinterSetupDialog	アルファベット順	凡例

TCommonDialog からの継承

OnClose

OnShow


TPrinterSetupDialog イベント3350005

TPrinterSetupDialog	オブジェクト順	凡例

OnClose

OnShow


TPrinterSetupDialog メソッド3350006

TPrinterSetupDialog	アルファベット順

TPrinterSetupDialog

Execute

TCommonDialog からの継承

Create

TComponent からの継承

Destroy

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TPrinterSetupDialog メソッド3350007

TPrinterSetupDialog	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Execute

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TPrinterSetupDialog.Execute
TPrinterSetupDialog.Execute3350008

TPrinterSetupDialog

Execute メソッドは，プリンタの環境設定ダイアログボックスを表示します。

function Execute: Boolean; override;

説明

Execute メソッドは，［プリンタの設定］ダイアログを開いてユーザーが［OK］をクリックしたときに True を返します。


スコープ3350009

published

読み出し／書き込み

読み出し専用


スコープ3350010

published


継承3350011

TObject

TPersistent

TComponent

TCommonDialog


TPrinterSetupDialog 例3350012

TPrinterSetupDialog


TQuery
TQuery3351001

継承	プロパティ	メソッド	イベント	参照	例

TQuery コンポーネントは，SQL 文をベースにした結果セットを使ってデータセットをカプセル化します。

ユニット

dbtables

説明

TQuery コンポーネントは，SQL 文でデータベースにアクセスするとき使うコンポーネントです。Query コンポーネントは，Sybase，SQL Server，Oracle，Informix，DB2，InterBase などのリモートデータベース，および Paradox，dBASE，Access，FoxPro，さらには ODBC 準拠データベースとともに使用できます。

Query コンポーネントが役に立つのは，次のためです。

・	一度に複数のテーブルにアクセスできる（SQL では「結合」という）

・	元のテーブルの行や列をすべて返すのではなく，行や列のサブセットに自動的にアクセスする

注意

TQuery コンポーネントは，スケーラブルなデータベースアプリケーションを開発するとき特に有効です。ローカルデータベース上で実行するように構築されたアプリケーションであっても将来，リモート SQL データベースサーバーにスケールアップする機会が多少でもあるのであれば，あとで簡単にスケールアップできるように最初から TQuery コンポーネントを使ってアプリケーションを作っておくのがいいでしょう。


TQuery プロパティ3351002

TQuery	アルファベット順	凡例

TQuery

Constrained

DataSource

Local

ParamCheck

ParamCount

Params

Prepared

RequestLive

RowsAffected

SQL

SQLBinary

StmtHandle

Text

UniDirectional

TDBDataSet からの継承

Database

DatabaseName

DBHandle

DBLocale

DBSession

Provider

SessionName

UpdateMode

TBDEDataSet からの継承

CacheBlobs

CachedUpdates

CanModify

ExpIndex

Filter

Filtered

FilterOptions

Handle

KeySize

Locale

RecNo

RecordCount

RecordSize

UpdateObject

UpdateRecordTypes

UpdatesPending

TDataSet からの継承

Active

AutoCalcFields

BOF

Bookmark

Constraints

DefaultFields

Designer

EOF

FieldCount

FieldDefs

Fields

FieldValues

Found

Modified

Name

State

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TQuery プロパティ3351003

TQuery	オブジェクト順	凡例

Active

AutoCalcFields

BOF

Bookmark

CacheBlobs

CachedUpdates

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Constrained

Constraints

Database

DatabaseName

DataSource

DBHandle

DBLocale

DBSession

DefaultFields

Designer

DesignInfo

EOF

ExpIndex

FieldCount

FieldDefs

Fields

FieldValues

Filter

Filtered

FilterOptions

Found

Handle

KeySize

Local

Locale

Modified

Name

Owner

ParamCheck

ParamCount

Params

Prepared

Provider

RecNo

RecordCount

RecordSize

RequestLive

RowsAffected

SessionName

SQL

SQLBinary

State

StmtHandle

Tag

Text

UniDirectional

UpdateMode

UpdateObject

UpdateRecordTypes

UpdatesPending

VCLComObject


TQuery.Constrained
TQuery.Constrained3351004

TQuery	参照

Constrained プロパティは，SELECT 文によって生成された結果セットに適合しない更新と挿入を，Paradox テーブルと dBASE テーブルに対してできるかどうかを指定します。

property Constrained: Boolean;

説明

Constrained プロパティは，結果セットを生み出した SELECT 文の WHERE 句条件を満たさない複数の値が UPDATE 文または INSERT 文に含まれているとき，結果セットのもとである Paradox テーブルまたは dBASE テーブルに，編集や挿入ができるかどうかがわかります。このプロパティはライブ結果セットにしか適用できません。Constrained プロパティは編集中に実行されます。

Constrained プロパティが False（デフォルト）の場合，SELECT 文の基準に関係なく，更新または挿入できます。True の場合，SELECT 文の基準に反すれば更新も挿入もできません。

例えば，Constrained プロパティが True で，問い合わせコンポーネントの SQL プロパティが以下のものとします。

SELECT * FROM CUSTOMERS

  WHERE (CUSTNO > 1400 AND CUSTNO < 1500)

この場合，CustNo に範囲外の値を入れることはできません。


TQuery.DataSource
TQuery.DataSource3351006

TQuery	参照

DataSource プロパティは，データソースコンポーネントを指定します。このコンポーネントから項目値を取り出して，SQL 文内のまだ値が代入されていないパラメータをバインドします。

property DataSource: TDataSource;

説明

DataSource プロパティには，バインドに使う現在の項目値の取り出し元であるデータソースコンポーネントの名前を設定します。このプロパティには他のデータセットを指定しないといけません。現在の問い合わせコンポーネントをしていすることはできません。

DataSource プロパティで指定されたデータセットを作成し，データを格納します。次いで，それを開いてから，パラメータをバインドします。パラメータのバインドは，問い合わせ実行の前に Prepare メソッドを呼び出すことで行われます。

参考

DataSource プロパティが特に役立つのは，リンク問い合わせを使ってテーブル間にマスターリンクを生成するときです。また，まだ Params プロパティや ParamByName メソッド呼び出しによって設定されていないパラメータをバインドできることも，便利です。

SQL 文にパラメータがない場合，あるいはすべてのパラメータが Params プロパティや ParamByName メソッドを使ってアプリケーションによってバインドされている場合，DataSource プロパティを割り当てる必要はありません。


TQuery.Local
TQuery.Local3351007

TQuery	参照

Local プロパティは，問い合わせが，リモートサーバー上の SQL テーブルではなく，1 つまたは複数の Paradox テーブルまたは dBASE テーブルを参照するかどうかを示します。

property Local: Boolean;

説明

Local プロパティは，問い合わせが，SQL テーブルではなく 1 つまたは複数の Paradox テーブルあるいは dBASE テーブルにアクセスするかどうかがわかります。Local が True ならば，問い合わせは dBASE テーブルまたは Paradox テーブルにしかアクセスしません。False ならば，SQL テーブルにもアクセスします。Local は，問い合わせの実行前，Prepare メソッドを呼び出すとき自動的に設定されます。

Constrained プロパティなど，Paradox テーブルまたは dBASE テーブルに対して問い合わせるときしか意味がない問い合わせコンポーネント設定があります。他の問い合わせコンポーネント設定は，リモート SQL サーバーに対する問い合わせにだけ意味があります。Local プロパティは，データベースのタイプに応じてコード内のロジックに分岐するとき役立つ情報を持っています。さらに，このプロパティによって，BDE が，SQL 文を直接リモートサーバーに渡さずにローカル問い合わせエンジンを使って問い合わせを解析したかどうかもわかります。


TQuery.ParamCheck
TQuery.ParamCheck3351008

TQuery	参照

ParamCheck プロパティは，実行時に SQL プロパティが変化した場合，問い合わせのパラメータリストを再生成するかどうかを示します。

property ParamCheck: Boolean;

説明

ParamCheck プロパティを設定すると，実行時に SQL プロパティが変更された場合，Params プロパティをいったんクリアしてから再び生成するかどうかを指定できます。デフォルトではこのプロパティは True で，Params プロパティを再生成することになります。True の場合，現在の SQL 文についてパラメータの数を正しく生成することが保証されます。

このプロパティは，パラメータを持つデータ定義文を定義するとき（問い合わせコンポーネントを使って InterBase の保存手続きを作成するときなど）に非常に便利です。

パラメータ付きの問い合わせを使わない場合，ParamCheck プロパティを False に設定してもよいですが，パラメータのある問い合わせを使う場合は，必ず True に設定してください。


TQuery.ParamCount
TQuery.ParamCount3351009

TQuery	参照

ParamCount プロパティは，問い合わせパラメータの現在の数を示します。

property ParamCount: Word;

説明

ParamCount プロパティをチェックすると，Params プロパティにいくつパラメータがあるかがわかります。ParamCheck プロパティが True の場合，ParamCount は常に SQL 文の実パラメータの数と一致します。

アプリケーションで，Params プロパティにパラメータを追加したり削除したりできます。この追加や削除の結果は，自動的に ParamCount に反映されます。


TQuery.Params
TQuery.Params3351010

TQuery	参照

Params プロパティは，SQL 文のパラメータを含んでいます。

property Params[Index: Word]TParams;

説明

実行時に Params プロパティにアクセスすると，パラメータの名前，値，およびデータ型を動的に設定したり，表示したりできます（設計時には，パラメータエディタでパラメータ情報を設定します）。このプロパティは，インデックス 0 から始まるパラメータレコード配列です。

注意

各パラメータの名前がわかっているときは，ParamByName メソッドを呼び出すのが，パラメータを設定したり取り出したりするもっとも簡単な方法です。ただし，ParamByName メソッドではパラメータのデータ型や名前を変更することはできません。


TQuery.Prepared
TQuery.Prepared3351011

TQuery	参照

Prepared プロパティは，問い合わせの実行準備ができているかどうかを示します。

property Prepared: Boolean;

説明

Prepared プロパティは，問い合わせの実行準備ができているかどうかがわかります。このプロパティが True なら準備ができており，False ならできていません。問い合わせの実行前に準備をする必要がなくても，事前に準備ができていれば，実行効率が上がります。パラメータのある問い合わせで，同じパラメータを使って複数回，実行するような場合，特にそうです。

注意

問い合わせの準備をしたりそれを解いたりするために，アプリケーションで，Prepared プロパティの現在の設定を変更できます。Prepared が True のときに False に設定すると，Unprepared メソッドが呼び出されて問い合わせの準備が解かれます。Prepared が False のときに True に設定すると，Prepared メソッドが呼び出されて問い合わせの準備がなされます。しかし一般的に，Prepared メソッドおよび Uprepared メソッドを直接呼び出す方がよいプログラミング習慣です。この 2 つのメソッドは自動的に Prepared プロパティを更新してくれます。


TQuery.RequestLive
TQuery.RequestLive3351012

TQuery	参照

RequestLive プロパティは，問い合わせを実行したときに，ボーランドデータベースエンジン（BDE）からライブ結果セットを受取りたいかどうかを指定します。

property RequestLive: Boolean;

説明

RequestLive プロパティを設定すると，BDE がライブ結果セットをアプリケーションに返そうと試みるかどうかを指定できます。デフォルトは False で，読み出し専用の結果セットがアプリケーションに返されます。

アプリケーションがライブ結果セットを返してほしいときは，RequestLive プロセスを True に設定します。True に設定しても，必ずライブ結果セットが返されると保証されるわけではありません。保証されるのは，BDE がライブ結果セットを返そうと試みることだけです。BDE がライブセットを返すのは，問い合わせの SELECT 構文がライブ結果セットの構文仕様に従っているときだけです。

RequestLive プロパティが True であっても，SELECT 構文の仕様があっていない場合，BDE は，Paradox または dBASE の読み出し専用結果セットを返すか，あるいはリモートサーバーのエラーリターンコードを返します。


TQuery.RowsAffected
TQuery.RowsAffected3351013

TQuery	参照

RowsAffecteed プロパティは，最新の問い合わせで実行対象だった行の数を返します。

property RowsAffected: Integer;

説明

RowsAffected プロパティは，最新の問い合わせ処理で何行が更新または削除されたかがわかります。このプロパティが -1 なら，1 行も更新または削除がされなかったことになります。


TQuery.SQL
TQuery.SQL3351014

TQuery	参照

SQL プロパティは，問い合わせを実行する SQL 文のテキストを含んでいます。

property SQL: TStrings;

説明

SQL プロパティは，ExecSQL メソッドまたは Open メソッドが呼び出されたとき問い合わせコンポーネントが実行する SQL 文を指定するのに使います。設計時には，Object Inspector で String List エディタを呼び出して SQL プロパティを編集できます。

注意

Delphi Client/Server Suite では，Visual Query Builder を呼び出して SQL 文を作成できます。

SQL プロパティを使って，以下のように各テーブルにアクセスします。

・	ローカル SQL を使って Paradox テーブルまたは dBASE テーブルにアクセスする。使用できる構文は ANSI 標準 SQL のサブセットで，SELECT，INSERT，UPDATE，および DELETE の各文

・	標準 SQL-92 および特殊な InterBase 拡張 SQL 構文を使ってローカル InterBase サーバー上のデータベースにアクセスする。SQL の構文と制限については，『InterBase 言語リファレンス』を参照のこと

・	SQL Link ドライバを使ってリモートデータベースサーバー（Delphi クライアント/サーバーのみ）上のデータベースにアクセスする。サーバー特有の SQL 固有言語の標準文はすべて使える。SQL の構文と制限についてはサーバーマニュアルを参照のこと

SQL 文には，標準 SQL-92 の構文規約に従い，置換可能なパラメータを含めることができます。各パラメータは Params プロパティ内に作成し格納します。

実行時に SQL 文を使うには，次のようにします。

1.	現在アクティブな問い合わせを閉じるには Close を呼び出します。

2.	SQL プロパティを空にするには Clear を呼び出します。

3.	新しいテキストを指定するには Add を，SQL スクリプトファイル内のテキストを SQL プロパティに指定するには LoadFromFile をそれぞれ呼び出します。

4.	問い合わせが使っているパラメータをセットアップするには ParamByName メソッドを呼び出します。

5.	問い合わせの実行準備をするには Prepare を呼び出します。

6.	問い合わせを実行するには ExecSQL または Open を呼び出します。

注意

SQL プロパティには，完全な SQL 文を一度に 1 文しか代入できません。一般に，サーバーがサポートしていなければ，「バッチ」文は使えません。


TQuery.SQLBinary
TQuery.SQLBinary3351015

TQuery	参照

SQLBinary プロパティは，SQL 問い合わせ文または結果セットを表すバイナリデータストリームを指します。

property SQLBinary: PChar;

説明

SQLBinary プロパティにアクセスしないでください。このプロパティは問い合わせコンポーネントが使う内部バイナリデータストリームで，ボーランドデータベースエンジンと直接通信するためのものです。問い合わせコンポーネントが実行する SQL 文にアクセスしたり，設定したりするには，SQL プロパティを使ってください。パラメータ付き SQL 文のパラメータにアクセスしたり設定したりするには，Params プロパティを使います。


TQuery.StmtHandle
TQuery.StmtHandle3351016

TQuery

StmtHandle プロパティは，問い合わせのボーランドデータベースエンジン（BDE）文ハンドルを示します。

property StmtHandle: HDBIStmt;

説明

アプリケーションにおいて BDE を直接呼び出す方法をとり，TQuery の各メソッドを使用しない場合，StmtHandle プロパティを使います。BDE API 呼び出しにはパラメータとして文が必要なものがいくつかあります。BDE を直接呼び出さない場合は，StmtHandle プロパティにアクセスする必要はありません。


TQuery.Text
TQuery.Text3351017

TQuery	参照

Text プロパティは，ボーランドデータベースエンジン（BDE）に渡された SQL 問い合わせの実際のテキストを指します。

property Text: PChar;

説明

Text プロパティは読み出し専用プロパティで，BDE に渡された SQL 文の実際の内容を取得できます。パラメータのある問い合わせの場合，パラメータは記号に置き換えられます。

一般に，Text プロパティを調べる必要はありません。SQL 文にアクセスしたり，SQL 文を変更したりするには，SQL プロパティを使ってください。またパラメータを調べたり，変更したりするには，Params プロパティを使ってください。


TQuery.UniDirectional
TQuery.UniDirectional3351018

TQuery

UniDirectional メソッドは，ボーランドデータベースエンジン（BDE）双方向カーソルを結果セット内で使用できるかどうかを指定します。

property UniDirectional: Boolean;

説明

UniDirectional プロパティを設定すると，BDE カーソルを結果セットの中で前後に移動できるかどうかを制御できます。デフォルトでこのプロパティは False で，前後に移動できます。

注意

従来の SQL カーソルは単方向です。このカーソルはデータセット内を前方にしか移動できません。それに対して，BDE カーソルはレコードをキャッシュすることで双方向移動できるようになっています。結果セット内のレコードに対し双方向アクセスしなくてもいい場合は，UniDirectional を True に設定してください。True の場合，必要なメモリが少なくてすみ，効率が上がります。


TQuery イベント3351019

TQuery	アルファベット順	凡例

TBDEDataSet からの継承

OnFilterRecord

OnServerYield

OnUpdateError

OnUpdateRecord

TDataSet からの継承

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnNewRecord

OnPostError


TQuery イベント3351020

TQuery	オブジェクト順	凡例

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError

OnServerYield

OnUpdateError

OnUpdateRecord


TQuery メソッド3351021

TQuery	アルファベット順

TQuery

Create

Destroy

ExecSQL

ParamByName

Prepare

UnPrepare

TDBDataSet からの継承

CheckOpen

CloseDatabase

OpenDatabase

TBDEDataSet からの継承

ApplyUpdates

BookmarkValid

Cancel

CancelUpdates

CommitUpdates

CompareBookmarks

ConstraintCallBack

CreateBlobStream

DisableConstraints

EnableConstraints

FetchAll

FlushBuffers

GetCurrentRecord

GetIndexInfo

Locate

Lookup

RevertRecord

UpdateStatus

TDataSet からの継承

ActiveBuffer

Append

AppendRecord

CheckBrowseMode

ClearFields

Close

ControlsDisabled

CursorPosChanged

Delete

DisableControls

Edit

EnableControls

FieldByName

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FreeBookmark

GetBookmark

GetFieldList

GetFieldNames

GotoBookmark

Insert

InsertRecord

IsEmpty

IsLinkedTo

IsSeguenced

Last

MoveBy

Next

Open

Post

Prior

Refresh

Resync

SetFields

Translate

UpdateCursorPos

UpdateRecord

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TQuery メソッド3351022

TQuery	オブジェクト順

ActiveBuffer

Append

AppendRecord

ApplyUpdates

Assign

BookmarkValid

Cancel

CancelUpdates

CheckBrowseMode

CheckOpen

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearFields

Close

CloseDatabase

CommitUpdates

CompareBookmarks

ConstraintCallBack

ControlsDisabled

Create

CreateBlobStream

CursorPosChanged

DefaultHandler

Delete

Destroy

DestroyComponents

Destroying

DisableConstraints

DisableControls

Dispatch

Edit

EnableConstraints

EnableControls

ExecSQL

FetchAll

FieldAddress

FieldByName

FindComponent

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FlushBuffers

Free

FreeBookmark

FreeInstance

FreeNotification

FreeOnRelease

GetBookmark

GetCurrentRecord

GetFieldList

GetFieldNames

GetIndexInfo

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GotoBookmark

HasParent

InheritsFrom

InitInstance

Insert

InsertComponent

InsertRecord

InstanceSize

IsEmpty

IsLinkedTo

IsSeguenced

Last

Locate

Lookup

MethodAddress

MethodName

MoveBy

NewInstance

Next

Open

OpenDatabase

ParamByName

Post

Prepare

Prior

Refresh

RemoveComponent

Resync

RevertRecord

SafeCallException

SetFields

Translate

UnPrepare

UpdateCursorPos

UpdateRecord

UpdateStatus


TQuery.Create
TQuery.Create3351023

TQuery	参照

Create メソッドは，問い合わせコンポーネントのインスタンスを作成します。

constructor Create(AOwner: TComponent);

説明

Create メソッドを呼び出すと，アプリケーション内で宣言された問い合わせをインスタンス化できます。このメソッドは継承された Create コンストラクタの呼び出して，空の SQL 文リスト/パラメータリストの作成，SQL 文リスト用の OnChange イベントハンドラの設定，およびデータリンクの確立を行います。さらに，RequestLive プロパティを False に，ParamCheck プロパティを True に，RowsAffected プロパティを -1 にそれぞれ設定します。


TQuery.Destroy
TQuery.Destroy3351024

TQuery	参照

Destroy メソッドは，問い合わせコンポーネントのインスタンスを破棄します。

destructor Destroy;

説明

直接 Destroy メソッドを呼び出さずに Free メソッドを呼び出してください。Free メソッドは問い合わせが解放されていないことを確認してから Destroy メソッドを呼び出します。Destroy はサーバーとの接続を終了し，SQL 文リスト，パラメータリスト，データリンク領域，および SQL バイナリ記憶領域を解放して，継承された Destroy デストラクタを呼び出します。


TQuery.ExecSQL
TQuery.ExecSQL3351025

TQuery	参照

ExecSQL メソッドは，問い合わせを行なう SQL 文を実行します。

procedure ExecSQL;

説明

ExecSQL メソッドを呼び出すと，現在 SQL プロパティに指定されている INSERT 文，UPDATE 文，または DELETE 文が実行されます。このメソッドは，データ定義文の実行にも使えます。

注意

SELECT 文の場合，ExecSQL の代わりに Open メソッドを呼び出します。

まだ実行準備が終わっていない場合，ExecSQL メソッドは SQL プロパティ内の文の実行準備を行います。通常は速度効率を上げるため，初めて ExecSQL メソッドを呼ぶときは事前に Prepare メソッドを呼び出すといいでしょう。


TQuery.ParamByName
TQuery.ParamByName3351026

TQuery	参照

ParamByName メソッドは，指定された名前を持つパラメータの情報にアクセスします。

function ParamByName(const Value: string): TParam;

説明

ParamByName メソッドを呼び出すと，指定された名前を持つパラメータの情報を設定したり使ったりできます。Value パラメータは情報を取り出したいパラメータの名前です。このメソッドは，実行時にパラメータの値を設定するのにも使えます。たとえば，次の文によって，「Contact」というパラメータの現在の値を取り出し，編集ボックスに格納します。

Edit1.Text := Query1.ParamByName('Contact').AsString;


TQuery.Prepare
TQuery.Prepare3351027

TQuery	参照

Prepare メソッドは，ボーランドデータベースエンジン（BDE）とリモートデータベースサーバーに問い合わせを送り，実行前の最適化を行います。

procedure Prepare;

説明

Prepare メソッドを呼び出すと，BDE とリモートデータベースサーバーが問い合わせ用のリソースを割り当て，かつ最適化を実行します。問い合わせ実行前にこのメソッドを呼び出すと，アプリケーションの性能が上がります。

注意

最初に準備をしないで問い合わせを実行した場合，自動的に Delphi が準備を行います。実行後，Delphi は準備を解きます。複数の問い合わせが実行される場合，必要でない準備処理や準備を解く処理が複数実行されないよう，常に明示的に問い合わせの準備を行うべきです。

問い合わせの準備をするとデータベースリソースが消費されるので，問い合わせが終了したら，準備を解くのが望ましいプログラミングの習慣です。準備を解くのは UnPrepare メソッドです。

注意

実行時に問い合わせテキストを変更すると，問い合わせは自動的に閉じられ，準備が解かれます。


TQuery.UnPrepare
TQuery.UnPrepare3351028

TQuery	参照

UnPrepare メソッドは，直前の問い合わせ準備で割り当てたリソースを解放します。

procedure UnPrepare;

説明

UnPrepare メソッドを呼び出すと，サーバー側，クライアント側双方で直前の問い合わせ準備で割り当てたリソースが解放されます。

問い合わせの準備をするとデータベースリソースが消費されるので，問い合わせが終了したら，準備を解くのが望ましいプログラミング習慣です。準備を解くのがこの UnPrepare メソッドです。

注意

実行時に問い合わせテキストを変更すると，問い合わせは自動的に閉じられ，準備が解かれます。


スコープ3351029

published

読み出し／書き込み

読み出し専用


スコープ3351030

published


継承3351031

TObject

TPersistent

TComponent

TDataSet

TBDEDataset

TDBDataSet


TQuery 例3351032

TQuery


TQueryTableProducer
TQueryTableProducer3352001

継承	プロパティ	メソッド	イベント	参照

TQueryTableProducer は HTML コマンドのシーケンスをアセンブルして，TQuery オブジェクトのレコードをテーブル形式で表示します。

ユニット

dbweb

説明

TQueryTableProducer を使うと，パラメータ付き問い合わせのレコードを表示する HTML テーブルを作成できます。TQuery オブジェクトは HTTP 要求メッセージからパラメータを取得します。要求が GET メッセージの場合，問い合わせに使われるパラメータは要求オブジェクトの QueryFields プロパティです。要求が POST メッセージの場合，問い合わせに使われるパラメータは要求オブジェクトの ContentFields プロパティです。


TQueryTableProducer プロパティ3352002

TQueryTableProducer	アルファベット順	凡例

TQueryTableProducer

DataSet

Query

TDSTableProducer からの継承

Caption

CaptionAlignment

Columns

Editor

Footer

Header

MaxRows

RowAttributes

TableAttributes

TCustomContentProducer からの継承

Dispatcher

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TQueryTableProducer プロパティ3352003

TQueryTableProducer	オブジェクト順	凡例

Caption

CaptionAlignment

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DataSet

DesignInfo

Dispatcher

Editor

Footer

Header

MaxRows

Name

Owner

Query

RowAttributes

TableAttributes

Tag

VCLComObject


TQueryTableProducer.DataSet
TQueryTableProducer.DataSet3352004

TQueryTableProducer	参照

DataSet プロパティは，TQueryTableProducer がデータを取得するのに使う TQuery オブジェクトです。

property DataSet: TDataSet;

説明

DataSet を設定すると，HTML テーブルのデータを取得するための問い合わせを指定できます。TQueryTableProducer への問い合わせを設定するには，DataSource プロパティではなく DataSet プロパティを使います。TQueryTableProducer はアプリケーション内のほかのデータオブジェクトとの間にレコードの通用性を維持しないため，外部の TDataSource オブジェクトを使いません。

Columns プロパティ内の THTMLTableColumn オブジェクトが指定する個々の項目の結合は DataSet 内の項目を参照します。

注意

DataSet は，問い合わせオブジェクトが TDataSet 型で表示される点を除いては Query プロパティと同じです。


TQueryTableProducer.Query
TQueryTableProducer.Query3352005

TQueryTableProducer	参照

Query プロパティは，TQueryTableProducer がデータを取得するために実行する TQuery オブジェクトです。

property Query: TQuery;

説明

Query を設定すると，HTML テーブルにデータを取得するための問い合わせを指定できます。TQueryTableProducer への問い合わせを設定するには，DataSource プロパティではなく Query プロパティを使います。TQueryTableProducer はアプリケーション内のほかのデータオブジェクトとの間にレコードの通用性を維持しないため，外部の TDataSource オブジェクトを使いません。

Columns プロパティ内の THTMLTableColumn オブジェクトが指定する個々の項目の結合は DataSet 内の項目を参照します。

注意

Query プロパティは，TQuery の基本クラスである TDataSet を使わないという点を除いては DataSet プロパティと同じです。


TQueryTableProducer イベント3352006

TQueryTableProducer	アルファベット順	凡例

TDSTableProducer からの継承

OnCreateContent

OnFormatCell

OnGetTableCaption


TQueryTableProducer イベント3352007

TQueryTableProducer	オブジェクト順	凡例

OnCreateContent

OnFormatCell

OnGetTableCaption


TQueryTableProducer メソッド3352008

TQueryTableProducer	アルファベット順

TQueryTableProducer

Content

TDSTableProducer からの継承

BeginUpdate

Create

Destroy

EndUpdate

TCustomContentProducer からの継承

ContentFromStream

ContentFromString

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TQueryTableProducer メソッド3352009

TQueryTableProducer	オブジェクト順

Assign

BeginUpdate

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Content

ContentFromStream

ContentFromString

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

EndUpdate

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TQueryTableProducer.Content
TQueryTableProducer.Content3352010

TQueryTableProducer	参照

Content メソッドは問い合わせの結果を HTML 表現で返します。

function Content: string; override;

説明

Content を呼び出すと，HTTP 要求メッセージから取得したパラメータを使って問い合わせを実行し，結果の HTML 表現を取り出すことができます。要求の MethodType が mtGet の場合，問い合わせに使うパラメータは要求の QueryField プロパティです。要求の MethodType が mrPost の場合，問い合わせに使うパラメータは要求の ContentFields プロパティです。

Content は問い合わせを実行した後，OnCreateContent イベントハンドラを呼び出します。OnCreateContent イベントハンドラが，Content メソッドが継続する必要のあることを示している場合，Content は，Header プロパティ，問い合わせレコードの HTML テーブルイメージ，そして Footer プロパティを順番に返します。OnCreateContent イベントハンドラが，Content メソッドが継続する必要がないことを示している場合，Content は空の文字列を返します。

Content が返す文字列は，要求メッセージに関連付けられた応答オブジェクトの Content プロパティとして使うことができます。


スコープ3352011

published

読み出し／書き込み

読み出し専用


スコープ3352012

published


継承3352013

TObject

TPersistent

TComponent

TCustomContentProducer

TDSTableProducer


TQueryTableProducer 例3352014

TQueryTableProducer


TRadioButton
TRadioButton3353001

継承	プロパティ	メソッド	イベント	参照

TRadioButton コンポーネントは Windows のラジオボタンのラッパーです。

ユニット

stdctrls

説明

TRadioButton を使うとラジオボタンをフォームに追加できます。ラジオボタンは，相互排他的な（常に 1 つしかラジオボタンを選択できない）オプションのセットを提示するのに使います。ユーザーがいずれかのラジオボタンを選択すると，前に選択されていたラジオボタンは選択解除されます。多くの場合，ラジオボタンはラジオグループボックス（TRadioGroup）にグループ化されます。グループボックスをフォームに追加してから，ラジオボタンをコンポーネントパレットから選択し，それをグループボックスに入れます。

デフォルトでは，TRadioGroup または TPanel などの同一のウィンドウコントロールコンテナに直接含まれているすべてのラジオボタンがグループ化されます。たとえば，フォーム上の 2 つのラジオボタンを同時に選択できるのは，その 2 つがそれぞれ異なるグループボックスに含まれている場合など別のコンテナに含まれている場合だけです。


TRadioButton プロパティ3353002

TRadioButton	アルファベット順	凡例

TRadioButton

Alignment

Checked

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TRadioButton プロパティ3353003

TRadioButton	オブジェクト順	凡例

Align

Alignment

BoundsRect

Brush

Caption

Checked

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TRadioButton.Alignment
TRadioButton.Alignment3353004

TRadioButton	参照

Alignment プロパティは，ラジオボタンに相対するキャプションの位置を指定します。

TAlignment = (taLeftJustify, taRightJustify, taCenter);

TLeftRight = taLeftJustify..taRightJustify;

property Alignment: TLeftRight;

説明

Alignment プロパティを設定するとラジオボタンのキャプションの表示位置を指定できます。以下に指定値を示します。

値	意味

taLeftJustify	キャプションをラジオボタンの左側に表示する

taRightJustify	キャプションをラジオボタンの右側に表示する

注意

Alignment プロパティをラジオボタンのテキスト領域におけるキャプションの位置合わせと間違えないでください。キャプションは常に左揃えで表示されます。Alignment はボタンのどちら側にテキスト領域が表示されるかを制御するだけです。


TRadioButton.Checked
TRadioButton.Checked3353005

TRadioButton	参照

Checked プロパティは，ラジオボタンで表されたオプションが選択されたかどうかを示します。

property Checked: Boolean;

説明

Checked プロパティは，ラジオボタンが選択されたかどうかを取得できます。Checked を True に設定すると，いずれかのラジオボタンを選択した場合に同じコンテナに入っているほかのすべてのラジオボタンの選択を解除されます。Checked を False に設定すると，ラジオボタンを選択してもそのグループで選択されているほかのラジオボタンの選択状態はそのままです。


TRadioButton イベント3353006

TRadioButton	アルファベット順	凡例

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TRadioButton イベント3353007

TRadioButton	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TRadioButton メソッド3353008

TRadioButton	アルファベット順

TRadioButton

Create

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TRadioButton メソッド3353009

TRadioButton	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TRadioButton.Create
TRadioButton.Create3353010

TRadioButton	参照

Create メソッドは，TRadioButton のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にラジオボタンをインスタンス化できます。設計時にフォームに追加されたラジオボタンは自動的に作成されます。Create は継承されたコンストラクタを呼び出してから，ラジオボタンの初期値を設定します。たとえば，Width プロパティと Height プロパティを 113 ピクセルと 17 ピクセルにそれぞれ設定し，ControlStyle を csSetCaption および csDoubleClicks に，Alignment プロパティ値を taLeftJustify に設定します。


スコープ3353011

published

読み出し／書き込み

読み出し専用


スコープ3353012

published


継承3353013

TObject

TPersistent

TComponent

TControl

TWinControl

TButtonControl


TRadioButton 例3353014

TRadioButton


TRadioGroup

継承	プロパティ	メソッド	イベント	参照	例

TRadioGroup コンポーネントは，1 つのまとまりとして機能するラジオボタンのグループを表します。

ユニット

extctrls

説明

TRadioGroup オブジェクトはラジオボタンだけを格納する特殊なグループボックスです。同じコントロール内に直接配置されたラジオボタンは「グループ化された」といいます。ユーザーがラジオボタンをチェックしたときには，グループ内の他のラジオボタンがすべて選択が解除されます。したがって，2 つのラジオボタンをチェックできるのは，ラジオボタンがグループボックスなどのコンテナに別々に配置されている場合だけです。

ラジオボタンを TRadioGroup に追加するには，オブジェクトインスペクタで Item プロパティを編集してください。Items の各文字列はその文字列をキャプションとするラジオボタンをグループボックスに表示します。ItemIndex プロパティの値はどのラジオボタンが現在選択されているかを決めます。

Columns プロパティの値を設定することで，ラジオボタンを 1 列に表示するか複数の列に表示するかを指定できます。


TRadioGroup プロパティ3354002

TRadioGroup	アルファベット順	凡例

TCustomRadioGroup からの継承

Columns

ItemIndex

Items

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TRadioGroup プロパティ3354003

TRadioGroup	オブジェクト順	凡例

Align

BoundsRect

Brush

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

Columns

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

Hint

ItemIndex

Items

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TRadioGroup イベント3354004

TRadioGroup	アルファベット順	凡例

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnStartDrag


TRadioGroup イベント3354005

TRadioGroup	オブジェクト順	凡例

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnStartDrag


TRadioGroup メソッド3354006

TRadioGroup	アルファベット順

TCustomRadioGroup からの継承

Create

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TRadioGroup メソッド3354007

TRadioGroup	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


スコープ3354008

published

読み出し／書き込み

読み出し専用


スコープ3354009

published


継承3354010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomGroupBox

TCustomRadioGroup


TRadioGroup 例3354011

TRadioGroup


TReader
TReader3355001

継承	プロパティ	メソッド	イベント	参照

TReader オブジェクトは，関連付けられたストリームからデータを読み出す特殊なファイラオブジェクトです。

ユニット

classes

説明

TReader オブジェクトは，VCL ストリーム入出力システムがストリームに書き込まれているコンポーネントの状態を復元する目的でストリームからデータを読み出すために内部的に使われます。TReader はストリームからコンポーネントに関連付けられているデータを読み出す機構を処理するストリームのためのヘルパーオブジェクトです。ストリームオブジェクトというよりも，リーダーオブジェクトであり，コンポーネントをストリーミングする複雑な処理を実行します。以下の目的で使われるメソッドが提供されます。

・	ストリームから読み出されたクラス名を使ってコンポーネントインスタンスを作成する

・	ストリームデータを published コンポーネントプロパティに割り当てる

・	オブジェクトが隠れたデータまたは複雑なデータをオブジェクトの実際のプロパティのように格納することを可能にする

・	他のコンポーネントを参照するプロパティなど，コンポーネント間の参照を解決する

TReader オブジェクトの他のメソッドおよびプロパティは，リーダーオブジェクトのイベントのトリガ，およびストリームとの対話のために使われます。

ユーザー側では直接リーダーオブジェクトを作成しないでください。TReader オブジェクトのコンストラクタはストリームをパラメータにとります。リーダーオブジェクトは，ストリームオブジェクトメソッドまたはストリームプロセスを初期化するグローバルルーチンで自動的に作成されます。たとえば以下のとおりです。

・	グローバルルーチンである ObjectBinaryToText 手続きを呼び出す。このメソッドは直接リーダーオブジェクトを作成する

・	グローバルな ReadComponentResFile 関数を呼びだす。このメソッドはリーダーオブジェクトを作成するファイラストリームオブジェクトを作成する

・	TStream.ReadCompoennt を呼び出す。このメソッドはリーダーオブジェクトを作成する

リーダーコンストラクタはストリームをパラメータにとります。これは関連付けられているストリームを表します。したがって，リーダーオブジェクトは必ず関連付けられているストリームオブジェクトを持ち，一度ストリームプロセスが実行されてしまえば，ユーザーは直接リーダーオブジェクトを操作する必要はありません。リーダー，コンポーネント，およびストリームオブジェクト間の対話は，お互いを呼び出すオブジェクトのメソッドで自動的に発生します。


TReader プロパティ3355002

TReader	アルファベット順

TReader

Owner

Parent

Position

TFiler からの継承

Ancestor

IgnoreChildren

Root


TReader プロパティ3355003

TReader	オブジェクト順

Ancestor

IgnoreChildren

Owner

Parent

Position

Root


TReader.Owner
TReader.Owner3355004

TReader	参照

Owner プロパティは，リーダーオブジェクトのストリームから読み出したすべてのコンポーネントの Owner プロパティとして割り当てるコンポーネントを格納します。

property Owner: TComponent;

説明

Owner プロパティは，VCL ストリーム入出力システムがどのコンポーネントをストリーミングするかを知るために内部的に使われます。Root コンポーネントによって所有されるすべてのコンポーネントはストリーミングプロセスで処理されます。

Owner は，ストリーミングされるコンポーネントの Owner プロパティです。その Reader オブジェクトから値が割り当てられます。リーダーが新しいコンポーネントインスタンスを作成すると，Reader.Owner が Component.Owner に割り当てられます。Reader.Owner が nil の場合，Reader.Root が Owner プロパティに割り当てられます。

ほとんどのコンポーネントで，Owner プロパティは nil です。Root フォームによって所有されていないコンポーネントを含むことができるコンポーネントの場合（タブ付きノートブックなど），Owner プロパティは Root と同じではありません。コンポーネントの GetChildOwner メソッドが Owner を決めます。


TReader.Parent
TReader.Parent3355005

TReader	参照

Parent プロパティは，リーダーオブジェクトのストリームから読み出したすべてのコントロールの Parent プロパティとして割り当てるコンポーネントを格納します。

property Parent: TComponent;

説明

Parent プロパティは VCL ストリーム入出力システムによって内部的に使われます。Parent プロパティの値は，ストリームから読み出されているコンポーネントの順番によって決まります。


TReader.Position
TReader.Position3355006

TReader	参照

Position プロパティは，関連付けられているストリームの現在の読み出し位置を表します。

property Position: Longint;

説明

Position プロパティはストリーム内のリーダーの位置を把握するために使われます。Position プロパティの値は，もっとも新しく読み込まれたバッファブロック内にあります。したがって，通常 Position はストリームの Position 未満になります。


TReader イベント3355007

TReader	アルファベット順

TReader

OnAncestorNotFOund

OnError

OnFindMethod

OnReferenceName

OnSetName


TReader イベント3355008

TReader	オブジェクト順

OnAncestorNotFOund

OnError

OnFindMethod

OnReferenceName

OnSetName


TReader.OnAncestorNotFOund
TReader.OnAncestorNotFound3355009

TReader	参照

OnAncestorNotFound イベントは，オブジェクトの上位オブジェクトが見つからない場合に発生します。

TAncestorNotFoundEvent = procedure(Reader: TReader; const ComponentName: string; ComponentClass: TPersistentClass; var Component: TComponent) of object;

property OnAncestorNotFound: TAncestorNotFoundEvent;

説明

OnAncestorNotFound イベントは Delphi 環境が内部でのみ使います。


TReader.OnError
TReader.OnError3355010

TReader	参照

OnError イベントは，リーダーオブジェクトがデータの読み出しエラー（非宣言プロパティの名前または不正な値の読み出しなど）を検出すると発生します。

type TReaderError = procedure(Reader: TReader; const Message: string; var Handled: Boolean) of object;

property OnError: TReaderError;

説明

OnError イベントは Delphi 環境でエラーを報告するために内部的に使われます。また，エラーを処理または無視するためのイベントハンドラを記述するためにも使われます。

OnError イベントハンドラに渡す最後のパラメータは Handled という var パラメータです。デフォルトの場合，Error メソッドは Handled を False にしますが，エラーを修正するか無視するハンドラは Handled に True を設定し，エラーをそれ以降処理しないようにします。イベントハンドラから制御が戻ったときに Handled が False に設定されていると，リーダーオブジェクトは EReadError 例外を生成します。


TReader.OnFindMethod
TReader.OnFindMethod3355011

TReader	参照

OnFindMethod イベントは，リーダーオブジェクトがオブジェクトのメソッドポインタプロパティを読み出すたびに発生します。

type TFindMethodEvent = procedure(Reader: TReader; const MethodName: string; var Address: Pointer; var Error: Boolean) of object;

property OnFindMethod: TFindMethodEvent;

説明

OnFindMethod イベントは，Delphi 環境でイベントを読み出すために内部的に使われます。また，失敗したメソッドを処理する方法をユーザーに尋ねるためにも使われます。

FindMethod メソッドは，メソッドポインタに割り当てたメソッドが見つからないと，OnFindMethod ハンドラの Error パラメータを True に設定します。Error は var パラメータなので，ハンドラは Error を False に設定できます。False に設定すると，ハンドラが制御を返したときに FindMethod は例外を生成しません。


TReader.OnReferenceName
TReader.OnReferenceName3355012

TReader	参照

OnReferenceName イベントは，Delphi 環境が内部的に使います。

type TReferenceNameEvent = procedure(Reader: TReader; var Name: string) of object;

property OnReferenceName: TReferenceNameEvent;

説明

OnReferenceName は内部でのみ使います。


TReader.OnSetName
TReader.OnSetName3355013

TReader	参照

OnSetName イベントは，リーダーオブジェクトがストリームから読み出すコンポーネントの Name プロパティを設定する直前に発生します。

type TSetNameEvent = procedure(Reader: TReader; Component: TComponent; var Name: string) of object;

property OnSetName: TSetNameEvent;

説明

OnSetName イベントは，Delphi 環境でコンポーネントおよびフォームの重複名を処理するために内部的に使われます。また，作成されたばかりで，ストリームからプロパティが読み出されようとしているコンポーネントに Name プロパティを設定する直前に特別な処理を実行するイベントハンドラを記述するためにも使われます。

OnSetName イベントハンドラの Name パラメータは var パラメータなので，リーダーオブジェクトが Name パラメータをコンポーネントに割り当てる前にハンドラは名前を変更できます。フォーム内のすべてのコンポーネント名にフィルタをかけて文字列に追加したり一部を変更したりする場合に便利です。


TReader メソッド3355014

TReader	アルファベット順	凡例

TReader

BeginReferences

CopyValue

DefineBinaryProperty

DefineProperty

Destroy

EndOfList

EndReferences

Error

FindAncestorComponent

FindMethod

FixupReferences

FlushBuffer

NextValue

Read

ReadBoolean

ReadChar

ReadCollection

ReadComponent

ReadComponents

ReadFloat

ReadIdent

ReadInteger

ReadListBegin

ReadListEnd

ReadPrefix

ReadRootComponent

ReadSignature

ReadStr

ReadString

ReadValue

ReferenceName

SetName

TFiler からの継承

Create

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafecallException


TReader メソッド3355015

TReader	オブジェクト順	凡例

BeginReferences

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyValue

Create

DefaultHandler

DefineBinaryProperty

DefineProperty

Destroy

Dispatch

EndOfList

EndReferences

Error

FieldAddress

FindAncestorComponent

FindMethod

FixupReferences

FlushBuffer

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

NextValue

Read

ReadBoolean

ReadChar

ReadCollection

ReadComponent

ReadComponents

ReadFloat

ReadIdent

ReadInteger

ReadListBegin

ReadListEnd

ReadPrefix

ReadRootComponent

ReadSignature

ReadStr

ReadString

ReadValue

ReferenceName

SafecallException

SetName


TReader.BeginReferences
TReader.BeginReferences3355016

TReader	参照

BeginReferences メソッドは，他のコンポーネントへの参照を持つ可能性のあるコンポーネントを読み出すブロックの開始を宣言します。

procedure BeginReferences;

説明

直接 BeginReferences メソッドを呼び出さないでください。BeginReferences メソッドは，Delphi 環境で他のコンポーネントを参照するプロパティをストリーミングするために内部的に使われます。

BeginReferences メソッドを呼び出した後，リーダーオブジェクトは，読み出されたすべてのオブジェクトとそれらの名前のリストを作成します。すべての相互依存オブジェクトを読み出した後，ストリームからの名前付き参照をインスタンスへの参照にするために FixupReferences を呼び出します。最後に，フィックスアップリストを破棄するために EndReferences を呼び出します。

BeginReferences は，try..finally ブロック内で必ず FixupReferences と EndReferences と一緒に使います。


TReader.CopyValue
TReader.CopyValue3355017

TReader

CopyValue メソッドは，内部でのみ使います。

procedure CopyValue(Writer: TWriter);

説明

CopyValue を呼び出さないでください。CopyValue は Delphi 環境が内部的に使います。


TReader.DefineBinaryProperty
TReader.DefineBinaryProperty3355018

TReader	参照

DefineBinaryProperty メソッドは，リーダーオブジェクトがプロパティであるかのように読み出すバイナリデータを定義します。

type TStreamProc = procedure(Stream: TStream) of object;

procedure DefineBinaryProperty(const Name: string; ReadData, WriteData: TStreamProc; HasData: Boolean); override;

説明

DefineBinaryProperty メソッドは，格納する必要があるデータを持つオブジェクトの DefineProperties メソッドによって内部的に呼び出されます。ユーザーは，大きなカスタムデータ（ビットマップなど）を持つコンポーネントを実現する場合に，そのコンポーネントの DefineProperties メソッド内で直接 DefineBinaryProperty メソッドを呼び出します。これが，DefineBinaryProperty（または DefineProperty）が使われる唯一の状況です。

DefineProperties メソッドは汎用ファイラオブジェクトをパラメータにとります。バイナリデータを読み出す場合，DefineProperties メソッドは TReader オブジェクトをとり，リーダーオブジェクトの TReader または TFiler DefineBinaryProperty メソッドを呼び出します。DefineBinaryProperty メソッドは，プロパティの名前とそのデータを読み出し，データを指定の ReadData メソッドに渡します。

Name パラメータは，ストリームから読み出される「偽の」プロパティの名前を指定します。「偽の」プロパティは非publishedプロパティで，DefineBinaryProperty メソッドのコード内にのみ存在します。たとえば，非ビジュアルコンポーネントの Top および Left プロパティは「偽の」プロパティです。「定義プロパティ」または「カスタム定義プロパティ」とも呼ばれます。

TStreamProc 型は ReadData および WriteData パラメータの型です。これは，Stream パラメータに渡されるストリームに対してバイナリ形式で表現されているオブジェクトのデータを直接読み書きする手続き（コンポーネントオブジェクトで定義）を示すメソッドポインタ型です。TReader オブジェクトの場合，WriteData パラメータは無視されます。

HasData パラメータは，実行時に「偽の」パラメータが格納する（書き込む）データを持っているかどうかを示します。TReader オブジェクトでは HasData パラメータは無視されます。

特別な（大きな）データ記憶容量を必要とするコンポーネントを書き込む場合，DefineProperties メソッドをオーバーライドできます。特別なプロパティ項目または「偽の」プロパティ項目ごとに，Filer.DefineProperty メソッドまたは Filer.DefineBinaryProperty メソッドを呼び出します。ReadData および WriteData パラメータには，特別なデータ型を処理する方法を知っているコンポーネントのメソッドを渡します。読み出しの場合は，ReadData が呼び出されます。書き出しの場合は，WriteData が呼び出されます。

バイナリプロパティを定義することはほとんどありません。グラフィックをバイナリデータとして格納する VCL オブジェクトは，データを格納したり取り出したりするファイラオブジェクトのもっとも一般的な用途です。さらに一般的なケースとして，オブジェクトは DefineProperty メソッドを使います。DefineBinaryProperty メソッドと DefineProperty メソッドの相違点は，コンポーネントがファイラオブジェクトを介するのではなくメモリストリームオブジェクトに対して直接バイナリプロパティを読み書きすることです。バイナリデータもテキストと同様に編集が難しいデータです。

注意

TPersistent オブジェクトから派生しているストリーム可能なオブジェクトは DefineProperties メソッドを継承しますが，DefineProperties メソッドは TComponent までは何もしません。このため，バイナリデータを読み出す場合にリーダーの DefineBinaryProperty メソッドを呼び出すのは，コンポーネントオブジェクトの DefineProperties メソッドです。


TReader.DefineProperty
TReader.DefineProperty3355019

TReader	参照

DefineProperty メソッドは，リーダーオブジェクトがプロパティであるかのように読み書きするデータを定義します。

type

TReaderProc = procedure(Reader: TReader) of object;

TWriterProc = procedure(Writer: TWriter) of object;

procedure DefineProperty(const Name: string; ReadData: TReaderProc; WriteData: TWriterProc; HasData: Boolean); override;

説明

DefineProperty メソッドは，格納するデータを持つオブジェクトの DefineProperties メソッドによって内部的に呼び出されます。DefineProperties メソッドは，汎用ファイラオブジェクトをパラメータにとります。データを読み出す場合，DefineProperties メソッドは TReader オブジェクトを取り，リーダーオブジェクトの DefineProperties メソッドを呼び出します。それから，DefineProperty メソッドはプロパティの名前およびそのデータを読み出します。

Name パラメータはストリームから読み出される「偽の」プロパティの名前を指定します。

TReaderProc 型は ReadData パラメータの型です。これは，オブジェクトのデータ（プロパティの値を表す）を直接リーダーオブジェクトへ読み出す手続き（格納するオブジェクトで定義）を示すメソッドポインタ型です。TReader オブジェクトの場合，WriteData パラメータは無視されます。

HasData パラメータは，実行時に「偽の」パラメータが格納する（書き込む）データを持っているかどうかを示します。TReader オブジェクトの場合，HasData パラメータは無視されます。

DefineBinaryProperty メソッドと DefineProperty メソッドの相違点は，バイナリプロパティがファイラオブジェクトを介するのではなくストリームオブジェクトから直接読み出されることです。バイナリデータもテキストと同様に編集が難しいデータです。


TReader.Destroy
TReader.Destroy3355020

TReader	参照

Destroy メソッドは，継承された Destroy メソッドを呼び出す前にストリームの現在の位置を先頭に移動します。

destructor Destroy; override;

説明

直接 Destroy メソッドを呼び出すことはせず，Free メソッドを呼び出すようにしてください。Free メソッドはオブジェクトインスタンスが nil ではないことを確認してから Destroy メソッドを呼び出します。


TReader.EndOfList
TReader.EndOfList3355021

TReader	参照

EndOfList メソッドは，ストリームから連続して読み出される項目グループの最後を示します。

function EndOfList: Boolean;

説明

EndOfList メソッドは，データを読み出す場合に項目リストを繰り返し処理する他のメソッドによって使われます。このメソッドは，その型のデータの終了を知らせる値の型をチェックします。EndOfList メソッドは，リーダーオブジェクトが項目リストの最後まで読み出したら True を返します。

EndOfList メソッドはリーダーオブジェクトが項目リストの最後まで読み出した場合，True を返します。項目リストを読み出すには，リーダーオブジェクトの ReadListBegin メソッドを呼び出してから，リスト項目を繰り返し呼び出して，EndOfList が True を返したら ReadListEnd を呼び出します。

注意

コンポーネント開発者は，たとえば TStrings を使用する場合のように，定義されたプロパティの ReadData メソッドで EndOfList メソッドを使うことができます。


TReader.EndReferences
TReader.EndReferences3355022

TReader	参照

EndReferences メソッドは，お互いを参照するリーダーオブジェクトのストリームからコンポーネントを読み出すコードのブロックを終了します。

procedure EndReferences;

説明

EndReferences メソッドは，他のコンポーネントを参照するプロパティをストリーミングするために使われます。ユーザーは直接 EndReferences メソッドを呼び出す必要はありません。

リーダーオブジェクトは EndReferences メソッドを呼び出し，読み出されたすべてのオブジェクトおよびその名前のリストを作成します。すべての相互依存オブジェクトを読み出した後，ストリームからの名前付き参照をインスタンスへの参照にするために FixupReferences を呼び出します。最後に，EndReferences メソッドを呼び出してフィクスアップリストを破棄します。

EndReferences は，try..finally ブロック内で必ず FixupReferences と BeginReferences と一緒に使います。


TReader.Error
TReader.Error3355023

TReader	参照

Error メソッドは，リーダーオブジェクトの OnError イベントのための実現メソッドです。

function Error(const Message: string): Boolean; virtual;

説明

リーダーオブジェクトはコンポーネントまたはプロパティの読み出しに関する問題を検出すると，必ず Error を呼び出します。デフォルトの場合，Error は戻り値に False を設定し，OnError イベントに結び付けられたハンドラを呼び出します。ハンドラは戻り値を変更することができます。

Error メソッドを使うと，エラー処理を続行するかどうかを示す戻り値を変更できます。戻り値が True ならば,アプリケーションはエラーのまま処理を続けなくてはなりません。False ならば，エラー条件を修正するか無視すべきことを示します。

注意

このメソッドは設計時の環境のためだけの仮想メソッドです。ユーザー側で TReader オブジェクトの下位クラスを作成することはありません。


TReader.FindAncestorComponent
TReader.FindAncestorComponent3355024

TReader	参照

FindAncestorComponent メソッドは，指定された名前を持つ上位コンポーネントを見つけます。

function FindAncestorComponent(const Name: string; ComponentClass: TPersistentClass): TComponent; virtual;

説明

TReader オブジェクトは，FindAncestorComponent を内部的に使用してメモリに読み出されているオブジェクトの上位オブジェクトを見つけます。FindAncestorComponent は，指定された名前の上位コンポーネントを見つけ，対応するコンポーネントオブジェクトを返します。上位オブジェクトがメモリに読み込まれていないと，FindAncestorComponent は OnAncestorNotFound イベントを生成して，イベントハンドラでその上位コンポーネントを見つけるようにします。


TReader.FindMethod
TReader.FindMethod3355025

TReader	参照

FindMethod メソッドは，指定のコンポーネントのメソッドへのポインタを返します。

function FindMethod(Root: TComponent; const MethodName: string): Pointer; virtual;

説明

FindMethod は，リーダーオブジェクトがメソッドポインタ（通常はイベント）であるプロパティを読み出す場合に使われます。リーダーオブジェクトは割り当てられたメソッド（イベントハンドラ）の名前を読み出した後，FindMethod を呼び出してルートオブジェクト（フォーム）内のメソッドのアドレスを取り出します。

FindMethod メソッドは，Root に指定したコンポーネント内にあり MethodName に指定した名前を持つメソッドへのポインタを返し，OnFindMethod イベントに結び付けられたイベントハンドラがあればそれを呼び出します。FindMethod が指定のメソッドを見つけられず OnFindMethod ハンドラがエラーフラグをクリアしない場合，FindMethod は EReadError 例外を生成します。

リーダーオブジェクトから読み出したメソッドポインタの処理方法をカスタマイズするには，イベントハンドラを OnFindMethod イベントに結び付けます。


TReader.FixupReferences
TReader.FixupReferences3355026

TReader	参照

FixupReferences メソッドは，他のコンポーネントによって表されるプロパティをストリーミングする場合に参照を解決するために使われます。

procedure FixupReferences;

説明

FixupReferences メソッドは，ストリーム入出力システムがストリームからの名前付き参照をインスタンスへの参照にするために内部的に使われます。ユーザーはこのメソッドを呼び出す必要はありません。

リーダーオブジェクトは BeginReferences メソッドを呼び出し，読み出されたすべてのオブジェクトおよびその名前のリストを作成します。すべての相互依存オブジェクトを読み出すと，FixupReferences メソッドが呼び出され，すべてのオブジェクトを読み出した後でリーダーオブジェクトのストリームから読み出されるさまざまな相互依存コンポーネント間の参照を解決します。最後に，EndReferences メソッドを呼び出してフィクスアップリストを破棄します。

FixupReferences メソッドは，必ず try..finally ブロック内の BeginReferences と EndReferences の呼び出しの間で使います。


TReader.FlushBuffer
TReader.FlushBuffer3355027

TReader	参照

FlushBuffer メソッドは，リーダーのバッファとストリームのバッファを同期させます。

procedure FlushBuffer; override;

説明

FlushBuffer メソッドは，ストリームの Position をリーダーの Position と一致させて，リーダーのバッファと，関連付けられているストリームを同期させます。


TReader.NextValue
TReader.NextValue3355028

TReader	参照

NextValue メソッドは，ストリームの位置を移動することなく，リーダーオブジェクトのストリーム内の次の項目の型を返します。

type TValueType = (vaNull, vaList, vaInt8, vaInt16, vaInt32, vaExtended, vaString, vaIdent, vaFalse, vaTrue, vaBinary, vaSet, vaLString, vaNil, vaCollection);

function NextValue: TValueType;

説明

NextValue メソッドは，リーダーメソッドがストリーム内の次の項目の型を問い合わせるために内部的に使われます。NextValue メソッドは次の項目を識別すると，値型インジケータの前であってもストリーム位置を使って返します。

TValueType 型は，ファイラオブジェクトに書き込まれる値とファイラオブジェクトから読み出される値の型を定義します。Delphi のファイラではタグ付きの値が使われ，ストリーム上のそれぞれの値に型を表すプレフィクスが付きます。これらのプレフィクスが TValueType 型です。


TReader.Read
TReader.Read3355029

TReader	参照

Read メソッドは，他のメソッドがデータの読み出しを処理するために内部的に使われます。

procedure Read(var Buf; Count: Longint);

説明

直接 Read メソッドを呼び出さないでください。Read メソッドは，ストリームからデータを読み出すために内部的に使われます。通常，他の多くのライターメソッドは適切な値を設定した後，またはデータ型を確認した後に Read メソッドを呼び出します。


TReader.ReadBoolean
TReader.ReadBoolean3355030

TReader	参照

ReadBoolean メソッドは，リーダーオブジェクトから論理値を読み出しその値を返します。

function ReadBoolean: Boolean;

説明

ReadBoolean は，現在のリーダーの Position からタグ付きの論理値を読み出すために他のリーダーメソッドに使われるヘルパーメソッドです。ReadBoolean は ReadValue を使って vaTrue 値の型を調べて，その結果を返します。


TReader.ReadChar
TReader.ReadChar3355031

TReader	参照

ReadChar メソッドは，リーダーオブジェクトのストリームから文字を読み出し，文字の値を返します。

function ReadChar: Char;

説明

ReadChar メソッドは，現在のリーダーの Posititon からタグ付きの文字の値を読み出すために他のメソッドに使われるヘルパーメソッドです。ReadChar メソッドはまず ReadValue メソッドを呼び出して値の型（TValueType）を調べます。項目が vaString の場合，ReadString が長さを調べます。長さによって値が char であるとわかった場合は，Read メソッドを呼び出して文字を返します。それ以外の場合は EReadError 例外が生成されます。

注意

タグ付きのデータが長さ = 1 の文字列の場合，それは char 互換です。長さ > 1 の場合，それはエラーです。しかし，残りの文字列データはリーダーを一定の状態の保つために読み出されます。タグ付きのデータを処理する各アクションは，読み出されていない次のタグの最初にリーダーの Position を設定しなければなりません。


TReader.ReadCollection
TReader.ReadCollection3355032

TReader

ReadCollection メソッドは，リーダーオブジェクトのストリームからコレクションを読み出して，その文字の値を返します。

procedure ReadCollection(Collection: TCollection);

説明

ReadCollection は，現在のリーダーの Position からコレクションを読み出すために他のリーダーメソッドによって使われるヘルパーメソッドです。


TReader.ReadComponent
TReader.ReadComponent3355033

TReader	参照

ReadComponent メソッドは，ストリームから Instance で指定されているコンポーネントを読み出し，そのコンポーネントを返します。

function ReadComponent(Component: TComponent): TComponent;

説明

ReadComponent メソッドは，ReadRootComponent メソッドが Root によって所有されている各コンポーネントを読み出すために内部的に使われます。ユーザーは直接 ReadComponent メソッドを呼び出す必要はありません。

ReadComponent メソッドは各コンポーネントのロードおよび初期化プロセスを処理します。すべてのコンポーネントをリストにロードした後，ReadComponents はロードした各コンポーネントの Loaded メソッドを読み出した順に呼び出します。ReadComponent メソッドは，他のリーダーメソッドおよびコンポーネントのメソッドの呼び出しを介してストリームからコンポーネントを読み出す複雑な処理を管理します。


TReader.ReadComponents
TReader.ReadComponents3355034

TReader

ReadComponents メソッドは，リーダーオブジェクトに関連付けられているストリームから所有コンポーネントのリストを読み出します。

type TReadComponentsProc = procedure(Component: TComponent) of object;

procedure ReadComponents(AOwner, AParent: TComponent; Proc: TReadComponentsProc);

説明

ReadComponents メソッドは Delphi 環境で設計時のストリーミング用に内部的に使われます。直接 ReadComponents メソッドを呼び出さないでください。

ReadComponents メソッドは最初にリーダーオブジェクトの Root と Owner プロパティを AOwner パラメータで指定したコンポーネントに設定し，その Parent プロパティを AParent に設定します。次に ReadComponent メソッドを呼び出してコンポーネントを読み出し，返される各コンポーネントを Proc で指定したメソッドに渡します。

注意

ReadComponents メソッドは設計時に複数のコンポーネントのカットアンドペーストで使われます。


TReader.ReadFloat
TReader.ReadFloat3355035

TReader	参照

ReadFloat メソッドは，リーダーオブジェクトのストリームから浮動小数点数を読み出し，その値を返します。

function ReadFloat: Extended;

説明

ReadFloat メソッドは，他のリーダーメソッドがタグ付きの浮動小数点データ値を現在の Position から読み出すために使われるヘルパーメソッドです。ReadFloat メソッドは最初に ReadValue メソッドを呼び出して値の型（TValueType）をチェックします。項目が vaExtended の場合，ReadFloat メソッドは Read メソッドを呼び出し，浮動小数点値を返します。それ以外の場合は ReadInteger メソッドを呼び出します。


TReader.ReadIdent
TReader.ReadIdent3355036

TReader	参照

ReadIdent メソッドは，リーダーオブジェクトのストリームから識別子を読み出し，その識別子を返します。

function ReadIdent: string;

説明

ReadIndent メソッドは，他のリーダーメソッドが現在の Position から識別型を読み出すために使われるヘルパーメソッドです。ReadIndent メソッドは最初に ReadValue メソッドを呼び出して値の型（TValueType）をチェックします。そして項目が，

・	vaIdent 型の場合，Read メソッドを呼び出して識別子の文字列値を返します。

・	vaFalse 型の場合，文字列「False」を返します。

・	vaTrue 型の場合，文字列「True」を返します。

・	vaNil 型の場合，文字列「Nil」を返します。

それ以外の場合は EReadError 例外が生成されます。


TReader.ReadInteger
TReader.ReadInteger3355037

TReader	参照

ReadInteger メソッドは，リーダーオブジェクトのストリームから整数型数値を読み出し，その値を返します。

function ReadInteger: Longint;

説明

ReadInteger メソッドは，他のリーダーメソッドが現在のリーダーの Position からタグ付きの整数値を読み出すために使われるヘルパーメソッドです。ReadInteger メソッドは最初に ReadValue メソッドを呼び出して値の型（TValueType）をチェックします。項目が vaString，vaInt8，vaInt16，または vaInt32 型の場合，ReadInteger メソッドは Read メソッドを呼び出して整数値を返します。それ以外の場合は EReadError 例外が生成されます。


TReader.ReadListBegin
TReader.ReadListBegin3355038

TReader	参照

ReadListBegin メソッドは，リーダーオブジェクトに関連付けられているストリームからリストの開始マーカーを読み出します。

procedure ReadListBegin;

説明

ReadListBegin メソッドは，項目リストを繰り返し処理する他のメソッドが確実にリストを読み出すために使われます。また，ReadListBegin メソッドはコンポーネント開発者も定義プロパティの ReadData メソッドで使います。

ストリーム内の次の項目が WriteListBegin メソッドで作成した開始マーカーでないと，ReadListBegin は EReadError 例外を生成します。

通常，ReadListBegin を呼び出すと読み出しループが実行されます。このループは EndOfList メソッドが True を返すと終了し，ストリーム内の次の項目がリストの終了マーカーであり，この点で ReadListEnd を呼び出さなくてはならないことを示します。


TReader.ReadListEnd
TReader.ReadListEnd3355039

TReader	参照

ReadListEnd メソッドは，リーダーオブジェクトに関連付けられているストリームからリストの終了マーカーを読み出します。

procedure ReadListEnd;

説明

ReadListEnd メソッドは，他のメソッドが項目リストを繰り返し処理する場合に，読み出されている項目グループの終了を通知するために使われます。また，ReadListEnd メソッドはコンポーネント開発者も定義プロパティの ReadData メソッドで使います。

通常，ReadListEnd メソッドを呼び出す前には読み出しループが実行されます。この読み出しループは EndOfList メソッドが True を返すと終了し，ストリーム内の次の項目がリストの終了マーカーがあることを示します。

読み出した項目が終了マーカーでないと，ReadListEnd は EReadError 例外を生成します。ReadListEnd を呼び出すには，先に ReadListBegin を呼び出していなくてはなりません。


TReader.ReadPrefix
TReader.ReadPrefix3355040

TReader	参照

ReadPrefix メソッドは，フォームからのコンポーネントの継承に関する予備的な情報を読み出します。

type

  TFilerFlag = (ffInherited, ffChildPos);

  TFilerFlags = set of TFilerFlag;

procedure ReadPrefix(var Flags: TFilerFlags; var AChildPos: Integer);

説明

ReadPrefix メソッドは，Delphi ストリーム入出力システムによって内部的に使われます。このメソッドは，コンポーネントが継承フォームのコンポーネントであるかどうか，またフォーム内でコンポーネントを作成した順序が重要かどうかを表す 2 つのフラグを読み出すために，ReadComponent メソッドによって自動的に読み出されます。また，上位フォームで作成した順序でコンポーネントの位置も読み出します。ライターオブジェクトがストリームにコンポーネントを書き込むときには，これらのフラグをコンポーネントの前に付加します。

TFilerFlags 型は Flags パラメータの型です。


TReader.ReadRootComponent
TReader.ReadRootComponent3355041

TReader	参照

ReadRootComponent メソッドは，リーダーオブジェクトのストリームからコンポーネントとそのすべての所有コンポーネントを読み出します。

function ReadRootComponent(Root: TComponent): TComponent;

説明

直接 ReadRootComponent メソッドを呼び出さないでください。このメソッドはストリーム入出力システムによって内部的に使われます。リーダーオブジェクトがそのストリームによって TStream.ReadComponent で作成されると，そのリーダーオブジェクトはただちに ReadRootComponent メソッドを呼び出します。ReadRootComponent メソッドは，オブジェクトを復元するストリーミングシーケンスを初期化します。

ReadRootComponent メソッドは最初に ReadSignature メソッドを呼び出して，適切なコンポーネントを読み出していることを確認します。また，ReadRootComponent メソッドは初期化およびフィクスアップ参照も処理します。たとえば，Root で指定するコンポーネントがリーダーオブジェクトの Root プロパティの値になります。

ReadRootComponent メソッドはコンポーネントの ReadState メソッドを呼び出し，ReadState メソッドが TReader.ReadData メソッドを呼び出します。TComponent.ReadState は仮想メソッドなので，ストリームから新しいデータとともにコンポーネントをロードするための準備をする機会が提供されます。


TReader.ReadSignature
TReader.ReadSignature3355042

TReader	参照

ReadSignature メソッドは，リーダーオブジェクトに関連付けられているストリームから Delphi ファイラ ID を読み出します。

procedure ReadSignature;

説明

ReadSignature メソッドは，読み出そうとしているファイルが有効な Delphi コンポーネントストリームであることを確認するためにいくつかのルーチンで使われます。たとえば，ReadRootComponent メソッドはストリームからコンポーネントを読み出す前に ReadSignature メソッドを呼び出します。オブジェクトをロードする前にファイラ ID を確認すれば，リーダーオブジェクトで無効なデータや破損したデータを読み出さないように保護できます。

ファイラ ID は 4 文字です。現在のバージョンの Delphi では TPF0 です。


TReader.ReadStr
TReader.ReadStr3355043

TReader	参照

ReadStr メソッドは，Delphi コンポーネントが文字列値を読み出すために内部的に使われます。

function ReadStr: string;

説明

直接 ReadStr メソッドを呼び出さないでください。ReadStr メソッドは VCL コンポーネントによって内部的に使われます。

注意

コンポーネント文字列をストリームに読み出す場合は，必ず ReadString メソッドを使ってください。ReadStr メソッドは正確に使わないとデータを破損することがあります。


TReader.ReadString
TReader.ReadString3355044

TReader	参照

ReadString メソッドは，リーダーオブジェクトのストリームから WriteString メソッドを使って書き込まれているタグ付きの文字列値を読み出し，その内容を返します。

function ReadString: string;

説明

ReadString メソッドは，他のリーダーメソッドが現在のリーダーの Position から文字列を読み出すために使われるヘルパーメソッドです。ReadString メソッドは最初に ReadValue メソッドを呼び出して値の型（TValueType）をチェックします。項目が vaString または vaLString 型の場合，ReadString メソッドは Read メソッドを呼び出して，文字列を返します。それ以外の場合は EReadError 例外が生成されます。

注意

コンポーネント文字列をストリームに読み出す場合は，必ず ReadString メソッドを使ってください。名前の似ている ReadStr メソッドは VCL コンポーネントによって内部的に使われます。


TReader.ReadValue
TReader.ReadValue3355045

TReader	参照

ReadValue メソッドは，リーダーオブジェクトのストリーム上の次のデータ型を読み出し，値型インジケータの後にあるストリームを使って返します。

type TValueType = (vaNull, vaList, vaInt8, vaInt16, vaInt32, vaExtended, vaString, vaIdent, vaFalse, vaTrue, vaBinary, vaSet, vaLString, vaNil, vaCollection);

function ReadValue: TValueType;

説明

ReadValue メソッドは，読み出されるデータの型チェックによって以降の処理が決まる場合に，他のリーダーメソッドによって使われます。

TValueType 型はファイラオブジェクトに対して読み書きされる値の型を定義します。Delphi のファイラはタグ付きの値を使い，ストリーム上の各値にはその型を示すプレフィクスが付きます。これらのプレフィクスは TValueType 型です。


TReader.ReferenceName
TReader.ReferenceName3355046

TReader	参照

ReferenceName メソッドは OnReference イベントを呼び出します。

procedure ReferenceName(var Name: string); virtual;

説明

ReferenceName は OnReference イベントを呼び出すために使います。 ReferenceName も OnReference も Delphi 環境が内部的に使います。


TReader.SetName
TReader.SetName3355047

TReader	参照

SetName メソッドは，関連付けられているストリームからリーダーオブジェクトが読み出すコンポーネントの名前をコンポーネントの Name プロパティに割り当てる前にコンポーネント名を変更できるようにします。

procedure SetName(Component: TComponent; var Name: string); virtual;

説明

SetName メソッドは ReadComponent メソッドによって呼び出されます。コンポーネントの名前を読み出した後，ReadComponent メソッドは Name パラメータのストリームから読み出した名前を SetName メソッドに渡します。Name は var パラメータなので，SetName メソッドは制御を返す前に文字列を変更できます。

SetName は OnSetName イベントに結び付けられたイベントハンドラも呼び出します。var パラメータで名前文字列を渡すので，結び付けたハンドラで文字列を変更することもできます。


TValueType

TValueType 型は，ファイラオブジェクトに書き込まれる値とファイラオブジェクトから読み出される値の種類を定義します。

type

TValueType = (vaNull, vaList, vaInt8, vaInt16, vaInt32, vaExtended, vaString, vaIdent, vaFalse, vaTrue, vaBinary, vaSet, vaLString, vaNil, vaCollection);

説明

TValueType 型は，コンポーネントおよびそのプロパティをストリーミングする場合に，ストリームに対して読み書きされるプロパティの値を型チェックするために TReader および TWriter ファイラオブジェクトによって使われます。

Delphi のファイラはタグ付きの値を使い，ストリーム上の各値にはその型を示すプレフィクスが付きます。これらのプレフィクスは TValueType 型です。以下に TValueType の値を示します。

値	意味

vaNull	定数バリアント NULL として識別する

vaList	ヌルで終わるタグ付き項目のリストとして識別する

vaInt8	Shortint として識別する

vaInt16	Smallint として識別する

vaInt32	Longint として識別する

vaExtended	浮動小数点数として識別する

vaString	短い文字列として識別する

vaIdent	Pascal 識別子文字列として識別する

vaFalse	論理値の False として識別する

vaTrue	論理値の True として識別する

vaBinary	長さカウントが前に付くバイナリのブロックとして識別する

vaSet	集合として識別する

vaLString	長い文字列として識別する

vaNil	nil として識別する

vaCollection	TCollection として識別する


スコープ3355050

protected


継承3355051

TObject

TFiler


TReader 例3355052

TReader


TRegIniFile
TRegIniFile3356001

継承	プロパティ	メソッド	例

TRegIniFile オブジェクトは，INI ファイルを使う既存の Delphi アプリケーションが最低限のコード変更でシステムレジストリを使えるようにする，Windows 95 および NT システムレジストリを扱う低レベルのラッパーです。

ユニット

registry

説明

TRegIniFile オブジェクトは，Windows 95 および NT システムレジストリをあたかも Windows 3.x INI ファイルのように処理することを可能にします。しかしながら，TRegIniFile オブジェクトは INI ファイルを処理するかわりにシステムレジストリを読み書きします。

TRegIniFile オブジェクトは TRegistry オブジェクトから派生します。TRegIniFile は TRegistry のすべてのプロパティおよびメソッドを継承し，さらに TIniFile オブジェクトによって使われる同じプロパティとメソッドを追加します。TRegIniFile に追加されたメソッドのいくつか（ReadBool や WriteBool）は TRegistry のメソッドをオーバーライドします。

TRegIniFile オブジェクトに渡される FileName プロパティは，システムレジストリのルートキー（デフォルトでは HKEY_CURRENT_USER）の下のサブキーになります。INI ファイルのセクションに相当するものは，システムレジストリではキーとして処理されます。また，INI ファイルのセクションにあるデータエントリに相当するものは，システムレジストリではキーの下のデータ値として処理されます。

TRegIniFile オブジェクトは，Windows 3.x 用の16 ビットアプリケーションを Windows 95 および NT に移植する場合に特に便利です。アプリケーションのソースコードにある TIniFile オブジェクトへのすべての参照を見つけて，それらを TRegIniFile オブジェクトに置き換え，そのアプリケーションを再コンパイルすれば，新しいコードをアプリケーションに追加することなく，開発者はアプリケーションを更新して INI ファイルのかわりにシステムレジストリを使うことができます。

注意

以上のような方法を使った場合，ユーザーの既存の INI ファイルに格納されている情報はシステムレジストリに移植されません。

参考

TRegIniFile オブジェクトはシステムレジストリに対する単純なインターフェースを提供するので，ユーザーはレジストリの基本となる構造を知る必要がなくなります。開発者によっては，TRegistry オブジェクトより TRegIniFile オブジェクトの方が使いやすい場合もあるでしょう。


TRegIniFile プロパティ3356002

TRegIniFile	アルファベット順	凡例

TRegIniFile

FileName

TRegistry からの継承

CurrentKey

CurrentPath

LazyWrite

RootKey


TRegIniFile プロパティ3356003

TRegIniFile	オブジェクト順	凡例

CurrentKey

CurrentPath

FileName

LazyWrite

RootKey


TRegIniFile.FileName
TRegIniFile.FileName3356004

TRegIniFile	参照

FileName プロパティは，システムレジストリで開かれるまたは作成されるキーの名前です。

property FileName: string;

説明

FileName プロパティは，システムレジストリ内にあるすべての TRegIniFile 操作のルートキーとなっているキーの名前がわかります。


TRegIniFile メソッド3356005

TRegIniFile	アルファベット順

TRegIniFile

Create

DeleteKey

EraseSection

ReadBool

ReadInteger

ReadSection

ReadSections

ReadSectionValues

ReadString

WriteBool

WriteInteger

WriteString

TRegistry からの継承

CloseKey

CreateKey

DeleteValue

Destroy

GetDataInfo

GetDataSize

GetDataType

GetKeyInfo

GetKeyNames

GetValueNames

HasSubKeys

KeyExists

LoadKey

MoveKey

OpenKey

ReadBinaryData

ReadCurrency

ReadDate

ReadDateTime

ReadFloat

ReadTime

RegistryConnect

RenameValue

ReplaceKey

RestoreKey

SaveKey

UnLoadKey

ValueExists

WriteBinaryData

WriteCurrency

WriteDate

WriteDateTime

WriteExpandString

WriteFloat

WriteTime

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TRegIniFile メソッド3356006

TRegIniFile	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CloseKey

Create

CreateKey

DefaultHandler

DeleteKey

DeleteValue

Destroy

Dispatch

EraseSection

FieldAddress

Free

FreeInstance

GetDataInfo

GetDataSize

GetDataType

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetKeyInfo

GetKeyNames

GetValueNames

HasSubKeys

InheritsFrom

InitInstance

InstanceSize

KeyExists

LoadKey

MethodAddress

MethodName

MoveKey

NewInstance

OpenKey

ReadBinaryData

ReadBool

ReadCurrency

ReadDate

ReadDateTime

ReadFloat

ReadInteger

ReadSection

ReadSections

ReadSectionValues

ReadString

ReadTime

RegistryConnect

RenameValue

ReplaceKey

RestoreKey

SafeCallException

SaveKey

UnLoadKey

ValueExists

WriteBinaryData

WriteBool

WriteCurrency

WriteDate

WriteDateTime

WriteExpandString

WriteFloat

WriteInteger

WriteString

WriteTime


TRegIniFile.Create
TRegIniFile.Create3356007

TRegIniFile	参照

Create メソッドは，アプリケーションの TRegIniFile オブジェクトを作成します。

constructor Create(const FileName: string);

説明

Create メソッドを呼び出すと，アプリケーションの TRegIniFile オブジェクトを作成できます。Create メソッドは TRegistry オブジェクトから Create メソッドを継承し，追加プロパティの FileName を作成します。このプロパティは，レジストリで開かれるまたは作成されるキーの名前を指定します。


TRegIniFile.DeleteKey
TRegIniFile.DeleteKey3356008

TRegIniFile	参照

DeleteKey メソッドは，キーに関連付けられているデータ値を削除します。

procedure DeleteKey(const Section, Ident: string);

説明

DeleteKey メソッドを呼び出すと，キーに関連付けられているデータ値を削除できます。Section は削除する値が格納されているシステムレジストリのキーの名前からなる文字列です。Ident は削除するデータ値の名前からなる文字列です。

注意

TRegIniFile オブジェクトの DeleteKey メソッドは，TRegIniFile が派生している TRegistry オブジェクトの DeleteKey メソッドをオーバーライドします。DeleteKey メソッドの呼び出しを TRegistry 型でキャストすれば，TRegistry オブジェクトの DeleteKey メソッドにアクセスできます。


TRegIniFile.EraseSection
TRegIniFile.EraseSection3356009

TRegIniFile	参照

EraseSection メソッドは，システムレジストリにあるキーとそのデータ値を削除します。

procedure EraseSection(const Section: string);

説明

EraseSection メソッドを呼び出すと，システムレジストリからキーとそのデータ値を削除できます。Section は削除するキーを識別します。


TRegIniFile.ReadBool
TRegIniFile.ReadBool3356010

TRegIniFile	参照

ReadBool メソッドは，キーに関連付けられている指定のデータ値から論理値を取り出します。

function ReadBool(const Section, Ident: string; Default: Boolean): Boolean;

説明

ReadBool メソッドを呼び出すと，キーに関連付けられている指定のデータ値から論理値を取り出すことができます。

Section はデータ値を取り出すキーを識別する文字列です。Ident は返されるデータ値の名前を識別する文字列です。Default は，Section に対応するキーまたは Ident. に対応するデータ値がない場合に使われる論理値です。

注意

この関数は，TRegIniFile オブジェクトが派生している TRegistry オブジェクトの ReadBool 関数をオーバーライドします。この関数のかわりに TRegistry オブジェクトの ReadBool 関数を呼び出すには，ReadBool 関数の呼び出し時に明示的に TRegistry 型を指定します。


TRegIniFile.ReadInteger
TRegIniFile.ReadInteger3356011

TRegIniFile	参照

ReadInteger メソッドは，キー（Section）に関連付けられている指定のデータ値（Ident）から整数値を取り出します。

function ReadInteger(const Section, Ident: string; Default: Longint): Longint;

説明

ReadInteger メソッドを呼び出すと，キーに関連付けられている指定のデータ値から整数値を取り出すことができます。

Section はデータ値が取り出されるキーを識別する文字列です。Ident は返されるデータ値の名前を識別する文字列です。Default は，Section に対応するキーまたは Ident. に対応するデータ値がない場合に使われる整数値です。

注意

この関数は，TRegIniFile オブジェクトが派生している TRegistry オブジェクトの ReadInteger 関数をオーバーライドします。この関数のかわりに TRegistry オブジェクトの ReadInteger 関数を呼び出すには，ReadInteger 関数の呼び出し時に明示的に TRegistry 型を指定します。


TRegIniFile.ReadSection
TRegIniFile.ReadSection3356012

TRegIniFile	参照

ReadSection メソッドは，キーに関連付けられているすべてのデータ値の名前を取り出し，TString オブジェクトに格納します。

procedure ReadSection(const Section: string; Strings: TString);

説明

ReadSection メソッドを呼び出すと，キーに関連付けられているすべてのデータ値の名前を取り出し，TString オブジェクトに格納できます。Section はデータ値の名前を取り出すキーを識別する文字列です。

Strings は取り出された名前を保持する文字列オブジェクトを指定します。Strings は文字列リストなどの TStringList オブジェクト，または TString 自体である TListBox コンポーネント の Items などのコンポーネントプロパティを指すことができます。


TRegIniFile.ReadSections
TRegIniFile.ReadSections3356013

TRegIniFile	参照

ReadSections メソッドは，現在のキーに関連付けられているすべてのサブキーの名前を取り出します。

procedure ReadSections(Strings: TStrings);

説明

ReadSections メソッドを呼び出すと，現在のキーに関連付けられているすべてのサブキーの名前を取り出すことができます。

Strings は取り出される名前を保持する文字列オブジェクトを指定します。Strings は TStringList オブジェクト，または TString オブジェクト自体である TListBox コンポーネントの Items などのコンポーネントプロパティを指すことができます。


TRegIniFile.ReadSectionValues
TRegIniFile.ReadSectionValues3356014

TRegIniFile	参照

ReadSectionValues メソッドは，指定のキーに関連付けられているデータ値を取り出し，文字列オブジェクトに格納します。

procedure ReadSectionValues(const Section: string; Strings: TStrings);

説明

ReadSectionValues メソッドを呼び出すと，指定のキーに関連付けられているすべてのデータ値を読み出して，文字列オブジェクトに格納できます。Section はデータ値が取り出されるキーの名前です。Strings は取り出された値を保持する文字列オブジェクトを指定します。

Strings は TStringList オブジェクト，または TString オブジェクト自体である TListBox コンポーネントの Items などのコンポーネントプロパティを指すことができます。文字列オブジェクトの Values プロパティを使うと，オブジェクトの特定の文字列にアクセスできます。


TRegIniFile.ReadString
TRegIniFile.ReadString3356015

TRegIniFile	参照

ReadString メソッドは，キー（Section）に関連付けられている指定のデータ値（Ident）から文字列値を取り出します。

function ReadString(const Section, Ident, Default: string): string;

説明

ReadString メソッドを呼び出すと，キーに関連付けられている指定のデータ値から文字列値を取り出すことができます。

Section はデータ値を取り出すキーを識別する文字列です。Ident は返されるデータ値の名前を識別する文字列です。Default は，Section に対応するキーまたは Ident に対応するデータ値がない場合に使われる文字列値です。

注意

この関数は，TRegIniFile オブジェクトが派生している TRegistry オブジェクトの ReadString 関数をオーバーライドします。この関数のかわりに TRegistry オブジェクトの ReadString 関数を呼び出すには，ReadString 関数の呼び出し時に明示的に TRegistry 型を指定します。


TRegIniFile.WriteBool
TRegIniFile.WriteBool3356016

TRegIniFile	参照

WriteBool メソッドは，指定のキーに関連付けられている指定のデータ値に論理値を書き込みます。

procedure WriteBool(const Section, Ident: string; Value: Boolean);

説明

WriteBool メソッドを呼び出すと，指定のキーに関連付けられているデータ値に論理値を格納できます。

Section はデータ値を格納するキーを識別する文字列です。Ident は書き込むデータ値の名前を識別する文字列です。Value はデータ値に書き込む論理値です。

注意

この関数は，TRegIniFile オブジェクトが派生している TRegistry オブジェクトの WriteBool 手続きをオーバーライドします。この手続きのかわりに TRegistry オブジェクトの WriteBool 手続きを呼び出すには，WriteBool 手続きの呼び出し時に明示的に TRegistry 型を指定します。


TRegIniFile.WriteInteger
TRegIniFile.WriteInteger3356017

TRegIniFile	参照

WriteInteger メソッドは，指定のキーに関連付けられている指定のデータ値に整数値を書き込みます。

procedure WriteInteger(const Section, Ident: string; Value: Longint);

説明

WriteInteger メソッドを呼び出すと，指定のキーに関連付けられているデータ値に整数値を格納できます。

Section はデータ値を格納するキーを識別する文字列です。Ident は書き込みデータ値の名前を識別する文字列です。Value はデータ値に書き込む整数値です。

注意

この関数は，TRegIniFile オブジェクトが派生している TRegistry オブジェクトの WriteInteger 手続きをオーバーライドします。この手続きのかわりに TRegistry オブジェクトの WriteInteger 手続きを呼び出すには，WriteInteger 手続きの呼び出し時に明示的に TRegistry 型を指定します。


TRegIniFile.WriteString
TRegIniFile.WriteString3356018

TRegIniFile	参照

WriteString メソッドは，指定のキーに関連付けられている指定のデータ値に文字列値を書き込みます。

procedure WriteString(const Section, Ident, Value: string);

説明

WriteString メソッドを呼び出すと，指定のキーに関連付けられているデータ値に文字列値を格納できます。

Section はデータ値を格納するキーを識別する文字列です。Ident は書き込むデータ値の名前を識別する文字列です。Value はデータ値に書き込む文字列値です。

注意

この関数は，TRegIniFile オブジェクトが派生している TRegistry オブジェクトの WriteString 手続きをオーバーライドします。この手続きのかわりに TRegistry オブジェクトの WriteString 手続きを呼び出すには，WriteString 手続きの呼び出し時に TRegistry 型を指定します。


読み出し／書き込み3356019

読み出し専用


継承3356020

TObject

TRegistry


TRegistry
TRegistry3357001

継承	プロパティ	メソッド

TRegistry オブジェクトは，Windows 95 および NT のシステムレジストリと関数向けの低レベルのラッパーです。

ユニット

registry

説明

TRegistry を使うとアプリケーションで Windows 95 および NT のシステムレジストリへのアクセスをカプセル化できます。レジストリとは，アプリケーションが環境設定情報を格納および取得するのに使用できるデータベースです。環境設定情報は階層ツリーの形で格納されます。ツリーの各ノードはキーと呼ばれます。各キーは，アプリケーション用の環境設定情報の一部を表すサブキーおよびデータ値を格納できます。

アプリケーションが作成，オープン，読み出し，または書き込みを行うすべてのキーは定義済みルートキーのサブキーです。デフォルトでは，TRegistry オブジェクトは HKEY_CURRENT_USER というルートキーで作成されます。

TRegistry オブジェクトでは同時に 2 つ以上のキーにアクセスできません。どのキーが現在アクセスできるのかを知るには，CurrentKey プロパティの値を読み出します。TRegistry メソッドは，アプリケーションがキーのオープン，クローズ，保存，移動，コピー，および削除を行えるようにします。

1 つのキーには，実際の環境設定情報を保持している 1 個以上のデータ値を格納できます。TRegistry のメソッドは，アプリケーションがキーのデータを読み出したり書き込んだりするために，キーにデータが格納されているかどうかを問い合わせることができます。


TRegistry プロパティ3357002

TRegistry	アルファベット順	凡例

TRegistry

CurrentKey

CurrentPath

LazyWrite

RootKey


TRegistry プロパティ3357003

TRegistry	オブジェクト順	凡例

CurrentKey

CurrentPath

LazyWrite

RootKey


TRegistry.CurrentKey
TRegistry.CurrentKey3357004

TRegistry	参照

CurrentKey プロパティは，現在開いているレジストリキーです。

property CurrentKey: HKEY;

説明

CurrentKey プロパティは，現在開いているレジストリキーを特定できます。TRegistry で実行されるすべての操作はカレントキーにしか影響しません。別のキーにアクセスするには OpenKey メソッドを使います。


TRegistry.CurrentPath
TRegistry.CurrentPath3357005

TRegistry	参照

CurrentPath プロパティは，カレントキーに関連付けられたレジストリパスを返します。

property CurrentPath: string;

説明

CurrentPath プロパティは，カレントキーのレジストリパスを取得できます。システムレジストリは階層になっているので，CurrentPath はルートキーからカレントキーまでの文字列を返します。

CurrentPath はカレントキーが変わるたびに自動的に再設定されます。


TRegistry.LazyWrite
TRegistry.LazyWrite3357006

TRegistry	参照

LazyWrite プロパティは，CloseKey 手続きを呼び出したときにどのようにキーがレジストリに書き込まれるかを指定します。

property LazyWrite: Boolean;

説明

LazyWrite プロパティは，レジストリにキーを書き込む方法を指定できます。デフォルトでは，LazyWrite はレジストリオブジェクトが最初に作成されたときに True に設定されます。LazyWrite が True の場合，キーは閉じるときにレジストリに書き込まれますが，CloseKey 手続きは書き込み操作が始まる前に完了します。

LazyWrite が False の場合，キーは CloseKey が復帰する前にレジストリに書き込まれます。必要なときだけ LazyWrite を False に設定してください。LazyWrite を False に設定すると，アプリケーションがキーに対して加える変更を，次の処理を始める前にレジストリに書き込むことができます。ただし，キーを閉じるときにより多くのシステムリソースが必要になります。LazyWrite が False で，アプリケーションが多くのレジストリエントリを表示または変更しているときには，アプリケーションの性能が低下する場合があります。


TRegistry.RootKey
TRegistry.RootKey3357007

TRegistry	参照

RootKey プロパティは，アプリケーションで TRegistry オブジェクトに使うルートキーを指定します。

property RootKey: HKEY;

説明

RootKey プロパティは，アプリケーションがアクセスできるサブキーの階層を特定したり，アプリケーションで使うルートキーを指定したりできます。

デフォルトでは，RootKey はレジストリオブジェクトの作成時に HKEY_CURRENT_USER に設定されます。ルートキーを変更するには，RootKey プロパティに有効な整数値を指定します。

注意

LoadKey または RegistryConnect などの操作では，アプリケーションは RootKey のデフォルト値を変更しなければならない場合があります。


TRegistry メソッド3357008

TRegistry	アルファベット順

TRegistry

CloseKey

Create

CreateKey

DeleteKey

DeleteValue

Destroy

GetDataInfo

GetDataSize

GetDataType

GetKeyInfo

GetKeyNames

GetValueNames

HasSubKeys

KeyExists

LoadKey

MoveKey

OpenKey

ReadBinaryData

ReadBool

ReadCurrency

ReadDate

ReadDateTime

ReadFloat

ReadInteger

ReadString

ReadTime

RegistryConnect

RenameValue

ReplaceKey

RestoreKey

SaveKey

UnLoadKey

ValueExists

WriteBinaryData

WriteBool

WriteCurrency

WriteDate

WriteDateTime

WriteExpandString

WriteFloat

WriteInteger

WriteString

WriteTime

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TRegistry メソッド3357009

TRegistry	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CloseKey

Create

CreateKey

DefaultHandler

DeleteKey

DeleteValue

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetDataInfo

GetDataSize

GetDataType

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetKeyInfo

GetKeyNames

GetValueNames

HasSubKeys

InheritsFrom

InitInstance

InstanceSize

KeyExists

LoadKey

MethodAddress

MethodName

MoveKey

NewInstance

OpenKey

ReadBinaryData

ReadBool

ReadCurrency

ReadDate

ReadDateTime

ReadFloat

ReadInteger

ReadString

ReadTime

RegistryConnect

RenameValue

ReplaceKey

RestoreKey

SafeCallException

SaveKey

UnLoadKey

ValueExists

WriteBinaryData

WriteBool

WriteCurrency

WriteDate

WriteDateTime

WriteExpandString

WriteFloat

WriteInteger

WriteString

WriteTime


TRegistry.CloseKey
TRegistry.CloseKey3357010

TRegistry	参照

CloseKey メソッドは，カレントキーをレジストリに書き込み，キーを閉じます。

procedure CloseKey;

説明

CloseKey を呼び出してカレントキーをレジストリに書き込み，そのキーを閉じます。アプリケーションが必要以上に長くキーを開いておくことはできません。TRegistry メソッドの多くは，レジストリからの読み出しまたはレジストリへの書き込みが終わると CloseKey を呼び出します。カレントキーがないときに CloseKey を呼び出しても効果はありません。

注意

アプリケーションがキーを閉じると，そのキーはレジストリに書き込まれます。LazyWrite プロパティはどのようにキーを書き込むかを指定します。


TRegistry.Create
TRegistry.Create3357011

TRegistry	参照

Create メソッドは，アプリケーションの TRegistry オブジェクトを作成します。

constructor Create;

説明

Create を呼び出すと，アプリケーションの TRegistry オブジェクトをインスタンス化できます。Create は TRegistry の RootKey プロパティを HKEY_CURRENT_USER に設定し，LazyWrite プロパティを True に設定します。


TRegistry.CreateKey
TRegistry.CreateKey3357012

TRegistry	参照

CreateKey メソッドは，レジストリに新しいキーを作成します。

function CreateKey(const Key: string): Boolean;

説明

CreateKey を呼び出すと，新しいキーをレジストリに追加できます。Key は作成するキーの名前です。Key は絶対名でも相対名でもかまいません。絶対キーは円記号（\）で始まるルートキーのサブキーです。相対キーはカレントキーのサブキーです。

CreateKey はキーが正しく作成されたときに True を返します。エラーが起きたときには，例外が発生して CreateKey は False を返します。CreateKey で既存のキーを作成しようとしても処理は行われません。

CreateKey は不揮発性キーしか作成しません。Windows NT で揮発性キーを作成するには Windows API を直接呼び出さなくてはなりません。

CreateKey は KEY_ALL_ACCESS のセキュリティアクセスを持つキーを作成します。さらにアクセスを制限したキーを作成するには，Windows API を直接呼び出さなくてはなりません。

CreateKey で作成されたキーは値を持ちません。キーに値を設定するには WriteCurrency メソッド，WriteBinaryData メソッド，WriteBool メソッド，WriteDate メソッド，WriteDateTime メソッド，WriteExpandString メソッド，WriteFloat メソッド，WriteInteger メソッド，WriteString メソッド，または WriteTime メソッドを使います。


TRegistry.DeleteKey
TRegistry.DeleteKey3357013

TRegistry	参照

DeleteKey メソッドは，指定されたキーおよびキーに関連付けられたデータをレジストリから削除します。

function DeleteKey(const Key: string): Boolean;

説明

DeleteKey を呼び出すと，指定されたキーおよび（もしあれば）関連付けられたデータをレジストリから削除できます。キーにサブキーがあれば，サブキーとその関連付けられたデータも削除されます。

DeleteKey は削除が正しく行われると True を返します。エラーが起きたときには DeleteKey は False を返します。


TRegistry.DeleteValue
TRegistry.DeleteValue3357014

TRegistry	参照

DeleteValue メソッドは，カレントキーに関連付けられたデータ値を削除します。

function DeleteValue(const Name: string): Boolean;

説明

DeleteValue を呼び出すと，カレントキーに関連付けられた特定のデータを削除できます。Name は削除する値の名前を格納する文字列です。キーには複数のデータを格納でき，キーに関連付けられた各値には固有の名前が付けられます。

DeleteValue は削除が正しく行われると True を返し，削除できないと False を返します。


TRegistry.Destroy
TRegistry.Destroy3357015

TRegistry	参照

Destroy メソッドは，カレントキーを閉じて TRegistry オブジェクトを破棄します。

destructor Destroy;

説明

Destroy メソッドはカレントキーを閉じ，レジストリオブジェクトが不要になったときに割り当てられていたリソースを解放します。


TRegistry.GetDataInfo
TRegistry.GetDataInfo3357016

TRegistry	参照

GetDataInfo メソッドは，カレントキーに関連付けられた特定のデータ値についての情報を返します。

type

TRegDataType = (rdUnknown, rdString, rdExpandString, rdInteger, rdBinary);

TRegDataInfo = record

RegData: TRegDataType;

DataSize: Integer;

end;

function GetDataInfo(const ValueName: string; var Value: TRegDataInfo): Boolean;

説明

GetDataInfo を呼び出してカレントキーに関連付けられたデータ値についての情報を取得します。ValueName は問い合わせるデータ値の名前を格納している文字列です。Value はデータ値の情報が返される TRegDataInfo 型のレコードです。データ値が rdString または rdExpandString の場合，データ値のサイズには終了を表すヌル文字のためのバイトが含まれます。

GetDataInfo はデータ値の情報が返されると True を返します。GetDataInfo がデータ値を受け取れないと False が返され，Value レコードはゼロで埋められます。

Value はアプリケーションで宣言される TRegDataInfo 型のレコードです。TRegDataInfo 型レコードは，データ値のデータ型を指定する RegData と呼ばれる TRegDataType 型のフィールドと，データ値のサイズをバイト数で指定する DataSize と呼ばれるフィールドを格納します。以下に RegData の値を示します。

値	意味

rdUnknown	データ値型は定義されていない

rdString	データ値型はヌルで終わる文字列である。アプリケーションが Unicode または ANSI のどちらの文字列関数を呼び出すかによって Unicode 文字列または ANSI 文字列になる

rdExpandString	データ値型は未展開の環境変数への参照を格納しているヌルで終わる文字列である（「%PATH%」など）。アプリケーションが Unicode または ANSI のどちらの文字列関数を呼び出すかによって Unicode 文字列または ANSI 文字列になる

rdInteger	データ値型は 32 ビットの数値である

rdBinary	データ値型はいずれかの形式のバイナリデータである


TRegistry.GetDataSize
TRegistry.GetDataSize3357017

TRegistry	参照

GetDataSize メソッドは，カレントキーに関連付けられている特定のデータ値のサイズをバイト数で返します。

function GetDataSize(const ValueName: string): Integer;

説明

GetDataSize を呼び出すと，カレントキーに関連付けられている特定のデータ値のサイズ（バイト数）がわかります。ValueName は問い合わせるデータ値の名前を格納している文字列です。

GetDataSize は正常に処理されればデータ値のサイズを返します。エラーが起きると GetDataSizeは -1 を返します。

注意

データ値が文字列の場合，GetDataSize はデータ値のサイズおよび終了を表すヌル文字のためのバイトを返します。


TRegistry.GetDataType
TRegistry.GetDataType3357018

TRegistry	参照

GetDataType メソッドは，カレントキーに関連付けられている特定のデータ値を列挙型として返します。

type

TRegDataType = (rdUnknown, rdString, rdExpandString, rdInteger, rdBinary);

function GetDataType(const ValueName: string): TRegDataType;

説明

GetDataType を呼び出すと，カレントキーに関連付けられている特定のデータ値のデータ型がわかります。ValueName は問い合わせるデータ値の名前を格納している文字列です。

GetDataType は TRegDataType 型の列挙値を返します。以下に TRegDataType の値を示します。

値	意味

rdUnknown	データ値型は定義されていない

rdString	データ値型はヌルで終わる文字列である。アプリケーションが Unicode または ANSI のどちらの文字列関数を呼び出すかによって Unicode 文字列または ANSI 文字列になる

rdExpandString	データ値型は未展開の環境変数への参照を格納しているヌルで終わる文字列である（「%PATH%」など）。アプリケーションが Unicode または ANSI のどちらの文字列関数を呼び出すかによって Unicode 文字列または ANSI 文字列になる

rdInteger	データ値型は32 ビットの数値である

rdBinary	データ値型はいずれかの形式のバイナリデータである


TRegistry.GetKeyInfo
TRegistry.GetKeyInfo3357019

TRegistry	参照

GetKeyInfo メソッドは，カレントキーについての情報を返します。

type

TRegKeyInfo = record

MaxSubKeyLen: Integer;

NumValues: Integer;

MaxValueLen: Integer;

MaxDataLen: Integer;

FileTime: TFileTime;

end;

function GetKeyInfo(var Value: TRegKeyInfo): Boolean;

説明

GetKeyInfo を呼び出してカレントキーについてのすべての情報をアプリケーションに返します。Value は GetKeyInfo が返すキーの情報を格納するためにアプリケーションで宣言される変数です。Value は TRegKeyInfo 型でなければなりません。カレントキーについて GetKeyInfo が返す情報を以下に示します。

・	サブキーの数

・	最長のサブキーの名前の文字数

・	データ値の数

・	最長のデータ値型の名前

・	最長のデータ値の長さ

・	キーが最後に更新された

GetKeyInfo は正常に処理されれば True を返します。エラーが起きると False を返し，Value レコードはゼロに設定されます。


TRegistry.GetKeyNames
TRegistry.GetKeyNames3357020

TRegistry	参照

GetKeyNames メソッドは，カレントキーに属するすべてのサブキーの名前が入っている文字列リストを返します。

procedure GetKeyNames(Strings: TStrings);

説明

GetKeyNames を呼び出すと，カレントキーに属するすべてのサブキーの名前がわかります。サブキーの名前を特定しておくと，アプリケーションがキーの集合を使って繰り返し処理を行うのに便利です。

Strings はサブキーの名前のリストが返される TStrings 型の変数です。


TRegistry.GetValueNames
TRegistry.GetValueNames3357021

TRegistry	参照

GetValueNames メソッドは，カレントキーに関連付けられているすべてのデータ値の名前が入っている文字列リストを返します。

procedure GetValueNames(Strings: TStrings);

説明

GetValueNames を呼び出すと，カレントキーに関連付けられているすべてのデータ値の名前がわかります。データ値の名前を特定しておくと，アプリケーションが個々のキーのデータ値の集合を使って繰り返し処理を行うのに便利です。

Strings はデータ値の名前のリストが返される TStrings 型の変数です。


TRegistry.HasSubKeys
TRegistry.HasSubKeys3357022

TRegistry	参照

HasSubKeys メソッドは，カレントキーがサブキーを持っているかどうかを示します。

function HasSubKeys: Boolean;

説明

HasSubKeys を呼び出すと，カレントキーがサブキーを持っているかどうかがわかります。HasSubKeys はカレントキーが少なくとも 1 個のサブキーを持っていれば True を返します。サブキーを持っていなければ False を返します。


TRegistry.KeyExists
TRegistry.KeyExists3357023

TRegistry	参照

KeyExists メソッドは，指定したキーが存在するかどうかを示します。

function KeyExists(const Key: string): Boolean;

説明

KeyExists を呼び出すと，指定した名前のキーがあるかどうかがわかります。Key は検索するキーの名前です。


TRegistry.LoadKey
TRegistry.LoadKey3357024

TRegistry	参照

LoadKey メソッドは，ルートキーの下にサブキーを作成して，そのサブキーにファイルからレジストリ情報を読み込みます。

function LoadKey(const Key, FileName: string): Boolean;

説明

LoadKey を呼び出すと次の処理を行うことができます。

1.	ルートキーに下に新しいサブキーを作成する

2.	そのサブキーにファイルからレジストリ情報を読み込む。レジストリ情報にはデータ値，サブキー，およびサブキーに関するデータ値を格納できる

LoadKey は，キーとその値およびサブキーとその値を 1 つの操作で簡単に作成することを目的としています。キーとサブキーおよびそれらのデータ値をハイブと呼びます。アプリケーションは，各キーとそのデータ値を別々に作成しなくても，ファイルからハイブを読み出すことができます。これは，ユーザーが実行時に再構成できるアプリケーションで使うと特に便利です。

注意

アプリケーションが LoadKey を呼び出す前に，RootKey プロパティを HKEY_USERS または HKEY_LOCAL_MACHINE に設定するか，あるいは前回の RegistryConnect の呼び出しで返されたキーに設定しなければなりません。

Key パラメータは作成するキーの名前です。FileName パラメータはサブキーに保存するレジストリ情報を格納しているファイルの場所です。FileName で指定されるファイル名は SaveKey 関数または RegSaveKey Windows API 関数で事前に作成したファイルの名前でなければなりません。ファイルアロケーションテーブル（FAT）を使うシステムでは，FileName に拡張子を付けることはできません。


TRegistry.MoveKey
TRegistry.MoveKey3357025

TRegistry	参照

MoveKey メソッドは，既存のキー，サブキー，およびそれらのデータ値を新しいキーの名前を使って新しい位置に移動します。

procedure MoveKey(const OldName, NewName: string; Delete: Boolean);

説明

MoveKey を呼び出すと，既存のキー，サブキー，およびそれらのデータ値を別の位置にコピーまたは移動できます。コピーは再帰的です。キーがサブキーおよびデータ値を格納している場合，それらもコピーされます。操作が完了すると新しいキーは閉じられます。

OldName は移動またはコピーするキーを指定します。NewName は作成するコピーキーの名前を指定します。NewName で指定されるキーがなければ，MoveKey がそのキーを作成します。Delete はコピー操作が終わったらコピー元のキーを削除するかどうかを指定します。Delete が True のときは，OldName で指定されたキーはコピー後に削除されます。True でないときはコピー元のキーは閉じられます。


TRegistry.OpenKey
TRegistry.OpenKey3357026

TRegistry	参照

OpenKey メソッドは，指定したキーを開きます。

function OpenKey(const Key: string; CanCreate: Boolean): Boolean;

説明

OpenKey を呼び出すと，指定したキーをカレントキーにできます。Key は開くキーの名前です。Key がヌルのときには，CurrentKey プロパティは RootKey プロパティで指定されるキーに設定されます。

CanCreate は指定したキーがないときに新しく作成するかどうかを指定します。CanCreate が True のときには，必要があればキーが作成されます。

セキュリティアクセス値 KEY_ALL_ACCESS を持つ Key が開かれるか，または作成されます。OpenKey は不揮発性キーしか作成しません。不揮発性キーはレジストリに格納されるのでシステムを再起動しても保存されます。

OpenKey は正常にキーが開かれるか作成されると True を返します。


TRegistry.ReadBinaryData
TRegistry.ReadBinaryData3357027

TRegistry	参照

ReadBinaryData メソッドは，カレントキーに関連付けられた特定のデータ値からバイナリ値を取得します。

function ReadBinaryData(const Name: string; var Buffer; BufSize: Integer): Integer;

説明

ReadBinaryData を呼び出すと，カレントキーに関連付けられた特定のデータ値からバイナリ値を読み出すことができます。Name は読み出すデータ値の名前です。Buffer はレジストリデータを読み出すアプリケーション変数です。Buffer は返されるデータがすべて格納できるサイズでなければなりません。BufSize は Buffer のサイズを指定します。

正常に処理されれば，ReadBinaryData は要求されたデータを返します。エラーが起きると例外が発生するので，その場合は返された値を破棄してください。

注意

バイナリデータは一般には Object Pascal のレコードの格納に使います。バイナリデータはアイコンやビットマップであってもかまいませんが，マイクロソフトは速度の低下を理由にグラフィックオブジェクトをレジストリに格納しないように勧めています。


TRegistry.ReadBool
TRegistry.ReadBool3357028

TRegistry	参照

ReadBool メソッドは，カレントキーに関連付けられた特定のデータ値から論理値を取得します。

function ReadBool(const Name: string): Boolean;

説明

ReadBool を呼び出すと，キーに関連付けられている特定のデータ値から論理値を読み出すことができます。Name は読み出すデータ値の名前です。

正常に処理されれば，ReadBool は要求された論理値を返します。エラーが起きると例外が発生するので，その場合は返された値を破棄してください。


TRegistry.ReadCurrency
TRegistry.ReadCurrency3357029

TRegistry	参照

ReadCurrency メソッドは，カレントキーに関連付けられた特定のデータ値から Currency 値を取得します。

function ReadCurrency(const Name: string): Currency;

説明

ReadCurrency を呼び出すと，カレントキーに関連付けられた特定のデータから Currency 値を読み出すことができます。Name は読み出すデータ値の名前です。

正常に処理されれば，ReadCurrency は Currency 値を返します。エラーが起きると例外が発生するので，その場合は返された値を破棄してください。


TRegistry.ReadDate
TRegistry.ReadDate3357030

TRegistry	参照

ReadDate をメソッドは，カレントキーに関連付けられた特定のデータ値から日付値を取得します。

TDateTime: type Double;

function ReadDate(const Name: string): TDateTime;

説明

ReadDate を呼び出すと，カレントキーに関連付けられた特定のデータ値から日付値を読み出すことができます。Name は読み出すデータ値の名前です。

正常に処理されれば，ReadDate は Delphi の TDateTime 値を返します。TDateTime 値の整数部は 1899 年 12 月 30 日からの経過日数です。TDateTime 値の小数部はその日の時間を示します。

エラーが起きると例外が発生するので，その場合は返された値を破棄してください。

注意

WriteDate 手続きで保存されたデータ値を読み出すには ReadDate だけを使ってください。


TRegistry.ReadDateTime
TRegistry.ReadDateTime3357031

TRegistry	参照

ReadDateTime メソッドは，カレントキーに関連付けられた特定のデータ値から日付値および時刻値を取得します。

TDateTime: type Double;

function ReadDateTime(const Name: string): TDateTime;

説明

ReadDateTime を呼び出すと，カレントキーに関連付けられた特定のデータ値から日付時刻値を読み出すことができます。Name は読み出すデータ値の名前です。

正常に処理されれば，ReadDateTime は Delphi TDateTime 値を返します。TDateTime 値の整数部は 1899 年 12 月 30 日からの経過日数です。TDateTime 値の小数部はその日の時間を示します。

エラーが起きると例外が発生するので，その場合は返された値を破棄してください。


TRegistry.ReadFloat
TRegistry.ReadFloat3357032

TRegistry	参照

ReadFloat メソッドは，カレントキーに関連付けられた特定のデータ値から浮動小数点値を取得します。

function ReadFloat(const Name: string): Double;

説明

ReadFloat を呼び出すと，カレントキーに関連付けられた特定のデータ値から浮動小数点値を読み出すことができます。Name は読み出すデータ値の名前です。

正常に処理されれば，ReadFloat は Object Pascal の Double 値を返します。エラーが起きると例外が発生するので，その場合は返された値を破棄してください。


TRegistry.ReadInteger
TRegistry.ReadInteger3357033

TRegistry	参照

ReadInteger メソッドは，カレントキーに関連付けられた特定のデータ値から整数値を取得します。

function ReadInteger(const Name: string): Integer;

説明

ReadInteger を呼び出すと，カレントキーに関連付けられた特定のデータ値から整数値を読み出すことができます。Name は読み出すデータ値の名前です。

正常に処理されれば，ReadInteger は Object Pascal の Integer 値を返します。エラーが起きると例外が発生するので，ReadInteger が返した値は破棄してください。


TRegistry.ReadString
TRegistry.ReadString3357034

TRegistry	参照

ReadString メソッドは，カレントキーに関連付けられた特定のデータ値から文字列値を取得します。

function ReadString(const Name: string): string;

説明

ReadString を呼び出すと，カレントキーに関連付けられた特定のデータ値から文字列値を取得できます。Name は読み出すデータ値の名前です。

正常に処理されれば，ReadString は Object Pascal の String 値を返します。エラーが起きると例外が発生するので，その場合は返された値を破棄してください。


TRegistry.ReadTime
TRegistry.ReadTime3357035

TRegistry	参照

ReadTime メソッドは，カレントキーに関連付けられた特定のデータ値から時刻値を取得します。

TDateTime: type Double;

function ReadTime(const Name: string): TDateTime;

説明

ReadTime を呼び出すと，カレントキーに関連付けられた特定のデータ値から時刻値を読み出すことができます。Name は読み出すデータ値の名前です。

正常に処理されれば，ReadTime は Delphi の TDateTime 値を返します。TDateTime 値の整数部は 1899 年 12 月 30 日からの経過日数です。TDateTime 値の小数部はその日の時間を示します。

エラーが起きると例外が発生するので，その場合は返された値を破棄してください。

注意

WriteDate 手続きで保存されたデータ値を読み出すには ReadTime だけを使ってください。


TRegistry.RegistryConnect
TRegistry.RegistryConnect3357036

TRegistry	参照

RegistryConnect メソッドは，別のコンピュータのレジストリへの接続を確立します。

function RegistryConnect(const UNCName: string): Boolean;

説明

RegistryConnect を呼び出すと，Windows 95 または Windows NT を実行している別のコンピュータ上のレジストリへの接続を確立できます。UNCName はリモートコンピュータの名前で，次の形式で指定しなければなりません。

\\computername

computername はリモートコンピュータの名前です。UNCName が nil のときは，ローカルマシンの名前が使われます。

注意

RegistryConnect を呼び出す前に，アプリケーションはレジストリオブジェクトの RootKey プロパティを HKEY_USERS または HKEY_LOCAL_MACHINE に設定しなければなりません。

正常に接続されれば，RegistryConnect は RootKey プロパティをリモートコンピュータのルートキーに設定して True を返します。正常に接続されないときは，RegistryConnect は False を返し，RootKey は変更されません。


TRegistry.RenameValue
TRegistry.RenameValue3357037

TRegistry	参照

RenameValue メソッドは，カレントキーに関連付けられたデータ値の名前を変更します。

procedure RenameValue(const OldName, NewName: string);

説明

RenameValue を呼び出すと，カレントキーに関連付けられているデータ値の名前を変更できます。OldName はデータ値の現在の名前を格納している文字列です。NewName はデータ値の新しい名前を格納する文字列です。

OldName がカレントキーで使う既存のデータ値名で，NewName がカレントキーで使う既存のデータ値名でないときは，RenameValue は指定した通りにデータ値の名前を変更します。それ以外のときは現在の名前は変更されません。


TRegistry.ReplaceKey
TRegistry.ReplaceKey3357038

TRegistry	参照

ReplaceKey メソッドは，キーおよびそのサブキーをバックアップしているハイブファイルを別のファイルのハイブと置き換えて，次にシステムを起動するときにキーおよびそのサブキーが新しいファイルに格納された値を持つようにします。

function ReplaceKey(const Key, FileName, BackUpFileName: string): Boolean;

説明

ReplaceKey を呼び出すと，キーおよびそのサブキーをバックアップしているハイブファイルを別のハイブファイルと置き換えることができます。ハイブとは，レジストリの階層構造の上位にあるキー，サブキー，およびそれらの値の離散的コレクションです。

FileName は新しいキーおよびサブキーの情報を格納しているファイルの名前を示します。BackUpFileName はカレントキーおよびサブキーの情報が上書きされる前のバックアップファイルの名前です。

正常に処理されれば ReplaceKey は True を返します。

注意

FileName パラメータで指定されるファイルは，SaveKey 関数，または直接 Windows 95 および NT の API 関数 RegSaveKey を呼び出して作成しなければなりません。FAT を使うファイルシステムでは，FileName には拡張子を付けられません。


TRegistry.RestoreKey
TRegistry.RestoreKey3357039

TRegistry	参照

RestoreKey メソッドは，指定されたキーを開いて，そのキーおよびサブキーに格納されているすべての情報にハイブファイルに保存されているレジストリデータを上書きします。

function RestoreKey(const Key, FileName: string): Boolean;

説明

RestoreKey を呼び出すと，セキュリティアクセス値 KEY_ALL_ACCESS を持つ指定のキーを開き，そのキーおよびサブキーが持つすべての情報にハイブファイルに保存されているレジストリデータを上書きできます。ハイブとは，レジストリ階層構造の上位にあるキー，サブキー，およびそれらの値の離散的コレクションです。

Key は開くキーの名前です。FileName はハイブ情報を格納しているファイル名です。

RestoreKey が FileName 内のレジストリ情報を指定されたキーに正常に読み出してコピーすれば，RestoreKey は True を返しそのキーは閉じられます。

注意

FileName パラメータで指定されるファイルは，SaveKey 関数，または直接 Windows 95 および NT の API 関数 RegSaveKey を呼び出して作成しなければなりません。FAT を使うファイルシステムでは，FileName には拡張子を付けられません。


TRegistry.SaveKey
TRegistry.SaveKey3357040

TRegistry	参照

SaveKey メソッドは，セキュリティアクセス値 KEY_ALL_ACCESS を持つ指定のキーを開いて，指定されたキー，サブキー，および値をハイブファイルに保存します。

function SaveKey(const Key, FileName: string): Boolean;

説明

SaveKey を呼び出すと，セキュリティアクセス値 KEY_ALL_ACCESS を持つ指定のキーを開いて，指定されたキー，サブキー，およびデータ値をハイブファイルに保存できます。ハイブとは，レジストリの階層構造の上位にあるキー，サブキー，およびそれらの値の離散的コレクションです。

Key は保存するキーの名前です。FileName はキーの情報を保存するファイルです。このファイル名は新規の名前でなければなりません。FAT を使うファイルシステムでは，FileName には拡張子を付けられません。

SaveKey によって作成されたファイルはパラメータとして RestoreKey 関数，ReplaceKey 関数および LoadKey 関数に渡されます。

正常に処理されれば，SaveKey は True を返してキーを閉じます。


TRegistry.UnLoadKey
TRegistry.UnLoadKey3357041

TRegistry	参照

UnLoadKey メソッドは，ハイブをレジストリから削除します。

function UnLoadKey(const Key: string): Boolean;

説明

UnLoadKey を呼び出すと，関連付けられたハイブファイルがあっても修正することなくハイブファイルをレジストリから削除できます。ハイブとは，レジストリ階層構造の上位にあるキー，サブキー，およびそれらの値の離散的コレクションです。

Key は削除するハイブのルートにあるキーの名前です。

正常に処理されれば UnLoadKey は True を返します。

注意

UnLoadKey 関数を呼び出す前に RootKey を HKEY_USERS，HKEY_LOCAL_MACHINE に設定するか，RegistryConnect を呼び出してください。


TRegistry.ValueExists
TRegistry.ValueExists3357042

TRegistry	参照

ValueExists メソッドは，カレントキーに対して指定されたデータ値が存在するかどうかを確認します。

function ValueExists(const Name: string): Boolean;

説明

ValueExists を呼び出すと，特定のキーがレジストリに存在するかどうかを確認できます。既存のキーに対してのみ機能する他の TRegistry メソッドを呼び出す前に ValueExists を呼び出すと特に便利です。

Name はチェックするデータ値の名前です。

一致するデータ値が見つかると ValueExists は True を返し，見つからないときは False を返します。


TRegistry.WriteBinaryData
TRegistry.WriteBinaryData3357043

TRegistry	参照

WriteBinaryData メソッドは，Object Pascal のレコードをカレントキーに関連付けられた特定のデータ値名で格納します。

procedure WriteBinaryData(const Name: string; var Buffer; BufSize: Integer);

説明

WriteBinaryData を呼び出すと，カレントキーに関連付けられたデータ値に Object Pascal のレコードを格納できます。

Name はデータを格納するデータ値の名前が入っている文字列です。Name が既存の名前のときには現在の値は WriteBinary によって上書きされます。Name が新規の名前のときには新しく作成されます。

Buffer はレジストリに格納するデータが入っている Object Pascal のレコードまたはデータバッファです。BufSize はバッファのサイズを示します。

注意

データ値の長さは使用可能なメモリによって制限されます。長い値（2048 バイト以上）の場合は，別のファイルとして格納して，ファイル名をレジストリに格納してください。アイコン，ビットマップ，および実行ファイルのようなアプリケーション要素はレジストリ内のデータとしてではなく，個別のファイルとして格納してください。

WriteBinaryData が失敗すると，例外が発生して値はレジストリに書き込まれません。


TRegistry.WriteBool
TRegistry.WriteBool3357044

TRegistry	参照

WriteBool メソッドは，カレントキーに関連付けられた特定のデータ値名で論理値を格納します。

procedure WriteBool(const Name: string; Value: Boolean);

説明

WriteBool を呼び出すと，Object Pascal Boolean 値をカレントキーに関連付けられたデータ値に格納できます。

Name はデータを格納するデータ値の名前が入っている文字列です。Name が既存の名前のときには現在の値は WriteBool によって上書きされます。Name が新規の名前のときには新しく作成されます。

Value はレジストリに格納する Object Pascal の Boolean 値です。

WriteBool が失敗すると例外が発生し，値はレジストリに書き込まれません。


TRegistry.WriteCurrency
TRegistry.WriteCurrency3357045

TRegistry	参照

WriteCurrency メソッドは，Currency 値をカレントキーに関連付けられた特定のデータ値名で格納します。

procedure WriteCurrency(const Name: string; Value: Currency);

説明

WriteCurrency を呼び出すと，Object Pascal の Currency 値をカレントキーに関連付けられたデータ値に格納できます。

Name はデータを格納するデータ値の名前が入っている文字列です。Name が既存の名前のときには現在の値は WriteCurrency によって上書きされます。Name が新規の名前のときには新しく作成されます。

Value はレジストリに格納する Object Pascal の Currency 値です。

WriteCurrency が失敗すると，例外が発生して値はレジストリに書き込まれません。


TRegistry.WriteDate
TRegistry.WriteDate3357046

TRegistry	参照

WriteDate メソッドは，カレントキーに関連付けられた特定のデータ値名で日付値を格納します。

TDateTime: type Double;

procedure WriteDate(const Name: string; Value: TDateTime);

説明

WriteDate を呼び出すと，カレントキーに関連付けられたデータ値に Object Pascal の日付時刻値を格納できます。

Name はデータを格納するデータ値の名前が入っている文字列です。Name が既存の名前のときには現在の値は WriteDate によって上書きされます。Name が新規の名前のときには新しく作成されます。

Value はレジストリに格納する Object Pascal の日付時刻値です。

WriteDate が失敗すると，例外が発生して値はレジストリに書き込まれません。

正常に処理されれば，WriteDate は Delphi の TDateTime 値を格納します。TDateTime 値の整数部は 1899 年 12 月 30 日からの経過日数です。TDateTime 値の小数部はその日の時間を示します。


TRegistry.WriteDateTime
TRegistry.WriteDateTime3357047

TRegistry	参照

WriteDateTime メソッドは，日付時刻値をカレントキーに関連付けられた特定のデータ値名で格納します。

TDateTime: type Double;

procedure WriteDateTime(const Name: string; Value: TDateTime);

説明

WriteDateTime を呼び出すと，Object Pascal の日付時刻値をカレントキーに関連付けられたデータ値に格納できます。

Name はデータを格納するデータ値の名前が入っている文字列です。Name が既存の名前のときには現在の値は WriteDateTime によって上書きされます。Name が新規の名前のときには新しく作成されます。

Value はレジストリに格納する Object Pascal の日付時刻値です。

WriteDateTime が失敗すると，例外が発生して値はレジストリに書き込まれません。

正常に処理されれば，WriteDateTime は Delphi の TDateTime 値を格納します。TDateTime 値の整数部は 1899 年 12 月 30 日からの経過日数です。TDateTime 値の小数部はその日の時間を示します。


TRegistry.WriteExpandString

TRegistry	参照

WriteExpandString メソッドは，文字列値をカレントキーに関連付けられた特定のデータ値名で格納します。

procedure WriteExpandString(const Name, Value: string);

説明

WriteExpandString を呼び出すと，Object Pascal 文字列値をカレントキーに関連付けられたデータ値に格納できます。

WriteString は文字列を REG_SZ 型のレジストリ値として書き込むのに対し，WriteExpandString は REG_EXPAND_SZ 型として書き込みます。レジストリの型については WIN32 API のヘルプを参照してください。

Name はデータを格納するデータ値の名前が入っている文字列です。Name が既存の名前のときには現在の値は WriteExpandString によって上書きされます。Name が新規の名前のときには新しく作成されます。Value はレジストリに格納する Object Pascal の文字値です。

WriteExpandString が失敗すると，例外が発生して値はレジストリに書き込まれません。


TRegistry.WriteFloat
TRegistry.WriteFloat3357048

TRegistry	参照

WriteFloat メソッドは，Double 値をカレントキーに関連付けられた特定のデータ値名で格納します。

procedure WriteFloat(const Name: string; Value: Double);

説明

WriteFloat を呼び出すと，Object Pascal の浮動小数点値をカレントキーに関連付けられたデータ値に格納できます。

Name はデータを格納するデータ値の名前が入っている文字列です。Name が既存の名前のときには現在の値は WriteFloat によって上書きされます。Name が新規の名前のときには新しく作成されます。

Value はレジストリに格納する Object Pascal の浮動小数点値です。

WriteFloat が失敗すると，例外が発生して値はレジストリに書き込まれません。


TRegistry.WriteInteger
TRegistry.WriteInteger3357049

TRegistry	参照

WriteInteger メソッドは，整数値をカレントキーに関連付けられた特定のデータ値名で格納します。

procedure WriteInteger(const Name: string; Value: Integer);

説明

WriteInteger を呼び出すと，Object Pascal の整数値をカレントキーに関連付けられたデータ値に格納できます。

Name はデータを格納するデータ値の名前が入っている文字列です。Name が既存の名前のときには現在の値は WriteInteger によって上書きされます。Name が新規の名前のときには新しく作成されます。

Value はレジストリに格納する Object Pascal の整数値です。

WriteInteger が失敗すると，例外が発生して値はレジストリに書き込まれません。


TRegistry.WriteString
TRegistry.WriteString3357050

TRegistry	参照

WriteString メソッドは，文字列値をカレントキーに関連付けられた特定のデータ値名で格納します。

procedure WriteString(const Name, Value: string);

説明

WriteString を呼び出すと，Object Pascal の文字列値をカレントキーに関連付けられたデータ値に格納できます。

Name はデータを格納するデータ値の名前が入っている文字列です。Name が既存の名前のときには現在の値は WriteString によって上書きされます。Name が新規の名前のときには新しく作成されます。

Value はレジストリに格納する Object Pascal の文字列値です。

WriteString が失敗すると，例外が発生して値はレジストリに書き込まれません。


TRegistry.WriteTime
TRegistry.WriteTime3357051

TRegistry	参照

WriteTime メソッドは，時刻値をカレントキーに関連付けられた特定のデータ値名で格納します。

procedure WriteTime(const Name: string; Value: TDateTime);

説明

WriteTime を呼び出すと，Object Pascal の日付時刻値をカレントキーに関連付けられたデータ値に格納できます。

Name はデータを格納するデータ値の名前が入っている文字列です。Name が既存の名前のときには現在の値は WriteTime によって上書きされます。Name が新規の名前のときには新しく作成されます。

Value はレジストリに格納する Object Pascal の日付時刻値です。

WriteTime が失敗すると，例外が発生して値はレジストリに書き込まれません。

正常に処理されれば，WriteTime は Delphi の TDateTime 値を格納します。TDateTime 値の整数部は 1899 年 12 月 30 日からの経過日数です。TDateTime 値の小数部はその日の時間を示します。


読み出し／書き込み3357052

読み出し専用


継承3357053

TObject


TRegistry 例3357054

TRegistry


TRemoteServer
TRemoteServer3358001

継承	プロパティ	メソッド	イベント	参照

TRemoteServer は，多層アプリケーションの一部をなすクライアントアプリケーションでリモートサーバー接続を処理するためのオブジェクトです。

ユニット

dbclient

説明

TRemoteServer は多層データベースアプリケーションのクライアント部で使い，クライアントとリモートアプリケーションサーバーの間の接続を確立して維持します。リモートサーバーオブジェクトは以下の処理を行うことができます。

・	リモートアプリケーションサーバーへの初期接続を確立する

・	この接続でクライアントデータセットが利用できるプロバイダ名のリストを提供する

・	プロバイダ名に基づいて IProvider インターフェースを取得する

・	この接続によってサービスの対象になるローカルクライアントデータセットのリストを管理する

・	リモートアプリケーションサーバーへの接続を切断する

リモートサーバーオブジェクトは，DCOM を使ってクライアントアプリケーションとリモートアプリケーションサーバーの間の初期接続を確立します。接続がいったん確立すると，クライアントがそのクライアントデータセットの一部または全部をリモートサーバーに登録するので，そういったクライアントデータセットがその IProvider DCOM インターフェースを介してアプリケーションサーバーの TProvider オブジェクトと直接通信できるようになります。


TRemoteServer プロパティ3358002

TRemoteServer	アルファベット順	凡例

TRemoteServer

AppServer

ComputerName

Connected

SenerGUID

ServerName

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TRemoteServer プロパティ3358003

TRemoteServer	オブジェクト順	凡例

AppServer

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ComputerName

Connected

DesignInfo

Name

Owner

SenerGUID

ServerName

Tag

VCLComObject


TRemoteServer.AppServer
TRemoteServer.AppServer3358004

TRemoteServer	参照

AppServer プロパティは，リモートサーバーに返されるインターフェースが入ったバリアントを示します。

property AppServer: Variant;

説明

AppServer プロパティは，アプリケーションサーバーのプロバイダコンポーネントによりリモートサーバーに返されるインターフェースを指す読み出し専用プロパティです。クライアントアプリケーションはこのインターフェースを介してアプリケーションサーバーと直接通信できます。


TRemoteServer.ComputerName
TRemoteServer.ComputerName3358005

TRemoteServer	参照

ComputerName プロパティは，複層アプリケーションのアプリケーションサーバーが配置されているマシンの名前を指定します。

property ComputerName: string;

説明

ComputerName プロパティをアプリケーションサーバーを配置するコンピュータのマシン名に設定します。ComputerName がブランク（デフォルト）のときは，Delphi はアプリケーションサーバーがユーザーのマシンにあるか，コンピュータ名を DCOM または OLE Enterprise の環境設定に基づいたシステムレジストリから取得できると想定します。クライアントとアプリケーションサーバーは別々のマシンで稼動しているのがふつうなので，ComputerName はこのようなメソッドの 1 つによって設定されなければなりません。


TRemoteServer.Connected
TRemoteServer.Connected3358006

TRemoteServer	参照

Connected プロパティは，リモートサーバーオブジェクトがリモートアプリケーションサーバーに接続されているかどうかを示します。

property Connected: Boolean;

説明

Connected プロパティは，リモートサーバーオブジェクトの現在の接続ステータスを取得および設定することができます。デフォルトでは，Connected は False です。


TRemoteServer.ServerName
TRemoteServer.ServerName3358007

TRemoteServer	参照

ServerNameプロパティは，リモートサーバーが接続するアプリケーションサーバーの名前を指定します。

property ServerName: string;

説明

ServerNameプロパティは，リモートサーバーオブジェクトが接続するアプリケーションサーバーの名前を指定できます。開発者は設計時に，オブジェクトインスペクタでこのプロパティ用のドロップダウンリストから利用可能なサーバーを選択できます。

ServerName がブランク（デフォルト）のときは，Delphi はサーバー名を DCOM または OL Enterprise の環境設定に基づいたシステムレジストリから取得できると想定します。


TRemoteServer イベント3358008

TRemoteServer	アルファベット順	凡例

TCustomRemoteServer からの継承

AfterConnect

AfterDisconnect

BeforeConnect

BeforeDisconnect


TRemoteServer イベント3358009

TRemoteServer	オブジェクト順	凡例

AfterConnect

AfterDisconnect

BeforeConnect

BeforeDisconnect


TRemoteServer メソッド3358010

TRemoteServer	アルファベット順	凡例

TRemoteServer

DoConnect

DoDisconnect

GetConnected

GetProvider

GetProviderNames

TCustomRemoteServer からの継承

Create

Destroy

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TRemoteServer メソッド3358011

TRemoteServer	オブジェクト順	凡例

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DoConnect

DoDisconnect

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetConnected

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetProvider

GetProviderNames

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TRemoteServer.DoConnect
TRemoteServer.DoConnect3358012

TRemoteServer	参照

DoConnect メソッドは，アプリケーションサーバーへの接続を確立します。

procedure DoConnect;

説明

DoConnect メソッドは，SetConnected メソッドによって内部的に呼び出されます。DoConnect はリモートサーバーとアプリケーションサーバー上のプロバイダオブジェクトとの間の ActiveX デュアルインターフェースを確立します。


TRemoteServer.DoDisconnect
TRemoteServer.DoDisconnect3358013

TRemoteServer	参照

DoDisconnect メソッドは，アプリケーションサーバーとの接続を解除します。

procedure DoDisonnect;

説明

DoDisconnect メソッドは，SetConnected メソッドによって内部的に呼び出されます。DoDisconnect はアプリケーションサーバーとの接続を解除します。


TRemoteServer.GetConnected
TRemoteServer.GetConnected3358014

TRemoteServer	参照

GetConnected メソッドは，Connected プロパティの読み出し専用メソッドです。

function GetConnected: Boolean;

説明

GetConnected メソッドは，リモートサーバーがアプリケーションサーバーに接続されているかどうかを判定します。GetConnected が返す値は Connected プロパティの現在の設定値になります。

GetConnected が True を返した場合，接続は確立されています。接続が確立されていない場合，GetConnected は False を返します。


TRemoteServer.GetProvider
TRemoteServer.GetProvider3358015

TRemoteServer	参照

GetProvider メソッドは，クライアントアプリケーション接続要求に応答してアプリケーションサーバー上のプロバイダオブジェクトにより実現された IProvider インターフェースを返す関数です。

function GetProvider (const ProviderName: string): IProvider;

説明

GetProvider メソッドを呼び出すと，ProviderName パラメータに対応する IProvider を返すことができます。GetProvider で返された IProvider インターフェースは，後でデータ交換の目的でプロバイダオブジェクトと直接通信するためにクライアントデータセットが使います。

ProviderName は，TProvider インターフェースを返すアプリケーションサーバー上のプロパティの名前です。

Delphi での COM インターフェースの使い方の詳細については，『開発者ガイド』を参照してください。


TRemoteServer.GetProviderNames
TRemoteServer.GetProviderNames3358016

TRemoteServer	参照

GetProviderNames メソッドは，アプリケーションサーバーから，リモートサーバーが作成し管理しているリストへ，利用可能なすべてのプロバイダオブジェクトのリストを取り出します。

procedure GetProviderNames(List: TStrings);

説明

GetProviderNames メソッドを呼び出すと，アプリケーションサーバーによって確立された利用可能なすべての IProvider インターフェースのリストが返されます。その後，このリモートサーバーを使うクライアントデータセットでインターフェースが利用可能になります。

List は，クライアントアプリケーションによって作成され，管理されている文字列リストで，IProvider インターフェースのリストはこの中に格納されます。


スコープ3358017

published

読み出し／書き込み

読み出し専用


スコープ3358018

protected


スコープ3358019

published


継承3358020

TObject

TPersistent

TComponent

TCustomRemoteServer


TRemoteServer 例3358021

TRemoteServer


TReplaceDialog
TReplaceDialog3359001

継承	プロパティ	メソッド	イベント	参照

TReplaceDialog コンポーネントは，検索および置換ダイアログボックスを表示します。

ユニット

dialogs

説明

TReplaceDialog は検索文字列および置換文字列を入力する TFindDialog の特別なバージョンです。［検索］ダイアログと同じように［置換］ダイアログにはモードがなく，実行時には Execute メソッドを呼び出してアクティブにされるまで表示されません。


TReplaceDialog プロパティ3359002

TReplaceDialog	アルファベット順	凡例

TReplaceDialog

ReplaceText

TFindDialog からの継承

FindText

Handle

Left

Options

Position

Top

TCommonDialog からの継承

Ctl3D

HelpContext

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TReplaceDialog プロパティ3359003

TReplaceDialog	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Ctl3D

DesignInfo

FindText

Handle

HelpContext

Left

Name

Options

Owner

Position

ReplaceText

Tag

Top

VCLComObject


TReplaceDialog.ReplaceText
TReplaceDialog.ReplaceText3359004

TReplaceDialog	参照

ReplaceText プロパティは，FindText を置き換えるテキストを示します。

property ReplaceText: string;

説明

［置換前の文字列(N)］編集ボックスの FindText には検索したい文字列が入ります。［置換後の文字列(P)］編集ボックスの ReplaceText には FindText と置き換えるテキスト文字列が入ります。ダイアログが開いたときに［置換後の文字列(P)］編集ボックスにデフォルトのテキスト文字列を表示するには，オブジェクトインスペクタかプログラムコードで ReplaceText に値を設定してください。


TReplaceDialog イベント3359005

TReplaceDialog	アルファベット順	凡例

TReplaceDialog

OnReplace

TFindDialog からの継承

OnFind

TCommonDialog からの継承

OnClose

OnShow


TReplaceDialog イベント3359006

TReplaceDialog	オブジェクト順	凡例

OnClose

OnFind

OnReplace

OnShow


TReplaceDialog.OnReplace
TReplaceDialog.OnReplace3359007

TReplaceDialog	参照

OnReplace イベントは，ユーザーが［置換して次に(R)］または［すべて置換(A)］ボタンをクリックしたときに発生します。

property OnReplace: TNotifyEvent;

説明

OnReplace イベントは，ユーザーが［置換］ダイアログボックスで［置換して次に(R)］ボタンか［すべて置換(A)］ボタンをクリックしたときに発生します。また，ユーザーが［置換して次に(R)］をクリックしたときには Options の frReplace フラグが設定（frReplaceAll はオフに）されます。ユーザーが ReplaceAll をクリックしたときには Options の frReplaceAll フラグが設定（frReplace フラグはオフに）されます。

FindText で指定したテキストを検索してそれを ReplaceText のテキストで置換する OnReplace イベントハンドラを記述してください。Options フラグを使うと検索の方法を指定できます。

たとえば，次のイベントハンドラは，TMemo オブジェクトの Memo1 を検索して FindText を ReplaceText と置換します。TMemo オブジェクトの SelStart，SelLength，および SelText の 3 つのプロパティを使います。

procedure TForm1.ReplaceDialog1Replace(Sender: TObject);

var

  SelPos: Integer;

begin

  with TReplaceDialog(Sender) do

  begin

    {大文字と小文字を区別して Memo1 の FindText をグローバル検索する}

    SelPos := Pos(FindText, Memo1.Lines.Text);

    if SelPos > 0 then

    begin

      Memo1.SelStart := SelPos - 1;

      Memo1.SelLength := Length(FindText);

      {選択されたテキストを ReplaceText と置換する}

      Memo1.SelText := ReplaceText;

    end

    else MessageDlg(Concat('Could not find "', FindText, '" in Memo1.'), mtError,

      [mbOk], 0);

  end;

end;


TReplaceDialog メソッド3359008

TReplaceDialog	アルファベット順

TReplaceDialog

Create

TFindDialog からの継承

CloseDialog

Destroy

Execute

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TReplaceDialog メソッド3359009

TReplaceDialog	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CloseDialog

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Execute

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TReplaceDialog.Create
TReplaceDialog.Create3359010

TReplaceDialog	参照

Create メソッドは，TReplaceDialog インスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは，TReplaceDialog インスタンスを生成しますが，新しいダイアログは実行時に Execute メソッドを呼び出すまでフォームに表示されません。


スコープ3359011

published

読み出し／書き込み

読み出し専用


スコープ3359012

published


継承3359013

TObject

TPersistent

TComponent

TCommonDialog

TFindDialog


TReplaceDialog 例3359014

TReplaceDialog


TWebRequest
TWebRequest3361001

継承	プロパティ	メソッド	参照

TWebRequest コンポーネントは，Web サーバーアプリケーションに渡されるクライアント要求情報を表すすべてのオブジェクトの抽象基本クラスです。

ユニット

httpapp

説明

TWebRequest の下位オブジェクトを使うと，HTTP 要求メッセージの意味を知ることができます。

Web アプリケーションオブジェクトは，クライアント要求をキャプチャする TWebRequest オブジェクトを作成します。TWebRequest オブジェクトのプロパティは，HTTP 要求メッセージから取得されます。Web アプリケーションは，TWebRequest オブジェクトを使って，対応する TWebResponse オブジェクトを作成します。次に，アプリケーションの TWebDispatcher は，TWebRequest オブジェクトの PathInfo を処理する TWebActionItem を呼び出します。

TWebRequest には，3 つの下位オブジェクトがあり，それぞれタイプの異なる Web サーバーアプリケーションから渡されたクライアント要求を表しています。この 3 つの下位オブジェクトは，以下のとおりです。

・	ISAPI サーバーまたは NSAPI サーバーに応答する DLL 用の TISAPIRequest オブジェクト

・	CGI サーバーアプリケーションに応答する TCGIRequest オブジェクト

・	Windows ベース CGI サーバーに応答する TWinCGIRequest オブジェクト


TWebRequest プロパティ3361002

TWebRequest	アルファベット順	凡例

TWebRequest

Accept

Authorization

CacheControl

Connection

Content

ContentEncoding

ContentFields

ContentLength

ContentType

ContentVersion

Cookie

CookieFields

Date

DerivedFrom

Expires

From

Host

IfModifiedSince

Method

MethodType

PathInfo

PathTranslated

ProtocolVersion

Query

QueryFields

Referer

RemoteAddr

RemoteHost

ScriptName

ServerPort

Title

URL

UserAgent


TWebRequest プロパティ3361003

TWebRequest	オブジェクト順	凡例

Accept

Authorization

CacheControl

Connection

Content

ContentEncoding

ContentFields

ContentLength

ContentType

ContentVersion

Cookie

CookieFields

Date

DerivedFrom

Expires

From

Host

IfModifiedSince

Method

MethodType

PathInfo

PathTranslated

ProtocolVersion

Query

QueryFields

Referer

RemoteAddr

RemoteHost

ScriptName

ServerPort

Title

URL

UserAgent


TWebRequest.Accept
TWebRequest.Accept3361004

TWebRequest	参照

Accept プロパティは，HTTP 要求メッセージの Accept ヘッダーの値です。

property Accept: string;

説明

Accept プロパティを読み出すと，Web クライアントが応答メッセージを受け取れる媒体の種類がわかります。すべての要求メッセージに Accept ヘッダーがあるわけではありません。Accept プロパティが設定されていない場合は，すべての媒体の種類が受け取り可能になります。

Accept ヘッダーは通常，応答メッセージを受け取れる望ましい媒体が限られていることを示しています。たとえば，オーディオ応答を要求するクライアントは，Accept プロパティに次の文字列を設定した TWebRequest オブジェクトを作成します。

audio/*; q=0.2，audio/basic

この要求は，望ましい媒体の種類がオーディオ／ベーシックであるが，性能が 80% ダウンした後に利用して最善なのであれば，どんなオーディオ媒体でもかまわないということを示しています。

Accept ヘッダーの形式については，現在のインターネット規格を参照してください。


TWebRequest.Authorization
TWebRequest.Authorization3361005

TWebRequest	参照

Authorization プロパティは，HTTP 要求メッセージの Authorization ヘッダーの値です。

property Authorization: string;

説明

Authorization を読み出すと，その要求メッセージを送ったクライアントが正しい認証情報を受け取っているかどうかを調べられます。Authorization を使うと，Web アプリケーションは URL プロパティで指定されたリソースへの限定的なアクセスを提供できます。

HTTP 認証については，インターネット規格を参照してください。


TWebRequest.CacheControl
TWebRequest.CacheControl3361006

TWebRequest	参照

CacheControl プロパティは，HTTP 要求メッセージの Cache-Control ヘッダーの値を示します。

property CacheControl: string;

説明

CacheControl プロパティを読み出すと，要求／応答チェーンにおいてすべてのキャッシュメカニズムに従わなければならない Web クライアント疑似命令がすべてわかります。HTTP 要求の CacheControl 疑似命令を，対応する HTTP 応答に適用する必要はありません。

HTTP 1.1 規格では，次の CacheControl 疑似命令を定義しています。

値	意味

no-cache	要求をキャッシュできない。Web サーバーは要求を確認してから TWebRequest オブジェクトを作成する

no-store	要求には微妙な情報があり，バックアップテープなどの永久的媒体に格納できない。この要求がファイル内に一時的に保存されている場合は，そのファイルを削除しなければならない

max-age=ss	要求は，ss 秒以上，古いものであれば無効とされる。Expires プロパティの方が制限時間が短くても，それよりもこの疑似命令の方が優先する。Web サーバーが無効な要求を確認した後，TWebRequest オブジェクトを作成する

max-stale or max-stale=ss	クライアントは，満了時間を超えた応答を受け取る用意がある。オプションの max-stale 疑似命令で，満了時間を何秒，超過してもよいかを示す

min-fresh=ss	クライアントは，ss 秒以内に満了になる応答を受け取らない


TWebRequest.Connection
TWebRequest.Connection3361007

TWebRequest	参照

Connection プロパティは，HTTP 要求メッセージの Connection ヘッダーの値を示します。

property Connection: string;

説明

Connection プロパティを読み出すと，Web クライアントが要求するサーバーアプリケーションとの接続オプションがわかります。HTTP 1.1 規格では，Connection ヘッダーに 1 つしか値を指定しません。このプロパティの値が close の場合，応答処理完了後，接続を切断しないといけません。


TWebRequest.Content
TWebRequest.Content3361008

TWebRequest	参照

Content プロパティは，HTTP 要求メッセージのまだ分解されていない内容を表しています。

property Content: stringe;

説明

Content プロパティを使うと，サーバーに情報を送る HTTP 要求メッセージの内容を読み出すことができます。このプロパティの値は，HTTP 要求メッセージの Method によって決まります。Method が POST のとき，Content プロパティはまだ分解されていない文字列で，関連項目とともに登録される値を示します。Method が PUT のとき，Content プロパティは，URL プロパティによって指定された URL を置換する値になります。

注意

Method が POST の場合，分解済みの登録要求は ContentFields プロパティで得られます。


TWebRequest.ContentEncoding
TWebRequest.ContentEncoding3361009

TWebRequest	参照

ContentEncoding プロパティは，HTTP 要求メッセージの Content-Encoding ヘッダーの値を示します。

property ContentEncoding: string;

説明

ContentEncoding プロパティを読み出すと，HTTP 要求の Content に適用されたコード化メカニズムがある場合，それを知ることができます。コード化メカニズムは，Web クライアントが適用した順番で並び，カンマで区切られています。一般にこのプロパティは，拡張 ASCII 文字をネット上で転送するための圧縮方式またはコード化方式を示しています。

ContentEncoding メカニズムを逆に使用すると，Content プロパティの値を復元して，ContentType プロパティが指定するフォームに設定できます。


TWebRequest.ContentFields
TWebRequest.ContentFields3361010

TWebRequest	参照

ContentFields プロパティは，POST 要求メッセージの分解された内容です。

property ContentFields: TStrings;

説明

MethodType が mtPost のときに ContentFields プロパティを使うと，HTTP 要求メッセージの各項目を読み出すことができます。HTTP 要求の Content は分解され，アンド記号（&）を挟んで別々の項目に分かれます。

各項目は，フォーム Name=Value の ContentFields リストに独立した文字列として入ります。TStrings オブジェクトと同様に，ContentFields プロパティを使えば，アプリケーションは名前や値によって個々の項目を操作できます。


TWebRequest.ContentLength
TWebRequest.ContentLength3361011

TWebRequest	参照

ContentLength プロパティは，HTTP 要求メッセージの Content-Length ヘッダーの値を示します。

property ContentLength: Integer;

説明

ContentLength プロパティを読み出すと，Content プロパティの長さがわかります。ContentType が text/html でないとき，ContentLength プロパティで Content プロパティの末尾を知ることができます。ContentLength プロパティがゼロの場合，Content プロパティの長さはわかりません。要求にまったく Content がない場合もあれば，Web クライアントが Content プロパティの長さを知らなかった場合もあるからです。

注意

分割転送によって Content プロパティが渡されたとき，Content プロパティの長さは ContentLength 未満の場合があります。


TWebRequest.ContentType
TWebRequest.ContentType3361012

TWebRequest	参照

ContentType プロパティは，HTTP 要求メッセージの Content-Type ヘッダーの値を示します。

property ContentType: string;

説明

ContentType プロパティを読み出すと，HTTP 要求メッセージの Content の媒体タイプがわかります。このプロパティは，Type/SubType 形式の文字列です。

ほとんどの HTTP 要求はまったく Content を要求しません。これを要求する Method を持った要求は大部分，ContentType が text/html です。ただし，サーバー固有の Method 値を持った HTTP 要求は，その要求に適したどんな媒体でも使用できます。


TWebRequest.ContentVersion
TWebRequest.ContentVersion3361013

TWebRequest	参照

ContentVersion プロパティは，HTTP 要求メッセージの Content-Version ヘッダーの値を示します。

property ContentVersion: string;

説明

ContentVersion プロパティを読み出すと，HTTP 要求メッセージの Content のバージョンがわかります。ほとんどの HTTP 要求はまったく Content を要求しません。Method が Content の値を要求するときは，ContentVersion に内容のソースのバージョンを設定できます。ContentVersion の形式は要求の ContentType によって決まります。


TWebRequest.Cookie
TWebRequest.Cookie3361014

TWebRequest	参照

Cookie プロパティは，HTTP 要求メッセージの Cookie ヘッダーの値を示します。

property Cookie: string;

説明

Cookie プロパティを使うと，Web クライアント要求内に指定されている「cookie」文字列を読み出すことができます。cookie 文字列を使えばどんな情報でもコード化できますが，この文字列は一般に Web アプリケーション内の状態情報を追跡するのに使用されます。Cookie プロパティは Cookie ヘッダーの分解されていない値です。Cookie ヘッダーには複数の項目をセミコロン（;）で区切って設定できます。項目単位で Cookie ヘッダーを処理するには，CookieFields プロパティを使います。


TWebRequest.CookieFields
TWebRequest.CookieFields3361015

TWebRequest	参照

CookieFields プロパティは，HTTP 要求メッセージの Cookie ヘッダーを分解した内容です。

property CookieFields: TStrings;

説明

CookieFields プロパティを使うと，Web クライアント要求で指定された個々の「cookie」文字列を操作できます。Cookie プロパティは，セミコロン（;）が現れたところでさらに小さい文字列に分離するという方法で，独立した複数の項目に分解されます。

cookie 文字列はどんな情報でもコード化できますが，一般には Web アプリケーション内の状態情報を追跡するのに使います。各項目は，フォーム Name=Value の CookieFields リストに独立した文字列として入ります。TStrings オブジェクトと同様に，CookieFields プロパティを使えば，アプリケーションは名前や値によって個々の項目を操作できます。

注意

アプリケーションは，状態変数に，予約された cookie 項目名を除く任意の名前を自由に付けることができます。予約された cookie 項目名とその意味のリストについては，Netscape のマニュアルを参照してください。


TWebRequest.Date
TWebRequest.Date3361016

TWebRequest	参照

Date プロパティは，HTTP 要求メッセージの Date ヘッダーの値を示します。

property Date: TDateTime;

説明

Date プロパティを読み出すと，HTTP 要求メッセージが発生した日付と時間がわかります。このプロパティを使うと，要求の Content がまだ有効かどうかがわかります。このプロパティの値は，Web クライアントが設定した時間単位から，Windows のコントロールパネルで指定される地方時間に変換されます。

たとえば，HTTP 要求メッセージの MethodType 指定が mtPost で，Date プロパティが登録中の項目の最近値より古い場合，サーバーアプリケーションは，もっと新しい値に書き換えるのではなく，エラーを示すステータスコードを返します。

Date プロパティは TDateTime 型で表されます。TDateTime の整数部は 1899 年 12 月 30 日からの経過日数で，小数部はその日の経過時間です。


TWebRequest.DerivedFrom
TWebRequest.DerivedFrom3361017

TWebRequest	参照

DerivedFrom プロパティは，HTTP 要求メッセージの Derived-From ヘッダーの値を示します。

property DerivedFrom: string;

説明

DerivedFrom プロパティを読み出すと，Content の値が発生した URI がわかります。このプロパティが意味を持つのは，要求に Content プロパティがあり，かつその Content プロパティが当該 Web クライアントから発生していないときだけです。


TWebRequest.Expires
TWebRequest.Expires3361018

TWebRequest	参照

Expires プロパティは，HTTP 要求メッセージの Expires ヘッダーの値を示します。

property Expires: TDateTime;

説明

Expires プロパティを使うと，要求が「古く無効なもの」かどうかがわかります。このプロパティは，要求が無効になる日付と時間を表しています。このプロパティの値は，Web クライアントが設定した時間の単位から，Windows のコントロールで示されるような地方時間に変換されます。

要求に max-age 疑似命令付きの CacheControl がある場合，この max-age 疑似命令で Expires プロパティの値がオーバーライドされます。

Expires プロパティは TDateTime 型で表されます。TDateTime の整数部は 1899 年 12 月 30 日からの経過日数で，小数部はその日の経過時間です。


TWebRequest.From
TWebRequest.From3361019

TWebRequest	参照

From プロパティは，HTTP 要求メッセージの From ヘッダーの値を示します。

property From: string;

説明

From プロパティを読み出すと，Web クライアントから HTTP 要求メッセージを送った人のインターネット e-mail アドレスがわかります。このプロパティの値は，ロギング用に使ったり，あるいは問題が発生した場合に要求の発信者と連絡するために使ったりできます。


TWebRequest.Host
TWebRequest.Host3361020

TWebRequest	参照

Host プロパティは，HTTP 要求メッセージの Host ヘッダーの値を示します。

property Host: string;

説明

Host プロパティを読み出すと，要求されたリソースのインターネット上のホストとポート番号がわかります。たとえば，クライアントの要求が次の URL を指定しているとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

Host プロパティの値は次のものになります。

www.TSite.com

Host プロパティの値を使えば，内部的にあいまいな URL を区別できます。たとえば，1 つの IP アドレスに複数のホスト名があるサーバーのルート（/）URL などを区別できます。


TWebRequest.IfModifiedSince
TWebRequest.IfModifiedSince3361021

TWebRequest	参照

IfModifiedSince プロパティは，HTTP 要求メッセージの If-Modified-Since ヘッダーの値を示します。

property IfModifiedSince: TDateTime;

説明

HTTPMethod が mtGet である要求の IfModifiedSince プロパティを読み出すと，その要求が条件付き要求かどうかがわかります。Web クライアントが要求した情報が IfModifiedSince プロパティによって指定された時間以降，変更されていない場合，応答メッセージは，URL プロパティによって示される情報ではなく，変更なしエラーとなるはずです。

IfModifiedSince プロパティの値は，Web クライアントのクロックではなく，Windows コントロールパネル内に示されたローカルクロックによって指定されます。

Modified プロパティは TDateTime 型で表されます。TDateTime の整数部は 1899 年 12 月 30 日からの経過日数で，小数部はその日の経過時間を示します。


TWebRequest.Method
TWebRequest.Method3361022

TWebRequest	参照

Method プロパティは，HTTP 要求メッセージの Method ヘッダーの値を示します。

property Method: string;

説明

Method プロパティを読み出すと，Web クライアントが要求したメソッドがわかります。HTTP 1.1 規格では，以下の値を定義しています。

値	意味

OPTIONS	利用できる通信オプションに関する情報を求める

GET	URL プロパティによって示される情報を求める

HEAD	HTTP 応答のプロパティ情報（応答の内容以外）を求める

POST	サーバーアプリケーションに，Content プロパティ内のデータを登録するよう求める

PUT	サーバーアプリケーションに，URL プロパティが示すリソースを Content プロパティ内のデータで置き換えるよう求める

DELETE	サーバーアプリケーションに，URL プロパティが示すリソースを削除または隠すよう求める

TRACE	要求が受け取られたかどうかを確認するために，サーバーアプリケーションにループバックを返信するよう求める

Method プロパティは，Web クライアントがサーバーに要求した他のメソッドを示すことがあります。このプロパティが TWebRequest オブジェクトの Allow プロパティと一致しない場合，その要求は処理できません。

MethodType プロパティは，Method プロパティの値が Get，Head，POST，PUT，あるいは他の文字列のいずれかであることを示します。できる限り，Method プロパティではなく MethodType プロパティを使って，文字列比較の負荷を減らしてください。

注意

HTTP アプリケーションは，メソッドのすべての種類に対処できる必要はありません。ただし，Get メソッドと HEAD メソッドの要求には応答しなければなりません。


TWebRequest.MethodType
TWebRequest.MethodType3361023

TWebRequest	参照

MethodType プロパティは，Web クライアントによって要求されたメソッドを示します。

TMethodType = (mtAny, mtGet, mtPut, mtPost, mtHead);

property MethodType: TMethodType;

説明

MethodType を読み出すと，Web クライアントによって要求された応答のタイプがわかります。このプロパティの値は，以下のいずれかです。

値	意味

mtGet	URL プロパティによって示される情報を求める

mtHead	HTTP 応答のプロパティに関する情報（応答の内容以外）を求める

mtPost	サーバーアプリケーションに，適宜 Content プロパティ内のデータを登録するよう求める

mtPut	サーバーアプリケーションに，URL プロパティで識別されるリソースを Content の値で置き換えるよう求める

mtAny	その他のタイプ

MethodType プロパティが mtAny の場合，Method プロパティを読み出すと，Web クライアントが要求したメソッドがわかります。


TWebRequest.PathInfo
TWebRequest.PathInfo3361024

TWebRequest	参照

PathInfo プロパティは，HTTP 要求メッセージン内に指定された URL のパス情報（存在する場合）の値を示します。

property PathInfo: string;

説明

PathInfo プロパティを読み出すと，要求のターゲットが存在するサーバーマシン上のパスがわかります。たとえば，次の URL があるとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

/gallery.dll が Web サーバーアプリケーションとすると，PathInfo は次のようになります。

/mammals

TWebDispatcher オブジェクトは，PathInfo を使って，要求メッセージを処理する適切な TWebActionItem を決定します。


TWebRequest.PathTranslated
TWebRequest.PathTranslated3361025

TWebRequest	参照

PathTranslated プロパティは，PathInfo プロパティの値をフルパスに変換した値です。

property PathTranslated: string;

説明

PathTranslated を使って，HTTP 応答メッセージ内で要求ターゲットの場所を参照します。


TWebRequest.ProtocolVersion
TWebRequest.ProtocolVersion3361026

TWebRequest	参照

ProtocolVersion プロパティは，HTTP 要求メッセージの開始ヘッダー内に指定された HTTP プロトコルのバージョン番号です。

property ProtocolVersion: string;

説明

ProtocolVersion プロパティを使うと，Web クライアントが HTTP 要求メッセージを作成するときに使用するプロトコルがわかります。

HTTP 要求メッセージのプロパティには，ProtocolVersion プロパティの値によって解釈が異なるものがあります。たとえば，ProtocolVersion が 1.0 の場合，Connection プロパティが close オプションでなくても，接続は一時的とみなされます。


TWebRequest.Query
TWebRequest.Query3361027

TWebRequest	参照

Query プロパティは，HTTP 要求メッセージ内に指定された URL の問い合わせ情報（存在する場合）の値を示します。

property Query: string;

説明

Query プロパティを読み出すと，要求メッセージの URL 内に指定された問い合わせの詳細な内容がわかります。たとえば，次の URL があるとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

/gallery.dll が Web サーバーアプリケーションとすると，Query は次のようになります。

animal=dog&color=black

Query プロパティは，URL の分解前の問い合わせ部分です。問い合わせには複数の項目があり，アンド記号（&）で区切られます。QueryFields プロパティを使うと，項目単位で問い合わせを処理できます。


TWebRequest.QueryFields
TWebRequest.QueryFields3361028

TWebRequest	参照

QueryFields プロパティは，HTTP 要求メッセージの URL 内にある Query の分解後の内容です。

property QueryFields: TStrings;

説明

QueryFields プロパティを使うと，Web クライアント要求で指定された個々の問い合わせ値を操作できます。Query プロパティは，アンド記号（&）が現れたところでさらに小さい文字列に分離するという方法で，独立した複数の項目に分解されます。

各問い合わせ項目は，フォーム Name=Value の QueryFields リストに独立した文字列として入ります。TStrings オブジェクトと同様に，QueryFields プロパティを使えば，アプリケーションは名前や値によって個々の項目を操作できます。


TWebRequest.Referer
TWebRequest.Referer3361029

TWebRequest	参照

Referer プロパティは，HTTP 要求メッセージの Referer ヘッダーの値です。

property Referer: string;

説明

Referer プロパティを読み出すと，HTTP 要求メッセージが発生したリソースの URI がわかります。このプロパティを使ってサーバーアプリケーションは，要求ソースへのバックリンクを作成できます。このプロパティが URI の一部である場合，これは URL プロパティへの相対パスとみなさないといけません。

HTTP 要求メッセージの URL が，ユーザーキーボードからの入力のように自分の URI を持っていないソースから取得したものであるとき，Referer プロパティは設定されません。


TWebRequest.RemoteAddr
TWebRequest.RemoteAddr3361030

TWebRequest	参照

RemoteAddr プロパティは，HTTP 要求メッセージを送ったクライアントのリモート IP アドレスです。

property RemoteAddr: string;

説明

RemoteAddr プロパティを読み出すと，クライアント要求が発生したソースの IP アドレスを取得できます。


TWebRequest.RemoteHost
TWebRequest.RemoteHost3361031

TWebRequest	参照

RemoteHost プロパティは，HTTP 要求メッセージを送ったクライアントの逆ドメイン参照（フルパス）を示します。

property RemoteHost: string;

説明

Referer プロパティが指定されていない場合，RemoteHost プロパティを使うと，要求ソースへのバックリンクを示す URI 値を作成できます。このプロパティにはパス情報が含まれていません。


TWebRequest.ScriptName
TWebRequest.ScriptName3361032

TWebRequest	参照

ScriptName プロパティは，HTTP 要求メッセージ内に指定された URL のスクリプト情報（存在する場合）です。

property ScriptName: string;

説明

ScriptName プロパティを読み出すと，要求メッセージによって指定された Web サーバーアプリケーションへのフルパスがわかります。たとえば，次の URL があるとします。

http://www.TSite.com/art/gallery.dll/mammals?animal=dog&color=black

/gallery.dll が Web サーバーアプリケーションとすると，ScriptName は次のようになります。

/art/gallery


TWebRequest.ServerPort
TWebRequest.ServerPort3361033

TWebRequest	参照

ServerPort プロパティは，Web サーバー上で HTTP 要求メッセージを受け取るポートのポート番号です。

property ServerPort: Integer;

説明

ServerPort プロパティを読み出すと，Web サーバーの接続に使用されたポートの番号がわかります。ServerPort が URL の一部として指定された場合，Host プロパティは ServerPost を含みます。


TWebRequest.Title
TWebRequest.Title3361034

TWebRequest	参照

Title プロパティは，HTTP 要求メッセージの Title ヘッダーの値を示します。

property Title: string;

説明

Title プロパティを読み出すと，要求内で要求された情報のタイトルがわかります。


TWebRequest.URL
TWebRequest.URL3361035

TWebRequest	参照

URL プロパティは，要求のターゲットを示すために HTTP 要求メッセージが指定した Uniform Resource Identifier（URI）です。

property URL: string;

説明

URL プロパティを使うと，要求メッセージのターゲットとして Web クライアントが指定したリソースがわかります。URL は，返すべき HTML ページ，作成または削除するリソース，または Web クライアントに他のサービスを提供するオブジェクトです。

TWebRequest オブジェクトは，URL を各構成要素に分解して，Host，ScriptName，PathInfo，および Query の各プロパティを生成します。

注意

通常，URL プロパティは，ホスト，スクリプト，パス，および問い合わせに分解できる Uniform Resource Locator（URL）です。しかし，HTTP 要求メッセージでは，Uniform Resource Identifier（URI）のように一般的な用語でターゲットを指定することもできます。


TWebRequest.UserAgent
TWebRequest.UserAgent3361036

TWebRequest	参照

UserAgent プロパティは，HTTP 要求メッセージの User-Agent ヘッダーの値を示します。

property UserAgent: string;

説明

UserAgent プロパティを読み出すと，クライアント要求を発生したユーザーエージェントに関する情報を取得できます。この情報は，統計目的やプロトコル違反の検出に使ったり，クライアントアプリケーションの知られている制限に合わせて応答メッセージを変えるために使います。UserAgent 文字列には 1 つまたは複数の記述子が含まれ，重要度の順番に並んでいます。各記述子は，要求を発した製品やアプリケーションの名前，あるいはユーザーエージェントに関する注釈を表しています。


TWebRequest メソッド3361037

TWebRequest	アルファベット順	凡例

TWebRequest

Create

Destroy

ExtractContentFields

ExtractCookieFields

ExtractFields

ExtractQueryFields

GetDateVariable

GetFieldByName

GetIntegerVariable

GetStringVariable

ReadClient

ReadString

TranslateURI

WriteClient

WriteString

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TWebRequest メソッド3361038

TWebRequest	オブジェクト順	凡例

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

ExtractContentFields

ExtractCookieFields

ExtractFields

ExtractQueryFields

FieldAddress

Free

FreeInstance

GetDateVariable

GetFieldByName

GetIntegerVariable

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetStringVariable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadClient

ReadString

SafeCallException

TranslateURI

WriteClient

WriteString


TWebRequest.Create
TWebRequest.Create3361039

TWebRequest	参照

Create メソッドは，TWebRequest のインスタンスを作成します。

constructor Create;

説明

要求オブジェクトをインスタンス化するために，アプリケーションで Create メソッドを呼び出す必要はありません。TWebApplication オブジェクトは，クライアント要求を受け取るたびに TWebRequest オブジェクトを作成します。


TWebRequest.Destroy
TWebRequest.Destroy3361040

TWebRequest	参照

Destroy メソッドは，TWebRequest のインスタンスを破棄します。

destructor Destroy; override;

説明

直接 Destroy メソッドを呼び出さないでください。要求メッセージの処理が完全に終わると，TWebApplication は Free メソッドを呼び出して要求ブジェクトを破棄します。Free メソッドは要求ブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy メソッドは，ContentFields，CookieFields，および QueryFields の各プロパティを表す TStrings オブジェクトを解放します。


TWebRequest.ExtractContentFields
TWebRequest.ExtractContentFields3361041

TWebRequest	参照

ExtractContentFields メソッドは，Content プロパティを各構成要素に分解します。

procedure ExtractContentFields(Strings: TStrings);

説明

ExtractContentFields メソッドを呼び出すと，Content プロパティ内の各項目を Strings パラメータに設定できます。このメソッドは，各項目がアンド記号（&）で分離されているものとみなしています。この形式は，MethodType プロパティが mtPost のときに使用される形式です。Content プロパティに何も設定されていない場合，ExtractContentFields メソッドは処理を行いません。


TWebRequest.ExtractCookieFields
TWebRequest.ExtractCookieFields3361042

TWebRequest	参照

ExtractCookieFields メソッドは，Cookie プロパティを各構成要素に分解します。

procedure ExtractCookieFields(Strings: TStrings);

説明

ExtractCookieFields メソッドを呼び出すと，Cookie プロパティ内の各項目を Strings パラメータに設定できます。このメソッドは，各項目がセミコロン（:）で分離されているものとみなしています。Cookie プロパティに何も設定されていない場合，ExtractCookieFields メソッドは処理を行いません。


TWebRequest.ExtractFields
TWebRequest.ExtractFields3361043

TWebRequest	参照

ExtractFields メソッドは，複数の値からなる文字列を各構成要素に分解します。

TCharSet = set of Char;

procedure ExtractFields(Separators, WhiteSpace: TCharSet; Content: PChar; Strings: TStrings);

説明

ExtractFields メソッドを呼び出すと，複数の値からなる HTTP ヘッダーが分解されて値ごとに独立した文字列になります。たとえば，UserAgent プロパティのセパレータ文字が既知の場合，このメソッドは UserAgent プロパティを独立した複数の UserAgent 値に分解できます。

Separators パラメータは，複数の値からなる文字列の個々の値を分離するために使う文字の集合です。WhiteSpace パラメータは，文字列を分解するときに無視される文字の集合です。Content パラメータは，分解の対象となる，複数の値からなる文字列です。Strings パラメータは，Content パラメータから分解された個々の値が入る TStrings オブジェクトです。


TWebRequest.ExtractQueryFields
TWebRequest.ExtractQueryFields3361044

TWebRequest	参照

ExtractQueryFields メソッドは，Query プロパティを各構成要素に分解します。

procedure ExtractQueryFields(Strings: TStrings);

説明

ExtractQueryFields メソッドを呼び出すと，Query プロパティ内の個々の値を Strings パラメータに設定できます。このメソッドは，各項目がアンド記号（&）で分離されているものとみなしています。Qyery プロパティに何も設定されていない場合，ExtractQueryFields メソッドは処理を行いません。


TWebRequest.GetDateVariable
TWebRequest.GetDateVariable3361045

TWebRequest	参照

GetDateVariable メソッドは，HTTP ヘッダー変数のインデックステープルから日付値を抽出するメソッドの抽象プロトタイプです。

function GetDateVariable(Index: Integer): TDateTime; virtual; abstract;

説明

TWebRequest の下位オブジェクトは GetDateVariable メソッドを実現して，HTTP 要求メッセージのヘッダー文字列から日時値を読み出す方法を提供します。要求ブジェクトは，GetDateVariable メソッドを使って，HTTP 要求ヘッダー内の日付を表すプロパティにアクセスします。


TWebRequest.GetFieldByName
TWebRequest.GetFieldByName3361046

TWebRequest	参照

GetFieldByName メソッドは，Name パラメータによって指定された HTTP ヘッダー変数の値を返すメソッドの抽象プロトタイプです。

function GetFieldByName(const Name: string): string; virtual; abstract;

説明

TWebRequest の下位オブジェクトは GetFieldByName メソッドを実現して，HTTP 要求メッセージ内の任意のヘッダー項目にアクセスする方法を提供します。GetFieldByName メソッドを使うと，TWebRequest のプロパティとして明示されていない HTTP ヘッダー変数の値を読み出すことができます。HTTP 要求ヘッダー変数についての詳細は，現在のインターネット規格を参照してください。


TWebRequest.GetIntegerVariable
TWebRequest.GetIntegerVariable3361047

TWebRequest	参照

GetIntegerVariable メソッドは，HTTP ヘッダー変数のインデックステーブルから整数値を抽出するメソッドの抽象プロトタイプです。

function GetIntegerVariable(Index: Integer): Integer; virtual; abstract;

説明

TWebRequest の下位オブジェクトは GetIntegerVariable メソッドを実現して，HTTP 要求メッセージのヘッダー文字列から整数値を読み出す方法を提供します。要求ブジェクトは，GetIntegerVariable メソッドを使って，HTTP 要求ヘッダー内の整数を表すプロパティにアクセスします。


TWebRequest.GetStringVariable
TWebRequest.GetStringVariable3361048

TWebRequest	参照

GetStringVariable メソッドは，HTTP ヘッダー変数のインデックステーブルから文字列値を抽出するメソッドの抽象プロトタイプです。

function GetStringVariable(Index: Integer): string; virtual; abstract;

説明

TWebRequest の下位オブジェクトは GetStringVariable メソッドを実現して，HTTP 要求メッセージのヘッダー文字列から文字列値を読み出す方法を提供します。要求ブジェクトは，GetStringVariable メソッドを使って，HTTP 要求ヘッダー内の文字列を表すプロパティにアクセスします。


TWebRequest.ReadClient
TWebRequest.ReadClient3361049

TWebRequest	参照

ReadClient メソッドは，HTTP 要求から Count バイトのデータを Buffer に読み出すメソッドの抽象プロトタイプです。

function ReadClient(var Buffer; Count: Integer): Integer; virtual; abstract;

説明

TWebRequest の下位オブジェクトは ReadClient メソッドを実現します。このメソッドは，HTTP 要求からメッセージの内容を読み出すために使います。要求メッセージの内容が Content プロパティで読み出すには大きすぎる場合，ReadClient メソッドを使うと，小分けにした次の情報を取得できます。ReadClient メソッドは，実際に読み出したデータのバイト数を返します。


TWebRequest.ReadString
TWebRequest.ReadString3361050

TWebRequest	参照

ReadString メソッドは，HTTP 要求メッセージから Count バイトのデータを文字列に読み出すメソッドの抽象プロトタイプです。

function ReadString(Count: Integer): string; virtual; abstract;

説明

TWebRequest の下位オブジェクトは ReadString メソッドを実現します。このメソッドは，HTTP 要求からメッセージの内容を文字列にロードするために使います。要求メッセージの内容が Content プロパティで読み出すには大きすぎる場合，ReadString メソッドを使うと，小分けにした次の情報を取得できます。


TWebRequest.TranslateURI
TWebRequest.TranslateURI3361051

TWebRequest	参照

TranslateURI メソッドは，Uniform Resource Identifier（URI）をサーバー上の場所の内部表現に変換するメソッドの抽象プロトタイプです。

function TranslateURI(const URI: string): string; virtual; abstract;

説明

TWebRequest の下位オブジェクトは TranslateURI メソッドを実現します。このメソッドは，クライアント要求で指定された URI を，サーバーアプリケーションで使用できる形式に変換するために使います。内部形式は，サーバーアプリケーションが ISAPI アプリケーションであるか NSAPI アプリケーションであるかによって変わります。TranslateURI メソッドは CGI アプリケーションには対応しません。


TWebRequest.WriteClient
TWebRequest.WriteClient3361052

TWebRequest	参照

WriteClient メソッドは Count バイトのデータを Buffer から元の HTTP クライアントに書き込むメソッドの抽象プロトタイプです。

function WriteClient(var Buffer; Count: Integer): Integer; virtual; abstract;

説明

TWebRequest の下位オブジェクトは WriteClient メソッドを実現します。このメソッドは，TWebResponse が応答の内容を Web クライアントに送るときに使います。


TWebRequest.WriteString
TWebRequest.WriteString3361053

TWebRequest	参照

WriteString メソッドは，元の HTTP クライアントに文字列 AString を書き込むメソッドの抽象プロトタイプです。

function WriteString(const AString: string): Boolean; virtual; abstract;

説明

TWebRequest の下位オブジェクトは WriteStirng メソッドを実現します。このメソッドは，TWebResponse が応答の内容を Web クライアントに送るときに使います。


読み出し／書き込み3361054

読み出し専用


スコープ3361055

protected


継承3361056

TObject


TWebRequest 例3361057

TWebRequest


TWebResponse
TWebResponse3362001

継承	プロパティ	メソッド	参照

TWebResponse コンポーネントは，HTTP 要求メッセージに対して返される HTTP 応答メッセージを表すすべてのオブジェクトの抽象基本クラスです。

ユニット

httpapp

説明

TWebResponse の下位オブジェクトを使うと，HTTP 要求メッセージに対する応答を指定できます。

Web アプリケーションは，入力された HTTP 要求メッセージを表す TWebRequest オブジェクトを基に TWebResponse オブジェクトを作成します。次いで，アプリケーションの TWebDispatcher は，TWebRequest オブジェクトを送った TWebActionItem にこの TWebResponse オブジェクトを渡して，応答メッセージを作成できるようにします。

TWebResponse には 3 つの下位オブジェクトがあり，それぞれ異なるタイプの Web サーバーアプリケーション内で HTTP 応答メッセージを表します。

・	サーバーDLL 内の TISAPIResponse オブジェクト

・	CGI サーバーアプリケーション内の TCGIResponse オブジェクト

・	Windows ベース CGI サーバー内の TWinCGIResponse オブジェクト


TWebResponse プロパティ3362002

TWebResponse	アルファベット順	凡例

TWebResponse

Allow

Content

ContentEncoding

ContentLength

ContentStream

ContentType

ContentVersion

Cookies

CustomHeaders

Date

DerivedFrom

Expires

HTTPRequest

LastModified

Location

LogMessage

Realm

ReasonString

Server

StatusCode

Title

Version

WWWAuthenticate


TWebResponse プロパティ3362003

TWebResponse	オブジェクト順	凡例

Allow

Content

ContentEncoding

ContentLength

ContentStream

ContentType

ContentVersion

Cookies

CustomHeaders

Date

DerivedFrom

Expires

HTTPRequest

LastModified

Location

LogMessage

Realm

ReasonString

Server

StatusCode

Title

Version

WWWAuthenticate


TWebResponse.Allow
TWebResponse.Allow3362004

TWebResponse	参照

Allow プロパティは，TWebResponse オブジェクトが対応できる HTTP 要求メソッドのリストです。

property Allow: string;

説明

Allow プロパティを使うと，HTTPRequest プロパティに指定された URL に対してサーバーアプリケーションがどのようなタイプの要求メソッドに応答できるかを指定できます。このプロパティは，カンマで区切られたメソッド名からなる文字列です。これらのメソッド名には，HTTP 規格の定義済みメソッドまたはサーバーアプリケーション作成の追加メソッドをすべて含めることができます。最低，TWebResponse オブジェクトは，GET 要求と HEAD 要求に対応できなければなりません。


TWebResponse.Content
TWebResponse.Content3362005

TWebResponse	参照

Content プロパティは，HTTP 要求メッセージに対する応答として Web クライアントに返される情報です。

property Content: string;

説明

Content プロパティを使うと，要求された情報を Web クライアントに送信できます。すべての HTTP 要求メッセージに対して情報を返す必要はありません。たとえば，OPTIONS，HEAD，POST，PUT，DELETE，または TRACE のメソッドを持った要求に対する応答メッセージには，Content を含めてはいけません。これらの場合にはいずれも，応答情報は完全に応答ヘッダーに含まれ，このヘッダーは TWebResponse オブジェクトが持つ Content 以外のプロパティから作成されます。

応答内容は，HTML コマンドの文字列，HTML ファイル名，ビットストリームなどのグラフィックコンテンツ，または他の MIME コンテンツです。

注意

ContentStream プロパティ が設定されている場合，それが Content プロパティの値に取って代わります。Content と ContentStream の両方が設定されている場合，Web クライアントは，Content プロパティの値ではなく，ContentStream の値を受け取ります。


TWebResponse.ContentEncoding
TWebResponse.ContentEncoding3362006

TWebResponse	参照

ContentEncoding プロパティは，HTTP 応答メッセージの内容をコード化するためのメカニズム（存在する場合）をリストに表示します。

property ContentEncoding: string;

説明

ContentEncoding プロパティは，Content プロパティの値を Web クライアントに送る前にコード化したときに設定します。コード化メカニズムは，適用される順序でリストに表示され，カンマで区切られます。一般に，このプロパティは，ネット上で拡張 ASCII 文字を転送するのに使われる圧縮方式またはコード化方式を表します。


TWebResponse.ContentLength
TWebResponse.ContentLength3362007

TWebResponse	参照

ContentLength プロパティは，Content プロパティの長さ（バイト単位）です。

property ContentLength: Integer;

説明

ContentLength プロパティには，Content プロパティの長さがわかっている場合，その値を設定します。わかっていない場合，または HTTP 応答メッセージにまったく内容がない場合は，0 を設定します。Web クライアントは，ContentLength プロパティを使って，HTTP 応答メッセージの内容を読み出します。

応答メッセージの内容をストリームから得る場合は，ContentLength プロパティの値はそのストリームから設定されます。


TWebResponse.ContentStream
TWebResponse.ContentStream3362008

TWebResponse	参照

ContentStream プロパティは，HTTP 応答メッセージの内容を Web クライアントに書き込むときに使用できるストリームオブジェクトです。

property ContentStream: TStream;

説明

ContentStream プロパティを使うと，ストリームから書き込める値を HTTP 応答メッセージの内容に設定できます。このプロパティによって応答オブジェクトは，その内容を直接ストリームから書き込むことができます。

ContentStream プロパティによって指定されたストリームは，HTML コマンドの文字列，BLOB データベース項目の内容，または任意の MIME コンテンツタイプにアクセスできます。

注意

ContentStream プロパティは，Content プロパティよりも優先します。両方のプロパティが設定されている場合，Web クライアントには，Content プロパティの値ではなく ContentStream プロパティの値が送られます。


TWebResponse.ContentType
TWebResponse.ContentType3362009

TWebResponse	参照

ContentType プロパティは，コンテントのメディアタイプの値です。

property ContentType: string;

説明

ContentType プロパティを設定すると，HTTP 応答メッセージの Content のメディアタイプを指定できます。このプロパティの値には，有効な MIME コンテンツタイプを指定しなくてはなりません。ContentType 文字列の形式は Type/SubType です。

たとえば，GET 要求に対する HTTP 応答メッセージとして HTML コマンドからなる文字列を Web クライアントに返す場合，ContentType は text/html になります。

注意

HTTP 要求メッセージに Accept ヘッダーが含まれている場合，ContentType プロパティは，TWebRequest.Accept プロパティに一覧表示されたコンテンツタイプのいずれかでなければなりません。


TWebResponse.ContentVersion
TWebResponse.ContentVersion3362010

TWebResponse	参照

ContentVersion プロパティは，HTTP 応答メッセージの Content に関連付けられたバージョンを示す文字列です。

property ContentVersion: string;

説明

ContentVersion プロパティを使うと，HTTP 応答の Content に関連付けられたバージョンを指定できます。このプロパティの意味は，HTTP 応答として送る情報の種類によって変わります。たとえば，HTTP 応答の Content に text/html という ContentType が含まれている場合，ContentVersion プロパティの値は使用される HTML のバージョンになるはずです。

ContentVersion プロパティの意味を規定するサーバーアプリケーションは，その意味を明確に記述しておかなければなりません。


TWebResponse.Cookies
TWebResponse.Cookies3362011

TWebResponse	参照

Cookies プロパティは，応答で送信される cookie ヘッダーのコレクションです。

Cookies is a collection of all cookie headers that should be sent with the response.

property Cookies: TCookieCollection;

説明

Cookies プロパティは，応答メッセージ内の cookie ヘッダーのフィールドを示す TCookie オブジェクトに直接アクセスします。TCookie オブジェクトは応答メッセージに含まれる cookie ヘッダーに表示されます。

SetCookieField メソッドを呼び出すと，cookie ヘッダーをコレクションに追加できます。SetCookieField メソッドは，domain，path，expires および secure フィールドの情報を持った，新しい TCookie を作成/追加します。Cookies 内の個々のエントリの headerValue プロパティは，実際に各 cookie ヘッダー用に送信される文字を示します。

Cookies プロパティは，cookie ヘッダーの情報を取得します。たとえば，次のコードは，任意の cookie が cookie の送信時に secure リンクを使用するよう，Web クライアントに対して指示するかどうかをチェックします。AnySecure を True に設定しています。

AnySecure := False;

with Cookies do

   for I := 0 to Count-1 do

     if Items[I].Secure = True then

     begin

           AnySecure := True;

           break;

     end;

cookie の詳細については，Netscapeの文書を参照してください。


TWebResponse.CustomHeaders
TWebResponse.CustomHeaders3362012

TWebResponse	参照

CustomHeaders プロパティはメッセージヘッダー文字列のセットで，送信される前に応答メッセージに追加されます。

property CustomHeaders: TStrings;

説明

CustomHeaders を使うと，TWebResponse の他のプロパティで指定することができない応答にヘッダー情報を追加できます。CustomHeaders プロパティの各文字列は HeaderName=Value の形式を持っており，HeaderName はヘッダーの名前を指定し，Value はそのヘッダーの値で文字列の形式になっています。

注意

CustomHeaders プロパティを設定すると，文字列のセットがカスタムヘッダーリストに割り当てられます。CustomHeaders の値である TSrings オブジェクトの置換は行いません。


TWebResponse.Date
TWebResponse.Date3362013

TWebResponse	参照

Date プロパティは，HTTP 応答メッセージを Web クライアントに送る日時です。

property Date: TDateTime;

説明

HTTP 応答メッセージを Web クライアントに送る直前に，Date プロパティに現在の日時を設定します。Web クライアントは，このプロパティを使って，返された情報の新しさを判断します。

Date プロパティは TDateTime 型で表します。TDateTime 値の整数部は 1899 年 12 月 30 日以降の経過日数です。小数部はその日の経過時間（24 時間制）です。


TWebResponse.DerivedFrom
TWebResponse.DerivedFrom3362014

TWebResponse	参照

DerivedFrom プロパティは，HTTP 応答の Content が発生したリソースの URI です。

property DerivedFrom: string;

説明

DerivedFrom プロパティには，Content の値が発生した URI を設定します。この設定が特に重要になるのは，要求オブジェクトの URL プロパティが示すリソースから HTTP 応答の Content が発生しなかったときです。


TWebResponse.Expires
TWebResponse.Expires3362015

TWebResponse	参照

Expires プロパティは，HTTP 応答メッセージの Content についてそれ以降を無効とみなす日時を指定します。

property Expires: TDateTime;

説明

Expires プロパティは，時間が経過すると無効になる可能性がある情報が，HTTP 応答メッセージの Content に含まれているときに設定します。このプロパティを設定しても，設定した日時になったら，必ずメッセージの情報やソースが変わったりなくなったりするわけではありません。Web クライアントは，Expires プロパティが示す日時以降，情報の新しさをチェックするよう警告されるだけです。

Expires プロパティの値は，マシンの地方時間で指定されます。HTTP 応答メッセージは，この値を HTTP が使う日付コードに変換します。

Expires プロパティは TDateTime 型で表します。TDateTime 値の整数部は 1899 年 12 月 30 日以降の経過日数です。小数部はその日の経過時間（24 時間制）です。


TWebResponse.HTTPRequest
TWebResponse.HTTPRequest3362016

TWebResponse	参照

HTTPRequest プロパティは，応答を生成した HTTP 要求メッセージをカプセル化する TWebRequest オブジェクトです。

property HTTPRequest: THTTPRequest;

説明

HTTPRequest プロパティを読み出すと，応答メッセージを生成した HTTP 要求メッセージのヘッダーと内容がわかります。HTTPRequest のプロパティは，Web クライアント要求メッセージ内の情報にアクセスします。


TWebResponse.LastModified
TWebResponse.LastModified3362017

TWebResponse	参照

LastModified プロパティは，Content プロパティの値が最後に更新された日時を示します。

property LastModified: TDateTime;

説明

LastModified プロパティには，HTTP 応答の Content プロパティが最後に変更された時間を設定します。この値によって Web クライアントは，情報のローカルバージョンが最新のものかどうかを知ることができます。HTTP 要求が HEAD メッセージの場合，Web クライアントとサーバーは，転送するとコストがかかりそうな情報をスキップできます。

LastModified プロパティの値は，マシンの地方時間で指定されます。 HTTP 応答メッセージは，この値を HTTP が使う日付コードに変換します。

LastModified プロパティは TDateTime 型で表します。TDateTime 値の整数部は 1899 年 12 月 30 日以降の経過日数です。小数部はその日の経過時間（24 時間制）です。


TWebResponse.Location
TWebResponse.Location3362018

TWebResponse	参照

Location プロパティは，要求を完了するために Web クライアントが指さなくてはならないリソースの URI です。

property Location: string;

説明

Location プロパティは，HTTPResponse が HTTP 要求メッセージに対応する新しいリソースを作成したとき，または応答の処理を HTTP 要求メッセージ内で指定された URI 以外の URI に代行させなくてはならないときに設定します。


TWebResponse.LogMessage
TWebResponse.LogMessage3362019

TWebResponse	参照

LogMessage プロパティは，処理の内容を記述した文字列で，イベントログ用に HTTP 応答メッセージ内に含めるものです。

property LogMessage: string;

説明

LogMessage プロパティには，HTTP 応答処理を行なう TWebActionItem オブジェクトが実行したアクションの内容を設定します。通常，このプロパティには，HTTP 要求メッセージを扱った URI と日時情報が含まれます。


TWebResponse.Realm
TWebResponse.Realm3362020

TWebResponse	参照

Realm プロパティはprotectedアクセス URI 群で，HTTP 要求メッセージによって指定された URI を含みます。

property Realm: string;

説明

Realm プロパティは，HTTP 応答メッセージが 401（不許可）または 402（対価要求）を返したときに設定します。このプロパティは，Web クライアントがパスワードを指定したり，対価を払ったりしないとアクセスできない URI 群の名前です。HTTP 要求メッセージ内の URI を含めて，プロパティ内の URI はすべて，Web クライアントがパスワードを指定したり対価を払ったりすればすぐにアクセスできるようになります。サーバーアプリケーションは，TWebRequest オブジェクトによるクライアント情報を使って，クライアントのパスワードや対価支払いについて内部的に継続して観察していかなくてはなりません。


TWebResponse.ReasonString
TWebResponse.ReasonString3362021

TWebResponse	参照

ReasonString プロパティは，Web クライアントの要求に対する応答のステータスを示すテキスト文字列です。

property ReasonString: string;

説明

ReasonString プロパティを設定すると，HTTP 要求メッセージの成功または失敗を Web クライアントに通知できます。この原因文字列は応答のステータスを示す 3 桁のステータスコードに関連付けられています。HTTP 規格ではあらかじめ，多くのステータスコードと，それに対応する原因文字列を規定しています。これ以外に，サーバーアプリケーションは新しい原因文字列を定義して，未使用のステータスコードに関連付けることができます。


TWebResponse.Server
TWebResponse.Server3362022

TWebResponse	参照

Server プロパティは，要求を処理するためにサーバーアプリケーションが使用するソフトウェアについての情報を提供します。

property Server: string;

説明

Server プロパティには，HTTP 応答メッセージの Content を提供するアプリケーションの名前とバージョン番号からなる文字列を設定します。Server プロパティの値には，複数の製品識別子とコメントを含めることができます。これらの製品識別子とコメントは空白で区切られ，重要度の順に一覧表示されます。製品識別子は ProductName/VersionNumber の形式を取ります。


TWebResponse.StatusCode
TWebResponse.StatusCode3362023

TWebResponse	参照

StatusCode プロパティは 3 桁の整数値で，HTTP 要求メッセージに対する応答のステータスを示します。

property StatusCode: Integer;

説明

StatusCode プロパティを設定すると，HTTP 要求メッセージのステータスを Web クライアントに通知できます。ステータスコードは，Web クライアントなら誰でも理解できる標準的な戻り値です。各ステータスコードには対応する原因文字列があり，これによって Web クライアントはステータスの意味を理解しやすくなります。

以下に，利用できるステータスコードとそれに対応する原因文字列を示します。

StatusCode	ReasonString

100	Continue

101	Switching Protocols

200	OK

201	Created

202	Accepted

203	Non-Authoritative Information

204	Non Content

205	Reset Content

206	Partial Content

300	Multiple Choices

301	Moved Parmanently

302	Moved Temporarily

303	See Other

304	Not Modified

305	Use Proxy

400	Bad Request

401	Unauthorized

402	Payment Required

403	Forbidden

404	Not Found

405	Method Not Allowed

406	Not Acceptable

407	Proxy Authentication Required

408	Request Time-out

409	Conflict

410	Gone

411	Length Required

412	Precondition Failed

413	Request Entity Too Large

414	Request-URI Too Large

415	Unsupported Media Type

500	Internal Server Error

501	Not Implemented

502	Bad Gateway

503	Service Unavailable

504	Gateway Time-out

505	HTTP Version not supported

上記のテーブルにないステータスコードは，サーバーアプリケーションで作成できます。新しいステータスコードを作成するときは，最上位桁に以下の応答クラスを指定しなくてはなりません。

・	1xx: 情報（要求受信済み，処理続行中）

・	2xx: 成功（要求受信済み，了解済み，受け入れ済み）

・	3xx: 転送（要求処理を終了するにはさらに処理が必要）

・	4xx: クライアントエラー（要求に不正な構文があるか，要求のサービスができない）

・	5xx: サーバーエラー（サーバーが有効な要求を処理できなかった）


TWebResponse.Title
TWebResponse.Title3362024

TWebResponse	参照

Title プロパティは HTTP 応答メッセージの Content のタイトルを指定します。

property Title: string;

説明

Title プロパティ を設定すると，HTTP 応答メッセージに Title ヘッダーを追加できます。このプロパティは，応答メッセージに含まれている情報に関連付けられたアプリケーション固有のオプションタイトルです。


TWebResponse.Version
TWebResponse.Version3362025

TWebResponse	参照

Version プロパティは，Web クライアントが使用している HTTP プロトコルのバージョン番号です。

property Version: string;

説明

Version プロパティを読み出すと，Web クライアントは TWebResponse オブジェクトに設定されたプロパティを確実に理解できるようになります。Version プロパティの値は，TWebRequest オブジェクトの ProtocolVersion プロパティから取得されます。

HTTP プロトコルの各種バージョンについては，インターネット規格を参照してください。


TWebResponse.WWWAuthenticate
TWebResponse.WWWAuthenticate3362026

TWebResponse	参照

WWWAuthenticate プロパティは，カンマで区切られた 1 つまたは複数の未処理アクセスからなるリストで，StatusCode 401（不許可）で要求が失敗したときに提供されます。

property WWWAuthenticate: string;

説明

WWWAuthenticate プロパティは，Web クライアントにパスワードが提供されていない realm 内の URI へのアクセスを要求したために HTTP 要求が失敗したときに設定します。このプロパティは，認証方式名と，認証方式にパラメータを与えるためのカンマで区切られたパラメータ/値の組み合せのリストから構成されます。最初のパラメータ/値の組み合せは realm を示します。

HTTP 認証方式についての詳細は，インターネット規格を参照してください。


TWebResponse メソッド3362027

TWebResponse	アルファベット順	凡例

TWebResponse

AddCustomHeaders

Create

Destroy

GetContent

GetCustomHeader

GetDateVariable

GetIntegerVariable

GetLogMessage

GetStatusCode

GetStringVariable

SendRedirect

SendResponse

SendStream

Sent

SetContent

SetContentStream

SetCookieField

SetCustomHeader

SetDateVariable

SetIntegerVariable

SetLogMessage

SetStatusCode

SetStringVariable

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TWebResponse メソッド3362028

TWebResponse	オブジェクト順	凡例

AddCustomHeaders

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetContent

GetCustomHeader

GetDateVariable

GetIntegerVariable

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetLogMessage

GetStatusCode

GetStringVariable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

SendRedirect

SendResponse

SendStream

Sent

SetContent

SetContentStream

SetCookieField

SetCustomHeader

SetDateVariable

SetIntegerVariable

SetLogMessage

SetStatusCode

SetStringVariable


TWebResponse.AddCustomHeaders
TWebResponse.AddCustomHeaders3362029

TWebResponse	参照

AddCustomHeaders メソッドは CustomHeaders プロパティで指定されたカスタムヘッダーを Headers パラメータに追加します。

procedure AddCustomHeaders(var Headers: string);

説明

AddCustomHeaders を呼び出すと，CustomHeaders プロパティで指定されたメッセージヘッダーをメッセージヘッダーの文字列に追加できます。各ヘッダーは，HeaderName: Value という形式で 1 行ごとに追加されます（復帰と改行で区切られます）。


TWebResponse.Create
TWebResponse.Create3362030

TWebResponse	参照

Create メソッドは TWebResponse のインスタンスを作成して，HTTPRequest パラメータに対する応答メッセージを生成します。

constructor Create(HTTPRequest: TWebRequest);

説明

応答オブジェクトをインスタンス化するために，アプリケーションで Create メソッドを呼び出す必要はありません。TWebApplication オブジェクトは，各 TWebRequest に対して TWebResponse を作成します。


TWebResponse.Destroy
TWebResponse.Destroy3362031

TWebResponse	参照

Destroy メソッドは TWebResponse のインスタンスを破棄します。

destructor Destroy; override;

説明

直接 Destroy メソッドを呼び出さないでください。TWebResponse オブジェクトを作成した TWebApplication オブジェクトが Free メソッドを呼び出して TWebResponse オブジェクトを破棄します。Free メソッドは応答オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy メソッドは，HTTP 応答メッセージの内容を書き込むために使われた ContentStream オブジェクトを解放します。


TWebResponse.GetContent
TWebResponse.GetContent3362032

TWebResponse	参照

GetContent メソッドは，Content プロパティにアクセスするメソッドの抽象プロトタイプです。

function GetContent: string; virtual; abstract;

説明

TWebResponse の下位オブジェクトは GetContent メソッドを実現して，Content プロパティを内部的に表現するためのアクセスメソッドを提供します。HTTP アプリケーションのタイプが異なると応答オブジェクトが Content プロパティの値を格納する方法が異なるので，このメソッドは抽象メソッドです。


TWebResponse.GetCustomHeader
TWebResponse.GetCustomHeader3362033

TWebResponse	参照

GetCustomHeader メソッドは，指定した名前のカスタムヘッダーの値を返します。

function GetCustomHeader(const Name: string): String;

説明

GetCustomHeader を呼び出すと，CustomHeaders プロパティで指定されたいずれかのカスタムヘッダーの値を取得できます。Name パラメータは HTTP メッセージヘッダーの名前を指定します。


TWebResponse.GetDateVariable
TWebResponse.GetDateVariable3362034

TWebResponse	参照

GetDateVariable メソッドは，HTTP ヘッダー変数のインデックステープルから日付値を抽出するメソッドの抽象プロトタイプです。

function GetDateVariable(Index: Integer): TDateTime; virtual; abstract;

説明

TWebResponse の下位オブジェクトは GetDateVariable メソッドを実現して，HTTP ヘッダー変数を格納するための内部テーブルから日時値を読み出す方法を提供します。応答オブジェクトは，GetDateVariable メソッドを使って，日付を表すプロパティにアクセスします。


TWebResponse.GetIntegerVariable
TWebResponse.GetIntegerVariable3362035

TWebResponse	参照

GetIntegerVariable メソッドは，HTTP ヘッダー変数のインデックステーブルから整数値を抽出するメソッドの抽象プロトタイプです。

function GetIntegerVariable(Index: Integer): Integer; virtual; abstract;

説明

TWebResponse の下位オブジェクトは GetIntegerVariable メソッドを実現して，HTTP ヘッダー変数を格納するための内部テーブルから整数値を読み出す方法を提供します。応答オブジェクトは，GetIntegerVariable メソッドを使って，整数を表すプロパティにアクセスします。


TWebResponse.GetLogMessage
TWebResponse.GetLogMessage3362036

TWebResponse	参照

GetLogMessage メソッドは，LogMessage プロパティにアクセスするメソッドの抽象プロトタイプです。

function GetLogMessage: string; virtual; abstract;

説明

TWebResponse の下位オブジェクトは GetLogMessage メソッドを実現して，LogMessage プロパティを内部的に表現するためのアクセスメソッドを提供します。HTTP アプリケーションのタイプが異なると応答オブジェクトが LogMessage プロパティの値を格納する方法が異なるので，このメソッドは抽象メソッドです。


TWebResponse.GetStatusCode
TWebResponse.GetStatusCode3362037

TWebResponse	参照

GetStatusCode メソッドは，StatusCode プロパティにアクセスするメソッドの抽象プロトタイプです。

function GetStatusCode: Integer; virtual; abstract;

説明

TWebResponse の下位オブジェクトは GetStatusCode メソッドを実現して，StatusCode プロパティを内部的に表現するためのアクセスメソッドを提供します。HTTP アプリケーションのタイプが異なると応答オブジェクトが StatusCode プロパティの値を格納する方法が異なるので，このメソッドは抽象メソッドです。


TWebResponse.GetStringVariable
TWebResponse.GetStringVariable3362038

TWebResponse	参照

GetStringVariable メソッドは，HTTP ヘッダー変数のインデックステーブルから文字列値を抽出するメソッドの抽象プロトタイプです。

function GetStringVariable(Index: Integer): string; virtual; abstract;

説明

TWebResponse の下位オブジェクトは GetStringVariable メソッドを実現して，HTTP ヘッダー変数を格納するための内部テーブルから文字列値を読み出す方法を提供します。応答オブジェクトは，GetStringVariable メソッドを使って，文字列を表すプロパティにアクセスします。


TWebResponse.SendRedirect
TWebResponse.SendRedirect3362039

TWebResponse	参照

SendRedirect メソッドは，StatusCode が 301（永久移動）で Location が URI の応答を送るメソッドの抽象プロトタイプです。

procedure SendRedirect(const URI: string); virtual; abstract;

説明

SendRedirect を呼び出すと，Web クライアント要求が，その要求の正しいターゲットである URI に転送されます。このメソッドは，StatusCode が 301 で Location が URI に設定されている状態で SendResponse を呼び出した場合とまったく同じように機能します。


TWebResponse.SendResponse
TWebResponse.SendResponse3362040

TWebResponse	参照

SendResponse メソッドは，HTTP 応答メッセージを Web クライアントに送るメソッドの抽象プロトタイプです。

procedure SendResponse; virtual; abstract;

説明

HTTP 応答オブジェクトのプロパティを設定してから SendResponse メソッドを呼び出すと，Web クライアントに送る応答を指定できます。要求を別の URI に転送しなければならないときは，SendRedirect メソッドを呼び出す方が便利です。


TWebResponse.SendStream
TWebResponse.SendStream3362041

TWebResponse	参照

SendStream メソッドは，AStream の内容を設定した HTTP 応答メッセージを送るメソッドの抽象プロトタイプです。

procedure SendStream(AStream: TStream); virtual; abstract;

説明

最初に SendResponse メソッドを呼び出した後にだけ，SendStream メソッドを呼び出してください。SendStream メソッドと違って，SendResponse メソッドは TWebResponse オブジェクトのプロパティを基にして HTTP 応答メッセージのヘッダーを設定します。最初に SendResponse を呼び出して HTTP 応答メッセージのヘッダーを設定したのでない場合は，ContentStream プロパティを AStream に設定して SendResponse を呼び出してください。


TWebResponse.Sent
TWebResponse.Sent3362042

TWebResponse	参照

Sent メソッドは，HTTP 応答メッセージがすでに送られたかどうかを示す論理値を返します。

function Sent: Boolean; virtual;

説明

SendRedirect と SendStream は TWebResponse の抽象メソッドなので，TWebResponse.Sent は常に False を返します。TWebResponse の下位オブジェクトは，HTTP 応答メッセージが送られたかどうかをチェックして True または False を返すために，Sent メソッドをオーバーライドします。

TWebApplication オブジェクトは Sent を読み出して，まだ送られていない応答を Web クライアントに送ります。


TWebResponse.SetContent
TWebResponse.SetContent3362043

TWebResponse	参照

SetContent メソッドは，Content プロパティを設定するメソッドの抽象プロトタイプです。

procedure SetContent(const Value: string); virtual; abstract;

説明

TWebResponse の下位オブジェクトは SetContent メソッドを実現して，Content プロパティを設定する方法を提供します。HTTP アプリケーションのタイプが異なると応答オブジェクトが Content プロパティの値を格納する方法が異なるので，このメソッドは抽象メソッドです。


TWebResponse.SetContentStream
TWebResponse.SetContentStream3362044

TWebResponse	参照

SetContentStream メソッドは ContentStream プロパティに Value パラメータの値を設定します。

procedure SetContentStream(Value: TStream); virtual;

説明

SetContentStream メソッドは ContentStream プロパティの値を解放して，Value パラメータの値に置き換えます。


TWebResponse.SetCookieField
TWebResponse.SetCookieField3362045

TWebResponse	参照

SetCookieField メソッドは，SetCookie の値を，各 cookie 名の状態値を示す文字列で置き換えます。

procedure SetCookieField(Values: TStrings; const ADomain, APath: string; AExpires: TDateTime; ASecure: Boolean);

説明

SetCookieField メソッドを呼び出すと，SetCookie 文字列を作成できます。この文字列は，1 つまたは複数の cookie 名を，Domain，Path，Expires，および cookie の安定性を表す状態変数に関連付けます。

未指定の状態変数は cookie 文字列から削除されます。Domain 変数と Path 変数は，対応するパラメータが空の文字列の場合，未指定とみなされます。Expires は，Expires パラメータが負の値の場合，未指定とみなされます。Secure は，Secure パラメータが False の場合，未指定とみなされます。


TWebResponse.SetCustomHeader
TWebResponse.SetCustomHeader3362046

TWebResponse	参照

SetCustomHeader メソッドは指定されたカスタムヘッダーの値を置き換えます。

procedure SetCustomHeader(const Name, Value: string);

説明

SetCustomHeader を呼び出すと，CustomHeaders プロパティが保守するリストに新しいカスタムヘッダーを追加したり，リスト内の既存のヘッダーのいずれかの値を変更したりできます。SetCustomHeader は，Name パラメータで指定された名前のヘッダーのリスト内の位置を特定します。指定された名前のヘッダーがリスト内にあれば，SetCustomHeader はそのヘッダーの値を Value パラメータとして指定された値と置き換えます。指定の名前のヘッダーがリストになければ，SetCustomHeader は指定された名前と値を持つ新しいヘッダーをリストに追加します。


TWebResponse.SetDateVariable
TWebResponse.SetDateVariable3362047

TWebResponse	参照

SetDateVariable メソッドは，日時値を持つ HTTP ヘッダープロパティを設定するメソッドの抽象プロトタイプです。

procedure SetDateVariable(Index: Integer; const Value: TDateTime); virtual; abstract;

説明

TWebResponse の下位オブジェクトは SetDateVariable メソッドを実現して，HTTP ヘッダー変数を格納するための内部テーブルに日時値を書き込む方法を提供します。応答オブジェクトは，SetDateVariable メソッドを使って，日付を表すプロパティを設定します。


TWebResponse.SetIntegerVariable
TWebResponse.SetIntegerVariable3362048

TWebResponse	参照

SetIntegerVariable メソッドは，整数値を持つ HTTP ヘッダープロパティを設定するメソッドの抽象プロトタイプです。

procedure SetIntegerVariable(Index: Integer; Value: Integer); virtual; abstract;

説明

TWebResponse の下位オブジェクトは SetIntegerVariable メソッドを実現して，HTTP ヘッダー変数を格納するための内部テーブルに整数値を書き込む方法を提供します。応答オブジェクトは，SetIntegerVariable メソッドを使って，整数を表すプロパティを設定します。


TWebResponse.SetLogMessage
TWebResponse.SetLogMessage3362049

TWebResponse	参照

SetLogMessage メソッドは，LogMessage プロパティの値を設定するメソッドの抽象プロトタイプです。

procedure SetLogMessage(const Value: string); virtual; abstract;

説明

TWebResponse の下位オブジェクトは SetLogMessage メソッドを実現して，LogMessage プロパティの内部表現を設定する方法を提供します。HTTP アプリケーションのタイプが異なると応答オブジェクトが LogMessage プロパティの値を格納する方法が異なるので，このメソッドは抽象メソッドです。


TWebResponse.SetStatusCode
TWebResponse.SetStatusCode3362050

TWebResponse	参照

SetStatusCode メソッドは，StatusCode プロパティの値を設定するメソッドの抽象プロトタイプです。

procedure SetStatusCode(Value: Integer); virtual; abstract;

説明

TWebResponse の下位オブジェクトは SetStatusCode メソッドを実現して，StatusCode プロパティの内部表現を設定する方法を提供します。HTTP アプリケーションのタイプが異なると応答オブジェクトが StatusCode プロパティの値を格納する方法が異なるので，このメソッドは抽象メソッドです。


TWebResponse.SetStringVariable
TWebResponse.SetStringVariable3362051

TWebResponse	参照

SetStringVariable メソッドは，文字列値を持つ HTTP ヘッダープロパティを設定するメソッドの抽象プロトタイプです。

procedure SetStringVariable(Index: Integer; const Value: string); virtual; abstract;

説明

TWebResponse の下位オブジェクトは SetStringVariable メソッドを実現して，HTTP ヘッダー変数を格納するための内部テーブルに文字列値を書き込む方法を提供します。応答オブジェクトは，SetStringVariable メソッドを使って，文字列を表すプロパティを設定します。


読み出し／書き込み3362052

読み出し専用


スコープ3362053

protected


継承3362054

TObject


TWebResponse 例3362055

TWebResponse


TRichEdit
TRichEdit3363001

継承	プロパティ	メソッド	イベント	参照

TRichEdit は Windows 書式付きテキスト編集コントロールのラッパーです。

ユニット

comctrls

説明

TRichEdit オブジェクトを使うと，標準的な Windows 書式付きテキスト編集コントロールをフォーム上に配置できます。書式付きテキストコントロールを使うと，フォント属性やパラグラフ属性を備えたテキストを入力できるようになります。

TRichEdit オブジェクトは，書式付きテキストの入力および操作に使うプロパティおよびメソッドを提供します。TRichEdit オブジェクトには，テキストの属性の設定オプションを提供するためのユーザーインターフェースコンポーネントはありません。TRichEdit オブジェクトによる書式付きテキスト編集機能を表示するユーザーインターフェースコンポーネントは，アプリケーション側で実現しなければなりません。

TRichEdit オブジェクトは TCustomRichEdit オブジェクトからの継承プロパティの多くをパブリッシュしますが，新しい動作は導入していません。


TRichEdit プロパティ3363002

TRichEdit	アルファベット順	凡例

TCustomRichEdit からの継承

DefAttributes

DefaultConverter

HideScrollBars

HideSelection

Lines

PageRect

Paragraph

PlainText

SelAttributes

SelLength

SelStart

SelText

TCustomMemo からの継承

Alignment

ScrollBars

WantReturns

WantTabs

WordWrap

TCustomEdit からの継承

BorderStyle

MaxLength

Modified

ReadOnly

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Text

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TRichEdit プロパティ3363003

TRichEdit	オブジェクト順	凡例

Align

Alignment

BorderStyle

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DefAttributes

DefaultConverter

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

HideScrollBars

HideSelection

Hint

ImeMode

ImeName

Left

Lines

MaxLength

Modified

Name

Owner

PageRect

Paragraph

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PlainText

PopupMenu

ReadOnly

ScrollBars

SelAttributes

SelLength

SelStart

SelText

ShowHint

Showing

TabOrder

TabStop

Tag

Text

Top

VCLComObject

Visible

WantReturns

WantTabs

Width

WindowProc

WordWrap


TRichEdit イベント3363004

TRichEdit	アルファベット順	凡例

TCustomRichEdit からの継承

OnProtectChange

OnResizeRequest

OnSaveClipboard

OnSelectionChange

TCustomEdit からの継承

OnChange

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TRichEdit イベント3363005

TRichEdit	オブジェクト順	凡例

OnChange

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnProtectChange

OnResizeRequest

OnSaveClipboard

OnSelectionChange

OnStartDrag


TRichEdit メソッド3363006

TRichEdit	アルファベット順

TCustomRichEdit からの継承

Clear

Create

Destroy

FindText

GetSelTextBuf

Print

RegisterConversionFormat

TCustomEdit からの継承

ClearSelection

CopyToClipboard

CutToClipboard

PasteFromClipboard

SelectAll

SetSelTextBuf

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TRichEdit メソッド3363007

TRichEdit	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

ClearSelection

ClientToScreen

ContainsControl

ControlAtPos

CopyToClipboard

Create

CreateParented

CutToClipboard

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

FindText

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetSelTextBuf

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

PasteFromClipboard

Perform

Print

Realign

Refresh

RegisterConversionFormat

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SelectAll

SendToBack

SetBounds

SetFocus

SetSelTextBuf

SetTextBuf

Show

Update

UpdateControlState


スコープ3363008

published

読み出し／書き込み

読み出し専用


スコープ3363009

published


継承3363010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomEdit

TCustomMemo

TCustomRichEdit


TRichEdit 例3363011

TRichEdit


TResourceStream
TResourceStream3365001

継承	プロパティ	メソッド	参照

TResourceStream は Windows アプリケーションのリソースへのアクセスを提供するメモリストリームです。

ユニット

classes

説明

TResourceStream オブジェクトを使って Windows アプリケーションのリソースを読み出します。TResourceStream の各インスタンスは，メモリバッファにあってアプリケーションからアクセスできる 1 個のリソースの値を保持します。

グローバル化した ReadComponentRes 関数は TResourceStream を使って，アプリケーションが使用するコンパイル済みのリソースにアクセスします。


TResourceStream プロパティ3365002

TResourceStream	アルファベット順	凡例

TcustomMemoryStream からの継承

Memory

Tstream からの継承

Position

Size


TResourceStream プロパティ3365003

TResourceStream	オブジェクト順	凡例

Memory

Position

Size


TResourceStream メソッド3365004

TResourceStream	アルファベット順

TresourceStream

Create

CreateFromID

Destroy

Write

TcustomMemoryStream からの継承

Read

SaveToFile

SaveToStream

Seek

Tstream からの継承

CopyFrom

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TResourceStream メソッド3365005

TResourceStream	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyFrom

Create

CreateFromID

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Read

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

SafeCallException

SaveToFile

SaveToStream

Seek

Write

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes


TResourceStream.Create
TResourceStream.Create3365006

TResourceStream	参照

Create メソッドは，特定のリソースの名前と種類に関連付けられた TResourceStream のインスタンスを作成します。

constructor Create(Instance: THandle; const ResName: string; ResType: PChar);

説明

Create メソッドを呼び出すと，名前で指定されるインスタンスのリソースに対して TResourceStream をインスタンス化できます。Create はリソースデータを検索し，TResourceStream に割り当てた Memory バッファにロードします。

Instance パラメータは，リソースを格納する実行可能ファイルまたは DLL と関連付けられた Windows インスタンスハンドルです。

ResName は，アプリケーションでコンパイルした .RC ファイルのリソースに関連付けられている文字列です。リソースが文字列ではなく整数 ID に関連付けられている場合には，シャープ記号（#）に続けてその整数の文字列表現を指定します。たとえば，整数識別子が 128 のリソースは ResName #128 で識別されます。

ResType はリソースの種類を識別する文字列です。アプリケーションは，アプリケーション固有のリソースを定義して .RC ファイルにある名前で各リソースを識別します。さらに，Windows には定義済みのリソースが数多く用意されています。定義済みの Windows リソースの種類を識別するには，ResType を以下の値に設定します。

ResType	リソースの種類

RT_ACCELERATOR	アクセラレータテーブル

RT_BITMAP	ビットマップ

RT_DIALOG	ダイアログボックス

RT_FONT	フォント

RT_FONTDIR	フォントディレクトリ

RT_MENU	メニュー

RT_RCDATA	アプリケーションで定義されるリソース（そのままのデータ）

RT_STRING	ストリングテーブルエントリ

RT_MESSAGETABLE	メッセージテーブルエントリ

RT_CURSOR	ハードウェア依存のカーソルリソース

RT_GROUP_CURSOR	非ハードウェア依存のカーソルリソース

RT_ICON	ハードウェア依存のアイコンリソース

RT_GROUP_ICON	非ハードウェア依存のアイコンリソース

RT_VERSION	バージョン情報

注意

リソースを指定するには，リソースの名前ではなく ID を使った方が少ないメモリで指定できます。


TResourceStream.CreateFromID
TResourceStream.CreateFromID3365007

TResourceStream	参照

CreateFromID メソッドは，特定のリソースの ID と種類に関連付けられた TResourceStream のインスタンスを作成します。

constructor CreateFromID(Instance: THandle; ResID: Integer; ResType: PChar);

説明

CreateFromID メソッドを呼び出すと，整数 ID で指定されるインスタンスのリソースに対して TResourceStream をインスタンス化できます。Create はリソースデータを検索し，TResourceStream に割り当てた Memory バッファにロードします。

Instance パラメータは，リソースを格納する実行可能ファイルまたは DLL と関連付けられたWindows インスタンスハンドルです。

ResID は，アプリケーションでコンパイルした .RC ファイルのリソースに関連付けられている整数 ID です。リソースが ID 番号ではなく文字列に関連付けられている場合には，Create メソッドを使います。

ResType はリソースの種類を識別する文字列です。アプリケーションは，アプリケーション固有のリソースを定義して .RC ファイルにある名前で識別します。さらに，Windows には定義済みのリソースが数多く用意されています。定義済みの Windows リソースの種類を識別するには，ResType を以下の値に設定します。

ResType	リソースの種類

RT_ACCELERATOR	アクセラレータテーブル

RT_BITMAP	ビットマップ

RT_DIALOG	ダイアログボックス

RT_FONT	フォント

RT_FONTDIR	フォントディレクトリ

RT_MENU	メニュー

RT_RCDATA	アプリケーションで定義されるリソース（そのままのデータ）

RT_STRING	ストリングテーブルエントリ

RT_MESSAGETABLE	メッセージテーブルエントリ

RT_CURSOR	ハードウェア依存のカーソルリソース

RT_GROUP_CURSOR	非ハードウェア依存のカーソルリソース

RT_ICON	ハードウェア依存のアイコンリソース

RT_GROUP_ICON	非ハードウェア依存のアイコンリソース

RT_VERSION	バージョン情報

注意

リソースを指定するには，リソースの名前ではなく ID を使った方が少ないメモリで指定できます。


TResourceStream.Destroy
TResourceStream.Destroy3365008

TResourceStream	参照

Destroy メソッドは，TResourceStream のインスタンスを破棄します。

destructor Destroy; override;

説明

TResourceStream のインスタンスを破棄するには，アプリケーションで直接 Destroy メソッドを呼び出さないで，かわりに Free メソッドを呼び出してください。Free メソッドは TResourceStream オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。

Destroy メソッドは，リソースを格納していたメモリバッファを解放してから継承デストラクタを呼び出します。


TResourceStream.Write
TResourceStream.Write3365009

TResourceStream	参照

Write メソッドは，buffer から Count で指定するバイト数をストリームに書き込み，ストリームの現在位置を Count バイト分だけ進め，書き込んだバイト数を返します。

function Write(const Buffer; Count: Longint): Longint; override;

説明

アプリケーションが TResourceStream を使って実行中のアプリケーションのリソースを書き込むことはできません。アプリケーションが実行中のアプリケーションのリソースを書き込もうとすると，Write メソッドは継承メソッドをオーバーライドして EStreamError 例外を生成します。

TResourceStream オブジェクトが提供する Write メソッド以外のデータ書き込みメソッド（WriteBuffer，WriteComponent）はすべて Write を呼び出して実際に書き込むので，TResourceStream のどのデータ書き込みメソッドを呼び出しても例外が生成されます。


読み出し／書き込み3365010

読み出し専用


継承3365011

TObject

TStream

TCustomMemoryStream


TResourceStream 例3365012

TResourceStream


TSaveDialog
TSaveDialog3366001

継承	プロパティ	メソッド	イベント	参照

TSaveDialog コンポーネントは，ファイルの保存に使う［ファイル名を付けて保存］ダイアログボックスを表示します。

ユニット

dialogs

説明

TSaveDialog はファイル名を選択してファイルを保存するときに使うモード付き Windows ダイアログボックスを表示します。このダイアログを実行時に表示するには，Execute メソッドを呼び出してダイアログをアクティブ化しなければなりません。ユーザーが［保存(S)］をクリックすると，ダイアログが閉じられ，選択したファイル名が FileName プロパティに格納されます。


TSaveDialog プロパティ3366002

TSaveDialog	アルファベット順	凡例

TOpenDialog からの継承

DefaultExt

FileEditStyle

FileName

Files

Filter

FilterIndex

HistoryList

InitialDir

Options

Title

TCommonDialog からの継承

Ctl3D

Handle

HelpContext

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComOBject


TSaveDialog プロパティ3366003

TSaveDialog	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Ctl3D

DefaultExt

DesignInfo

FileEditStyle

FileName

Files

Filter

FilterIndex

Handle

HelpContext

HistoryList

InitialDir

Name

Options

Owner

Tag

Title

VCLComOBject


TSaveDialog イベント3366004

TSaveDialog	アルファベット順	凡例

TOpenDialog からの継承

OnFolderChange

OnSelectionChange

OnTypeChange

TCommonDialog からの継承

OnClose

OnShow


TSaveDialog イベント3366005

TSaveDialog	オブジェクト順	凡例

OnClose

OnFolderChange

OnSelectionChange

OnShow

OnTypeChange


TSaveDialog メソッド3366006

TSaveDialog	アルファベット順	凡例

TSaveDialog

Execute

TOpenDialog からの継承

Create

Destroy

GetStaticRect

TComponent からの継承

DestroyComponents

Destroying

FeeOnRelease

FindComponent

FreeNotification

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TSaveDialog メソッド3366007

TSaveDialog	オブジェクト順	凡例

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Execute

FeeOnRelease

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetStaticRect

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TSaveDialog.Execute
TSaveDialog.Execute3366008

TSaveDialog

Execute メソッドは，［ファイル名を付けて保存］ダイアログボックスを表示します。

function Execute: Boolean; override;

説明

Execute メソッドは［ファイル名を付けて保存］ダイアログを開き，ユーザーがファイル名を選択して［保存(S)］をクリックしたときに True を返します。


スコープ3366009

published

読み出し／書き込み

読み出し専用


スコープ3366010

protected


スコープ3366011

published


継承3366012

TObject

TPersistent

TComponent

TCommonDialog

TOpenDialog


TSaveDialog 例3366013

TSaveDialog


TSavePictureDialog
TSavePictureDialog3367001

継承	プロパティ	メソッド	イベント	参照

TSavePictureDialog はグラフィックファイルを保存するために［ファイル名を付けて保存］ダイアログボックスを表示します。

ユニット

extdlgs

説明

TSavePictureDialog は，ファイル名を選択しグラフィックファイルを保存するためのモード付き Windows ダイアログボックスを表示します。このコンポーネントはプレビュー領域を持っている以外は TSaveDialog と似ています。選択された画像が TPicture で読み出し可能な場合，プレビュー領域が表示されます。サポートされるファイルの種類はビットマップ（.BMP），アイコン（.ICO），Windows メタファイル（.WMF），および Windows 拡張形式メタファイル（.EMF）です。選択した画像ファイルを表示できない場合，「なし」がプレビュー領域に表示されます。


TSavePictureDialog プロパティ3367002

TSavePictureDialog	アルファベット順	凡例

TOpenDialog からの継承

DefaultExt

FileEditStyle

FileName

Files

Filter

FilterIndex

HistoryList

InitialDir

Options

Title

TCommonDialog からの継承

Ctl3D

Handle

HelpContext

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TSavePictureDialog プロパティ3367003

TSavePictureDialog	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Ctl3D

DefaultExt

DesignInfo

FileEditStyle

FileName

Files

Filter

FilterIndex

Handle

HelpContext

HistoryList

InitialDir

Name

Options

Owner

Tag

Title

VCLComObject


TSavePictureDialog イベント3367004

TSavePictureDialog	アルファベット順	凡例

TOpenDialog からの継承

OnFolderChange

OnSelectionChange

OnTypeChange

TCommonDialog からの継承

OnClose

OnShow


TSavePictureDialog イベント3367005

TSavePictureDialog	オブジェクト順	凡例

OnClose

OnFolderChange

OnSelectionChange

OnShow

OnTypeChange


TSavePictureDialog メソッド3367006

TSavePictureDialog	アルファベット順

TSavePictureDialog

Execute

TOpenPictureDialog からの継承

Create

Destroy

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TSavePictureDialog メソッド3367007

TSavePictureDialog	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Execute

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TSavePictureDialog.Execute
TSavePictureDialog.Execute3367008

TSavePictureDialog

Execute メソッドは，［ファイル名を付けて保存］ダイアログボックスを表示します。

function Execute: Boolean; override;

説明

Execute メソッドを呼び出すと［ファイル名を付けて保存］ダイアログボックスを表示し，ユーザーがファイル名を選択して［保存(S)］をクリックした場合に True を返します。


スコープ3367009

published

読み出し／書き込み

読み出し専用


スコープ3367010

published


継承3367011

TObject

TPersistent

TComponent

TCommonDialog

TOpenDialog

TOpenPictureDialog


TSavePictureDialog 例3367012

TSavePictureDialog


TScreen
TScreen3368001

継承	プロパティ	メソッド	イベント	参照

TScreen コンポーネントは，アプリケーションの実行時の画面の状態を表します。

ユニット

forms

説明

TScreen は，次の内容をトラッキングするプロパティを提供します。

・	アプリケーションによってどのようなフォームおよびデータモジュールがインスタンス化されたか

・	アクティブフォーム，およびそのフォーム内でアクティブなコントロール

・	画面のサイズおよび解像度

・	アプリケーションで使えるカーソルおよびフォント

Delphi アプリケーションで使えるようにすでにインスタンス化されている TScreen 型のグローバル変数 Screen があります。Screen を使うと，アプリケーションにおける画面の現在の状態に関する情報を取得できます。


TScreen プロパティ3368002

TScreen	アルファベット順	凡例

TScreen

ActiveControl

ActiveCustomForm

ActiveForm

Cursor

Cursors

CustomFormCount

CustomForms

DataModuleCount

DataModules

DefaultIme

DefaultKbLayout

Fonts

FormCount

Forms

Height

IconFont

Imes

PixelsPerInch

Width

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TScreen プロパティ3368003

TScreen	オブジェクト順	凡例

ActiveControl

ActiveCustomForm

ActiveForm

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Cursor

Cursors

CustomFormCount

CustomForms

DataModuleCount

DataModules

DefaultIme

DefaultKbLayout

DesignInfo

Fonts

FormCount

Forms

Height

IconFont

Imes

Name

Owner

PixelsPerInch

Tag

VCLComObject

Width


TScreen.ActiveControl
TScreen.ActiveControl3368004

TScreen	参照

ActiveControl プロパティは，画面上で現在どのコントロールに入力フォーカスがあるかを示します。

property ActiveControl: TWinControl;

説明

ActiveControl プロパティは，アクティブフォーム内でどのウィンドウコントロールが現在キーボードからの入力を受け取るかを判別するために使われます。

ActiveControl は読み出し専用プロパティです。ActiveControl を変更するには，フォーカスを受け取るコントロールを格納しているフォームの SetFocusedControl メソッドを使ってください。

フォーカスが別のコントロールに移ると，画面は OnActiveControlChange イベントを受け取ります。


TScreen.ActiveCustomForm
TScreen.ActiveCustomForm3368005

TScreen	参照

ActiveCustomForm プロパティは，現在フォーカスを持っている TCustomForm の下位を示します。

property ActiveCustomForm: TCustomForm;

説明

ActiveForm プロパティは，どのフォームまたはプロパティが入力フォーカスを持っているかを判別するために使われます。アクティブなカスタムフォームが TForm の場合，ActiveCustomForm は ActiveForm と同じです。


TScreen.ActiveForm
TScreen.ActiveForm3368006

TScreen	参照

ActiveForm プロパティは，現在どのフォームにフォーカスがあるかを指定します。

property ActiveForm: TForm;

説明

ActiveForm プロパティは，アプリケーション内のどのフォームが入力フォーカスを持っているかを判別するために使われます。アプリケーションが現在非アクティブの場合，ActiveForm はアプリケーションがアクティブになったときにフォーカスを持つフォームです。

ActiveForm は読み出し専用プロパティです。ActiveForm を変更するには，フォーカスを受け取るフォームの SetFocus メソッドを使ってください。非アクティブフォームの SetFocusedControl メソッドを呼び出してそのフォームにフォーカスを設定した場合にも ActiveForm は変わります。

フォーカスが別のフォームに移ると，画面は OnActiveFormChange イベントを受け取ります。


TScreen.Cursor
TScreen.Cursor3368007

TScreen	参照

Cursor プロパティは，マウスカーソルイメージをグローバルに制御します。

property Cursor: TCursor;

説明

Cursor プロパティは，個々のコントロールオブジェクトに関連付けられたカーソルイメージをオーバーライドするために使われます。Cursor が crDefault ならば，個々のオブジェクトによってカーソルイメージが決まります。それ以外の値を指定するとそのアプリケーションに属するすべてのウィンドウでマウスカーソルのイメージが設定されます。画面の Cursor プロパティの設定が crDefault に戻されるまでグローバルなカーソルイメージは有効です。

Screen オブジェクトのカーソルプロパティを指定する場合，たいていは次のコードに示すように通常のカーソル動作に戻れるように try...finally 文を使います。

Screen.Cursor := crHourglass;  { 砂時計カーソルを表示する }

try

  { 時間のかかる動作を実行する }

finally

  Screen.Cursor := crDefault;  { 必ず通常のカーソルに戻る }

end;

Cursor には Cursors プロパティで指定できるすべての値を指定できます。この値は組み込みカーソル値でも，Cursors プロパティに追加したカスタムカーソルでもかまいません。


TScreen.Cursors
TScreen.Cursors3368008

TScreen	参照

Cursors プロパティは，アプリケーションで使えるカーソルの配列です。

property Cursors[Index: Integer]: HCursor;

説明

Cursor プロパティは，アプリケーションまたはアプリケーション内のコントロールで使える特定のカーソルにアクセスするために使われます。TScreen にはカーソル定数シンボルでインデックス付けられた組み込みカーソルが用意されています。組み込みカーソル定数に関連付けられたイメージは Cursors プロパティの設定で変更できます。

以下に Cursors プロパティ配列におけるカーソル定数およびその位置を示します。

定数	値	イメージ	定数	値	イメージ

crDefault	0	ActiveControl による	crHourGlass	-11

crNone	-1	crDrag	-12

crArrow	-2	crNoDrop	-13

crCross	-3	crHSplit	-14

crIBeam	-4	crVSplit	-15

crSize	-5	crMultiDrag	-16

crSizeNESW	-6	crSQLWait	-17

crSizeNS	-7	crNo	-18

crSizeNWSE	-8	crAppStart	-19

crSizeWE	-9	crHelp	-20

crUpArrow	-10	crHandPoint	-21

カスタムカーソルを Cursors プロパティに追加するとアプリケーションまたはそのコントロールで使えます。カスタムカーソルをアプリケーションに追加する手順は以下のとおりです。

1.	リソースエディタを使ってカーソルリソースを作成します。

2.	既存のカーソル定数と矛盾しない値を指定してカーソル定数を宣言します。

3.	Windows API の LoadCursor 関数を使って新しいカーソルへのハンドルを取得します。

4.	新しく宣言されたカーソル定数にインデックス付けされた Cursors プロパティを LoadCursor で取得されたハンドルに設定します。

たとえば，NewCursor という名前でアプリケーションのリソースにカスタムカーソルが追加されたとします。次のコードはこのカーソルを crMyCursor 定数を経由してアプリケーションで使えるようにするとともに，そのアプリケーションに対してグローバルなカーソルとして設定します。

const

  crMyCursor = 5;

procedure TForm1.FormCreate(Sender: TObject);

begin

  Screen.Cursors[crMyCursor] := LoadCursor(HInstance, 'NewCursor');

  Cursor := crMyCursor;

end;

注意

カスタムカーソルを使い終わっても Windows API の DestroyCursor 関数を呼び出さないでください。Delphi が自動的に呼び出します。


TScreen.CustomFormCount
TScreen.CustomFormCount3368009

TScreen	参照

CustomFormCount プロパティは，画面に表示されるフォームまたはプロパティページの数です。

property CustomFormCount: Integer;

説明

CustomFormCount プロパティは，画面に現在表示されているフォームまたはプロパティページの数を特定するために使われます。フォームには CustomForms プロパティによってアクセスできます。CustomFormCount は，アプリケーション内のすべてのフォームまたはプロパティページを反復処理するのに CustomForms とともに使うことができます。


TScreen.CustomForms
TScreen.CustomForms3368010

TScreen	参照

CustomForms プロパティは，現在アプリケーションで表示されているすべてのフォームまたはプロパティページのリストです。

property CustomForms[Index: Integer]: TCustomForm;

説明

CustomForms プロパティは，インデックスを使ってフォームまたはプロパティページにアクセスするために使われます。Index の値は，0（最初のカスタムフォーム）～ CustomFormCount - 1 です。CustomForms は，アプリケーションがすべてのフォームおよびプロパティページを反復処理する必要がある場合に CustomFormCount と一緒に使います。

たとえば， Button1 がクリックされると次のコードは， 画面に表示されているすべてのフォームおよびプロパティページの名前を ListBox1 に追加します。

procedure TForm1.Button1Click(Sender: TObject);

var

  I: Integer;

begin

  for I := 0 to Screen.CustomFormCount-1 do

    ListBox1.Items.Add(Screen.CustomForms[I].Name);

end;


TScreen.DataModuleCount
TScreen.DataModuleCount3368011

TScreen	参照

DataModuleCount プロパティは，現在アプリケーション内でインスタンス化されているすべてのデータモジュールの件数を示します。

property DataModuleCount: Integer;

説明

DataModuleCount プロパティは，DataModules プロパティ内のデータモジュール数を特定するために使われます。DataModuleCount はアプリケーションがすべてのデータモジュールに対して反復処理を行うときに DataModules とともに使います。


TScreen.DataModules
TScreen.DataModules3368012

TScreen	参照

DataModules プロパティは，現在アプリケーション内でインスタンス化されているすべてのデータモジュールのリストです。

property DataModules[Index: Integer]: TDataModule;

説明

DataModules プロパティは，インスタンス化されたデータモジュールにインデックスによってアクセスするために使われます。Index の値は 0（最初のデータモジュール）～ DataModuleCount - 1 です。DataModules はアプリケーションがすべてのデータモジュールに対して反復処理を行うときに DataModuleCount とともに使います。


TScreen.DefaultIme
TScreen.DefaultIme3368013

TScreen	参照

DefaultIme プロパティは，TScreen オブジェクトが作成されるときにアクティブなインプットメソッドエディタ（IME）の名前を示します。

property DefaultIme: string;

説明

アジア語の文字をサポートするアプリケーションでは，DefaultIme を読み出すとアプリケーションがスタートするときにアクティブな IME を指定できます。

IME はアジア語用のフロントエンドプロセッサです。IME はすべてのキー入力をフックして変換ウィンドウでアジア語の文字に変換し，その変換後の文字または文字列を Delphi アプリケーションに送ります。1 台のコンピューターに複数の IME をインストールする場合もあります。各 IME によってユーザーインターフェース，変換辞書，および入力方法が異なります。

個々のコントロールはデフォルト IME をオーバーライドできます。コントロールがそのコントロールに情報を入力する別の IME を指定すると，キーボード入力を処理する IME はそのコントロールがフォーカスを持つと切り替わります。コントロールがフォーカスを失うと DefaultIme はシステム IME として復元されます。


TScreen.DefaultKbLayout
TScreen.DefaultKbLayout3368014

TScreen	参照

DefaultKbLayout プロパティは，アプリケーションの起動時にアクティブだったキーボード配置への Windows ハンドルです。

property DefaultKbLayout: HKL;

説明

DefaultKbLayout プロパティは，キーボード配置へのハンドルを必要とする Windows API を呼び出すために使われます。たとえば，アプリケーションがその国に適した設定に合わせるためにキーボード配置を変更した場合，DefaultKbLayout の値は，元の配置を復元するために Windows API の ActivateKeyboardLayout 関数のパラメータとして使われます。

アジア向けのキーボードの場合，キーボード配置はデフォルトの言語だけでなくインプットメソッドエディタ（IME）も識別します。IME と連動する Windows API の呼び出しに DefaultKbLayout を使います。DefaultKbLayout は，DefaultIme プロパティで名前を付けられた IME に関連付けられたキーボード配置のハンドルです。


TScreen.Fonts
TScreen.Fonts3368015

TScreen	参照

Fonts プロパティは，画面で使えるフォントの書体名リストです。

property Fonts: TStrings;

説明

Fonts プロパティは，現在インストールされているスクリーンフォントの種類を判別するために使われます。アプリケーションは Fonts を使ってユーザーのシステムにインストールされていないフォントが要求されないようにできます。アプリケーションが，インストールされていないフォントを使うために TFont オブジェクトを使うときには，Windows は別のフォントで代用しますが，アプリケーションの指定フォントとは異なる場合があります。

注意

Fonts はスクリーンフォントのリストです。アプリケーションで使えるプリンタフォントは表しません。


TScreen.FormCount
TScreen.FormCount3368016

TScreen	参照

FormCount プロパティは，画面に表示されているフォームの数を示します。

property FormCount: Integer;

説明

FormCount プロパティは，現在画面に表示されているフォームの数を示します。これらのフォームには Forms プロパティを使ってアクセスできます。FormCount はアプリケーション内のすべてのフォームに反復処理を行うときに Forms とともに使います。


TScreen.Forms
TScreen.Forms3368017

TScreen	参照

Forms プロパティは，アプリケーションで現在表示されているすべてのフォームのリストを示します。

property Forms[Index: Integer]: TForm;

説明

Forms プロパティは，インデックスによってフォームにアクセスするために使われます。Index の値は 0（最初のフォーム）～ FormCount - 1 です。Forms はアプリケーションがすべてのダイアログを含むすべてのフォームに対して反復処理を行う必要があるときに FormCount とともに使います。

たとえば，Button1 をクリックすると，次のコードは画面上のすべてのフォーム名を ListBox1 に追加します。

procedure TForm1.Button1Click(Sender: TObject);

var

  I: Integer;

begin

  for I := 0 to Screen.FormCount-1 do

    ListBox1.Items.Add(Screen.Forms[I].Name);

end;


TScreen.Height
TScreen.Height3368018

TScreen	参照

Height プロパティは，画面の縦方向のサイズをピクセル数で示します。

property Height: Integer;

説明

Height プロパティは，ユーザーの画面のサイズ（ピクセル数）を示します。次に画面に配置されたオブジェクトのサイズまたは位置が画面に適合するように設定されます。たとえば，次のコードは画面上のすべてのフォームの高さを調べ，画面の高さよりも大きいもののサイズを変更します。

with Screen do

  for I := 0 to FormCount-1 do

    if Forms[I].Height > Height then Forms[I].Height := Height;


TScreen.IconFont
TScreen.IconFont3368019

TScreen	参照

IconFont プロパティは，ファイル選択ダイアログでアイコン上のラベルを表示するのに使うフォントです。

property IconFont: TFont;

説明

IconFont プロパティは，Windows 95 アイコンのフォント設定を格納します。このアイコンは，Windows 95 のデスクトップ上のアイコンとファイル選択ダイアログのアイコンにラベル付けするのに使われます。


TScreen.Imes
TScreen.Imes3368020

TScreen	参照

Imes プロパティは，システムにインストールされているすべてのインプットメソッドエディタ（IME）のリストを示します。

property Imes: TStrings;

説明

Imes プロパティは， Windows レジストリ内にリストされているすべての IME のリストを示します。IME はアジア語の文字用のフロントエンドプロセッサです。IME はすべてのキー入力をフックして変換ウィンドウでアジア語の文字に変換し，その変換後の文字または文字列を Delphi アプリケーションに送ります。1 台のコンピューターに複数の IME をインストールする場合もあります。各 IME によってユーザーインターフェース，変換辞書，および入力方法が異なります。

個々のコントロールはフォーカスを持ったときにキー入力を処理するために特定の IME を必要とします。IME を指定するために，コントロールが ImeName プロパティを Imes 内のいずれかの文字列に設定します。

Imes 内の各 IME 名はそれぞれ関連付けられたキーボード配置ハンドルを持っています。キーボード配置ハンドルとは一次言語およびキー入力を処理するために使う IME を識別する Windows ハンドルです。キーボード配置ハンドルは IME をプログラムするために Windows API 呼び出しで使ってください。特定の IME に対するキーボード配置ハンドルを取得するには，コントロールで次のようなコードを使います。

HKeyboard := HKL(Screen.Imes.Objects[Screen.Imes.IndexOf(ImeName)]);


TScreen.PixelsPerInch
TScreen.PixelsPerInch3368021

TScreen	参照

PixelsPerInch プロパティは，垂直方向の論理インチとなる画面ピクセルの数です。

property PixelsPerInch: Integer;

説明

PixelsPerInch プロパティは，ピクセル単位で表した寸法と論理インチで表した寸法を変換するために使われます。PixelsPerInch は垂直方向の寸法についてのみ正確です。通常ほとんどの画面で水平方向の寸法については異なるスケール係数を使っています。PixelsPerInch の値は Delphi の起動時に Windows から取得します。


TScreen.Width
TScreen.Width3368022

TScreen	参照

Width プロパティは，画面の水平サイズ（ピクセル数）を示します。

property Width: Integer;

説明

Width プロパティは，とユーザーの画面のサイズ（ピクセル数）を示します。それによって，画面に配置したオブジェクトのサイズまたは位置を画面に合わせて設定することができます。たとえば次のコードは，画面上のすべてのフォームの幅を調べ，画面の幅よりも大きいもののサイズを変更します。

with Screen do

  for I := 0 to FormCount-1 do

    if Forms[I].Width > Width then Forms[I].Width := Width;


TScreen イベント3368023

TScreen	アルファベット順

TScreen

OnActiveControlChange

OnActiveFormChange


TScreen イベント3368024

TScreen	オブジェクト順

OnActiveControlChange

OnActiveFormChange


TScreen.OnActiveControlChange
TScreen.OnActiveControlChange3368025

TScreen	参照

OnActiveControlChange イベントは，入力フォーカスが新しいウィンドウコントロールに移った直後に発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnActiveControlChange: TNotifyEvent;

説明

OnActiveControlChange イベントハンドラを記述すると，入力フォーカスが新しいコントロールに変わったときに特定のアクションを実行できます。フォーカスの移動には，別のアクティブフォームに移る場合と，新しく開いてアクティブになったフォームに移る場合があります。

コントロール間でフォーカスが移動すると次のイベントが発生します。

1.	新しくフォーカスを受け取るコントロールが別のフォームにある場合，フォーカスは新しいフォームに移動する

2.	フォーカスは新しくアクティブになったコントロールに移動する

3.	アクティブフォームが変わった場合，OnActiveFormChange イベントが発生する

4.	OnActiveControlChange イベントが発生する


TScreen.OnActiveFormChange
TScreen.OnActiveFormChange3368026

TScreen	参照

OnActiveFormChange イベントは，マルチフォームアプリケーションで新しいフォームがアクティブになった直後に発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnActiveFormChange: TNotifyEvent;

説明

OnActiveFormChange イベントハンドラを記述すると，新しいフォームがアクティブになったときに特定のアクションを実行できます。OnActiveFormChange が発生するのはアプリケーションのアクティブフォームが変わったときであり，アプリケーションがアクティブになったためにフォームがアクティブになったときではありません。


TScreen メソッド3368027

TScreen	アルファベット順

TScreen

Create

Destroy

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TScreen メソッド3368028

TScreen	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TScreen.Create
TScreen.Create3368029

TScreen	参照

Create メソッドは，TScreen のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

TScreen の別のインスタンスを作成しないでください。Delphi アプリケーションで使うためにインスタンス化されている TScreen 型のグローバル変数 Screen があります。Screen のプロパティはアプリケーション全体に対してグローバルです。

Create は TScreen オブジェクトにメモリを割り当ててから，次の処理を行います。

・	Cursors プロパティを組み込みカーソルで埋める

・	Fonts プロパティを使用可能なスクリーンフォントで埋める

・	Imes プロパティを登録済みのインプットメソッドエディタ（IME）で埋めて DefaultIme プロパティおよび DefaultKbLayout プロパティを設定する

・	現在の画面の解像度に PixelsPerInch プロパティを設定する

・	IconFont プロパティ，Forms プロパティ，および DataModules プロパティ向けのヘルパーオブジェクトを作成する


TScreen.Destroy
TScreen.Destroy3368030

TScreen	参照

Destroy メソッドは，TScreen のインスタンスを破棄します。

destructor Destroy; override;

説明

Delphi アプリケーションで自動的にインスタンス化されるグローバルオブジェクト Screen を破棄しないでください。Screen は多くの Delphi オブジェクトが使います。

Destroy メソッドは，DataModules プロパティ，Forms プロパティ，Fonts プロパティ，IconFont プロパティ，および Imes プロパティに関連付けられたメモリを解放するとともに Cursors プロパティが使っていたカーソルを解放します。


スコープ3368031

published

読み出し／書き込み

読み出し専用


継承3368032

TObject

TPersistent

TComponent


TScreen 例3368033

TScreen


TScrollBar
TScrollBar3369001

継承	プロパティ	メソッド	イベント	参照	例

TScrollBar コンポーネントは，Windows のスクロールバーであり，ウィンドウ，フォーム，コントロールの内容をスクロールするために使います。

ユニット

stdctrls

説明

TScrollBar は，フォームに単独のスクロールバーを追加します。コントロールの多くには，コントロールに組み込むスクロールバーを追加するプロパティがあります。TScrollBar を使うと，ユーザーが TScrollBar オブジェクトを操作したときにスクロールするスクロールバーが付いていないコントロールのグループまたはコントロールを使用できます。


TScrollBar プロパティ3369002

TScrollBar	アルファベット順	凡例

TScrollBar

Kind

LargeChange

Max

Min

Position

SmallChange

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Height

Hint

Left

Name

Parent

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TScrollBar プロパティ3369003

TScrollBar	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Handle

Height

HelpContext

Hint

Kind

LargeChange

Left

Max

Min

Name

Owner

Parent

ParentCtl3D

ParentShowHint

ParentWindow

PopupMenu

Position

ShowHint

Showing

SmallChange

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TScrollBar.Kind
TScrollBar.Kind3369004

TScrollBar

Kind プロパティは，スクロールバーが水平スクロールバーか垂直スクロールバーのどちらであるかを示します。

property Kind: TScrollBarKind;

説明

Kind プロパティは，スクロールバーの方向を示します。以下に指定値を示します。

値	意味

sbHorizontal	水平スクロールバー

sbVertical	垂直スクロールバー


TScrollBar.LargeChange
TScrollBar.LargeChange3369005

TScrollBar	参照

LargeChange プロパティは，水平スクロールバーまたは垂直スクロールバーのスクロールボックスとどちらかのスクロール矢印の間をクリックするか，〔PageUp〕または〔PageDown〕キーを押したときに Position がどれだけ移動するか指定します。

TScrollBarInc = 1..32767;

説明

LargeChange プロパティは，スクロールボックスとスクロール矢印の間をクリックしたときの Position の変化量を示します。Max プロパティと Min プロパティは，Position が変化する範囲を定義します。

たとえば，Max が 30000 で Min が 0 の場合，スクロールボックスの範囲は 30000 位置になります。LargeChange プロパティの設定が 10000 で Position プロパティが 0 ならば，スクロールバーを 3 回（30000/10000 = 3）クリックするとスクロールバーボックスがスクロールバーの端から端まで移動します。

LargeChange は，1 つのページまたは画面で見えるように，Max プロパティ，Min プロパティ，および Position プロパティに使う論理ユニットで表される範囲に対応します。


TScrollBar.Max
TScrollBar.Max3369006

TScrollBar	参照

Max プロパティは，スクロールバーが表す最大位置です。

property Max: Integer;

説明

Max プロパティは，Position プロパティが取ることできる最大値に設定します。Max プロパティと Min プロパティは，Position プロパティの値の範囲全体を定義します。


TScrollBar.Min
TScrollBar.Min3369007

TScrollBar	参照

Min プロパティは，スクロールバーが表す最小位置です。

property Min: Integer;

説明

Min プロパティは，Position プロパティが取ることのできる最小値に設定します。Min プロパティと Max プロパティは，Position プロパティの値の範囲全体を定義します。


TScrollBar.Position
TScrollBar.Position3369008

TScrollBar	参照

Position プロパティは，スクロールバーの現在位置を示します。

property Position: Integer;

説明

Position プロパティは，スクロールバーの位置を示します。ユーザーがスクロールバーをスクロールさせると Position 値が変化します。Position を設定すると，プログラムでスクロールバーのスクロールボックスを移動できます。

スクロールバー上の可能な位置の数は，Max プロパティと Min プロパティの差によって決まります。Position の値が Min と同じ値ならば，スクロールボックスは水平スクロールバーの左端，または垂直スクロールバーの上端に表示されます。Position の値が Max と同じ値ならば，スクロールボックスが水平スクロールバーの右端，または垂直スクロールバーの下端に表示されます。


TScrollBar.SmallChange
TScrollBar.SmallChange3369009

TScrollBar	参照

SmallChange プロパティは，ユーザーがスクロールバーの端にある矢印をクリックしてスクロールしたとき，またはキーボード上の矢印キーを使ったときの Position の変化量を示します。

TScrollBarInc = 1..32767;

説明

SmallChange プロパティは，ユーザーが矢印ボタンをクリックしたときの Position の値の変化量を示します。Max プロパティと Min プロパティは，Position の値の範囲全体を定義します。

たとえば，Max が 100 で Min が 0 ならば，スクロールボックスの範囲は 100 位置です。SmallChange プロパティの設定が 5 で Position プロパティが 0 ならば，矢印ボタンを 20 クリックするとスクロールボックスがスクロールバーの端から端まで移動します。

SmallChange は，1 行または 1 つの項目として見えるように， Max プロパティ，Min プロパティ，および Position プロパティに使う論理ユニットで表される範囲に対応します。


TScrollBar イベント3369010

TScrollBar	アルファベット順	凡例

TScrollBar

OnChange

OnScroll

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnDragDrop

OnDragOver

OnEndDrag

OnStartDrag


TScrollBar イベント3369011

TScrollBar	オブジェクト順	凡例

OnChange

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnScroll

OnStartDrag


TScrollBar.OnChange
TScrollBar.OnChange3369012

TScrollBar	参照

OnChange イベントは，Position 値の変化した直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラを記述すると， TScrollBar を使って別のオブジェクトまたはオブジェクトのグループを制御できます。Position の新しい値を反映するために，スクロールバーで制御するオブジェクトを調整します。

OnChange は，ユーザーまたはプログラムによって Position の値が変化すると発生します。Position の値がユーザーによって変更された場合，OnChange は OnScroll イベントの直後に発生します。


TScrollBar.OnScroll
TScrollBar.OnScroll3369013

TScrollBar	参照

OnScroll イベントは，ユーザーがマウスまたはキーボードを使ってスクロールバーをスクロールさせると発生します。

TScrollCode = (scLineUp, scLineDown, scPageUp, scPageDown, scPosition, scTrack, scTop,

    scBottom, scEndScroll);

TScrollEvent = procedure(Sender: TObject; ScrollCode: TScrollCode; var ScrollPos: Integer) of object;

property OnScroll: TScrollEvent;

説明

OnScroll イベントハンドラを記述すると，ユーザーがスクロールバーをスクロールさせたときに Position の値を調整できます。ScrollPos パラメータには，スクロールした後に Position プロパティに代入されようとしている新しい値が入っています。ScrollPos を変更すると，スクロールの結果を変更できます。

ScrollCode パラメータは，スクロールバーをスクロールしたユーザーアクションの型を示します。以下に ScrollCode パラメータの指定値を示します。

値	意味

scLineUp	ユーザーは上向きまたは左向きのスクロール矢印をクリックしたか，上向きまたは左向きの矢印キーを押した

scLineDown	ユーザーは下向きまたは右向きのスクロール矢印をクリックしたか，下向きまたは右向きの矢印キーを押した

scPageUp	ユーザーはスクロールボックスの上または左の領域をクリックしたか〔PageUp〕キーを押した

scPageDown	ユーザーはスクロールボックスの下または右の領域をクリックしたか〔PageDown〕キーを押した

scPosition	ユーザーはスクロールボックスを位置付けて放した

scTrack	ユーザーはスクロールボックスを移動している

scTop	ユーザーはスクロールボックスをスクロールバーの一番上または一番左に移動した

scBottom	ユーザーはスクロールボックスをスクロールバーの一番下または一番右に移動した

scEndScroll	ユーザーはスクロールボックスの移動を終えた


TScrollBar メソッド3369014

TScrollBar	アルファベット順

TScrollBar

Create

SetParams

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TScrollBar メソッド3369015

TScrollBar	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetParams

SetTextBuf

Show

Update

UpdateControlState


TScrollBar.Create
TScrollBar.Create3369016

TScrollBar	参照

Create メソッドは，TScrollBar のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TScrollBar のインスタンスを作成できます。設計時にフォームに配置されたスクロールバーは自動的に作成されます。Create は継承された Create メソッドを呼び出してから，次のようにスクロールバーの初期値を設定します。

・	ControlStyle を [csFramed, csDoubleClicks] に設定する

・	Height をシステムの水平スクロールバーの高さに，Width を 121 に設定する

・	Kind を sbHorizontal に設定する

・	Position を 0 に，Min を 0 に，Max を 100 に設定する

・	SmallChange と LargeChange を 1 に設定する

・	TabStop を True に設定する


TScrollBar.SetParams
TScrollBar.SetParams3369017

TScrollBar	参照

SetParams メソッドは，Position，Max，および Min の 3 つのプロパティを同時に設定します。

procedure SetParams(APosition, AMax, AMin: Integer);

説明

SetParams メソッドを呼び出すと，Position，Max，および Min の 3 つのプロパティ値を同時に設定できるので，各メソッドを個々に設定した場合に発生する画面の再描画を回避できます。


スコープ3369018

published

読み出し／書き込み

読み出し専用


スコープ3369019

published


継承3369020

TObject

TPersistent

TComponent

TControl

TWinControl


TScrollBox
TScrollBox3370001

継承	プロパティ	メソッド	イベント	参照

TScrollBox は，ウィンドウ内のスクロール領域（スクロールボックス）を作成するコンポーネントです。

ユニット

forms

説明

TScrollBox を使ってウィンドウ内にスクロールボックスを作成します。

スクロールボックスは，ツールバーおよびステータスバー（TPanel コンポーネント）などのウィンドウ内の領域をスクロールしないようにしたい場合に使います。ツールバーおよびステータスバーをスクロールしないようにするには，ウィンドウのスクロールバーを隠してから，ツールバーとステータスバーの間のクライアント領域にスクロールボックスを配置します。このスクロールボックスに関連付けられたスクロールバーはウィンドウに属するように見えますが，スクロールするのはスクロールボックス内部の領域だけです。

スクロールボックスを使ってウィンドウ内に複数のスクロール領域（ビュー）を作成できます。ビューはワードプロセッサ，スプレッドシート，およびプロジェクト管理アプリケーションでは一般的になっています。

スクロールボックスには，TButton および TCheckBox オブジェクトなどのオブジェクトを格納できます。


TScrollBox プロパティ3370002

TScrollBox	アルファベット順	凡例

TScrollBox

BorderStyle

TScrollingWinControl からの継承

AutoScroll

HorzScrollBar

VertScrollBar

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComOBject


TScrollBox プロパティ3370003

TScrollBox	オブジェクト順	凡例

Align

AutoScroll

BorderStyle

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

Hint

HorzScrollBar

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComOBject

VertScrollBar

Visible

Width

WindowProc


TScrollBox.BorderStyle
TScrollBox.BorderStyle3370004

TScrollBox

BorderStyle プロパティは，スクロールボックスに境界を付けるかどうかを指定します。

property BorderStyle: TBorderStyle;

説明

BorderStyle プロパティは，スクロールボックスに境界を設定します。BorderStyle では次に示す TBorderStyle の値を指定できます。

値	意味

bsNone	非可視境界

bsSingle	一重境界線


TScrollBox イベント3370005

TScrollBox	アルファベット順	凡例

TScrollBox

OnResize

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp


TScrollBox イベント3370006

TScrollBox	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnMouseDown

OnMouseMove

OnMouseUp

OnResize


TScrollBox.OnResize
TScrollBox.OnResize3370007

TScrollBox

OnResize イベントは，スクロールボックスをサイズ変更したときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnResize: TNotifyEvent;

説明

スクロールボックスがサイズ変更されたときの特別な処理を実行するための OnResize を使います。


TScrollBox メソッド3370008

TScrollBox	アルファベット順

TScrollBox

Create

TScrollingWinControl からの継承

Destroy

DisableAutoRange

EnableAutoRange

ScrollInView

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TScrollBox メソッド3370009

TScrollBox	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

DisableAutoRange

Dispatch

DragDrop

Dragging

EnableAlign

EnableAutoRange

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

ScrollInView

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TScrollBox.Create
TScrollBox.Create3370010

TScrollBox	参照

Create メソッドは，新しい TScrollBox オブジェクトを作成，初期化します。

constructor Create(AOwner: TComponent);

説明

Create メソッドは，新しい TScrollBox オブジェクトを作成，初期化します。

AOwner はスクロールボックスの親オブジェクトをカプセル化する TComponent オブジェクトです。

Create メソッドは次のタスクを実行します。

・	TScrollingWinControl.Create メソッドを呼び出して AOwnerを渡す

・	ControlStyle プロパティを csAcceptsControls，csCaptureMouse，csClickEvents，csSetCaption，csDoubleClicks に設定する

・	Width プロパティを 185 に設定する

・	Height プロパティを 41 に設定する

・	BorderStyle プロパティを bsSingle に設定する


スコープ3370011

published

読み出し／書き込み

読み出し専用


スコープ3370012

published


継承3370013

TObject

TPersistent

TComponent

TControl

TWinControl

TScrollingWinControl


TScrollBox 例3370014

TScrollBox


TScrollingWinControl
TScrollingWinControl3371001

継承	プロパティ	メソッド	参照

TScrollingWinControl は，スクロールをサポートするウィンドウコントロール用のコンポーネントです。

ユニット

forms

説明

TScrollingWinControl は，スクロールをサポートするウインドウコントロールを作成します。

通常，スクロールウインドウコントロールは水平スクロールバーと垂直スクロールバーを持ち，子コントロールがフォーカスを受け取ると子コントロールを表示範囲にスクロールします。

スクロールウインドウコントロールの例には TForm オブジェクトおよび TScrollBox オブジェクトがあります。


TScrollingWinControl プロパティ3371002

TScrollingWinControl	アルファベット順	凡例

TScrollingWinControl

AutoScroll

HorzScrollBar

VertScrollBar

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TScrollingWinControl プロパティ3371003

TScrollingWinControl	オブジェクト順	凡例

Align

AutoScroll

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

HorzScrollBar

Left

Name

Owner

Parent

ParentWindow

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

VertScrollBar

Visible

Width

WindowProc


TScrollingWinControl.AutoScroll
TScrollingWinControl.AutoScroll3371004

TScrollingWinControl	参照

AutoScroll プロパティは，スクロールウインドウコントロールが小さくてすべてのコントロールを表示できないときに，スクロールバーを表示するかどうかを指定する論理プロパティです。

property AutoScroll: Boolean;

説明

AutoScroll が True ならば，必要に応じてスクロールバーが自動的に現れます。たとえばユーザーがスクロールウインドウコントロールのサイズを小さくして一部のコントロールが部分的に隠れるとスクロールバーが現れます。

AutoScroll が False ならば自動的にはスクロールバーは現れません。この場合，スクロールバーを表示するには HorzScrollBar プロパティおよび VertScrollBar プロパティを使います。


TScrollingWinControl.HorzScrollBar
TScrollingWinControl.HorzScrollBar3371005

TScrollingWinControl	参照

HorzScrollBar プロパティは，スクロールウインドウコントロール用に水平スクロールバーをカプセル化する TControlScrollBar オブジェクトです。

property HorzScrollBar: TControlScrollBar;

説明

HorzScrollBar プロパティは，スクロールウインドウコントロール用に水平スクロールバーの非表示，表示，および操作を行うために使われます。


TScrollingWinControl.VertScrollBar
TScrollingWinControl.VertScrollBar3371006

TScrollingWinControl	参照

VertScrollBar プロパティは，スクロールウインドウコントロール用に垂直スクロールバーをカプセル化する TControlScrollBar オブジェクトです。

property VertScrollBar: TControlScrollBar;

説明

VertScrollBar プロパティは，スクロールウインドウコントロール用に垂直スクロールバーの表示/非表示を切り替えたり，操作するために使われます。


TScrollingWinControl メソッド3371007

TScrollingWinControl	アルファベット順	凡例

TScrollingWinControl

AlignControls

AutoScrollInView

ChangeScale

Create

CreateParams

CreateWnd

Destroy

EnableAutoRange

ScrollInView

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

TCcrollingWinControl からの継承

DisableAutoRange


TScrollingWinControl メソッド3371008

TScrollingWinControl	オブジェクト順	凡例

AlignControls

Assign

AutoScrollInView

BeginDrag

BringToFront

Broadcast

CanFocus

ChangeScale

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParams

CreateParented

CreateWnd

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

DisableAutoRange

Dispatch

DragDrop

Dragging

EnableAlign

EnableAutoRange

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

ScrollInView

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TScrollingWinControl.AlignControls
TScrollingWinControl.AlignControls3371009

TScrollingWinControl	参照

AlignControls メソッドは，スクロールウインドウコントロール内でコントロールの位置合わせを行います。

procedure AlignControls(AControl: TControl; var ARect: TRect); override;

説明

AlignControls メソッドを呼び出すと，スクロールウインドウコントロール内でコントロールの位置合わせを行うことができます。位置合わせの方法は個々のコントロールの Align プロパティ値によって指定します。

AControl は同じ Align 値を持つ複数のコントロールがあるときにどのコントロールを優先するかを指定する TControl オブジェクトです。AControl は nil でもかまいません。

ARect は位置合わせの対象となるコントロールを格納しているスクロールウインドウコントロール内で領域を指定する TRect オブジェクトです。ARect はスクロールウインドウコントロールの全領域に自動的に設定されます。

AutoScroll が True でスクロールウインドウコントロールがサイズ変更されていなければ，スクロールウインドウコントロール上のスクロールバーの範囲は自動的に再計算されます。

AlignControls はスクロールバーの範囲を再計算し ARect 値を設定してから，TWinControl.AlignControls を呼び出して AControl および ARect オブジェクトを渡します。


TScrollingWinControl.AutoScrollInView
TScrollingWinControl.AutoScrollInView3371010

TScrollingWinControl	参照

AutoScrollInView メソッドは，スクロールウインドウコントロールの可視領域にコントロールをスクロールします。

procedure AutoScrollInView(AControl: TControl)

説明

AutoScrollInView メソッドを呼び出すと，スクロールウインドウコントロールの可視領域にコントロールをスクロールできます。

AControl はスクロールウインドウコントロールの可視領域にスクロールするためのコントロールをカプセル化する TControl オブジェクトです。

ScrollInView とは異なり，AutoScrollInView は AControl またはスクロールウインドウコントロールの ComponentState プロパティが csLoading になっているときにはコントロールをスクロールしません。

AutoScrollInView は ScrollInView を呼び出して必要なスクロールを行います。


TScrollingWinControl.ChangeScale
TScrollingWinControl.ChangeScale3371011

TScrollingWinControl	参照

ChangeScale メソッドは，スクロールウインドウコントロールのサイズを指定した割合で変更します。

procedure ChangeScale(M, D: Integer); override;

説明

ChangeScale メソッドを呼び出すと，スクロールウインドウコントロールのサイズを指定した割合で変更できます。

M パラメータは乗数で D パラメータは除数です。たとえばスクロールウインドウコントロールを元のサイズの 4/5 にしたければ，M の値を 4，D の値を 5に指定します。

ChangeScale メソッドは指定した割合でスクロールウインドウコントロール上のスクロールバーの範囲を再計算し，次に TControl.ChangeScale を呼び出します。


TScrollingWinControl.Create
TScrollingWinControl.Create3371012

TScrollingWinControl	参照

Create メソッドは，新しい TScrollingWinControl オブジェクトを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，新しい TScrollingWinControl オブジェクトを作成し，初期化できます。

AOwner はスクロールウインドウコントロールを所有するオブジェクトをカプセル化する TControlScrollBar オブジェクトです。

Create は次のタスクを実行します。

・	TWinControl.Create を呼び出して TScrollingWinControl オブジェクトを作成してオーナーに挿入する

・	水平および垂直スクロールバーを作成して HorzScrollBar および VertScrollBar にそれぞれ割り当てる

・	AutoScroll を True に設定する


TScrollingWinControl.CreateWnd
TScrollingWinControl.CreateWnd3371014

TScrollingWinControl	参照

CreateWnd メソッドは，TScrollingWinControl オブジェクトに対応する Windows コントロールを作成します。

procedure CreateWnd; override;

説明

CreateWnd メソッドを呼び出すと，TScrollingWinControl オブジェクトに対応する Windows コントロールを作成できます。

CreateWnd はスクロールウインドウコントロール上のスクロールバーを初期化して，次に TWinControl.CreateWnd を呼び出します。.


TScrollingWinControl.Destroy
TScrollingWinControl.Destroy3371015

TScrollingWinControl	参照

Destroy メソッドは，メモリから TScrollingWinControl オブジェクトを削除します。

destructor Destroy; override;

説明

Destroy のかわりに Free を呼び出してください。TScrollingWinControl オブジェクトが nil でないときに，Free は Destroy を呼び出します。

Destroy は HorzScrollBar および VertScrollBar プロパティを解放して，次に TWinControl.Destroy を呼び出します。


DisableAutoRange

DisableAutoRange メソッドは，自動スクロールを使用不可にします。

procedure DisableAutoRange;

説明

DisableAutoRange メソッドを呼び出すと，フォームでコントロールを再配列するときに一時的に自動スクロールを使用不可にできます。このメソッドを EnableAutoScroll メソッドと組み合わせて使うと，スクロールのオン/オフを切り換えられます。


TScrollingWinControl.EnableAutoRange
TScrollingWinControl.EnableAutoRange3371017

TScrollingWinControl	参照

EnableAutoRange メソッドは，自動スクロールを使用可能にします。

     procedure EnableAutoRange;

説明

EnableAutoRange を呼び出すと，オフになっていたスクロールを再び使用可能にできます。このメソッドを DisableAutoScroll メソッドと組み合わせて使うと，スクロールのオン/オフを切り換えられます。


TScrollingWinControl.ScrollInView
TScrollingWinControl.ScrollInView3371018

TScrollingWinControl	参照

ScrollInView メソッドは，スクロールウインドウコントロールの可視領域にコントロールをスクロールするメソッドです。

procedure ScrollInView(AControl: TControl)

説明

ScrollInView メソッドを呼び出すと，スクロールウインドウコントロールの可視領域にコントロールをスクロールできます。

AControl は可視領域にスクロールするコントロールをカプセル化する TControl オブジェクトです。

注意

AControl またはスクロールウインドウコントロールの ComponentState プロパティが csLoading になっている可能性があるときには，ScrollInView のかわりに AutoScrollInView を使ってください。


スコープ3371019

protected

published

読み出し／書き込み

読み出し専用


スコープ3371020

protected


継承3371021

TObject

TPersistent

TComponent

TControl

TWinControl


TScrollingWinControl 例3371022

TScrollingWinControl


TSessionList
TSessionList3372001

継承	プロパティ	メソッド	参照

TSessionList オブジェクトはデータベースアプリケーション内部でボーランドデータベースエンジン（BDE）のセッションを管理します。

ユニット

dbtables

説明

TSessionList を使うと，マルチセッションを提供するアプリケーションでセッションコンポーネントを管理できます。Delphiは，すべてのデータベースアプリケーション用にグローバルにアクセス可能なデフォルトセッションリストコンポーネントを Sessions という名前で自動的に作成します。マルチセッションアプリケーションでは複数のセッションがアクティブになることがありますが，カレントセッションは 1 つだけです。アプリケーションは TSessionList を使うことでカレントセッションを切り替えることができます。

注意

アプリケーションでは，追加したセッションリストコンポーネントをインスタンス化しないでください。


TSessionList プロパティ3372002

TSessionList	アルファベット順	凡例

TSessionList

Count

CurrentSession

List

Sessions


TSessionList プロパティ3372003

TSessionList	オブジェクト順	凡例

Count

CurrentSession

List

Sessions


TSessionList.Count
TSessionList.Count3372004

TSessionList	参照

Count プロパティは，アプリケーションで利用できるセッションの数を示します。

property Count: Integer;

説明

Count プロパティを読み出すと，利用可能なセッションの数がわかります。Count を使うと，利用可能なセッションのリストを繰り返し処理して汎用のアクションをすべてのセッションで実行できます。アプリケーションからインデックス番号を使ってセッションにアクセスできる Session プロパティとともに使用することにより，Count プロパティは Sessions に格納するインデックスの最大エントリ数（Count - 1）を表します。


TSessionList.CurrentSession
TSessionList.CurrentSession3372005

TSessionList	参照

CurrentSession プロパティは，カレントのセッションコンポーネントを指すポインタを返します。

property CurrentSession: TSession

説明

CurrentSession は，データベースアプリケーション内のカレントセッションを確認したり指定したりできます。デフォルトでは，カレントセッションはデフォルトセッションコンポーネントの Session を指すポインタです。Session は Delphi によってすべてのデータベースアプリケーション用に自動的に作成されます。CurrentSession を設定すると，指定したセッションコンポーネントがカレントセッションになります。アクティブなセッションがいくつあっても，カレントセッションは 1 つだけです。


TSessionList.List
TSessionList.List3372006

TSessionList	参照

List プロパティは，指定したセッションコンポーネントを返します。

property List[const SessionName: string]: TSession;

説明

List プロパティを使うと，セッションリストで管理している特定のセッションコンポーネントを指すポインタが返されます。List はどのセッションをカレントにするかを指定しません。SessionName でどのセッションコンポーネントを返すかを指定します。また，SessionName は既存のセッションコンポーネントの SessionName プロパティと一致しなければなりません。一致するセッションが存在しないときには，List は EDatabaseError 例外を生成し，無効なセッション名を指定したことを知らせるメッセージを作成します。

注意

例外を生成しないようにするには，List プロパティを使わずに FindSession メソッドを呼び出します。


TSessionList.Sessions
TSessionList.Sessions3372007

TSessionList	参照

Session プロパティは，セッションリストでアクティブなすべてのセッションコンポーネントのインデックス配列を提供します。

property Sessions[Index: Integer]: TSession;

説明

Sessions プロパティは，利用可能なセッションコンポーネントにアクセスできます。Index はアクセスするセッションを指定します。Index の値は 0 と Count プロパティの現在の値から 1 を引いた値の間になければなりません。この範囲にない値を指定すると EListError 例外が生成され，値が制限を超えていることを通知します。

たとえば，アプリケーションがリスト内の利用可能なすべてのセッションを繰り返し処理してグローバルなアクションを実行することがあります。次のコードは各セッションの KeepConnections プロパティを False に設定します。

var

I: Integer;

begin

for I := 0 to Sessions.Count - 1 do

Sessions[I].KeepConnections := False;

end;


TSessionList メソッド3372008

TSessionList	アルファベット順

TSessionList

Create

Destroy

FindSession

GetSessionNames

OpenSession

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntity

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TSessionList メソッド3372009

TSessionList	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FindSession

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetSessionNames

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

OpenSession

SafeCallException


TSessionList.Create
TSessionList.Create3372010

TSessionList	参照

Create メソッドは，TSessionList コンポーネントのインスタンスを作成します。

constructor Create;

説明

TSessionList のインスタンスは作成しないでください。Sessions はデフォルトのセッションリストコンポーネントなので，すべてのデータベースアプリケーション用に自動的に作成されます。また，二次セッションリストは必要ありません。

Create は継承コンストラクタを呼び出し，空のリストオブジェクトを作成してセッションコンポーネントをトラッキングするとともに，データベースを開くクリティカルセクションを作成および初期化します。


TSessionList.Destroy
TSessionList.Destroy3372011

TSessionList	参照

Destroy メソッドは，セッションリストコンポーネントのインスタンスを破棄します。

destructor Destroy;

説明

ユーザー側では Destroy メソッドを呼び出さないでください。Delphi はアプリケーション終了時にデフォルトのセッションリストコンポーネントの Sessions を自動的に破棄します。

Destroy はすべてのセッションコンポーネントを終了し，BDE のクリティカルセクションを削除してから，継承デストラクタを呼び出します。


TSessionList.FindSession
TSessionList.FindSession3372012

TSessionList	参照

FindSession メソッドは，セッションリストから指定のセッションを検索します。

function FindSession(const SessionName: string): TSession;

説明

FindSession を呼び出すと，指定したセッションが存在するかどうかがわかります。SessionName は検索するセッションを指定します。

FindSession は SessionName パラメータとセッションリスト内の各セッションコンポーネントの SessionName プロパティを比較します。一致するコンポーネントが見つかった場合，FindSession はそのセッションコンポーネントを指すポインタを返します。アプリケーションが SessionName で空の文字列を渡した場合，FindSession はデフォルトセッションの Session を返します。一致するコンポーネントが見つからない場合，FindSession は nil を返します。


TSessionList.GetSessionNames
TSessionList.GetSessionNames3372013

TSessionList	参照

GetSessionNames メソッドは，文字列リストに利用可能なすべてのセッションの名前を取得します。

アプリケーションから作成した文字列リストオブジェクトに利用可能なすべてのセッションの名前（SessionName プロパティ）を取得します。

procedure GetSessionNames(List: TStrings);

説明

GetSessionNames を呼び出すと，利用可能なすべてのセッションのリストを取得できます。List はセッション名を格納する文字列リストオブジェクトで，アプリケーションによって作成，保持されます。GetSessionNames が返す名前は利用可能なすべてのセッションの SessionName プロパティに対応します。


TSessionList.OpenSession
TSessionList.OpenSession3372014

TSessionList	参照

OpenSession メソッドは，作成済みのセッションコンポーネントをアクティブにしたり，新しいセッションコンポーネントを作成してアクティブにしたりします。

function OpenSession(const SessionName: string): TSession;

説明

OpenSession メソッドを呼び出すと，作成済みのセッションコンポーネントをアクティブにしたり，新しいセッションコンポーネントを作成してアクティブにしたりできます。SessionName はどのセッションを開くかを指定します。

OpenSession は FindSession を呼び出して，SessionName パラメータに指定したセッションが存在するかどうかを調べます。一致するセッションが見つかった場合は，まだ開始されていなければそのセッションを開始してアクティブにします。OpenSession が一致するセッションを見つけられない場合には，SessionName パラメータに指定した名前を使って新しいセッションを作成してから，そのセッションを開始してアクティブにします。

いずれの場合も OpenSession はセッションオブジェクトを返します。


読み出し／書き込み3372015

読み出し専用


継承3372016

TObject


TSessionList 例3372017

TSessionList


TSession
TSession3373001

継承	プロパティ	メソッド	イベント	参照

TSession コンポーネントは，アプリケーションにおけるデータベース接続をグローバルに管理します。

ユニット

dbtables

説明

TSession コンポーネントは,アプリケーションでデータベース接続を管理します。

TSession には標準，Paradox 用複数のネットファイル，およびマルチスレッドデータベースアプリケーションの 3 つの使い方があります。

Delphi はすべてのデータベースアプリケーション用に，グローバルにアクセス可能な Session という名前のデフォルト TSession コンポーネントを自動的に作成します。デフォルトセッションコンポーネントは標準データベース接続を処理します。アプリケーションは実行時にデフォルトセッションのプロパティ，イベント，およびメソッドにアクセスすることでそのセッションを制御します。

それぞれが離れているネットワーク上の Paradox テーブルに同時にアクセスする必要のあるデータベースアプリケーションは，各ネットワークにひとつのセッションを開始してマルチセッションを処理します。

同じデータに対して一度に 2 つの問い合わせを実行するように，同じデータベースに複数の並行接続するデータベースアプリケーションはマルチスレッドアプリケーションになります。マルチスレッドアプリケーションは単一のデータベースサーバーへの接続ごとにセッションコンポーネントを作成，保守しなければなりません。

注意

マルチセッションを保守するアプリケーションは TSessionList コンポーネントを通じてセッションを管理できます。Sessions（デフォルトセッションコンポーネントの Session とは異なることに注意してください）と呼ばれるデフォルトのセッションリストコンポーネントは，すべてのデータベースアプリケーションに対して自動的に作成されます。


TSession プロパティ3373002

TSession	アルファベット順	凡例

TSession

Active

AutoSessionName

ConfigMode

DatabaseCount

Databases

Handle

KeepConnections

Locale

NetFileDir

PrivateDir

SessionName

SQLHourGlass

TraceFlags

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TSession プロパティ3373003

TSession	オブジェクト順	凡例

Active

AutoSessionName

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConfigMode

DatabaseCount

Databases

DesignInfo

Handle

KeepConnections

Locale

Name

NetFileDir

Owner

PrivateDir

SessionName

SQLHourGlass

Tag

TraceFlags

VCLComObject


TSession.Active
TSession.Active3373004

TSession	参照

Active プロパティは，セッションがアクティブかどうかを示します。

property Active: Boolean;

説明

Active プロパティは，デフォルトセッションの Session がアクティブかどうかを示します。Active はデフォルトでは False に設定されていて，開いているデータベース接続がない，またはそのセッションと関連付けられたデータベースがないことを表します。Active が True の場合，開いているデータベース接続がないときでもセッションはアクティブです。

データベースアプリケーションでセッションコンポーネントを追加するには，設計時または実行時に Active プロパティを設定してください。Active を True に設定するとセッションが開始されカレントセッションになります。Active を True にするとセッションに対して OnStartup イベントハンドラが発生し，NetFileDir プロパティ，PrivateDir プロパティ，および ConfigMode プロパティを初期化します。

Active を False（デフォルト設定）にすると，開いているデータセットがすべて閉じられ，データベースサーバからの接続を解除します。

注意

Active を False に設定することで，アプリケーションはデフォルトセッションを終了できますが，お勧めしません。


TSession.AutoSessionName
TSession.AutoSessionName3373005

TSession	参照

AutoSessionName プロパティは，セッションにユニークな名前を自動的に生成するかどうかを示します。

property AutoSessionName: Boolean;

説明

AutoSessionName プロパティは，Delphi で自動的にユニークなセッション名を生成するかどうかを示します。AutoSessionName は，Web ベースアプリケーションの開発者に，Web サーバー用に発生するセッションが実行時にそれぞれユニークになることを保証するためのものです。

AutoSessionName が False（デフォルト設定）の場合，アプリケーションはそのセッションコンポーネントの SessionName プロパティを設定しなければなりません。AutoSessionName が True の場合，Delphi は SessionName プロパティを自動的に割り当て，割り当てられたセッション名は，セッションコンポーネントが表示されるデータモジュールまたはフォーム内のすべてのデータセットコンポーネントの SessionName プロパティに共通して使われます。Delphi は，現在の Name プロパティ値にアンダースコア（_）を追加し，次に数値を付けてセッション名を生成します。たとえば，Name が CustomerSession ならば，AutoSessionName は CustomerSession_2 になります。

注意

AutoSessionName には次の制限事項があります。

・	AutoSessionName は，2 つ以上のセッションコンポーネントが入っているデータモジュールまたはフォームに設定できません。

・	AutoSessionName を True に設定してあるセッションコンポーネントが入っているデータモジュールまたはフォームにセッションコンポーネントを追加することはできません。

・	AutoSessionName を True の場合にセッションの SessionName プロパティを直接設定できません。


TSession.ConfigMode
TSession.ConfigMode3373006

TSession	参照

ConfigMode プロパティは，セッションに対して作成したエリアスをどのようにボーランドデータベースエンジン（BDE）が処理するかを示します。

type

TConfigModes = (cfmVirtual, cfmPersistent, cfmSession);

TConfigMode = set of TConfigModes;

property ConfigMode: TConfigMode;

説明

ConfigMode プロパティは，セッションの状況内で AddAlias または AddStandardAlias を使って作成されたエリアスを BDE でどのように処理するかを示します。また，ConfigMode はアプリケーションが GetAliasNames メソッドを呼び出したときにどの BDE エリアスがセッションにレポートされるかを示します。

ConfigMode のデフォルト設定は cmAll です。これには TConfigModes に定義されているすべての設定項目が含まれます。以下にエリアスに設定できる BDE 環境設定モードを示します。

モード	意味

cfmVirtual	BDE 環境設定ファイル（BDE 持続的ストア）のすべてのエリアスおよびローカルエリアスをそのセッションで利用できる

cfmPersistent	BDE 環境設定ファイルのエリアス（BDE 持続的ストアに追加されたエリアス）だけをそのセッションで利用できる

cfmSession	そのセッション内で作成されたエリアスだけを利用できる

ConfigMode の最大の目的は，アプリケーションがセッションレベルにおいてエリアスを指定し，制限できるようにすることです。

注意

セッションで作成されたエリアスは BDE 環境設定ファイルに自動的には保存されません。エリアスを環境設定ファイルに保存するには，SaveConfigFile メソッドを呼び出してください。


TSession.DatabaseCount
TSession.DatabaseCount3373007

TSession	参照

DatabaseCount プロパティは，セッションに関連付けられているアクティブなデータベースコンポーネントの数を示します。

property DatabaseCount: Integer;

説明

DatabaseCount プロパティは，セッションに関連付けられているアクティブなデータベースコンポーネントの数を示します。セッションが開いている間にデータベース接続を開いたり閉じられたりすると，この数値は変化します。DatabaseCountが 0 の場合，現在そのセッションでアクティブになっているデータベースコンポーネントがないことを意味します。

通常，DatabaseCount は Databases プロパティとともに使用してセッション内でアクティブなデータベースのカレントセットを繰り返すのに利用します。たとえば，次のコードを使用すれば，デフォルトセッションでアクティブな各データベースの KeepConnection プロパティを True に設定できます。

var

  I: Integer;

begin

  with Session do

    if DatabaseCount > 0 then

    begin

     for I:= to DatabaseCount -1 do

      Databases[I].KeepConnection := True;

    end;

  end;

end;


TSession.Databases
TSession.Databases3373008

TSession	参照

Databases プロパティは，アクティブなデータベースコンポーネント名のインデックス配列をセッションに提供します。

property Databases[Index: Integer]: TDatabase;

説明

Databases プロパティは，セッションと関連付けられたアクティブなデータベースコンポーネントへのアクセスを提供します。アクティブなデータベースとは現在データベースサーバーに接続しているデータベースを意味します。

通常，Databases は DatabaseCount プロパティとともに使用してセッション内でアクティブなデータベースのカレントセットを繰り返すのに利用します。たとえば，次のコードを使用すれば，デフォルトセッションでアクティブな各データベースの KeepConnection プロパティを True に設定できます。

var

  I: Integer;

begin

  with Session do

    if DatabaseCount > 0 then

    begin

     for I:= to DatabaseCount -1 do

      Databases[I].KeepConnection := True;

    end;

  end;

end;


TSession.Handle
TSession.Handle3373009

TSession	参照

Handle プロパティは，セッションに対してボーランドデータベースエンジン（BDE）のハンドルを示します。

type

HDBISES: Longint;

property Handle: HDBISES;

説明

Handle プロパティは，TSession メソッドをバイパスして直接 BDE の API を呼び出すためにのみ使用してください。BDE 関数呼び出しの多くはハンドルパラメータを必要とします。Handleはセッションが開始されたときに初期値を指定します。

注意

標準 Delphi コンポーネントで提供されない BDE の機能をアプリケーションに付加する必要がないかぎり Handle プロパティを使用してはいけません。


TSession.KeepConnections
TSession.KeepConnections3373010

TSession	参照

KeepConnections プロパティは，データベースと関連付けられているアクティブなデータセットがなくても，セッションの状況に応じて一時的なデータベースコンポーネントを作成するかどうかを示します。

property KeepConnections: Boolean;

説明

KeepConnections プロパティは，アクティブなデータセットがないときでも実行時に作成されるデータベースコンポーネントがサーバー接続を維持するかどうかを示します。KeepConnections を True（デフォルト設定）に設定すると，アプリケーションが終了するか DropConnections メソッドを呼び出すまでデータベース接続は維持されます。リモートデータベースサーバーへの接続，または起動と終了を頻繁に繰り返すアプリケーションの場合，ネットワークトラフィックを減らし，処理速度を向上させるために KeepConnections は True に設定するべきです。

KeepConnections を False に設定すると，アプリケーションはデータベースに関連付けられたデータセットをすべて閉じたときにデータベースへの接続を解除します。接続を解除するとその接続に割り当てていたシステムリソースは解放されますが，データセットが同じデータベースを使うときには，再接続して初期化しなければなりません。

注意

持続的データベースコンポーネント用のサーバー接続の持続時間は，セッションの KeepConnections プロパティの代わりに，データベースコンポーネントの KeepConnection プロパティによって決まります。


TSession.Locale
TSession.Locale3373011

TSession	参照

Locale プロパティは，セッションコンポーネントで使うボーランドデータベースエンジン（BDE）言語ドライバを識別します。

type

TLocale: Pointer;

property Locale: TLocale;

説明

Locale プロパティは，セッションコンポーネントで使われる BDE の言語ドライバを示します。BDE を直接呼び出すアプリケーションは，API 関数パラメータとして Locale 情報を渡す必要があります。

注意

標準 Delphi コンポーネントで提供されない BDE 機能をアプリケーションに付加する必要がないかぎり Locale プロパティを使用してはいけません。


TSession.NetFileDir
TSession.NetFileDir3373012

TSession	参照

NetFileDir プロパティは，ボーランドデータベースエンジン（BDE）ネットワークコントロールファイル PDOXUSRS.NET が格納されているディレクトリを指定します。

property NetFileDir: string;

説明

NetFileDir プロパティは，BDE のネットワークコントロールファイル PDOXUSRS.NET が格納されているディレクトリを示します。このファイルを使うと，ネットワークドライブで複数のユーザーが Paradox テーブルを共有できます。ネットワークドライブで Paradox テーブルを共有するすべてのアプリケーションは NetFileDir プロパティに同じ値を指定し，そのディレクトリについて読み出し，書き込み，および作成の権限がなくてはなりません。

Delphi では NetFileDir プロパティの初期値を Paradox ドライバに使う BDE の環境設定をファイルから派生します。設計時または実行時に NetFileDir に指定された値は BDE の環境設定をオーバーライドします。


TSession.PrivateDir
TSession.PrivateDir3373013

TSession	参照

PrivateDir プロパティは，セッションと関連付けられたデータベースコンポーネントで使うボーランドデータベースエンジン（BDE）によって作成された一時的なテーブル処理ファイルを格納するディレクトリを示します。

property PrivateDir: string;

説明

PrivateDir プロパティは，データベース接続で使う一時的なテーブル処理ファイル（ローカル SQL 文を処理するために BDE が作成したファイルなど）を格納するディレクトリを示します。通常，この値は実行時にのみ設定され，ユーザーが一時ファイルをローカルのハードディスクに保存できるようにします。ローカルな記憶媒体に保存すると速度が速くなります。PrivateDir に値を設定しないと，BDE は BDE が初期化されたときのディレクトリに自動的に一時ファイルを格納します。

注意

ネットワーク化されたファイルサーバーから直接アプリケーションを実行する場合，性能を向上させるとともに，サーバーに一時ファイルを作成すると別のアプリケーションのインスタンスの一時ファイルが作成されたときにサーバー上で競合することがあるので，サーバーに一時ファイルが作成されないようにするため，PrivateDir をユーザーのローカルドライブに設定してください。


TSession.SessionName
TSession.SessionName3373014

TSession	参照

SessionName プロパティは，セッションにリンクしたデータベースおよびデータセットコンポーネントを識別するために一意的なセッション名を示します。

property SessionName: string;

説明

SessionName プロパティは，データベースおよびデータセットコンポーネントをセッションにリンクするために使う一意的で意味のある名前を示します。各データベースおよびデータセットコンポーネントは対応する SessionName プロパティを持ち，そのプロパティはアクティブなセッションの SessionNameプロパティと一致するか，デフォルトセッション Session と関連付けられているとを示す空白でなければなりません。

注意

AutoSessionName プロパティが True の場合，アプリケーションは SessionName を直接設定できません。


TSession.SQLHourGlass
TSession.SQLHourGlass3373015

TSession

SQLHourGlass プロパティは，BDE 処理中にマウスカーソルを砂時計の形に変えるかどうかを示します。

property SQLHourGlass: Boolean;

説明

SQL サーバーが処理を実行するのを BDE が待っている間にマウスカーソルを砂時計に変えたくない場合，SQLHourGlass を False に設定します。このプロパティはセッションを開く前に設定しなければなりません。


TSession.TraceFlags
TSession.TraceFlags3373016

TSession	参照

TraceFlags プロパティは，実行時に SQL モニタで追跡されるデータベース操作を示します。

type

TTraceFlag = (tfQPrepare, tfQExecute, tfError, tfStmt, tfConnect, tfTransact,

tfBlob, tfMisc, tfVendor, tfDataIn, tfDataOut);

TTraceFlags = set of TTraceFlag;

property TraceFlags: TTraceFlags;

説明

TraceFlags プロパティは，アプリケーションの実行時に SQL モニタで追跡されるデータベース操作を示します。TraceFlags は SQL モニタに対してだけ意味を持ち，リモート SQL サーバーにアクセスするときの処理効率の調整および SQL デバッグが可能にします。

注意

通常，トレースオプションはアプリケーションコードに TraceFlags を記述するよりも SQL モニタから設定します。

セッションコンポーネントの TraceFlags プロパティ値は，そのセッションに関連付けられたデータベースコンポーネントで使う TraceFlags プロパティの初期設定です。

TTraceFlags 型は TraceFlags プロパティに可能な個々の値を定義します。以下に TraceFlags に指定できる値を示します。

値	意味

tfQPrepare	Prepare 文をモニタする

TfQExecute	ExecSQL 文をモニタする

TfError	サーバーのエラーメッセージをモニタする。エラーメッセージにはエラーコードが含まれることがある

TfStmt	すべてのSQL 文をモニタする

tfConnect	データベースの接続および接続解除に関連した操作（接続ハンドルの割り当てや解放を含む）をモニタする

tfTransact	StartTransaction，Commit，および Rollback などのトランザクション文をモニタする

tfBlob	BLOB データ型に対する操作をモニタする

tfMisc	他のフラグ操作で網羅されないすべての文をモニタする

tfVendor	データベースサーバーの API 関数の直接呼び出しをモニタする

tfDataIn	サーバーから受け取ったデータをモニタする

tfDataOut	サーバーに送ったデータをモニタする

TraceFlags は集合プロパティなので，アプリケーションは異なるフラグの組み合わせを指定して異なる文をモニタすることができます。たとえば，次の文を使うとデータベース接続と SQL 文の準備をモニタするように設定できます。

TraceFlags := [tfConnect, tfQPrepare];


TSession イベント3373017

TSession	アルファベット順	凡例

TSession

OnPassword

OnStartup


TSession イベント3373018

TSession	オブジェクト順	凡例

OnPassword

OnStartup


TSession.OnPassword
TSession.OnPassword3373019

TSession	参照

OnPassword イベントは，Paradox テーブルを最初に開こうとしたときに，アプリケーションが適切なアクセス権を持たないことがボーランドデータベースエンジン（BDE）から報告されると発生します。

type

TPasswordEvent = procedure(Sender: TObject; var Continue: Boolean) of object;

property OnPassword: TPasswordEvent;

説明

OnPassword イベントハンドラを記述すると，アプリケーションが初めてパスワード保護された Paradox テーブルにアクセスしようとしたときにどのようなアクションを取るかを指定できます。Paradox テーブルにアクセスするには，イベントハンドラは BDE に有効なパスワードを渡さなければなりません。そのセッションに対するパスワードを設定可能にするには，イベントハンドラは AddPassword メソッドを呼び出さなければなりません。

注意

OnPasswordイベントが定義されていない場合でも，BDE はアクセス権が適切ではないことを報告し，Delphi がパスワードを入力できるようにデフォルトダイアログボックスを表示します。


TSession.OnStartup
TSession.OnStartup3373020

TSession	参照

OnStartup イベントは，アプリケーションがセッションをアクティブにすると OnStartup が発生します。

type

TNotifyEvent = procedure(Sender: TObject) of object;

property OnStartup: TNotifyEvent;

説明

OnStartup イベントハンドラを記述すると，アプリケーションがセッションを開始したときに どのようなアクションを取るかを指定できます。セッションは Active プロパティを True に設定したり，そのセッションと関連付けられたデータベースまたはデータセット（いずれも Active を True に設定してある場合）を開いたりすると開始されます。


TSession メソッド3373021

TSession	アルファベット順

TSession

AddAlias

AddDriver

AddPassword

AddStandardAlias

Close

CloseDatabase

Create

DeleteAlias

DeleteDriver

Destroy

DropConnections

FindDatabase

GetAliasDriverName

GetAliasNames

GetAliasParams

GetConfigParams

GetDatabaseNames

GetDriverNames

GetDriverParams

GetPassword

GetStoredProcNames

GetTableNames

IsAlias

ModifyAlias

ModifyDriver

Open

OpenDatabase

RemoveAllPasswords

RemovePassword

SaveConfigFile

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntity

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TSession メソッド3373022

TSession	オブジェクト順

AddAlias

AddDriver

AddPassword

AddStandardAlias

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Close

CloseDatabase

Create

DefaultHandler

DeleteAlias

DeleteDriver

Destroy

DestroyComponents

Destroying

Dispatch

DropConnections

FieldAddress

FindComponent

FindDatabase

Free

FreeInstance

FreeNotification

FreeOnRelease

GetAliasDriverName

GetAliasNames

GetAliasParams

GetConfigParams

GetDatabaseNames

GetDriverNames

GetDriverParams

GetInterface

GetInterfaceEntity

GetInterfaceTable

GetNamePath

GetParentComponent

GetPassword

GetStoredProcNames

GetTableNames

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsAlias

MethodAddress

MethodName

ModifyAlias

ModifyDriver

NewInstance

Open

OpenDatabase

RemoveAllPasswords

RemoveComponent

RemovePassword

SafeCallException

SaveConfigFile


TSession.AddAlias
TSession.AddAlias3373023

TSession	参照

AddAlias メソッドは，指定されたボーランドデータベースエンジン（BDE）エリアスを SQL データベースサーバーのセッションに追加します。

procedure AddAlias(const Name, Driver: string; List: TStrings);

説明

AddAlias メソッドを実行時に呼び出すと，SQL データベースサーバーにセッション固有の BDE エリアスを作成できます。Name はエリアスに割り当てる一意の名前です。Driver はエリアスに使う SQL Link データベースドライバの名前です。List はエリアスのパラメータが入っている文字列リストです。

セッションの ConfigMode プロパティは，エリアスがローカルか，BDE クライアントがアクティブの間 BDE 持続的記憶に格納されているすべてのアプリケーションで使用可能かを示します。エリアスを永続的に保存するには，SaveConfigFile メソッドを呼び出してからセッションを終了します。

注意

AddAlias は Paradox または dBASE エリアスの作成に使われますが，AddStandardAlias を使えばより簡単に Paradox および dBASE エリアスを作成できます。

例

次の例では InterBase データベースサーバーのエリアスを作成します。

var

  MyList: TStringList;

begin

  MyList := TStringList.Create;

  try

    with MyList do begin

    begin

     Add('SERVER NAME=IB_SERVER:/PATH/DATABASE.GDB');

     Add('USER NAME=MYNAME');

    end;

    Session1.AddAlias('NewIBAlias', 'INTRBASE', MyList);

  finally

    MyList.Free;

  end;

end;


TSession.AddDriver
TSession.AddDriver3373024

TSession	参照

AddDriver メソッドは，指定したボーランドデータベースエンジン（BDE）ドライバを SQL データベースサーバーのセッションに追加します。

procedure AddDriver(const Name: string; List: TStrings);

説明

実行時に AddDriver メソッドを呼び出すと，SQL データベースサーバーの BDE ドライバを作成できます。AddDriver を使って ODBC ドライバのエントリを作成することもできます。Name はそのドライバに割り当てるユニークな名前です。List はそのエリアスのパラメータを格納する文字列リストです。

セッションの ConfigMode プロパティは，ドライバがそのセッションにのみ利用可能なのか，BDE クライアントがアクティブであるかぎり BDE 持続的記憶内のすべてのアプリケーションで利用可能なのかを指定します。ドライバを保存するには，セッションを終了する前に SaveConfigFile メソッドを呼び出します。


TSession.AddPassword
TSession.AddPassword3373025

TSession	参照

AddPassword メソッドは，暗号化されている Paradox テーブルにアクセスするためにパスワードをカレントセッションに追加します。

procedure AddPassword(const Password: string);

説明

AddPassword メソッドを呼び出すと，暗号化された Paradox テーブルを開くセッションの前にパスワードを入力するセッションを追加できます。アクセスするのにパスワードが必要な Paradox テーブルをアプリケーションが開く場合，セッションはそのパスワードを割り当てるのではなく，アプリケーションも OnPassword イベントハンドラを提供しません。テーブルにアクセスが許可される前に，Delphi がダイアログボックスを表示してパスワードの入力を求めます。

注意

アプリケーションが独自の OnPassword イベントハンドラを定義する場合，ハンドラはこのメソッドを呼び出して，セッションを開始するためのパスワードを追加しなければなりません。AddPassword によって割り当てられたパスワードは，アプリケーションが終了する前に RemoveAllPasswords または RemovePassword を使って削除しなければなりません。


TSession.AddStandardAlias
TSession.AddStandardAlias3373026

TSession	参照

AddStandardAlias メソッドは， Paradox，dBASE，または ASCII テーブル用のセッションに標準ボーランドデータベースエンジン（BDE）エリアスを追加します。

procedure AddStandardAlias(const Name, Path, DefaultDriver: string);

説明

AddStandardAlias メソッドを実行時に呼び出すと，Paradox，dBASE，または ASCII テーブルにセッション固有の BDE エリアスを作成します。Name はエリアスに割り当てる一意の名前です。 Path はデータベースが格納されているディレクトリです。DefaultDriverはエリアスで使う標準 BDE ドライバの名前です。設定する場合，DefaultDriver は「 PARADOX 」，「 DBASE 」，または「 ASCIIDRV 」のいずれかでなければなりません。空白の場合，DefaultDriver は「 PARADOX 」にデフォルト設定されます。DefaultDriver は，拡張子を持たずテーブル型が ttDefault として定義されているテーブルを開こうとしたときに使用されます。

セッションの ConfigMode プロパティは，エリアスがローカルか，BDE クライアントがアクティブの間持続的なエリアスを使うすべてのアプリケーションで使用可能かを示します。エリアスを永続的に保存するには，SavConfigFile メソッドを呼び出してからセッションを終了します。

注意

SQL データベースのエリアスを作成するには，AddStandardAlias の代わりに AddAlias を呼び出します。


TSession.Close
TSession.Close3373027

TSession	参照

Close メソッドは，すべてのデータベースから接続を解除してセッションを閉じます。

procedure Close;

説明

Close メソッドを呼び出すと，セッションを終了できます。Close は一時データベースコンポーネントを解放し，Close メソッドの持続的データベースコンポーネントを呼び出すことにより，アクティブなすべてのデータベースから接続を解除してから，セッション所有のハンドルを nil に設定します。

注意

Active プロパティを False に設定してもセッションを終了できます。


TSession.CloseDatabase
TSession.CloseDatabase3373028

TSession	参照

CloseDatabase メソッドは，カレントセッションに関連付けられたデータベース接続をクローズします。

procedure CloseDatabase(Database: TDatabase);

説明

CloseDatabase メソッドを呼び出すと，持続的データベースコンポーネント接続の終了，または一時データベース接続の終了および解放ができます。Database は接続を終了するデータベースコンポーネント名を指定します。

CloseDatabase は指定されているデータベースコンポーネントの参照カウントをデクリメントし，次に，参照カウントがゼロでそのデータベースコンポーネントの KeepConnection プロパティが False のとき，CloseDatabase は一時データベースコンポーネントを解放するか，持続的データベースコンポーネントへの接続を終了します。

注意

持続的データベースコンポーネントに対して CloseDatabase を呼び出しても接続は終了されません。持続的データベースコンポーネントの接続を終了するには，そのデータベースコンポーネントの Close メソッドを直接呼び出します。

一時データベースコンポーネントは，それに関連付けられた最後のデータセットを閉じたときに自動的に閉じられますが，アプリケーションは強制終了する前に CloseDatabase を呼び出せます。一時データベースコンポーネントが確立した接続を終了しても，そのセッションの KeepConnections プロパティが True（デフォルト）に設定されていると，そのコンポーネントは解放されません。一時データベースコンポーネントを解放するには，各接続を終了してから DropConnections を呼び出します。


TSession.Create
TSession.Create3373029

TSession	参照

Create メソッドは，TSession コンポーネントのインスタンスを作成します。

constructor Create(AOwner: TComponent);

説明

Create は直接呼び出さないでください。デフォルトセッションコンポーネント Session はすべてのデータベースアプリケーションに対して自動的に作成されます。実行時にマルチスレッドデータベースアプリケーションの追加セッションを作成するには，Create のかわりに OpenSession を呼び出します。OpenSession は新規のセッションの場合にのみ Create を呼び出します（設計時にはデータモジュールをドロップして追加セッションを作成します)。

Create は継承コンストラクタを呼び出して，データモジュールまたはそれが入ったフォームがオブジェクトリポジトリに格納されている場合，そのセッションが継承されないようにします。また，Create は次の処理を行います。

・	セッションで使う空のデータベースコンポーネントのリストを作成する

・	KeepConnections プロパティを True に設定する

・	セッションをセッションリストに追加する

・	Handle プロパティを nil に設定する


TSession.DeleteAlias
TSession.DeleteAlias3373030

TSession	参照

DeleteAlias メソッドは，指定したボーランドデータベースエンジン（BDE）エリアスをセッションから削除します。

procedure DeleteAlias(const Name: string);

説明

DeleteAlias メソッドを呼び出すとセッションから BDE エリアスを削除できます。エリアスを削除するとそのセッションではそのエリアスを利用できなくなりますが，セッションが作成されるときに，すでに格納されているエリアスは，BDE 環境設定ファイルからは削除されません。エリアスを BDE 環境設定ファイルから削除するには，DeleteAlias の後で SaveConfigFile を呼び出します。


TSession.DeleteDriver
TSession.DeleteDriver3373031

TSession	参照

DeleteDriver メソッドは，指定したボーランドデータベースエンジン（BDE）ドライバをセッションから削除します。

procedure DeleteDriver(const Name: string);

説明

DeleteDriver を呼び出すと，セッションから BDE ドライバを削除できます。ドライバを削除するとそのセッションではそのドライバを利用できなくなりますが，セッションが作成されるときに，すでに格納されているドライバは，BDE 環境設定ファイルからは削除されません。BDE 環境設定ファイルからドライバを削除するには，DeleteDriver の後で SaveConfigFile を呼び出します。


TSession.Destroy
TSession.Destroy3373032

TSession	参照

Destroy メソッドは，セッションコンポーネントのインスタンスを破棄します。

destructor Destroy;

説明

Destroy は直接呼び出さないでください。デフォルトセッション以外のセッションコンポーネントの場合，アプリケーションは Free を呼び出す必要があります。Free はセッションコンポーネントが解放されていないことを確認してから Destroy を呼び出します。

警告

デフォルトセッションに対して Free または Destroy を呼び出してはいけません。アプリケーションの終了時に，Delphi がデフォルトセッションを自動的に解放します。

Destroy は以下に示すアクションを実行してから継承デストラクタを呼び出します。

・	セッションを非アクティブにしてすべてのデータベース接続を終了する

・	セッションリストからそのセッションを削除する

・	必要に応じてデータベースセッション参照を再設定する

・	セッションと関連付けられたデータベースコンポーネントのリストを解放する


TSession.DropConnections
TSession.DropConnections3373033

TSession	参照

DropConnections メソッドは，セッションと関連付けられた非アクティブな一時データベースコンポーネントをすべて解放します。

procedure DropConnections;

説明

DropConnections メソッドを呼び出すと，現在非アクティブなすべての一時データベースコンポーネントを解放できます。セッションの KeepConnections プロパティを True（デフォルト）に設定すると，データベース接続が解除されても，実行時に Delphi がセッションに対して作成した一時データベースコンポーネントは自動的に解放されません。DropConnections を使えば，不要になったコンポーネントをアプリケーションが解放できます。


TSession.FindDatabase
TSession.FindDatabase3373034

TSession	参照

FindDatabase メソッドは，指定したデータベースをセッションのデータベースコンポーネントリストから検索します。

function FindDatabase(const DatabaseName: string): TDatabase;

説明

FindDatabase メソッドを呼び出すと，指定したデータベースがセッションと関連付けられているかどうかがわかります。DatabaseName はどのデータベースコンポーネントを検索するかを指定します。

FindDatabase は，DatabaseName プロパティと DatabaseName プロパティを比較して，セッションリストにある各データベースコンポーネントを検索します。一致するデータベースを見つけると，FindDatabase はそのデータベースコンポーネントにポインタを返します。見つからなければ FindDatabase は nil を返します。

セッションで使う新しいデータベースコンポーネントを作成する前に，アプリケーションで FindDatabase を呼び出して既存のデータベースコンポーネントがないかどうかを確認できます。


TSession.GetAliasDriverName
TSession.GetAliasDriverName3373035

TSession	参照

GetAliasDriverName メソッドは，GetAliasDriverName メソッドは，セッションと関連付けられている指定したボーランドデータベースエンジン（BDE）エリアスで使うデータベースドライバ名を返します。

function GetAliasDriverName(const AliasName: string): string;

説明

GetAliasDriverName メソッドを呼び出すと，特定のエリアスが用いる BDE データベースドライバを決められます。AliasNameはドライバ情報を返すエリアス名です。

Paradox テーブルおよび dBASE テーブルに対応するエリアスの場合，GetAliasDriverNameは「 STANDARD 」を返します。ASCII テーブルの場合，戻り値は「 ASCIIDRV 」です。SQL データベースの場合，ドライバ名はデータベースサーバーによって異なります。


TSession.GetAliasNames
TSession.GetAliasNames3373036

TSession	参照

GetAliasNames メソッドは，文字列リストに持続的ボーランドデータベースエンジン（BDE）エリアスを追加します。

procedure GetAliasNames(List: TStrings);

説明

GetAliasNames メソッドを呼び出すと，持続的 BDE エリアス（持続的記憶または BDE 環境設定ファイル内のエリアス）のリストを取得できます。List はアプリケーションが作成および保守する文字列リストオブジェクトでエリアス名を格納します。

セッションの ConfigMode プロパティは，セッションのコンテキストに応じて作成されたエリアスが GetAliasNames で報告されるかどうかを示します。ConfigMode を cmAll に設定した場合，セッションで作成されたエリアスが報告されます。


TSession.GetAliasParams
TSession.GetAliasParams3373037

TSession	参照

GetAliasParams メソッドは，ボーランドデータベースエンジン（BDE）エリアスに関連付けられているパラメータを取得します。

procedure GetAliasParams(const AliasName: string; List: TStrings);

説明

GetAliasParams メソッドは，指定されたエリアスで使う BDE 環境設定パラメータを取得します。AliasName はパラメータを取得するエリアス名です。List はアプリケーションが作成および保守する文字列リストオブジェクトであり，パラメータを格納します。


TSession.GetConfigParams
TSession.GetConfigParams3373038

TSession	参照

GetConfigParams メソッドは，ボーランドデータベースエンジン（BDE）環境設定情報を取得します。

procedure GetConfigParams(const Path, Section: string; List: TStrings);

説明

GetConfigParams メソッドを呼び出すと，アプリケーションの初期化に使う BDE 環境設定ファイルから特定の種類の環境設定情報を取得できます。

Path は BDE 環境設定ファイルの内部ノード構造を表し，必ずルートつまり 1 個のバックスラッシュで表されるディレクトリから開始しなければなりません。各ノードはバックスラッシュで区切り，ノードを空白にすることはできません。たとえば \SYSTEM\FORMATS\TIME の Path は BDE 環境設定ファイルで使う時刻形式を返します。

Path ではノード指定のどこか 1 カ所で置換可能な形式設定文字列（%s）が使えます。その場合，Section には指定していないノードの情報が含まれていなければなりません。例では GetConfigParams は Section の内容を Path に挿入してから BDE を呼び出して要求された情報のパラメータを返します。

Listはアプリケーションが作成および保守する文字列リストで，環境設定情報を格納します。たとえば Path が \DATABASES\%s\DB INFO で Section がエリアス名の場合，GetConfigParams は List 内で該当するエリアスのパラメータを返します。

BDE 環境設定ファイルの詳しい情報については， BDE のオンラインヘルプを参照してください。


TSession.GetDatabaseNames
TSession.GetDatabaseNames3373039

TSession	参照

GetDatabaseNames メソッドは，持続的ボーランドデータベースエンジン（BDE）エリアスおよびセッションと関連付けられているすべてのデータベースコンポーネントの名前の文字列リストを取得します。

procedure GetDatabaseNames(List: TStrings);

説明

GetDatabaseNames メソッドは，BDE エリアス（持続的記憶または BDE 環境設定ファイル内のエリアス）およびおよびセッションと関連付けられているすべてのデータベースコンポーネントの名前のソートされた済み組み合わせ文字列リストを取得します。List はアプリケーションが作成および保守する文字列リストオブジェクトで，データベースおよびエリアス名を格納します。


TSession.GetDriverNames
TSession.GetDriverNames3373040

TSession	参照

GetDriverNames メソッドは，セッションで使用可能なボーランドデータベースエンジン（BDE）ドライバ名の文字列リストを取得します。

procedure GetDriverNames(List: TStrings);

説明

GetDriverNames メソッドを呼び出すと，セッションで使用可能なすべての BDE ドライバ名を取得できます。 List はアプリケーションが作成および保守する文字列リストオブジェクトで，ドライバ名を格納します。


TSession.GetDriverParams
TSession.GetDriverParams3373041

TSession	参照

GetDriverParams メソッドは，指定されたボーランドデータベースエンジン（BDE）ドライバのパラメータを文字列リストに追加します。

procedure GetDriverParams(const DriverName: string; List: TStrings);

説明

GetDriverParams メソッドを呼び出すと，指定された BDE ドライバに関連付けられたパラメータリストを取得できます。DriverName はパラメータリストに返す BDE ドライバです。List はアプリケーションが作成および保守する文字列リストオブジェクトでドライバパラメータを格納します。

GetDriverParams が返すパラメータの実数は指定するドライバによって異なります。たとえば Paradox および dBASE 用の STANDARD というドライバのパラメータはごくわずかです。SQL Link ドライバの場合には複数のパラメータが返されます。


TSession.GetPassword
TSession.GetPassword3373042

TSession	参照

GetPassword メソッドは，セッションの OnPassword イベントハンドラを呼び出すか，デフォルトのパスワードダイアログボックスを表示します。

function GetPassword: Boolean;

説明

GetPassword メソッドは，アプリケーションがパスワード保護された Paradox ファイルを開くときのセッションおよびハンドラの応答ロジックに対して OnPassword イベントハンドラを呼び出します。OnPassword イベントハンドラを定義していないときは，GetPassword はデフォルトのパスワードダイアログボックスを表示します。

アプリケーションは GetPassword の戻り値を使ってプログラムロジックを制御できます。ユーザーが OK を選択すると GetPassword は True を返し，Cancel を選択すると False を返します。


TSession.GetStoredProcNames
TSession.GetStoredProcNames3373043

TSession	参照

GetStoredProcNames メソッドは，SQL データベースサーバーに接続している指定されたデータベースコンポーネントに関連付けられたすべてのストアドプロシージャの文字列リストを取得します。

procedure GetStoredProcNames(const DatabaseName: string; List: TStrings);

説明

GetStoredProcNames メソッドを呼び出すと，SQL データベースサーバーに接続しているデータベースコンポーネントについてのすべてのストアドプロシージャのリストを取得できます。DatabaseName はストアドプロシージャを取得するデータベース名を指定します。List はアプリケーションが作成および保守する文字列リストオブジェクトでストアドプロシージャ名を格納します。

注意

GetStoredProcNames が Paradox または dBASEデータベースに対して呼び出されると例外が生成されます。


TSession.GetTableNames
TSession.GetTableNames3373044

TSession	参照

GetTableNames メソッドは，指定されたデータベースコンポーネントに関連付けられたテーブル名の文字列リストを取得します。

procedure GetTableNames(const DatabaseName, Pattern: string; Extensions,

SystemTables: Boolean; List: TStrings);

説明

GetTableNames メソッドを呼び出すと，指定のデータベースに関連付けられたテーブル名のリストを取得できます。DatabaseName はテーブル名を取得するデータベースを指定します。

Pattern は区切り記号文字列を指定して，その文字列に一致するものだけを返すようにテーブルを制限します。Pattern ではワイルドカードを使えます。あるいは制限されていないすべてのファイルを一致させるために空の Pattern 文字列を渡します。

Paradox および dBASE 上で検索する場合， Extensions を True に設定することによりテーブル名にファイルの拡張子が追加されます。SQL ベースのデータベースの場合には Extension をFalseに設定します。

データベース構造を定義するデータテーブルおよびシステムテーブルを返すように SQL ベースのデータベースには SystemTables を True に設定します。Paradox および dBASE テーブルには SystemTables を False に設定してください。

List はアプリケーションが作成および保守する文字列リストオブジェクトでテーブル名を格納します。


TSession.IsAlias
TSession.IsAlias3373045

TSession	参照

IsAlias メソッドは，セッションと関連付けられた既存のボーランドデータベースエンジン（BDE）エリアスに文字列値が対応するかどうかを決めます。

function IsAlias(const Name: string): Boolean;

説明

IsAlias メソッドを呼び出すと，文字列がセッションで使用可能な既存の BDE エリアス名と対応するかどうかを決められます。Name は対応を確認する文字列です。

IsAlias が True を返した場合，Name は有効なエリアスです。

注意

IsAlias と関連付けられるエリアスはセッションの ConfigMode プロパティで決定されます。 ConfigMode が cmAll の場合，すべてのエリアスがそのセッションで使用可能です。


TSession.ModifyAlias
TSession.ModifyAlias3373046

TSession	参照

ModifyAlias メソッドは，ボーランドデータベースエンジン（BDE）エリアスのパラメータを追加または変更できます。

procedure ModifyAlias(Name: string; List: TStrings);

説明

ModifyAlias メソッドを呼び出すと，指定した BDE エリアスのパラメータを変更できます。Name は修正するエリアスの名前です。List は追加または変更するパラメータ値を取得済みの文字列リストです。アプリケーションが List の作成および保守を行わなければなりません。

パラメータ文字列を List に追加してから ModifyAlias を呼び出してください。List には変更したいパラメータだけを指定します。ModifyAlias が既存の値にパラメータを渡した場合，新しいパラメータは既存のパラメータと置換されます。エリアスについて未定義のパラメータは既存のパラメータに追加されます。List が空の場合，ModifyAlias は既存のパラメータを変更しません。


TSession.Open
TSession.Open3373048

TSession	参照

Open メソッドは，セッションを開始してカレントセッションにします。

procedure Open;

説明

Open メソッドを呼び出すと，データベースアプリケーションでデフォルト以外のセッションを開始できます。Open は Active を True に設定して，OnStartup イベントハンドラを呼び出し NetFileDir プロパティ，PrivateDir プロパティ，および ConfigMode プロパティを初期化します。


TSession.OpenDatabase
TSession.OpenDatabase3373049

TSession	参照

OpenDatabase メソッドは,既存のデータベースを開くまたは一時データベースコンポーネントを作成してから開きます。あるいは，一時的なデータベースコンポーネントを作成してから開きます。

function OpenDatabase(const DatabaseName: string): TDatabase;

説明

OpenDatabase を呼び出すと，既存のデータベースコンポーネント用のデータベースへの接続，あるいは一時データベースコンポーネントを作成してからのデータベースへの接続が可能です。DatabaseName は開くデータベースを指定します。

OpenDatabase は，カレントセッションをアクティブにしてから，FindDatabase を呼び出して DatabaseName パラメータが既存のデータベースコンポーネントの DatabaseName プロパティに対応するかどうかを決めます。対応しない場合には OpenDatabase は一時データベースコンポーネントを作成して DatabaseName パラメータを DatabaseName プロパティに割り当てます。OpenDatabase はデータベースの Open メソッドを呼び出してデータベースに接続し，セッションのデータベース参照カウントを 1 つインクリメントします。


TSession.RemoveAllPasswords
TSession.RemoveAllPasswords3373050

TSession	参照

RemoveAllPasswords メソッドは，暗号化された Paradox テーブルにアクセスするカレントセッションに追加されているすべてのパスワードを削除します。

procedure RemoveAllPasswords;

説明

RemoveAllPasswords メソッドを呼び出すと，カレントセッションに関連付けられたカレント Paradox テーブルに対するすべてのパスワードを削除できます。暗号化された Paradox テーブルには，アプリケーションで AddPassword を呼び出してパスワードを再設定しないとアクセスできません。

注意

通常，アプリケーションは終了する前に RemoveAllPasswords を呼び出して，ボーランドデータベースエンジン（BDE）の持続的記憶から作成されたセッション固有のすべてのパスワードを削除しなければなりません。


TSession.RemovePassword
TSession.RemovePassword3373051

TSession	参照

RemovePassword メソッドは，暗号化された Paradox テーブルにアクセスするカレントセッションに追加されているパスワードを 1 個削除します。

procedure RemovePassword(const Password: string);

説明

RemovePassword メソッドを呼び出すと，カレントセッションに関連付けられた Paradox テーブルに対するパスワードを 1 個だけボーランドデータベースエンジン（BDE）の持続的記憶から削除できます。Paradox テーブルには，アプリケーションで AddPassword を呼び出してパスワードを再設定しないとアクセスできません。


TSession.SaveConfigFile
TSession.SaveConfigFile3373052

TSession	参照

SaveConfigFile メソッドは，ボーランドデータベースエンジン（BDE）の持続的記憶内の現在の情報をメモリからディスク上の BDE 環境設定ファイルへ書き込みます。

procedure SaveConfigFile;

説明

SaveConfigFile メソッドを呼び出すと，BDE 環境設定に対するすべての変更情報がメモリからディスク上の BDE 環境設定ファイルに書き込まれます。BDE が初期化されるときには現在の BDE 環境設定ファイルはメモリ内の持続的記憶に読み込まれます。アプリケーションはメモリ内の環境設定ファイルの読み込みまたは修正ができますが，修正できるのはメモリ上だけでディスクには書き込まれません。

たとえばアプリケーションが新しい BDE エリアスをAddAliasを使って作成する場合，エリアスがメモリ内にあるのは BDE がメモリ内に読み出されているだけです。BDE を使うすべてのアプリケーションが新しいエリアスを利用できるように保存するにはSaveConfigFile を呼び出してください。SaveConfigFile は持続的環境設定ファイルのメモリイメージを環境設定ファイルのディスクイメージに上書きします。

注意

セッションの ConfigMode プロパティが cmSession のときは,追加されたエリアスは BDE 環境設定ファイルに保存できません。


スコープ3373053

published

読み出し／書き込み

読み出し専用


スコープ3373054

published


継承3373055

TObject

TPersistent

TComponent


TSession 例3373056

TSession


TShape
TShape3374001

継承	プロパティ	メソッド	イベント	参照	例

TShape コンポーネントは，フォーム上に描画される幾何学図形を表します。

ユニット

extctrls

説明

TShape オブジェクトをフォームに追加するとフォームに簡単な幾何学図形を描画できます。TShape は，図形の輪郭を描くペンとその中を塗りつぶすのに使うブラシを設定するためのプロパティを提供します。

図形が TCustomControl オブジェクトのイメージの一部ならば，TShape の代わりにコントロールのキャンバスのメソッドを使います。


TShape プロパティ3374002

TShape	アルファベット順	凡例

TShape

Brush

Pen

Shape

TControl からの継承

Align

BoundsRect

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Height

Hint

Left

Name

Parent

ParentShowHint

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TShape プロパティ3374003

TShape	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlState

ControlStyle

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Height

Hint

Left

Name

Owner

Parent

ParentShowHint

Pen

Shape

ShowHint

Tag

Top

VCLComObject

Visible

Width

WindowProc


TShape.Brush
TShape.Brush3374004

TShape	参照

Brush プロパティは，図形コントロールを塗りつぶすのに使う色と模様を指定します。

property Brush: TBrush;

説明

Brush プロパティは，図形の内部を塗りつぶす色および模様を表す，TBrush オブジェクトを取得するために使われます。Brush のプロパティを使うと色と模様を変更できます。

Brush プロパティを使って TShape が管理する TBrush オブジェクトに別の TBrush オブジェクトを割り当てることができます。


TShape.Pen
TShape.Pen3374005

TShape	参照

Pen プロパティは，図形コントロールの輪郭の描画に使うペンを指定します。

property Pen: TPen;

説明

Pen プロパティは，図形の輪郭を描画するのに使う色およびスタイルを表す，TPen オブジェクトを取得するために使われます。Pen のプロパティを使うと色とスタイルを変更できます。

Pen プロパティを使って，TShape が管理する TPen オブジェクトに別の TPen オブジェクトを割り当てることができます。


TShape.Shape
TShape.Shape3374006

TShape

Shape プロパティは，コントロールの形状を指定します。

TShapeType = (stRectangle, stSquare, stRoundRect, stRoundSquare, stEllipse, stCircle);

property Shape: TShapeType;

説明

Shape プロパティは，フォームに表示する幾何学図形に Shape を設定するために使われます。以下に Shape プロパティの値と意味を示します。

値	意味

stCircle	図形は円である

stEllipse	図形は楕円である

stRectangle	図形は長方形である

stRoundRect	図形は角の丸い長方形である

stRoundSquare	図形は角の丸い正方形である

stSquare	図形は正方形である


TShape イベント3374007

TShape	アルファベット順	凡例

TControl からの継承

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TShape イベント3374008

TShape	オブジェクト順	凡例

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TShape メソッド3374009

TShape	アルファベット順

TShape

Create

Destroy

StyleChanged

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Invalidate

Perform

Refresh

Repaint

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

Tpersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TShape メソッド3374010

TShape	オブジェクト順

Assign

BeginDrag

BringToFront

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DragDrop

Dragging

EndDrag

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTextBuf

GetTextLen

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Perform

Refresh

RemoveComponent

Repaint

SafeCallException

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

StyleChanged

Update


TShape.Create
TShape.Create3374011

TShape	参照

Create メソッドは，TShape のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TShape オブジェクトをインスタンス化できます。設計時にフォームに追加された図形は自動的に作成されます。

Create はメモリを割り当てて，その図形の Height プロパティと Width プロパティを 65 に初期化します。


TShape.Destroy
TShape.Destroy3374012

TShape	参照

Destroy メソッドは，TShape のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TShape オブジェクトが解放されていないことを確認してから Destroy メソッドを呼び出します。


スコープ3374013

published

読み出し／書き込み

読み出し専用


スコープ3374014

published


継承3374015

TObject

TPersistent

TComponent

TControl

TGraphicControl


TShape 例3374016

TShape


TSharedImage
TSharedImage3375001

継承	メソッド	参照

TSharedImage は，グラフィックオブジェクトに使うイメージを格納するクラスの抽象基本クラスです。

ユニット

graphics

説明

TSharedImage は，ビットマップやアイコンなどのグラフィックイメージの内部表現を保持するクラスのための基本クラスとして使います。TSharedImage は抽象クラスです。その派生クラスは，Delphi グラフィックオブジェクトによって使用され，それらの関連グラフィックオブジェクトによって自動的に作成されます。


TSharedImage のメソッド3375002

TSharedImage	アルファベット順

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TSharedImage のメソッド3375003

TSharedImage	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3375004

TObject


TSharedImage の例3375005

TSharedImage


TSmallIntArray
TSmallIntArray3376001

継承	プロパティ	メソッド	参照

TSmallIntArray は動的にサイズ変更可能な 16 ビット整数の配列です。

ユニット

mxarrays

説明

TSmallIntArray を使うと，配列内の要素の数が不明な場合に short 型整数の配列を表示できます。たとえば，デシジョンキューブは TSmallIntArray オブジェクトを使って集計値のマルチディメンションキャッシュ内のセルの座標を表示します。


TSmallIntArray のプロパティ3376002

TSmallIntArray	アルファベット順	凡例

TSmallIntArray

Items

TBaseArray からの継承

AutoSize

Capacity

CompareProc

Count

Duplicates

ItemSize

Limit

List

SortOrder


TSmallIntArray のプロパティ3376003

TSmallIntArray	オブジェクト順	凡例

AutoSize

Capacity

CompareProc

Count

Duplicates

ItemSize

Items

Limit

List

SortOrder


TSmallIntArray.Items
TSmallIntArray.Items3376004

TSmallIntArray	参照

Items プロパティは，配列内のすべての要素のをインデックス配列です。

property Items[ Index:Integer ]: SmallInt; default;

説明

Items プロパティは，Index パラメータで指定された要素の値を取得および設定できます。Index パラメータは，0 が 配列内の最初の要素を示し，1 が 2 番目のパラメータを示すというように続きます。Items は TSmallIntArray 用のデフォルトプロパティであるため，Items プロパティを使うときはその名前を指定する必要はありません。つまり，次の行の

FirstInt := SmallIntArray1.Items[0];

は以下のように記述できます。

FirstInt := SmallIntArray1[0].


TSmallIntArray のメソッド3376005

TSmallIntArray	アルファベット順

TSmallIntArray

Add

Assign

Create

GetItem

PutItem

TBaseArray からの継承

Clear

Delete

Destroy

Exchange

FindItem

IndexOf

Insert

InsertAt

RemoveItem

Sort

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TSmallIntArray のメソッド3376006

TSmallIntArray	オブジェクト順

Add

Assign

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Delete

Destroy

Dispatch

Exchange

FieldAddress

FindItem

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetItem

GetNamePath

IndexOf

InheritsFrom

InitInstance

InsertAt

Insert

InstanceSize

MethodAddress

MethodName

NewInstance

PutItem

RemoveItem

SafeCallException

Sort


TSmallIntArray.Add
TSmallIntArray.Add3376007

TSmallIntArray	参照

Add メソッドは，配列に新しい要素を追加します。

function Add( Value: SmallInt ): Integer;

説明

Add メソッドを呼び出すと，ソートされていない配列の末尾や，ソート済みの配列の適切な位置に項目を追加できます。配列内の指定された位置に要素を挿入するには，Add のかわりに Insert メソッドを使います。

注意

Add はソート済みの配列が昇順にソートされていることを前提としています。SortOrder が TS_DESCENDING である配列で Add を使うには，一時的に CompareProc プロパティを CompareProc で返される値に -1 を掛ける関数に変更します。


TSmallIntArray.Assign
TSmallIntArray.Assign3376008

TSmallIntArray	参照

Assign メソッドは，別の TSmallIntArray オブジェクトの Items プロパティをコピーします。

procedure Assign( Source: TPersistent ); override;

説明

Assign メソッドを呼び出すと，別のオブジェクトから配列をコピーできます。Source パラメータが TSmallIntArray オブジェクトである場合，Assign は Items プロパティをソース配列の配列で置き換えます。それ以外の場合，Assign は AssignTo メソッドで TSmallIntArray を処理する Source オブジェクトの値を割り当てる継承されたメソッドを呼び出します。

注意

Assign は要素のリストだけを変更し，AutoSize，Capacity，CompareProc，Duplicates，または SortOrder の各プロパティはコピーしません。AutoSize プロパティが False の場合， Capacity の値は少なくともソース配列の Count プロパティよりも大きい値である必要があります。配列がソート済みの場合は，ソース項目がソートされた順序で表示されます。Duplicates プロパティが dupAccept ではない場合，複製された要素はソース配列からコピーされません。


TSmallIntArray.Create
TSmallIntArray.Create3376009

TSmallIntArray	参照

Create メソッドは，TSmallIntArray のインスタンスを作成します。

constructor Create( Itemcount, iSize: Integer ); virtual;

説明

Create メソッドを呼び出すと，TSmallIntArray オブジェクトを作成し初期化できます。Create は Capacity プロパティを Itemcount に設定して iSize パラメータは無視します。

Create は以下のプロパティも初期化します。

・	ItemSize は 2 に設定される（small 型整数のサイズ）

・	CompareProc は 2 つの 16 ビット整数の差を返す関数に初期化される

・	AutoSize は True に設定される

・	Count は 0 に設定される


TSmallIntArray.GetItem
TSmallIntArray.GetItem3376010

TSmallIntArray	参照

GetItem メソッドは，指定された位置の整数を返します。

function GetItem(Index: Integer): SmallInt;

説明

GetItem メソッドを呼び出すと，配列内の整数値を取得できます。Index パラメータは配列の要素を示し，最初の要素はインデックス 0 を持ち，2 番目の要素はインデックス 1を持つというように続きます。


TSmallIntArray.PutItem
TSmallIntArray.PutItem3376011

TSmallIntArray	参照

PutItem メソッドは，配列内の要素の値を置き換えます。

procedure PutItem( Index: Integer; Value: SmallInt );

説明

PutItem メソッドを呼び出すと，整数の値を Value の値に変換できます。Insert メソッドとは異なり，PutItem は配列に新しい要素は追加しませんが，既存の要素の値を置き換えます。Index パラメータは変更する要素を示し，0 は最初の要素，1 は 2 番目の要素というように指定します。

注意

Index を Count プロパティの値に設定して PutItem を呼び出すと，配列の末尾に新しい要素が追加されます。これは PutItem が既存の要素を置き換えずに新しい要素を追加する唯一の例です。


アクセス種別3376012

読み出し専用


継承3376013

TObject

TPersistent

TBaseArray


TSmallIntArray の例3376014

TSmallIntArray


TSmallintField
TSmallintField3377001

継承	プロパティ	メソッド	イベント	参照

TSmallintField オブジェクトは，データセット内の符号付き 16 ビット整数型項目を表します。

ユニット

db

説明

Smallint 項目は，-32768 から 32767 の範囲の値を保持できるので，符号付き 16 ビット整数の保持に使われます。

TSmallIntField オブジェクトとその直接の上位オブジェクトである TIntegerField オブジェクトの違いは，表すデータ形式のみです。コンストラクタ以外のすべてのプロパティ，メソッド，およびイベントは TIntegerField オブジェクトと同じで，データベース内の整数型項目の値およびプロパティの管理に便利な機能を提供しています。


TSmallintField プロパティ3377002

TSmallintField	アルファベット順	凡例

TSmallintField

DataSize

TIntegerField からの継承

AsFloat

AsInteger

AsString

AsVariant

MaxValue

MinValue

Value

TNumericField からの継承

DisplayFormat

EditFormat

TField からの継承

Alignment

AsBoolean

AsCurrency

AsDateTime

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TSmallintField プロパティ3377003

TSmallintField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayFormat

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditFormat

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

MaxValue

MinValue

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TSmallintField.DataSize
TSmallintField.DataSize3377004

TSmallintField	参照

DataSize プロパティは，ネイティブなデータベース形式で Smallint 項目の値を格納するのに必要なメモリの大きさです。

property DataSize: Word;

説明

DataSize プロパティは，Smallint 項目コンポーネントの値を格納するのに何バイト必要かを取得できます。GetData や SetData メソッドと共にこのプロパティを使うと，必要なバッファの大きさを決めることができます。

Smallint 項目の DataSize は常に 2 です。これはデータベーステーブルの 16 ビット整数値の大きさで，TSmallintField が整数値を格納したり操作したりするのに使う Longint データ型の大きさではありません。


TSmallintField イベント3377005

TSmallintField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TSmallintField イベント3377006

TSmallintField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TSmallintField メソッド3377007

TSmallintField	アルファベット順

TSmallintField

Create

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

InBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TSmallintField メソッド3377008

TSmallintField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InBlob

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TSmallintField.Create
TSmallintField.Create3377009

TSmallintField	参照

Create メソッドは，TSmallintField オブジェクトのインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを直接呼び出す必要はほとんどありません。Smallint 項目オブジェクトは，データセット内のすべての Smallint 項目について自動的にインスタンス化されるからです。

継承コンストラクタを呼び出した後で，Create メソッドは次の値を設定します。

・	DataType プロパティは ftSmallint

・	MinValue プロパティは -32768

・	MaxValue プロパティは 32767


スコープ3377010

published

読み出し／書き込み

読み出し専用


スコープ3377011

published


継承3377012

TObject

TPersistent

TComponent

TField

TNumericField

TIntegerField


TSmallintField 例3377013

TSmallintField


TSimpleEvent
TSimpleEvent3378001

継承	プロパティ	メソッド	参照

TSimpleEvent は名前のないマニュアルイベントオブジェクトです。

ユニット

syncobjs

説明

TSimpleEvent を使うと，同一の単純なイベントオブジェクトにアクセスするスレッド間の調整を行うことができます。シングルスレッドのアプリケーションでは，TSimpleEvent を使って，異なる非同期イベント（Windows メッセージやユーザーのアクションなど）に応答するコードのセクションを調整することもできます。

TSimpleEvent は名前のないイベントオブジェクトなので，1 個の TSimpleEvent オブジェクトは，そのオブジェクトを使う全コードのスコープ内になければなりません。スコープ外のコードやほかのアプリケーションとの調整には，名前の付いたイベントオブジェクト TEvent を使います。


TSimpleEvent プロパティ3378002

TSimpleEvent	アルファベット順	凡例

THandleObject からの継承

Handle

LastError


TSimpleEvent プロパティ3378003

TSimpleEvent	オブジェクト順	凡例

Handle

LastError


TSimpleEvent メソッド3378004

TSimpleEvent	アルファベット順

TSimpleEvent

Create

TEvent からの継承

ResetEvent

SetEvent

WaitFor

THandleObject からの継承

Destroy

TSynchroObject からの継承

Acquire

Release

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TSimpleEvent メソッド3378005

TSimpleEvent	オブジェクト順

Acquire

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Release

ResetEvent

SafeCallException

SetEvent

WaitFor


TSimpleEvent.Create
TSimpleEvent.Create3378006

TSimpleEvent	参照

Create メソッドは，Windows のイベントオブジェクトを作成し，TSimpleEvent オブジェクトをインスタンス化してそのイベントを表します。

constructor Create;

説明

Create を呼び出すと，TSimpleEvent オブジェクトを作成できます。Create は 名前のない Windows マニュアルイベントオブジェクトを作成します。イベントはアンセット状態で開始されます。

Handle プロパティは，イベントオブジェクトに対する Windows ハンドルに初期化されます。


読み出し／書き込み3378007

読み出し専用


継承3378008

TObject

TSynchroObject

THandleObject

TEvent


TSimpleEvent 例3378009

TSimpleEvent


TSpeedButton
TSpeedButton3380001

継承	プロパティ	メソッド	イベント	参照

TSpeedButton コンポーネントは，ユーザーがコマンドの実行またはモードの設定に使うボタンです。

ユニット

buttons

説明

TSpeedButton コンポーネントは，フォーム内のボタングループにボタンを追加します。TSpeedButton は，ボタンのさまざまな状態（選択，非選択，使用不可など）を表現するグラフィックイメージを設定するために使うプロパティを導入します。あるいは，複数のイメージを指定したり，ボタン上でイメージおよびテキストを表示するプロパティもあります。TSpeedButton には，スピードボタンを 1 つのまとまりとして機能させるプロパティもあります。スピードボタンは一般に，特殊なツールバーやツールパレットを作成するためにパネル（TPanel）でグループ化されます。


TSpeedButton プロパティ3380002

TSpeedButton	アルファベット順	凡例

TSpeedButton

AllowAllUp

Down

Flat

Glyph

GroupIndex

Layout

Margin

NumGlyphs

Spacing

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Font

Height

Hint

Left

Name

Parent

ParentFont

ParentShowHint

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TSpeedButton プロパティ3380003

TSpeedButton	オブジェクト順	凡例

Align

AllowAllUp

BoundsRect

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlState

ControlStyle

Cursor

DesignInfo

Down

Enabled

Flat

Font

Glyph

GroupIndex

Height

Hint

Layout

Left

Margin

Name

NumGlyphs

Owner

Parent

ParentFont

ParentShowHint

ShowHint

Spacing

Tag

Top

VCLComObject

Visible

Width

WindowProc


TSpeedButton.AllowAllUp
TSpeedButton.AllowAllUp3380004

TSpeedButton	参照

AllowAllUp プロパティは，スピードボタンが入っているグループ内のすべてのスピードボタンを一度に選択解除できるかどうかを示します。

property AllowAllUp: Boolean;

説明

AllowAllUp プロパティは，同じグループに属するボタングループとともに使います。GroupIndex プロパティに同じ値を持つスピードボタンは同じグループに属します。同じグループに入っているボタンは互いに排他的に動作します。つまり，グループ内の 1 つのボタンを選択する（押した状態）と，他のボタンはすべて選択解除（押されていない状態）されます。AllowAllUp が True の場合，グループ内のすべてのスピードボタンを同時に選択解除できます。グループで選択されている 1 つのボタンをクリックすると，別のボタンを選択しなくてもそのボタンを選択解除できます。AllowAllUp が False の場合，グループ内で常に 1 つのボタンが選択されていなければなりません。押されているボタンをクリックしても押されていない状態に戻りません。

グループ内で 1 つのスピードボタンの AllowAllUp プロパティの値を変更すると，そのグループのすべてのボタンの AllowAllUp 値が変わります。

注意

GroupIndex が 0 ならば，AllowAllUp は無効です。


TSpeedButton.Down
TSpeedButton.Down3380005

TSpeedButton	参照

Down プロパティは，スピードボタンが押されていない（選択していない）状態または押された（選択した）状態のどちらかを示します。

property Down: Boolean;

説明

Down プロパティは，スピードボタンが選択されているかどうかを示します。Down プロパティは，GroupIndex プロパティが 0 でない場合にのみ有効です。

GroupIndex が 0 より大きい場合，Down を True に設定するとボタンを選択できます。ユーザーが未選択状態（上がった状態）のボタンをクリックすると，そのボタンは選択され，Down が True に設定されます。ユーザーが選択状態（押された状態）のボタンをクリックすると，AllowAllUp が True の場合，そのボタンは選択解除され，Down が False に設定されます。

設計時には，グループでどのボタンを最初から選択された状態にするのかを，そのボタンの Down プロパティを True に設定することで指定します。

注意

GroupIndex が 0 の場合，ボタンをクリックすると選択状態が解除されます。


TSpeedButton.Flat
TSpeedButton.Flat3380006

TSpeedButton	参照

Flat プロパティは，ボタンが下がったように見えたり，上がったように見えたりする 3 次元の境界をボタンに付けるかどうかを指定します。

property Flat: Boolean;

説明

Flat を True に設定すると，ボタンを選択していないときに上がったように見える境界を削除し，ボタンがクリック（選択）されたときに下がったように見える境界を削除できます。Flat が True の場合，ボタンの状態に合わせてそれぞれ別のビットマップを使うとボタンの状態をユーザーにわかりやすく示すことができます。


TSpeedButton.Glyph
TSpeedButton.Glyph3380007

TSpeedButton	参照

Glyph プロパティは，スピードボタンに表示するビットマップを指定します。

property Glyph: TBitmap;

説明

Glyph プロパティは，ボタンの表面に表示するイメージを格納するビットマップオブジェクトを設定します。オブジェクトインスペクタで［ファイルを開く］ダイアログボックスを開くと，ビットマップファイル（.BMP 拡張子が付いているファイル）を選択したり，実行時にビットマップファイルを指定したりできます。

Glyph は 1 つのビットマップでビットマップボタンまたはスピードボタンに指定できるイメージを 4 つまで提供できます。TSpeedButton は指定したイメージのいずれか 1 つをボタンの状態に従って表示します。

ビットマップ内の

イメージの位置	ボタンの状態	説明

最初	上がっている	ボタンを選択していないときのイメージ。ビットマップ以外に他のイメージがない場合，それ以外のどのイメージにもこのイメージが使われる

2 番目	使用不可	ボタンを選択できないことを示すイメージ。淡色表示される

3 番目	クリック	ボタンをクリックしたときのイメージ。GroupIndex が 0 ならば，マウスボタンから指を離すと上がった状態のイメージに戻る

4 番目	下がっている	ボタンを押し下げたままのときのイメージ。選択されたままであることを示す

TSpeedButton は，イメージが 1 つだけの場合は，下がっている状態も上がっている状態と同じイメージを使いますが，他の状態については応じてイメージを少し変えて，その状態になったことを表そうとします。

ビットマップに複数のイメージがある場合，NumGlyphs プロパティを使ってビットマップ内のイメージの数を指定してください。イメージはどれも同じサイズで，横に一列に並んでいなくてはなりません。

注意

ビットマップの左下のピクセルは「透過」色用に予約されています。ビットマップで左下に位置するピクセルはすべて透過になります。


TSpeedButton.GroupIndex
TSpeedButton.GroupIndex3380008

TSpeedButton	参照

GroupIndex プロパティは，スピードボタンが 1 つのまとまりとして機能できるようにします。

property GroupIndex: Integer;

説明

GroupIndex プロパティは，ボタンがクリックされたときのボタンの動作を示します。

GroupIndex が 0 の場合，ボタンはそのフォームの他のボタンと独立して動作します。ユーザーがそのようなボタンをクリックすると，ボタンは押された状態（クリックされた状態）として表示され，マウスのボタンを離すと通常の押されていない状態に戻ります。

GroupIndex が 0 より大きい場合，ユーザーがクリックするとボタンは選択された状態（下がった状態）のままです。ユーザーが選択されているボタンをクリックすると，AllowAllUp が False でないかぎり元の上がった状態に戻ります。1 つのスピードボタンの GroupIndex プロパティを 0 より大きな値に設定すると，AllowAllUp が True の場合にそのボタンを 2 つの状態を持つボタンとして動作させることができます。

GroupIndex プロパティの値（0 以外の値）が同じスピードボタンは 1 つのグループとして機能します。グループのボタンを 1 つクリックすると，そのボタンは同じグループの別のスピードボタンをクリックするまで押された状態のままです。スピードボタンは同時には選択できない項目として使えます。


TSpeedButton.Layout
TSpeedButton.Layout3380009

TSpeedButton	参照

Layout プロパティは，ビットマップボタンまたはスピードボタンのどこにイメージまたはテキストを表示するか示します。

TButtonLayout = (blGlyphLeft, blGlyphRight, blGlyphTop, blGlyphBottom);

property Layout: TButtonLayout;

説明

Layout プロパティは，Glyph プロパティで指定されたビットマップまたは Caption プロパティで指定されたテキストの位置を示します。次の値を指定できます。

値	意味

blGlyphLeft	ボタンの左端にイメージが表示される

blGlyphRight	ボタンの右端にイメージが表示される

blGlyphTop	ボタンの上部にイメージが表示される

blGlyphBottom	ボタンの下部にイメージが表示される


TSpeedButton.Margin
TSpeedButton.Margin3380010

TSpeedButton	参照

Margin プロパティは，ボタンの表面に描画するイメージまたはテキストとボタンの端までとのピクセル数を示します。

property Margin: Integer;

説明

Margin プロパティは，Glyph プロパティで指定されたイメージまたは Caption プロパティで指定されたテキストのインデントを示します。Margin とその両端の関係は Layout プロパティによって決まります。Layout が blGlyphLeft ならば，マージンはイメージまたはキャプションの左端とボタンの端の間にあります。Layout が blGlyphRight ならば，マージンは右側にあります。Layout が blGlyphTop ならば，マージンは上側に，また Layout が blGlyphBottom ならば，マージンは下側にあります。

Margin が -1 ならば，イメージまたはテキストはボタンの中央に位置揃えされます。


TSpeedButton.NumGlyphs
TSpeedButton.NumGlyphs3380011

TSpeedButton	参照

NumGlyphs プロパティは，Glyph プロパティで指定されたイメージの数を示します。

TNumGlyphs: 1..4;

property NumGlyphs: TNumGlyphs;

説明

NumGlyphs プロパティは，Glyph プロパティに割り当てられたビットマップに提供されるイメージの数に設定します。イメージはすべて同じサイズで 1 行に隣り合って並んでいなくてはなりません。Glyphs プロパティは 4 つまでのイメージを提供できます。


TSpeedButton.Spacing
TSpeedButton.Spacing3380012

TSpeedButton	参照

Spacing プロパティは，イメージとテキストをスピードボタンのどの場所に表示するかを示します。

property Spacing: Integer;

説明

Spacing プロパティは，Glyph プロパティで指定されたイメージと Caption プロパティで指定されたテキストの間のピクセル数を示します。

Spacing が正数ならば，その値はイメージとテキストの間のピクセル数です。Spacing が 0 ならば，イメージとテキストは端と端を合わせて表示されます。Spacing が -1 ならば，テキストはイメージとボタンの端との中間に表示されます。


TSpeedButton イベント3380013

TSpeedButton	アルファベット順	凡例

TControl からの継承

OnClick

OnDblClick

OnMouseDown

OnMouseMove

OnMouseUp


TSpeedButton イベント3380014

TSpeedButton	オブジェクト順	凡例

OnClick

OnDblClick

OnMouseDown

OnMouseMove

OnMouseUp


TSpeedButton メソッド3380015

TSpeedButton	アルファベット順

TSpeedButton

Click

Create

Destroy

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Invalidate

Perform

Refresh

Repaint

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TSpeedButton メソッド3380016

TSpeedButton	オブジェクト順

Assign

BeginDrag

BringToFront

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Click

ClientToScreen

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DragDrop

Dragging

EndDrag

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTextBuf

GetTextLen

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Perform

Refresh

RemoveComponent

Repaint

SafeCallException

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update


TSpeedButton.Click
TSpeedButton.Click3380017

TSpeedButton	参照

Click メソッドは，OnClick イベントを発生させます。

procedure Click; override;

説明

Click メソッドを呼び出すと， OnClick イベントを発生することができます。スピードボタンに OnClick イベントハンドラがある場合，Click はアプリケーションにそのボタンをクリックしたときと同じ動作をさせることができます。


TSpeedButton.Create
TSpeedButton.Create3380018

TSpeedButton	参照

Create メソッドは，TSpeedButton のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にスピードボタンを作成できます。設計時にフォームに配置されたスピードボタンは自動的に作成されます。継承されたコンストラクタの呼び出し後，Create は次の値を初期化します。

・	ControlStyle を [csCaptureMouse, csOpaque, csDoubleClicks] に設定する

・	Height と Width をいずれも 25 に設定する

・	Layout を blGlyphLeft に設定する

・	Margin を -1 に，Spacing を 4 に設定する

・	ParentFont を True に設定する


TSpeedButton.Destroy
TSpeedButton.Destroy3380019

TSpeedButton	参照

Destroy メソッドは，TSpeedButton のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは Destroy を直接呼び出さないでください。代わりに Free を呼び出します。Free はスピードボタンがすでに解放されていないことを確認してからのみ Destroy メソッドを呼び出します。


スコープ3380020

published

読み出し／書き込み

読み出し専用


スコープ3380021

published


継承3380022

TObject

TPersistent

TComponent

TControl

TGraphicControl


TSpeedButton 例3380023

TSpeedButton


TSplitter
TSplitter3381001

継承	プロパティ	メソッド	イベント	参照

TSplitter は，フォームのクライアント領域をサイズ変更可能なペインに分割します。

ユニット

extctrls

説明

フォーム上に揃えた 2 つのコントロールの間にスプリッタを追加すると，ユーザーは実行時にその 2 つのコントロールをサイズ変更できるようになります。スプリッタは，フォームの端の 1 つに揃えたコントロールと，クライアント領域の残りの部分を占めるコントロール群の間に配置されます。スプリッタを，フォームの一端に固定したコントロールと同じ配置にします。ユーザーがスプリッタを移動すると，それによって固定されたコントロールのサイズが変更されます。これが今度は，フォームのクライアント領域を変更し，それに呼応してクライアント領域の残りを占めるコントロール群がサイズ変更されます。

フォーム上の各コントロールを別々のペインとして使います。各ペインの位置を決めたら，そのペインをサイズ変更できるように同じ位置合わせでスプリッタを配置します。フォーム上に配置する最後のペインについてはクライアント揃えにしなければなりません。これで，それ以外のすべてのペインがサイズ変更されると，最後のペインが残りの空間を占めるように自動的にサイズ変更されます。


TSplitter プロパティ3381002

TSplitter	アルファベット順	凡例

TSplitter

Beveled

MinSize

TControl からの継承

Align

BoundsRect

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ParentColor

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TSplitter プロパティ3381003

TSplitter	オブジェクト順	凡例

Align

Beveled

BoundsRect

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Height

Hint

Left

MinSize

Name

Owner

Parent

ParentColor

ShowHint

Tag

Top

VCLComObject

Visible

Width

WindowProc


TSplitter.Beveled
TSplitter.Beveled3381004

TSplitter	参照

Beveled プロパティは，スプリッタが移動する端に沿ってベベルに見えるかどうかを指定します。

property Beveled: Boolean;

説明

Beveled プロパティを False に設定すると，スプリッタからベベルの端を除去できます。Beveled を True に設定すると，端に 3 次元のベベルの外観を与えられます。

スプリッタのベベルは一方向にしか付きません。つまり，ユーザーが隣接するオブジェクトをサイズ変更するために動かす端に沿って付けられます。このため，Align プロパティが alLeft または alRight のときは，スプリッタの左右にベベルが付きます。Align プロパティが alTop または alBottom のときは，スプリッタの上下にベベルが付きます。


TSplitter.MinSize
TSplitter.MinSize3381005

TSplitter	参照

MinSize プロパティは，スプリッタがフォーム上に残さなければならないクライアント領域の最小サイズをピクセル単位で示します。

NaturalNumber = 1..High(Integer);

property MinSize: NaturalNumber;

説明

MinSize プロパティを設定すると，その隣接するコントロールをサイズ変更するときにスプリッタが残さなければならない最小サイズを提供できます。たとえば Align プロパティが alLeft の場合，MinSize はスプリッタの左右領域の最小幅を表します。Align プロパティが alTop のときは，MinSize はスプリッタの上下の領域の最小の高さを表します。


TSplitter イベント3381006

TSplitter	アルファベット順	凡例

TSplitter

OnMoved


TSplitter イベント3381007

TSplitter	オブジェクト順	凡例

OnMoved


TSplitter.OnMoved
TSplitter.OnMoved3381008

TSplitter	参照

OnMoved イベントは，ユーザーがスプリッタを使ってフォームのタイル表示を変更した後で発生します。

TNotifyEvent = procedure (Sender: TObject) of object;

property OnMoved: TNotifyEvent;

説明

OnMoved イベントハンドラを記述すると，ユーザーがスプリッタを使って隣接するコントロールの端をドラッグし終えたときに特定のアクションを実行できます。たとえばフォーム端のコントロールをサイズ変更した後で，フォームの新しいクライアント領域のレイアウトを更新するために OnMoved イベントハンドラを使います。また，フォームの ClientRect プロパティを使うと，残りの領域のサイズを更新できます。


TSplitter メソッド3381009

TSplitter	アルファベット順	凡例

TSplitter

Create

MouseDown

MouseMove

MouseUp

Paint

StopSizing

TGraphicControl からの継承

Destroy

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Invalidate

Perform

Refresh

Repaint

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TSplitter メソッド3381010

TSplitter	オブジェクト順	凡例

Assign

BeginDrag

BringToFront

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DragDrop

Dragging

EndDrag

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTextBuf

GetTextLen

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Invalidate

MethodAddress

MethodName

MouseDown

MouseMove

MouseUp

NewInstance

Paint

Perform

Refresh

RemoveComponent

Repaint

SafeCallException

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

StopSizing

Update


TSplitter.Create
TSplitter.Create3381011

TSplitter	参照

Create メソッドは，TSplitter のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create を呼び出すと，実行時にスプリッタのインスタンスを作成できます。設計時にフォーム上に配置された TSplitter オブジェクトは自動的に作成されます。

Create は TSplitter オブジェクトのメモリを割り当てて，以下のプロパティを初期化します。

・	Beveled は True

・	MinSize は 30

・	Align は alLeft

・	Width は 3

・	Cursor は crHSplit


TSplitter.MouseDown
TSplitter.MouseDown3381012

TSplitter	参照

MouseDown メソッドは，スプリッタでサイズ変更できるコントロールを動的に特定します。

procedure MouseDown(Button: TMouseButton; Shift: TShiftState; X, Y: Integer); override;

説明

継承メソッドを呼び出した後に，MouseDown はこれからサイズ変更されるコントロールを特定します。このコントロールは動的に特定されるため，アプリケーションはスプリッタの隣に位置合わせされたコントロールを実行時に削除または追加できますし，スプリッタは現在その隣にあるコントロールならどれでもサイズ変更します。


TSplitter.MouseMove
TSplitter.MouseMove3381013

TSplitter	参照

MouseMove メソッドは，隣接するコントロールがどのようなサイズに変更されるかをビジュアルに表します。

procedure MouseMove(Shift: TShiftState; X, Y: Integer); override;

説明

継承メソッドを呼び出した後で，MouseMove は隣接するコントロールの新しい境界を計算して，新しい端の位置に線を描画します。ただし，コントロールが実際にサイズ変更されるのは，マウスが離された後です。


TSplitter.MouseUp
TSplitter.MouseUp3381014

TSplitter	参照

MouseUp メソッドは，ユーザーがマウスを離したときに隣接するコントロールをサイズ変更します。

procedure MouseUp(Button: TMouseButton; Shift: TShiftState; X, Y: Integer); override;

説明

継承メソッドを呼び出した後で，MouseUp はマウスが離された時点で特定された隣接コントロールをサイズ変更します。コントロールがサイズ変更された後で，MouseUp は OnMoved イベントを生成します。


TSplitter.Paint
TSplitter.Paint3381015

TSplitter	参照

Paint メソッドは，ペイントメッセージへの応答としてスプリッタのイメージを描画します。

procedure Paint; override;

説明

スプリッタは WM_PAINT メッセージをその Parent から受け取ると，Paint メソッドを呼び出します。Paint はスプリッタの背景色を描いて，Beveled が True の場合には移動可能な端に沿ってベベルを描画します。


TSplitter.StopSizing
TSplitter.StopSizing3381016

TSplitter	参照

StopSizing メソッドは，スプリッタがその隣接するコントロールをサイズ変更した後でクリーンアップを実行します。

procedure StopSizing;

説明

このプロテクト手続きは，ユーザーがスプリッタでコントロールのサイズを変更しているときにマウスを放したり Escape キーを押したりしたときに呼び出されます。StopSizing は，サイズ変更線を非表示にして OnMoved イベントを生成します。


スコープ3381017

published

読み出し／書き込み

読み出し専用


スコープ3381018

protected


スコープ3381019

published


継承3381020

TObject

TPersistent

TComponent

TControl

TGraphicControl


TSplitter 例3381021

TSplitter


TServerClientThread
TServerClientThread3382001

継承	プロパティ	メソッド	イベント	参照

TServerClientThread は，Windows サーバーソケットによって受け入れられたクライアントソケットへの単一の接続で使用される実行スレッドです。

ユニット

scktcomp

説明

TServerWinSocket オブジェクトは，別々の実行スレッドで個々のクライアント接続を処理するための TServerClientThread オブジェクトを生成します。このため，サーバーソケットはほかの接続の処理効率にあまり悪影響を及ぼすことなく，クライアントソケットとの間の回線速度が低速でも読み書き処理を実行できるようになります。

TServerClientThread は以下の処理を行うための新しいプロパティを備えています。

・	スレッドおよびクライアントソケットに接続されている TServerClientWinSocket を生成した TServerWinSocket オブジェクトにアクセスする

・	スレッド固有のデータを格納およびアクセスする

・	TServerWinSocket によって保持されているスレッドキャッシュにスレッドを格納するかどうかを指定する


TServerClientThread プロパティ3382002

TServerClientThread	アルファベット順	凡例

TServerClientThread

ClientSocket

Data

KeepInCache

ServerSocket

TThread からの継承

FreeOnTerminate

Handle

Priority

Suspended

ThreadID


TServerClientThread プロパティ3382003

TServerClientThread	オブジェクト順	凡例

ClientSocket

Data

FreeOnTerminate

Handle

KeepInCache

Priority

ServerSocket

Suspended

ThreadID


TServerClientThread.ClientSocket
TServerClientThread.ClientSocket3382004

TServerClientThread	参照

ClientSocket プロパティは，ソケット接続間で読み書きを行う，スレッドを使用する TServerClientWinSocket オブジェクトです。

ClientSocket は，ソケット接続でのすべての読み書きにそのスレッドを使用する TServerClientWinSocket オブジェクトです。

property ClientSocket: TServerClientWinSocket;

説明

ClientSocket プロパティを使うと，スレッドを使用する Windows ソケットコンポーネントへ直接アクセスできます。ClientSocket が nil ならば，そのスレッドはアイドルであり，別の TServerClientWinSocket オブジェクトによって再使用可能です。TServerClientThread は ClientSocket を使用してソケット接続との間で読み書きを行います。


TServerClientThread.Data
TServerClientThread.Data3382005

TServerClientThread	参照

Data プロパティは，スレッドに関連付けられているアプリケーション固有のデータへのポインタです。

property Data: Pointer;

説明

Data プロパティは，情報をスレッドオブジェクトに関連付けることができます。Data プロパティは，スレッドが保障される方法で情報を格納できるので，グローバル変数を使用する必要はありません。


TServerClientThread.KeepInCache
TServerClientThread.KeepInCache3382006

TServerClientThread	参照

KeenInCache プロパティは，ServerSocket が管理するスレッドキャッシュにスレッドを保持するかどうかを決めるものです。

KeepInCache プロパティは，ServerSocket によって保持されるスレッドキャッシュにスレッドを格納するかどうかを指定します。

property KeepInCache: Boolean;

説明

クライアントソケットへの接続のためにサーバークライアントスレッドを生成するTServerWinSocket は，再使用できるサーバークライアントスレッドのキャッシュを保持します。サーバークライアントスレッドがアクティブ化されると，TServerWinSocket オブジェクトは，そのスレッドがスレッドキャッシュ内に入るかどうかを示す KeepInCache プロパティを設定します。

KeepInCache プロパティが True ならば，そのスレッドが終了する前に FreeOnTerminate プロパティが False に設定され，そのスレッドがスレッドキャッシュ内に残されます。KeepInCache が False ならば，そのスレッドは実行が終了したら解放されます。


TServerClientThread.ServerSocket
TServerClientThread.ServerSocket3382007

TServerClientThread	参照

ServerSocket プロパティは，すべての TServerClientThread オブジェクトを管理する TServerWinSocket オブジェクトです。

ServerSocket プロパティは，クライアント接続用のすべての TServerClientThread オブジェクトを管理する TServerWinSocket オブジェクトです。

property ServerSocket: TServerWinSocket;

説明

ServerSocket プロパティは，受け入れたクライアント接続用のスレッドを生成したリスニング Windows ソケットオブジェクトへ直接アクセスできます。TServerClientThread は ServerSocket に割り当てられている適切なイベントハンドラにイベントおよびエラーを渡します。TServerClientThread は自分のコンストラクタから ServerSocket によって保持されているスレッドのキャッシュに自分自身を追加し，スレッドが終了したら自分自身を削除します。


TServerClientThread イベント3382008

TServerClientThread	アルファベット順

TThread からの継承

OnTerminate


TServerClientThread イベント3382009

TServerClientThread	オブジェクト順

OnTerminate


TServerClientThread メソッド3382010

TServerClientThread	アルファベット順

TServerClientThread

Create

Destroy

TThread からの継承

Resume

Suspend

Terminate

WaitFor

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TServerClientThread メソッド3382011

TServerClientThread	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Resume

SafeCallException

Suspend

Terminate

WaitFor


TServerClientThread.Create
TServerClientThread.Create3382012

TServerClientThread	参照

Create メソッドは，TServerClientThread のインスタンスを作成します。

constructor Create(CreateSuspended: Boolean; ASocket: TServerClientWinSocket);

説明

Create メソッドを呼び出すと，クライアントソケットへの接続のための TServerClientThread のインスタンスを作成し，関連付けられているリスニングソケットによって保持されているキャッシュにそのスレッドを追加できます。

Create メソッドは以下の処理を実行します。

・	FreeOnTerminate プロパティを True に初期化する

・	Priority プロパティを tpHigher に初期化する

・	ClientSocket プロパティを ASocket パラメータに初期化し，ServerSocket プロパティを ASocket.ServerWinSocket に初期化する

・	スレッドの実行を開始する

・	ServerSocket によって保持されているキャッシュにスレッドを追加する

・	ClientSocket の OnErrorEvent および OnSocketEvent イベントハンドラを設定して，イベントが ServerSocket に送信されるようにする

・	初期化が完了し，スレッドがクライアント接続との間で読み書きを行えるようになったことを通知する


TServerClientThread.Destroy
TServerClientThread.Destroy3382013

TServerClientThread	参照

Destroy メソッドは，サーバー/クライアントスレッドオブジェクトを破棄して，それらに割り当てられていたメモリを解放します。

Destroy メソッドはサーバークライアントスレッドオブジェクトを破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。ServerClientThread オブジェクトは，それらのオブジェクトを管理する TServerWinSocket オブジェクトによって解放されます。

Destroy は，クライアントソケットへの接続をカプセル化する TServerClientWinSocket オブジェクトを解放してから，継承デストラクタを呼び出します。


読み出し／書き込み3382014

読み出し専用


継承3382015

TObject

TThread


TServerClientThread 例3382016

TServerClientThread


TServerClientWinSocket
TServerClientWinSocket3383001

継承	プロパティ	メソッド	イベント	参照

TServerClientWinSocket オブジェクトはクライアントソケットへのソケット接続のサーバーエンドポイントを示します。

ユニット

scktcomp

説明

TServerClientWinSocket は，個々のクライアントソケットへのソケット接続の Windows ソケット API 呼び出しを管理するために，サーバーソケットコンポーネントによって使われます。TServerClientWinSocket オブジェクトは，クライアントソケット接続がリスニングサーバーソケットによって受け入れられたときに作成されます。

アプリケーションは，サーバーソケットコンポーネントの OnGetSocket イベントハンドラで TServerClientWinSocket オブジェクトのプロパティを作成およびカスタマイズできます。コンポーネントを作成する場合は，OnGetSocket イベントハンドラで TServerClientWinSocket のかわりになる TServerClientWinSocket の下位オブジェクトを作成できます。


TServerClientWinSocket プロパティ3383002

TServerClientWinSocket	アルファベット順	凡例

TServerClientWinSocket

ServerWinSocket

TCustomWinSocket からの継承

Addr

ASyncStyles

Connected

Data

Handle

LocalAddress

LocalHost

LocalPort

RemoteAddr

RemoteAddress

RemoteHost

RemotePort

SocketHandle


TServerClientWinSocket プロパティ3383003

TServerClientWinSocket	オブジェクト順	凡例

Addr

ASyncStyles

Connected

Data

Handle

LocalAddress

LocalHost

LocalPort

RemoteAddr

RemoteAddress

RemoteHost

RemotePort

ServerWinSocket

SocketHandle


TServerClientWinSocket.ServerWinSocket
TServerClientWinSocket.ServerWinSocket3383004

TServerClientWinSocket	参照

ServerWinSocket プロパティは，この TServerClientWinSocket によって管理されるクライアントソケットへの接続を受け入れたリスニング接続のエンドポイントを示します。

property ServerWinSocket: TServerWinSocket

説明

ServerWinSocket プロパティは，この TServerClientWinSocket を生成したリスニング接続の Windows ソケットオブジェクトにアクセスします。また，ServerWinSocket を使うと，サーバーソケットのイベントハンドラによって処理できるイベントを生成したり，Windows サーバーソケットによって保持されているキャッシュから実行スレッドを取得したり，サーバーソケットによって受け入れられた他のアクティブな接続についての情報を取得することができます。


TServerClientWinSocket イベント3383005

TServerClientWinSocket	アルファベット順

TCustomWinSocket からの継承

OnErrorEvent

OnSocketEvent


TServerClientWinSocket イベント3383006

TServerClientWinSocket	オブジェクト順

OnErrorEvent

OnSocketEvent


TServerClientWinSocket メソッド3383007

TServerClientWinSocket	アルファベット順

TServerClientWinSocket

Create

Destroy

TCustomWinSocket からの継承

Close

Lock

LookupName

LookupService

ReceiveBuf

ReceiveLength

ReceiveText

SendBuf

SendStream

SendStreamThenDrop

SendText

Unlock

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TServerClientWinSocket メソッド3383008

TServerClientWinSocket	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Close

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

Lock

LookupName

LookupService

MethodAddress

MethodName

NewInstance

ReceiveBuf

ReceiveLength

ReceiveText

SafeCallException

SendBuf

SendStream

SendStreamThenDrop

SendText

Unlock


TServerClientWinSocket.Create
TServerClientWinSocket.Create3383009

TServerClientWinSocket	参照

Create メソッドは，TServerClientWinSocket のインスタンスを作成し，初期化します。

constructor Create(Socket: TSocket; ServerWinSocket: TServerWinSocket);

説明

Create メソッドを呼び出すと，サーバーソケットコンポーネントの OnGetSocket イベントハンドラで TServerClientWinSocket のインスタンスを作成できます。Socket パラメータは，受け入れられたクライアントソケットへのソケット接続の Windows ソケットハンドルです。ServerWinSocket パラメータはクライアントソケットへの接続を受け入れたリスニング接続の Windows ソケットオブジェクトです。

Create メソッドはリスニングサーバーソケットによって保持されている接続のリストに新しい TServerClientWinSocket オブジェクトを追加します。次に，その接続からクライアントへの通知がサーバーソケットに渡されるように OnSocketEvent イベントハンドラを設定します。サーバーソケットへの接続をセットアップした後で，Create は継承コンストラクタを呼び出します。


TServerClientWinSocket.Destroy
TServerClientWinSocket.Destroy3383010

TServerClientWinSocket	参照

Destroy メソッドは，TServerClientWinSocket のインスタンスを破棄します。

destructor Destroy; override

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TServerClientWinSocket オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。TServerClientWinSocket のインスタンスは接続が終了したときに自動的に解放されます。

Destroy はリスニング Windows ソケットによって保持されている接続のリストから TServerClientWinSocket を削除します。


読み出し／書き込み3383011

読み出し専用


継承3383012

TObject

TCustomWinSocket


TServerClientWinSocket 例3383013

TServerClientWinSocket


TServerSocket
TServerSocket3384001

継承	プロパティ	メソッド	イベント	参照

TServerSocket オブジェクトは TCP/IP サーバー用のサーバーソケット接続を管理します。

ユニット

scktcomp

説明

フォームまたはデータモジュールに TServerSocket オブジェクトを追加すると，アプリケーションを TCP/IP サーバーにすることができます。TServerSocket は，他のマシンからの TCP/IP 接続の要求を監視し，要求を受信したときに接続を確立します。


TServerSocket プロパティ3384002

TServerSocket	アルファベット順	凡例

TServerSocket

Socket

TCustomServerSocket からの継承

ServerType

ThreadCacheSize

TCustomSocket からの継承

Active

Port

Service

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TServerSocket プロパティ3384003

TServerSocket	オブジェクト順	凡例

Active

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Port

ServerType

Service

Socket

Tag

ThreadCacheSize

VCLComObject


TServerSocket.Socket
TServerSocket.Socket3384004

TServerSocket	参照

Socket プロパティは，リスニング接続のエンドポイントを示す TServerWinSocket オブジェクトです。

property Socket: TServerWinSocket;

説明

Socket プロパティは，以下の情報を提供します。

・	サーバーソケットで現在アクティブな接続についての情報を取得する

・	サーバーソケットによる使用のためにキャッシュされている接続スレッドについての情報を取得する

・	Windows ソケット API 呼び出しで必要とされるリスニング接続の Windows ソケットハンドルへアクセスする


TServerSocket イベント3384005

TServerSocket	アルファベット順	凡例

TCustomServerSocket からの継承

OnClientConnect

OnClientDisconnect

OnClientError

OnClientRead

OnClientWrite

OnGetSocket

OnGetThread

OnThreadEnd

OnThreadStart

TCustomSocket からの継承

OnAccept

OnListen


TServerSocket イベント3384006

TServerSocket	オブジェクト順	凡例

OnAccept

OnClientConnect

OnClientDisconnect

OnClientError

OnClientRead

OnClientWrite

OnGetSocket

OnGetThread

OnListen

OnThreadEnd

OnThreadStart


TServerSocket メソッド3384007

TServerSocket	アルファベット順

TServerSocket

Create

TCustomServerSocket からの継承

Destroy

TCustomSocket からの継承

Close

Open

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TServerSocket メソッド3384008

TServerSocket	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Close

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

Open

RemoveComponent

SafeCallException


TServerSocket.Create
TServerSocket.Create3384009

TServerSocket	参照

Create メソッドは，TServerSocket のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にサーバーソケットコンポーネントを作成および初期化できます。設計時に配置された TServerSocket オブジェクトは自動的に作成されます。

継承されたコンストラクタを呼び出した後，Create は以下の処理を行います。

・	サーバーソケットの Windows ソケット接続をカプセル化する TServerWinSocket オブジェクトを割り当てる

・	サーバーソケットのイベントおよびエラーディスパッチャを初期化する

・	ThreadCacheSize を 10 に初期化する


スコープ3384010

published

読み出し／書き込み

読み出し専用


スコープ3384011

published


継承3384012

TObject

TPersistent

TComponent

TCustomSocket

TCustomServerSocket


TServerSocket 例3384013

TServerSocket


TServerWinSocket
TServerWinSocket3385001

継承	プロパティ	メソッド	イベント	参照

TServerWinSocket オブジェクトはリスニングサーバーソケット接続のエンドポイントを示します。

ユニット

scktcomp

説明

TServerWinSocket は，TCP/IP リスニング接続の Windows ソケット API 呼び出しを管理するために，サーバーソケットコンポーネントによって使われます。TServerWinSocket は，別々のクライアントソケットへの複数のソケット接続を管理したり，それぞれのクライアント接続が独自の実行スレッドを持てるように TServerClientThread オブジェクトを生成または再使用したりするための新しいプロパティ，イベント，メソッドを備えています。


TServerWinSocket プロパティ3385002

TServerWinSocket	アルファベット順	凡例

TServerWinSocket

ActiveConnections

ActiveThreads

Connections

IdleThreads

ServerType

ThreadCacheSize

TCustomWinSocket からの継承

Addr

ASyncStyles

Connected

Data

Handle

LocalAddress

LocalHost

LocalPort

RemoteAddr

RemoteAddress

RemoteHost

RemotePort

SocketHandle


TServerWinSocket プロパティ3385003

TServerWinSocket	オブジェクト順	凡例

ActiveConnections

ActiveThreads

Addr

ASyncStyles

Connected

Connections

Data

Handle

IdleThreads

LocalAddress

LocalHost

LocalPort

RemoteAddr

RemoteAddress

RemoteHost

RemotePort

ServerType

SocketHandle

ThreadCacheSize


TServerWinSocket.ActiveConnections
TServerWinSocket.ActiveConnections3385004

TServerWinSocket	参照

ActiveConnections プロパティは，現在オープンしている，このリスニングソケットによって受け入れられたクライアントソケットへの接続の数です。

property ActiveConnections: Integer;

説明

ActiveConnections プロパティを使うと，サーバーソケットの使用をモニタできます。ActiveConnections は Connections 配列内のエントリ数です。


TServerWinSocket.ActiveThreads
TServerWinSocket.ActiveThreads3385005

TServerWinSocket	参照

ActiveThreads プロパティは，Connections 配列にリストされている，ソケット接続によって現在使用中の TServerClientThread オブジェクトの数です。

property ActiveThreads: Integer;

説明

ActiveThreads プロパティは，リスニングソケットによるスレッドの使用率をモニタできます。ActiveThreads の値が ThreadCacheSize よりはるかに大きい場合，ThreadCacheSize の値を増加させると，処理効率が向上します。ThreadCacheSize の値が大きすぎるかどうかを判定するには，IdleThreads プロパティを使用します。

ServerType プロパティが stThreadBlocking ならば，各クライアント接続は，キャッシュに追加され，ActiveThreads によってカウントされるスレッドを自動的に生成します。


TServerWinSocket.Connections
TServerWinSocket.Connections3385006

TServerWinSocket	参照

Connections プロパティは，このリスニングソケットによって受け入れられたクライアントソケットへのオープンソケット接続を表すすべての TServerClientWinSocket オブジェクトのインデックス配列です。

property Connections[Index: Integer]: TCustomWinSocket;

説明

Connections プロパティを ActiveConnections プロパティと一緒に使うと，リスニングソケットによって受け入れられたオープンソケット接続すべてを繰り返すことができます。Connections 配列の各エントリは TServerClientWinSocket オブジェクトで，Index 値 0 は，1 番目の TServerClientWinSocket，Index 値 1 は 2 番目の TServerClientWinSocket を返します。

ServerType が stThreadBlocking の場合，Connections 配列内の各 TServerClientWinSocket オブジェクトに関連付けられているスレッドは GetClientThread メソッドを使って取得できます。


TServerWinSocket.IdleThreads
TServerWinSocket.IdleThreads3385007

TServerWinSocket	参照

IdleThreads プロパティは，キャッシュ内にある利用可能な未使用の TServerClientThread オブジェクトの数です。

property IdleThreads: Integer;

説明

IdleThreads プロパティは，リスニングソケットによるスレッドキャッシュの使用率をモニタできます。IdleThreads が非常に大きい値を頻繁に示す場合は，スレッドキャッシュが余分なスレッドの格納に多くの未使用メモリを使っています。ActiveThreads プロパティをモニタすると，ThreadCacheSize プロパティの適切な値を判定できます。

ServerType プロパティが stThreadBlocking ならば，各クライアント接続はキャッシュに追加されるスレッドを自動的に生成します。実行を完了したキャッシュ内のスレッドは，再使用可能になり，IdleThreads によってカウントされます。アクティブなスレッドが ThreadCacheSize よりも多いときは，多い分のスレッドは実行が完了したら解放されます。


TServerWinSocket.ServerType
TServerWinSocket.ServerType3385008

TServerWinSocket	参照

ServerType プロパティは，サーバーソケットによって受け入れられる各接続を非ブロッキング接続にするかどうか，あるいは，自動的に接続ごとに独立した実行スレッドが与えられようにするかどうかを指定します。

TServerType = (stNonBlocking, stThreadBlocking);

property ServerType: TServerType;

説明

ServerType プロパティを stThreadBlocking に設定すると，リスニングソケット接続によって受け入れられるソケット接続ごとに新しいスレッドを自動的に生成できます。ServerType が stThreadBlocking ならば，接続のための TServerClientThread オブジェクトは，サーバーソケットが読み書きを行うことが必要になったときに OnClientRead または OnClientWrite イベントを生成します。

ServerType プロパティを stNonBlocking に設定すると，リスニングソケットによって受け入れられるソケット接続でのすべての読み書きを非同期的に処理できます。ServerType が stNonBlocking ならば，デフォルトですべてのクライアント接続は単一の実行スレッドで処理されます。OnClientRead または OnClientWrite イベントは，サーバーソケットが接続の 1 つで入出力を保守する必要があるときに発生します。

読み書きをクライアントソケットと同期させる必要があるときには非ブロッキングソケットを使用します。

注意

ServerType が stThreadBlocking ならば，OnClient... イベントハンドラのコードはスレッドセーフのコードであることが重要です。


TServerWinSocket.ThreadCacheSize
TServerWinSocket.ThreadCacheSize3385009

TServerWinSocket	参照

ThreadCacheSize プロパティは，新しいクライアントソケットへの接続による再使用のためにキャッシュされる TServerClientThread オブジェクトの数です。

property ThreadCacheSize: Integer;

説明

ServerType が stThreadBlocking ならば，サーバーソケットによって受け入れられる新しい接続ごとに独立した実行スレッドが与えられます。処理効率を向上させるために，サーバーソケットは，接続がクローズしたときにこれらのスレッドを解放しないで，キャッシュに格納します。このため，新しい接続は，接続が受け入れられるたびに新しいスレッドの作成をソケットサーバーに要求せずに，キャッシュからスレッドを再使用することができます。

ThreadCacheSize を設定すると，再利用のためにキャッシュされるスレッドの数を指定できます。ThreadCacheSize の最適値は，サーバーソケットが受け取るクライアントソケット要求の数と頻度によって異なります。ThreadCacheSize の値が小さすぎると，クライアント接続を受け入れるときに，サーバーソケットがスレッドを解放および作成するのに時間がかかってしまいます。ThreadCacheSize の値が大きすぎると，サーバーソケットは再使用されないスレッドのためにメモリをロックしてしまうことがあります。


TServerWinSocket イベント3385010

TServerWinSocket	アルファベット順

TServerWinSocket

OnClientConnect

OnClientDisconnect

OnClientError

OnClientRead

OnClientWrite

OnGetSocket

OnGetThread

OnThreadEnd

OnThreadStart

TCustomWinSocket からの継承

OnErrorEvent

OnSocketEvent


TServerWinSocket イベント3385011

TServerWinSocket	オブジェクト順

OnClientConnect

OnClientDisconnect

OnClientError

OnClientRead

OnClientWrite

OnErrorEvent

OnGetSocket

OnGetThread

OnSocketEvent

OnThreadEnd

OnThreadStart


TServerWinSocket.OnClientConnect
TServerWinSocket.OnClientConnect3385012

TServerWinSocket	参照

OnClientConnect イベントは，クライアントソケットがリスニングソケットによって受け入れられた接続を完了したときに発生します。

TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnClientConnect: TSocketNotifyEvent;

説明

OnClientConnect イベントハンドラを記述すると，クライアントソケットが TServerClientWinSocket オブジェクトへのソケット接続を完了したときに特定の処理が行われるようにすることができます。サービスによっては，この時点でソケットが読み書きを開始します。

OnClientConnect が発生するまでの Windows サーバーソケットイベントの順番は以下のとおりです。

1.	Windows ソケットがリスニングのためにオープンされる直前に，seListen 型の OnSocketEvent イベントが発生する

2.	リスニング Windows ソケットがリスニングキューにクライアント要求を受け取る。リスニングソケットが要求の 1 つを受け入れ，新しいソケット接続の Windows ソケットハンドルを受け取る

3.	リスニングソケットが OnGetSocket イベントを生成し，Windows ソケットハンドルに渡す。Windows ソケットハンドル用の TServerClientWinSocket オブジェクトが OnGetSocket イベントハンドラで作成されなかった場合は，Windows ソケットがそのオブジェクトを作成する。Windows ソケットは他のクライアントの監視を続行する

4.	新しい TServerClientWinSocket オブジェクトを使って，seAccept 型の OnSocketEvent イベントが発生する

5.	ServerType が stThreadBlocking で，キャッシュに利用可能なスレッドがない場合は，OnGetThread イベントが発生する。OnGetThread イベントハンドラがスレッドを作成しない場合は，Windows ソケットオブジェクトが TServerClientThread を作成する

6.	ServerType が stThreadBlocking の場合は，スレッドが実行を開始すると，OnThreadStart イベントが発生する

7.	クライアントが TServerClientWinSocket オブジェクトへの接続を完了し，OnClientConnect イベントが発生する

Sender パラメータはクライアント要求を監視する TServerWinClient オブジェクトです。Socket パラメータはクライアントソケットへの接続を確立する TServerClientWinSocket オブジェクトです。

注意

ServerType が stThreadBlocking の場合は，OnClientConnect イベントハンドラ内のすべてのコードがスレッドセーフのコードであることを確認してください。GetClientThread メソッドを使うと，スレッド固有の情報にアクセスできます。

注意

関連付けられている TServerSocket の OnClientConnect イベントハンドラを設定すると，TServerWinSocket の OnClientConnect イベントハンドラも設定されます。


TServerWinSocket.OnClientDisconnect
TServerWinSocket.OnClientDisconnect3385013

TServerWinSocket	参照

OnClientDisconnect イベントは，クライアントソケットへの接続の 1 つをクローズしたときに発生します。

TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnClientDisconnect: TSocketNotifyEvent;

説明

OnClientDisconnect イベントハンドラを記述すると，クライアントソケットへの接続が終了したときに特定の処理が行われるようにすることができます。クライアント要求が終了しても，リスニングソケットはクローズしません。リスニング接続は，新しいクライアント接続要求を受け入れるためにオープンしたままです。

クライアント接続に関連付けられている TServerClientWinSocket オブジェクトは，OnClientDisconnect の後で解放されます。ServerType が stThreadBlocking の場合，OnClientDisconnect の後に OnThreadEnd イベントが発生します。

Sender パラメータはクライアント要求を受け取った TServerWinClient オブジェクトです。Socket パラメータはクライアントソケットとの接続を終了する TServerClientWinSocket オブジェクトです。

注意

ServerType が stThreadBlocking の場合は，OnClientDisconnect イベントハンドラ内のすべてのコードがスレッドセーフのコードであることを確認して下さい。GetClientThread メソッドを使うと，スレッド固有の情報にアクセスできます。

注意

関連付けられている TServerSocket の OnClientDisconnect イベントハンドラを設定すると，TServerWinSocket の OnClientDisconnect イベントハンドラも設定されます。


TServerWinSocket.OnClientError
TServerWinSocket.OnClientError3385014

TServerWinSocket	参照

OnClientError イベントは，個々のクライアントソケットへのソケット接続を確立，使用，または終了するときに失敗が生じたときに発生します。

TErrorEvent = (eeGeneral, eeSend, eeReceive, eeConnect, eeDisconnect, eeAccept);

TSocketErrorEvent = procedure (Sender: TObject; Socket: TCustomWinSocket;

    ErrorEvent: TErrorEvent; var ErrorCode: Integer) of object;

property OnClientError: TSocketErrorEvent;

説明

OnClientError イベントハンドラを記述すると，クライアントソケットへの接続で発生したエラーに応答することができます。OnClientError イベントハンドラがエラー状況を正常に処理する場合，ErrorCode パラメータを 0 に設定すると ESocketError は生成されません。

Sender パラメータはクライアント要求を受け取った TServerWinClient オブジェクトです。 Socket パラメータはクライアントへの接続を管理する TServerClientWinSocket オブジェクトです。ErrorEvent パラメータは，エラー発生時に Socket が何を行おうとしていたかを示します。ErrorCode パラメータは Windows ソケット API 呼び出しによって返されるエラーコードです。

注意

ServerType が stThreadBlocking の場合は，OnClientError イベントハンドラ内のすべてのコードがスレッドセーフのコードであることを確認して下さい。GetClientThread メソッドを使うと，スレッド固有の情報にアクセスできます。

注意

関連付けられている TServerSocket の OnClientError イベントハンドラを設定すると，TServerWinSocket の OnClientError イベントハンドラも設定されます。


TServerWinSocket.OnClientRead
TServerWinSocket.OnClientRead3385015

TServerWinSocket	参照

OnClientRead イベントは，サーバーソケットがクライアントソケットから情報を読み出すことが必要になったときに発生します。

TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnClientRead: TSocketNotifyEvent;

説明

OnClientRead イベントハンドラを記述すると，ソケット接続から情報を読み出すことができます。読み出しを行うには，TWinSocketStream オブジェクトまたは Socket パラメータのメソッドを使います。

Sender パラメータはクライアント要求を受け取った TServerWinClient オブジェクトです。 Socket パラメータ Windows ソケット接続をカプセル化する TServerClientWinSocket オブジェクトです。

注意

ServerType が stThreadBlocking の場合は，OnClientRead イベントハンドラ内のすべてのコードがスレッドセーフのコードであることを確認して下さい。GetClientThread メソッドを使うと，スレッド固有の情報にアクセスできます。

注意

関連付けられている TServerSocket の OnClientRead イベントハンドラを設定すると，TServerWinSocket の OnClientRead イベントハンドラも設定されます。


TServerWinSocket.OnClientWrite
TServerWinSocket.OnClientWrite3385016

TServerWinSocket	参照

OnClientWrite イベントは，サーバーソケットがクライアントソケットに情報を書き込むことが必要になったときに発生します。

TSocketNotifyEvent = procedure (Sender: TObject; Socket: TCustomWinSocket) of object;

property OnClientWrite: TSocketNotifyEvent;

説明

OnClientWrite イベントハンドラを記述すると，ソケット接続に情報を書き込むことができます。実際に書き込みを行うには，TWinSocketStream オブジェクトまたは Socket パラメータのメソッドを使います。

Sender パラメータはクライアント要求を受け取った TServerWinClient オブジェクトです。 Socket パラメータ は Windows ソケット接続をカプセル化する TServerClientWinSocket オブジェクトです。

注意

ServerType が stThreadBlocking の場合は，OnClientWrite イベントハンドラ内のすべてのコードがスレッドセーフのコードであることを確認して下さい。GetClientThread メソッドを使うと，スレッド固有の情報にアクセスできます。

注意

関連付けられている TServerSocket の OnClientWrite イベントハンドラを設定すると，TServerWinSocket の OnClientWrite イベントハンドラも設定されます。


TServerWinSocket.OnGetSocket
TServerWinSocket.OnGetSocket3385017

TServerWinSocket	参照

OnGetSocket イベントは，クライアントソケットへの接続を確立するために，サーバーソケットが新しい TServerClientWinSocket オブジェクトを作成することが必要になったときに発生します。

TSocket = u_int;

TGetSocketEvent = procedure (Sender: TObject; Socket: TSocket;

    var ClientSocket: TServerClientWinSocket) of object;

property OnGetSocket: TGetSocketEvent;

説明

OnGetSocket イベントハンドラを記述すると，Socket パラメータで表される接続で使う特殊な TServerClientWinSocket オブジェクトを作成することができます。ClientSocket パラメータに新しい TServerClientWinSocket オブジェクトを返します。

Sender パラメータはクライアント要求を受け取った TServerWinSocket オブジェクトです。Socket パラメータはクライアントソケットへのソケット接続の Windows ソケットハンドルです。

注意

関連付けられている TServerSocket の OnGetSocket イベントハンドラを設定すると，TServerWinSocket の OnGetSocket イベントハンドラも設定されます。


TServerWinSocket.OnGetThread
TServerWinSocket.OnGetThread3385018

TServerWinSocket	参照

OnGetThread イベントは，クライアントソケットへの接続のために，サーバーソケットが新しい実行スレッドを作成することが必要になったときに発生します。

TGetThreadEvent = procedure (Sender: TObject; ClientSocket: TServerClientWinSocket;

    var SocketThread: TServerClientThread) of object;

property OnGetThread: TGetThreadEvent;

説明

OnGetThread イベントハンドラを記述すると，クライアントソケットへの接続のための特殊な TServerClientThread の下位オブジェクトを作成することができます。SocketThread パラメータに新しい TServerClientThread オブジェクトを返します。OnGetThread が発生するのは，キャッシュ内にアイドルスレッドがない場合にだけです。

Sender パラメータはクライアント要求を受け取った TServerWinSocket オブジェクトです。ClientSocket パラメータはクライアントソケットと通信する TServerClientWinSocket オブジェクトです。

注意

関連付けられている TServerSocket の OnGetThread イベントハンドラを設定すると，TServerWinSocket の OnGetThread イベントハンドラも設定されます。


TServerWinSocket.OnThreadEnd
TServerWinSocket.OnThreadEnd3385019

TServerWinSocket	参照

OnThreadEnd イベントは，クライアントソケット接続が終了し，関連付けられているスレッドが実行を完了したときに発生します。

TThreadNotifyEvent = procedure (Sender: TObject; Thread: TServerClientThread) of object;

property OnThreadEnd: TThreadNotifyEvent;

説明

OnThreadEnd イベントを記述すると，クライアント接続のスレッドが実行を完了したときに特定の処理が行われるようにすることができます。OnThreadEnd は OnClientDisconnect イベントの後に発生します。

Sender パラメータはクライアント要求を受け取った TServerWinSocket です。Thread パラメータは終了するスレッドです。

注意

関連付けられている TServerSocket の OnThreadEnd イベントハンドラを設定すると，TServerWinSocket の OnThreadEnd イベントハンドラも設定されます。


TServerWinSocket.OnThreadStart
TServerWinSocket.OnThreadStart3385020

TServerWinSocket	参照

OnThreadStart イベントは，クライアントソケットへの接続のための実行スレッドが開始されたときに発生します。

TThreadNotifyEvent = procedure (Sender: TObject; Thread: TServerClientThread) of object;

property OnThreadStart: TThreadNotifyEvent;

説明

OnThreadStart イベントを記述すると，単一のクライアントソケットへの接続のための TServerClientThread を初期化することができます。Sender パラメータはクライアント要求を受け取った TServerWinSocket です。Thread パラメータは実行を開始するスレッドです。

注意

関連付けられている TServerSocket の OnThreadStart イベントハンドラを設定すると，TServerWinSocket の OnThreadStart イベントハンドラも設定されます。


TServerWinSocket メソッド3385021

TServerWinSocket	アルファベット順

TServerWinSocket

Create

Destroy

GetClientThread

TCustomWinSocket からの継承

Close

Lock

LookupName

LookupService

ReceiveBuf

ReceiveLength

ReceiveText

SendBuf

SendStream

SendStreamThenDrop

SendText

Unlock

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TServerWinSocket メソッド3385022

TServerWinSocket	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Close

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetClientThread

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

Lock

LookupName

LookupService

MethodAddress

MethodName

NewInstance

ReceiveBuf

ReceiveLength

ReceiveText

SafeCallException

SendBuf

SendStream

SendStreamThenDrop

SendText

Unlock


TServerWinSocket.Create
TServerWinSocket.Create3385023

TServerWinSocket	参照

Create メソッドは，Windows ソケットハンドルから TServerWinSocket のインスタンスを作成します。

TSocket = u_int;

constructor Create(ASocket: TSocket);

説明

Create メソッドを呼び出すと，Windows リスニングソケットオブジェクトを作成できます。Windows リスニングソケットオブジェクトは，それらを使用するサーバーソケットコンポーネントによって自動的に作成されます。

Create は，アクティブなクライアント接続のリストとスレッドキャッシュを管理するヘルパーオブジェクトを割り当ててから，継承するコンストラクタを呼び出します。また，Create は ASyncStyles プロパティを初期化して [asAccept] に設定します。


TServerWinSocket.Destroy
TServerWinSocket.Destroy3385024

TServerWinSocket	参照

Destroy メソッドは，TServerWinSocket のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは Windows リスニングソケットオブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。Windows ソケットオブジェクトは，サーバーソケットコンポーネントによって使われていない場合以外は，ソケットコンポーネントによって自動的に解放されます。

Destroy は，アクティブなクライアント接続のリストとスレッドキャッシュを管理するヘルパーオブジェクトを解放します。


TServerWinSocket.GetClientThread
TServerWinSocket.GetClientThread3385025

TServerWinSocket	参照

GetClientThread メソッドは，ClientSocket パラメータによって管理されるクライアント接続が使う実行スレッドを返します。

function GetClientThread(ClientSocket: TServerClientWinSocket): TServerClientThread;

説明

GetClientThread メソッドを呼び出すと，特定のクライアント接続の TServerClientThread へアクセスできます。GetClientThread により，OnClient... イベントハンドラはスレッドの Data プロパティに格納されたスレッドグローバルな情報へアクセスできるようになります。


読み出し／書き込み3385026

読み出し専用


継承3385027

TObject

TCustomWinSocket


TServerWinSocket 例3385028

TServerWinSocket


TStaticText
TStaticText3386001

継承	プロパティ	メソッド	イベント	参照

TStaticText はフォーム上にテキストを表示するウィンドウコントロールです。

ユニット

stdctrls

説明

TStaticText コンポーネントは TWinControl から継承されているためにウィンドウハンドルを持っていることを除けば TLabel に似ています。ActiveX のプロパティページのように，コンポーネントのアクセラレータキーがウィンドウコントロールに属さなければならないときは，TLabelの代わりに TStaticText を使います。


TStaticText プロパティ3386002

TStaticText	アルファベット順	凡例

TCustomStaticText からの継承

Alignment

AutoSize

BorderStyle

FocusControl

ShowAccelChar

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TStaticText プロパティ3386003

TStaticText	オブジェクト順	凡例

Align

Alignment

AutoSize

BorderStyle

BoundsRect

Brush

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

DragCursor

DragMode

Enabled

FocusControl

Font

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentColor

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ShowAccelChar

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TStaticText イベント3386004

TStaticText	アルファベット順	凡例

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TStaticText イベント3386005

TStaticText	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TStaticText メソッド3386006

TStaticText	アルファベット順

TCustomStaticText からの継承

Create

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TStaticText メソッド3386007

TStaticText	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


スコープ3386008

published

読み出し／書き込み

読み出し専用


スコープ3386009

published


継承3386010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomStaticText


TStaticText 例3386011

TStaticText


TStringsAdapter
TStringsAdapter3387001

継承	プロパティ	メソッド	参照

TStringsAdapter は，OLE で使うために TStrings オブジェクトを IString として実現します。

ユニット

axctrls

説明

TStringsAdapter のインスタンスを作成するには，OLE のために TStrings オブジェクトを IString として実現する GetIStrings 関数を呼び出します。


TStringsAdapter のプロパティ3387002

TStringsAdapter	アルファベット順	凡例

TAutoIntfObject からの継承

DispIID

DispIntfEntry

DispTypeInfo

TInterfacedObject からの継承

RefCount


TStringsAdapter のプロパティ3387003

TStringsAdapter	オブジェクト順	凡例

DispIID

DispIntfEntry

DispTypeInfo

RefCount


TStringsAdapter のメソッド3387004

TStringsAdapter	アルファベット順

TStringsAdapter

Create

TAutoIntfObject からの継承

SafeCallException

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TStringsAdapter のメソッド3387005

TStringsAdapter	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TStringsAdapter.Create
TStringsAdapter.Create3387006

TStringsAdapter	参照

Create メソッドは，文字列アダプタコントロールのインスタンスを構築します。

constructor Create(Strings: TStrings);

説明

通常，このクラスのオブジェクトを作成することはありません。かわりに，OLE で使うために TStrings オブジェクトを IStrings として実現する GetIStrings 関数を呼び出してください。


アクセス種別3387007

読み出し専用


継承3387008

TObject

TInterfacedObject

TAutoIntfObject


TStringsAdapter の例3387009

TStringsAdapter


TStoredProc
TStoredProc3388001

継承	プロパティ	メソッド	イベント	参照

TStoredProc コンポーネントは，データベースサーバー上のストアドプロシージャをカプセル化します。

ユニット

dbtables

説明

TStoredProc コンポーネントは，クライアントアプリケーションからデータベースサーバー上のストアドプロシージャを利用しなければならないときに使います。ストアドプロシージャは，（テーブル，インデックス，ドメインとまったく同様に）データベースサーバーのメタデータとして格納された文の集合で，データベースサーバー上で頻繁に反復実行されるデータベース関連作業を実行し，その結果をクライアントに返します。

注意

すべてのデータベースサーバーがストアドプロシージャをサポートするわけではありません。あるデータベースサーバーがストアドプロシージャをサポートするかどうかを調べるには，各データベースサーバーのマニュアルを参照してください。

多くのストアドプロシージャは，処理中に使用する複数の入力引数つまりパラメータを必要とします。TStoredProc コンポーネントには Params プロパティがあり，これによってアプリケーションは，ストアドプロシージャを実行する前に必要なパラメータを設定することができます。

TStoredProc コンポーネントは，ストアドプロシージャから返された結果を保持するために Params プロパティを再利用します。Params プロパティは値の配列です。サーバー処理系によって，ストアドプロシージャは，一組の値を返したり，問い合わせが返す結果セットと似た結果セットを返したりします。


TStoredProc プロパティ3388002

TStoredProc	アルファベット順	凡例

TStoredProc

Overload

ParamBindMode

ParamCount

Params

Prepared

StmtHandle

StoredProcName

TDBDataSet からの継承

Database

DatabaseName

DBHandle

DBLocale

DBSession

Provider

SessionName

TBDEDataSet からの継承

CacheBlobs

CachedUpdates

CanModify

ExpIndex

Filter

Filtered

FilterOptions

Handle

KeySize

Locale

RecNo

RecordCount

RecordSize

UpdateObject

UpdateRecordTypes

UpdatesPending

TDataSet からの継承

Active

AutoCalcFields

BOF

Bookmark

DataSource

DefaultFields

Designer

EOF

FieldCount

FieldDefs

Fields

FieldValues

Found

Modified

Name

State

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TStoredProc プロパティ3388003

TStoredProc	オブジェクト順	凡例

Active

AutoCalcFields

BOF

Bookmark

CacheBlobs

CachedUpdates

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Database

DatabaseName

DataSource

DBHandle

DBLocale

DBSession

DefaultFields

Designer

DesignInfo

EOF

ExpIndex

FieldCount

FieldDefs

Fields

FieldValues

Filter

Filtered

FilterOptions

Found

Handle

KeySize

Locale

Modified

Name

Overload

Owner

ParamBindMode

ParamCount

Params

Prepared

Provider

RecNo

RecordCount

RecordSize

SessionName

State

StmtHandle

StoredProcName

Tag

UpdateObject

UpdateRecordTypes

UpdatesPending

VCLComObject


TStoredProc.Overload
TStoredProc.Overload3388004

TStoredProc	参照

Overload プロパティは，Oracle のオーバーロードストアドプロシージャを指定します。

property Overload: Word;

説明

Overload プロパティは，Oracle サーバー上で実行するオーバーロードストアドプロシージャを指定します。Oracle オーバーロードストアドプロシージャは，他の 1 つまたは複数のストアドプロシージャと名前を共有する手続きです。Oracle は，各手続きに一意な数値識別子を割り当てることでそれぞれのオーバーロードストアドプロシージャを識別します。アプリケーションは，Overload プロパティを使ってこの数値識別子を指定します。

デフォルトで Overload プロパティはゼロで，これはオーバーロードされた手続きがないということです。Oracle 以外のサーバーではこの値を変えないでください。Overload プロパティを設定しないで Oracle オーバーロード手続きにアクセスしようとすると，ボーランドデータベースエンジン（BDE）は Oracle サーバー上の最低番号つまり 1 のオーバーロードストアドプロシージャにアクセスします。

このプロパティが 1 の場合，BDE はサーバー上の第 1 オーバーロードストアドプロシージャを実行し，2 の場合，第 2 オーバーロードストアドプロシージャを実行します。以下同様です。

注意

Oracle オーバーロードストアドプロシージャは，名前を共有しますが，パラメータリストはそれぞれ異なります。アプリケーションでは，常に正しいパラメータリストをオーバーロードストアドプロシージャに渡さければなりません。


TStoredProc.ParamBindMode
TStoredProc.ParamBindMode3388005

TStoredProc	参照

ParamBindMode プロパティは，コンポーネントのパラメータをストアドプロシージャのパラメータリストに代入する順序を指定します。

TParamBindMode = (pbByName, pbByNumber);

property ParamBindMode: TParamBindMode;

説明

ParamBindMode プロパティは，Params プロパティ内のパラメータと，ストアドプロシージャが使用するパラメータとの対応関係がわかります。ParamBindMode パラメータの値は以下の表のとおりです。

値	順序

pbByName	Params プロパティ内のパラメータは，ストアドプロシージャの同名のパラメータと一致する

pbByNumber	Params プロパティ内のパラメータは，ストアドプロシージャの次に使用できるパラメータに 1 つずつ代入される。（つまり，Params の最初のパラメータはストアドプロシージャの最初のパラメータに代入される。以下同様）

可能な場合は必ず pbByName を代入してください。そうすれば，Params プロパティ内の物理的順序に関係なく各パラメータは正しく代入されます。設計時には，既知のパラメータがパラメータエディタに表示されます。

ストアドプロシージャがボーランドデータベースエンジン（BDE）にパラメータ名を知らせないことがあります。サーバー（たとえば Informix）上のパラメータ名が設計時や実行時にわからない場合は，ParamBindMode パラメータに pbByNumber を指定する必要があるでしょう。ただし，この場合，各パラメータの正しいデータ型を知らないといけません。それを知らないで使うと，実行時に例外が発生する恐れがあります。


TStoredProc.ParamCount
TStoredProc.ParamCount3388006

TStoredProc	参照

ParamCount パラメータは，ストアドプロシージャコンポーネントのパラメータ数を示します。

property ParamCount: Word;

説明

ParamCount プロパティは，現在 Params プロパティに格納されているパラメータの数を取得できます。


TStoredProc.Params
TStoredProc.Params3388007

TStoredProc	参照

Params プロパティは，ストアドプロシージャの入力/出力パラメータを格納します。

property Params: TParams;

説明

実行時に Params プロパティは，入力パラメータの名前，値，およびデータ型を動的に設定できます（設計時には，パラメータエディタでパラメータ情報を設定します）。このプロパティはパラメータ値の配列です。

アプリケーションは，ストアドプロシージャの実行後，サーバーがストアドプロシージャに返した出力パラメータを取り出すために，Params プロパティにアクセスします。


TStoredProc.Prepared
TStoredProc.Prepared3388008

TStoredProc	参照

Prepared プロパティは，ストアドプロシージャの実行準備が整ったかどうかを示します。

property Prepared: Boolean;

説明

Prepared プロパティをチェックすると，ストアドプロシージャの実行準備ができているかどうかがわかります。このプロパティが True なら準備ができており，False ならできていません。ストアドプロシージャは準備が終わっていないと実行できません。

注意

アプリケーションが ExecProc を呼び出したときにストアドプロシージャが準備されていない場合，自動的に Delphi がストアドプロシージャの準備をします。実行後，Delphi は自動的にストアドプロシージャの準備を解きます。手続きが何度も実行される場合，ストアドプロシージャを一度だけ準備し，必要でなくなったとき準備を解くほうが効率的です。

ストアドプロシージャの準備をしたりそれを解いたりするために，アプリケーションで Prepared プロジェクトの現在の設定を変更できます。Prepared プロパティが True のときに False に設定すると，UnPrepared メソッドが呼び出されストアドプロシージャの準備が解かれます。Prepared プロパティが False のときに True に設定すると，Prepared メソッドが呼び出されストアドプロシージャの準備が行われます。ただし一般的には，Prepared メソッドおよび Unprepared メソッドを直接呼び出す方がよいプログラミング習慣です。この 2 つのメソッドは自動的に Prepared プロパティを更新します。


TStoredProc.StmtHandle
TStoredProc.StmtHandle3388009

TStoredProc

StmtHandle プロパティは，ストアドプロシージャのボーランドデータベースエンジン（BDE）文ハンドル示します。

property StmtHandle: HDBIStmt;

説明

アプリケーションにおいて TStoredProc の各メソッドを使用しないで BDE を直接呼び出す方法をとる場合，StmtHandle プロパティを取得して使います。BDE API 呼び出しにはパラメータとして文が必要なものがいくつかあります。BDE を直接呼び出さない場合はどんなときでも StmtHadle プロパティにアクセスする必要はありません。


TStoredProc.StoredProcName
TStoredProc.StoredProcName3388010

TStoredProc	参照

StoredProcName プロパティは，ストアドプロシージャ名を示します。

property StoredProcName: string;

説明

StoredProcName プロパティを設定すると，ストアドプロシージャ名を指定できます。このプロパティが既存のストアドプロシージャの名前と一致しない場合，アプリケーションがストアドプロシージャの実行に先立って実行準備を行なうと，例外が発生します。


TStoredProc イベント3388011

TStoredProc	アルファベット順	凡例

TBDEDataSet からの継承

OnFilterRecord

OnServerYield

OnUpdateError

OnUpdateRecord

TDataSet からの継承

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnNewRecord

OnPostError


TStoredProc イベント3388012

TStoredProc	オブジェクト順	凡例

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError

OnServerYield

OnUpdateError

OnUpdateRecord


TStoredProc メソッド3388013

TStoredProc	アルファベット順

TStoredProc

CopyParams

Create

DescriptionsAvailable

Destroy

ExecProc

GetResults

ParamByName

Prepare

UnPrepare

TDBDataSet からの継承

CheckOpen

CloseDatabase

OpenDatabase

TBDEDataSet からの継承

ApplyUpdates

BookmarkValid

Cancel

CancelUpdates

CommitUpdates

CompareBookmarks

ConstraintCallBack

CreateBlobStream

DisableConstraints

EnableConstraints

FetchAll

GetCurrentRecord

GetIndexInfo

IsSeguenced

Locate

Lookup

RevertRecord

UpdateStatus

TDataSet からの継承

ActiveBuffer

Append

AppendRecord

CheckBrowseMode

ClearFields

Close

ControlsDisabled

CursorPosChanged

Delete

DisableControls

Edit

EnableControls

FieldByName

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FlushBuffers

FreeBookmark

GetBookmark

GetFieldList

GetFieldNames

GotoBookmark

Insert

InsertRecord

IsEmpty

IsLinkedTo

Last

MoveBy

Next

Open

Post

Prior

Refresh

Resync

SetFields

Translate

UpdateCursorPos

UpdateRecord

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TStoredProc メソッド3388014

TStoredProc	オブジェクト順

ActiveBuffer

Append

AppendRecord

ApplyUpdates

Assign

BookmarkValid

Cancel

CancelUpdates

CheckBrowseMode

CheckOpen

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearFields

Close

CloseDatabase

CommitUpdates

CompareBookmarks

ConstraintCallBack

ControlsDisabled

CopyParams

Create

CreateBlobStream

CursorPosChanged

DefaultHandler

Delete

DescriptionsAvailable

Destroy

DestroyComponents

Destroying

DisableConstraints

DisableControls

Dispatch

Edit

EnableConstraints

EnableControls

ExecProc

FetchAll

FieldAddress

FieldByName

FindComponent

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FlushBuffers

Free

FreeBookmark

FreeInstance

FreeNotification

FreeOnRelease

GetBookmark

GetCurrentRecord

GetFieldList

GetFieldNames

GetIndexInfo

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetResults

GotoBookmark

HasParent

InheritsFrom

InitInstance

Insert

InsertComponent

InsertRecord

InstanceSize

IsEmpty

IsLinkedTo

IsSeguenced

Last

Locate

Lookup

MethodAddress

MethodName

MoveBy

NewInstance

Next

Open

OpenDatabase

ParamByName

Post

Prepare

Prior

Refresh

RemoveComponent

Resync

RevertRecord

SafeCallException

SetFields

Translate

UnPrepare

UpdateCursorPos

UpdateRecord

UpdateStatus


TStoredProc.CopyParams
TStoredProc.CopyParams3388015

TStoredProc	参照

CopyParams メソッドは，ストアドプロシージャのパラメータを他のストアドプロシージャのパラメータリストにコピーします。

procedure CopyParams(Value: TParams);

説明

CopyParams メソッドを呼び出すと，現在のストアドプロシージャのパラメータが別のストアドプロシージャのパラメータリストにコピーされます。Value パラメータは，コピー先のパラメータリストです。Vaule パラメータは他のストアドプロシージャのパラメータリストであってもかまいません。たとえば，次のように指定できます。

TStoredProc1.CopyParams(TStoredProc2.Params);

アプリケーションが CopyParams メソッドを呼び出したとき，ストアドプロシージャの準備がなされていないと，CopyParams はパラメータをコピーする前に Prepare メソッドを呼び出します。コピー終了後，Unprepare メソッドを呼び出してストアドプロシージャを以前の状態に復帰します。


TStoredProc.Create
TStoredProc.Create3388016

TStoredProc	参照

Create メソッドには，ストアドプロシージャコンポーネントのインスタンスを作成します。

constructor Create(AOwner: TComponent);

説明

Create メソッドを呼び出すと，アプリケーション内で宣言されたストアドプロシージャをインスタンス化できます。このメソッドは継承された Create コンストラクタを呼び出して，新規にインスタンス化されたストアドプロシージャ用に空のパラメータリストを作成し，パラメータ，サーバー，レコードバッファを nil に初期化します。


TStoredProc.DescriptionsAvailable
TStoredProc.DescriptionsAvailable3388017

TStoredProc	参照

DescriptionsAvailable メソッドは，ストアドプロシージャのパラメータ情報を利用できるかどうかを示します。

function DescriptionsAvailable: Boolean;

説明

DescriptionsAvailable メソッドを呼び出すと，ストアドプロシージャからアプリケーションにパラメータ情報が返されるかどうかがわかります。このメソッドが True を返した場合，パラメータ情報は利用できます。False を返した場合，パラメータ情報は利用できません。

注意

DescriptionsAvailable メソッドが False を返した場合，アプリケーションは正しいパラメータ情報をストアドプロシージャに提供しないといけません。設計時にどんなパラメータが必要かを知るのは，アプリケーション開発者の責任です。


TStoredProc.Destroy
TStoredProc.Destroy3388018

TStoredProc	参照

Destroy メソッドは，ストアドプロシージャのインスタンスを破棄します。

destructor Destroy;

説明

直接 Destroy メソッドを呼び出さずに Free メソッドを呼び出してください。Free メソッドはストアドプロシージャが解放されていないことを確認してから Destroy メソッドを呼び出します。Destroy はサーバとの接続を終了し，パラメータリストを解放して，継承された Destroy デストラクタを呼び出します。


TStoredProc.ExecProc
TStoredProc.ExecProc3388019

TStoredProc	参照

ExecProc メソッドは，サーバーのストアドプロシージャを実行します。

procedure ExecProc;

説明

ExecProc メソッドを呼び出すと，サーバーのストアドプロシージャが実行されます。このメソッドを呼び出す前に，次のようにします。

1.	Params プロパティにすべての入力パラメータを設定します。設計時，開発者は Parameters エディタを使って各パラメータを設定できます。実行時，アプリケーションは Params パラメータに直接アクセスしなければなりません。

2.	Prepare メソッドを呼び出して各パラメータをバインドします。

ストアドプロシージャが出力パラメータを返した場合，それらのパラメータは，ExecProc からアプリケーションに制御が戻ったとき，Params プロパティに正しく格納されています。アプリケーションは，インデックスを用いて Params リストにアクセスしたり，ParamByName メソッドを用いたりすれば，出力パラメータにアクセスできます。

参考

アプリケーションがストアドプロシージャの返す結果セットだけを必要とする場合， StoreProc.Open メソッドを呼び出すか，Active プロパティを True を設定します。


TStoredProc.GetResults
TStoredProc.GetResults3388020

TStoredProc	参照

GetResults メソッドは，Sybase ストアドプロシージャから出力パラメータ値を返します。

procedure GetResults;

説明

GetResults メソッドを呼び出すと，Sybase ストアドプロシージャは，結果セットがあればそれをクライアントに返すようになります。Sybase 以外のサーバーのストアドプロシージャでは，結果セットは自動的にクライアントに送られますが，Sybase の場合，通常，カーソルが結果セットの末尾に来るまで結果セットを戻しません。GetResult メソッドは，強制的にカーソルを結果セットの末尾に移動させます。

GetResults メソッドに応答して Sybase ストアドプロシージャが結果セットと出力パラメータを返した場合，その出力パラメータは Params プロパティに格納されます。アプリケーションは，インデックスを用いて Params リストにアクセスしたり，ParamsByName メソッドを用いたりすれば，出力パラメータにアクセスできます。

参考

アプリケーションがストアドプロシージャの返す結果セットだけを必要とする場合，StoreProc.Open メソッドを呼び出すか，Active プロパティを True に設定します。


TStoredProc.ParamByName
TStoredProc.ParamByName3388021

TStoredProc	参照

ParamByName メソッドは，指定された名前を持つパラメータの情報にアクセスします。

function ParamByName(const Value: string): TParam;

説明

ParamByName メソッドを呼び出すと，指定された名前を持つパラメータの情報が返されます。Value パラメータが情報を取り出したいパラメータの名前です。一般に，ParamByName メソッドを使って，実行時に入力パラメータの値を設定したり，出力パラメータの値を取り出したりします。たとえば，以下の文で，「Contact」というパラメータの現在の値が取り出され，編集ボックスに格納されます。

Edit1.Text := StoredProc1.ParamsByName('Contact').AsString;


TStoredProc.Prepare
TStoredProc.Prepare3388022

TStoredProc	参照

Prepare メソッドは，ストアドプロシージャの実行準備を行います。

procedure Prepare;

説明

Prepare メソッドを呼び出すと，ExecProc メソッドを呼び出す前にストアドプロシージャのパラメータがバインドされます。Prepare メソッドは，ストアドプロシージャのパラメータを作成し，ボーランドデータベースエンジン（BDE）を初期化，ストアドプロシージャの実行準備ができたことをサーバーに通知します。これらの処理を通じて，システムリソースが割り当てられ，サーバーの効率を上げるため問い合わせが最適化されます。

注意

アプリケーションが準備されていないストアドプロシージャを実行しようとした場合，Delphi は自動的に実行前に準備を行い，実行後に準備を解きます。ストアドプロシージャが複数回実行される場合，必要でない準備処理や準備を解く処理が繰り返し実行されないよう，アプリケーションは一度 Prepare を明示的に呼び出し，必要でなくなった時にUnPrepare を呼び出すのが効率的です。


TStoredProc.UnPrepare
TStoredProc.UnPrepare3388023

TStoredProc	参照

UnPrepare メソッドは，ストアドプロシージャに割り当てられているリソースを解放します。

procedure UnPrepare;

説明

UnPrepare メソッドを呼び出すと，サーバーおよびクライアントサイドにおいてストアドプロシージャに割り当てられているリソースが解放されます。


スコープ3388024

published

読み出し／書き込み

読み出し専用


スコープ3388025

published


継承3388026

TObject

TPersistent

TComponent

TDataSet

TBDEDataSet

TDBDataSet


TStoredProc 例3388027

TStoredProc


TStream
TStream3389001

継承	プロパティ	メソッド	参照

TStream オブジェクトはディスクファイルやダイナミックメモリなどの記憶媒体にバイナリデータを格納できる Delphi ストリームオブジェクトの基本となる抽象クラス型です。

ユニット

classes

説明

TStream は汎用ファイルの入出力に使うメソッドをカプセル化します。TStream は，このカプセル化を行うために，ストリームに対してバイトの読み出し，書き込み，およびコピーを行ったり，ストリームでの現在位置を確認したりするためのメソッドを定義します。TStream のプロパティはストリームのサイズや現在位置などの情報を提供します。

また，TStream はストリームコンポーネント用のコンポーネントおよびファイラと連携するメソッドを，継承された単純なフォームに導入します。これらのメソッドはコンポーネントのストリームを開始するグローバルなルーチンによって自動的に呼び出されます。また，ストリームプロセスを開始するために直接呼び出すこともできます。ただし，コンポーネントストリームには次の 2 つのオブジェクトを必ず追加してください。

・	ストリームのメソッドにパラメータとして渡すコンポーネントオブジェクト

・	ストリームによって自動的に作成され，ストリームと関連付けられたファイラオブジェクト

抽象クラスの TStream はインスタンス化できません。コンポーネントストリームに使うメモリストリームやファイルストリームなどの下位ストリームオブジェクトは，グローバル関数 ReadComponentRes および WriteComponentRes を使うと自動的に作成されます。それ以外の情報をストリームする場合は，データの種類や保存の形式によって下位クラスを選択します。


TStream プロパティ3389002

TStream	アルファベット順

TStream

Position

Size


TStream プロパティ3389003

TStream	オブジェクト順

Position

Size


TStream.Position
TStream.Position3389004

TStream	参照

Position プロパティは，データの読み書きが行われるストリームにおける現在のオフセットを示します。

property Position: Longint;

説明

Position プロパティは，ストリームの現在位置を取得できます。Position はストリームでデータを読み書きするときにファイラオブジェクトが内部で使います。


TStream.Size
TStream.Size3389005

TStream	参照

Size プロパティは，ストリームのサイズをバイト数で示します。

property Size: Longint;

説明

Size プロパティは，ストリームのサイズを取得できます。Size はストリームのデータを読み書きするルーチンが内部で使います。TStream の Size プロパティを設定しても何の効果もありません。TStream のいくつかの下位オブジェクトは，ストリームを使ってアクセスするリソースのサイズをアプリケーションが変更できるようにするためにこのプロパティをオーバーライドします。


TStream メソッド3389006

TStream	アルファベット順	凡例

TStream

CopyFrom

Read

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

Seek

SetSize

Write

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TStream メソッド3389007

TStream	オブジェクト順	凡例

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyFrom

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Read

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

SafeCallException

Seek

SetSize

Write

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes


TStream.CopyFrom
TStream.CopyFrom3389008

TStream

CopyFrom メソッドは，指定したバイト数を別のストリームへコピーします。

function CopyFrom(Source: TStream; Count: Longint): Longint;

説明

CopyFrom メソッドを呼び出すと，データを別のストリームにコピーします。CopyFrom を使うと，データをコピーするときにバッファの作成，読み書き，および解放を行う必要がなくなります。

CopyFrom は，Source が指定するストリームの Count バイトを別のストリームにコピーします。そして，現在の位置を Count で指定するバイト数だけ移動し，コピーしたバイト数を返します。

Count がゼロのときは，CopyFrom は Source 位置をゼロに設定してからデータを読み出してストリームに Source の内容をすべてコピーします。Count がゼロ以外のときは，CopyFrom は Source の現在位置からデータを読み出します。


TStream.Read
TStream.Read3389009

TStream	参照

TStream オブジェクトは，Read を抽象メソッドとして提供します。

function Read(var Buffer; Count: Longint): Longint; virtual; abstract;

説明

各派生ストリームオブジェクトは，特定の記憶媒体（メモリやディスクファイルなど）からデータを読み出す Read メソッドを定義します。

Read はストリームから読み出すバイト数が決まっていない場合に使います。

Read 以外のストリームデータ読み出しメソッド（ReadBuffer，ReadComponent）は Read を呼び出して実際にデータを読み出します。


TStream.ReadBuffer
TStream.ReadBuffer3389010

TStream	参照

ReadBuffer メソッドは指定するバイト数をストリームから Buffer に読み出します。

procedure ReadBuffer(var Buffer; Count: Longint);

説明

ReadBuffer メソッドを呼び出すと，レコード内でデータを読み出すときのようにバイト数が固定されている場合にストリームからバッファに Count バイトを読み出すことができます。ReadBuffer はストリームからの読み出しやコピーのために内部で使用されます。

ReadBuffer は Read を呼び出して実際にデータを読み出します。ストリームから Count バイトを読み出せない場合，EReadError 例外が生成されます。


TStream.ReadComponent
TStream.ReadComponent3389011

TStream	参照

ReadComponent メソッドは，コンポーネントとそのプロパティのストリーミングを開始する方法の 1 つです。

function ReadComponent(Instance: TComponent): TComponent;

説明

ReadComponent メソッドは，グローバルルーチン ReadComponentRes や ReadComponentRes メソッドで間接的に呼び出されるか，あるいはコンポーネントのストリーミングを開始する場合に直接呼び出すことができます。

ReadComponent はストリームからデータ値を読み出して Instance のプロパティに代入します。次にリーダーオブジェクトを構築し，リーダーの ReadRootComponent メソッドを呼び出して Instance のプロパティ値を読み出すとともに，Instance の子としてストリームで定義された子オブジェクトを構築します。最後に，ReadComponent は構築したコンポーネントを返します。

Instance が nil の場合，ReadComponent はストリームの型情報に基づいてコンポーネントを構築し，新しく構築したコンポーネントを返します。


TStream.ReadComponentRes
TStream.ReadComponentRes3389012

TStream	参照

ReadComponentRes メソッドは，ストリームからコンポーネントとそのプロパティを Windows リソースファイル形式で読み出します。

function ReadComponentRes(Instance: TComponent): TComponent;

説明

ReadComponentRes メソッドは，グローバルルーチン ReadComponentResFile によって自動的に呼び出されます。またストリームの現在位置が WriteComponentRes メソッドで記述したコンポーネントを指しているときは直接呼び出すことができます。

ReadComponentResFile はファイルストリームオブジェクトを作成し，その ReadComponentRes メソッドを呼び出します。

ReadComponentRes は最初に ReadResHeader を呼び出してストリームのリソースヘッダーを読み出します。ストリームの現在位置にリソースヘッダーがないと，ReadResHeader は EInvalidImage 例外を生成します。次に ReadComponentRes は ReadComponent を呼び出してInstance を読み出します。


TStream.ReadResHeader
TStream.ReadResHeader3389013

TStream	参照

ReadResHeader メソッドは，ストリームから Windows リソースファイルヘッダーを読み出すためにストリーミングシステムによって内部で使用されます。

procedure ReadResHeader;

説明

ReadResHeader メソッドは直接呼び出さないでください。リソースファイルからコンポーネントを読み出す前に ReadComponentRes が自動的に呼び出します。

ReadResHeader はリソースファイルのヘッダーを読み出してから，ストリームの現在位置をヘッダーより 1 つ先に移動します。ストリームに有効なリソースファイルヘッダーがないと，ReadResHeader は EInvalidImage 例外を生成します。


TStream.Seek
TStream.Seek3389014

TStream

TStream は，Seek を抽象メソッドとして提供します。

function Seek(Offset: Longint; Origin: Word): Longint; virtual; abstract;

説明

各下位ストリームオブジェクトは，特定の記憶媒体（メモリやディスクファイルなど）にあるストリームの現在位置を移動する Seek メソッドを定義します。

Origin パラメータは Offset パラメータを解釈する方法を示します。Origin には次の値を指定します。

値	意味

soFromBeginning	Offset はリソースの始め。Seek は Offset の位置に移動する。Offset >= 0

soFromCurrent	Offset はリソースの現在位置。Seek は Position + Offset に移動する

soFromEnd	Offset はリソースの終わり。Offset <= 0 でファイルの終わりまでのバイト数を示す

Seek は Position および Size プロパティによって呼び出されます。


TStream.SetSize
TStream.SetSize3389015

TStream

SetSize メソッドは TStream では何もしません。

procedure SetSize(NewSize: Longint); virtual;

説明

SetSize は TStream では何もしません。派生ストリームクラスはこのメソッドをオーバーライドして，それぞれのオブジェクトの Size プロパティを設定できます。SetSize は Size プロパティの書き込み手続きです。

注意

下位クラスではプロパティの定義を変更できないので，SetSize は何もしなくても TStream に導入されています。したがって，SetSize は Size が導入されるときに導入される必要があります。


TStream.Write
TStream.Write3389016

TStream	参照

TStream は，Write を抽象メソッドとして提供します。

function Write(const Buffer; Count: Longint): Longint; virtual; abstract;

説明

各下位ストリームオブジェクトは，特定の記憶媒体（メモリやディスクファイルなど）にデータを書き込む Write メソッドを定義します。Write 以外のストリームデータ書き込みメソッド（WriteBuffer，WriteComponent）は Write を呼び出して実際にデータを書き込みます。


TStream.WriteBuffer
TStream.WriteBuffer3389017

TStream	参照

WriteBuffer メソッドは，Count バイトを Buffer からストリームに書き込み，ストリームの現在位置を Count で指定するバイト数だけ進めます。

procedure WriteBuffer(const Buffer; Count: Longint);

説明

WriteBuffer メソッドを呼び出すと，ストリームにデータを保存できます。WriteBuffer および ReadBuffer は，レコード内でデータを読み出すときのようにバイト数が指定されている場合に使われます。標準的なファイル入出力ストリームには WriteBuffer を使ってください。

WriteBuffer はストリームへの書き込みやストリームからのコピーのために内部で使われます。このメソッドは，他のオブジェクト（文字列やリストなど）がバッファに文字列を書き込むために使います。

WriteBuffer は Write を呼び出して実際にデータを書き込みます。指定されたすべてのバイトをストリームに書き込めなかった場合には EWriteError 例外が発生します。


TStream.WriteComponent
TStream.WriteComponent3389018

TStream	参照

WriteComponent メソッドは，コンポーネントおよびそのプロパティのストリームへの書き込みを開始する方法の 1 つです。

procedure WriteComponent(Instance: TComponent);

説明

WriteComponent メソッドは，Delphi ストリーミングシステムの内部で使われますが，コンポーネントをメモリストリームやデータベースの BLOB（バイナリ大規模オブジェクト）に書き込むときに直接呼び出すこともできます。

WriteComponent はライターオブジェクトを構築してその WriteRootComponent メソッドを呼び出し，Instance で指定したコンポーネントとその所有オブジェクトをストリームに書き込みます。


TStream.WriteComponentRes
TStream.WriteComponentRes3389019

TStream	参照

WriteComponentRes メソッドは，Windows リソースファイル形式からコンポーネントおよびそのプロパティをストリームへ書き込みます。

procedure WriteComponentRes(const ResName: string; Instance: TComponent);

説明

WriteComponentRes メソッドは Delphi ストリーミングシステムの内部で使われますが，データをディスク上の他のアプリケーションに送るときに直接呼び出すこともできます。WriteComponentRes は，ビットマップやアイコンなどのデータを Windows リソースファイル形式で格納するコンポーネントのストリーミングに使われます。

WriteComponentRes は WriteDescendentRes を呼び出し，Ancestor として nil を渡します。したがって WriteDescendentRes は，この場合は下位ではないコンポーネントに対するストリーミングプロセスの続きを開始します。

WriteComponentRes で記述したコンポーネントを読み出すには ReadComponentRes メソッドを呼び出します。


TStream.WriteDescendent
TStream.WriteDescendent3389020

TStream	参照

WriteDescendent メソッドは，継承フォーム内のコンポーネントとそのプロパティをストリームするためにストリーミングシステムの内部で使われます。

procedure WriteDescendent(Instance, Ancestor: TComponent);

説明

WriteDescendent メソッドは直接呼び出さないでください。WriteDescendent は WriteComponent が自動的に呼び出します。

WriteDescendent はライターオブジェクトを構築してその WriteDescendent メソッドを呼び出し，Instance に渡されたコンポーネントをストリームに書き込みます。Instance は Ancestor から派生した継承フォームか nil のどちらかです。ただし，WriteDescendent は所有されたコンポーネントを書き込むためには使わず，ルートコンポーネントでストリームを開始するためだけに使います。


TStream.WriteDescendentRes
TStream.WriteDescendentRes3389021

TStream	参照

WriteDescendentRes メソッドは，継承フォーム内のコンポーネントとそのプロパティをストリームするためにストリーミングシステムの内部で使われます。

procedure WriteDescendentRes(const ResName: string; Instance, Ancestor: TComponent);

説明

WriteDescendentRes メソッドは直接呼び出さないでください。WriteDescendentRes は WriteComponentRes が自動的に呼び出します。

WriteDescendentRes は，ResName に渡された名前をリソース名として使って標準の Windows リソースファイルヘッダーをストリームに書き込みます。次に WriteDescendent を呼び出して Instance を Ancestor の下位としてストリームに書き込みます。


スコープ3389022

protected


継承3389023

TObject


TStream 例3389024

TStream


TStringGridStrings
TStringGridStrings3390001

継承	プロパティ	メソッド	参照

TStringGridStrings は文字列グリッドのセルに表示される文字列リストを保持します。

ユニット

grids

説明

TStringGridStrings をアプリケーションで直接使ってはいけません。TStringGridStrings は TStringGrid オブジェクトとともに動作するように設計されており，文字列グリッドによって作成され，グリッドの行または列に文字列（および関連付けられたオブジェクト）を表示します。


TStringGridStrings のプロパティ3390002

TStringGridStrings	アルファベット順	凡例

TStringGridStrings

Count

Objects

Strings

TStrings からの継承

Capacity

CommaText

Names

StringsAdapter

Text

Values


TStringGridStrings のプロパティ3390003

TStringGridStrings	オブジェクト順	凡例

Capacity

CommaText

Count

Names

Objects

StringsAdapter

Strings

Text

Values


TStringGridStrings.Count
TStringGridStrings.Count3390004

TStringGridStrings	参照

Count プロパティは，Strings プロパティ配列内の要素数です。

property Count: Integer;

説明

Count プロパティは，TStringGridStrings のインスタンスで扱う文字列の数を指定できます。 TStringGridStrings オブジェクトがグリッドの行内の文字列を表す場合，Count はそのグリッド内の列の数となります。TStringGridStrings オブジェクトがグリッドの列内の文字列を表す場合，Count はそのグリッド内の行の数となります。


TStringGridStrings.Objects
TStringGridStrings.Objects3390005

TStringGridStrings	参照

Objects プロパティは，Strings プロパティで示される文字列に関連付けられたオブジェクトのインデックス付き配列です。

property Objects[Index: Integer]: TObject;

説明

Objects プロパティは，Strings 配列内の文字列に関連付けられたオブジェクトを取得できます。1 つのオブジェクトがStrings 配列内の文字列に関連付けるには Objects を設定します。Objects 配列内の各要素は，文字列グリッドの Objects プロパティ配列内の対応するセルの要素と同じオブジェクトを指します。


TStringGridStrings.Strings
TStringGridStrings.Strings3390006

TStringGridStrings	参照

Strings プロパティは，TStringGridStrings オブジェクトで示される文字列グリッドの行内または列内に表示される文字列のインデックス付き配列です。

property Strings[Index: Integer]: string;

説明

Strings プロパティは，TStringGridStrings オブジェクトで示される行内または列内の 1 つのセル内の文字列を取得および設定できます。各文字列は，文字列グリッドの対応するセル内に表示されます。文字列に関連付けられたオブジェクトを探すには Objects プロパティ配列を使います。


TStringGridStrings のメソッド3390007

TStringGridStrings	アルファベット順

TStringGridStrings

Assign

Create

Delete

Insert

Derived from TStrings からの継承

Add

AddObject

AddStrings

Append

BeginUpdate

Clear

Destroy

EndUpdate

Equals

Exchange

GetText

IndexOf

IndexOfName

IndexOfObject

InsertObject

LoadFromFile

LoadFromStream

Move

SaveToFile

SaveToStream

SetText

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TStringGridStrings のメソッド3390008

TStringGridStrings	オブジェクト順

AddObject

AddStrings

Add

Append

Assign

BeginUpdate

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Delete

Destroy

Dispatch

EndUpdate

Equals

Exchange

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

GetText

IndexOfName

IndexOfObject

IndexOf

InheritsFrom

InitInstance

InsertObject

Insert

InstanceSize

LoadFromFile

LoadFromStream

MethodAddress

MethodName

Move

NewInstance

SafeCallException

SaveToFile

SaveToStream

SetText


TStringGridStrings.Assign
TStringGridStrings.Assign3390009

TStringGridStrings	参照

Assign メソッドは，別の TStrings オブジェクトから文字列やオブジェクトのリストをコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドを呼び出すと，TStrings 型のソースオブジェクトから文字列やオブジェクトをコピーできます。ソースオブジェクトが保持している文字列の数が TStringGridStrings オブジェクトで示される行内または列内のセルの数よりも多い場合，Assign は Count の最初の文字列とオブジェクトだけをコピーします。

Source パラメータが TStrings オブジェクトでない場合，Assign は継承されたメソッドを呼び出します。


TStringGridStrings.Create
TStringGridStrings.Create3390010

TStringGridStrings	参照

Create メソッドは，TStringGridStrings のインスタンスを作成します。

constructor Create(AGrid: TStringGrid; AIndex: Longint);

説明

アプリケーションは TStringGridStrings のインスタンスを作成する必要はありません。String グリッドが各々の行や列に対して TStringGridStrings オブジェクトを作成し，グリッド内のセルに関連付けられた文字列やオブジェクトに素早くアクセスできるようにします。

AGrid パラメータは，TStringGridStrings オブジェクトを使う文字列グリッドを指定します。AIndex パラメータは TStringGridStrings オブジェクトに関連付けられた行または列のインデックスを指定します。AIndex が 0 よりも大きい場合，TStringGridStrings オブジェクトは AIndex でインデックス付けされた行を表します。AIndex が 0 よりも小さい場合，TStringGridStrings オブジェクトは AIndex の絶対値でインデックス付けされた列を表します。AIndex が 0 の場合，TStringGridStrings オブジェクトは空の行または列を表します。


TStringGridStrings.Delete
TStringGridStrings.Delete3390011

TStringGridStrings	参照

Delete メソッドは，継承されたメソッドをオーバーライドして，文字列が削除されるのを防ぎます。

procedure Delete(Index: Integer); override;

説明

TStringGridStrings オブジェクトは文字列グリッドの行または列を表すため，リスト内の要素数は，対応する行内または列内のセルの数と正確に一致する必要があります。要素の削除を許可するというよりも，この対応関係を壊すと，Delete は EInvalidGridOperation 例外を発生させます。


TStringGridStrings.Insert
TStringGridStrings.Insert3390012

TStringGridStrings	参照

Insert メソッドは，継承されたメソッドをオーバーライドして，文字列が挿入されるのを防ぎます。

procedure Insert(Index: Integer; const S: string); override;

説明

TStringGridStrings オブジェクトは文字列グリッドの行または列を表すため，リスト内の要素の数は，対応する行内または列内のセルの数と正確に一致する必要があります。要素の挿入を許可するというよりも，この対応関係を壊すと，Insert は EInvalidGridOperation 例外を発生させます。


アクセス種別3390013

読み出し専用


継承3390014

TObject

TPersistent

TStrings


TStringGridStrings の例3390015

TStringGridStrings


TStrings
TStrings3391001

継承	プロパティ	メソッド	参照

TStrings オブジェクトは文字列リストを表すオブジェクトの基本となる抽象クラスです。

ユニット

classes

説明

文字列リストを格納および操作するには，TStrings からクラスを派生させます。TStrings の下位オブジェクトはリストボックスに表示される行などの個々の文字列を表すことができます。いくつかのオブジェクトは TStrings の下位オブジェクトを使って 1 つの長いテキストを表し，小さなまとまりで処理できるようにします。

TStrings はさまざまなプロパティとメソッドを導入して以下の操作を可能にします。

・	リスト内の指定の位置で文字列を追加または削除する

・	リストで文字列を再配置する

・	特定の位置で文字列にアクセスする

・	ファイルまたはストリームの文字列を読み書きする

・	リスト内の各文字列にオブジェクトを関連付ける


TStrings プロパティ3391002

TStrings	アルファベット順	凡例

TStrings

Capacity

CommaText

Count

Names

Objects

Strings

StringsAdapter

Text

Values


TStrings プロパティ3391003

TStrings	オブジェクト順	凡例

Capacity

CommaText

Count

Names

Objects

Strings

StringsAdapter

Text

Values


TStrings.Capacity
TStrings.Capacity3391004

TStrings	参照

Capacity プロパティは，TStrings オブジェクトが保持できる文字列の数を示します。

property Capacity: Integer;

説明

Capacity プロパティは，現在の割り当てられている文字列のサイズを調べられます。Capacity は 単に Count プロパティを返すだけです。TStrings の派生オブジェクトはこのプロパティをオーバーライドして，文字列リストがリストに追加されていないエントリにメモリを割り当てられるようにします。


TStrings.CommaText
TStrings.CommaText3391005

TStrings	参照

CommaText プロパティは，システムデータ形式（SDF）でリストに入っている TStrings オブジェクト内の文字列リストです。

property CommaText: string;

CommaText プロパティは TStrings オブジェクト内のすべての文字列を単一のカンマ区切り文字列として取得および設定できます。

CommaText を取得するときに文字列リストの文字列にスペース，カンマ，または引用符がある場合には，文字列は二重引用符で囲まれ，二重引用符がある場合には二重引用符が連続して付けられます。たとえば，文字列リストに次の文字列があるとします。

Stri,ng 1

Striﾓng 2

String 3

String4

CommaText は次を返します。

ﾒStri,ng 1ﾓ,ﾓStriﾓﾓng 2ﾓ,ﾓString 3ﾓ,String4

CommaText を割り当てる場合，値は SDF 書式付きテキストとして解析されます。SDF 形式の場合，文字列はスペースまたはカンマで区切られ，任意で二重引用符で囲まれます。文字列に二重引用符がある場合，元の文字列と文字列を囲む引用符を区別するために続けて引用符を付けます。二重引用符で囲まれていないスペースおよびカンマは区切り記号です。2 つ並んだカンマは空の文字列を意味しますが，区切り記号の前後にあるスペースは無視されます。たとえば，CommaText を次のように設定するとします。

ﾒStri,ng 1ﾓ, ﾓStriﾓﾓng 2ﾓ , String 3,String4

リストには次の文字列が含まれます。

Stri,ng 1

Striﾓng 2

String

3

String4

注意

CommaText を読み出すには Strings プロパティを使ってテキストを取得します。CommaText を設定するには Add メソッドを使ってテキストを設定します。


TStrings.Count
TStrings.Count3391006

TStrings	参照

TStrings は抽象プロパティとして Count を導入して文字列リスト内の文字列数を表します。

property Count: Integer;

説明

TStrings の下位オブジェクトは Count プロパティ を実現して文字列リスト内の文字列の数を示します。

Count プロパティはリスト内のすべての文字列に対して繰り返し処理を行うとき，またはリストの最後の文字列に対する文字列の位置を特定するときに使います。


TStrings.Names
TStrings.Names3391007

TStrings	参照

形式が「名前 = 値」というリスト内の文字列の場合，Names は文字列の名前の部分だけを返します。

property Names[Index: Integer]: string;

説明

TStrings オブジェクトで使う文字列リストに形式が「名前 = 値」の文字列がある場合，Names を読み出すと文字列の名前の部分にアクセスできます。Names は Index 位置にある文字列の名前部分です。Index は文字列の位置で，0 が最初の文字列，1 が 2 番目の文字列のように表します。指定した位置の文字列が「名前 = 値」の形式ではない場合，Names は空の文字列を返します。

形式が「名前 = 値」の文字列は一般に .INI ファイルの中にあります。以下に DELPHI.INI ファイルの文字列の例を示します。

DisplayGrid=1

SnapToGrid=1

GridSizeX=8

GridSizeY=8

データベースコンポーネント（TDatabase）の Params プロパティにもこの形式の文字列があります。

文字列を識別する Name は等号（=）の左側に置かれ，Name 識別子の現在の Value は等号の右側に置かれます。等号の前後に空白は入れません。

注意

Names は Strings プロパティを使って文字列を取得します。


TStrings.Objects
TStrings.Objects3391008

TStrings	参照

Objects は Strings プロパティの各文字列に関連付けられたオブジェクトの集合を表すプロパティとして提供されます。

property Objects[Index: Integer]: TObject;

説明

TStrings に対して Objects プロパティを設定しても意味はありません。TStrings に対して Objects プロパティを読み出しても nil が返されます。Objects プロパティを実現することで，下位クラスは集合内の文字列とオブジェクトを関連付けられます。

TStrings の下位の Objects プロパティを使うと Index 位置の文字列を取得または設定できます。Index は文字列の位置で，0 なら最初の文字列，1 なら 2 番目の文字列のように表します。TStrings の下位オブジェクトが Objects プロパティをサポートしない場合には Objects プロパティは nil を返します。


TStrings.Strings
TStrings.Strings3391009

TStrings	参照

TStrings は Strings を抽象プロパティとして導入してリスト内の文字列をそれぞれの位置で参照します。

property Strings[Index: Integer]: string;

説明

TStrings の下位オブジェクトは，Index 位置の文字列を返すために Strings プロパティで使う参照用の関数を実現しなければなりません。Index は文字列の位置で，0 なら最初の文字列，1 なら 2 番目の文字列のように表します。

Strings プロパティを使うと特定の位置の文字列を取得または設定できます。Strings は TStrings オブジェクトのデフォルトのプロパティです。TStrings の下位の Strings プロパティを参照するときには Strings 識別子を省略しても問題はありません。たとえば次の 2 行のコードはどちらも受け入れられ，同じ処理を行います。

MyStrings.Strings[0] := 'This is the first string';

MyStrings[0] := 'This is the first string';


TStrings.StringsAdapter
TStrings.StringsAdapter3391010

TStrings	参照

StringsAdapter プロパティは，TStrings オブジェクトが OLE を使って通信できるようにする IStrings インターフェースを格納します。

property StringsAdapter: IStringsAdapter;

説明

StringsAdapter プロパティを使わないでください。StringsAdapter は，ActiveX コントロールが OLE インターフェースを通して情報通信するために内部で使います。


TStrings.Text
TStrings.Text3391011

TStrings	参照

Text は TStrings オブジェクトの文字列リストで復帰と改行で区切られた個々の文字列を表します。

property Text: string;

説明

Text を使うと TStrings オブジェクトのすべての文字列の中で復帰と改行で区切られた文字列を取得または設定できます。

Text を読み出す場合，文字列リストの文字列は復帰と改行で区切られます。文字列リストに復帰と改行で区切られた文字列がある場合には，Text の値は Count プロパティで示される数よりも大きくなります。

Text を設定する場合，値は復帰と改行（この 2 つは組になっている必要はありません）が見つかるたびに部分文字列に区切られて解析されます。

リストの文字列が復帰または改行文字で区切られている場合には，CommaText プロパティを使うことによってより可読性の高い形式で文字列を表示できます。

注意

Text を読み出すには Strings プロパティを使ってテキストを取得します。Text を書き込むには Add メソッドを使ってテキストを設定します。


TStrings.Values
TStrings.Values3391012

TStrings	参照

形式が「名前 = 値」というリスト内の文字列の場合，Values は指定した名前に関連付けられた文字列の値の部分だけを返します。

property Values[const Name: string]: string;

説明

TStrings オブジェクトで使う文字列リストに形式が「名前 = 値」の文字列がある場合，Values を使うと指定した名前の部分に関連付けられた文字列の値の部分を取得または設定できます。リストに適切な「名前 = 値」の形式の文字列がない場合，または文字列が Name インデックスに一致しない場合には，Values は空の文字列を返します。

形式が「名前 = 値」の文字列は一般に .INI ファイルの中にあります。以下に DELPHI.INI ファイルの文字列の例を示します。

DisplayGrid=1

SnapToGrid=1

GridSizeX=8

GridSizeY=8

データベースコンポーネント（TDatabase）の Params プロパティにもこの形式の文字列があります。

文字列を識別する Name は等号（=）の左側に置かれ，Name 識別子の現在の Value は等号の右側に置かれます。等号の前後に空白は入れません。

注意

Values を読み出すには Strings プロパティを使って値を取得します。Values を書き込むには Insert メソッドを使って値を設定します。


TStrings メソッド3391013

TStrings	アルファベット順

TStrings

Add

AddObject

AddStrings

Append

Assign

BeginUpdate

Clear

Delete

EndUpdate

Equals

Exchange

GetText

IndexOf

IndexOfName

IndexOfObject

Insert

InsertObject

LoadFromFile

LoadFromStream

Move

SaveToFile

SaveToStream

SetText

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TStrings メソッド3391014

TStrings	オブジェクト順

Add

AddObject

AddStrings

Append

Assign

BeginUpdate

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Delete

Destroy

Dispatch

EndUpdate

Equals

Exchange

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetText

IndexOf

IndexOfName

IndexOfObject

InheritsFrom

InitInstance

Insert

InsertObject

InstanceSize

LoadFromFile

LoadFromStream

MethodAddress

MethodName

Move

NewInstance

SafeCallException

SaveToFile

SaveToStream

SetText


TStrings.Add
TStrings.Add3391015

TStrings	参照

Add メソッドは文字列リストに新しい文字列を追加します。

function Add(const S: string): Integer; virtual;

説明

Add を呼び出すと文字列リストの最後に文字列を追加できます。Add は新しい文字列のインデックスを返します。

注意

Add は Insert メソッドを使って文字列を追加します。


TStrings.AddObject
TStrings.AddObject3391016

TStrings	参照

AddObject メソッドは文字列リストに文字列を追加して，その文字列にオブジェクトを関連付けます。

function AddObject(const S: string; AObject: TObject): Integer; virtual;

説明

AddObject を呼び出すと文字列とそれに関連付けられたオブジェクトをリストに追加できます。AddObject は新しい文字列とオブジェクトのインデックスを返します。

注意

AddObject は Add メソッドを使って文字列を追加し，Objects プロパティでオブジェクトを関連付けます。


TStrings.AddStrings
TStrings.AddStrings3391017

TStrings	参照	例

AddStrings メソッドは文字列リストに文字列をまとめて追加します。

procedure AddStrings(Strings: TStrings); virtual;

説明

AddStrings を呼び出すと文字列を別の TStrings オブジェクトから文字列リストに追加できます。ソースとターゲットの両方の TStrings オブジェクトが自身の文字列に関連付けられたオブジェクトをサポートしている場合には，関連オブジェクトへの参照も追加されます。

注意

AddStrings は Add メソッドを使って文字列を追加して，Objects プロパティでオブジェクトを関連付けます。


TStrings.Append
TStrings.Append3391018

TStrings	参照

Append メソッドは文字列を文字列リストに追加します。

procedure Append(const S: string);

説明

Append は Add メソッドと機能は同じですが，値を返しません。Append は，追加後の文字列のインデックスを知る必要のない場合に使うか，インデックスを返しても意味がない TStrings の下位オブジェクトで使います。

たとえば，メモ型オブジェクトが使う TStrings の下位オブジェクトはインデックスで文字列の挿入先を判断しますが，挿入した文字列がリストに単一の文字列として収まるとは限りません。挿入したテキストの一部が直前の文字列の一部になったり，分割されて直後の文字列になったりする場合があります。この場合には Add が返すインデックスに意味はありません。

TGetStrProc を必要とする関数の場合には，Add ではなく Append をパラメータとして使います。


TStrings.Assign
TStrings.Assign3391019

TStrings	参照

Assign メソッドはリストの文字列と（もしあれば）関連オブジェクトをソースオブジェクトから設定します。

procedure Assign(Source: TPersistent); override;

説明

Assign を使うと別のオブジェクトから TStrings オブジェクトの値を設定できます。Source が TStrings 型の場合にはリストはソース TStrings オブジェクトのリストに設定され，関連付けられたオブジェクトがサポートされる場合にはそれらのオブジェクトもすべて Source からコピーされます。

Source がTStrings 型でない場合には，継承された Assign は TStrings をサポートするすべてのオブジェクトからその AssignTo メソッドを使って値を設定します。


TStrings.BeginUpdate
TStrings.BeginUpdate3391020

TStrings	参照

BeginUpdate メソッドを使うと TStrings オブジェクトでいつ文字列リストが変更処理されるかをトラッキングできます。

procedure BeginUpdate;

説明

BeginUpdate は，文字列リストを変更するプロパティまたはメソッドによって自動的に呼び出されます。変更が完了すると，プロパティまたはメソッドは EndUpdate を呼び出します。文字列リストの文字列を直接修正する前に BeginUpdate を呼び出してから EndUpdate を呼び出してください。TStrings の下位オブジェクト内の文字列リストを変更するプロパティまたはメソッドを実装する場合，BeginUpdate を呼び出してから変更を加え，変更が完了したときに EndUpdate を呼び出してください。

TStrings は文字列リストが変更処理されているときにその情報をトレースするだけです。TStrings の下位オブジェクトのいくつかは，更新が完了したときにこの変更情報を使ってコントロールに再描画させるなどのアクションを実行します。


TStrings.Clear
TStrings.Clear3391021

TStrings	参照

TStrings は抽象メソッドとして Clear を導入し，リストおよび関連付けられたすべてのオブジェクトを空にします。

procedure Clear; virtual; abstract;

説明

TStrings の下位オブジェクトは Clear メソッドを実装して文字列リストの文字列および関連付けられたオブジェクトへの参照をすべて削除します。


TStrings.Delete
TStrings.Delete3391022

TStrings	参照

TStrings は抽象メソッドとして Delete を導入し，指定した文字列を文字列リストから削除します。

procedure Delete(Index: Integer); virtual; abstract;

説明

TStrings の下位オブジェクトは Delete メソッドを実装して指定した文字列を文字列リストから削除します。オブジェクトが文字列と関連付けられている場合，そのオブジェクトへの参照も削除されます。Index は文字列の位置で，0 が最初の文字列，1 が 2 番目の文字列のように表します。


Destroy

Destroy メソッドは，TStrings のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは，Destroy メソッドを直接呼び出さないでください。かわりに Free を呼び出して，TStrings オブジェクトが解放されていないことを確認してから Destroy を呼び出すようにします。


TStrings.EndUpdate
TStrings.EndUpdate3391024

TStrings	参照

EndUpdate を使うと TStrings オブジェクトで文字列リストの変更完了をトレースできます。

procedure EndUpdate;

説明

EndUpdate は，文字列リストを変更するプロパティまたはメソッドによって自動的に呼び出されます。文字列リストの文字列を直接修正する前に BeginUpdate を呼び出してから EndUpdate を呼び出してください。TStrings の下位オブジェクト内の文字列リストを変更するプロパティまたはメソッドを実装する場合，BeginUpdate を呼び出してから変更を加え，変更が完了したときに EndUpdate を呼び出してください。

TStrings は文字列リストが変更処理されているときにその情報をトレースするだけです。TStrings の下位オブジェクトのいくつかは，更新が完了したときにこの変更情報を使ってコントロールに再描画させるなどのアクションを実行します。


TStrings.Equals
TStrings.Equals3391025

TStrings	参照

Equals メソッドは文字列リストと別の TStrings オブジェクトの文字列リストを比較して一致すれば True を返します。

function Equals(Strings: TStrings): Boolean;

説明

Equals を呼び出して 2 つの TStrings オブジェクト内のリストを比較します。Equals は文字列だけを比較し，関連付けられたオブジェクトへの参照は比較しません。Equals は両方の TStrings オブジェクトに同じ数の文字列があり，各文字列リストの文字列が等しい場合には True を返します。文字列，または文字列リスト内の文字列の順序が異なる場合には Equals は False を返します。


TStrings.Exchange
TStrings.Exchange3391026

TStrings	参照

Exchange メソッドは文字列リストの文字列の位置を入れ替えます。

procedure Exchange(Index1, Index2: Integer); virtual;

説明

Exchange を呼び出してリスト内の文字列を入れ替えます。入れ替える文字列は Index1パラメータおよび Index2 パラメータのインデックス値で指定します。インデックスは 0 から始まるので，リストの最初の項目のインデックス値は 0，2 番目の項目のインデックス値は 1 です。

文字列オブジェクトまたは文字列リストオブジェクトの文字列に関連付けられたオブジェクトがある場合，Exchange は文字列とオブジェクト両方の位置を変更します。


TStrings.GetText
TStrings.GetText3391027

TStrings	参照

GetText メソッドはテキストバッファを割り当て，Text プロパティの値を取得します。

function GetText: PChar; virtual;

説明

GetText を呼び出して，リスト内の文字列すべてを格納している，動的に割り当てられた文字列バッファを取得します。個々の文字列は復帰と改行で区切られています。呼び出し側は戻り値を解放しなければなりません。

注意

GetText は Strings プロパティを使って文字列を取得します。


TStrings.IndexOf
TStrings.IndexOf3391028

TStrings	参照

IndexOf メソッドはリスト内の文字列の位置を返します。

function IndexOf(const S: string): Integer; virtual;

説明

IndexOf を呼び出して文字列 S の最初の位置を取得します。IndexOf は 0 から始まる文字列のインデックス値を返します。このようにして S がリスト内の最初の文字列と一致した場合には IndexOf は 0を返し，S が 2 番目と一致した場合には IndexOf は 1 を返します。文字列リストにその文字列がない場合には IndexOf は -1 を返します。

注意

同じ文字列がリスト内に複数ある場合，IndexOf は最初に見つかった文字列の位置を返します。


TStrings.IndexOfName
TStrings.IndexOfName3391029

TStrings	参照

IndexOfName メソッドは「名前 = 値」という形式の文字列について，その名前部分の Index を返します。

function IndexOfName(const Name: string): Integer;

説明

IndexOfName を呼び出して，「名前 = 値」つまり名前の部分が Name パラメータと等しい形式の文字列が最初に見つかった位置を示します。IndexOfName は 0 から始まる文字列のインデックス値を返します。指定した名前が文字列リストにない場合，IndexOfName は -1 を返します。

「名前 = 値」の形式の文字列は一般に .INI ファイルに見られます。以下に DELPHI.INI ファイルからの例を示します。

DisplayGrid=1

SnapToGrid=1

GridSizeX=8

GridSizeY=8

データベースコンポーネント（TDatabase）の Params プロパティにもこの形式の文字列があります。

文字列を識別する Name は等号（=）の左側に置かれ，Name 識別子の現在の Value は等号の右側に置かれます。等号の前後に空白は入れません。

注意

名前の部分が Name パラメータと一致する文字列が複数ある場合には IndexOfName は最初の文字列の位置を返します。


TStrings.IndexOfObject
TStrings.IndexOfObject3391030

TStrings	参照

IndexOfObject メソッドは文字列リスト内で指定したオブジェクトと関連付けられた最初の文字列のインデックスを返します。

function IndexOfObject(AObject: TObject): Integer;

説明

IndexOfObject を呼び出してリスト内でオブジェクト AObject と関連付けられている最初の文字列の位置を示します。検索するオブジェクトを AObject パラメータで指定します。IndexOfObjectは 0 で始まる文字列とオブジェクトのインデックスを返します。オブジェクトが文字列に関連付けられていないときには IndexOfObject は -1 を返します。


TStrings.Insert
TStrings.Insert3391031

TStrings	参照

TStrings は抽象メソッドとして Insert を導入して指定した位置に文字列を挿入します。

procedure Insert(Index: Integer; const S: string); virtual; abstract;

説明

TStrings の下位オブジェクトは Insert メソッドを実装して文字列 S を Index で指定した位置に挿入します。Index が 0 のときには文字列はリストの先頭に挿入されます。Index が 1 のときには文字列はリストの 2 番目に挿入されます。

文字列リストに文字列を追加するすべてのメソッドは Insert メソッドを使って文字列を追加します。

文字列に関連付けられたオブジェクトがないときには，Insert ではなく InsertObject メソッドを使います。


TStrings.InsertObject
TStrings.InsertObject3391032

TStrings	参照

InsertObject メソッドは指定した位置に文字列を挿入して，それをオブジェクトと関連付けます。

procedure InsertObject(Index: Integer; const S: string; AObject: TObject);

説明

InsertObject を呼び出して文字列 S を Index 値で指定した位置に挿入して，それをオブジェクト AObject と関連付けます。Index が 0 のときには文字列はリストの先頭に挿入されます。Index が 1 のときには文字列はリストの 2 番目に挿入されます。


TStrings.LoadFromFile
TStrings.LoadFromFile3391033

TStrings	参照

LoadFromFile メソッドは指定したファイルのテキスト行をリストに取得します。

procedure LoadFromFile(const FileName: string); virtual;

説明

LoadFromFile を呼び出して FileName で指定したファイルから TStrings オブジェクトのリストを取得します。ファイルの各行は，復帰または改行で示されるように，リストでは 1 個の文字列として追加されます。

注意

LoadFromFile は Add メソッドを使ってファイルから読み出した文字列を追加します。


TStrings.LoadFromStream
TStrings.LoadFromStream3391034

TStrings	参照

LoadFromStream メソッドはストリームから読み出したテキスト行をリストに取得します。

procedure LoadFromStream(Stream: TStream); virtual;

説明

LoadFromStream を呼び出して Stream で指定したストリームから TStrings オブジェクトのリストを取得します。ストリームから読み出したテキストは復帰または改行で区切られた文字列として解析されます。このようにして LoadFromStream は Text プロパティの値を読み出します。

ストリームがファイルストリームのときには，アプリケーションがファイルストリームを作成および廃棄しなけらばならないという点を除けば，LoadFromStream は LoadFromFile と同じことをします。

注意

LoadFromStream は Add メソッドを使ってストリームされる文字列を追加します。


TStrings.Move
TStrings.Move3391035

TStrings	参照

Move メソッドはリスト内の文字列の位置を変更します。

procedure Move(CurIndex, NewIndex: Integer); virtual;

説明

Move を使うと，位置 CurIndex を NewIndex に変更することで文字列を移動します。位置は 0 で始まるインデックスで指定します。たとえば，次のコード行は文字列の位置をリストの先頭から最後に移動します。

MyStringsObject.Move(0, MyStringsObject.Count - 1);

文字列がオブジェクトに関連付けられていると，Move は文字列とそのオブジェクトの両方の位置を変更します。


TStrings.SaveToFile
TStrings.SaveToFile3391036

TStrings	参照

SaveToFile メソッドはリストの文字列を指定したファイルに保存します。

procedure SaveToFile(const FileName: string); virtual;

説明

SaveToFile を呼び出して FileName で指定したファイルにリストの文字列を保存します。リストの各文字列は行ごとにファイルに書き込まれます。

注意

SaveToFile は Strings プロパティを使って保存する文字列を取得します。


TStrings.SaveToStream
TStrings.SaveToStream3391037

TStrings	参照

SaveToStream メソッドはストリームオブジェクトに Text プロパティの値を保存します。

procedure SaveToStream(Stream: TStream); virtual;

説明

SaveToStream を呼び出して Stream パラメータで指定したストリームにリスト内の文字列を保存します。SaveToStream は復帰および改行で区切られた文字列を書き込みます。ストリームがファイルストリームのときには，アプリケーションがファイルストリームを作成および廃棄しなければならないという点を除けば，SaveToStream は SaveToFile と同じことをします。

注意

SaveToStream は Strings プロパティを使って保存する文字列を取得します。


TStrings.SetText
TStrings.SetText3391038

TStrings	参照

SetText メソッドは Text プロパティを設定します。

procedure SetText(Text: PChar); virtual;

説明

SetTextを呼び出して Text パラメータで指定した文字列でリストを置換します。SetText は，Text 内の復帰または改行文字を新しい文字列を追加するための区切り記号として使うことで，1 回に 1 個の文字列をリストに追加します。

注意

SetText は Add メソッドを使って文字列を追加します。


読み出し／書き込み3391039

読み出し専用


継承3391040

TObject

TPersistent


TStrings 例3391041

TStrings


TStringStream
TStringStream3392001

継承	プロパティ	メソッド	参照

TStringStream は長い文字列として格納されている情報へのファイルアクセスを提供します。

ユニット

classes

説明

TStringStream を使うと，入出力機能を持つように拡張された長い文字列としてデータを格納できます。TStringStream は別の記憶媒体へテキストを読み書きできるだけでなく，テキストを保持することもできる媒介オブジェクトとして便利です。


TStringStream プロパティ3392002

TStringStream	アルファベット順	凡例

TStringStream

DataString

TStream からの継承

Position

Size


TStringStream プロパティ3392003

TStringStream	オブジェクト順	凡例

DataString

Position

Size


TStringStream.DataString
TStringStream.DataString3392004

TStringStream	参照

DataString プロパティは TStringStream オブジェクトによって表されたテキストを格納する文字列へ直接アクセスできるようにします。

property DataString: string;

説明

DataString を使うとストリームのテキストへアクセスできます。テキストは文字列ストリームによって転送される文字列です。Size プロパティは文字列内のバイト数で，Position プロパティは DataString 内の現在位置を示します。

注意

DataString は 読み出し専用プロパティです。DataString を使うと文字列の内容を変更できますが，アプリケーションは DataString 自体を変更することはできません。


TStringStream メソッド3392005

TStringStream	アルファベット順

TStringStream

Create

Read

ReadString

Seek

Write

WriteString

TStream からの継承

CopyFrom

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TStringStream メソッド3392006

TStringStream	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyFrom

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Read

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

ReadString

SafeCallException

Seek

Write

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

WriteString


TStringStream.Create
TStringStream.Create3392007

TStringStream	参照

Create メソッドは，TStringStream のインスタンスを作成します。

constructor Create(AString: string);

説明

Create を呼び出すと TStringStream オブジェクトをインスタンス化できます。Create は DataString プロパティを AString パラメータで初期化します。


TStringStream.Read
TStringStream.Read3392008

TStringStream	参照

Read メソッドは，文字列ストリームから Count で指定するバイト数を Buffer に読み出して，そのバイト数だけストリームの現在位置を進めます。

function Read(var Buffer; Count: Longint): Longint; override;

説明

Read を呼び出すと，現在位置からの文字列ストリームの内容をバッファに読み出せます。Count が DataString の最後を超えて指定した場合でも，Read は DataString の最後までの文字のみを転送します。戻り値が Count 値より少ない場合，文字列の最後まで読み出したことを意味します。

ReadBuffer メソッドおよび ReadComponent メソッドは，実際の読み出しを行うために Read を呼び出します。

注意

Read は Count で指定する値を上限とみなします。対照的に ReadBuffer メソッドは，Count で指定するバイト数を読み出せない場合に例外を生成します。


TStringStream.ReadString
TStringStream.ReadString3392009

TStringStream	参照

ReadString メソッドは，文字列ストリームで現在位置から Count で指定するバイトまでで構成される文字列を返し，ストリームの現在位置を読み出したバイト数だけ進めます。

function ReadString(Count: Longint): string;

説明

Read を呼び出すと，現在位置からの文字列ストリームの内容をバッファに読み出せます。Count が DataString の最後を超えて指定した場合でも，Read は DataString の最後までの文字のみを転送します。戻り値が Count 値より少ない場合，文字列の最後まで読み出したことを意味します。

注意

ReadString がバッファを埋めるのではなく文字列を返すという以外は Read と同じです。


TStringStream.Seek
TStringStream.Seek3392010

TStringStream	参照

Seek メソッドは，ストリームの現在位置を Origin で指定する原点から Offset で指定するバイト数だけ移動します。

function Seek(Offset: Longint; Origin: Word): Longint; override;

説明

Seek メソッドを呼び出すと，文字列ストリーム内の現在位置をオフセットで指定するバイト数だけ移動できます。Seek はアプリケーションが DataString で特定の位置を読み書きできるようにします。

Offset が負の数ならば，指定した原点から後方に移動します。次の表に Origin の値とその位置を示します。

値	意味

soFromBeginning	Offset は DataString の始めを原点とする。Seek は Offset の位置へ移動する。 Offset 値は 0 以上（>= 0）でなければならない

soFromCurrent	Offset は現在位置を原点とする。Seek は Position + Offset へ移動する

soFromEnd	Offset は Memory の最後を原点とする。DataString の最後のバイト数を示すためには Offset は 0 以下（<= 0）でなければならない

Seek は Position プロパティの新しい値を返します。


TStringStream.Write
TStringStream.Write3392011

TStringStream	参照

Write メソッドは，Count で指定するバイトを Buffer から文字列ストリームの現在位置に書き込み，Count で指定するバイトだけ現在位置を更新します。

function Write(const Buffer; Count: Longint): Longint; override;

説明

Write メソッドを呼び出すと，現在位置からの文字列の最後を Buffer の最初の Count バイトと置換できます。Write は新しい DataString 長を反映させるために Size プロパティを変更します。

Write はヌル文字が Count バイトの 1 つとして含まれている場合でも，必ず Buffer から Count バイトを書き込みます。したがって，Write は WriteBuffer メソッドと同じです。


TStringStream.WriteString
TStringStream.WriteString3392012

TStringStream	参照

WriteString メソッドは，AString から最高 Count バイトまでを文字列ストリーム内の現在位置に書き込み，書き込んだバイト数だけ現在位置を更新します。

procedure WriteString(const AString: string; Count: Longint);

説明

WriteString メソッドを呼び出すと，現在位置からの文字列の最後を AString の Count バイトと置換できます。AString が Count バイトよりも短い場合には WriteString は AString の最後までしか書き込みません。Write は新しい DataString 長を反映させるために Size プロパティを変更します。


読み出し／書き込み3392013

読み出し専用


継承3392014

TObject

TStream


TStringStream 例3392015

TStringStream


TStringField
TStringField3393001

継承	プロパティ	メソッド	イベント	参照	例

TStringField オブジェクトはデータセット内の文字列項目を表します。

ユニット

db

説明

文字列項目の値は 8192 文字以内のシーケンスとして物理的に格納されます。文字列項目は名前や住所といったテキストの格納に使います。

TStringField オブジェクトは文字列値と他のデータ形式の変換をしたり，言語ドライバの変換を管理したりするためのプロパティを導入します。TField オブジェクトの下位オブジェクトとして，TStringField オブジェクトはデータベース内の項目の値およびプロパティの管理に便利なプロパティ，メソッド，およびイベントを数多く継承します。


TStringField プロパティ3393002

TStringField	アルファベット順	凡例

TStringField

AsBoolean

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

DataSize

Transliterate

Value

TField からの継承

Alignment

AsCurrency

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TStringField プロパティ3393003

TStringField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

Transliterate

ValidChars

Value

VCLComObject

Visible


TStringField.AsBoolean
TStringField.AsBoolean3393004

TStringField	参照

AsBoolean プロパティは，項目の値を論理値に変換したり，その逆の変換をしたりします。

property AsBoolean: Boolean;

説明

AsBoolean プロパティは次の処理に使います。

・	文字列項目の値を論理変数に代入

・	論理値を文字列項目に代入

AsBoolean プロパティは，項目の値であるテキストが Y，y，T，または t (Yes または True を示す) で始まっている場合は True を戻し，それ以外の場合は False を戻します。 AsBoolean を使って TStringField に値を書き込むと，その値の文字列は T または F になります。


TStringField.AsDateTime
TStringField.AsDateTime3393005

TStringField	参照

AsDateTime プロパティは，項目の値を日付および時刻の値に変換したり，その逆の変換をしたりします。

property AsDateTime: TDateTime;

説明

AsDateTime プロパティは次の処理に使います。

・	文字列項目の値を TDateTime の値に代入

・	TDateTime の値を文字列項目に代入

AsDateTime プロパティを読み出すと，StrToDateTime 関数を使って日付 - 時刻に変換された項目の値が返されます。AsDateTime プロパティを設定すると，DateTimeToStr 関数を使って日付 - 時刻の値が文字列に変換されます。


TStringField.AsFloat
TStringField.AsFloat3393006

TStringField	参照

AsFloat プロパティは，項目の値を浮動小数点値に変換したり，その逆の変換をしたりします。

property AsFloat: Double;

説明

AsFloat プロパティは次の処理に使います。

・	文字列項目の値を浮動小数点値に代入

・	浮動小数点値を文字列項目に代入

次のコードは浮動小数点値を文字列値に代入します。

MyStringField.AsFloat := 7.345;

文字列項目の値を浮動小数点値に代入するには，次のようなコードを使います。

FloatVariable := MyStringField.AsFloat;

AsFloat プロパティを読み出すと，StrToFloat 関数を使って浮動小数点値に変換された項目の値が返されます。AsFloat プロパティを設定すると，FloatToStr 関数を使って浮動小数点値が文字列に変換されます。


TStringField.AsInteger
TStringField.AsInteger3393007

TStringField	参照

AsInteger プロパティは，項目の値を整数値に変換したり，その逆の変換をしたりします。

property AsInteger: Longint;

説明

AsInteger プロパティは次の処理に使います。

・	文字列項目の値を整数値に代入

・	整数値を文字列項目に代入

次のコードは整数値を文字列項目の値に代入します。

MyStringField.AsInteger := 12;

文字列項目の値を整数値に代入するには，次のようなコードを使います。

IntegerVariable := MyStringField.AsInteger;

AsInteger プロパティを読み出すと，StrToInt 関数を使って整数に変換された項目の値が返されます。AsInteger プロパティを設定すると，IntToStr 関数を使って整数が文字列に変換されます。


TStringField.AsString
TStringField.AsString3393008

TStringField	参照

AsString プロパティは，項目の値を取得または設定します。

property AsString: string;

説明

文字列項目のネイティブな形式は文字列であるため，値は交換されません。文字列項目では，AsString プロパティは Value プロパティと同じです。AsString プロパティは，データの内部形式が不明のときに汎用項目コンポーネントを使って文字列値の取得または設定をするための統一されたインターフェースを提供します。

AsString プロパティを設定するとき，Transliterate プロパティが True であれば，TStringField オブジェクトは代入された文字列をデータセットの言語ドライバを使用して ANSI から変換します。Size プロパティの値よりも文字数の多い文字列は，AsString プロパティを設定するときに Size プロパティの文字数までで切られます。


TStringField.AsVariant
TStringField.AsVariant3393009

TStringField	参照

AsVariant プロパティは，文字列項目の値をバリアント値に変換したり，その逆の変換をしたりします。

property AsVariant: Variant;

説明

AsVariant プロパティを使うと次の処理を行えます。

・	文字列項目の値をバリアント変数に代入する

・	バリアント値を文字列項目に代入する

項目の型とその項目に代入される値の型がいずれも不明な場合，バリアントを使うと便利です。


TStringField.DataSize
TStringField.DataSize3393010

TStringField	参照

DataSize プロパティは，ネイティブなデータベース形式で文字列項目を格納するのに必要なメモリの大きさです。

property DataSize: Word;

説明

DataSize プロパティは，文字列項目コンポーネントの値を格納するのに何バイト必要かを取得できます。GetData メソッドおよび SetData メソッドと一緒にこのプロパティを使うと，必要なバッファの大きさを決めることができます。

文字列項目の DataSize は Size プロパティの値より 1 バイト大きくなります。文字列内の文字のサイズが Size バイトで，最後に追加された 1 バイトはヌル文字です。


TStringField.Transliterate
TStringField.Transliterate3393011

TStringField	参照

Transliterate プロパティは，物理データベーステーブルを読み書きする際に，文字列項目の値について，ANSI 文字セットと，データセットで指定された文字セットとの間の変換を行うかどうかを決めます。

property Transliterate: Boolean;

説明

Transliterate プロパティは，データセットで識別された物理データベーステーブルが ANSI 言語ドライバを使わず，データが拡張 ASCII 文字を含む場合に使います。

Transliterate プロパティが True の場合，AnsiToNative 関数が呼び出されて，文字列項目の値を設定するときに ANSI 文字からデータセットで使われる文字セットに変換されます。文字列項目の値を読み出す場合，NativeToAnsi 関数が呼び出されて，データベーステーブル内の文字を ANSI 文字セットに変換します。


TStringField.Value
TStringField.Value3393012

TStringField	参照

Value プロパティは，文字列項目の実際のデータです。

property Value: string;

説明

Value プロパティは，実行時に文字列項目コンポーネントにデータを直接取得および設定できます。Value プロパティを使うのは，AsString プロパティを使うのと同じです。Value プロパティは，項目コンポーネントが 文字列項目であると分かっているときに使います。AsString プロパティは，汎用項目コンポーネントを扱うときに使います。

Value プロパティを設定する場合，Transliterate プロパティが True ならば，TStringField オブジェクトは代入された文字列を，データセットの言語ドライバを使用して ANSI から変換します。Size プロパティの値よりも文字数の多い文字列は，Value プロパティを設定するときに Size プロパティの文字数まで切り捨てられます。


TStringField イベント3393013

TStringField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TStringField イベント3393014

TStringField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TStringField メソッド3393015

TStringField	アルファベット順

TStringField

Create

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TStringField メソッド3393016

TStringField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TStringField.Create
TStringField.Create3393017

TStringField	参照

Create メソッドは，TStringField オブジェクトのインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを直接呼び出す必要はほとんどありません。文字列項目コンポーネントは，データセット内のすべての文字列項目用に自動的にインスタンス化されるからです。

継承コンストラクタを呼び出した後で，Create メソッドは次の値を設定します。

・	DataType プロパティを ftString に設定する

・	Size プロパティを 20 に設定する

・	Transliterate プロパティを True に設定する


スコープ3393018

published

読み出し／書き込み

読み出し専用


スコープ3393019

published


継承3393020

TObject

TPersistent

TComponent

TField


TStringField 例3393021

TStringField


TStringGrid
TStringGrid3394001

継承	プロパティ	メソッド	イベント	参照

TStringGrid は，文字列とそれに関連付けられたオブジェクトの処理を簡易化することを目的としたグリッドコントロールです。

ユニット

grids

説明

TStringGrid オブジェクトをフォームに追加すると，テキストデータを表形式で提示できます。TStringGrid は，ユーザーアクションに応答してグリッドの外観のほか，グリッドの表構造を利用するイベントおよびメソッドを制御するための多数のプロパティを提供します。

TStringGrid は，オブジェクトをグリッド内の各文字列と関連付ける機能を導入します。こういったオブジェクトは，ユーザーに提示される文字列で表現される情報や動作をカプセル化できます。

グリッド内に格納される文字列がデータセットのレコードのフィールド値を表すときは，かわりに TDBGrid を使います。


TStringGrid プロパティ3394002

TStringGrid	アルファベット順	凡例

TStringGrid

Cells

Cols

Objects

Rows

TCustomGrid からの継承

BorderStyle

Col

ColCount

ColWidths

DefaultColWidth

DefaultDrawing

DefaultRowHeight

EditorMode

FixedColor

FixedCols

FixedRows

GridHeight

GridLineWidth

GridWidth

LeftCol

Options

Row

RowCount

RowHeights

ScrollBars

Selection

TabStops

TopRow

VisibleColCount

VisibleRowCount

TCustomControl からの継承

Canvas

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TStringGrid プロパティ3394003

TStringGrid	オブジェクト順	凡例

Align

BorderStyle

BoundsRect

Brush

Canvas

Cells

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Col

ColCount

Color

Cols

ColWidths

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DefaultColWidth

DefaultDrawing

DefaultRowHeight

DesignInfo

DragCursor

DragMode

EditorMode

Enabled

FixedColor

FixedCols

FixedRows

Font

GridHeight

GridLineWidth

GridWidth

Handle

Height

HelpContext

Hint

Left

LeftCol

Name

Objects

Options

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

ParentWindow

PopupMenu

Row

RowCount

RowHeights

Rows

ScrollBars

Selection

ShowHint

Showing

TabOrder

TabStop

TabStops

Tag

Top

TopRow

VCLComObject

Visible

VisibleColCount

VisibleRowCount

Width

WindowProc


TStringGrid.Cells
TStringGrid.Cells3394004

TStringGrid	参照

Cells プロパティは，文字列の配列で，グリッドの各セルにつき文字列が 1 つずつ入ります。

property Cells[ACol, ARow: Integer]: string;

説明

Cells プロパティは，特定のセルにある文字列にアクセスできます。ACol はセルの列座標，ARow はセルの行座標です。最初の行は行 0，最初の列は列 0 になります。

ColCount プロパティと RowCount プロパティの値は文字列の配列サイズを指定します。

Cells 配列の文字列に関連付けられたオブジェクトにアクセスするには，Objects プロパティを使います。


TStringGrid.Cols
TStringGrid.Cols3394005

TStringGrid	参照

Cols プロパティは，文字列とそれに関連付けられたオブジェクトが 1 列になっている配列です。

property Cols[Index: Integer]: TStrings;

説明

Cols プロパティは，1 列のすべての文字列とその関連するオブジェクトにアクセスできます。文字列とそれに関連付けられたオブジェクトの数は常に ColCount プロパティの値，つまりグリッドの列数と同じです。Index パラメータは列数と同じですが，グリッドの最初の列の値はゼロになります。

列ではなく行のすべての文字列とオブジェクトにアクセスするには，Rows プロパティを使います。


TStringGrid.Objects
TStringGrid.Objects3394006

TStringGrid	参照

Objects プロパティは，グリッドの各セルごとにオブジェクトが 1 つずつある配列です。

property Objects [ACol, ARow: Integer]: TObject;

説明

Objects プロパティは，特定のセルに関連付けられたオブジェクトにアクセスできます。ColCount と RowCount の値は，オブジェクト配列のサイズを指定します。ACol はセルの列座標，ARow はセルの行座標です。ただし，最初の行は行 0，最初の列は列 0 になります。

注意

文字列グリッドは，Objects 配列にオブジェクトを所有していません。Objects 配列に追加されたオブジェクトは，文字列グリッドが破棄されても存在します。そういったオブジェクトは，アプリケーションにより明示的に破棄しなければなりません。


TStringGrid.Rows
TStringGrid.Rows3394007

TStringGrid	参照

Rows プロパティは，文字列とそれに関連付けられたオブジェクトが 1 行になっている配列です。

property Rows[Index: Integer]: TStrings;

説明

Rows プロパティは，1 行のすべての文字列とその関連するオブジェクトにアクセスできます。文字列とそれに関連付けられたオブジェクトの数は常に RowCount プロパティの値，つまりグリッドの行数と同じです。Index パラメータは行数と同じですが，グリッドの最初の行の値はゼロになります。

行ではなく列のすべての文字列とオブジェクトを取得するには，Cols プロパティを使います。


TStringGrid イベント3394008

TStringGrid	アルファベット順	凡例

TDrawGrid からの継承

OnColumnMoved

OnDrawCell

OnGetEditMask

OnGetEditText

OnRowMoved

OnSelectCell

OnSetEditText

OnTopLeftChanged

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TStringGrid イベント3394009

TStringGrid	オブジェクト順	凡例

OnClick

OnColumnMoved

OnDblClick

OnDragDrop

OnDragOver

OnDrawCell

OnEndDrag

OnEnter

OnExit

OnGetEditMask

OnGetEditText

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnRowMoved

OnSelectCell

OnSetEditText

OnStartDrag

OnTopLeftChanged


TStringGrid メソッド3394010

TStringGrid	アルファベット順

TStringGrid

Create

Destroy

TDrawGrid からの継承

CellRect

MouseToCell

TCustomGrid からの継承

MouseCoord

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TStringGrid メソッド3394011

TStringGrid	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

CellRect

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

MouseCoord

MouseToCell

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TStringGrid.Create
TStringGrid.Create3394012

TStringGrid	参照

Create メソッドは，TStringGrid のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TStringGrid のインスタンスを作成できます。設計時にフォーム上に配置された文字列グリッドの場合，Create は自動的に呼び出されます。

継承コンストラクタを呼び出した後，Create は文字列とその関連するオブジェクトの配列を管理するために TStringGrid が使うヘルパーオブジェクトを作成します。


TStringGrid.Destroy
TStringGrid.Destroy3394013

TStringGrid	参照

Destroy メソッドは，TStringGrid のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは文字列リストが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

Destroy は，文字列とその関連付けられたオブジェクトの配列を管理するために使うヘルパーオブジェクトを解放します。


スコープ3394014

published

読み出し／書き込み

読み出し専用


スコープ3394015

published


継承3394016

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TCustomGrid

TDrawGrid


TStringGrid 例3394017

TStringGrid


TStringList
TStringList3395001

継承	プロパティ	メソッド	イベント	参照

TStringList は文字列リストを管理します。

ユニット

classes

説明

文字列リストオブジェクトを使うと，文字列リストを保存して管理できます。TStringList は，TStrings が提供する抽象プロパティおよびメソッドを実装して，新しいプロパティ，イベント，メソッドを以下の処理を行うために使用します。

・	リストの文字列を並べ替える

・	ソートされたリストで文字列の重複を禁じる

・	リストの内容の変更に応答する


TStringList のプロパティ3395002

TStringList	アルファベット順	凡例

TStringList

Capacity

Count

Duplicates

Objects

Sorted

Strings

Tstrings からの継承

CommaText

Names

StringsAdapter

Text

Values


TStringList のプロパティ3395003

TStringList	オブジェクト順	凡例

Capacity

CommaText

Count

Duplicates

Names

Objects

Sorted

Strings

StringsAdapter

Text

Values


TStringList.Capacity
TStringList.Capacity3395004

TStringList	参照

Capacity プロパティは，文字列リストがメモリを割り当てて保持する文字列の数です。

property Capacity: Integer;

説明

Capacity プロパティは，文字列を保持するためのメモリ割り当て容量を変更できます。

Capacity は文字列リストで割り当て済みのエントリ数で，Count はリスト内の文字列の数です。このため，Capacity は常に Count より大きいか等しくなります。

新しい文字列を追加すると Capacity プロパティは必要があれば増加しますが，Capacity プロパティを設定しても Count プロパティは変更されません。Capacity を Count より小さい値に設定しないでください。このように設定すると，リストが切り捨てられ，Count はリストの文字列数が設定よりも多いことを示します。また，Capacity を Count より小さい値に設定すると，リストから落ちた文字列を格納するために使ったメモリが解放されません（ただし，そのような文字列を示すリスト内のエントリでは解放されます）。


TStringList.Count
TStringList.Count3395005

TStringList	参照

Count プロパティは，リスト内の文字列の数です。

property Count: Integer;

説明

Count プロパティは，リストの最後の文字列を基準にして相対的な文字列の位置を取得できます。リスト内のすべての文字列を反復処理するときなどに使用できます。


TStringList.Duplicates
TStringList.Duplicates3395006

TStringList	参照

Duplicates プロパティは，ソートされたリストに重複文字列を追加できるかどうかを指定します。

TDuplicates = (dupIgnore, dupAccept, dupError);

property Duplicates: TDuplicates;

説明

Duplicates プロパティを設定すると，ソートされたリストに重複文字列を追加しようとしたときに発生する動作を指定できます。以下に Duplicates の値を示します。

値	意味

dupIgnore	ソートされたリストに重複文字列を追加しようとする操作を無視する

dupError	ソートされたリストに重複文字列を追加しようとしたときに EListError 例外を発生させる

dupAccept	ソートされたリストで重複文字列を許可する

Duplicates は，文字列をリストに追加する前に設定します。Duplicates を dupIgnore または dupError に設定しても，リストに既存の重複文字列については何もしません。

注意

Duplicates は，リストがソートされていない場合には何もしません。


TStringList.Objects
TStringList.Objects3395007

TStringList	参照

Objects プロパティは，Strings プロパティの各文字列に関連付けれれたオブジェクトの集合です。

property Objects[Index: Integer]: TObject;

説明

オブジェクトを既存の文字列に関連付けるには，Strings プロパティでその文字列のものと同じインデックスを使って Objects プロパティを設定します。文字列と関連付けられたオブジェクトを参照するには，その文字列のインデックスで Objects プロパティを読み出します。Index はオブジェクトに関連付けられた文字列の位置を指定します。ただし，0が最初の文字列，1 が 2 番目の文字列というように順次対応します。IndexOf メソッドを使うと，文字列のインデックスを検出できます。

たとえば Objects を使って，ビットマップオブジェクトを文字列リストの文字列と関連付けることができます。Objects プロパティは次に，リストボックス内の文字列の横に表示するためのビットマップや，関連付けられた文字列がコントロールで選択されたときに描画するビットマップを，アプリケーションがすばやく見つけられるようにします。


TStringList.Sorted
TStringList.Sorted3395008

TStringList	参照

Sorted プロパティは，リストの文字列を自動的に並べ替えるかどうかを指定します。

property Sorted: Boolean;

説明

Sorted を True に設定すると，リスト内の文字列を自動的に昇順で並べ替えられます。Sorted を False に設定すると，文字列を挿入された場所にそのまま固定します。ただし，Sorted が False の場合でも，Sort メソッドを呼び出せばリスト内の文字列をいつでも昇順に並べ替えることが可能です。

Sorted が True の場合，リストに文字列を追加するのに Insert を使わないでください。かわりに Add を使います。これは，新しい文字列を適切な位置に挿入します。Sorted が False の場合，Insert を使えば文字列をリストの任意の位置に追加でき，Add を使えばリストの末尾に追加できます。


TStringList.Strings
TStringList.Strings3395009

TStringList	参照

Strings プロパティは，0 ベースのインデックスで参照される，文字列のリストです。

property Strings[Index: Integer]: string;

説明

Strings を使うと，特定位置の文字列を読み出したり変更したりできます。Index は文字列の位置を指定します。ただし，0 が最初の文字列，1 が 2 番目の文字列というように順次対応します。リスト内の特定文字列を検出するには，IndexOf メソッドを呼び出します。

Strings は文字列リストオブジェクトのデフォルトプロパティです。文字列リストオブジェクトの Strings プロパティをアクセスするときは，文字列 ID を省略できます。たとえば以下の 2 つの行のコードはいずれも有効で，同じ処理を実行します。

MyStringList.Strings[0] := 'This is the first string';

MyStringList[0] := 'This is the first string';


TStringList のイベント3395010

TStringList	アルファベット順

TStringList

OnChange

OnChanging


TStringList のイベント3395011

TStringList	オブジェクト順

OnChanging

OnChange


TStringList.OnChange
TStringList.OnChange3395012

TStringList	参照

OnChange イベントは，文字列リストが変更された直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラを記述すると，文字列リストの変更に応答できます。たとえば文字列リストがコントロールに関連付けられている場合，OnChange イベントハンドラはリストの内容が変わるたびにコントロールにそれ自体をリペイントするように通知できます。

リストで文字列を追加，削除，移動，修正するたびに，以下のイベントが発生します。

1.	まず，OnChanging イベントが変更の前に発生する

2.	文字列が追加，削除，移動，修正される

3.	最後に，OnChange イベントが発生する


TStringList.OnChanging
TStringList.OnChanging3395013

TStringList	参照

OnChanging イベントは，文字列リストが変更される直前に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnChanging: TNotifyEvent;

説明

OnChanging イベントハンドラを記述すると，文字列リストの変更の準備を整えられます。たとえば文字列リストがコントロールに関連付けられている場合，OnChanging イベントハンドラはリストの変更が終了したときに OnChange イベントが発生するまでコントロールにリペイントを無効にするように通知できます。

リストで文字列を追加，削除，移動，修正するたびに，以下のイベントが発生します。

1.	まず，OnChanging イベントが変更前に発生する

2.	文字列が追加，削除，移動，修正される

3.	最後に，変更が完了した後に OnChange イベントが発生する


TStringList のメソッド3395014

TStringList	アルファベット順

TStringList

Add

Clear

Delete

Destroy

Exchange

Find

IndexOf

Insert

Sort

TStrings からの継承

AddObject

AddStrings

Append

Assign

BeginUpdate

EndUpdate

Equals

GetText

IndexOfName

IndexOfObject

InsertObject

LoadFromFile

LoadFromStream

Move

SaveToFile

SaveToStream

SetText

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TStringList のメソッド3395015

TStringList	オブジェクト順

AddObject

AddStrings

Add

Append

Assign

BeginUpdate

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Delete

Destroy

Dispatch

EndUpdate

Equals

Exchange

FieldAddress

Find

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetNamePath

GetText

IndexOfName

IndexOfObject

IndexOf

InheritsFrom

InitInstance

InsertObject

Insert

InstanceSize

LoadFromFile

LoadFromStream

MethodAddress

MethodName

Move

NewInstance

SafeCallException

SaveToFile

SaveToStream

SetText

Sort


TStringList.Add
TStringList.Add3395016

TStringList	参照

Add メソッドは，新しい文字列をリストに追加します。

function Add(const S: string): Integer; override;

説明

Add メソッドを呼び出すと，S パラメータで指定する文字列をリストに追加できます。リストがソートされている場合，S は並べ替え順の適切な位置に追加されます。リストがソートされていない場合，S はリストの末尾に追加されます。Add はリスト内の項目の位置を返します。ただし，リストの先頭項目の値は 0 です。

注意

ソートされたリストでは，文字列 S がすでにリストに表示されていて Duplicates が dupError に設定されている場合，Add は EListError 例外を発生させます。Duplicates が dupIgnore に設定されている場合，ソートされたリストに重複文字列を追加しようとしても何もしません。


TStringList.Clear
TStringList.Clear3395017

TStringList	参照

Clear メソッドは，リストからすべての文字列を削除します。

procedure Clear; override;

説明

Clear メソッドを呼び出すと，文字列リストを空にできます。関連付けられたオブジェクトへのすべての参照も同時に削除されます。


TStringList.Delete
TStringList.Delete3395018

TStringList	参照

Delete メソッドは，Index パラメータで指定した文字列を削除します。

procedure Delete(Index: Integer); override;

説明

Delete メソッドを呼び出すと，リストから 1 つの文字列を削除できます。オブジェクトがその文字列と関連付けられている場合，そのオブジェクトへの参照も同時に削除されます。Index は文字列の位置を指定します。ただし，0 が最初の文字列，1 が 2 番目の文字列というように順次対応します。


TStringList.Destroy
TStringList.Destroy3395019

TStringList	参照

Destroy メソッドは，TStringList のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで Destroy メソッドを直接呼び出さないでください。かわりに Free メソッドを呼び出します。Free は，TStringList オブジェクトが解放されていないことを確認してからのみ Destroy を呼び出します。

Destroy は文字列リストとオブジェクト参照を保持するために割り当てられたメモリを解放した後，継承デストラクタを呼び出します。


TStringList.Exchange
TStringList.Exchange3395020

TStringList	参照

Exchange メソッドは，リスト内の 2 つの文字列の位置を入れ替えます。

procedure Exchange(Index1, Index2: Integer); override;

説明

Exchange メソッドを呼び出すと，リストで文字列を再配置できます。文字列は，Index1 および Index2 パラメータのインデックス値で指定します。インデックスはゼロベースなので，リストの先頭文字列のインデックス値は 0，2 番目のインデックス値は 1 というように順次対応します。

どちらかの文字列が関連付けられたオブジェクトを持つ場合，Exchange はオブジェクトのインデックスも同時に変更します。

注意

異なる関連付けられたオブジェクトを持つ 2 つの同じ文字列を入れ替えることを目的とする以外には，ソートされたリストに Exchange を呼び出さないでください。Exchange はリストがソートされているかどうかをチェックしないので，ソートされたリストの並べ替え順を破棄することがあります。


TStringList.Find
TStringList.Find3395021

TStringList	参照

Find メソッドは，ソートされたリスト内の文字列のインデックスを特定し，その値を持つ文字列がすでにリストに存在するかどうかを示します。

function Find(const S: string; var Index: Integer): Boolean; virtual;

説明

Find メソッドを呼び出すと，S パラメータで指定する文字列の追加先となるソートされたリストのインデックスを取得できます。文字列 S がすでにリストに存在する場合，Find は True を返します。リストが S を保持していない場合，Find は False を返します。S の挿入先のインデックスは Index パラメータで返されます。Index の値はゼロベースなので，最初の文字列のインデックスは 0，2 番目の文字列のインデックスは 1 というように順次対応します。

注意

Find はソートされたリストでのみ使います。ソートされていないリストでは，かわりに IndexOf メソッドを使います。


TStringList.IndexOf
TStringList.IndexOf3395022

TStringList	参照

IndexOf メソッドはリスト内の文字列の位置を返します。

function IndexOf(const S: string): Integer; override;

説明

IndexOf メソッドを呼び出すと，S パラメータで指定する文字列の最初の項目位置を取得できます。IndexOf は文字列の 0 ベースインデックスを返します。このため，S がリストの最初の文字列に一致する場合に IndexOf は 0 を返し，S が 2 番目の文字列の場合に IndexOf は 1 を返し，という対応になります。また，文字列が文字列リストにない場合は，IndexOf は �1 を返します。


TStringList.Insert
TStringList.Insert3395023

TStringList	参照

Insert メソッドは，リスト内の Index が指定する位置に文字列を追加します。

procedure Insert(Index: Integer; const S: string); override;

説明

Insert を呼び出すと，リスト内の Index パラメータが指定する位置に S パラメータで指定する文字列を追加できます。Index が 0 の場合に文字列はリストの先頭に挿入され，Index が 1 の場合に文字列はリストの 2 番目の位置に挿入され，というふうに順次対応します。

文字列が関連付けられたオブジェクトを持つ場合，かわりに InsertObject メソッドを使います。

注意

リストがソートされている場合，Insert または InsertObject を呼び出すと，EListError 例外が発生します。ソートされたリストでは，Add または AddObject を使います。


TStringList.Sort
TStringList.Sort3395024

TStringList	参照

Sort メソッドは，リスト内の文字列を昇順で並べ替えます。

procedure Sort; virtual;

説明

Sort メソッドを呼び出すと，Sorted プロパティを False に設定したリストで文字列を並べ替えることができます。また，Sorted プロパティを True に設定した文字列リストでは，自動的に並べ替えが実行されます。


アクセス種別3395025

読み出し専用


継承3395026

TObject

TPersistent

TStrings


TStringList の例3395027

TStringList


TStatusPanel
TStatusPanel3396001

継承	プロパティ	メソッド	参照

TStatusPanel オブジェクトは個々のステータスバーのパネルです。

ユニット

comctrls

説明

各 TStatusBar オブジェクトでは，TStatusPanels がステータスバーの特定領域を表します。


TStatusPanel プロパティ3396002

TStatusPanel	アルファベット順	凡例

TStatusPanel

Alignment

Bevel

Style

Text

Width

TCollectionItem からの継承

Collection

DisplayName

ID

Index


TStatusPanel プロパティ3396003

TStatusPanel	オブジェクト順	凡例

Alignment

Bevel

Collection

DisplayName

ID

Index

Style

Text

Width


TStatusPanel.Alignment
TStatusPanel.Alignment3396004

TStatusPanel	参照

Alignment プロパティは，スタータスパネル内でどのようにテキストを揃えるか指定します。

property Alignment: TAlignment default taLeftJustify;

説明

以下に Alignment の値を示します。

値	意味

taLeftJustify	テキストをパネルの左端に揃える

taCenter	テキストをパネルの横方向に中央揃えにする

taRightJustify	テキストをパネルの右端に揃える

注意

ステータスバーにサイズ変更グリップを表示している場合，最終ステータスパネルの Alignment を taRightJustify に設定するとパネルのテキストは破棄されます。


TStatusPanel.Bevel
TStatusPanel.Bevel3396005

TStatusPanel	参照

Bevel プロパティは，パネルの境界のスタイルを決めます。

property Bevel: TStatusPanelBevel default pbLowered;

説明

以下に Bevel の値を示します。

値	意味

pbNone	パネルにはベベルがなく平らに見える

pbLowered	パネルは押し込まれたように見える

pbRaised	パネルは浮き上がって見える


TStatusPanel.Style
TStatusPanel.Style3396006

TStatusPanel	参照

Style プロパティは，ステータスパネルのテキストの表示スタイルを決めます。

property Style: TStatusPanelStyle default psText;

説明

Style を psText (デフォルト) に設定すると，Text プロパティの文字列が，Alignment で指定した位置揃えの方法でステータスバーに表示されます。フォントはステータスバーの Font プロパティで指定します。

Style を psOwnerDraw に設定すると，ステータスパネルに表示されている内容が，TStatusBar  の OnDrawPanel イベントハンドラに記述されたコードによって，実行時にステータスバーのキャンバスに表示されます。


TStatusPanel.Text
TStatusPanel.Text3396007

TStatusPanel

Text プロパティは，ステータスパネルに表示されるテキストを示します。

property Text: string;

説明

Style が psText の場合には，Text プロパティの文字列がステータスパネルに表示されます。


TStatusPanel.Width
TStatusPanel.Width3396008

TStatusPanel

Width プロパティは，ステータスパネルの幅を表します。

property Width: Integer;

説明

Width プロパティはステータスパネルの幅がピクセル単位で表現されます。


TStatusPanel メソッド3396009

TStatusPanel	アルファベット順

TStatusPanel

Assign

Create

TCollectionItem からの継承

Destroy

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TStatusPanel メソッド3396010

TStatusPanel	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TStatusPanel.Assign
TStatusPanel.Assign3396011

TStatusPanel	参照

Assign メソッドは，ソースステータスパネルの内容を新しいステータスパネルにコピーします。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドでは、ソースオブジェクトと同じ Alignment，Bevel，Style，Text，および Width の値で新しいステータスパネルを作成します。


TStatusPanel.Create
TStatusPanel.Create3396012

TStatusPanel	参照

Create メソッドは，ステータスパネルを作成および初期化します。

constructor Create(Collection: TCollection); override;

説明

Create メソッドでは、TStatusPanels インスタンスを引数とします。


スコープ3396013

published

読み出し／書き込み

読み出し専用


継承3396014

TObject

TPersistent

TCollectionItem


TStatusPanel 例3396015

TStatusPanel


TStatusPanels
TStatusPanels3397001

継承	プロパティ	メソッド	参照

TStatusPanels オブジェクトは TStatusPanel オブジェクトのコンテナです。

ユニット

comctrls

説明

各 TStatusPanels は TStatusBar コンポーネントの TStatusPanel オブジェクトのコレクションを保持します。TStatusPanels オブジェクトは，その Items 配列でステータスパネルをインデックスを用いて保守します。Count プロパティには保持されているステータスパネルの数が入ります。設計時には，TStatusBar コンポーネントの Panels エディタを使ってパネルを追加，削除，または変更します。


TStatusPanels プロパティ3397002

TStatusPanels	アルファベット順	凡例

TStatusPanels

Items

TCollection からの継承

Count

ItemClass


TStatusPanels プロパティ3397003

TStatusPanels	オブジェクト順	凡例

Count

ItemClass

Items


TStatusPanels.Items
TStatusPanels.Items3397004

TStatusPanels	参照

保持されているステータスパネルのインデックスを示します。

property Items[Index: Integer]: TStatusPanel;

説明

Index パラメータの値は TStatusPanel の Index プロパティに対応します。この値はステータスバーにおけるステータスパネルの位置を表します。


TStatusPanels メソッド3397005

TStatusPanels	アルファベット順

TStatusPanels

Add

Create

TCollection からの継承

Assign

BeginUpdate

Clear

Destroy

EndUpdate

FindItemID

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TStatusPanels メソッド3397006

TStatusPanels	オブジェクト順

Add

Assign

BeginUpdate

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

EndUpdate

FieldAddress

FindItemID

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TStatusPanels.Add
TStatusPanels.Add3397007

TStatusPanels	参照

Add メソッドは，新しい TStatusPanel インスタンスを作成し，それを Items 配列に追加します。

function Add: TStatusPanel;

説明

Add は新しいパネルを返します。設計時には Panels エディタを使ってパネルをステータスバーに追加します。


TStatusPanels.Create
TStatusPanels.Create3397008

TStatusPanels	参照

Create メソッドは，TStatusPanels オブジェクトを作成，初期化します。

constructor Create(StatusBar: TStatusBar);

説明

Create メソッドは TStatusBar インスタンスを引数に指定します。


読み出し／書き込み3397009

読み出し専用


継承3397010

TObject

TPersistent

TCollection


TStatusPanels 例3397011

TStatusPanels


TStatusBar
TStatusBar3398001

継承	プロパティ	メソッド	イベント	参照

TStatusBar は，Windows のステータスバーを表します。

ユニット

comctrls

説明

TStatusBar コンポーネントは通常，フォームの下端にそって横に表示されるパネルの列で，アプリケーション実行時の情報を表示します。各パネルは，Panels プロパティ内のリストにある TStatusPanel オブジェクトで表現します。また，SimplePanel プロパティを使うと，実行時にステータスバーのシングルパネル表示とマルチパネル表示を切り替えることができます。


TStatusBar プロパティ3398002

TStatusBar	アルファベット順	凡例

TStatusBar

Canvas

Panels

SimplePanel

SimpleText

SizeGrip

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TStatusBar プロパティ3398003

TStatusBar	オブジェクト順	凡例

Align

BoundsRect

Brush

Canvas

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

Hint

Left

Name

Owner

Panels

Parent

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

SimplePanel

SimpleText

SizeGrip

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TStatusBar.Canvas
TStatusBar.Canvas3398004

TStatusBar	参照

Canvas プロパティを使って，実行時にステータスバーの表面に描画できます。

property Canvas: TCanvas;

説明

Canvas プロパティは読み出し専用で，OnDrawPanel イベントのハンドラを実装しステータスバーの表面に描画するときに使われます。


TStatusBar.Panels
TStatusBar.Panels3398005

TStatusBar	参照

Panels プロパティは，ステータスバー内のパネル（TStatusPanel）のリストです。

property Panels: TStatusPanels;

説明

Panels プロパティは，TStatusPanel オブジェクトのコレクションである TStatusPanels を保持します。設計時には，Panels エディタを使ってパネルを追加，削除，または修正できます。Panels エディタを開くには，オブジェクトインスぺクタで Panels プロパティを選択してから，右側の値列をダブルクリックするか，省略記号（...）ボタンをクリックします。


TStatusBar.SimplePanel
TStatusBar.SimplePanel3398006

TStatusBar	参照

SimplePanel プロパティは，ステータスバーが表示するパネルを 1 つにするか複数にするかを指定します。

property SimplePanel: Boolean;

説明

SimplePanel を True に設定すると，ステータスバーはパネルを 1 つだけ使って SimpleText のテキストを表示します。SimplePanel を False に設定すると，ステータスバーは Panels プロパティの各項目に対して別個にパネルを表示します。実行時にステータスバーの表示を変更するには，SimplePanel の値をプログラム的に変更してください。


TStatusBar.SimpleText
TStatusBar.SimpleText3398007

TStatusBar	参照

SimpleText プロパティは，SimplePanel が True に設定されているときにステータスバーに表示される文字列を格納します。

property SimpleText: string;

説明

SimpleText プロパティは，SimplePanel が True に設定されているときにステータスバーに表示されるテキスト文字列を格納します。


TStatusBar.SizeGrip
TStatusBar.SizeGrip3398008

TStatusBar	参照

SizeGrip プロパティは，実行時にステータスバーのサイズを変更できるかどうかを指定します。

property SizeGrip: Boolean default True;

説明

SizeGrip を True に設定すると，ステータスバーの右下隅に三角形のグリップが表示されます。ユーザーはそのグリップをマウスでドラッグすることでステータスバーのサイズを変更できます。

注意

Align が alBottom，alRight，または alClient に設定されている場合には，グリップでサイズを変更することはできません。また，ステータスバーの最後のパネルの Alignment プロパティが taRightJustify に設定されている場合には，サイズ変更グリップはパネルのテキストの末尾を切り捨てます。


TStatusBar イベント3398009

TStatusBar	アルファベット順	凡例

TStatusBar

OnDrawPanel

OnResize

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TStatusBar イベント3398010

TStatusBar	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnDrawPanel

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnResize

OnStartDrag


TStatusBar.OnDrawPanel
TStatusBar.OnDrawPanel3398011

TStatusBar	参照

OnDrawPanel イベントは，ステータスパネルを再描画する必要があるときに発生します。

TDrawPanelEvent = procedure(StatusBar: TStatusBar; Panel: TStatusPanel; const Rect: TRect) of object;

property OnDrawPanel: TDrawPanelEvent;

説明

OnDrawPanel イベントは，ユーザーがステータスバーのサイズを変更したときなど，ステータスパネルを再表示する必要があるときに発生します。Rect パラメータはステータスパネルの（新しい）寸法を渡します。OnDrawPanel イベントは，ステータスパネルの Style プロパティが psOwnerDraw に設定されているときにだけ発生します。

TDrawPanelEvent は OnDrawPanel プロパティの型です。


TStatusBar.OnResize
TStatusBar.OnResize3398012

TStatusBar	参照

OnResize イベントは，ステータスパネルのサイズが変更されたときに発生します。

property OnResize: TNotifyEvent;

説明

OnResize イベントは，実行時にステータスバー全体のサイズが変更されたときに発生します。


TStatusBar メソッド3398013

TStatusBar	アルファベット順

TStatusBar

Create

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TStatusBar メソッド3398014

TStatusBar	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TStatusBar.Create
TStatusBar.Create3398015

TStatusBar	参照

Create メソッドは，TStatusBar コンポーネントを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは，ステータスバーとそのキャンバスおよびパネルを作成します。


TStatusBar.Destroy
TStatusBar.Destroy3398016

TStatusBar	参照

Destroy メソッドは，TStatusBar を破棄し，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

Destroy メソッドは，ステータスバーとそのキャンバスおよびパネルを破棄します。


スコープ3398017

published

読み出し／書き込み

読み出し専用


スコープ3398018

published


継承3398019

TObject

TPersistent

TComponent

TControl

TWinControl


TStatusBar 例3398020

TStatusBar


TSynchroObject
TSynchroObject3399001

継承	メソッド	参照

TSynchroObject はすべてのスレッド同期オブジェクトの基本クラスです。

ユニット

syncobjs

説明

TSynchroObject は，マルチスレッドアプリケーションで異なるスレッドの実行を調整するオブジェクトを定義するときの基本クラスとして使います。同期オブジェクトにはクリティカルセクションとイベントオブジェクトがあります。クリティカルセクションは，あるコードのセクションの正常終了を妨げる可能性のあるスレッドの実行を一時的に中断します。イベントオブジェクトを使うと，スレッドからクリティカルイベントの発生を通知できます。


TSynchroObject メソッド3399002

TSynchroObject	アルファベット順

TSynchroObject

Acquire

Release

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TSynchroObject メソッド3399003

TSynchroObject	オブジェクト順

Acquire

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Release

SafeCallException


TSynchroObject.Acquire
TSynchroObject.Acquire3399004

TSynchroObject	参照

Acquire メソッドは，スレッドに同期オブジェクトを割り当てるメソッドを提供します。

procedure Acquire; virtual;

説明

Acquire メソッドは，同期オブジェクトを使うスレッドから呼び出します。TSynchroObject の Acquire メソッドは，呼び出し側のスレッド用に動作する同期オブジェクトをアクセスするためのメソッドとのインターフェースを提供するだけで，ほかには処理を行いません。


TSynchroObject.Release
TSynchroObject.Release3399005

TSynchroObject	参照

Release メソッドは，ほかのスレッドが使っていた同期オブジェクトを解放するメソッドを提供します。

procedure Release; virtual;

説明

Release メソッドは，同期オブジェクトを使い終わったスレッドから呼び出します。TSynchroObject の Release メソッドは，呼び出し側のスレッドから同期オブジェクトを解放するためのメソッドとのインターフェースを提供するだけで，ほかには処理を行いません。


継承3399006

TObject


TSynchroObject 例3399007

TSynchroObject


THTMLTableAttributes
THTMLTableAttributes3400001

継承	プロパティ	メソッド	イベント	参照

THTMLTableAttributes オブジェクトは HTML テーブルタグの表示属性を表します。

ユニット

httpapp

説明

THTMLTableAttributes を使うと，HTML テーブルの外観を記述できます。THTMLTableAttributes オブジェクトのプロパティは HTML テーブルタグに追加できるオプションに対応します。すべての HTML テーブル要素の属性が指定されると，HTML テーブル作成オブジェクトは HTML コマンドを作成し，記述されたとおりにテーブル指定します。


THTMLTableAttributes プロパティ3400002

THTMLTableAttributes	アルファベット順	凡例

THTMLTableAttributes

Align

BgColor

Border

CellPadding

CellSpacing

Width

THTMLTagAttributes からの継承

Custom

Producer


THTMLTableAttributes プロパティ3400003

THTMLTableAttributes	オブジェクト順	凡例

Align

BgColor

Border

CellPadding

CellSpacing

Custom

Producer

Width


THTMLTableAttributes.Align
THTMLTableAttributes.Align3400004

THTMLTableAttributes

Align プロパティは，HTML ドキュメント内でテーブルをどう配置するかを指定します。

THTMLAlign = (haDefault, haLeft, haRight, haCenter);

property Align: THTMLAlign;

説明

Align を設定すると，HTML ドキュメント内でテーブルを配置する方法，または周囲の HTML テーブルオブジェクトのセル内でテーブルを配置する方法を指定できます。Align は HTML テーブルタグの Align オプションの値を示します。

Align のデフォルト値は haDefault で，HTML ドキュメントを読む Web ブラウザが HTML テーブルをどう配置するかを決めることを意味します。以下に Align に設定される値を示します。

値	意味

haDefault	Web ブラウザは HTML テーブルを任意の位置に配置できる

haLeft	Web ブラウザは HTML テーブルの左端を HTML ドキュメントまたは HTML テーブルセルの左端に合わせてテーブルを配置する

haRight	Web ブラウザは HTML テーブルの右端を HTML ドキュメントまたは HTML テーブルセルの右端に合わせてテーブルを配置する

haCenter	Web ブラウザは HTML テーブルを HTML ドキュメントまたは HTML テーブルセルの中央に配置する

参照

CellPadding プロパティ，Width プロパティ


THTMLTableAttributes.BgColor
THTMLTableAttributes.BgColor3400005

THTMLTableAttributes	参照

BgColor プロパティは，HTML テーブルの背景色を指定します。

THTMLBgColor = type string;

property BgColor: THTMLBgColor ;

説明

BgColor プロパティは，HTML テーブルの背景色を指定できます。BgColor の値は色の名前です。BgColor に設定できる文字列は以下のとおりです。

・	Aqua（空色）

・	Black（黒色）

・	Blue（青色）

・	Fuschia（赤紫色）

・	Gray（灰色）

・	Green（緑色）

・	Lime（濃緑色）

・	Maroon（栗色）

・	Navy（濃紺色）

・	Olive（黄緑色）

・	Purple（紫色）

・	Red（赤色）

・	Silver（銀色）

・	Teal（暗青緑色）

・	White （白色）

・	Yellow（黄色）

テーブルの各要素に HTML 属性オブジェクトの BgColor プロパティを使うと，より多彩な色効果を表現できます。


THTMLTableAttributes.Border
THTMLTableAttributes.Border3400006

THTMLTableAttributes	参照

Border プロパティは HTML テーブルの周囲に描かれる枠の太さを指定します。

property Border: Integer;

説明

Border を設定すると，テーブルの周囲に枠を付けるかどうか，付けるならどれくらいの太さにするかを指定できます。指定した値に対する枠の太さは，HTML テーブルを表示する Web ブラウザによって異なります。ただしどのブラウザでも，数値が大きいほど枠は太くなります。-1 はテーブルの周囲に枠を付けないことを示します。


THTMLTableAttributes.CellPadding
THTMLTableAttributes.CellPadding3400007

THTMLTableAttributes	参照

CellPadding プロパティは，HTML テーブルで各セルの内容の周囲にどれだけスペースを空けるかを指定します。

property CellPadding: Integer;

説明

CellPadding を設定すると，セルの内容とセルの縁との間にホワイトスペースを何ピクセル空けるかを指定できます。-1 は，HTML テーブルのセルに挿入するスペースの量を Web ブラウザが決定しなけらばならないことを示します。


THTMLTableAttributes.CellSpacing
THTMLTableAttributes.CellSpacing3400008

THTMLTableAttributes	参照

CellSpacing プロパティは，HTML テーブルのセルとセルの間にどれだけスペースを空けるかを指定します。

property CellSpacing: Integer;

説明

CellSpacing を設定すると，テーブル内のセルとセルの間にホワイトスペースを何ピクセル空けるかを指定できます。-1 は，HTML テーブルのセル間に挿入するスペースの量を Web ブラウザが決定しなければならないことを示します。

注意

CellSpacing は行と列を分ける線の太さのことではなく，HTML テーブルのセルとセルの間にあるホワイトスペースのことです。


THTMLTableAttributes.Width
THTMLTableAttributes.Width3400009

THTMLTableAttributes	参照

Width プロパティは，HTML テーブル全体の幅を指定します。

property Width: Integer;

説明

Width を設定すると，HTML テーブルの幅を Web ブラウザのウィンドウ幅に対する割合で指定できます。テーブルの内容に対して Width の値が小さすぎる場合，Web ブラウザはこのプロパティを無視します。

Width のデフォルト値は 100 で，テーブルがブラウザウィンドウ全体に及ぶことを意味します。この場合，Align プロパティの値は無効です。


THTMLTableAttributes イベント3400010

THTMLTableAttributes	アルファベット順

THTMLTagAttributes からの継承

OnChange


THTMLTableAttributes イベント3400011

THTMLTableAttributes	オブジェクト順

OnChange


THTMLTableAttributes メソッド3400012

THTMLTableAttributes	アルファベット順	凡例

THTMLTableAttributes

AssignTo

Create

RestoreDefaults

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THTMLTableAttributes メソッド3400013

THTMLTableAttributes	オブジェクト順	凡例

Assign

AssignTo

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RestoreDefaults

SafeCallException


THTMLTableAttributes.AssignTo
THTMLTableAttributes.AssignTo3400014

THTMLTableAttributes	参照

AssignTo メソッドは，THTMLTableAttributes オブジェクトのプロパティを別の THTMLTableAttributes オブジェクトにコピーします。

procedure AssignTo(Dest: TPersistent); override;

説明

アプリケーションはプロテクトされた AssignTo メソッドを呼び出すことはできません。THTMLTableAttributes オブジェクトのプロパティを別のオブジェクトに割り当てるには，割り当て先のオブジェクトの Assign メソッドを使います。

別のオブジェクトの Assign メソッドが THTMLTableAttributes オブジェクトをコピー元として指定している場合，THTMLTableAttributes オブジェクトの AssignTo メソッドが呼び出されます。AssignTo は Dest パラメータが別の THTMLTableAttributes オブジェクトであるかどうかを調べ，そうならば Align，Border，CellSpacing，CellPadding，および Width の各プロパティの値をコピーします。Dest がほかのクラスのオブジェクトである場合は，継承されたメソッドが呼び出されます。

注意

AssignTo は Custom プロパティについてはコピーしません。


THTMLTableAttributes.Create
THTMLTableAttributes.Create3400015

THTMLTableAttributes	参照

Create メソッドは，THTMLTableAttributes のインスタンスを作成します。

constructor Create(Producer: TCustomContentProducer);

説明

Create を呼び出すと，THTMLTableAttributes オブジェクトを作成および初期化できます。Producer パラメータは HTML テーブル作成オブジェクトを指定し，HTML テーブル作成オブジェクトは，その出力の一部である HTML テーブルの属性を THTMLTableAttributes オブジェクトを使って指定します。

継承コンストラクタを呼び出した後，Create は以下のプロパティを初期化します。

・	Width は 100

・	Border は -1

・	CellPadding は -1

・	CellSpacing は -1


THTMLTableAttributes.RestoreDefaults
THTMLTableAttributes.RestoreDefaults3400016

THTMLTableAttributes

RestoreDefaults メソッドは，テーブル属性のすべてのプロパティを初期状態に戻します。

procedure RestoreDefaults; override;

説明

RestoreDefaults メソッドを呼び出すと，テーブル属性に対してプログラム上で行った変更や設計時に応答エディタを使って行った変更を取り消して，初期状態に戻します。

RestoreDefaults は以下のプロパティを初期化します。

・	Align は haDefault

・	Border，CellPadding，および CellSpacing は -1

・	Custom は空の文字列

・	Width は 100


スコープ3400017

published

読み出し／書き込み

読み出し専用


スコープ3400018

protected


継承3400019

TObject

TPersistent

THTMLTagAttributes


THTMLTableAttributes 例3400020

THTMLTableAttributes


THTMLTableCellAttributes
THTMLTableCellAttributes3401001

継承	プロパティ	メソッド	イベント	参照

THTMLTableCellAttributes オブジェクトは HTML テーブルのセルタグの表示属性を表します。

ユニット

httpapp

説明

THTMLTableCellAttributes を使うと，HTML テーブルのセルの外観を記述できます。THTMLTableCellAttributes オブジェクトのプロパティは，HTML テーブルデータタグ（TD）に追加できるオプションに対応します。HTML テーブルの属性をすべて指定すると，HTML テーブル作成オブジェクトが HTML コマンドを作成し，記述に従ってテーブルを指定します。


THTMLTableCellAttributes プロパティ3401002

THTMLTableCellAttributes	アルファベット順	凡例

THTMLTableElementAttributes からの継承

Align

BgColor

VAlign

THTMLTagAttributes からの継承

Custom

Producer


THTMLTableCellAttributes プロパティ3401003

THTMLTableCellAttributes	オブジェクト順	凡例

Align

BgColor

Custom

Producer

VAlign


THTMLTableCellAttributes イベント3401004

THTMLTableCellAttributes	アルファベット順

THTMLTagAttributes からの継承

OnChange


THTMLTableCellAttributes イベント3401005

THTMLTableCellAttributes	オブジェクト順

OnChange


THTMLTableCellAttributes メソッド3401006

THTMLTableCellAttributes	アルファベット順

THTMLTableElementAttributes からの継承

RestoreDefaults

THTMLTagAttributes からの継承

Create

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THTMLTableCellAttributes メソッド3401007

THTMLTableCellAttributes	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RestoreDefaults

SafeCallException


スコープ3401008

published

読み出し／書き込み

読み出し専用


継承3401009

TObject

TPersistent

THTMLTagAttributes

THTMLTableElementAttributes


THTMLTableCellAttributes 例3401010

THTMLTableCellAttributes


TTabControl
TTabControl3402001

継承	プロパティ	メソッド	イベント	参照	例

TTabControl は，ノートブックの仕切りページのように見えるタブセットです。

ユニット

comctrls

説明

TTabControl を使うと，複数のタブ設定を持つコントロールをフォームに追加できます。ページコントロールとは違い，TTabControl は異なるコントロールを格納する複数のページを持たない単一のオブジェクトです。現在のタブが変わると，タブコントロールは変更を反映するために OnChange イベントハンドラで直接コントロールの内容を更新しなければなりません。

TTabControl オブジェクトは，単一のコントロールであるため，それを使用不可にするとすべてのタブが使用不可になります。個々のタブを使用不可にするには，TPageControl を使い，そのページを表す個々の TTabSheet コントロールを使用不可にします。


TTabControl プロパティ3402002

TTabControl	アルファベット順	凡例

TCustomTabControl からの継承

DisplayRect

HotTrack

MultiLine

ScrollOpposite

TabHeight

TabIndex

TabPosition

Tabs

TabWidth

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TTabControl プロパティ3402003

TTabControl	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

DisplayRect

DragCursor

DragMode

Enabled

Font

Handle

Height

HelpContext

Hint

HotTrack

Left

MultiLine

Name

Owner

Parent

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ScrollOpposite

ShowHint

Showing

TabHeight

TabIndex

TabOrder

TabPosition

Tabs

TabStop

TabWidth

Tag

Top

VCLComObject

Visible

Width

WindowProc


TTabControl イベント3402004

TTabControl	アルファベット順	凡例

TCustomTabControl からの継承

OnChange

OnChanging

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TTabControl イベント3402005

TTabControl	オブジェクト順	凡例

OnChange

OnChanging

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TTabControl メソッド3402006

TTabControl	アルファベット順

TCustomTabControl からの継承

Create

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TTabControl メソッド3402007

TTabControl	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


スコープ3402008

published

読み出し／書き込み

読み出し専用


スコープ3402009

published


継承3402010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomTabControl


THTMLTableElementAttributes
THTMLTableElementAttributes3403001

継承	プロパティ	メソッド	イベント	参照

THTMLTableElementAttributes は HTML テーブルの構成要素の表示属性を表すオブジェクトの共通基本クラスです。

ユニット

httpapp

説明

THTMLTableElementAttributes のプロパティを使うと，HTML テーブルの構成要素の外観を記述できます。THTMLTableElementAttributes のプロパティは HTML テーブル要素のタグに追加できる共通のオプションに対応します。すべての HTML テーブル要素の属性が指定されると，HTML テーブル作成オブジェクトは HTML コマンドを作成して，記述されたとおりにテーブルを指定します。


THTMLTableElementAttributes プロパティ3403002

THTMLTableElementAttributes	アルファベット順	凡例

THTMLTableElementAttributes

Align

BgColor

VAlign

THTMLTagAttributes からの継承

Custom

Producer


THTMLTableElementAttributes プロパティ3403003

THTMLTableElementAttributes	オブジェクト順	凡例

Align

BgColor

Custom

Producer

VAlign


THTMLTableElementAttributes.Align
THTMLTableElementAttributes.Align3403004

THTMLTableElementAttributes	参照

Align プロパティは，HTML テーブル要素の内容を水平方向にどう揃えるかを指定します。

THTMLAlign = (haDefault, haLeft, haRight, haCenter);

property Align: THTMLAlign;

説明

Align を設定すると，テーブル要素が示すセルの内容を水平方向にどう揃えるかを指定できます。Align は，テーブル要素に付けられる HTML タグの Align オプションの値を示します。

Align のデフォルト値は haDefault で，HTML ドキュメントを読む Web ブラウザがテーブル要素の内容を水平方向にどう揃えるかを決めることを意味します。以下に Align に設定される値を示します。

値	意味

haDefault	Web ブラウザはテーブル要素内でセルの内容を水平方向のどの位置にでも配置できる

haLeft	Web ブラウザはテーブル要素内でセルの内容を左揃えで配置する

haRight	Web ブラウザはテーブル要素内でセルの内容を右揃えで配置する

haCenter	Web ブラウザはテーブル要素内でセルの内容を水平方向の中央に揃える

テーブルデータセルまたはヘッダーセルの Align プロパティは，それらのセルのあるテーブル行の Align プロパティをオーバーライドします。


THTMLTableElementAttributes.BgColor
THTMLTableElementAttributes.BgColor3403005

THTMLTableElementAttributes	参照

BgColor プロパティは HTML テーブル要素の背景色を指定します。

THTMLBgColor = type string;

property BgColor: THTMLBgColor;

説明

BgColor を使うと，HTML テーブル要素の背景色を指定できます。BgColor の値は色の名前です。BgColor に設定できる文字列は以下のとおりです。

・	Aqua（空色）

・	Black（黒色）

・	Blue（青色）

・	Fuschia（赤紫色）

・	Gray（灰色）

・	Green（緑色）

・	Lime（濃緑色）

・	Maroon（栗色）

・	Navy（濃紺色）

・	Olive（黄緑色）

・	Purple（紫色）

・	Red（赤色）

・	Silver（銀色）

・	Teal（暗青緑色）

・	White （白色）

・	Yellow（黄色）

THTMLTableAttributes オブジェクトの BgColor プロパティを使うと，テーブル全体の背景色を設定できます。テーブル要素属性オブジェクトの BgColor プロパティを使うと，テーブル内で 1 つのテーブル要素だけを際立たせることができます。


THTMLTableElementAttributes.VAlign
THTMLTableElementAttributes.VAlign3403006

THTMLTableElementAttributes	参照

VAlign プロパティは，HTML テーブル要素の内容を垂直方向にどう揃えるかを指定します。

THTMLVAlign = (haVDefault, haTop, haMiddle, haBottom, haBaseline);

property VAlign: THTMLVAlign;

説明

VAlign を設定すると，HTML テーブル要素の内容を垂直方向にどう揃えるかを指定できます。VAlign は，テーブル要素に付けられる HTML タグの VAlign オプションの値を示します。

デフォルトは haVDefault です。デフォルトでは，Web ブラウザはテーブル要素内でのセルの内容を垂直方向のどの位置にでも配置できます。VAlign は次の値をとります。

VAlign の デフォルト値は haVDefault で，HTML ドキュメントを読む Web ブラウザがテーブル要素内でセルの内容を垂直方向にどう揃えるかを決めることを意味します。以下に VAlign に設定される値を示します。

値	意味

haVDefault	Web ブラウザはテーブル要素内でセルの内容を垂直方向のどの位置にでも配置できる

haTop	Web ブラウザはテーブル要素内でセルの内容を上部に揃える

haMiddle	Web ブラウザはテーブル要素内でセルの内容を水平方向の中央に揃える

haBottom	Web ブラウザはテーブル要素内でセルの内容を下部に揃える

haBaseline	Web ブラウザは同じ行にある各テーブル要素の内容を 1 行目のテキストの並び線上に揃える

テーブルデータセルまたはヘッダーセルの VAlign プロパティは，それらのセルのあるテーブル行の VAlign プロパティをオーバーライドします。


THTMLTableElementAttributes イベント3403007

THTMLTableElementAttributes	アルファベット順

THTMLTagAttributes からの継承

OnChange


THTMLTableElementAttributes イベント3403008

THTMLTableElementAttributes	オブジェクト順

OnChange


THTMLTableElementAttributes メソッド3403009

THTMLTableElementAttributes	アルファベット順	凡例

THTMLTableElementAttributes

AssignTo

RestoreDefaults

THTMLTagAttributes からの継承

Create

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THTMLTableElementAttributes メソッド3403010

THTMLTableElementAttributes	オブジェクト順	凡例

Assign

AssignTo

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RestoreDefaults

SafeCallException


THTMLTableElementAttributes.AssignTo
THTMLTableElementAttributes.AssignTo3403011

THTMLTableElementAttributes	参照

AssignTo メソッドは，THTMLTableElementAttributes オブジェクトのプロパティを別の THTMLTableElementAttributes オブジェクトにコピーします。

procedure AssignTo(Dest: TPersistent); override;

説明

アプリケーションはプロテクトされた AssignTo メソッドを呼び出すことはできません。THTMLTableElementAttributes オブジェクトのプロパティを別のオブジェクトに割り当てるには，割り当て先のオブジェクトの Assign メソッドを使います。

別のオブジェクトの Assign メソッドが THTMLTableElementAttributes オブジェクトをコピー元として指定している場合，THTMLTableElementAttributes オブジェクトの AssignTo メソッドが呼び出されます。AssignTo は Dest パラメータが別の THTMLTableElementAttributes オブジェクトであるかどうかを調べ，そうならば Align プロパティと VAlign プロパティの値をコピーします。Dest がほかのクラスのオブジェクトの場合は，継承されたメソッドが呼び出されます。

注意

AssignTo は Custom プロパティはコピーしません。


THTMLTableElementAttributes.RestoreDefaults
THTMLTableElementAttributes.RestoreDefaults3403012

THTMLTableElementAttributes

RestoreDefaults メソッドは，テーブル要素属性オブジェクトのすべてのプロパティを初期状態に戻します。

procedure RestoreDefaults; override;

説明

RestoreDefaults メソッドは，テーブル要素属性オブジェクトに対して，プログラム上で行った変更や設計時にオブジェクトインスペクタを使って行った変更を取り消して，初期状態に戻します。

RestoreDefaults は以下のプロパティを初期化します。

・	Align は haDefault，VAlign は haVDefault

・	BgColor は空の文字列

・	Custom は空の文字列


スコープ3403013

published

読み出し／書き込み

読み出し専用


スコープ3403014

protected


継承3403015

TObject

TPersistent

THTMLTagAttributes


THTMLTableElementAttributes 例3403016

THTMLTableElementAttributes


THTMLTableHeaderAttributes
とTHTMLTableHeaderAttributes3404001

継承	プロパティ	メソッド	イベント	参照

THTMLTableHeaderAttributes オブジェクトは HTML テーブルのヘッダータグの表示属性を表します。

ユニット

httpapp

説明

THTMLTableHeaderAttributes を使うと，HTML テーブルのヘッダーの外観を記述できます。THTMLTableHeaderAttributes オブジェクトのプロパティは HTML ヘッダータグ（HT）に追加できるオプションに対応します。HTML テーブルの属性をすべて指定すると，HTML コンテンツ作成オブジェクトが HTML コマンドを作成し，記述に従ってテーブルを指定します。

THTMLTableHeaderAttributes は直接の上位オブジェクト THTMLTableElementAttributes によって提供されるプロパティ，イベント，メソッド以外には，新しいプロパティ，イベント，メソッドは提供しません。


THTMLTableHeaderAttributes プロパティ3404002

THTMLTableHeaderAttributes	アルファベット順	凡例

THTMLTableHeaderAttributes

Caption

THTMLTableElementAttributes からの継承

Align

BgColor

VAlign

THTMLTagAttributes からの継承

Custom

Producer


THTMLTableHeaderAttributes プロパティ3404003

THTMLTableHeaderAttributes	オブジェクト順	凡例

Align

BgColor

Caption

Custom

Producer

VAlign


THTMLTableHeaderAttributes.Caption
THTMLTableHeaderAttributes.Caption3404004

THTMLTableHeaderAttributes

Caption プロパティは，ヘッダーに表示されるテキストを表示します。

property Caption: string;

説明

Caption プロパティは，ヘッダーを含む列のキャプションを示します。ヘッダーがデータセットテーブル作成オブジェクトや問い合わせテーブル作成オブジェクトによって使われている場合，Caption プロパティは，デフォルトの列名で項目名を上書きします。


THTMLTableHeaderAttributes イベント3404005

THTMLTableHeaderAttributes	アルファベット順

THTMLTagAttributes からの継承

OnChange


THTMLTableHeaderAttributes イベント3404006

THTMLTableHeaderAttributes	オブジェクト順

OnChange


THTMLTableHeaderAttributes メソッド3404007

THTMLTableHeaderAttributes	アルファベット順

THTMLTableHeaderAttributes

AssignTo

RestoreDefaults

THTMLTagAttributes からの継承

Create

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THTMLTableHeaderAttributes メソッド3404008

THTMLTableHeaderAttributes	オブジェクト順

Assign

AssignTo

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RestoreDefaults

SafeCallException


THTMLTableHeaderAttributes.AssignTo

THTMLTableHeaderAttributes	参照

AssignTo メソッドは，THTMLTableHeaderAttributes オブジェクトのプロパティを別の THTMLTableHeaderAttributes オブジェクトにコピーします。

procedure AssignTo(Dest: TPersistent); override;

説明

アプリケーションはプロテクトされた AssignTo メソッドを呼び出すことはできません。THTMLTableHeaderAttributes オブジェクトのプロパティを別のオブジェクトに割り当てるには，割り当て先のオブジェクトの Assign メソッドを使います。

別のオブジェクトの Assign メソッドが THTMLTableheaderAttributes オブジェクトをコピー元として指定している場合，THTMLTableHeaderAttributes オブジェクトの AssignTo メソッドが呼び出されます。AssignTo は Dest パラメータが別の THTMLTableheaderAttributes オブジェクトであるかどうかを調べ，そうならば Align プロパティと VAlign プロパティの値をコピーします。Dest がほかのクラスのオブジェクトの場合は，継承されたメソッドが呼び出されます。

注意

AssignTo は Custom プロパティはコピーしません。


THTMLTableHeaderAttributes.RestoreDefaults
THTMLTableHeaderAttributes.RestoreDefaults3404009

THTMLTableHeaderAttributes

RestoreDefaults メソッドは，テーブル属性オブジェクトのすべてのプロパティを初期状態に戻します。

RestoreDefaults changes all properties of the attributes object back to their initial settings.

説明

RestoreDefaults メソッドは，テーブル要素属性オブジェクトに対して，プログラム上で行った変更や設計時にオブジェクトインスペクタを使って行った変更を取り消して，初期状態に戻します。

RestoreDefaults は以下のプロパティを初期化します。

・	Align は haDefault，VAlign は haVDefault

・	BgColor は空の文字列

・	Caption は空の文字列

・	Custom は空の文字列


スコープ3404010

published

読み出し／書き込み

読み出し専用


継承3404011

TObject

TPersistent

THTMLTagAttributes

THTMLTableElementAttributes


THTMLTableHeaderAttributes 例3404012

THTMLTableHeaderAttributes


TTable
TTable3405001

継承	プロパティ	メソッド	イベント	参照	例

TTable コンポーネントは，データベーステーブルをカプセル化するデータセットコンポーネントです。

ユニット

dbtables

説明

TTable コンポーネントを使うと，ボーランドデータベースエンジン（BDE）を使って 1 つのデータベーステーブル内のデータにアクセスできます。このコンポーネントを使えば，基のデータベーステーブル内の各レコードおよび各項目に直接アクセスできます。これは，基のデータベーステーブルが Paradox，dBASE，Access，FoxPro，ODBC 準拠データベース，あるいはリモートサーバー上の SQL データベース（InterBase，Oracle，Sybase，MS-SQL Server，Informix，DB2 など）のいずれであるかを問いません。

またテーブルコンポーネントは，範囲とフィルタを使ってデータベーステーブル内のレコードのサブセットについても処理できます。


TTable プロパティ3405002

TTable	アルファベット順	凡例

TTable

CanModify

DataSource

Exclusive

IndexDefs

IndexFieldCount

IndexFieldNames

IndexFields

IndexFiles

IndexName

KeyExclusive

KeyFieldCount

MasterFields

MasterSource

ReadOnly

TableLevel

TableName

TableType

TDBDataSet からの継承

Database

DatabaseName

DBHandle

DBLocale

DBSession

Provider

SessionName

UpdateMode

TBDEDataSet からの継承

CacheBlobs

CachedUpdates

ExpIndex

Filter

Filtered

FilterOptions

Handle

KeySize

Locale

RecNo

RecordCount

RecordSize

UpdateObject

UpdateRecordTypes

UpdatesPending

TDataSet からの継承

Active

AutoCalcFields

BOF

Bookmark

Constraints

DefaultFields

Designer

EOF

FieldCount

FieldDefs

Fields

FieldValues

Found

Modified

Name

State

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TTable プロパティ3405003

TTable	オブジェクト順	凡例

Active

AutoCalcFields

BOF

Bookmark

CacheBlobs

CachedUpdates

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Constraints

Database

DatabaseName

DataSource

DBHandle

DBLocale

DBSession

DefaultFields

Designer

DesignInfo

EOF

Exclusive

ExpIndex

FieldCount

FieldDefs

Fields

FieldValues

Filter

Filtered

FilterOptions

Found

Handle

IndexDefs

IndexFieldCount

IndexFieldNames

IndexFields

IndexFiles

IndexName

KeyExclusive

KeyFieldCount

KeySize

Locale

MasterFields

MasterSource

Modified

Name

Owner

Provider

ReadOnly

RecNo

RecordCount

RecordSize

SessionName

State

TableLevel

TableName

TableType

Tag

UpdateMode

UpdateObject

UpdateRecordTypes

UpdatesPending

VCLComObject


TTable.CanModify
TTable.CanModify3405004

TTable	参照

CanModify プロパティは，アプリケーションでデータベーステーブル内のデータを挿入，編集，または削除できるかどうかを示します。

property CanModify: Boolean;

説明

CanModify プロパティを取得すると，アプリケーションでデータセットを変更できるかどうかがわかります。このプロパティが True であれば，変更できます。False であれば，データベーステーブルは読み出し専用です。

CanModify プロパティは，アプリケーションでデータベーステーブルを開いたとき自動的に設定されます。テーブルコンポーネントの ReadOnly プロパティが True であれば，CanModify は False に設定されます。CanModify は以下の場合にも False に設定されます。

・	他のアプリケーションが現在，当該テーブルに排他的書き込み権を持っている

・	当該テーブルがデータベース設計により読み出し専用である

注意

CanModify が True であっても，テーブルにレコードを挿入したりレコードを更新したりできるとは保証されません。他の要因，たとえば SQL アクセス特権なども関係してきます。


Constraints

Constraints プロパティは，データベースサーバーの制約がデータセットに複写されるかどうかを表します。

property Constraints: Boolean;

説明

Constraints プロパティは，データセットがデータベースサーバーから制約をインポートするかどうかを指定できます。デフォルト値は True です。データセットがサーバーの制約をインポートしないようにするには，データセットを開く前に Constraints を False に設定します。


TTable.DataSource
TTable.DataSource3405006

TTable	参照

DataSource プロパティは，テーブルのデータソースを指定します。

property DataSource: TDataSource;

説明

DataSource プロパティによって，現在テーブルに割り当てられているデータソースがわかります。DataSource コンポーネントの DataSet プロパティに当該テーブルコンポーネントの名前を設定すると，テーブルの DataSource プロパティは自動的にこのテーブルを使うデータソースコンポーネントの名前に更新されます。


TTable.Exclusive
TTable.Exclusive3405007

TTable	参照

Exclusive プロパティは，Paradox テーブルまたは dBASE テーブルに対する排他的アクセス権を与えます。

property Exclusive: Boolean;

説明

Exclusive プロパティは，Paradox テーブルまたは dBASE テーブルを使っているとき，他のアプリケーションでこれらのテーブルにアクセスできなくすることができます。テーブルを開く前に，このプロパティを True にしてください。

このプロパティが True で，テーブルを開くのに成功した場合，他のアプリケーションはこのテーブルにアクセスできなくなります。しかし，排他的アクセス権を要求したテーブルがすでに他のアプリケーションによって使用されていた場合，例外が発生します。この例外を処理するには，例外ハンドラを作成します。

テーブルは，Exclusive プロパティの設定を変更する前に閉じないといけません。設計時に Active プロパティも True に設定するつもりであれば，設計時に Exclusive プロパティを True に設定しないでください。この場合，テーブルがすでに IDE によって使用されているため，例外が発生するからです。

注意

SQL テーブルに対しても Exclusive プロパティを True に設定しようと試みることはできます。しかし，排他的テーブルロックをサポートしない SQL サーバーがあります。他の SQL サーバーは排他的読み出し権／書き込みロック権を許可しますが，それでも他のアプリケーションにも読み出し専用権を与えます。特定のサーバーにおけるデータベーステーブルの排他的ロックに関する詳細については，そのサーバーのマニュアルを参照してください。


TTable.IndexDefs
TTable.IndexDefs3405008

TTable	参照

IndexDefs プロパティは，テーブルのインデックスに関する情報を持っています。

property IndexDefs: TIndexDefs;

説明

IndexDefs プロパティは，テーブルのインデックス情報を取得できます。このプロパティはインデックス項目の配列で，各インデックス項目は利用可能なインデックスを表しています。通常，IndexFieldNames プロパティまたは IndexFields プロパティを使ってインデックスにアクセスしたりインデックスを指定したりします。

注意

IndexDefs プロパティ内のインデックス項目は，常に現在，利用可能なインデックスを示しているわけではありません。IndexDefs プロパティをチェックする前に，Update メソッドを呼び出して最新の項目リストに更新してください。


TTable.IndexFieldCount
TTable.IndexFieldCount3405009

TTable	参照

IndexFieldCount プロパティは，現在のキーを構成する項目の数を示します。

property IndexFieldCount: Integer;

説明

IndexFieldCount プロパティは，現在のキーを構成する項目の数を取得できます。このプロパティは，1 列をベースにしたインデックスの場合，1 を返し，複数列インデックスの場合，ベースとなる項目の数を返します。


TTable.IndexFieldNames
TTable.IndexFieldNames3405010

TTable	参照

IndexFieldNames プロパティは，テーブルのインデックスとして利用する列をリストします。

property IndexFieldNames: string;

説明

IndexFieldNames プロパティは，テーブルのインデックスを指定する 2 つの方法のうちの一つです。このプロパティでは，インデックスとなる各列の名前を指定します。列の名前の順序は重要で，それぞれの名前はセミコロンで区切ります。

Paradox と dBASE の場合，このプロパティで指定する列の名前には，インデックスが付いていなければなりません。SQL ベースのテーブルの場合，列にインデックスを付ける必要はありません。

注意

IndexFieldNames プロパティと IndexName プロパティは相互に排他的です。一方を設定すると，もう一方がクリアされます。


TTable.IndexFields
TTable.IndexFields3405011

TTable	参照

IndexFields プロパティは，インデックス内の項目を取り出したり設定したりします。

property IndexFields: [Index: Integer]: TField;

説明

IndexFields は，項目オブジェクトにゼロを起点とした配列を提供します。各項目オブジェクトは現在のインデックスにある項目に対応します。インデックスはインデックス内の項目の位置を表す序数です。インデックスの 1 番目の項目は IndexFields[0]で，2 番目の項目は IndexFields[1] などとなります。

注意

直接 IndexField を設定しないでください。かわりに IndexFieldNames プロパティを使って実行時にデータセットを順序付けます。


TTable.IndexFiles
TTable.IndexFiles3405012

TTable	参照

IndexFiles プロパティは，非プロダクションインデックスを使う dBASE テーブル用の dBASE インデックスファイルを 1 つまたは複数，指定します。

property IndexFiles: TStrings;

説明

IndexFiles プロパティは，非プロダクションインデックスを使う dBASE テーブル用の dBASE インデックスファイルを指定できます。このインデックスファイルは複数のインデックスを持てます。インデックスファイル内の各インデックスは，任意に使われる実際のインデックスを指定する IndexName プロパティ用に選択できます。

使用可能なインデックスリストにインデックスファイルが追加されたとき，テーブルコンポーネントはこのインデックスファイルを開きます。テーブルになされた挿入や変更はインデックスファイルに保持されます。インデックスファイルがインデックスリストから削除されると，そのインデックスファイルはテーブルコンポーネントによって閉じられ，もう保守されなくなります。

注意

設計時にオブジェクトインスぺクタを使って，インデックスファイル名を IndexFiles プロパティに追加したり削除したりできます。実行時，IndexFiles プロパティにセミコロンで区切られたファイル名リストを含む文字列を設定することで，複数のインデックスファイルを指定できます。


TTable.IndexName
TTable.IndexName3405013

TTable	参照

IndexName プロパティは，テーブルの二次インデックスを示します。

property IndexName: string;

説明

IndexName プロパティで，テーブルの二次インデックスを指定できます。また IndexName プロパティに何も指定されていない場合，テーブルは一次インデックスをキーにしてソートされますが，dBASE テーブルについては物理的レコード順でソートされます。

IndexName プロパティに有効なインデックス名が含まれている場合，そのインデックスでレコードのソート順序がわかります。dBASE テーブルの場合，IndexName プロパティに与えられたインデックス名はテーブルのマスターインデックスファイル内に置くか，すでに IndexFiles プロパティに指定されている他のインデックスファイル内に置かないといけません。

注意

IndexFieldNames プロパティと IndexName プロパティは相互に排他的です。一方を設定するともう一方はクリアされます。


TTable.KeyExclusive
TTable.KeyExclusive3405014

TTable	参照

KeyExlusive プロパティは，範囲の上下限を指定します。

property KeyExclusive: Boolean;

説明

KeyExclusive プロパティは，範囲の開始値および終了値に一致するレコードを範囲内のものとするか除外するかを指定します。デフォルトで，このプロパティは True で，開始値および終了値に一致する値を含めることになります。

開始値より大きく終了値より小さい各レコードの範囲を制限するには，KeyExclusive プロパティを False に設定します。


TTable.KeyFieldCount
TTable.KeyFieldCount3405015

TTable	参照

KeyFieldCount プロパティは，部分キーを使って複数項目キー検索を行うとき，使用する項目の数を指定します。

property KeyFieldCount: Integer;

説明

KeyFieldCount プロパティは，複数項目キーに基づく検索を行う場合に，使用する項目をそれらの項目の連続するサブセットに限定します。KeyFieldCount はゼロを起点とします。たとえば，一次キーが 3 つの項目からなるとき，KeyFieldCount を 0 に設定すると，1 番目のキー項目を使って部分キー検索が行われます。

注意

検索は，1 番目の項目で始まる連続するキー項目に対してのみ行われます。たとえばキーが 3 項目からなる場合，KeyFieldCount に 0 を設定すると 1 番目の項目，1 を設定すると 1 番目と 2 番目の項目，2 を設定するとすべての項目に基づいて検索が行われます。デフォルトでは，全項目を含む検索が行われます。


TTable.MasterFields
TTable.MasterFields3405016

TTable	参照

MasterFields プロパティは，マスターテーブルと当該テーブルとの間にマスターリンク関係を確立するため，当該テーブルの項目とリンクするマスターテーブル内の 1 つまたは複数の項目を指定します。

property MasterFields: string;

説明

MasterFields プロパティは，1 つまたは複数の項目を指定して当該テーブルと MasterSource プロパティで指定したテーブルとの間にマスターリンク関係を確立するとき，MasterSource プロパティ設定後に設定するプロパティです。

このプロパティは，マスターテーブル内の 1 つまたは複数の項目名からなる文字列です。項目名はセミコロンで区切ります。

マスターテーブル内の現在のレコードが変化するたびに，項目内の新しい値を使って当該テーブル内の対応レコードを選択して表示します。

注意

設計時には［リンク項目の設計］ダイアログを使ってテーブル間のマスターリンク関係を確立します。


TTable.MasterSource
TTable.MasterSource3405017

TTable	参照

MasterSource プロパティは，テーブル間にマスターリンク関係を確立する際，マスターテーブルとして使用するデータソースコンポーネントの名前を指定します。

property MasterSource: TDataSource;

説明

MasterSource プロパティは，テーブル間にマスターリンク関係を確立する際，DataSet プロパティがマスターテーブルとして使用されるデータセットを示しているデータソースコンポーネントの名前を指定します。

注意

設計時は，オブジェクトインスぺクタ内で MasterSource プロパティのドロップダウンリストから利用可能なデータソースを選んでください。

MasterSource プロパティ設定後，MasterFields プロパティを設定することによってマスターテーブル内で使用する項目を指定します。実行時，マスターテーブル内の現在のレコードが変化するたびに，項目内の新しい値を使って，当該テーブルの対応レコードを選択して表示します。

注意

設計時は，［リンク項目の設計］ダイアログを使って，テーブル間のマスターリンク関係を確立します。


TTable.ReadOnly
TTable.ReadOnly3405018

TTable	参照

ReadOnly プロパティは，あるテーブルが当該アプリケーションで読み出し専用かどうかを示します。

property ReadOnly: Boolean;

説明

ReadOnly プロパティは，テーブル内のデータを更新，挿入，または削除できないようにするものです。デフォルトでこのプロパティは False で，テーブルのデータは変更可能です。

注意

ReadOnly プロパティが False であっても，データを変更したり追加したりできない場合があります。つまり，当該アプリケーションまたは現在のユーザーが持つ SQL 特権が充分でないなどの理由で，変更や追加ができないことがあるわけです。

テーブルの変更や追加を絶対できないようにするには，次のようにします。

1.	Active プロパティを False に設定する

2.	ReadOnly プロパティを True に設定する

ReadOnly プロパティが False のとき，CanModify プロパティは False となります。


TTable.TableLevel
TTable.TableLevel3405019

TTable	参照

TableLeve プロパティは，ボーランドデータベースエンジン（BDE）ドライバに依存するテーブルレベルを指定します。

property TableLevel: Integer;

説明

TableLevel プロパティは，テーブル作成時にデータセットのテーブルを処理するために必要な特定のレベルの BDE ドライバを指定できます。TableLevel が 0 の場合（デフォルト），このプロパティは無視されます。

BDE ドライバに依存するテーブルレベル仕様の詳細については，オンライン BDE ヘルプファイル，BDE32.HLP を参照してください。


TTable.TableName
TTable.TableName3405020

TTable	参照

TableName プロパティは，当該コンポーネントがカプセル化するデータベーステーブルの名前を示します。

property TableName: TFileName;

説明

TableName プロパティは，当該コンポーネントがカプセル化するデータベーステーブルの名前を指定します。このプロパティに意味のある値を設定するには，DatabaseName プロパティがすでに設定されていないといけません。DatabaseName プロパティが設計時に設定されていれば，オブジェクトインスぺクタにおいて TableName ドロップダウンリストから正しいテーブル名を選択します。

注意

TableName プロパティを設定するには，Active プロパティが False でなければなりません


TTable.TableType
TTable.TableType3405021

TTable	参照

TableType プロパティは，当該コンポーネントがカプセル化するテーブルのデータベーステーブル構造を示します。

type

TTableType = (ttDefault, ttParadox, ttDBase, ttASCII);

property TableType: TTableType

説明

TableType プロパティは，dBASE，Paradox，または ASCII テーブルのデータベーステーブル構造を指定します。このプロパティは，リモート SQL サーバーのテーブルには適用されません。このプロパティには，以下の値のいずれかを設定します。

値	意味

ttDefault	（デフォルト）テーブルのファイル拡張子からテーブルタイプが決まる

ttParadox	Paradox テーブル

ttDBase	dBASE テーブル

ttASCII	各項目がカンマで区切られた引用符付き文字列からなるテキストファイル

TableType プロパティが ttDefault の場合，以下のようにファイル名拡張子によってテーブルの種類が決まります。

拡張子	意味

DB またはなし	Paradox テーブル

DBF	dBASE テーブル

TXT	ASCII テーブル

TableType プロパティが ttParadox，ttDBase，または ttSCII の場合，ファイル名拡張子に関係なく，テーブルの種類は 1 つ目の表で指定されたものになります。


TTable イベント3405022

TTable	アルファベット順	凡例

TBDEDataSet からの継承

OnServerYield

OnUpdateError

OnUpdateRecord

TDataSet からの継承

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TTable イベント3405023

TTable	オブジェクト順	凡例

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError

OnServerYield

OnUpdateError

OnUpdateRecord


TTable メソッド3405024

TTable	アルファベット順	凡例

TBDEDataSet からの継承

OnServerYield

OnUpdateError

OnUpdateRecord

TDataSet からの継承

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TTable メソッド3405025

TTable	オブジェクト順	凡例

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError

OnServerYield

OnUpdateError

OnUpdateRecord


AddIndex

AddIndex メソッドは，テーブルの新しいインデックスを作成します。

type

  TIndexOptions = set of (ixPrimary, ixUnique, ixDescending,
     ixCaseInsensitive, ixExpression);

procedure AddIndex(const Name, Fields: string; Options: TIndexOptions);

説明

AddIndex メッドを呼び出すと，テーブルの新しいインデックスが作られます。この手続きによって作成されるインデックスは，データセットの基であるデータセットテーブルに追加されます。Name パラメータは新しいインデックスの名前です。Fields パラメータは，インデックスに入る項目をセミコロンで区切ったリストを指定します。Options パラメータは，以下の値の 1 つまたは複数に限定されたセットです。

値	意味	制約

ixPrimary	一次インデックスを作る	dBASE では使えない。

1 つのテーブルで複数の一次インデックスを作れない

isUnique	一意なインデックスを作る

ixDescending	降順でソートする

ixCaseInsensitive	ソート時，大文字・小文字を無視する	dBASE では使えない

ixExpression	式インデックスを作る	dBASE のみ

適用できないオプションを使用してインデックスを作ろうとすると，例外が発生します。


ApplyRange

ApplyRange メソッドは，データセットにある範囲を適用します。

procedure ApplyRange;

説明

ApplyRange メソッドを呼び出すと，SetRangeStart と SetRangeEnd，あるいは EditRangeStart と EditRangeEnd によって設定された範囲が有効になります。有効になると，その範囲におさまるレコードしか表示や編集ができません。


BatchMove

BatchMove メソッドは，データセット内のレコードを当該テーブルに移動します。

type TBatchMode = (batAppend, batUpdate, batAppendUpdate, batDelete, batCopy);

function BatchMove(ASource: TBDEDataSet; AMode: TBatchMode): Longint;

説明

BatchMove を呼び出すと，以下の処理が行われます。

・	他のテーブルから当該テーブルへレコードをコピーする

・	他のテーブルの対応レコードで当該テーブルのレコードを更新する

・	他のテーブルのレコードを当該テーブルの末尾に追加する

・	他のテーブルにソースがある当該テーブルのレコードを削除する

ASource パラメータは，当該テーブルにインポートしたレコードを持っている元のデータセットコンポーネントを表します。AMode パラメータには，以下の値のいずれかを指定します。

値	意味

batAppend	ソーステーブルの全レコードを当該テーブルの末尾に追加する

batAppendUpdate	ソーステーブルの全レコードを当該テーブルの末尾に移動し，当該テーブルの既存レコードをソーステーブルの対応レコードで更新する

batCopy	ソーステーブルの全レコードを当該テーブルにコピーする

batDelete	当該テーブルにあるレコードのうちソーステーブルにもあるレコードをすべて削除する

batUpdate	当該テーブルの既存レコードをソーステーブルの対応レコードで更新する

BatchMove メソッドは，処理したレコード数を返します。


CancelRange

CancelRange メソッドは，現在有効な範囲を消去します。

procedure CancelRange;

説明

CancelRange メソッドを呼び出すと，現在テーブルに適用されている範囲が消去されます。消去することで，データセット内の全レコードに再びアクセスできるようになります。


CloseIndexFile

CloseIndexFile メソッドは，指定した dBASE 非プロダクションインデックスファイルを閉じます。

procedure CloseIndexFile(const IndexFileName: string);

説明

CloseIndexFile メソッドを呼び出すと，指定した dBASE 非プロダクションインデックスファイルが閉じられます。IndexFileName パラメータは閉じたいファイルの名前で，OpenIndexFile 呼び出しで開かれているインデックスファイルか，または IndexFiles プロパティ内にファイル名がリストされているため開かれているインデックスファイル，どちらかの名前です。

非プロダクションインデックスファイルは閉じられると，それ以降，保守されなくなります。データセットに対してこれ以降行われる変更は，インデックスに反映されないことになります。


Create

Create メソッドは，テーブルコンポーネントのインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，アプリケーションで宣言されたテーブルで，設計時にフォーム上に配置されていなかったテーブルをインスタンス化できます。このメソッドは，継承された Create コンストラクタの呼び出し，空のインデックス定義リストの作成，空のデータリンクの作成，および空のインデックスファイルリストの作成を行います。


CreateTable

CreateTable メソッドは，新しい構造情報を使って新しいテーブルを作成します。

procedure CreateTable;

説明

実行時に CreateTable メソッド呼び出すと，データセットの現在の定義を使ってテーブルを作成することができます。CreateTable は既存のテーブルの構造とデータを上書きします。

FieldDefs プロパティに値が指定されている場合，この値を使って項目定義を作成します。FieldDefs プロパティに値が指定されていない場合，Fields プロパティを使って項目定義を作成します。データセットを再作成するには，2 つのプロパティの一方あるいは両方に値が指定されていないといけません。

IndexDefs プロパティに値が指定されている場合，この値を使ってデータセットのインデックス定義を作成します。


DeleteIndex

DeleteIndex メソッドは，テーブルの二次インデックスを削除します。

procedure DeleteIndex(const Name: string);

説明

DeleteIndex メソッドを呼び出すと，テーブルの二次インデックスが削除されます。Name パラメータは削除するインデックスの名前です。このメソッドでは一次インデックスを削除できません。

注意

インデックスを削除するには，まず排他的アクセス権を持ってテーブルを開かなければなりません。


DeleteTable

DeleteTable メソッドは，既存のデータセットテーブルを削除します。

procedure DeleteTable;

説明

DeleteTable メソッドを呼び出すと，DatabaseName プロパティと TableName プロパティによって定義された既存のデータベーステーブルが削除されます。削除されるテーブルは，その前に閉じななければなりません。

警告

テーブルを削除すると，そのテーブル内のデータはすべて消去され，テーブルの構造情報も破棄されます。


Destroy

Destroy メソッドは，テーブルのインスタンスを破棄します。

destructor Destroy; override;

説明

直接 Destroy メソッドを呼び出さずに Free メソッドを呼び出してください。Free メソッドは，テーブルが解放されていないことを確認してから Destroy メソッドを呼び出します。Destroy メソッドは，インデックスファイルリストの解放，データリンクの解放，インデックス定義の解放を行い，次に継承された Destroy デストラクタを呼び出します。


EditKey

EditKey メソッドは，検索キーバッファの変更ができるようにします。

procedure EditKey;

説明

EditKey メソッドを呼び出すと，検索キーバッファの現在の内容を保持しながら，データセットを dsSetKey 状態に設定することができます。現在の検索キーを決定するには，IndexFields プロパティを使って現在のインデックスが使っている項目を反復処理します。

EditKey メソッドが特に役立つのは，各検索の間で，数多くある項目のうち 1 つか 2 つしか項目値が変わらないような複数の検索を実行するときです。


EditRangeEnd

EditRangeEnd メソッドは，既存範囲の終了値の変更ができるようにします。

procedure EditRangeEnd;

説明

EditRangeEnd メソッドを呼び出すと，既存範囲の終了値を変更することができます。終了範囲値を指定するには，EditRangeEnd メソッドを呼び出してから FieldByName メソッドを呼び出します。新しい終了値を割り当てた後，ApplyRange メソッドを呼び出して修正した範囲をアクティブにします。

注意

Paradox テーブルまたは dBASE テーブルの場合，EditRangeEnd メソッドはインデックス付けされた項目にしか適用されません。SQL データベースの場合，IndexFieldNames プロパティで指定されたすべての列にも適用されます。


EditRangeStart

EditRangeStart メソッドは，既存範囲の開始値の変更を可能にします。

procedure EditRangeStart;

説明

EditRangeStart メソッドを呼び出すと，既存範囲の開始値を変更することができます。開始範囲値を指定するには，EditRangeStart メソッドを呼び出してから FieldByName メソッドを呼び出します。新しい開始値を割り当てた後，ApplyRange メソッドを呼び出して修正した範囲をアクティブにします。

注意

Paradox テーブルまたは dBASE テーブルの場合，EditRangeStart メソッドはインデックス付けされた項目にしか適用されません。SQL データベースの場合，IndexFieldNames プロパティで指定されたすべての列にも適用されます。


EmptyTable

EmptyTable メソッドは,

テーブルから全レコードを削除します。

procedure EmptyTable;

説明

EmptyTable メソッドは，DatabaseName プロパティと TableName プロパティで指定されたデータベーステーブルから全レコードを削除します。

注意

削除処理を実行するだけの特権がない場合，削除が失敗することがあります。


FindKey

FindKey メソッドは，指定された項目値を含むレコードを検索します。

function FindKey(const KeyValues: array of const): Boolean;

説明

FindKey メソッドを呼び出すと，指定されたレコードがデータセット内で検索されます。KeyVaues パラメータは検索キーである項目値をカンマで区切った配列です。キー内の値はリテラル，変数，ヌル，あるいは nil のいずれかです。KeyValues 内の値の数が検索に使用されるインデックス内の列の数よりも少ない場合，その部分の値はヌルになります。

Paradox テーブルと dBASE テーブルの場合，キーは必ずインデックスでなければならず，IndexName プロパティで指定できます。このプロパティに何も指定されていない場合，テーブルの一次キーがキーとなります。

SQL テーブルの場合，キーは，IndexName プロパティ内のインデックス，または IndexFieldNames プロパティ内の項目名リストと一致することがあります。

検索に成功した場合，FindKey メソッドはカーソルを一致したレコードに移動し，True を返します。検索に失敗した場合，カーソルは移動せず，False を返します。


FindNearest

FindNearest メソッドは，指定されたキー値セットに最も近いレコードにカーソルを移動します。

procedure FindNearest(const KeyValues: array of const);

説明

FindNearest メソッドを呼び出すと，データセット内の指定されたレコード，または指定された値よりも大きいレコードのうち最初のレコードにカーソルが移動します。KeyValues パラメータは，検索キーである項目値をカンマで区切った配列です。キー内の値の数が検索に使用される列の数よりも少ない場合，その部分の値はヌルになります。

Paradox テーブルと dBASE テーブルの場合，キーは必ずインデックスでなければならず，IndexName プロパティで指定できます。このプロパティに何も指定されていない場合，テーブルの一次キーがキーとなります。

SQL テーブルの場合，キーは IndexName プロパティ内のインデックス，あるいは IndexFieldNames プロパティ内の項目名リストと一致することがあります。

このメソッドは，検索キーに完全に一致するレコード，あるいは検索キーに指定された値よりも大きいレコードのうち最初のレコードにカーソルを移動します。KeyExclusive プロパティは範囲の境界条件にも影響を及ぼし，FindNearest によって選択されるレコードにも影響を及ぼすことになります。


GetIndexNames

GetIndexNames メソッドは，テーブルの利用可能なインデックスリストを取り出します。

procedure GetIndexNames(List: TStrings);

説明

GetIndexNames メソッドを呼び出すと，テーブルの利用可能なインデックスすべてを取り出せます。List パラメータは，アプリケーションで作成され保守されている文字列リストで，ここにインデックス名を取り出します。


GotoCurrent

GotoCurrent メソッドは，現在のレコードの位置を，指定したテーブルコンポーネントの現在のレコードと同じにします。

procedure GotoCurrent(Table: TTable);

説明

GotoCurrent メソッドを呼び出すと，テーブルの現在の位置が，異なるデータソースコンポーネントを使っているが，同じデータベーステーブルにリンクしている他のデータセットの現在の位置と同じになります。Table パラメータは，カーソル位置を同じにしたいデータセットの名前です。

注意

このメソッドは，Database プロパティと TableName プロパティの値が同じであるテーブルコンポーネントにしか適用されません。これらのプロパティが異なる場合にこのメソッドを使用すると，例外が発生します。

このメソッドは主に，異なるデータソースコンポーネントを介して同じデータベーステーブルにリンクしている 2 つのテーブルコンポーネントを持ったアプリケーションにおいて使用するものです。このメソッドを使用することで，別々に表示されていたデータが確実にリンクして見えるようになります。


GotoKey

GotoKey メソッドは，現在のキーによって指定されたレコードにカーソルを移動します。

function GotoKey: Boolean;

説明

GotoKey メソッドを呼び出すと，SetKey 呼び出しか EditKey 呼び出しで割り当てられたキー値，および Fields プロパティ内で指定された実際の検索値が示すレコードに移動します。

一致するレコードを見つけた場合，このメソッドはカーソルをそのレコードに位置付け，True を返します。一致するレコードを見つけなかった場合，現在のカーソル位置を変えず，False を返します。


GotoNearest

GotoNearest メソッドは，現在のキーに最も近いレコードにキーを移動します。

procedure GotoNearest;

説明

GotoNearest メソッドを呼び出すと，キーバッファ内の現在のキー値で指定したのと同じレコードか，あるいはそれを超える最初のレコードにカーソルが移動します。

注意

KeyExclusive は，どのレコードが検索範囲部分にあると判断されるかを決定します。

GotoNearest メソッドを呼び出す前に，データセットを dsSetKey 状態に設定するために SetKey メソッドか EditKey メソッドを呼び出してキー値を指定してから，FieldByName を使ってキーバッファに検索値を設定しなければなりません。


LockTable

LockTable メソッドは，Paradox テーブルまたは dBASE テーブルをロックします。

type TLockType = (ltReadLock, ltWriteLock);

procedure LockTable(LockType: TLockType);

説明

LockTable メソッドを呼び出すと，Paradox テーブルまたは dBASE テーブルに対して，他のアプリケーションから特定の型のロックをかけられないようにそのテーブルをロックできます。LockType パラメータでアプリケーションが要求するロックの種類を指定します。

読み出しロックを要求すると，他のアプリケーションがテーブルから読み出せないようにできます。また，書き込みロックを要求すると，他のアプリケーションがテーブルに書き込めないようにできます。

読み出しロックに 1 回，書き込みロックに 1 回，計 2 回 LockTable メソッドを呼び出せば，読み出し，書き込み両方のロックを要求できます。


OpenIndexFile

OpenIndexFile メソッドは，プロダクションファイル以外の指定された dBASE インデックスファイルを開きます。

procedure OpenIndexFile(const IndexFileName: string);

説明

OpenIndexFile メソッドを呼び出すと，プロダクションファイル以外の指定された dBASE インデックスファイルを開けます。IndexFileName パラメータで，開きたいファイルの名前を指定します。 OpenIndexFile は，指定されたファイルを開き，そのファイル名を IndexFiles プロパティ内のインデックスファイルリストに追加します。

プロダクションファイル以外のインデックスファイルが開いている間，そのファイルは保守されます。


RenameTable

RenameTable メソッドは，テーブルコンポーネントに関連付けられた Paradox テーブルまたは dBASE テーブルの名前を変更します。

procedure RenameTable(const NewTableName: string);

説明

RenameTable メソッドを呼び出すと，テーブルコンポーネントの基である Paradox テーブルまたは dBASE テーブルに新しい名前を付けられます。このメソッドは，テーブルとすべてのサポートファイル（Paradox.DB ファイル，Paradox.MB ファイルなど）の名前を変更します。


SetKey

SetKey メソッドは，検索前にデータセットのキー設定と範囲設定を有効にします。

procedure SetKey;

説明

SetKey メソッドを呼び出すと，データセットを dsSetKey 状態に設定し，キーバッファの現在の内容をクリアできます。FieldByMethod は，検索前に新しい検索値を提供するために使われます。

注意

既存のキーや範囲を変更するには，EditKey を呼び出してください。


SetRange

SetRange メソッドは，範囲の開始値と終了値を設定し，それを適用します。

procedure SetRange(const StartValues, EndValues: array of const);

説明

SetRange メソッドを呼び出すと，ある範囲が指定され，それがデータセットに適用されます。StartValues パラメータは範囲の最初のレコードとなる項目値を，EndValues パラメータは最後のレコードとなる項目値をそれぞれ示します。

このメソッドは，SetRangeStart，SetRangeEnd，および ApplyRange の各機能をまとめて 1 つの手続きにしたものです。このメソッドは以下の機能を実行します。

1.	データセットを dsSetKey 状態に設定する

2.	既存の範囲開始値と範囲終了値を削除する

3.	新しい範囲開始値と範囲終了値を設定する

4.	新しい範囲をデータセットに適用する

StartValues パラメータまたは EndValues パラメータいずれかの要素の数が現在のインデックスの項目数より少ない場合，範囲指定に使われる項目の数も少なくなります。

注意

Paradox テーブルまたは dBASE テーブルの場合，SetRange メソッドはインデックス付けされた項目にしか適用されません。SQL データベースの場合，IndexFieldNames プロパティに指定されたすべての列にも適用されます。


SetRangeEnd

SetRangeEnd メソッドは，項目に新しい値を代入すると，それが行範囲の終了値となることを示します。

procedure SetRangeEnd;

説明

SetRangeEnd メソッドを呼び出すと，データセットが dsSetKey 状態に設定され，これまでの範囲終了値が削除されてヌルに設定されます。この後，FieldByName メソッドを使って範囲の終了値を設定し，キーバッファに代入される項目値を作成することができます。

FieldValues プロパティに範囲終了値を代入した後，変更した範囲をアクティブにするには ApplyRange を呼び出します。

注意

Paradox テーブルまたは dBASE テーブルの場合，SetRangeEnd メソッドはインデックス付けされた項目にしか適用されません。SQL データベースの場合，IndexFieldNames プロパティ内に指定されたすべての列にも適用されます。


SetRangeStart

SetRangeStart メソッドは，項目に新しい値を代入すると，それが行範囲の開始値となることを示します。

procedure SetRangeStart;

説明

SetRangeStart メソッドを呼び出すと，データセットが dsSetKey 状態に設定され，これまでの範囲開始値が削除されてヌルに設定されます。この後，FieldValues プロパティに代入される項目値が新しい開始値となります。

FieldValues プロパティに範囲開始値を代入した後，変更した範囲をアクティブにするには ApplyRange を呼び出します。

注意

Paradox テーブルまたは dBASE テーブルの場合，SetRangeStart メソッドはインデックス付けされた項目にしか適用されません。SQL データベースの場合，IndexFieldNames プロパティ内に指定されたすべての列にも適用されます。


UnlockTable

UnlockTable メソッドは，Paradox テーブルまたは dBASE テーブルにかけられているロック状態を解除します。

type TLockType = (ltReadLock, ltWriteLock);

procedure UnlockTable(LockType: TLockType);

説明

UnlockTable メソッドを呼び出すと，他のアプリケーションからロックされないように Paradox テーブルまたは dBASE テーブルにかけられていたロック状態が解除されます。LockType パラメータは解除するロックの種類を指定します。

読み出しロックを解除すると，他のアプリケーションからテーブルを読み出せるようになります。書き込みロックを解除すると，他のアプリケーションからテーブルに書き込めるようになります。

読み出し解除に 1 回，書き込み解除に 1 回，計 2 回 UnlockTable メソッドを呼び出せば，読み出し，書き込み両方のロック状態を解除できます。


スコープ3405054

published

読み出し／書き込み

読み出し専用


スコープ

published


スコープ3405055

published


継承3405056

TObject

TPersistent

TComponent

TDataSet

TBDEDataSet

TDBDataSet


TTable 例3405057

TTable


THTMLTableRowAttributes
THTMLTableRowAttributes3406001

継承	プロパティ	メソッド	イベント	参照

THTMLTableRowAttributes オブジェクトは HTML テーブルの行タグの表示属性を表します。

ユニット

httpapp

説明

THTMLTableRowAttributes を使うと，HTML テーブルの行の外観を記述できます。THTMLTableRowAttributes オブジェクトのプロパティは HTML 行タグ（RT）に追加できるオプションに対応します。HTML テーブルの属性をすべて指定すると，コンテンツ作成オブジェクトが HTML コマンドを作成し，記述に従ってテーブルを指定します。

HTMLTableRowAttributes は直接の上位オブジェクト THTMLTableElementAttributes によって提供されるプロパティ，イベント，メソッド以外には，新しいプロパティ，イベント，メソッドは提供しません。


THTMLTableRowAttributes プロパティ3406002

THTMLTableRowAttributes	アルファベット順	凡例

THTMLTableElementAttributes からの継承

Align

BgColor

VAlign

THTMLTagAttributes からの継承

Custom

Producer


THTMLTableRowAttributes プロパティ3406003

THTMLTableRowAttributes	オブジェクト順	凡例

Align

BgColor

Custom

Producer

VAlign


THTMLTableRowAttributes イベント3406004

THTMLTableRowAttributes	アルファベット順

THTMLTagAttributes からの継承

OnChange


THTMLTableRowAttributes イベント3406005

THTMLTableRowAttributes	オブジェクト順

OnChange


THTMLTableRowAttributes メソッド3406006

THTMLTableRowAttributes	アルファベット順

THTMLTableElementAttributes からの継承

RestoreDefaults

THTMLTagAttributes からの継承

Create

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THTMLTableRowAttributes メソッド3406007

THTMLTableRowAttributes	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RestoreDefaults

SafeCallException


スコープ3406008

published

読み出し／書き込み

読み出し専用


継承3406009

TObject

TPersistent

THTMLTagAttributes

THTMLTableElementAttributes


THTMLTableRowAttributes 例3406010

THTMLTableRowAttributes


TTabSheet
TTabSheet3407001

継承	プロパティ	メソッド	イベント	参照

TTabSheet コンポーネントは，TPageControl オブジェクトの個々のページです。

ユニット

comctrls

説明

TTabSheet コンポーネントは，タブ付きページコントロールでページを表します。通常，タブシートとはページを意味します。TPageControl は，Pages プロパティ中にタブシートのインデックス付きの配列を保持します。ユーザーがタブをクリックするとそのタブシートがアクティブになります。


TTabSheet プロパティ3407002

TTabSheet	アルファベット順	凡例

TTabSheet

PageControl

PageIndex

TabIndex

TabVisible

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Font

Height

Hint

Left

Name

Parent

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TTabSheet プロパティ3407003

TTabSheet	オブジェクト順	凡例

Align

BoundsRect

Brush

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Font

Handle

Height

HelpContext

Hint

Left

Name

Owner

PageControl

PageIndex

Parent

ParentFont

ParentShowHint

ParentWindow

PopupMenu

ShowHint

Showing

TabIndex

TabOrder

TabStop

TabVisible

Tag

Top

VCLComObject

Visible

Width

WindowProc


TTabSheet.PageControl
TTabSheet.PageControl3407004

TTabSheet	参照

PageControl プロパティは，タブシートを格納するページコントロールオブジェクトです。

property PageControl: TPageControl;

説明

PageControl プロパティは，タブシートを使うページコントロールオブジェクトを示します。 PageControl オブジェクトのプロパティおよびメソッドは，選択されたページの位置を特定したり，そのページコントロール内で別のページの反復処理を行ったり，タブの表示プロパティを変更したりするのにも使えます。

PageControl を設定すると，タブシートを現在のページコントロール（存在する場合）から削除して，それを新しいページコントロールに挿入できます。


TTabSheet.PageIndex
TTabSheet.PageIndex3407005

TTabSheet	参照	例

PageIndex プロパティは，ページコントロールで保守する，タブシートのリスト内でのタブシートのインデックスです。

property PageIndex: Integer;

説明

PageIndex プロパティは，ページコントロールでのタブシートの配置位置を示します。ページコントロールの各タブシートは，ページコントロールに挿入されたときに自動的に PageIndex を割り当てられます。最初のタブシートの値は 0，2 番目の値は 1 などとなります。タブシートを削除または移動すると，PageIndex 値が再割り当てされます。

インデックス値が与えられている特定のタブシートへアクセスするには，TPageControl オブジェクトのインデックス付き Pages プロパティを使います。


TTabSheet.TabIndex
TTabSheet.TabIndex3407006

TTabSheet	参照

TabIndex プロパティは，TPageControl で表示されるタブシートの位置を示します。

property TabIndex: Integer;

説明

TabIndex プロパティは，タブシートの位置を示します。値 0 は最初の表示されているタブシートを示し，値 1 は 2 番目のタブシートを示します。TabIndex は常に PageIndex に等しいか，それよりも小さくなります。たとえば，PageIndex が 3 のタブシートは，それより前のタブシートにページコントロールで非表示のものが 1 つあれば TabIndex が 2 になります。

タブシートの TabVisible プロパティが False の場合，TabIndex プロパティは -1 です。


TTabSheet.TabVisible
TTabSheet.TabVisible3407007

TTabSheet	参照	例

TabVisible プロパティは，TTabSheet オブジェクトのタブを TPageControl で表示するかどうかを示します。

property TabVisible Boolean;

説明

TabVisible プロパティは，タブシートを一時的にページコントロールから削除します。TabVisible が False の場合，タブはページコントロールで表示されず，TabIndex プロパティは -1 になります。TabVisible を True に設定すると，そのタブシートのタブが再び表示されます。


TTabSheet イベント3407008

TTabSheet	アルファベット順	凡例

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnDragDrop

OnDragOver

OnMouseDown

OnMouseMove

OnMouseUp


TTabSheet イベント3407009

TTabSheet	オブジェクト順	凡例

OnDragDrop

OnDragOver

OnEnter

OnExit

OnMouseDown

OnMouseMove

OnMouseUp


TTabSheet メソッド3407010

TTabSheet	アルファベット順

TTabSheet

Create

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TTabSheet メソッド3407011

TTabSheet	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TTabSheet.Create
TTabSheet.Create3407012

TTabSheet	参照

Create メソッドは，TTabSheet のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にタブシートをインスタンス化できます。設計時にページコントロールに追加されたタブシートは自動的に作成されます。Create は継承した Create メソッドを呼び出してから，タブシートコンポーネントの初期値を設定します。

実行時にタブシートを作成するときは，PageControl プロパティを使うとタブシートをページコントロールオブジェクトに挿入できます。


TTabSheet.Destroy
TTabSheet.Destroy3407013

TTabSheet	参照

Destroy メソッドは，TTabSheet のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは Destroy を直接呼び出さないでください。代わりに Free を呼び出します。Destroy はタブシートをページコントロールから破棄した後に，継承した Destroy メソッドを呼び出します。


スコープ3407014

published

読み出し／書き込み

読み出し専用


スコープ3407015

published


継承3407016

TObject

TPersistent

TComponent

TControl

TWinControl


TTabSheet 例3407017

TTabSheet


THTMLTableColumn
THTMLTableColumn3408001

継承	プロパティ	メソッド	参照

THTMLTableColumn オブジェクトは HTML で記述されているデータセットの列の表示属性および項目の結合を表します。

ユニット

dbweb

説明

TColumn を使うと，TDSTableProducer が作成したテーブルの列の外観や値を指定できます。アプリケーションは列のプロパティを実行時にプログラムで設定するか，設計時に列エディタで設定できます。


THTMLTableColumn プロパティ3408002

THTMLTableColumn	アルファベット順	凡例

THTMLTableColumn

Align

BgColor

Custom

DisplayName

DSTableProducer

Field

FieldName

Title

VAlign

TCollectionItem からの継承

Collection

ID

Index


THTMLTableColumn プロパティ3408003

THTMLTableColumn	オブジェクト順	凡例

Align

BgColor

Collection

Custom

DisplayName

DSTableProducer

Field

FieldName

ID

Index

Title

VAlign


THTMLTableColumn.Align
THTMLTableColumn.Align3408004

THTMLTableColumn	参照

Align プロパティは列内でセルの内容を水平方向にどう揃えるかを指定します。

THTMLAlign = (haDefault, haLeft, haRight, haCenter);

property Align: THTMLAlign;

説明

Align を設定すると，列のセル内でテキストを水平方向にどう揃えるかを指定できます。Align は HTML の TD タグの Align オプションの値を示します。

デフォルトは haDefault です。デフォルトでは，Web ブラウザはテーブル要素内でのセルの内容を垂直方向のどの位置にでも配置できます。VAlign は次の値をとります。

VAlign の デフォルト値は haVDefault で，HTML ドキュメントを読む Web ブラウザがテーブル要素内でセルの内容を垂直方向にどう揃えるかを決めることを意味します。以下に VAlign に設定される値を示します。

Align のデフォルト値は haDefault で， HTML ドキュメントを読む Web ブラウザがセルの内容を水平方向にどう揃えるかを決めることを意味します。以下に Align に設定される値を示します。

値	意味

haDefault	Web ブラウザはセルの内容を水平方向のどの位置にでも配置できる

haLeft	Web ブラウザは列内でセルの内容を左揃えで配置する

haRight	Web ブラウザは列内でセルの内容を右揃えで配置する

haCenter	Web ブラウザは列内でセルの内容を水平方向の中央に配置する


THTMLTableColumn.BgColor
THTMLTableColumn.BgColor3408005

THTMLTableColumn	参照

BgColor プロパティは，列内のセルの背景色を指定します。

THTMLBgColor = type string;

property BgColor: THTMLBgColor;

説明

BgColor プロパティは，HTML の TD タグの BgColor オプションの値を指定できます。BgColor の値は色の名前です。BgColor に設定できる文字列は以下のとおりです。

・	Aqua（空色）

・	Black（黒色）

・	Blue（青色）

・	Fuschia（赤紫色）

・	Gray（灰色）

・	Green（緑色）

・	Lime（濃緑色）

・	Maroon（栗色）

・	Navy（濃紺色）

・	Olive（黄緑色）

・	Purple（紫色）

・	Red（赤色）

・	Silver（銀色）

・	Teal（暗青緑色）

・	White （白色）

・	Yellow（黄色）

THTMLTableAttributes オブジェクトの BgColor プロパティを使うと，テーブル全体の背景色を設定できます。THTMLTableColumn の BgColor プロパティを使うと，テーブル内で 1 つの列だけを際立たせることができます。


THTMLTableColumn.Custom
THTMLTableColumn.Custom3408006

THTMLTableColumn	参照

Custom プロパティは列内のセルに付けられる HTML の TD タグのタグオプションとその値を指定します。

property Custom: string;

説明

Custom を使うと，HTML タグに追加する 1 つまたは複数のオプションを指定できます。各オプションと値は以下の形式で記述しなければなりません。

OPTIONNAME=Value

Custom に 2 つ以上のオプションを指定する場合，各オブジェクトをスペースで区切ってください。


THTMLTableColumn.DisplayName
THTMLTableColumn.DisplayName3408007

THTMLTableColumn	参照

DisplayName プロパティは，列のコレクションにある個々の HTML テーブル列の名前を表す文字列です。

property DisplayName: string;

説明

DisplayName プロパティは，TDSTableProducer が保守している列のリストから特定の列を指定できます。DisplayName は列の先頭のヘッダーセルに表示される文字列です。

注意

FieldName プロパティが設定されているときに DisplayName を読み出すと，設定されている値に関係なく DispalyName は必ず FieldName を返します。


THTMLTableColumn.Field
THTMLTableColumn.Field3408008

THTMLTableColumn	参照

Field プロパティは列の項目結合に関連付けられた項目コンポーネントです。

property Field: TField;

説明

Field プロパティは，列の項目コンポーネントに直接アクセスできます。Field は項目コンポーネントで，通常はデータセットによって保守されますが，列が計算項目を表す場合などには直接 THTMLTableColumn によって保守されることもあります。THTMLTableColumn オブジェクトを使う TDSTableProducer のデータセットから TField オブジェクトを取得した場合，または TField オブジェクトがそのデータセットに基づく計算項目である場合を除いて，Field プロパティは設定しないでください。

Field を設定すると，FieldName プロパティは自動的に更新されます。


THTMLTableColumn.FieldName
THTMLTableColumn.FieldName3408009

THTMLTableColumn	参照

FieldName プロパティは，列に結合している項目の名前です。

property FieldName: string;

説明

FieldName を設定すると，HTML テーブル内で列に結合している項目を指定できます。FieldName は，この THTMLTableColumn オブジェクトを使う TDSTableProducer オブジェクトのデータセット内にある特定の項目コンポーネントを表します。

Fieldname を設定すると，Field プロパティは自動的に更新されます。


THTMLTableColumn.Title
THTMLTableColumn.Title3408010

THTMLTableColumn	参照

Title プロパティは，列の先頭に表示されるヘッダーセルに追加する表示属性を指定します。

property Title: THTMLTableHeaderAttributes;

説明

Title に THTMLTableHeaderAttributes オブジェクトを設定すると，列の先頭のヘッダーセルに付けられる HTML の TH タグの表示属性を記述できます。Title を設定すると，THTMLTableColumn によって内部的に格納されている THTMLTableHeaderAttributes オブジェクトの Assign メソッドが呼び出されます。このため，Title プロパティに割り当てられているテーブルヘッダー属性オブジェクトのメモリが HTML テーブルの列によって所有されたり解放されたりすることはありません。

注意

テーブル属性オブジェクトが別のテーブル属性オブジェクトに割り当てられる場合，テーブルヘッダー属性オブジェクトのプロパティがすべてコピーされるわけではありません。Title が表すすべての属性を適切に設定したい場合は，Title を読み出して THTMLTableHeaderAttributes オブジェクトの各プロパティ設定してください。


THTMLTableColumn.VAlign
THTMLTableColumn.VAlign3408011

THTMLTableColumn	参照

VAlignプロパティは列内でセルの内容を垂直方向にどう揃えるかを指定します。

property VAlign: THTMLVAlign;

説明

VAlign を設定すると，列のセル内でテキストを垂直方向にどう揃えるかを指定できます。VAlign は HTML の TD タグの VAlign オプションの値を示します。

デフォルトは haDefault です。デフォルトでは，Web ブラウザはテーブル要素内でのセルの内容を垂直方向のどの位置にでも配置できます。VAlign は次の値をとります。

VAlign の デフォルト値は haVDefault で，HTML ドキュメントを読む Web ブラウザがテーブル要素内でセルの内容を垂直方向にどう揃えるかを決めることを意味します。以下に VAlign に設定される値を示します。

Align のデフォルト値は haDefault で， HTML ドキュメントを読む Web ブラウザがセルの内容を水平方向にどう揃えるかを決めることを意味します。以下に Align に設定される値を示します。

VAlign のデフォルト値は haVDefault で，HTML を読む Web ブラウザがセルの内容を垂直方向にどう揃えるかを決めることを意味します。以下に VAlign に設定される値を示します。

値	意味

haVDefault	Web ブラウザはセルの内容の垂直方向のどの位置にでも配置できる

haTop	Web ブラウザは列内でセルの内容を上部に揃える

haMiddle	Web ブラウザは列内でセルの内容を垂直方向の中央に揃える

haBottom	Web ブラウザは列内でセルの内容を下部に揃える


THTMLTableColumn メソッド3408012

THTMLTableColumn	アルファベット順

THTMLTableColumn

AssignTo

Create

Destroy

RestoreDefaults

Update

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THTMLTableColumn メソッド3408013

THTMLTableColumn	オブジェクト順

Assign

AssignTo

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RestoreDefaults

SafeCallException

Update


THTMLTableColumn.AssignTo
THTMLTableColumn.AssignTo3408014

THTMLTableColumn	参照

AssignTo メソッドは，THTMLTableColumn オブジェクトのプロパティを別の THTMLTableColumn オブジェクトにコピーします。

procedure AssignTo(Dest: TPersistent); override;

説明

アプリケーションはプロテクトされた AssignTo メソッドを呼び出すことはできません。THTMLTableColumn オブジェクトのプロパティを別のオブジェクトに割り当てるには，割り当て先オブジェクトの Assign メソッドを使います。

別のオブジェクトの Assign メソッドが THTMLTableColumn オブジェクトをコピー元として指定している場合，THTMLTableColumn オブジェクトの AssignTo メソッドが呼び出されます。AssignTo は Dest パラメータが別の THTMLTableColumn オブジェクトであるかどうかを調べ，そうならば Custom と DisplayName 以外のすべてのプロパティの値をコピーします。Dest がほかのクラスのオブジェクトの場合は，継承されたメソッドが呼び出されます。


THTMLTableColumn.Create
THTMLTableColumn.Create3408015

THTMLTableColumn	参照

Create メソッドは，THTMLTableColumn のインスタンスを作成します。

constructor Create(Collection: TCollection); override;

説明

Create を呼び出すと，実行時に THTMLTableColumn オブジェクトを作成および初期化できます。設計時に列エディタで作成された列は自動的に作成されます。

Create は THTMLTableColumn オブジェクトを割り当ててから，対応する TDSTableProducer オブジェクトにレイアウトを更新するよう指示します。


THTMLTableColumn.Destroy
THTMLTableColumn.Destroy3408016

THTMLTableColumn	参照

Destroy メソッドは，THTMLTableColumn のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは THTMLTableColumn オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。THTMLTableColumns オブジェクトに含まれる THTMLTableColumn は明示的に解放しないでください。THTMLTableColumns が管理している個々の列オブジェクトは，THTMLTableColumns 自身が解放します。


THTMLTableColumn.RestoreDefaults
THTMLTableColumn.RestoreDefaults3408017

THTMLTableColumn

RestoreDefaults メソッドは，テーブル属性オブジェクトのすべてのプロパティを初期状態に戻します。

procedure RestoreDefaults; override;

説明

RestoreDefaults メソッドは，テーブル要素属性オブジェクトに対して，プログラム上で行った変更や設計時にオブジェクトインスペクタを使って行った変更を取り消して，初期状態に戻します。

RestoreDefaults は以下のプロパティを初期化します。

・	Align は haDefault，VAlign は haVDefault

・	BgColor は空の文字列

・	Custom は空の文字列

RestoreDefaults メソッドは，列名を示す THTMLTableHeaderAttributes オブジェクトのデフォルトの設定も復元します。


スコープ3408018

published

読み出し／書き込み

読み出し専用


継承3408019

TObject

TPersistent

TCollectionItem


THTMLTableColumn 例3408020

THTMLTableColumn


THTMLTableColumns
THTMLTableColumns3409001

継承	プロパティ	メソッド	参照

THTMLTableColumns オブジェクトは，HTML で表現されたテーブルデータ内の列の表示属性および項目の結合を記述する THTMLTableColumn オブジェクトのコレクションです。

ユニット

dbweb

説明

THTMLTableColumns は，TDSTableProducer が使いやすいように設計されています。このオブジェクトは，TDSTableProducer が作成した HTML テーブルの列を記述する THTMLTableColumn オブジェクトに対する変更を格納および管理します。列の結合に変更があると，THTMLTableColumns はその変更をテーブル作成オブジェクトに通知するので，テーブル作成オブジェクトはテーブルのレイアウトを再計算できます。


THTMLTableColumns プロパティ3409002

THTMLTableColumns	アルファベット順	凡例

THTMLTableColumns

DSTableProducer

Items

State

TCollection からの継承

Count

ItemClass


THTMLTableColumns プロパティ3409003

THTMLTableColumns	オブジェクト順	凡例

Count

DSTableProducer

ItemClass

Items

State


THTMLTableColumns.DSTableProducer
THTMLTableColumns.DSTableProducer3409004

THTMLTableColumns	参照

DSTableProducer プロパティは，THTMLTableColumns を使って列記述オブジェクトを格納および管理する TDSTableProducer オブジェクトです。THTMLTableColumns は，これらの列記述オブジェクトを使って HTML でデータセットを構築します。

property DSTableProducer: TDSTableProducer;

説明

DSTableProducer プロパティは，THTMLTableColumns オブジェクトを使うテーブル作成オブジェクトに直接アクセスできます。THTMLTableColumns はこのプロパティを使ってテーブル作成オブジェクトに列の変更を通知するので，テーブル作成オブジェクトはテーブルのレイアウトを再計算できます。


THTMLTableColumns.Items
THTMLTableColumns.Items3409005

THTMLTableColumns	参照

Items プロパティは，THTMLTableColumns が TDSTableProducer オブジェクト用に格納および管理する THTMLTableColumn オブジェクトのインデックス付き配列です。

property Items[Index: Integer]: THTMLTableColumn; default;

説明

Items プロパティは，THTMLTableColumns が管理している個々の列記述子にアクセスできます。Items はインデックス付き配列で，最初の列記述子のインデックスが 0 ，2 番目の列記述子のインデックスが 1 といった具合になります。

Items は THTMLTableColumns のデフォルトのプロパティなので，アプリケーションは Items 配列の要素を参照するのに Items プロパティの名前を指定する必要はありません。たとえば，以下のように記述すると，TDSTableProducer オブジェクトは Columns プロパティ内の列記述子を繰り返し処理します。

for I := 0 to Columns.Count - 1 do

 begin

   CurFieldname := Columns[I].FieldName; { Columns.Items[I] のかわり}

   {CurFieldname に対する処理を行う}

 end


THTMLTableColumns.State
THTMLTableColumns.State3409006

THTMLTableColumns	参照

State プロパティは個々の列記述子が動的に生成されるのが静的に格納されるのかを示します。

THTMLColumnState = (csDefault, csCustom);

property State: THTMLColumnState;

説明

State を csDefault に設定すると，列記述子を動的に生成するよう指定できます。列記述子が動的に生成された場合，HTML テーブルの列には特別な表示属性は設定されず，列記述子とデータセットの項目は順序と数において正確に対応します。State を csDefault に設定すると，コレクション内のすべての列記述子は動的に生成されたデフォルト値に置き換えられます。

表示属性の追加，項目の再整列，計算項目の列の追加，項目サブセットのデータセットへの組み込みなどで列記述子をカスタマイズする場合，カスタマイズの前に State を csCustom に設定してください。State を csCustom に設定すると，列記述子は TDSTableProducer オブジェクトと一緒に保存されます。

注意

列エディタで列記述子をカスタマイズすると，State は 自動的に csCustom に設定されます。


THTMLTableColumns メソッド3409007

THTMLTableColumns	アルファベット順

THTMLTableColumns

Add

Create

RebuildColumns

RestoreDefaults

TCollection からの継承

Assign

BeginUpdate

Clear

Destroy

EndUpdate

FindItemID

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THTMLTableColumns メソッド3409008

THTMLTableColumns	オブジェクト順

Add

Assign

BeginUpdate

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

EndUpdate

FieldAddress

FindItemID

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RebuildColumns

RestoreDefaults

SafeCallException


THTMLTableColumns.Add
THTMLTableColumns.Add3409009

THTMLTableColumns	参照

Add メソッドは，Items 配列の末尾に新しい列記述子を追加します。

function  Add: THTMLTableColumn;

説明

Add を呼び出すと，TDSTableProducer が生成した HTML テーブルの列のコレクションに列記述子を追加できます。アプリケーションでは，State プロパティの値が csCustom の場合にのみ Add を呼び出してください。


THTMLTableColumns.Create
THTMLTableColumns.Create3409010

THTMLTableColumns	参照

Create メソッドは，THTMLTableColumns のインスタンスを作成します。

THTMLTableColumnClass = class of THTMLTableColumn;

constructor Create(DSTableProducer: TDSTableProducer;

   ColumnClass: THTMLTableColumnClass);

説明

THTMLTableColumns のコンストラクタは呼び出さないでください。TDSTableProducer は自身のコンストラクタから Create を呼び出します。DSTableProducer パラメータは，THTMLTableColumns オブジェクトを使って列記述子を管理する TDSTableProducer オブジェクトを指定します。ColumnClass パラメータは，Items 配列に設定される THTMLTableColumn オブジェクトのクラスを示します。


THTMLTableColumns.RebuildColumns
THTMLTableColumns.RebuildColumns3409011

THTMLTableColumns	参照

RebuildColumns メソッドは，Items 配列内のすべての列記述子を DSTableProducer のデータセットの項目と完全に一致する新しい列記述子に置き換えます。

procedure RebuildColumns;

説明

RebuildColumns を呼び出すと，列記述子のコレクションをデフォルトの状態に設定できます。デフォルトの状態では，列記述子とデータセット内の項目の順序と数が一致し，特別な表示属性は設定されていません。RebuildColumns は列記述子のコレクションを，State プロパティが cdDefault のときに動的に保持される状態に戻します。


THTMLTableColumns.RestoreDefaults
THTMLTableColumns.RestoreDefaults3409012

THTMLTableColumns	参照

RestoreDefaults メソッドは，すべての列記述子の表示属性をデフォルトに戻すメソッドとのインターフェースを提供します。

procedure RestoreDefaults;

説明

THTMLTableColumns の RestoreDefaults メソッドは何も処理を行いません。このメソッドは，RebuildColumns を呼び出した後で列記述子の表示属性をデフォルトの状態に戻すメソッドとのインターフェースを提供するために用意されています。


読み出し／書き込み3409013

読み出し専用


継承3409014

TObject

TPersistent

TCollection


THTMLTableColumns 例3409015

THTMLTableColumns


THTMLTagAttributes
THTMLTagAttributes3410001

継承	プロパティ	メソッド	イベント	参照

THTMLTagAttributes は HTML タグの属性を表すすべてのオブジェクトの基本クラスです。

ユニット

httpapp

説明

TCustomContentProducer の派生オブジェクトは THTMLTagAttributes オブジェクトを使って，生成した HTML コマンドの HTML タグに追加されたオプションをカプセル化します。TCustomContentProducer オブジェクトは HTML コマンドの作成時にタグ属性オブジェクトのプロパティからタグ属性を調べ，適切なタグオプションを生成します。


THTMLTagAttributes プロパティ3410002

THTMLTagAttributes	アルファベット順	凡例

THTMLTagAttributes

Custom

Producer


THTMLTagAttributes プロパティ3410003

THTMLTagAttributes	オブジェクト順	凡例

Custom

Producer


THTMLTagAttributes.Custom
THTMLTagAttributes.Custom3410004

THTMLTagAttributes	参照

Custom プロパティは，HTML タグのタグオプションとその値を表します。

property Custom: string;

説明

Custom プロパティは，HTML タグに追加する 1 つまたは複数のオプションを指定できます。各オプションと値は以下の形式で記述します。

OPTIONNAME=Value

Custom で指定するオプションはスペースで区切る必要があります。たとえば，HTML テーブルの 1 つのセルとその左と下に隣接している 3 つのセルを結合する場合，セルのテーブルデータタグに ROWSPAN オプションと COLSPAN オプションを設定します。これらのオプションを設定するには，Custom に以下のような文字列を指定します。

ROWSPAN=2 COLSPAN=2

HTML テーブル作成オブジェクトは Content の生成時に Custom 文字列を HTML タグに挿入しなくてはなりません。


THTMLTagAttributes.Producer
THTMLTagAttributes.Producer3410005

THTMLTagAttributes	参照

Producer プロパティは，TCustomContentProducer の下位のプロパティで，THTMLTagAttributes オブジェクトを使って，作成したコンテンツの HTML タグのオプションを表します。

property Producer: TCustomContentProducer;

説明

Producer プロパティは，THTMLTagAttributes オブジェクトを使っている HTML テーブル作成オブジェクトにアクセスできます。THTMLTagAttributes は OnChange イベントハンドラの Producer プロパティを使って，自身が指定する属性の変更を TCustomContentProducer に通知できます。


THTMLTagAttributes イベント3410006

THTMLTagAttributes	アルファベット順

THTMLTagAttributes

OnChange


THTMLTagAttributes イベント3410007

THTMLTagAttributes	オブジェクト順

OnChange


THTMLTagAttributes.OnChange
THTMLTagAttributes.OnChange3410008

THTMLTagAttributes	参照

OnChange イベントは，タグ属性のプロパティが変更された直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラを記述すると，タグ属性オブジェクトのプロパティが変更されたときに特定のアクションを実行できます。OnChange が発生したときには，タグ属性オブジェクトにすでに新しいプロパティが設定されています。OnChange イベントハンドラを使うと，HTML コンテンツ作成オブジェクトが作成中のコンテンツを更新する必要がある場合にタグ属性が変更されたことをコンテンツ作成オブジェクに通知できます。


THTMLTagAttributes メソッド3410009

THTMLTagAttributes	アルファベット順	凡例

THTMLTagAttributes

Changed

Create

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THTMLTagAttributes メソッド3410010

THTMLTagAttributes	オブジェクト順	凡例

Assign

Changed

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


THTMLTagAttributes.Changed
THTMLTagAttributes.Changed3410011

THTMLTagAttributes	参照

Changed メソッドは，割り当てられたときに OnChange イベントハンドラを呼び出します。

procedure Changed;

説明

Changed メソッドは，THTMLTagAttributes の派生オブジェクトが提供するタグオプションの変更後に，その派生オブジェクトから呼び出します。Changed は Protected メソッドとして定義されているため，コンポーネント開発者は THTMLTagAttributes の下位オブジェクトを作成して，OnChange イベントハンドラを正確に呼び出すことができます。


THTMLTagAttributes.Create
THTMLTagAttributes.Create3410012

THTMLTagAttributes	参照

Create メソッドは，THTMLTagAttributes のインスタンスを作成します。

constructor Create(Producer: TCustomHTMLProducer);

説明

Create メソッドを呼び出すと，実行時に THTMLTagAttributes のインスタンスを作成および初期化できます。継承されたコンストラクタを呼び出した後，Create は Producer プロパティを Producer パラメータの値に設定します。


スコープ3410014

published

読み出し／書き込み

読み出し専用


スコープ3410015

protected


継承3410016

TObject

TPersistent


THTMLTagAttributes 例3410017

THTMLTagAttributes


TTextAttributes
TTextAttributes3411001

継承	プロパティ	メソッド	参照

TTextAttributes オブジェクトは，書式付き編集コントロールのセクションのフォント属性を表すヘルパーオブジェクトです。

ユニット

comctrls

説明

TTextAttributes オブジェクトには，書式付き編集コントロールのテキストのフォント属性を表すたくさんのプロパティがあります。TTextAttributes オブジェクトの用途は，TCustomRichEdit の下位オブジェクトを作れるようにし，デフォルトのテキスト属性 (DefAttributes プロパティ) や，選択したテキストの属性 (SelAttributes プロパティ) を読み書きできるようにすることです。TTextAttributes オブジェクトの各プロパティは，TCustomRichEdit の下位オブジェクトがオーナーでない限り無効です。

TTextAttributes オブジェクトが表すフォント属性のほとんどは，TFont オブジェクトの同名のプロパティと同じです。テキストの属性にフォントを適用したり，テキストに適用されているフォントを取得したりできます。


TTextAttributes プロパティ3411002

TTextAttributes	アルファベット順	凡例

TTextAttributes

CharSet

Color

ConsistentAttributes

Height

Name

Pitch

Protected

Size

Style


TTextAttributes プロパティ3411003

TTextAttributes	オブジェクト順	凡例

CharSet

Color

ConsistentAttributes

Height

Name

Pitch

Protected

Size

Style


TTextAttributes.CharSet
TTextAttributes.CharSet3411004

TTextAttributes

CharSet プロパティは，フォントの文字セットを示します。

type TFontCharset = 0..255;

property Charset: TFontCharset;

説明

CharSet プロパティは，フォントの文字セットを示します。各フォントのタイプフェース（Name プロパティで示される）は，１つあるいは複数の文字セットをサポートします。有効な文字セット値については，ベンダーごとに提供されている情報を参照してください。標準の文字セット用に提供されている，定義済みの定数を次の表に示します。

定数	値	説明

ANSI_CHARSET	0	ANSI

DEFAULT_CHARSET	1	フォントは Name および Size に基づいて選択される。指定されているフォントがシステムで使用できない場合，Windows は代わりのフォントを割り当てる

SYMBOL_CHARSET	2	標準の記号セット

MAC_CHARSET	77	マッキントッシュ用文字セット
NT 3.51 では使用できない

SHIFTJIS_CHARSET	128	SHIFT-JIS 文字

HANGEUL_CHARSET	129	韓国語（Wansung）

JOHAB_CHARSET	130	韓国語（Johab）
NT 3.51 では使用できない

GB2312_CHARSET	134	簡体字中国語

CHINESEBIG5_CHARSET	136	伝統的中国語

GREEK_CHARSET	161	ギリシャ語
NT 3.51 では使用できない

TURKISH_CHARSET	162	トルコ語
NT 3.51 では使用できない

VIETNAMESE_CHARSET	163	ベトナム語
NT 3.51 では使用できない

HEBREW_CHARSET	177	ヘブライ語
NT 3.51 では使用できない

ARABIC_CHARSET	178	アラビア語
NT 3.51 では使用できない

BALTIC_CHARSET	186	バルト語
NT 3.51 では使用できない

RUSSIAN_CHARSET	204	キリール文字
NT 3.51 では使用できない

THAI_CHARSET	222	タイ語
NT 3.51 では使用できない

EASTEUROPE_CHARSET	238	東欧諸国用の区別的発音符を含む。
NT 3.51 では使用できない

OEM_CHARSET	255	オペレーティングシステムのコードページによって異なる


TTextAttributes.Color
TTextAttributes.Color3411005

TTextAttributes	参照

Color プロパティは，テキストの前面色を示します。

property Color: TColor;

説明

Color プロパティは，文字の実際の色を示すことができます。背景色は TTextAttributes オブジェクトを使う書式付き編集コントロールのプロパティであり，書式付き編集コントロールの Color プロパティを使って設定されなければなりません。

Color の値は以下のとおりです。

値	意味

clBlack	黒色

clMaroon	栗色

clGreen	緑色

clOlive	黄緑色

clNavy	濃紺色

clPurple	紫色

clTeal	暗青緑色

clGray	灰色

clSilver	銀色

clRed	赤色

clLime	濃緑色

clBlue	青色

clFuchsia	赤紫色

clAqua	空色

clWhite	白色

clBackground	Windows の背景の現在の色

clActiveCaption	アクティブウィンドウのタイトルバーの現在の色

clInactiveCaption	アクティブでないウィンドウのタイトルバーの現在の色

clMenu	メニューの現在の背景色

clWindow	ウィンドウの現在の背景色

clWindowFrame	ウィンドウ枠の現在の色

clMenuText	メニュー上のテキストの現在の色

clWindowText	ウィンドウ内のテキストの現在の色

clCaptionText	アクティブウィンドウのタイトルバー上のテキストの現在の色

clActiveBorder	アクティブウィンドウの現在の境界色

clInactiveBorder	アクティブでないウィンドウの現在の境界色

clAppWorkSpace	アプリケーション作業領域の現在の色

clHighlight	選択したテキストの現在の背景色

clHightlightText	選択したテキストの現在の色

clBtnFace	ボタン面の現在の色

clBtnShadow	ボタン面の影の現在の色

clGrayText	淡色表示されているテキストの現在の色

clBtnText	ボタンのテキストの現在の色

clInactiveCaptionText	アクティブでないウィンドウのタイトルバーのテキストの現在の色

clBtnHighlight	ボタンの強調表示の現在の色

cl3DDkShadow 	Windows 95 のみ。3 次元表示要素の暗い影

cl3DLight 	Windows 95 のみ。3 次元表示要素の明るい色 (明るい面の縁用)

clInfoText 	Windows 95 のみ。ツールチップコントロールのテキストの色

clInfoBk 	Windows 95 のみ。ツールチップコントロールの背景色

このカラーリストの後半は Windows システムの色です。どの色が表示されるかは Windows にどのカラー体系を使っているかで異なります。色はプログラムマネージャのコントロールパネルを使って変更できます。しかし，Color プロパティが ClWindowText に設定されていない限り，コントロールパネルで色を変更しても書式付き編集コントロールの色は更新されません。実際に表示される色はシステムによって異なります。たとえば，赤紫色はシステムによってはもっと青に近い色になります。


TTextAttributes.ConsistentAttributes
TTextAttributes.ConsistentAttributes3411006

TTextAttributes	参照

ConsistentAttributes プロパティは，TTexeAttributes オブジェクトのプロパティのうちで，書式付き編集コントロールで現在選択されているテキストを通じて統一されているものを示します。

property ConsistentAttributes: TConsistentAttributes;

説明

書式付きテキストオブジェクトの SelAttributes プロパティの ConsistentAttributes プロパティを読み出すと，現在の選択において TTextAttributes のどのプロパティが有効かが分かりますこの情報は，現在選択しているテキストの属性を読み出すときに有効です。TTextAttributes のプロパティを設定すると，そのプロパティは選択が変更されるまで一定です。

ConsistentAttributes の値は以下のとおりです。

値	意味

caBold	選択した範囲内で文字が太字かそうでないかのどちらかに統一されている

caColor	選択した範囲内で文字フォントの色が統一されていることを示す

caFace	選択した範囲内で文字のフォントが統一されていることを示す

caItalic	選択した範囲内で文字が斜体かそうでないかのどちらかに統一されている

caSize	選択した範囲内で文字のフォントサイズが統一されていることを示す

caStrikeout	選択した範囲内で文字が打ち消し線付きかそうでないかのどちらかに統一されている

caUnderline	選択した範囲内で文字が打ち消し線付きかそうでないかのどちらかに統一されている

caProtected	テキストが保護されているかそうでないかのどちらかに統一されている

注意

ConsistentAttributes プロパティは書式付き編集コントロールの SelAttributes プロパティとともに使います。書式付き編集コントロールの DefAttributes プロパティの ConsistentAttributes プロパティは空で，これはデフォルト属性をもつテキストのセクションですべての属性が統一されている場合でも当てはまります。.


TTextAttributes.Height
TTextAttributes.Height3411007

TTextAttributes	参照

Height プロパティは，フォントの高さをピクセルで表します。

property Height: Integer;

説明

フォントの高さをピクセル単位で指定するには，Height プロパティを使います。フォントのサイズをポイント単位で指定するには，Size プロパティを使います。アプリケーションでは通常はポイント単位でフォントサイズを表しますが，プログラムではフォントのサイズをピクセル単位で扱い，画面に表示するのが普通です。

Height プロパティの値と Size プロパティの値の関係は，次の式で示されます。

Height = Size * ScreenPixelsPerInch/72

注意

TFont オブジェクトの Height プロパティとは異なり，TTextAttributes オブジェクトの Height プロパティはフォントの上部に表示される内部レディングを含みます。


TTextAttributes.Name
TTextAttributes.Name3411008

TTextAttributes	参照

Name プロパティは，TTextAttributes オブジェクトによって記述されるフォントのタイプフェースを指定します。

TFontName = string[LF_FACESIZE - 1];

property Name: TFontName;

説明

Name プロパティは，フォントのタイプフェースを指定します。タイプフェースは，Windows でフォントを特定するために使用される最長 32 文字の文字列です。Name プロパティはほとんどのフォント選択コントロールが表示するフォントに使う識別子です。


TTextAttributes.Pitch
TTextAttributes.Pitch3411009

TTextAttributes	参照

Pitch プロパティは，フォントの文字がすべて同じ幅であるかどうかを指定します。

TFontPitch = (fpDefault, fpVariable, fpFixed);

property Pitch: TFontPitch;

説明

タイプフェースにはそれぞれ文字幅が決められています。固定ピッチのフォントでは文字幅がすべて同じになります。可変ピッチのフォントでは，文字によって幅が異なります。固定ピッチのフォントは一般にソースコードに用いられます。インデントが正しくそろうからです。可変ピッチのフォントは，より読みやすさが求められるテキスト一般に用いられます。

Pitch プロパティの値は以下のとおりです。

値	意味

fpDefault	フォントピッチはデフォルト値に設定される。デフォルト値は Name プロパティに指定したフォントによって異なる

fpFixed	フォントピッチは固定ピッチに設定される。フォント内のすべての文字は同じ幅になる

fpVariable	フォントピッチは可変ピッチに設定される。フォント内の文字は幅が異なる

固定幅フォントの Pitch を fpVariable に，可変幅フォントを fpFixed に設定すると，Window によって別のフォントで代用される場合があります。このとき，フォントの外観に何も効果がないか，Windows によって適切なピッチの別のフォントに置き換えられます。可変ピッチのフォントである MS Serif のピッチを fpFixed にすると，代わりに Courier フォントが表示されるといったことです。


TTextAttributes.Protected
TTextAttributes.Protected3411010

TTextAttributes	参照

Protected プロパティは，TTextAttributes オブジェクトの表すテキストが保護されているかどうかを示します。

property Protected: Boolean;

説明

保護されたテキストをユーザーが変更することはできません。保護されたテキストを含んだ選択範囲の編集をユーザーが試みると，書式付き編集コントロールは OnProtectChange イベントハンドラを呼び出します。OnProtectChange イベントハンドラは，保護されたテキストの編集を許可したり禁止したりできます。OnProtectChange イベントハンドラがない場合，保護されたテキストは読み出し専用になります。


TTextAttributes.Size
TTextAttributes.Size3411011

TTextAttributes	参照

Size プロパティは，フォントの高さをポイント単位で示します。

property Size: Integer;

説明

フォントの高さをポイント単位で指定するには，Size プロパティを使います。フォントのサイズをピクセル単位で指定するには，Height プロパティを使います。アプリケーションでは通常はポイント単位でフォントサイズを表しますが，プログラムではフォントのサイズをピクセル単位で扱い，画面に表示するのが普通です。

Height プロパティの値と Size プロパティの値の関係は，次の式で示されます。

Size = Height * 72 / ScreenPixelsPerInch

注意

TFont オブジェクトの Size プロパティとは異なり，TTextAttributes オブジェクトの Size プロパティはフォントの上部に表示される内部レディングを省きます。


TTextAttributes.Style
TTextAttributes.Style3411012

TTextAttributes	参照

Style プロパティは，フォントの通常書体，斜体，下線付き，太字，または打ち消し線付きといったスタイルを決めます。

property Style: TFontStyles;

説明

Style プロパティの値は以下のとおりです。

値	意味

fsBold	フォントは太字になる

fsItalic	フォントは斜体になる

fsUnderline	フォントは下線付きになる

fsStrikeout	フォントは打ち消し線付きになる

Style プロパティは集合なので複数の値を設定できます。たとえば，フォントを太字の斜体にしたりできます。


TTextAttributes メソッド3411013

TTextAttributes	アルファベット順	凡例

TTextAttributes

Assign

AssignTo

Create

InitFormat

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TTextAttributes メソッド3411014

TTextAttributes	オブジェクト順	凡例

Assign

AssignTo

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitFormat

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TTextAttributes.Assign
TTextAttributes.Assign3411015

TTextAttributes	参照

Assign メソッドは，TTextAttributes オブジェクトのプロパティを他の TTextAttributes オブジェクトまたは TFont オブジェクトで指定されたプロパティと一致させます。

procedure Assign(Source: TPersistent); override;

説明

Assign メソッドを呼び出すと，テキストのすべての属性を一度に変更できます。Assign メソッドは，選択したテキストのフォント属性をデフォルトフォント属性と一致させたり，選択したテキストのフォント属性を取得したりできます。Source が TTextAttributes オブジェクトの場合，Assign メソッドは Color，Name，Style，および Pitch プロパティのみを一致させます。Source が TFont オブジェクトの場合は，Assign メソッドによって Size プロパティも統一されます。

注意

Assign メソッドは実行時に Source が TTextAttiributes オブジェクト，TFont オブジェクト，あるいは TTextAttributes オブジェクトを扱える AssignTo メソッドを実現しているオブジェクトである場合にのみ正しく実行されます。他のソースオブジェクトでは EConvertError 例外が生成されます。


TTextAttributes.AssignTo
TTextAttributes.AssignTo3411016

TTextAttributes	参照

AssignTo メソッドは，TTextAttributes オブジェクトのプロパティを TFont オブジェクトに適用できるようにします。

procedure AssignTo(Dest: TPersistent); override;

説明

TTextAttributes オブジェクトは，継承された AssignTo メソッドをオーバーライドしてフォントプロパティを TFont オブジェクトに適用できるようにします。アプリケーションは AssignTo メソッドを呼び出してはいけません。AssignTo メソッドの呼び出しは，TFont オブジェクトの Assign メソッドが呼び出されたときに実行されます。AssignTo メソッドは Color，Name，Style，Size，および Pitch プロパティを TFont オブジェクトにコピーします。


TTextAttributes.Create
TTextAttributes.Create3411017

TTextAttributes	参照

Create メソッドは TTextAttributes のインスタンスを作成します。

constructor Create(AOwner: TCustomRichEdit; AttributeType: TAttributeType);

説明

TTextAttributes のコンストラクタは呼び出さないでください。Create メソッドは，書式付き編集コントロールのコンストラクタから呼び出されます。書式付き編集コントロールは atDefaultText の属性型を使って DefAttributes プロパティを実現し，atSelected の属性型を使って SelAttributes プロパティを実現します。


TTextAttributes.InitFormat
TTextAttributes.InitFormat3411018

TTextAttributes	参照

InitFormat メソッドは，TCharFormat レコードを初期化します。

procedure InitFormat(var Format: TCharFormat);

説明

TTextAttributes オブジェクトは TCharFormat 構造体を使って書式付き編集コントロールと通信し，コントロールのプロパティを取得および設定します。InitFormat メソッドは，特定のプロパティが読み出されたり設定されたりする前に構造体を初期化します。InitFormat メソッドはプロテクトメソッドとしてエクスポーズされているので，派生クラスは TCharFormat レコードを使って任意のテキストプロパティを実現することができます。


読み出し／書き込み3411019

読み出し専用


スコープ3411020

protected


継承3411021

TObject

TPersistent


TTextAttributes 例3411022

TTextAttributes


TThreadList
TThreadList3412001

継承	メソッド	参照

TThreadList はスレッドセーフリストを表します。

ユニット

classes

説明

TThreadList オブジェクトは，スレッドセーフリストです。各 TThreadList はプライベートな TList（オブジェクトへのポインタのリスト）を保持しています。ユーザーは，明示的にロックをかけることなく，複数のスレッドから TThreadList 内の項目を追加したり削除したりできます。

リストの Count プロパティにアクセスするには，TList を返す LockList を呼び出してロックをかけてから，リストのロックを解除するために Unlock を呼び出します。以下に例を示します。

with MyThreadList.LockList do

try

for X := 0 to Count-1 do

Something(Items[X]);

finally

MyThreadList.UnlockList;

end;


TThreadList のメソッド3412002

TThreadList	アルファベット順

TThreadList

Add

Clear

Create

Destroy

LockList

Remove

UnlockList

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TThreadList のメソッド3412003

TThreadList	オブジェクト順

Add

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

LockList

MethodAddress

MethodName

NewInstance

Remove

SafeCallException

UnlockList


TThreadList.Add
TThreadList.Add3412004

TThreadList

Add メソッドは，リストに項目を 1 つ追加します。

procedure Add(Item: Pointer);

説明

Add メソッドを呼び出すと，スレッドセーフリストの最後に新しいオブジェクトを 1 つ挿入することができます。


TThreadList.Clear
TThreadList.Clear3412005

TThreadList	参照

Crear メソッドは，リストからすべての項目を削除します。

procedure Clear;

説明

Clear メソッドは，リストにロックをかけて TList の Clear メソッドを呼び出し，次にロックを解除します。


TThreadList.Create
TThreadList.Create3412006

TThreadList

Create メソッドは，TThreadList のインスタンスを作成し，初期化します。

constructor Create;

説明

Create メソッドは TThreadList オブジェクトを作成します。


TThreadList.Destroy
TThreadList.Destroy3412007

TThreadList	参照

Destroy メソッドは，TThreadList を破棄し，そのメモリを解放します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy を呼び出さないでください。かわりに Free を呼び出します。Free はオブジェクトが解放されていないことを確認してからのみ Destroy を呼び出します。


TThreadList.LockList
TThreadList.LockList3412008

TThreadList	参照

LockList メソッドは，スレッドセーフリストにロックをかけ，TList オブジェクトを返します。

function LockList: TList;

説明

LockList メソッドは，Windows の EnterCriticalSection 関数を呼び出して，スレッドセーフリストにロックをかけます。次に，リストを含む TList オブジェクトを返します。


TThreadList.Remove
TThreadList.Remove3412009

TThreadList	参照

Remove メソッドは，リストから項目を 1 つ削除します。

procedure Remove(Item: Pointer);

説明

Remove メソッドを呼び出すと，インデックスを指定しなくてもリストから特定の項目を削除することができます。Remove はリストにロックをかけてから，TList の Remove メソッドを呼び出し，次にリストのロックを解除します。


TThreadList.UnlockList
TThreadList.UnlockList3412010

TThreadList	参照

UnlockList メソッドは，スレッドセーフリストのロックを解除します。

procedure UnlockList;

説明

UnlockList メソッドは，Windows の LeaveCriticalSection 関数を呼び出します。LockList のあとに UnLockList を使うと，リストを再ロックすることができます。


継承3412011

TObject


TThreadList の例3412012

TThreadList


TThread
TThread3413001

継承	プロパティ	メソッド	イベント	参照

TThread オブジェクトは，アプリケーションで複数の実行スレッドを作成できる抽象クラスです。

ユニット

classes

説明

サブクラス化された TThread オブジェクトの新しいインスタンスそれぞれが新しい実行スレッドです。TThread オブジェクトの派生クラスが複数インスタンス化されることによって，Delphi アプリケーションはマルチスレッドになります。アプリケーション内で複数のスレッドを使うには，TThread オブジェクトから新しいクラスを派生させ，そのメソッドをオーバーライドします。

実行中のアプリケーションは，メモリにロードされて実行可能な状態になっています。この時点でアプリケーションは，データ，コードなどのシステムリソースを持つ 1 つまたは複数のスレッドから構成されるプロセスになります。スレッドはアプリケーション処理の一部を実行し，オペレーティングシステムから CPU 時間の割り当てを受けます。処理に関係するすべてのスレッドは同じアドレス空間を共有し，プロセスのグローバル変数にアクセスすることができます。

スレッドを使うと以下のようにアプリケーションの処理性能を向上させることができます。

・	複数の通信装置からの入力の処理

・	優先順位の異なる処理の区別。優先度の高いスレッドはタイムクリティカルな処理を扱い，優先度の低いスレッドはその他の処理を行う

スレッドを使うときの問題およびその回避策は以下のとおりです。

・	スレッドの数が多すぎると CPU 時間を浪費する。シングルプロセッサシステムで 1 プロセスあたり最大 16 スレッドを推奨

・	複数のスレッドが同じリソースを更新する場合は，スレッドの同期を保ち衝突を回避する

・	VCL コンポーネントあるいはフォームにアクセスするメソッドの呼び出しはメイン VCL スレッド内からのみ可能

新しいスレッドオブジェクトを作る方法は次のとおりです。

・	［ファイル(F)｜新規作成(N)｜スレッドオブジェクト］を選択して，TThread クラスから派生したオブジェクトを含む新しいユニットを作成

・	新しいスレッドオブジェクトの Create メソッドを定義

・	スレッドが実行されるときに実行するコードを挿入して，スレッドオブジェクトの Execute メソッドを定義

・	VCL コンポーネントを使う呼び出しを Synchronize メソッドに渡してメイン VCL スレッドに呼び出しを実行させ，マルチスレッドの衝突を回避する

サンプルについては，DELPHI\DEMOS\THREADS ディレクトリを参照してください。


TThread プロパティ3413002

TThread	アルファベット順	凡例

TThread

FreeOnTerminate

Handle

Priority

ReturnValue

Suspended

Terminated

ThreadID


TThread プロパティ3413003

TThread	オブジェクト順	凡例

FreeOnTerminate

Handle

Priority

ReturnValue

Suspended

Terminated

ThreadID


TThread.FreeOnTerminate
TThread.FreeOnTerminate3413004

TThread	参照

FreeOnTerminate プロパティは，スレッドの終了時にスレッドオブジェクトを自動的に破棄するかどうかを決めます。

property FreeOnTerminate: Boolean;

説明

FreeOnTerminate プロパティは，デフォルトでは False で，これはスレッドオブジェクトがアプリケーションコードによって明示的に破棄されなければならないことを示します。


TThread.Handle
TThread.Handle3413005

TThread	参照

Handle プロパティは，スレッドのハンドルを含みます。

property Handle: THandle;

説明

Handle プロパティは，スレッド操作に使う Win32 API 関数を呼び出すときに使います。


TThread.Priority
TThread.Priority3413006

TThread	参照

Priority プロパティは，スレッドのスケジュール優先度をプロセス中のほかのスレッドに対して相対的に決定します。

type

  TThreadPriority = (tpIdle, tpLowest, tpLower, tpNormal, tpHigher, tpHighest,
  tpTimeCritical);

property Priority: TThreadPriority;

説明

Priority プロパティは列挙型でデフォルトは tpNormal です。必要に応じて優先度を高くしたり低くしたりできます。

TThreadPriority 型は，以下の表に示すように，TThread コンポーネントの Priority プロパティに可能な値を定義します。Windows は優先度に応じて各スレッドに CPU サイクルを割り当てます。Priority プロパティはスレッドの優先度を表に示す単位で高くしたり低くしたりします。

値	意味

tpIdle	スレッドが実行されるのは，システムがアイドルのときのみ。他のスレッドが動作しているときには tpIdle のスレッドは実行されない

tpLowest	スレッドの優先度は通常よりも 2 ポイント低い

tpLower	スレッドの優先度は通常よりも 1 ポイント低い

tpNormal	スレッドは通常の優先度である

tpHigher	スレッドの優先度は通常よりも 1 ポイント高い

tpHighest	スレッドの優先度は通常よりも 2 ポイント高い

tpTimeCritical	スレッドはもっとも高い優先度を取得する

警告

CPU に負担をかける処理のスレッド優先度を高くすると，アプリケーションのほかのスレッドへの CPU 時間割り当てが不足してしまいます。優先度を上げるのは，ほとんどの時間を外部イベント待ちの状態で過ごすスレッドのみにしてください。


TThread.ReturnValue
TThread.ReturnValue3413007

TThread	参照

ReturnValue プロパティは，関数の Result 変数に相当します。

property ReturnValue: Integer;

説明

ReturnValue プロパティは，スレッドの成功/失敗，または数値的な結果/出力をアプリケーションやほかのスレッドに示すことができます。WaitFor メソッドは RetunValue プロパティに格納されている値を返します。


TThread.Suspended
TThread.Suspended3413008

TThread	参照

Suspended プロパティは，スレッドの実行が一時停止されているかどうかを示します。

property Suspended: Boolean;

説明

一時停止されたスレッドは，再開されるまで実行を続行しません。Suspended を True に設定するとスレッドを一時停止できます。False に設定するとスレッドの実行が再開します。


TThread.Terminated
TThread.Terminated3413009

TThread	参照

Terminated プロパティは，スレッドに終了の要求が出されているかどうかを示します。Terminate メソッドは Terminated プロパティを True に設定します。

property Terminated: Boolean;

説明

スレッドの Execute メソッドおよび Execute メソッドが呼び出すすべてのメソッドは，定期的に Terminated プロパティを調べて，True の場合は終了しなければなりません。

Terminate メソッドはスレッドの実行を中止する丁寧な方法ですが，スレッドの Execute コードの協力が必要です。Win32 API 関数 TerminateThread を呼び出すのではなく，この方法でスレッドを終了することを推奨します。


TThread.ThreadID
TThread.ThreadID3413010

TThread	参照

ThreadID プロパティは，システムでスレッドを一意に特定するスレッド識別子です。ThreadID プロパティは，Handle プロパティで示されるスレッドのハンドルとも異なります。

property ThreadID: THandle;

説明

ThreadID プロパティは，スレッド操作のために Win32 API 関数を呼び出す場合に便利です。


TThread イベント3413011

TThread	アルファベット順

TThread

OnTerminate


TThread イベント3413012

TThread	オブジェクト順

OnTerminate


TThread.OnTerminate
TThread.OnTerminate3413013

TThread	参照

OnTerminate イベントは，スレッドの Execute メソッドがリターンした後で，スレッドが破棄される前に呼び出されます。

TNotifyEvent = procedure (Sender: TObject) of object;

property OnTerminate: TNotifyEvent;

説明

OnTerminate イベントハンドラは，メイン VCL スレッドのコンテキスト内で呼び出され，VCL メソッドおよびプロパティを自由に呼び出せるようにします。スレッドオブジェクトもまたイベントハンドラ内で解放されます。

TNotifyEvent 型は，パラメータなしイベントが使う型です。こうしたイベントは，特定のイベントが発生したコンポーネントを通知するだけです（この場合は OnTerminate イベント）。


TThread メソッド3413014

TThread	アルファベット順	凡例

TThread

Create

Destroy

DoTerminate

Execute

Resume

Suspend

Synchronize

Terminate

WaitFor

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TThread メソッド3413015

TThread	オブジェクト順	凡例

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

DoTerminate

Execute

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Resume

Suspend

Synchronize

Terminate

WaitFor


TThread.Create
TThread.Create3413016

TThread	参照

Create メソッドは，スレッドオブジェクトのインスタンスを作成します。

constructor Create(CreateSuspended: Boolean);

説明

CreateSuspended が False の場合，Execute メソッドがすぐに呼び出されます。CreateSuspended が True の場合，Execute メソッドは Resume が呼び出された後では呼び出されません。


TThread.Destroy
TThread.Destroy3413017

TThread	参照

Destroy メソッドは，スレッドオブジェクトを破棄して，割り当てていたメモリを解放します。

destructor Destroy; override;

説明

Destroy メソッドはスレッドに終了を通知し，スレッドがリターンするのを待ってから継承 Destroy メソッドを呼び出します。


TThread.DoTerminate
TThread.DoTerminate3413018

TThread	参照

DoTerminate メソッドは，スレッドの OnTerminate イベントハンドラが割り当てられていればそれを呼び出します。

procedure DoTerminate; virtual;

説明

DoTerminate メソッドは OnTerminate イベントハンドラを呼び出しますが，スレッドを終了させることはありません。


TThread.Execute
TThread.Execute3413019

TThread	参照

Execute メソッドは，オーバーライドしなければならない抽象メソッドです。スレッドが始まるときに実行されるコードを含みます。

procedure Execute; virtual; abstract;

説明

スレッドは，CreateSuspended が False である Create メソッドが呼び出されたときと，CreateSuspended が True である Create が呼び出された直後に Resume が呼び出されたときに始まります。このメソッドをオーバーライドして，スレッドが始まるときに実行させたいコードを挿入します。Execute メソッドは Terminated プロパティの値をモニターして，スレッドを終了する必要がある時点を調べなければなりません。


TThread.Resume
TThread.Resume3413020

TThread	参照

Resume メソッドは，一時中止されていたメソッドの実行を再開します。

procedure Resume;

説明

Resume メソッドの呼び出しはネストできますが，実際にスレッドを再開するには，Suspend メソッドを呼び出した数だけ Resume メソッドを呼び出さなければなりません。


TThread.Suspend
TThread.Suspend3413021

TThread	参照

Suspend メソッドは，実行中のスレッドを一時中止します。

procedure Suspend;

説明

実行を再開するには Resume メソッドを呼び出します。Suspend メソッドの呼び出しはネストできますが，実際にスレッドを再開するには，Suspend メソッドを呼び出した数だけ Resume メソッドを呼び出さなければなりません。


TThread.Synchronize
TThread.Synchronize3413022

TThread	参照

Synchonize メソッドは，Method をメイン VCL スレッド内で実行します。

TThreadMethod = procedure of object;

procedure Synchronize(Method: TThreadMethod);

説明

Synchronize メソッドは，Method に指定された呼び出しをメイン VCL スレッドで実行するようにして，マルチスレッドの衝突を回避します。VCL コンポーネントにアクセスする任意のメソッドを呼び出し，Synchronize メソッドに渡すことによってメイン VCL スレッド内からのみフォームを更新します。

注意

Method がメイン VCL スレッドで実行中は，スレッドの実行が一時中止されます。


TThread.Terminate
TThread.Terminate3413023

TThread	参照

Terminate メソッドは，Terminated プロパティを True に設定してスレッドに終了を通知します。

procedure Terminate;

説明

スレッドの Execute メソッドおよび Execute メソッドが呼び出す任意のメソッドは，Terminated プロパティを常にモニターしてその値が True になったら終了しなければなりません。


TThread.WaitFor
TThread.WaitFor3413024

TThread	参照

WaitFor メソッドは，スレッドが終了するのを待機して ReturnValue プロパティの値を返します。

function WaitFor: Integer;

説明

WaitFor メソッドはスレッドが終了するまではリターンしないので，スレッドを終了するには Execute メソッドを終了させるか，Terminated プロパティが True のときに終了しなければなりません。スレッドが Synchronize を使っている場合は，メイン VCL スレッドのコンテキストで WaitFor メソッドを呼び出さないでください。呼び出した場合，デッドロックが引き起こされたり（アプリケーションがハング状態になったように見えます）EThread 例外が生成されたりします。

Synchronize メソッドは，同期をとろうとするメソッドの実行を許可する前に，メイン VCL スレッドがメッセージループに入るのを待機します。メイン VCL スレッドが WaitFor メソッドを呼び出してしまうと，メイン VCL スレッドはメッセージループに入らず，Synchronize メソッドは決してリターンしません。TThread はこうした状況を検出して，そのスレッドに EThread 例外を生成してスレッドを終了させ，Execute メソッドで処理できなかった場合は，アプリケーションも終了します。WaitFor メソッドが呼び出されたときに Synchronize メソッドがすでにメインスレッドで待機中の場合は，TThread は介入できず，アプリケーションはデッドロックになります。


スコープ3413025

protected

読み出し／書き込み

読み出し専用


スコープ3413026

protected


継承3413027

TObject


TThread 例3413028

TThread


TTimeField
TTimeField3414001

継承	プロパティ	メソッド	イベント	参照

TTimeField オブジェクトは，データセット中のデータ項目を表します。

ユニット

db

説明

時刻項目には，時刻を示す値が入ります。

TTimeField は新しいプロパティ，イベント，メソッドを提供しません。TTimeField は DataSize プロパティ と Create メソッドをオーバーライドして ftTime 型項目の特性を反映させます。

TDateTimeField の下位オブジェクトである TTimeField は，データベースの一時項目の値およびプロパティを管理するのに便利な，数多くのプロパティ，メソッド，およびイベントを備えています。


TTimeField プロパティ3414002

TTimeField	アルファベット順	凡例

TTimeField

DataSize

TDateTimeField からの継承

AsDateTime

AsFloat

AsString

AsVariant

DisplayFormat

Value

TField からの継承

Alignment

AsBoolean

AsCurrency

AsInteger

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraint

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TTimeField プロパティ3414003

TTimeField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayFormat

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraint

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TTimeField.DataSize
TTimeField.DataSize3414004

TTimeField	参照

DataSize プロパティは，ネイティブなデータベース形式で時刻項目の値を格納するのに必要なメモリの大きさです。

property DataSize: Word;

説明

DataSize プロパティは，時刻項目コンポーネントの値を格納するのに何バイト必要かを取得できます。GetData や SetData メソッドと共にこのプロパティを使うと，必要なバッファの大きさを決めることができます。

時刻項目の DataSize は常に 4 です。これはデータベーステーブルの時刻値の大きさで，TTimeField が時刻値を格納したり操作したりするのに使う TDateTime データ型の大きさではありません。


TTimeField イベント3414005

TTimeField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TTimeField イベント3414006

TTimeField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TTimeField メソッド3414007

TTimeField	アルファベット順

TTimeField

Create

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

TPersistense からの継承

GetNamePath


TTimeField メソッド3414008

TTimeField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TTimeField.Create
TTimeField.Create3414009

TTimeField	参照

Create メソッドは，TTimeField のインスタンスを作成して初期化します。

constructor Create(AOwner: TComponent); override;

説明

ほとんどの場合，Create を直接呼び出す必要はありません。なぜなら，時刻項目オブジェクトは，データセット中のすべての時刻項目において，自動的にインスタンス化されるからです。

継承したコンストラクタを呼び出した後で，Create は DataType プロパティを ftTime に設定します。


スコープ3414010

published

読み出し／書き込み

読み出し専用


スコープ3414011

published


継承3414012

TObject

TPersistent

TComponent

TField

TDateTimeField


TTimeField 例3414013

TTimeField


TTimer
TTimer3415001

継承	プロパティ	メソッド	イベント

TTimer は，Windows API のタイマー関数をカプセル化するオブジェクトです。

ユニット

extctrls

説明

TTimer は，Windows API のタイマー関数 SetTimer および KillTimer の呼び出しを簡略化したり，WM_TIMER メッセージの処理を簡略化したりするのに使うコンポーネントです。アプリケーションの各タイマーに対して 1 個のタイマーコンポーネントを使ってください。

タイマーのプロパティは，タイマーの動作に影響する情報を提供します。この情報にはタイマーの時間間隔が含まれ，これは Windows API の SetTimer 関数のパラメータに対応します。実際には，タイマーは OnTimer イベントで実行されます。

警告

システム全体で許されるタイマー数の上限は，システムによって異なります。


TTimer プロパティ3415002

TTimer	アルファベット順	凡例

TTimer

Enabled

Interval

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TTimer プロパティ3415003

TTimer	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Enabled

Interval

Name

Owner

Tag

VCLComObject


TTimer.Enabled
TTimer.Enabled3415004

TTimer	参照

Enabled プロパティは，タイマーがタイマーイベントに応答するかどうかを制御します。

property Enabled: Boolean;

説明

Enabled プロパティは，タイマーを使用可能または使用不可にするために使われます。Enabled が True ならばタイマーは正常に応答します。Enabled が False ならばタイマーは OnTimer イベントを発生しません。デフォルト設定は True です。


TTimer.Interval
TTimer.Interval3415005

TTimer	参照

Interval プロパティは，タイマーコンポーネントが別の OnTimer イベントを開始するまでの時間をミリ秒単位で指定します。

property Interval: Cardinal;

説明

Interval プロパティは，OnTimer イベントの発生頻度を示します。指定した時間間隔が経過するたびに OnTimer イベントが発生します。

Interval を使うと，任意の基数値を OnTimer イベントが発生する間隔として指定できます。デフォルト値は 1000 （1秒）です。

注意

Windows のタイマーの特性により，厳密に指定した間隔にはならないことがあります。0 は有効な値ですが，0 を指定したときにはタイマーは OnTimer イベントを呼び出しません。


TTimer イベント3415006

TTimer	アルファベット順	凡例

TTimer

OnTimer


TTimer イベント3415007

TTimer	オブジェクト順	凡例

OnTimer


TTimer.OnTimer
TTimer.OnTimer3415008

TTimer	参照

OnTimer イベントは，Interval プロパティで指定した時間が経過すると発生します。

property OnTimer: TNotifyEvent;

説明

OnTimer プロパティは，一定間隔で実行されるイベントハンドラを記述するために使われます。

タイマーの Interval プロパティは OnTimerイベントの発生頻度を指定します。指定した時間間隔が経過するたびに OnTimer イベントが発生します。

例

次のコードを OnTimer イベントハンドラ内に記述すると，ボールとして指定した形状コンポーネント（TShape）がゆっくりとフォームを横切ります。

procedure TForm1.Timer1Timer(Sender: TObject);

begin

  Timer1.Interval := 100;

  Shape1.Shape := stCircle;

  Shape1.Left := Shape1.Left + 1;

end;


TTimer メソッド3415009

TTimer	アルファベット順

TTimer

Create

Destroy

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TTimer メソッド3415010

TTimer	オブジェクト順

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TTimer.Create
TTimer.Create3415011

TTimer	参照

Create メソッドは，タイマーオブジェクトをインスタンス化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時にタイマーをインスタンス化できます。設計時にタイマーを作成した場合には，Create は自動的に呼び出されます。

Create はタイマーにメモリを割り当てて，継承された Create メソッドを呼び出します。その後，以下の処理を行います。

・	Enabled プロパティを True に初期化する

・	Interval プロパティを 1000 に初期化する

・	タイマーのウィンドウハンドルを割り当てて，WM TIMER メッセージを処理するタイマーウィンドウ手続きにこのハンドルを渡します。


TTimer.Destroy
TTimer.Destroy3415012

TTimer	参照

Destroy メソッドは，タイマーオブジェクトを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはリストボックスオブジェクトが解放されていないことを確認してから Destroy メソッドを呼び出します。

Destroy メソッドは Enabled を False に設定することでタイマーを非アクティブ化します。次に Windows API の KillTimer 関数を呼び出してタイマーを終了し，タイマーウィンドウハンドルの割り当てを解除してから継承された Destroy を呼び出します。


スコープ3415013

published

読み出し／書き込み

読み出し専用


スコープ3415014

published


継承3415015

TObject

TPersistent

TComponent


TTimer 例3415016

TTimer


TToolBar
TToolBar3416001

継承	プロパティ	メソッド	イベント	参照

TToolBar はツールボタンとその他のコントロールを数行内に収めてそのサイズと配置を自動調整します。

ユニット

comctrls

説明

TToolBar はツールボタン（TToolButton）のコンテナです。これは以下のように，ビジュアルコントロールを整理および管理するための簡単な方法を提供します。

・	ツールバー上のツールボタンはすべて同じ高さと幅に統一される

・	ほかのコントロールもツールバーに収容可能である。このようなコントロール（これは非表示のツールボタンで位置が固定される）は統一された高さに維持される

・	コントロールを水平のツールバーに収容しきれないときは，自動的にツールバーの改行が行われる

・	Flat プロパティは，ツールバー越しに背景を透過的に見えるようにし，ツールボタンにポップアップ境界の機能を与える

・	セパレータとデバイダ（実際は特殊設定されたツールボタン）は，ツールバー上のコントロールをビジュアル面と機能面の両方からグループ分けできる

一般に，ツールボタンはアプリケーションのメニュー項目に対応しており，アプリケーションコマンドへのより直接的なアクセスをユーザーに提供します。


TToolBar プロパティ3416002

TToolBar	アルファベット順	凡例

TToolBar

AutoSize

ButtonCount

ButtonHeight

Buttons

ButtonWidth

DisabledImages

Flat

HotImages

Images

Indent

List

RowCount

ShowCaptions

Wrapable

TToolWindow からの継承

BorderWidth

EdgeBorders

EdgeInner

EdgeOuter

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TToolBar プロパティ3416003

TToolBar	オブジェクト順	凡例

Align

AutoSize

BorderWidth

BoundsRect

Brush

ButtonCount

ButtonHeight

Buttons

ButtonWidth

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DisabledImages

DragCursor

DragMode

EdgeBorders

EdgeInner

EdgeOuter

Enabled

Flat

Font

Handle

Height

HelpContext

Hint

HotImages

Images

Indent

Left

List

Name

Owner

Parent

ParentColor

ParentFont

ParentShowHint

ParentWindow

PopupMenu

RowCount

ShowCaptions

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc

Wrapable


TToolBar.AutoSize
TToolBar.AutoSize3416004

TToolBar	参照

AutoSize プロパティは，ツールバーの高さを各コントロールを収容できるように変更します。

property AutoSize: Boolean;

説明

AutoSize プロパティを True に設定すると，ツールバーの高さが自動調整されてコントロールの縦の余白がない状態で収容できるようになります。


TToolBar.ButtonCount
TToolBar.ButtonCount3416005

TToolBar	参照

ButtonCount プロパティは，ツールバーのボタン数です。

property ButtonCount: Integer;

説明

ButtonCount プロパティは，Buttons 配列のボタン数を返します。


TToolBar.ButtonHeight
TToolBar.ButtonHeight3416006

TToolBar	参照

ButtonHeight プロパティは，ツールバー内のコントロールの高さです。

property ButtonHeight: Integer default 22;

説明

ButtonHeight プロパティは，ツールバー内のコントロールの高さをピクセル単位で表します。


TToolBar.Buttons
TToolBar.Buttons3416007

TToolBar	参照

Buttons プロパティは，ツールバーのツールボタン（TToolButton）のリストです。

property Buttons[Index: Integer]: TToolButton;

説明

Buttons プロパティは，TToolButton インスタンスのリストを管理します。TToolBar の親を共有するすべてのツールボタンは同じ高さと（セパレータとデバイダを除いて）同じ幅を持ちます。ツールバーのほかのコントロールは，非表示のセパレータで定位置に固定されます。このセパレータは自動的に作成，破棄されます。

ツールボタンを設計時にツールバーに追加するには，ツールバーを選択して右クリックし［ボタン新規作成(U)］ボタンを選択します。あるボタンと次のボタンの間にスペース（セパレータ）を作成するには，［セパレータ新規作成(P)］を選択します。ボタン間にデバイダを作成するには，ボタンを追加してその Style プロパティを tbsDivider に設定します。ほかのコントロールは，コンポーネントパレットから直接ツールバーに追加できます。


TToolBar.ButtonWidth
TToolBar.ButtonWidth3416008

TToolBar	参照

ButtonWidthプロパティは，ツールバー内のツールボタン（TToolButton）の幅です。

property ButtonWidth: Integer default 23;

説明

ButtonWidthプロパティは，ツールバーの TToolButton コンポーネントの幅をピクセル単位で表します。ただし，これは，その Style プロパティが tbsSeparator か tbsDivider に設定されているツールボタンには有効ではありません。


TToolBar.DisabledImages
TToolBar.DisabledImages3416009

TToolBar	参照

DisabledImages プロパティは，無効なツールボタン上に表示できるイメージのリストです。

property DisabledImages: TImageList;

説明

DisabledImages プロパティは，ツールボタンが無効になっているときにその上に表示可能なイメージのリストを保持します。各ツールボタンの ImageIndex プロパティは，それに表示される特定のイメージを指定します。DisabledImages を割り当てていない場合，無効なツールボタンは通常のイメージ（Images プロパティで指定される）の淡色バージョンを表示します。


TToolBar.Flat
TToolBar.Flat3416010

TToolBar	参照

Flat プロパティは，ツールバーを透過にしてツールボタンの境界を取り除きます。

property Flat: Boolean default False;

説明

Flat プロパティを True に設定すると，ツールバーとそのツールボタンは透過的に表現されます。つまり，ツールバーやツールボタンから背景の色とグラフィックが透けて見えます。さらに，Flat が True の場合には，ツールバー上のツールボタン（TToolButton）にマウスポインタを置いたときにだけそのポップアップ境界が表示されます。

注意

Flat が True に設定されている場合は，設計時および実行時の両方で，バージョン 4.70 以降の COMCTL32.DLL が必要です。


TToolBar.HotImages
TToolBar.HotImages3416011

TToolBar	参照

HotImages プロパティは，マウスがツールボタンを指したときにツールボタン上に表示できるイメージのリストです。

property HotImages: TImageList;

説明

HotImages プロパティは，マウスが実行時にツールボタンを指したときにその上に表示できるイメージのリストを保持します。各ツールボタンの ImageIndex プロパティはマウスがそれを指したときに表示される特定のイメージを指定します。HotImages を割り当てていない場合，ツールボタンはマウスで指されたときにその通常のイメージ（Images プロパティで指定）を保持します。


TToolBar.Images
TToolBar.Images3416012

TToolBar	参照

Images プロパティは，ツールボタン上に表示できるイメージのリストです。

property Images: TImageList;

説明

Images プロパティは，ツールバーのツールボタン上に表示できるイメージのリストを保持します。各ツールボタンの ImageIndex プロパティは，ボタン上に表示される特定のイメージを指定します。Images を割り当てていない場合，ツールボタン上にはイメージが表示されません。


TToolBar.Indent
TToolBar.Indent3416013

TToolBar

Indent プロパティは，ツールバーの左部に余白を作成します。

property Indent: Integer default 0;

説明

Indent プロパティは，ツールバーの左縁とその内部のコントロールを区切る余白をピクセル単位で指定します。


TToolBar.List
TToolBar.List3416014

TToolBar	参照

List プロパティは，ツールボタンでキャプションを右にイメージを左に割り当てます。

property List: Boolean default False;

説明

List プロパティが False の場合，ツールボタン（TToolButton）はイメージを持っていればそれを中央にキャプションが表示可能であればその下に示した状態でツールバーに表示されます。List を True に設定すると，キャプションを右にイメージを左に割り当てます。


TToolBar.RowCount
TToolBar.RowCount3416015

TToolBar	参照

RowCount プロパティは，ツールバー内の行数です。

property RowCount: Integer;

説明

RowCount プロパティは，ツールボタンが配置される行数を返します。


TToolBar.ShowCaptions
TToolBar.ShowCaptions3416016

TToolBar	参照

ShowCaptions プロパティは，ツールボタン上にテキストキャプションを表示するかどうかを指定します。

property ShowCaptions: Boolean default False;

説明

ShowCaptions プロパティが True に設定された場合，ツールバーに表示されるツールボタンにそのキャプションが示されます。ShowCaptions を True に設定すると，ツールボタンのサイズが大きくなることがあります。


TToolBar.Wrapable
TToolBar.Wrapable3416017

TToolBar	参照

Wrapable プロパティは，ツールバー内のコンポーネントの改行を可能にします。

property Wrapable: Boolean default True;

説明

Wrapable プロパティが True の場合，ツールバーを水平にしてコンポーネントを収容しきれないときは，コンポーネントが改行されて次の行が作成されます。


TToolBar イベント3416018

TToolBar	アルファベット順	凡例

TToolBar

OnResize

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TToolBar イベント3416019

TToolBar	オブジェクト順	凡例

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnMouseDown

OnMouseMove

OnMouseUp

OnResize

OnStartDrag


TToolBar.OnResize
TToolBar.OnResize3416020

TToolBar	参照

OnResize イベントは，ツールバーのサイズ変更時に発生します。

property OnResize: TNotifyEvent;

説明

OnResize イベントは，TToolBar が実行時にサイズ変更されるたびに発生します。


TToolBar メソッド3416021

TToolBar	アルファベット順

TToolBar

Create

Destroy

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TToolBar メソッド3416022

TToolBar	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TToolBar.Create
TToolBar.Create3416023

TToolBar	例

Create メソッドは，TToolBar インスタンスを作成して初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは TToolBar オブジェクトを生成してそのプロパティを初期化します。


TToolBar.Destroy
TToolBar.Destroy3416024

TToolBar	参照

Destroy メソッドは，TToolBar インスタンスを破棄してそのメモリを解放します。

destructor Destroy; override;

説明

Destroy メソッドはアプリケーションに直接呼び出さないでください。通常は Free を呼び出します。Free は，コントロールが既に破棄されていることを検証して，それから初めて Destroy を呼び出します。


スコープ3416025

published

読み出し／書き込み

読み出し専用


スコープ3416026

published


継承3416027

TObject

TPersistent

TComponent

TControl

TWinControl

TToolWindow


TToolBar 例3416028

TToolBar


TToolButton
TToolButton3417001

継承	プロパティ	メソッド	イベント	参照

TToolButton は，TToolBar オブジェクト内のボタンコントロールです。

ユニット

comctrls

説明

TToolButton を使うと，ツールバーにボタンを実装できます。ほかのコントロール（TButton と TSpeedButton を含む）もツールバーに配置できますが，TToolButton は特殊なツールバー機能を活用してボタンの設定を簡易化し，ポップアップ境界や透過性といった追加の表示オプションを提供します。

ツールボタンを設計時にツールバーに配置するには，ツールバーを選択してから右クリックして［ボタン新規作成(U)］ボタンを選択します。


TToolButton プロパティ3417002

TToolButton	アルファベット順	凡例

TToolButton

AllowAllUp

Down

DropDownMenu

Grouped

ImageIndex

Indeterminate

Style

Wrap

TControl からの継承

Align

BoundsRect

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Height

Hint

Left

Name

Parent

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TToolButton プロパティ3417003

TToolButton	オブジェクト順	凡例

Align

AllowAllUp

BoundsRect

Caption

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlState

ControlStyle

Cursor

DesignInfo

Down

DragCursor

DragMode

DropDownMenu

Enabled

Grouped

Height

Hint

ImageIndex

Indeterminate

Left

Name

Owner

Parent

ParentShowHint

PopupMenu

ShowHint

Style

Tag

Top

VCLComObject

Visible

Width

WindowProc

Wrap


TToolButton.AllowAllUp
TToolButton.AllowAllUp3417004

TToolButton	参照

AllowAllUp プロパティは，グループ内のすべてのツールボタンを同時に選択解除できるようにします。

property AllowAllUp: Boolean;

説明

AllowAllUp プロパティを True に設定したときは，グループ内のすべてのツールボタンを選択解除できます。AllowAllUp を False に設定したときは，グループ内の少なくとも 1 つのツールボタンが常に選択されていなければなりません（初期的に選択されるツールボタンを指定するには，目的のツールボタンの Down プロパティを True に設定します）。

AllowAllUp が有効なのは，Grouped が True で Style が tbsCheck に設定されている場合だけです。グループ内の 1 つのボタンの AllowAllUp の値を変更すると，グループのすべてのボタンの値が自動的に変更されます。


TToolButton.Down
TToolButton.Down3417005

TToolButton	参照

Down プロパティは，ボタンが選択されている（押されている）か選択解除されている（押されていない）かを指定します。

property Down: Boolean;

説明

Down プロパティは，ツールボタンが選択されているかどうかを判定できます。Down を設計時に True に設定すると，そのボタンが初期的に選択されます。


TToolButton.DropDownMenu
TToolButton.DropdownMenu3417006

TToolButton	参照

DropdownMenu プロパティは，ツールボタンに関連付けられたポップアップメニューを識別します。

property DropdownMenu: TPopupMenu;

説明

DropdownMenu に値を割り当てると，ボタンが押されたときにメニューを表示できます（メニューをプログラムに基づいて表示するには，ツールボタンの Click メソッドを呼び出します）。メニューの AutoPopup プロパティを True に設定すると，メニューが自動的に表示されます。AutoPopup が False の場合，メニューを表示するにはツールボタンの OnClick イベントハンドラ内でメニューの Popup メソッドを呼び出します。


TToolButton.Grouped
TToolButton.Grouped3417007

TToolButton	参照

Grouped プロパティは，連続した隣り合う tbsCheck ボタンを 1 つのグループに統合します。

property Grouped: Boolean;

説明

連続している隣り合ったツールボタン群で各ボタンの Grouped プロパティを True に Style を tbsCheck に設定すると，同時に選択できるボタンはただ 1 つになります。グループ化されたボタンの 1 つを実行時に選択すると，そのグループ内のそれ以外のボタンの選択が解除されます。

ツールバー内で複数のボタングループを明確に作成するには，Grouped プロパティが False のツールボタン，Style プロパティが tbsCheck でないツールボタン（これには tbsSeparator ボタンと tbsDivider ボタンが役立つ），またはツールボタン以外のコントロールのいずれかを使ってグループ分けします。


TToolButton.ImageIndex
TToolButton.ImageIndex3417008

TToolButton	参照

ImageIndex プロパティは，ツールボタンにどのイメージを表示するかを指定します。

property ImageIndex: Integer;

説明

ImageIndex プロパティは，TToolBar の Images リストのどのイメージをツールボタン上に表示するかを指定します。TToolBar.DisabledImages と TToolBar.HotImages が指定されているときは，ボタンが無効であるときとマウスポインタがボタン上に合ったときで異なるイメージが表示されます。

このようなリストはゼロベースなので，最初のイメージのインデックスは 0 で，2 つめのイメージのインデックスは 1 という対応で順次示されます。ImageIndex は 1 つの整数値だけを保持するので，選択されているイメージの位置は複数のリストに同時に存在しなければなりません。たとえば ImageIndex = 2 のときは，ボタンは各リストの 3 つめのイメージを表示します。


TToolButton.Indeterminate
TToolButton.Indeterminate3417009

TToolButton	参照

Indeterminate プロパティは，ツールボタンが選択状態でも選択解除状態でもないことを示します。

property Indeterminate: Boolean;

説明

Indeterminate は，選択状態でも選択解除状態でもないツールボタンの 3 つめの状態を提供します。プログラムコードでこのプロパティを設定すると，ボタンが特定の状況で適用できないことを示せます。ボタンの Indeterminate プロパティを True に設定すると，ボタンが淡色表示されます。

Indeterminate を True に設定すると，Down が自動的に False に設定されます。


TToolButton.Style
TToolButton.Style3417010

TToolButton	参照

Style プロパティは，ツールボタンのスタイルを指定します。

TToolButtonStyle = (tbsButton, tbsCheck, tbsDropDown, tbsSeparator, tbsDivider);

property Style: TToolButtonStyle;

説明

以下に Style のとり得る値を示します。

値	意味

tbsButton	ボタンが通常のスピードボタンと同じように表示され機能する

tbsCheck	ボタンをクリックすると，Down プロパティが切り替わる。いったんボタンを選択すると，もう一度クリックするまで選択された状態になる

tbsDropDown	ボタンは下向き矢印（ドロップダウンメニューのアクセスに適当）を表示する

tbsSeparator	ボタンがツールバー上の空きスペースとして表示される（ほかのコントロールを区切るために使われる）

tbsDivider	ボタンがツールバー上の垂直線として表示される（ほかのコントロールを区切るために使われる）


TToolButton.Wrap
TToolButton.Wrap3417011

TToolButton	参照

Wrap プロパティは，ツールボタンの後ろに強制的に新しい行を設定します。

property Wrap: Boolean;

説明

ToolBar コントロールの Wrapable プロパティが False のとき，Wrap プロパティを True に設定すると，目的のツールボタンをその行の最後に配置できます。


TToolButton イベント3417012

TToolButton	アルファベット順	凡例

TControl からの継承

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TToolButton イベント3417013

TToolButton	オブジェクト順	凡例

OnClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TToolButton メソッド3417014

TToolButton	アルファベット順

TToolButton

Create

Destroy

TControl からの継承

BeginDrag

BringToFront

Click

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Invalidate

Perform

Refresh

Repaint

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TToolButton メソッド3417015

TToolButton	オブジェクト順

Assign

BeginDrag

BringToFront

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Click

ClientToScreen

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DragDrop

Dragging

EndDrag

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTextBuf

GetTextLen

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

Perform

Refresh

RemoveComponent

Repaint

SafeCallException

ScreenToClient

SendToBack

SetBounds

SetTextBuf

Show

Update


TToolButton.Create
TToolButton.Create3417016

TToolButton

Create メソッドは，TToolButton インスタンスを作成して初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは TToolButton を生成してそのプロパティを初期化します。


TToolButton.Destroy

TToolButton	参照

Destroy メソッドは，TToolButton を破棄してそのメモリを解放します。

destructor Destroy; override;

説明

Destroy メソッドはアプリケーションに直接呼び出さないでください。通常は Free を呼び出します。Free は，コントロールが既に破棄されていないことを検証して，それから初めて Destroy を呼び出します。


スコープ3417017

published

読み出し／書き込み

読み出し専用


スコープ3417018

published


継承3417019

TObject

TPersistent

TComponent

TControl

TGraphicControl


TToolButton 例3417020

TToolButton


TToolWindow
TToolWindow3418001

継承	プロパティ	メソッド	参照

TToolWindow は，カスタムクライアント領域および端の境界を必要とするウィンドウコントロール用の抽象上位オブジェクトです。

ユニット

toolwin

説明

TToolWindow は TCoolBar コンポーネントと TToolBar コンポーネントの上位オブジェクトです。このようなコンポーネントによって，ボタンとそのほかのビジュアルコントロールを簡単に加工できます。


TToolWindow プロパティ3418002

TToolWindow	アルファベット順	凡例

TToolWindow

BorderWidth

EdgeBorders

EdgeInner

EdgeOuter

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TToolWindow プロパティ3418003

TToolWindow	オブジェクト順	凡例

Align

BorderWidth

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

EdgeBorders

EdgeInner

EdgeOuter

Enabled

Handle

Height

HelpContext

Hint

Left

Name

Owner

Parent

ParentWindow

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowProc


TToolWindow.BorderWidth
TToolWindow.BorderWidth3418004

TToolWindow

BorderWidth プロパティは，コントロールの内部境界の幅を指定します。

property BorderWidth: Integer default 0;

説明

BorderWidth プロパティは，TToolWindow の内側の端とその中のコントロールとの間に余白を作成します。BorderWidth が広すぎるときは，内部のコントロールが見えなくなります。


TToolWindow.EdgeBorders
TToolWindow.EdgeBorders3418005

TToolWindow	参照

EdgeBorders プロパティは，コントロールのどちら側を可視境界にするかを指定します。

TEdgeBorder = (ebLeft, ebTop, ebRight, ebBottom);

TEdgeBorders = set of TEdgeBorder;

property EdgeBorders: TEdgeBorders default [ebLeft, ebTop, ebRight, ebBottom];

説明

EdgeBorders プロパティを使うと，境界を追加または除去できます。境界の外観を設定するには，EdgeInner プロパティと EdgeOuter プロパティを使います。


TToolWindow.EdgeInner
TToolWindow.EdgeInner3418006

TToolWindow	参照

EdgeInner プロパティは，コントロールの内側の端の境界スタイルを指定します。

TEdgeStyle = (esNone, esRaised, esLowered);

property EdgeInner: TEdgeStyle default esRaised;

説明

以下に EdgeInner プロパティの値を示します。

値	意味

esNone	内側の端は表示されない

esRaised	内側の端がもりあがったように見える

esLowered	内側の端がへこんでいるように見える

EdgeInner を EdgeOuter と組み合わせて使うと，コンポーネントの外観を 3 次元で表現できます。


TToolWindow.EdgeOuter
TToolWindow.EdgeOuter3418007

TToolWindow	参照

EdgeOuter プロパティは，コントロールの外側の端の境界スタイルを指定します。

TEdgeStyle = (esNone, esRaised, esLowered);

property EdgeOuter: TEdgeStyle default esLowered;

説明

以下に EdgeOuter プロパティの値を示します。

値	意味

esNone	外側の端は表示されない

esRaised	外側の端がもりあがったように見える

esLowered	外側の端がへこんでいるように見える

EdgeOuter を EdgeInner と組み合わせて使うと，コンポーネントの外観を 3 次元で表現できます。


TToolWindow メソッド3418008

TToolWindow	アルファベット順

TToolWindow

Create

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TToolWindow メソッド3418009

TToolWindow	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


TToolWindow.Create
TToolWindow.Create3418010

TToolWindow

Create メソッドは，TToolWindow のインスタンスを作成し初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドは TToolWindow を生成してそのプロパティを初期化します。


スコープ3418011

published

読み出し／書き込み

読み出し専用


継承3418012

TObject

TPersistent

TComponent

TControl

TWinControl


TToolWindow 例3418013

TToolWindow


TTrackBar
TTrackBar3419001

継承	プロパティ	メソッド	イベント	参照

TTrackBar は，Windows トラックバーコントロールのラッパーです。

ユニット

comctrls

説明

TTrackBar は，トラックバーをフォームに配置できます。トラックバーは，スライダと目盛り（オプション）を使って列に沿った位置を示します。また，トラックバーは，三角形の印で選択範囲の始点と終点を表示します。

プログラムの実行中は，マウスでドラッグするか，バー上でマウスをクリックしてスライダを移動したい位置に移動できます。キーボードを使ってスライダを移動させるには，矢印キーか，〔PageUp〕または〔PageDown〕キーを押します。


TTrackBar プロパティ3419002

TTrackBar	アルファベット順	凡例

TTrackBar

Frequency

LineSize

Max

Min

Orientation

PageSize

Position

SelEnd

SelStart

TickMarks

TickStyle

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

DragCursor

DragMode

Enabled

Height

Hint

Left

Name

Parent

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TTrackBar プロパティ3419003

TTrackBar	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

Enabled

Frequency

Handle

Height

HelpContext

Hint

Left

LineSize

Max

Min

Name

Orientation

Owner

PageSize

Parent

ParentCtl3D

ParentShowHint

ParentWindow

PopupMenu

Position

SelEnd

SelStart

ShowHint

Showing

TabOrder

TabStop

Tag

TickMarks

TickStyle

Top

VCLComObject

Visible

Width

WindowProc


TTrackBar.Frequency
TTrackBar.Frequency3419004

TTrackBar	参照

Frequency プロパティは，トラックバー上の目盛り間の増分を示します。

property Frequency: Integer;

説明

Frequency プロパティは，Position プロパティが使う論理ユニットで目盛りの間隔を示します。Frequency の値が 5 ならば，5 つおきに目盛りが設定されます。トラックバーの単位を表示するには，Frequency を LineSize または PageSize に設定します。

注意

TickStyle プロパティの値が tsAuto に設定されていない場合，Frequency の値は無視されます。


TTrackBar.LineSize
TTrackBar.LineSize3419005

TTrackBar	参照

LineSize プロパティは，ユーザーが矢印キーを押したときの Position 値の変化量を示します。

property LineSize: Integer;

説明

LineSize プロパティは，1 つの目盛りを表すスライダに沿った距離を示します。現在の Position はスライダが示します。VK_RIGHT と VK_DOWN は LineSize で指定された分だけ Position の値をインクリメントし，VK_LEFT と VK_UP は LineSize で指定された分だけ Position の値をデクリメントします。

〔PageUp〕と〔PageDown〕キーを使って移動する刻み数を設定するには，PageSize プロパティを使います。


TTrackBar.Max
TTrackBar.Max3419006

TTrackBar	参照

Max プロパティは，TTrackBar の Position の最大値を示します。

property Max: Integer;

説明

Max プロパティは，トラックバーで表される上限値を設定できます。スライダは，Min～Max の範囲における現在の Position を示します。


TTrackBar.Min
TTrackBar.Min3419007

TTrackBar	参照

Min プロパティは，TTrackBar の Position の最小値を示します。

property Min: Integer;

説明

Min プロパティは，トラックバーで表される下限値を設定できます。スライダは，Min～Max の範囲における現在の Position を示します。


TTrackBar.Orientation
TTrackBar.Orientation3419008

TTrackBar	参照

Orientation プロパティは，トラックバーが垂直か水平かを示します。

TTrackBarOrientation = (trHorizontal, trVertical);

property Orientation: TTrackBarOrientation;

説明

Orientation を移動したい方向に設定します。

値	意味

tbHorizontal	トラックの長い方の縁はフォームの上部と平行。Min 位置は一番左側にあり，スライダが右に移動すると Max 位置に近づく

tbVertical	トラックの長い方の縁はフォームの側面と平行。Min 位置は一番上にあり，スライダが下に移動すると Max 位置に近づく


TTrackBar.PageSize
TTrackBar.PageSize3419009

TTrackBar	参照

PageSize プロパティは，〔PageUp〕と〔PageDown〕キーを使うか，マウスでバーをクリックした場合の Position の変化量を示します。

property PageSize: Integer;

説明

PageSize プロパティは，1 つのビューに相当するスライダに沿った距離を示します。現在の Position はスライダが示します。〔PageUp〕とキーは PageSize で指定された分だけ Position の値をインクリメントし，〔PageDown〕キーは PageSize で指定された分だけ Position の値をデクリメントします。

矢印キーを使って移動する刻み数を設定するには，LineSize プロパティを使います。


TTrackBar.Position
TTrackBar.Position3419010

TTrackBar	参照

Position プロパティは，TTrackBar のスライダの現在の位置を示します。

property Position: Integer;

説明

Position プロパティは，トラックバーが表す現在の値を示します。Position は，Min 以上 Max以下の値です。Position を設定すると，トラックバーのスライダをプログラムで新しい値に移動できます。


TTrackBar.SelEnd
TTrackBar.SelEnd3419011

TTrackBar	参照

SelEnd プロパティは，選択範囲の終了位置を示します。

property SelEnd: Integer;

説明

SelEnd プロパティは，SelStart を始点とした選択範囲の長さを示します。トラックバーでは SelStart プロパティと SelEnd プロパティで指定した位置に特別な目盛りを配置し，その部分を強調表示することでバー上の選択範囲を示します。

SelEnd は，Position に等しいかそれより大きくなくてはなりません。SelEnd を Position より小さい値に設定すると，Position は SelEnd に変わります。SelEnd は，SelStart に等しいかそれより大きくなくてはなりません。SelEnd が SelStart と等しい場合，選択範囲はなくなり，Position の値は SelStart および SelEnd と等しくなります。


TTrackBar.SelStart
TTrackBar.SelStart3419012

TTrackBar	参照

SelStart プロパティは，選択範囲の開始位置を指定します。

property SelStart: Integer;

説明

SelStart プロパティは，SelEnd を終点とする選択範囲の始点を示します。トラックバーでは SelStart プロパティと SelEnd プロパティで指定した位置に特別な目盛りを配置し，その部分を強調表示することでバー上の選択範囲を示します。

SelStart は，Position に等しいかそれよりも小さくなくてはなりません。SelStart を Position よりも大きな値に設定した場合，Position が SelStart になります。SelStart はSelEnd に等しいかそれよりも小さくなくてはなりません。SelStart が SelEnd と等しい場合，選択範囲はなくなり，Position の値は SelStart および SelEnd と等しくなります。


TTrackBar.TickMarks

TTrackBar	参照

TickMarks プロパティは，目盛りの位置を指定します。

TTickMark = (tmBottomRight, tmTopLeft, tmBoth);

property TickMarks: TTickMark;

説明

TickMarks プロパティは，目盛りの表示位置を示します。以下に TickMarks の指定値を示します。

値	意味

tmBottomRight	Orientation プロパティの値に応じて，トラックバーの下側または右側に目盛りが表示される

tmTopLeft	Orientation プロパティの値に応じて，トラックバーの上側または左側にトラックバーが表示される

tmBoth	トラックバーの両側に目盛りが表示される

TickStyle プロパティが tsNone の場合，TickMarks の値は無視されます。


TTrackBar.TickStyle
TTrackBar.TickStyle3419014

TTrackBar	参照

TickStyle プロパティは，目盛りをトラックバーに配置する方法を示します。

property TickStyle: TTickStyle;

説明

TickStyle プロパティは，トラックバーに目盛りを表示するかどうかを示すことができ，表示する場合には目盛りの設定方法についても示すことができます。以下に TickStyle の指定値を示します。

値	意味

tsAuto	目盛りは Frequency プロパティの値に等しい単位で自動的に表示される

tsManual	目盛りは Min 値とMax 値の位置に表示される。 SetTick メソッドを使うと目盛りを設定できる

tsNone	目盛りは表示されない


TTrackBar イベント3419015

TTrackBar	アルファベット順	凡例

TTrackBar

OnChange

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnDragDrop

OnDragOver

OnEndDrag

OnStartDrag


TTrackBar イベント3419016

TTrackBar	オブジェクト順	凡例

OnChange

OnDragDrop

OnDragOver

OnEndDrag

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

OnStartDrag


TTrackBar.OnChange
TTrackBar.OnChange3419017

TTrackBar	参照

OnChange イベントは，Position の値が変わった直後に発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnChange: TNotifyEvent;

説明

OnChange イベントハンドラを記述すると，スライダの位置が変更されたときに特定のアクションを実行できます。たとえば，トラックバーをオブジェクトの制御に使っている場合，他のオブジェクトを OnChange イベントハンドラで更新します。


TTrackBar メソッド3419018

TTrackBar	アルファベット順

TTrackBar

Create

SetTick

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TTrackBar メソッド3419019

TTrackBar	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

SetTick

Show

Update

UpdateControlState


TTrackBar.Create
TTrackBar.Create3419020

TTrackBar	参照

Create メソッドは，TTrackBar のインスタンスを作成し，初期化します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，実行時に TTrackBar オブジェクトをインスタンス化できます。設計時にフォームに配置されたトラックバーは自動的に作成されます。

Create はメモリを割り当ててから，次のプロパティを初期化します。

・	ControlStyle を [csCaptureMouse, csClickEvents, csSetCaption] に設定する

・	Frequency を 1 に設定する

・	Height を 45 に，Width を 150 に設定する

・	LineSize を 1 に，PageSize を 2 に設定する

・	Max を 10 に，Min を 0 に設定する

・	Orientation を trHorizontal に設定する

・	TickMarks を tbBottomRight に，TickStyle を tsAuto に設定する

・	TabStop を True に設定する


TTrackBar.SetTick
TTrackBar.SetTick3419021

TTrackBar	参照

SetTick メソッドは，指定された位置でトラックバーに目盛りを追加します。

procedure SetTick(Value: Integer);

説明

SetTick メソッドを呼び出すと，Value パラメータに対応する位置でトラックバー上に目盛りを配置できます。この方法で指定された目盛りは TickStyle が tsManual に設定されている場合のみ表示されます。


スコープ3419022

published

読み出し／書き込み

読み出し専用


スコープ3419023

published


継承3419024

TObject

TPersistent

TComponent

TControl

TWinControl


TTrackBar 例3419025

TTrackBar


TTreeNode
TTreeNode3420001

継承	プロパティ	メソッド	参照

TTreeNode オブジェクトはツリービューコントロールの個々のノードを記述します。

ユニット

comctrls

説明

ツリービューコントロールの各ノードは，ラベルおよびオプションのビットマップイメージからなります。各項目は子項目のリストの親になれます。項目をクリックすると，ユーザーは関連付けられた子項目のリストを展開したり，縮小（折りたたみ）したりできます。


TTreeNode プロパティ3420002

TTreeNode	アルファベット順	凡例

TTreeNode

AbsoluteIndex

Count

Cut

Data

Deleting

DropTarget

Expanded

Focused

Handle

HasChildren

ImageIndex

Index

IsVisible

Item

ItemId

Level

OverlayIndex

Owner

Parent

Selected

SelectedIndex

StateIndex

Text

TreeView


TTreeNode プロパティ3420003

TTreeNode	オブジェクト順	凡例

AbsoluteIndex

Count

Cut

Data

Deleting

DropTarget

Expanded

Focused

Handle

HasChildren

ImageIndex

Index

IsVisible

Item

ItemId

Level

OverlayIndex

Owner

Parent

Selected

SelectedIndex

StateIndex

Text

TreeView


TTreeNode.AbsoluteIndex
TTreeNode.AbsoluteIndex3420004

TTreeNode	参照

AbsoluteIndex プロパティは，ツリーノードで最初のノードを基準にしたノードのインデックスです。

property AbsoluteIndex: Integer;

説明

AbsoluteIndex プロパティは，ツリーノードオブジェクトにおけるノードの絶対位置を取得できます。ツリーノードオブジェクトの最初のノードのインデックスは 0 で，その以降のノードには順に番号が付きます。ノードに子がある場合，親ノードの AbsoluteIndex は最初のノードから 1 を引いた値になります。


TTreeNode.Count
TTreeNode.Count3420005

TTreeNode	参照

Count プロパティは，ツリーノードの直接の下位項目の数を示します。

property Count: Integer;

説明

Count プロパティは，ツリーノードにある子の数を取得できます。Count には直接の子の数だけが入っていて，子の下位項目は入っていません。Count はツリーノードの子に繰り返し処理を行うときに便利です。


TTreeNode.Cut
TTreeNode.Cut3420006

TTreeNode	参照

Cut プロパティは，ツリーノードオブジェクトが切り取りと貼り付け操作の対象になっているように表示されるかどうかを示します。

property Cut: Boolean;

説明

Cut プロパティは，ノードが切り取りと貼り付け操作の対象として選択されたときにツリーノードの外観を変更できます。


TTreeNode.Data
TTreeNode.Data3420007

TTreeNode	参照

Data プロパティは，ツリーノードに関連付けられているアプリケーション定義のデータへのポインタです。

property Data: Pointer;

説明

Data プロパティは，データをツリーノードに関連付けることができます。Data は，アプリケーションがノードによって表されるデータにすばやくアクセスすることを可能にします。


TTreeNode.Deleting
TTreeNode.Deleting3420008

TTreeNode	参照

Deleting プロパティは，ノードの Destroy メソッドが呼び出されて削除処理をしているかどうかを示します。

property Deleting: Boolean;

説明

Deleting プロパティは，ノードを削除中であるために発生するイベントに応答して再帰的にノードを削除しようとすることを取得できます。


TTreeNode.DropTarget
TTreeNode.DropTarget3420009

TTreeNode	参照

DropTarget プロパティは，ツリーノードがドラッグアンドドロップのターゲットとして選択されているかどうかを示します。

property DropTarget: Boolean;

説明

DropTarget は，ノードがドラッグアンドドロップのターゲットになっていることを取得できます。DropTarget が True ならば，ノードはドラッグアンドドロップのターゲットであることを示すスタイルで描画されます。

注意

DropTarget を True に設定すると，ドラッグされていたオブジェクトが離されたときに自動的にそれをノードが受け取るようにできます。アプリケーションはドロップ動作を実現する必要があります。


TTreeNode.Expanded
TTreeNode.Expanded3420010

TTreeNode	参照

Expanded プロパティは，ツリーノードが展開されているかどうかを示します。

property Expanded: Boolean;

説明

ツリーノードが展開されていると，ツリービューの ShowButtons プロパティが True かどうかで負符号のボタンが表示され，子ノードが表示されます。Expanded を True に設定するとノードの子が表示されます。Expanded を False に設定するとノードは折りたたまれて，ノードの子はすべて隠されます。


TTreeNode.Focused
TTreeNode.Focused3420011

TTreeNode	参照

Focused プロパティは，ノードが表示されるとそのノードがフォーカスを持つかどうかを示します。

property Focused: Boolean;

説明

ツリービューコントロールはウィンドウ付きコントロールではないので，入力フォーカスを受け取ることができません。ただし，ツリービューがフォーカスを持っていればそれを編集できます。Focused が True の場合，ノードは標準の四角形のフォーカス領域で囲まれ，ユーザーはそのラベルを編集できます。Focused を使うと，ツリービューの特定のノードが現在ユーザーによって編集中であるかどうかを判別できます。


TTreeNode.Handle
TTreeNode.Handle3420012

TTreeNode	参照

Handle プロパティは，ツリーノードを格納するツリービューのウィンドウ Handle です。

property Handle: HWND;

説明

Handle プロパティは，ノードを所有するツリービューのハンドルを取得できます。このハンドルは，ツリービューのハンドルを必要とする Windows API 関数呼び出しへのパラメータとして渡すことができます。


TTreeNode.HasChildren
TTreeNode.HasChildren3420013

TTreeNode	参照

HasChildren プロパティはノードに子があるかどうかを示します。

property HasChildren: Boolean;

説明

HasChildren はノードに下位ノードがある場合に True，ノードに下位ノードがない場合に False になります。ツリービューの ShowButtons が True の場合，HasChildren を True に設定すると，ノードが折りたたまれているときにノードの左側に［+］ボタンが表示され，展開されているときに［-］ボタンが表示されます。

注意

ノードが子を持たない場合，HasChildren を True に設定すると［+］ボタンが表示されますが，子ノードは追加されず，ノードは展開できません。


TTreeNode.ImageIndex
TTreeNode.ImageIndex3420014

TTreeNode	参照

ImageIndex プロパティは，ノードが通常の状態にあって現在選択されていない場合に，どのイメージを表示するかを指定します。

property ImageIndex: Integer;

説明

ツリービューの Images プロパティとともに ImageIndex プロパティを使うと，通常の状態にあるノードのイメージを指定できます。


TTreeNode.Index
TTreeNode.Index3420015

TTreeNode	参照

Index プロパティは，親ノードが保守する子ノードリストでのノードの位置を指定します。

property Index: Longint;

説明

Index を使うと兄弟ノードに相対するノードの位置を特定できます。親ノードの最初の子の Index は 0 で，以後これに続いてインデックス付けされます。


TTreeNode.IsVisible
TTreeNode.IsVisible3420016

TTreeNode	参照

IsVisible プロパティは，ツリーノードがツリービューイメージで現在可視かどうかを示します。

property IsVisible: Boolean;

説明

ノードがレベル 0 にあるか親ノードがすべて展開されていれば，ノードは表示されています。IsVisible は，ノードがツリービューイメージの一部になっているかどうかを示します。ツリービューイメージがツリービューことよりも大きい場合に，ノードをスクロールしてビューに入るかどうかを示しはしません。


TTreeNode.Item
TTreeNode.Item3420017

TTreeNode	参照

Item プロパティは，子ノードリストの位置によって子ノードへのアクセスを提供します。

property Item[Index: Integer]: TTreeNode;

説明

Item を使うと Index プロパティに基づいて子ノードへアクセスできます。最初の子ノードのインデックスは 0，2 番目のインデックスは 1 となります。

例

たとえば，次のコードは Item を使って，ボタンがクリックされた場合に選択したノードのすべての子ノードのラベルをリストボックスに追加します。

procedure TForm1.Button1Click(Sender: TObject);

var

I : Integer;

begin

for I := 0 to (TreeView1.Selected.Count - 1) do

ListBox1.Items.Add(TreeView1.Selected.Item[I].Text);

end;


TTreeNode.ItemId
TTreeNode.ItemId3420018

TTreeNode	参照

ItemID プロパティは，HTreeItem 型のハンドルで，ツリービューにある各ノードをユニークに識別します。

property ItemId: HTreeItem;

説明

ItemID プロパティを使うと，Windows API 呼び出しを行うときや項目を所有する TTreeNodes の GetNode メソッドを呼び出すときにノードを参照することができます。


TTreeNode.Level
TTreeNode.Level3420019

TTreeNode	参照

Level プロパティは，ツリービューコントロール内のノードのインデントレベルを示します。

property Level: Integer;

説明

トップレベルノードの Level 値は 0 です。その子ノードの Level 値は 1 となります。


TTreeNode.OverlayIndex
TTreeNode.OverlayIndex3420020

TTreeNode	参照

OverlayIndex プロパティは，イメージリスト内にあるどのイメージをオーバーレイマスクとして使うかを指定します。

property OverlayIndex: Integer;

説明

オーバーレイマスクはツリービューまたはリストビュー内で別のイメージの上に透過的に描画されるイメージです。たとえば，使用可能でなくなったノードを示すため，現在のノードのイメージ上に X を描画するオーバーレイイメージなどです。


TTreeNode.Owner
TTreeNode.Owner3420021

TTreeNode	参照

Owner プロパティはどのツリーノードオブジェクトがツリーノードを格納するかを示します。

property Owner: TTreeNodes;

説明

Owner プロパティを使うとツリーノードのオーナーを判別できます。Owner と TreeView プロパティを間違えないでください。Owner はツリービューがそのノードを管理するために使うノードのリストです。TreeView プロパティはそのリストを使うツリービューです。


TTreeNode.Parent
TTreeNode.Parent3420022

TTreeNode	参照

Parent プロパティはツリーノードの親ノードを識別します。

property Parent: TTreeNode;

説明

親ノードは 1 レベル高く，ノードを下位ノードとして格納しています。


TTreeNode.Selected
TTreeNode.Selected3420023

TTreeNode	参照

Selected プロパティはノードが選択されているかどうかを特定します。

property Selected: Boolean;

説明

Selected を True に設定するとノードを選択できます。選択されたノードの外観は，そのノードにフォーカスがあるかどうかと，選択時にシステムカラーが使われるかどうかによって決まります。ノードが選択されると，ツリービューの OnChanging イベントと OnChanged イベントが発生します。


TTreeNode.SelectedIndex
TTreeNode.SelectedIndex3420024

TTreeNode	参照

SelectedIndex プロパティは，ツリービューのイメージリストでのイメージのインデックスです。そのイメージはノードが選択されたときにノードに表示するイメージです。

property SelectedIndex: Integer;

説明

SelectedIndex プロパティを使うと，ノードが選択されたときに表示するイメージを指定できます。


TTreeNode.StateIndex
TTreeNode.StateIndex3420025

TTreeNode	参照

StateIndex プロパティはノードに対して表示するイメージを StateImages リストから指定します。

property StateIndex: Integer;

説明

StateIndex を使うと，ノードの状態についての情報を表すイメージを追加して表示できます。 StateIndex が -1 の場合，状態イメージは描画されません。


TTreeNode.Text
TTreeNode.Text3420026

TTreeNode	参照

Text プロパティはツリーノードを識別するラベルです。

property Text: string;

説明

Text を使うとツリービューに表示する文字列を指定できます。Text の値は実行時に直接割り当てることも，TTreeView コンポーネントの Items プロパティを修正中に TreeView の項目エディタで設定することもできます。ツリービューがノードの編集をユーザーに許可している場合，Text を読み出すと，ユーザーがノードに指定した値を特定できます。


TTreeNode.TreeView
TTreeNode.TreeView3420027

TTreeNode	参照

TreeView プロパティはノードを表示ツリービューを指定します。

property TreeView: TCustomTreeView;

説明

TreeView プロパティを使うと，ツリーノードに関連付けられたツリービューを調べることができます。


TTreeNode メソッド3420028

TTreeNode	アルファベット順

TTreeNode

AlphaSort

Assign

Collapse

Create

CustomSort

Delete

DeleteChildren

Destroy

DisplayRect

EditText

EndEdit

Expand

GetFirstChild

GetHandle

GetLastChild

GetNext

GetNextChild

GetNextSibling

GetNextVisible

GetPrev

GetPrevChild

GetPrevSibling

GetPrevVisible

HasAsParent

IndexOf

MakeVisible

MoveTo

Tpersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafecallException


TTreeNode メソッド3420029

TTreeNode	オブジェクト順

AlphaSort

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Collapse

Create

CustomSort

DefaultHandler

Delete

DeleteChildren

Destroy

Dispatch

DisplayRect

EditText

EndEdit

Expand

FieldAddress

Free

FreeInstance

GetFirstChild

GetHandle

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetLastChild

GetNamePath

GetNext

GetNextChild

GetNextSibling

GetNextVisible

GetPrev

GetPrevChild

GetPrevSibling

GetPrevVisible

HasAsParent

IndexOf

InheritsFrom

InitInstance

InstanceSize

MakeVisible

MethodAddress

MethodName

MoveTo

NewInstance

SafecallException


TTreeNode.AlphaSort
TTreeNode.AlphaSort3420030

TTreeNode	参照

AlphaSort メソッドは，ノードの子をそれぞれの Text プロパティに基づいてアルファベット順にソートします。

function AlphaSort: Boolean;

説明

AlphaSort を呼び出すとツリービューのサブツリーをアルファベット順にソートできます。成功すると，AlphaSort は True を返します。


TTreeNode.Assign
TTreeNode.Assign3420031

TTreeNode	参照

Assign メソッドは別のツリービューノードのプロパティをコピーします。

procedure Assign(Source: TPersistent); override;

説明

Source パラメータが TTreeNode オブジェクトの場合，Assign がソースノードからコピーするのは Text，Data，ImageIndex，SelectedIndex，OverlayIndex，Focused，DropTarget，Cut，および HasChildren の各プロパティです。Source が TTreeNode オブジェクト以外の場合，Assign は継承されたメソッドを呼び出し，それが AssignTo メソッドでツリーノードにコピーできるオブジェクトからの情報をコピーします。

注意

Assign は HasChildren プロパティをコピーしますが，子ノードはコピーしません。子を持つ別のノードのプロパティを割り当てた後で，必ずすべての子をコピーしてください。


TTreeNode.Collapse
TTreeNode.Collapse3420032

TTreeNode	参照

Collapse メソッドはノードを縮小（折りたたみ）します。

procedure Collapse(Recurse: Boolean);

説明

ノードを縮小すると，その下位ノードすべてが隠されます。ツリービューの ShowButtons プロパティが設定されているかどうかで，正符号ボタンが表示されることがあります。Recurse が True の場合はすべての下位ノードも縮小されます。次にノードを展開しても下位ノードは縮小されたままです。Recurse が False の場合，子ノードは縮小されず，次にノードを展開しても子ノードは Collapse を呼び出したときと同じ状態のままです。


TTreeNode.Create
TTreeNode.Create3420033

TTreeNode	参照

Create メソッドは TTreeNode のインスタンスを作成します。

constructor Create(AOwner: TTreeNodes);

説明

Create を呼び出すと実行時にツリーノードをインスタンス化できます。設計時にツリービューコントロールに追加されたノードは自動的に作成されます。TTreeNodes オブジェクトを代わりに使うと，既存のツリービューの一部としてノードを作成できます。

継承されたコンストラクタの読み出し後，Create は OverlayIndex プロパティと StateIndex プロパティを -1 に設定し，次にツリーノードの Owner プロパティを AOwner TTreeNodes オブジェクトに設定します。


TTreeNode.CustomSort
TTreeNode.CustomSort3420034

TTreeNode	参照

CustomSort メソッドはカスタマイズした順序付け関数を使って子ノードをソートします。

TTVCompare = function(lParam1, lParam2, lParamSort: Longint): Integer stdcall;

function CustomSort(SortProc: TTVCompare; Data: Longint): Boolean;

説明

CustomSort を使うと，SortProc パラメータで定義されたソート順のツリービューの子ノードをソートできます。TTreeNode オブジェクトにキャストされるソート手続きの lParam1 パラメータと lParam2 パラメータが比較されます。ソート手続きの lParamSort パラメータは CustomSort の Data パラメータの値です。ソート手続きは，lParam1 を lParam2 の前に置く場合には負の値を，lParam1 と lParam2 が等しい場合には 0 を，lParam1 を lParam2 の後に置く場合には正の値を返さなければなりません。

SortProc パラメータが nil の場合，AlphaSort メソッドが呼び出されます。

たとえば，アルファベットの逆順にサブツリーを順序付けるには，以下に示すような CustomSortProc 関数などのコールバック関数を記述し，グローバル AnsiStrIComp 関数を呼び出します。

function CustomSortProc(Node1, Node2: TTreeNode; Data: Longint): integer; stdcall;

begin

  Result := -AnsiStrIComp(PChar(Node1.Text), PChar(Node2.Text));

end;

この手続きは， CustomSortの引数として使用されます。

TreeNode1.CustomSort(@CustomSortProc, 0);


TTreeNode.Delete
TTreeNode.Delete3420035

TTreeNode	参照

Delete メソッドはノードとそのすべての子を破棄します。

procedure Delete;

説明

Delete メソッドを使うとツリーノードを削除して，それに関連付けられていたメモリを解放します。


TTreeNode.DeleteChildren
TTreeNode.DeleteChildren3420036

TTreeNode	参照

DeleteChildren メソッドはノードのすべての子を削除します。

procedure DeleteChildren;

説明

DeleteChildren メソッドを使うとツリーノードのすべての子を削除して，関連付けられていたメモリを解放できます。


TTreeNode.Destroy
TTreeNode.Destroy3420037

TTreeNode	参照

Destroy はツリーノードオブジェクトを破棄します。

destructor Destroy; override;

説明

アプリケーションで Destroy を直接呼び出さないでください。かわりに Delete メソッドを使います。Delete はノードのイメージおよびそのすべての子をツリービューウィンドウから削除し，Windows メッセージに応答して発生する可能性のある再帰的な削除の発生を防ぎます。


TTreeNode.DisplayRect
TTreeNode.DisplayRect3420038

TTreeNode	参照

DisplayRect メソッドはツリーノードの境界となる四角形を返します。

function DisplayRect(TextOnly: Boolean): TRect;

説明

TextOnly パラメータが True の場合，境界の四角にはノードだけが含まれます。それ以外の場合，ノードがツリービューコントロール内で占有する行全体が含まれます。


TTreeNode.EditText
TTreeNode.EditText3420039

TTreeNode	参照

EditText メソッドは指定したノードのテキストのインプレース編集を開始し，ノードのテキストをそのテキストが入った 1 行の編集コントロールに置き換えます。

function EditText: Boolean;

説明

EditText を呼び出すとユーザーにノードのラベル編集を許可できます。このメソッドは暗黙的に Selected プロパティと Focused プロパティを True に設定します。EditText が呼び出されると，ツリービューの OnEditing イベントが発生します。


TTreeNode.EndEdit
TTreeNode.EndEdit3420040

TTreeNode	参照

EndEdit メソッドはノードのラベル編集を終了します。

procedure EndEdit(Cancel Boolean);

説明

EndEdit を呼び出すとノードの編集モードを終了できます。Cancel パラメータが True の場合，ユーザーが加えた変更はすべて破棄されます。Cancel が False の場合，EndEdit はノードの Text プロパティを更新し，ツリービューの OnEdited イベントが発生します。

ユーザーが変更を加えて Cancel が False の場合，ツリービューの OnEdited イベントが発生します。


TTreeNode.Expand
TTreeNode.Expand3420041

TTreeNode	参照

Expand メソッドはノードを展開してすべての子ノードを表示します。

procedure Expand(Recurse: Boolean);

説明

ノードを展開するとその直接の子ノードが表示されます。ツリービューの ShowButtons プロパティが設定されているかどうかで負符号の［-］ボタンが表示されます。Recurse が True の場合，直接の子のすべての子ノードも展開されます。


TTreeNode.GetFirstChild
TTreeNode.GetFirstChild3420042

TTreeNode	参照

GetFirstChild メソッドはツリーノードで最初の子ノードを返します。

function GetFirstChild: TTreeNode;

説明

GetFirstChild を呼び出すとツリービューノードの最初の子ノードにアクセスできます。ノードが子を持っていない場合には，GetFirstChild は nil を返します。

注意

GetFirstChild は Item[0] と同じ値を返します。


TTreeNode.GetHandle
TTreeNode.GetHandle3420043

TTreeNode	参照

GetHandle メソッドは Handle プロパティを返します。

function GetHandle: HWND;

説明

GetHandle を呼び出すことは Handle プロパティを読み出すことと同じです。


TTreeNode.GetLastChild
TTreeNode.GetLastChild3420044

TTreeNode	参照

GetLastChild メソッドは，呼び出し側ノードの直接の子ノード中の最後のものを返します。

function GetLastChild: TTreeNode;

説明

GetLastChild を呼び出すとノード中の最後の直接の子ノードを見つけられます。呼び出し側ノードに子が存在しない場合，GetLastChild は nil を返します。GetLastChild は Item[Count-1]と同じ値を返しますが，Item プロパティを使うよりも速く処理できます。


TTreeNode.GetNext
TTreeNode.GetNext3420045

TTreeNode	参照

GetNext メソッドはツリービュー内で呼び出し側ノードの次のノードを返します。

function GetNext: TTreeNode;

説明

呼び出し側ノードが最後のノードの場合，GetNext は nil を返します。表示されないノードや子ノードも含めた次のノードを返します。呼び出し側ノードと同じレベルにある次のノードを取得するには GetNextSibling を使います。表示される次のノードを取得するには GetNextVisible を使います。


TTreeNode.GetNextChild
TTreeNode.GetNextChild3420046

TTreeNode	参照

GetNextChild メソッドは Value の次の子ノードを返します。

function GetNextChild(Value: TTreeNode): TTreeNode;

説明

GetNextChild を呼び出すとツリービューの直接の子のリスト内で次のノードの位置を調べられます。呼び出し側ノードに子が存在しないか，Value の後にノードがない場合，GetNextChild は nil を返します。

子ノードのリストに対して繰り返し処理を行うには，GetNextChild を使った方が Item プロパティを使うよりも効率的です。


TTreeNode.GetNextSibling
TTreeNode.GetNextSibling3420047

TTreeNode	参照

GetNextSibling メソッドは，呼び出し側ノードと同じレベルにあるツリービュー内の次のノードを返します。

function GetNextSibling: TTreeNode;

説明

GetNextSibling は，ノードが表示されるかどうかに関係なく，次のノードを返します。子ノードも含めた子ノードを検出するには GetNext を使います。


TTreeNode.GetNextVisible
TTreeNode.GetNextVisible3420048

TTreeNode	参照

GetNextVisible メソッドは，ツリービュー内で呼び出し側ノードより後の表示されている次のノードを返します。

function GetNextVisible: TTreeNode;

説明

GetNextVisible はツリービューで表示されているノードすべてに対して繰り返し処理を行うときに使います。ノードは，その親ノードがすべて展開されている場合に表示されます。


TTreeNode.GetPrev
TTreeNode.GetPrev3420049

TTreeNode	参照

GetPrev メソッドは，ツリービュー内で呼び出し側ノードより 1 つ前のノードを返します。

function GetPrev: TTreeNode;

説明

GetPrev は表示されるかどうかに関係なく，1 つ前のノードを返します。1 つ前の表示ノードを取得するには GetPrevVisible を使います。


TTreeNode.GetPrevChild
TTreeNode.GetPrevChild3420050

TTreeNode	参照

GetPrevChild メソッドは Value の 1 つ前の子ノードを返します。

function GetPrevChild(Value: TTreeNode): TTreeNode;

説明

GetPrevChild を呼び出すと，ツリービューノードの直接の子のリストで 1 つ前のノードの位置を調べられます。呼び出し側のノードに子が存在しないか Value の前にノードが存在しない場合，GetPrevChild は nil を返します。

子ノードのリストに対して繰り返し処理を行うには，GetPrevChild を使った方が Item プロパティを使うよりも効率的です。


TTreeNode.GetPrevSibling
TTreeNode.GetPrevSibling3420051

TTreeNode	参照

GetPrevSibling メソッドは，呼び出し側ノードの 1 つ前の同じレベルのノードを返します。

function GetPrevSibling: TTreeNode;

説明

GetPrevSibling は 1 つ前の兄弟ノードが表示されているかどうかに関係なくそれを返します。すべてのレベルを含むツリービューで 1 つ前のノードを検索するには，GetPrev を使います。


TTreeNode.GetPrevVisible
TTreeNode.GetPrevVisible3420052

TTreeNode	参照

GetPrevChild メソッドは呼び出し側のノードで表示されている 1 つ前の子ノードを返します。

function GetPrevVisible: TTreeNode;

説明

表示されないノードも含めた 1 つ前のノードを取得するには GetPrev を使います。


TTreeNode.HasAsParent
TTreeNode.HasAsParent3420053

TTreeNode	参照

HasAsParent メソッドは，Value が呼び出し側ノードの親ノードの場合に True を返します。

function HasAsParent(Value: TTreeNode): Boolean;

説明

HasAsParent メソッドを使うと，ノードが特定のノードの親かどうかを判別できます。


TTreeNode.IndexOf
TTreeNode.IndexOf3420054

TTreeNode	参照

IndexOf メソッドは呼び出し側ノードの直接の子ノードの位置を返します。

function IndexOf(Value: TTreeNode): Integer;

説明

IndexOf を呼び出すと，呼び出し側ノードの子の位置を取得できます。Value が呼び出し側ノードの直接の子でない場合は IndexOf は -1 を返します。最初の子ノードのインデックスは 0，2 番目のインデックスは 1 となります。


TTreeNode.MakeVisible
TTreeNode.MakeVisible3420055

TTreeNode	参照

MakeVisible メソッドはノードの親ノードを展開します。

procedure MakeVisible;

説明

1 つまたは複数の親ノードが折りたたまれているために表示されていないノードの場合，MakeVisible はそのノードが見えるようにするために親を展開します。


TTreeNode.MoveTo
TTreeNode.MoveTo3420056

TTreeNode	参照

MoveTo メソッドはツリービュー上でノードを別の位置まで移動します。

procedure MoveTo(Destination: TTreeNode; Mode: TNodeAttachMode);

説明

Destination パラメータはノードをどこまで移動するかを決めます。Mode パラメータは TNodeAttachMode 型で，ノードを移動する方法を指定します。Mode パラメータには次の値を指定できます。

値	意味

naAdd	ノードをリストの末尾に追加する

naAddFirst	ノードをリストの先頭に追加する

naAddChild	ノードをターゲットの子として子ノードのリストの末尾に追加する

naAddChildFirst	ノードをターゲットの子として子ノードのリストの先頭に追加する

naInsert	ノードをターゲットノードの後ろに挿入する

次の手続きは，ノードがドラッグアンドドロップのターゲットとして離されたときに MoveTo を使ってどのようにしてノードをツリービューに挿入するかを示します。

procedure TForm1.TreeView1DragDrop(Sender, Source: TObject; X, Y: Integer);

var

  AnItem: TTreeNode;

  AttachMode: TNodeAttachMode;

  HT: THitTests;

begin

  if TreeView1.Selected = nil then Exit;

  HT := TreeView1.GetHitTestInfoAt(X, Y);

  AnItem := TreeView1.GetNodeAt(X, Y);

  if (HT - [htOnItem, htOnIcon, htNowhere, htOnIndent] <> HT) then

  begin

    if (htOnItem in HT) or (htOnIcon in HT) then AttachMode := naAddChild

    else if htNowhere in HT then AttachMode := naAdd

    else if htOnIndent in HT then AttachMode := naInsert;

    TreeView1.Selected.MoveTo(AnItem, AttachMode);

  end;

end;


読み出し／書き込み3420057

読み出し専用


継承3420058

TObject

TPersistent


TTreeNode 例3420059

TTreeNode


TTreeNodes
TTreeNodes3421001

継承	プロパティ	メソッド	参照

ユニット

comctrls

TTreeNodes オブジェクトはツリービューコントロール内のツリーノードのリストを保持します。

説明

ツリービューコントロールの Items プロパティは TTreeNodes オブジェクトで，ツリービューのノードのコレクションを保持します。ノードはツリービュー内で追加，削除，挿入，および移動できます。ツリービューのノードへのアクセスにはツリービューの Item プロパティを使います。


TTreeNodes プロパティ3421002

TTreeNodes	アルファベット順	凡例

TTreeNodes

Count

Handle

Item

Owner


TTreeNodes プロパティ3421003

TTreeNodes	オブジェクト順	凡例

Count

Handle

Item

Owner


TTreeNodes.Count
TTreeNodes.Count3421004

TTreeNodes	参照

Count プロパティは，TTreeNodes オブジェクトが保守するノード数を示します。

property Count: Integer;

説明

Count プロパティは，ツリーノードオブジェクトを所有しているツリービュー内のツリーノード数を取得できます。Count は，Item プロパティ配列のエントリに対して繰り返し処理を実行するときの上限値として使用できます。


TTreeNodes.Handle
TTreeNodes.Handle3421005

TTreeNodes	参照

Handle プロパティは，ツリーノードオブジェクトを所有しているツリービューコントロールのウィンドウハンドルです。

property Handle: HWND;

説明

Handle プロパティは，ツリーノードオブジェクトを所有するツリービューのハンドルを取得できます。


TTreeNodes.Item
TTreeNodes.Item3421006

TTreeNodes	参照

Item プロパティは，TTreeNodes オブジェクトによって管理されるすべてのツリーノードのインデックス配列です。

property Item[Index: Integer]: TTreeNode; default;

説明

Item プロパティは，ツリービュー内の位置によってノードにアクセスできます。最初のノードのインデックスは 0，2 番目のインデックスは 1 などとなります。Item は TTreeNodes のデフォルトプロパティです。つまり，ツリーノードのセットにインデックス付けするときに Item プロパティの名前を省略してもかまいません。したがって次の行の

FirstNode := TreeView1.Items.Item[0];

は次のように記述できます。

FirstNode := TreeView1.Items[0];

注意

インデックスを使ってツリービューにアクセスすると，特にツリービュー内の項目が多いときには時間がかかる場合があります。最大の性能を引き出すには，アプリケーションがツリービューの項目インデックスにできるだけ依存しないようにアプリケーションを設計してください。


TTreeNodes.Owner
TTreeNodes.Owner3421007

TTreeNodes	参照

Owner プロパティは，ツリーノードオブジェクトを使って Items プロパティを実現するツリービューコントロールです。

property Owner: TCustomTreeView read FOwner;

説明

Owner プロパティは，TTreeNodes オブジェクトによって保守されるノードを表示するツリービューコントロールにアクセスできます。


TTreeNodes メソッド3421008

TTreeNodes	アルファベット順

TTreeNodes

Add

AddChild

AddChildFirst

AddChildObject

AddChildObjectFirst

AddFirst

AddObject

AddObjectFirst

Assign

BeginUpdate

Clear

Create

Delete

Destroy

EndUpdate

GetFirstNode

GetNode

Insert

InsertObject

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TTreeNodes メソッド3421009

TTreeNodes	オブジェクト順

Add

AddChild

AddChildFirst

AddChildObject

AddChildObjectFirst

AddFirst

AddObject

AddObjectFirst

Assign

BeginUpdate

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Delete

Destroy

Dispatch

EndUpdate

FieldAddress

Free

FreeInstance

GetFirstNode

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetNode

InheritsFrom

InitInstance

Insert

InsertObject

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TTreeNodes.Add
TTreeNodes.Add3421010

TTreeNodes	参照

Add メソッドは，新しいツリーノードをツリービューコントロールに追加します。

function Add(Node: TTreeNode; const S: string): TTreeNode;

説明

ノードは Node パラメータの兄弟ノードの最後に追加されます。S パラメータは新しいノードの Text プロパティを指定します。Add は追加されたノードを返します。ツリービューがソートされている場合，Add は，Node パラメータの兄弟ノードの最後に追加するのではなく，ソート順に従った正しい位置にノードを挿入します。


TTreeNodes.AddChild
TTreeNodes.AddChild3421011

TTreeNodes	参照

Add メソッドは，新しいツリーノードをツリービューに追加します。

function AddChild(Node: TTreeNode; const S: string): TTreeNode;

説明

ノードは Node パラメータで指定したノードの子として追加されます。子ノードの Node リストの最後に追加されます。S パラメータは新しいノードの Text プロパティを指定します。AddChild は追加されたノードを返します。ツリービューがソート済みの場合，AddChild は，Node パラメータの最後の子として追加するのではなく，ソート順に従って正しい位置にノードを挿入します。


TTreeNodes.AddChildFirst
TTreeNodes.AddChildFirst3421012

TTreeNodes	参照

AddChildFirst メソッドは，新しいツリーノードをツリービューに追加します。

function AddChildFirst(Node: TTreeNode; const S: string): TTreeNode;

説明

AddChildFirst を呼び出すと，Node パラメータで指定したノードの最初の子として追加できます。S パラメータは新しいノードの Text プロパティを指定します。追加したノードの後ろのノードは 1 行下に移動し，有効な Index 値で再インデックス付けされます。AddChildFirst は追加したノードを返します。


TTreeNodes.AddChildObject
TTreeNodes.AddChildObject3421013

TTreeNodes	参照

AddChildObject メソッドは，データが入っている新しいツリーノードをツリービューに追加します。

function AddChildObject(Node: TTreeNode; const S: string; Ptr: Pointer):TTreeNode;

説明

ノードは Node パラメータで指定したノードの最後の子として追加されます。S パラメータは新しいノードの Text プロパティを指定します。 Ptr パラメータは新しいノードの Data プロパティ値を指定します。AddChildObject は追加されたノードを返します。

注意

ツリーノードオブジェクトが解放されても，Ptr が参照するメモリは解放されません。


TTreeNodes.AddChildObjectFirst
TTreeNodes.AddChildObjectFirst3421014

TTreeNodes	参照

AddChildObjectFirst メソッドは，データが入っている新しいツリーノードをツリービューに追加します。

function AddChildObjectFirst(Node: TTreeNode; const S: string; Ptr: Pointer): TTreeNode;

説明

ノードは Node パラメータで指定したノードの最初の子として追加されます。追加したノードの後ろのノードは 1 行下に移動し，有効な Index 値で再インデックス付けされます。S パラメータは新しいノードの Text プロパティを指定します。S パラメータは新しいノードの Text プロパティを指定します。Ptr パラメータは新しいノードの Data プロパティ値を指定します。AddChildObjectFirst は追加されたノードを返します。

注意

ツリーノードオブジェクトが解放されても，Ptr が参照するメモリは解放されません。


TTreeNodes.AddFirst
TTreeNodes.AddFirst3421015

TTreeNodes	参照

AddFirst メソッドは，新しいツリーノードをツリービューに追加します。

function AddFirst(Node: TTreeNode; const S: string): TTreeNode;

説明

ノードは Node パラメータが指定したノードの最初の兄弟として追加されます。指定したノードの後ろのノードは 1 行下に移動し，有効な Index 値で再インデックス付けされます。S パラメータは新しいノードの Text プロパティを指定します。AddFirst は追加されたノードを返します。


TTreeNodes.AddObject
TTreeNodes.AddObject3421016

TTreeNodes	参照

AddObject メソッドは，データが入っている新しいツリーノードをツリービューに追加します。

function AddObject(Node: TTreeNode; const S: string; Ptr: Pointer): TTreeNode;

説明

ノードは Node パラメータが指定したノードの最後の兄弟として追加されます。S パラメータは新しいノードの Text プロパティを指定します。Ptr パラメータは新しいノードの Data プロパティを指定します。AddObject は追加されたノードを返します。

注意

ツリーノードオブジェクトが解放されても，Ptr が参照するメモリは解放されません。


TTreeNodes.AddObjectFirst
TTreeNodes.AddObjectFirst3421017

TTreeNodes	参照

AddObjectFirst メソッドは，データが入っている新しいツリーノードをツリービューに追加します。

function AddObjectFirst(Node: TTreeNode; const S: string; Ptr: Pointer): TTreeNode;

説明

ノードは Node パラメータで指定するノードが属しているリストの最初に追加されます。追加したノードの後ろのノードは 1 行下へ移動し，有効な Index の値で再インデックス付けされます。S パラメータは新しいノードの Text プロパティを指定します。Ptr パラメータは新しいノードの Data プロパティ値を指定します。AddObjectFirst は追加したノードを返します。


TTreeNodes.Assign
TTreeNodes.Assign3421018

TTreeNodes	参照

Assign メソッドは，現在のプロパティ情報を破棄し，Source の情報に置き換えます。

procedure Assign(Source: TPersistent);

説明

Assign メソッドを呼び出すと，ツリーノードの情報を別のツリーノードにコピーできます。Source が TTreeNodes オブジェクト以外のオブジェクトの場合，Assign はその継承されたメソッドを呼び出し，それが AssignTo を使って TTreeNodes オブジェクトにコピーできるオブジェクトからプロパティをコピーします。


TTreeNodes.BeginUpdate
TTreeNodes.BeginUpdate3421019

TTreeNodes	参照

BeginUpdate メソッドは，EndUpdate メソッドが呼び出されるまでツリーノードの更新を抑制します。

procedure BeginUpdate;

説明

BeginUpdate はツリーノードが追加，削除，または挿入されても画面をリペイントしません。変更されたツリーノードの Index 値は EndUpdate が呼び出されるまで無効です。

BeginUpdateを使うと，ツリービューにノードを追加しているときに画面のリペイントを抑制するとともに処理時間を短縮できます。

注意:

BeginUpdate の呼び出しは累積的なので，BeginUpdate の呼び出しには対応する EndUpdate の呼び出しが必要です。


TTreeNodes.Clear
TTreeNodes.Clear3421020

TTreeNodes	参照

Clear メソッドは，TTreeNodes によって保守されるリストからすべてのツリーノードを削除します。

procedure Clear;

説明

Clear メソッドを使うとツリービューのすべてのノードを削除できます。


TTreeNodes.Create
TTreeNodes.Create3421021

TTreeNodes	参照

Create メソッドは，TTreeNodes オブジェクトのインスタンスを作成します。

constructor Create(AOwner: TCustomTreeView);

Create を呼び出すと実行時に TTreeNodes オブジェクトをインスタンス化できます。TTreeView が使う TTreeNodes オブジェクトは，ツリービューオブジェクトのコンストラクタから自動的に作成されます。

継承されたコンストラクタの呼び出し後，Create はツリーノードオブジェクトの Owner プロパティを AOwner パラメータに設定します。


TTreeNodes.Delete
TTreeNodes.Delete3421022

TTreeNodes	参照

Delete メソッドは，ツリーノードをツリービューから削除します。

procedure Delete(Node: TTreeNode);

説明

Delete メソッドは Node パラメータで指定されたツリービュー内のツリーノードを削除します。

例

次のコードはユーザーがツリービュー内の項目の上にあるボタンをクリックすると，ツリービュー内の点（X，Y）にある項目を削除します。

procedure TForm1.TreeView1MouseDown(Sender: TObject; Button:
  TMouseButton; Shift: TShiftState; X, Y: Integer);

var

  HT : THitTests;

begin

  if (CheckBox1.Checked and (Sender is TTreeView)) then

    begin

      HT := TreeView1.GetHitTestInfoAt(X,Y);

      if (htOnItem in HT) then

        TreeView1.Items.Delete(TreeView1.GetNodeAt(X,Y));

    end;

end;


TTreeNodes.Destroy
TTreeNodes.Destroy3421023

TTreeNodes	参照

Destroy メソッドは，TTreeNodes のインスタンスを破棄します。

destructor TTreeNode.Destroy;

説明

アプリケーションで Destroy を直接呼び出さないでください。TTreeNodes オブジェクトを所有するツリービューは Free メソッドを呼び出してツリーノードオブジェクトを破棄します。Free は TTreeNodes オブジェクトが解放済みでないことを確認してからのみ，Destroy を呼び出します。


TTreeNodes.EndUpdate
TTreeNodes.EndUpdate3421024

TTreeNodes	参照

EndUpdate メソッドは，BeginUpdate メソッドでオフにした画面の再ペイントとノードの再インデックス付けを可能にします。

procedure EndUpdate;

説明

EndUpdate メソッドは，BeginUpdate が呼び出された後で画面の更新ができます。BeginUpdate への呼び出しは累積していくので，BeginUpdate を呼び出してそれに対応する EndUpdate がすでに呼び出されている場合，EndUpdate を呼び出してもツリービューが更新されるだけです。


TTreeNodes.GetFirstNode
TTreeNodes.GetFirstNode3421025

TTreeNodes	参照

GetFirstNode メソッドは，ツリービュー内の最初のツリーノードを返します。

function GetFirstNode: TTreeNode;

説明

GetFirstNode メソッドを呼び出すとツリービュー内の最初のツリーノードを取得できます。GetFirstChild は Item[0]の値を返します。


TTreeNodes.GetNode
TTreeNodes.GetNode3421026

TTreeNodes	参照

GetNode メソッドは，ツリーノードの ItemId からツリーノードを返します。

function GetNode(ItemId: HTreeItem): TTreeNode;

説明

ItemId はツリービュー内のノードへのハンドルです。


TTreeNodes.Insert
TTreeNodes.Insert3421027

TTreeNodes	参照

Insert メソッドは，ツリービュー内の Node パラメータで指定したノードの後にノードを挿入します。

function Insert(Node: TTreeNode; const S: string): TTreeNode;

説明

Insert を呼び出すと新しい兄弟ノードを Node パラメータに Node の後の位置で追加できます。S パラメータは新しいノードの Text プロパティを指定します。Insert は新しいノードを返します。


TTreeNodes.InsertObject
TTreeNodes.InsertObject3421028

TTreeNodes	参照

InsertObject メソッドは，新しいデータ付きのツリーノードをツリービュー内の Node パラメータで指定したノードの後に挿入します。

function InsertObject(Node: TTreeNode; const S: string; Ptr: Pointer): TTreeNode;

説明

InsertObject を呼び出すと新しい兄弟ノードを Node パラメータに Node の後の位置で追加できます。S パラメータは新しいノードの Text プロパティを指定します。Insert は新しいノードを返します。Ptr パラメータは新しいノードの Data プロパティを指定します。InsertObject は新しいノードを返します。

注意

ツリーノードオブジェクトが解放されても，Ptr が参照するメモリは解放されません。


読み出し／書き込み3421029

読み出し専用


継承3421030

TObject

TPersistent


TTreeNodes 例3421031

TTreeNodes


TTreeView
TTreeView3422001

継承	プロパティ	メソッド	イベント	参照

ツリービューコントロールは文書の見出し，インデックスのエントリ，またはディスク上のファイルやディレクトリなどの項目を階層的リストとして表示するウィンドウです。

ユニット

comctrls

説明

ツリービューコントロール内の各ノードは，ラベルとオプションのビットマップイメージからなります。各ノードには関連するサブノードのリストが含まれることもあります。ユーザーはノードをクリックして，関連のサブノードのリストを展開したり，縮小（折りたたみ）したりできます。このコントロールは，データベースエクスプローラの左ペインでも使用しています。


TTreeView プロパティ3422002

TTreeView	アルファベット順	凡例

TTreeView

ReadOnly

TCustomTreeView からの継承

BorderStyle

DragMode

DropTarget

HideSelection

Images

Indent

Items

RightClickSelect

Selected

ShowButtons

ShowLines

ShowRoot

SortType

StateImages

TopItem

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

Handle

HelpContext

ParentCtl3D

パプリック	ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

Color

ControlState

ControlStyle

Cursor

DragCursor

Enabled

Font

Height

Hint

Left

Name

Parent

ParentColor

ParentFont

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TTreeView プロパティ3422003

TTreeView	オブジェクト順	凡例

パプリック	ParentWindow

Align

BorderStyle

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

Color

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DesignInfo

DragCursor

DragMode

DropTarget

Enabled

Font

Handle

Height

HelpContext

HideSelection

Hint

Images

Indent

Items

Left

Name

Owner

Parent

ParentColor

ParentCtl3D

ParentFont

ParentShowHint

PopupMenu

ReadOnly

RightClickSelect

Selected

ShowButtons

ShowHint

Showing

ShowLines

ShowRoot

SortType

StateImages

TabOrder

TabStop

Tag

Top

TopItem

VCLComObject

Visible

Width

WindowProc


TTreeView イベント3422004

TTreeView	アルファベット順	凡例

TCustomTreeView からの継承

OnChange

OnChanging

OnCollapsed

OnCollapsing

OnCompare

OnDeletion

OnEdited

OnEditing

OnExpanded

OnExpanding

OnGetImageIndex

OnGetSelectedIndex

TWinControl からの継承

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp

TControl からの継承

OnClick

OnDblClick

OnDragDrop

OnDragOver

OnEndDrag

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TTreeView イベント3422005

TTreeView	オブジェクト順	凡例

OnChange

OnChanging

OnClick

OnCollapsed

OnCollapsing

OnCompare

OnDblClick

OnDeletion

OnDragDrop

OnDragOver

OnEdited

OnEditing

OnEndDrag

OnEnter

OnExit

OnExpanded

OnExpanding

OnGetImageIndex

OnGetSelectedIndex

OnKeyDown

OnKeyPress

OnKeyUp

OnMouseDown

OnMouseMove

OnMouseUp

OnStartDrag


TTreeView メソッド3422006

TTreeView	アルファベット順

TCustomTreeView からの継承

AlphaSort

Create

CustomSort

Destroy

FullCollapse

FullExpand

GetHitTestInfoAt

GetNodeAt

IsEditing

LoadFromFile

LoadFromStream

SaveToFile

SaveToStream

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CtreateParented

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TTreeView メソッド3422007

TTreeView	オブジェクト順

AlphaSort

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CtreateParented

CustomSort

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

FullCollapse

FullExpand

GetHitTestInfoAt

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetNodeAt

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

IsEditing

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

SaveToFile

SaveToStream

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


スコープ3422008

published

読み出し／書き込み

読み出し専用


スコープ3422009

published


継承3422010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomTreeView


TTreeView 例3422011

TTreeView


TTypedComObjectFactory
TTypedComObjectFactory3423001

継承	プロパティ	メソッド

TTypedComObjectFactory はTypedComObject クラスをインスタンス化するときに使うクラスファクトリオブジェクトの型です。

ユニット

comobj

説明

TTypedComObjectFactory は IUnknown，IClassFactory，および IClassFactory2 の各インターフェースのサポートを継承します。TTypedComObjectFactory は TTypedComObject クラスをインスタンス化するときに使います。


TTypedComObjectFactory のプロパティ3423002

TTypedComObjectFactory	アルファベット順	凡例

TTypedComObjectFactory

ClassInfo

TComObjectFactory からの継承

ClassID

ClassName

ComClass

ComServer

Description

ErrorIID

Instancing

LicString

ProgID

ShowErrors

SupportsLicensing


TTypedComObjectFactory のプロパティ3423003

TTypedComObjectFactory	オブジェクト順	凡例

ClassID

ClassInfo

ClassName

ComClass

ComServer

Description

ErrorIID

Instancing

LicString

ProgID

ShowErrors

SupportsLicensing


TTypedComObjectFactory.ClassInfo
TTypedComObjectFactory.ClassInfo3423004

TTypedComObjectFactory

ClassInfo プロパティは，タイプライブラリをロードせずに型情報を提供できるインターフェース参照です。

property ClassInfo: ITypeInfo;

説明

ClassInfo プロパティは ITypeInfo の型であり，通常はオブジェクトに関する情報を取得するときに使うインターフェースです。ITypeInfo を使うと，タイプライブラリからオブジェクトの特性や機能に関する情報を抽出できます。

型情報のインターフェースは，アプリケーションを構築するときに内部的に使うパーツを示すことよりも，外部のクライアントから呼び出されるパーツを示すことを目的にしています。

ITypeInfo インターフェースが提供するアクセスの対象は以下のとおりです。

・	型に関連付けられた関数の記述セット; インターフェースの場合は，インターフェース内のメンバ関数のセットが含まれる

・	型に関連付けられたデータメンバの記述セット; 構造の場合は，型の項目セットが含まれる

・	構造やインターフェースなどを記述するかどうかといった，型の一般的な属性

ITypeInfo インスタンスは型に関するさまざまな情報を提供し，さまざまなケースで使うことができます。コンパイラでは ITypeInfo を使って型のメンバへの参照をコンパイルすることができます。型インターフェースブラウザでは ITypeInfo を使って型の各メンバに関する情報を検索することができます。

注意

IDispatch インプリメンタではITypeInfo を使ってインターフェースへの IDispatch 呼び出しの自動委任を提供することができます。

注意

タイプライブラリは型を記述するためのコンテナです。タイプライブラリは 1 つまたは複数のオブジェクトの記述を格納し，ITypeLib インターフェースを介してアクセスされます。ITypeLib インターフェースは，タイプライブラリ内の型の記述に関する情報へのアクセスを提供します。個々のオブジェクトの記述は ITypeInfo インターフェースを介してアクセスされます。


TTypedComObjectFactory のメソッド3423005

TTypedComObjectFactory	アルファベット順

TTypedComObjectFactory

Create

GetInterfaceTypeInfo

UpdateRegistry

TComObjectFactory からの継承

CreateComObject

Destroy

RegisterClassObject

TObject からの継承

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TTypedComObjectFactory のメソッド3423006

TTypedComObjectFactory	オブジェクト順

ClassNameIs

ClassParent

ClassType

CleanupInstance

CreateComObject

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

GetInterfaceTypeInfo

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

RegisterClassObject

SafeCallException

UpdateRegistry


TTypedComObjectFactory.Create
TTypedComObjectFactory.Create3423007

TTypedComObjectFactory	参照

Create メソッドは，TTypedComObjectFactory オブジェクトをインスタンス化します。

constructor Create(ComServer: TComServerObject; TypedComClass: TTypedComClass; const ClassID: TGUID; Instancing: TClassInstancing);

説明

Create メソッドは，TTypedComObjectFactory をインスタンス化するときに使います。Create は，TTypedComObject 用のクラス定義を格納する COM サーバーがロードされるときに自動的に呼び出されます。Class の各ファクトリは，関連付けられたサーバーを格納するユニットの初期化セクションでインスタンス化する必要があります。

Create は TTypedComObjectFactory 用のメモリを割り当て，継承された Createを呼び出す前にタイプライブラリが存在し利用可能であることを確認します。型情報が利用できない場合は EOleSysError 例外が生成されます。


TTypedComObjectFactory.GetInterfaceTypeInfo
TTypedComObjectFactory.GetInterfaceTypeInfo3423008

TTypedComObjectFactory

GetInterfaceTypeInfo メソッドは，ファクトリで作成された COM 型オブジェクトの型情報を取得します。

function GetInterfaceTypeInfo(TypeFlags: Integer): ITypeInfo;

説明

GetInterfaceTypeInfo メソッドは，ファクトリで作成される TTypedComObject インスタンスに関する型情報を取得するときに呼び出されます。


TTypedComObjectFactory.UpdateRegistry
TTypedComObjectFactory.UpdateRegistry3423009

TTypedComObjectFactory	参照

UpdateRegistry メソッドは，COM 型オブジェクトのクラスを登録します。

procedure UpdateRegistry(Register: Boolean); override;

説明

UpdateRegistry メソッドは，EXE が実行されているときには 各 EXE で呼び出され，特にサーバーを登録したり登録解除したりするためのルーチンが呼び出されているときには各 DLL または各 EXE で呼び出されます。


アクセス種別3423010

読み出し専用


継承3423011

TObject

TComObjectFactory


TTypedComObjectFactory の例3423012

TTypedComObjectFactory


TTypedComObject
TTypedComObject3424001

継承	プロパティ	メソッド

TTypedComObject は IProvideClassInfo インターフェースをサポートし，タイプライブラリのロードを要求しないで型情報を提供できる COM オブジェクト用のクラス型です。

ユニット

comobj

説明

TTypedComObject は，クラス識別子（CLSID）などのオブジェクトについての情報が不明な場合に，そのオブジェクトが自身のインターフェースおよび型を説明できるようにする IProvideClassInfo インターフェースをサポートします。TTypedComObject は IProvideClassInfo インターフェース用のタイプライブラリを必要とします。このクラスは，デュアルインターフェース（Delphi がデフォルトで作成します）をサポートできるように，タイプライブラリを必要とする設計になっています。

IProvideClassInfo には TTypedComObject で実装される GetClassInfo メソッドがあり，このメソッドはタイプライブラリに入っているオブジェクトの CoClass の型情報へのアクセスを提供します。つまり，TTypedComObject がインスタンスを実行している場合，クライアントは IProvideClassInfo インターフェースに問い合わせれば，タイプライブラリをロードして操作し，オブジェクトの CoClass の ITypeInfo ポインタを検索しなくても型情報を取り出すことができます。

TTypedComObject をオブジェクトの基本クラスとして使うと，ドラッグアンドドロップ操作で不明のオブジェクトを受け取った場合などに，タイプライブラリをロードしなくても型情報を提供できるので便利です。IProvideClassInfo を実現しなくてはならないオブジェクトは，ActiveX コントロールなどのカスタムイベントを利用するオブジェクトだけです。

注意

特定の言語での型情報は提供されません。現在のマシンでのユーザーの地域設定に正しく対応した型情報がロードされているものとみなされます。

IProvideClassInfo の実装済みメソッド

GetClassClassInfo.


TTypedComObject のプロパティ3424002

TTypedComObject	アルファベット順	凡例

TComObject からの継承

Controller

Factory

RefCount


TTypedComObject のプロパティ3424003

TTypedComObject	オブジェクト順	凡例

Controller

Factory

RefCount


TTypedComObject のメソッド3424004

TTypedComObject	アルファベット順

TComObject からの継承

Create

CreateAggregated

CreateFromFactory

Destroy

Initialize

ObjAddRef

ObjQueryInterface

ObjRelease

SafeCallException

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TTypedComObject のメソッド3424005

TTypedComObject	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

CreateAggregated

CreateFromFactory

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

Initialize

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ObjAddRef

ObjQueryInterface

ObjRelease

SafeCallException


アクセス種別3424006

読み出し専用


継承3424007

TObject

TComObject


TTypedComObject の例3424008

TTypedComObject


EUnsupportedTypeError
EUnsupportedTypeError3426001

継承	プロパティ	メソッド	参照

EUnsupportedTypeError は，デシジョンキューブのキャッシュに次元を追加するときに発生したエラーの例外クラスです。

ユニット

mxarrays

説明

EUnsupportedTypeError は，無効な項目型がデシジョンキューブでアクティブな次元として選択されると生成されます。たとえば，BLOB 項目に対応する次元をアクティブにすると EUnsupportedTypeError が生成されます。


EUnsupportedTypeError のプロパティ3426002

EUnsupportedTypeError	アルファベット順

Exception からの継承

HelpContext

Message


EUnsupportedTypeError のプロパティ3426003

EUnsupportedTypeError	オブジェクト順

HelpContext

Message


EUnsupportedTypeError のメソッド3426004

EUnsupportedTypeError	アルファベット順

Exception からの継承

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EUnsupportedTypeError のメソッド3426005

EUnsupportedTypeError	オブジェクト順

ClassInfo

ClassNameIs

ClassName

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

FreeInstance

Free

GetInterfaceEntry

GetInterfaceTable

GetInterface

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


継承3426006

TObject

Exception


EUnsupportedTypeError の例3426007

EUnsupportedTypeError


TUpdateSQL
TUpdateSQL3427001

継承	プロパティ	メソッド	参照	例

TUpdateSQL オブジェクトは，キャッシュアップデートが使用可能なときに，読み出し専用のデータセットを更新するために使われます。

ユニット

dbtables

説明

TUpdateSQL オブジェクトは，キャッシュアップデートが使用可能なときに TQuery コンポーネントで表される読み出し専用のデータセットの更新に使う SQL 文を提供します。データセットが読み出し専用であるのは，設計によるものか，状況によるもののいずれかです。設計によってデータセットが読み出し専用であるならば，アプリケーション自身はデータを更新するためのユーザーインターフェイスを提供しませんが，見えないところでデータを更新するプログラムがあるかもしれません。状況によってデータセットが読み出し専用であるならば，ボーランドデータベースエンジン（BDE）が読み出し専用の結果を返したことを示します。これは複数のテーブルに対して問い合わせをしたときに起こります。そうした問い合わせは，SQL-92 の定義によって読み出し専用となります。

TUpdateSQL は，SQL-92 の制限とも考えられているこの動作を迂回する仕組みを提供します。これによって，開発者は読み出し専用の結果に対して別々の更新用の問い合わせを実行するための INSERT，UPDATE，DELETE 文を提供でき，エンドユーザーに対する透過性を保ちます。

実用的なアプリケーションでは，TUpdateSQL オブジェクトはデータモジュールまたはデータフォーム上に置かれ，UpdateSQL プロパティを使って TQuery コンポーネントとリンクされています。UpdateSQL プロパティが有効な TUpdateSQL オブジェクトを指している場合， 更新オブジェクトに属している SQL 文は，キャッシュアップデートが適用されるときに自動的に適用されます。


TUpdateSQL プロパティ3427002

TUpdateSQL	アルファベット順	凡例

TUpdateSQL

DataSet

DeleteSQL

InsertSQL

ModifySQL

Query

SQL

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TUpdateSQL プロパティ3427003

TUpdateSQL	オブジェクト順	凡例

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DataSet

DeleteSQL

DesignInfo

InsertSQL

ModifySQL

Name

Owner

Query

SQL

Tag

VCLComObject


TUpdateSQL.DataSet
TUpdateSQL.DataSet3427004

TUpdateSQL	参照

DataSet プロパティは，TUpdateSQL コンポーネントが属するデータセットを示します。

property DataSet: TDataSet;

説明

DataSet プロパティは，データセットオブジェクトの UpdateSQL プロパティを更新オブジェクトの名前に設定するときに DataSet を使うデータセットオブジェクトを識別するために，設計時に自動的に設定されます。アプリケーションがこのプロパティを設定する必要があるのは，実行時に新しい TUpdateSQL コンポーネントを生成する場合だけです。


TUpdateSQL.DeleteSQL
TUpdateSQL.DeleteSQL3427005

TUpdateSQL	参照

DeleteSQL プロパティは，キャッシュにあるレコード削除を適用するときに使う SQL の DELETE 文を指定します。

property DeleteSQL: TStrings;

説明

DeleteSQL プロパティは，レコード削除を適用するとき使う SQL の DELETE 文を設定します。文はパラメータ付きの問い合わせの場合もあります。設計時に DELETE 文を作成するには，UpdateSQL エディタを使って次のような文を作成します。

delete from "COUNTRY.DB"

where

  Name = :OLD_Name

実行時に，アプリケーションは，DELETE 文を設定または変更するために直接このプロパティに文を記述できます。

注意

例に示されているように，DeleteSQL は通常のパラメータの拡張をサポートします。キャッシュされた更新情報が適用される前に項目が持っていた値を取得するには，項目名に「OLD_」を付けます。これは，文の WHERE 節で項目を比較するときに特に便利です。


TUpdateSQL.InsertSQL
TUpdateSQL.InsertSQL3427006

TUpdateSQL	参照

InsertSQL プロパティは，キャッシュされている追加予定のレコードを適用するときに使う SQL INSERT 文を指定します。

property InsertSQL: TStrings;

説明

InsertSQL プロパティは，データセットに追加を適用するときに使う SQL の INSERT 文を設定します。文はパラメータ付きの問い合わせの場合もあります。設計時に INSERT 文を作成するには，UpdateSQL エディタを使って次のような文を作成します。

insert into "COUNTRY.DB"

  (Name, Capital, Continent)

  value (:Name, :Capital, :Continent)

  where :OLD_Name = 'Rangoon'

実行時にアプリケーションは，INSERT 文を設定または変更するために直接このプロパティに文を記述できます。

注意

例に示されているように，InsertSQL は通常のパラメータの拡張をサポートします。キャッシュされた更新情報が適用される前に項目が持っていた値を取得するには，項目名に「OLD_」を付けます。これは，文の WHERE 節で項目を比較するときに特に便利です。


TUpdateSQL.ModifySQL
TUpdateSQL.ModifySQL3427007

TUpdateSQL	参照

ModifySQL プロパティは，レコードへの更新の適用およびキャッシュアップデートが使用可能なときに使う SQL UPDATE 文を指定します。

property ModifySQL: TStrings;

説明

ModifySQL プロパティは，データセットに更新済みレコードを適用するときに使う SQL のUPDATE 文を設定します。文はパラメータ付きの問い合わせの場合もあります。設計時に UPDATE 文を作成するには，UpdateSQL エディタを使って次のような文を作成します。

  update "COUNTRY.DB"

  set Name = :Name, Capital = :Capital, Continent = :Continent

  where Name = :OLD_Name

実行時にアプリケーションは，UPDATE 文を設定または変更するために直接このプロパティに文を記述できます。

注意

例に示されているように，ModifySQL は通常のパラメータの拡張をサポートします。キャッシュされた更新情報が適用される前に項目が持っていた値を取得するには，項目名に「OLD_」を付けます。これは，文の WHERE 節で項目を比較するときに特に便利です。


TUpdateSQL.Query
TUpdateSQL.Query3427008

TUpdateSQL	参照

Query プロパティは，指定した更新の種類を実行するのに使われる問い合わせオブジェクトを返します。

type

  TUpdateKind = (ukModify, ukInsert, ukDelete)

property Query[UpdateKind: TUpdateKind]: TQuery;

説明

Query プロパティは，SQL 更新の特定のフォームを実行するために使う TQuery オブジェクトを返すように設定してください。UpdateKind はどの問い合わせオブジェクトを取得するかを指定します。以下に UpdateKind の値を示します。

値	意味

ukModify	UPDATE	文を実行するのに使う問い合わせオブジェクトを返す

ukInsert	INSERT	文を実行するのに使う問い合わせオブジェクトを返す

ukDelete	DELETE	文を実行するのに使う問い合わせオブジェクトを返す

各問い合わせオブジェクトは特定の SQL 文を実行します。これらのオブジェクトで実行される SQL 文の内容には，ModifySQLプロパティ，InsertSQL プロパティ，および DeleteSQL プロパティを使って直接アクセスできます。

Query の主な目的は，更新問い合わせオブジェクトのプロパティを設定したり，問い合わせメソッドを呼び出したりする方法をアプリケーションに提供することです。

注意

指定の更新文がない場合，対応する問い合わせオブジェクトは nil になります。たとえば，アプリケーションが DeleteSQLプロパティ の SQL 文を提供しない場合，Query[ukDelete] を設定すると nil が返されます。


TUpdateSQL.SQL
TUpdateSQL.SQL3427009

TUpdateSQL	参照

SQL プロパティは，キャッシュされた更新情報を適用する時に使われる指定の SQL 文を返します。

type

  TUpdateKind = (ukModify, ukInsert, ukDelete)

property SQL[UpdateKind: TUpdateKind]: TStrings;

説明

SQL プロパティは，UpdateKind の設定によって ModifySQL プロパティ，InsertSQL プロパティ，または DeleteSQL プロパティの SQL 文を返します。以下に UpdateKind の値を示します。

値	意味

ukModify	データセット内のレコードを更新するために使う SQL 文を返す

ukInsert	データセット内に新しいレコードを挿入するために使う SQL 文を返す

ukDelete	データセット内のレコードを削除するために使う SQL 文を返す


TUpdateSQL メソッド3427010

TUpdateSQL	アルファベット順

TUpdateSQL

Apply

Create

Destroy

ExecSQL

SetParams

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TUpdateSQL メソッド3427011

TUpdateSQL	オブジェクト順

Apply

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecSQL

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException

SetParams


TUpdateSQL.Apply
TUpdateSQL.Apply3427012

TUpdateSQL	参照

Apply メソッドは，指定された SQL 文に対応するパラメータを設定し，その文を実行します。

type

  TUpdateKind = (ukModify, ukInsert, ukDelete)

procedure Apply(UpdateKind: TUpdateKind);

説明

Apply メソッドを呼び出すと，SQL 文のパラメータを設定し，それをレコードの更新のために実行できます。UpdateKind はどの SQL 文を結合システム実行するかを指定し，次の値をとります。

値	意味

ukModify	ModifySQL プロパティの SQL 文を結合，実行する

ukInsert	InsertSQL プロパティの SQL 文を結合，実行する

ukDelete	DeleteSQL プロパティの SQL 文を結合，実行する

Apply の主な目的は OnUpdateRecord イベントハンドラの更新文をマニュアルで実行することです。

注意

SQL 文パラメータがない場合，Apply の代わりに ExecSQL を呼び出すほうが効率的です。


TUpdateSQL.ExecSQL
TUpdateSQL.ExecSQL3427015

TUpdateSQL	参照

ExecSQL メソッドは，キャッシュアップデートが使用可能なときに他の場合には読み出し専用の結果セットを更新するために指定された型の SQL 文を実行します。

type TUpdateKind = (ukModify, ukInsert, ukDelete)

procedure ExecSQL(UpdateKind: TUpdateKind);

説明

ExecSQL メソッドを呼び出すと，キャッシュアップデートが使用可能なときに読み出し専用の結果セットに属するレコードを更新するために必要な SQL 文を実行できます。UpdateKind は実行する文を指定し，指定値は次のとおりです。

値	意味

ukModify	データセット内のレコード更新に使う SQL 文を実行する

ukInsert	データセット内にレコードを挿入するために使う SQL 文を実行する

ukDelete	データセット内のレコード削除に使う SQL 文を実行する

実行する文にパラメータがない場合，アプリケーションは ExecSQL を呼び出す前に，パラメータを結合するために SetParams を呼び出さなくてはなりません。文にパラメータがあるかどうかを判別するには，実行のための文の型によって ModifySQL プロパティ，InsertSQL プロパティ，または DeleteSQL プロパティが正しく設定されているかどうかを調べます。

注意

パラメータを結合し，文を実行するには Apply を呼び出してください。


TUpdateSQL.SetParams
TUpdateSQL.SetParams3427016

TUpdateSQL	参照

SetParams メソッドは，文を実行する前に SQL 文のパラメータを結合します。

type TUpdateKind = (ukModify, ukInsert, ukDelete)

procedure SetParams(UpdateKind: TUpdateKind);

説明

SetParams メソッドを呼び出すと，文を実行する前に更新オブジェクトに関連付けられた SQL 文のパラメータを結合します。UpdateKind はどの型の文のパラメータを結合するかを指定して，次の値をとります。

値	意味

ukModify	レコードの更新に使う SQL 文のパラメータを結合する

ukInsert	レコードの挿入に使う SQL 文のパラメータを結合する

ukDelete	レコードの削除に使う SQL 文のパラメータを結合する

パラメータは SQL 文でコロンによって示されます。パラメータ名の前に付いているコロン以外について，パラメータ名は既存のデータセットの項目名と正確に一致しなければなりません。

注意

パラメータ名は「OLD_」インジケータで始まる場合があります。その場合，更新を実行するためにキャッシュされた更新情報の代わりに項目の古い値が使われます。


スコープ3427017

published

読み出し／書き込み

読み出し専用


継承3427018

TObject

TPersistent

TComponent

TDataSetUpdateObject


TUpDown
TUpDown3428001

継承	プロパティ	メソッド	イベント	参照	例

TUpDown コンポーネントは Windows のアップダウンコントロールのラッパーです。

ユニット

comctrls

説明

TUpDown を使うと，フォームにアップダウンコントロールを追加できます。アップダウンコントロールは 2 つの矢印ボタンからなっており，スピンボックスなどに表示される一組の矢印ボタンのことをいいます。このコントロールを使うと，矢印ボタンをクリックして数値の大きさを変更することができます。


TUpDown プロパティ3428002

TUpDown	アルファベット順	凡例

TCustomUpDown からの継承

AlignButton

ArrowKeys

Associate

Increment

Max

Min

Orientation

Position

Thousands

Wrap

TWinControl からの継承

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Handle

HelpContext

ParentWindow

Showing

TabOrder

TabStop

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ParentShowHint

PopupMenu

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TUpDown プロパティ3428003

TUpDown	オブジェクト順	凡例

Align

AlignButton

ArrowKeys

Associate

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Cursor

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

Increment

Left

Max

Min

Name

Orientation

Owner

Parent

ParentShowHint

ParentWindow

PopupMenu

Position

ShowHint

Showing

TabOrder

TabStop

Tag

Thousands

Top

VCLComObject

Visible

Width

WindowProc

Wrap


TUpDown イベント3428004

TUpDown	アルファベット順	凡例

TCustomUpDown からの継承

OnChanging

OnClick

TWinControl からの継承

OnEnter

OnExit

TControl からの継承

OnMouseDown

OnMouseMove

OnMouseUp


TUpDown イベント3428005

TUpDown	オブジェクト順	凡例

OnChanging

OnClick

OnEnter

OnExit

OnMouseDown

OnMouseMove

OnMouseUp


TUpDown メソッド3428006

TUpDown	アルファベット順

TCustomUpDown からの継承

Create

TWinControl からの継承

Broadcast

CanFocus

ContainsControl

ControlAtPos

CreateParented

Destroy

DisableAlign

EnableAlign

Focused

GetTabOrderList

HandleAllocated

HandleNeeded

InsertControl

Invalidate

PaintTo

Realign

RemoveControl

Repaint

ScaleBy

ScrollBy

SetBounds

SetFocus

Update

UpdateControlState

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TUpDown メソッド3428007

TUpDown	オブジェクト順

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateParented

DefaultHandler

Destroy

DestroyComponents

Destroying

DisableAlign

Dispatch

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTabOrderList

GetTextBuf

GetTextLen

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

MethodAddress

MethodName

NewInstance

PaintTo

Perform

Realign

Refresh

RemoveComponent

RemoveControl

Repaint

SafeCallException

ScaleBy

ScreenToClient

ScrollBy

SendToBack

SetBounds

SetFocus

SetTextBuf

Show

Update

UpdateControlState


スコープ3428008

published

読み出し／書き込み

読み出し専用


スコープ3428009

published


継承3428010

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomUpDown


TUpDown 例3428011

TUpDown


TVarBytesField
TVarBytesField3430001

継承	プロパティ	メソッド	イベント	参照

TVarBytesField オブジェクトは，データセット中の型なし可変長バイナリ項目を表します。

ユニット

db

説明

可変長バイト項目の値は，可変長バイトの集合です。値の実際の長さは，最初の 2 バイトに保存されています。

TVarBytesField とその上位オブジェクト TBinaryField の相違点は，表すデータ型のみです。コンストラクタと DataSize プロパティを除いて，すべてのプロパティ，メソッド，およびイベントは TByteField のものと同じであり，データセットの型なしバイナリデータ項目を管理するのに便利な機能を提供します。


TVarBytesField プロパティ3430002

TVarBytesField	アルファベット順	凡例

TVarBytesField

DataSize

TBinaryField からの継承

AsString

AsVariant

Value

TField からの継承

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TVarBytesField プロパティ3430003

TVarBytesField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TVarBytesField.DataSize
TVarBytesField.DataSize3430004

TVarBytesField	参照

DataSize プロパティは，ネイティブなデータベース形式で可変長バイト項目の値を格納するのに必要なメモリの大きさです。

property DataSize: Word;

説明

DataSize プロパティは，可変長バイト項目コンポーネントの値を格納するのに何バイト必要かを取得できます。GetData や SetData メソッドと共にこのプロパティを使うと，必要なバッファの大きさを決めることができます。

可変長バイト項目の DataSize は常に Size + 2 です。型なしデータの大きさが最大 Size バイトで，後の 2 バイトにその型なしデータの長さが格納されます。


TVarBytesField イベント3430005

TVarBytesField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TVarBytesField イベント3430006

TVarBytesField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TVarBytesField メソッド3430007

TVarBytesField	アルファベット順

TVarBytesField

Create

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TVarBytesField メソッド3430008

TVarBytesField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TVarBytesField.Create
TVarBytesField.Create3430009

TVarBytesField	参照

Create メソッドは，TVarBytesField のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

ほとんどの場合，Create を直接呼び出す必要はありません。なぜなら，VarBytes 項目オブジェクトは，データセット中のすべての可変長バイト項目において，自動的にインスタンス化されるからです。

継承したコンストラクタを呼び出した後で，Create は DataType を ftVarBytes に設定し，Size プロパティを 16 に初期化します。


スコープ3430010

published

読み出し／書き込み

読み出し専用


スコープ3430011

published


継承3430012

TObject

TPersistent

TComponent

TField

TBinaryField

TBytesField


TVarBytesField 例3430013

TVarBytesField


TWebModule
TWebModule3431001

継承	プロパティ	メソッド	イベント	参照

TWebModule は，自動的に生成される Web サーバーアプリケーション用 Web モジュールです。

ユニット

httpapp

説明

新しい Web アプリケーションが作成されると，それは自動的に Web モジュールを保持します。Web モジュールは，TPageProducer，TSession，TTable，TDataSetTableProducer など，非ビジュアルコンポーネントのリポジトリとして機能します。同時に，要求オブジェクトおよび応答オブジェクトを適切なアクション項目に渡すことで，Web サーバーアプリケーションが HTTP 要求メッセージに応答できるようにします。アプリケーションが持つ Web モジュールは 1 つだけです。

TWebModule オブジェクトは，HTTP 要求メッセージへの応答方法を知っているアクション項目の集まりを管理します。Web モジュールが管理するアクション項目を表示，追加，削除するには，TWebModule アイコンをダブルクリックして開くアクションエディタを使います。

アプリケーション用の多数の非ビジュアルコンポーネントとビジネスルールを持つデータモジュールがすでに存在するときは，Web モジュールをそのデータモジュールで置き換えることができます。単純に Web モジュールを削除し，新しいデータモジュールをその場所に挿入した後に，TWebDispatcher オブジェクトを新しいデータモジュールに追加してください。


TWebModule プロパティ3431002

TWebModule	アルファベット順	凡例

TCustomWebDispatcher からの継承

Action

Actions

Request

Response

TDataModule からの継承

DesignOffset

DesignSize

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TWebModule プロパティ3431003

TWebModule	オブジェクト順	凡例

Action

Actions

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

DesignOffset

DesignSize

Name

Owner

Request

Response

Tag

VCLComObject


TWebModule イベント3431004

TWebModule	アルファベット順	凡例

TCustomWebDispatcher からの継承

AfterDispatch

BeforeDispatch

TDataModule からの継承

OnCreate

OnDestroy


TWebModule イベント3431005

TWebModule	オブジェクト順	凡例

AfterDispatch

BeforeDispatch

OnCreate

OnDestroy


TWebModule メソッド3431006

TWebModule	アルファベット順

TWebModule

Create

TCustomWebDispatcher からの継承

ActionByName

Destroy

TDataModule からの継承

CreateNew

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TWebModule メソッド3431007

TWebModule	オブジェクト順

ActionByName

Assign

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateNew

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

MethodAddress

MethodName

NewInstance

RemoveComponent

SafeCallException


TWebModule.Create
TWebModule.Create3431008

TWebModule	参照

Create メソッドは，TWebModule のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

TWebModule の Create メソッドは直接呼び出さないでください。Web モジュールは，Web アプリケーションプロジェクトが設計時に作成された時点で自動的に作成されます。Web サーバーアプリケーションが HTTP 要求メッセージへの応答として実行されるたびに，設計時に作成された Web モジュールに基づいて新しい TWebModule が作成されます。

Create は OnCreate イベントを生成するので，Web アプリケーションは新しい HTTP 要求メッセージが処理される前に Web モジュールを初期化できます。


スコープ3431009

published

読み出し／書き込み

読み出し専用


スコープ3431010

published


継承3431011

TObject

TPersistent

TComponent

TDataModule

TCustomWebDispatcher


TWebModule 例3431012

TWebModule


TWinControl
TWinControl3432001

継承	プロパティ	メソッド	イベント	参照

TWinControl はすべてのウィンドウコントロールの抽象基本クラスです。

ユニット

controls

説明

ウィンドウコントロールは、以下のような特徴を持ちます。

・	アプリケーションの実行中にフォーカスを受け取ることができる

それに対して，ほかのコントロールはデータを表示します。ユーザーがキーボードを使って対話形式でやり取りできるのは，コントロールがウィンドウコントロールの場合だけです。

・	ほかのコントロールを中に収めることができる

ほかのコントロールを中に収めるものを「親」コントロールと呼びます。ウィンドウコントロールだけが，1 つまたは複数のほかの子コントロールの親になることができます。

・	ウィンドウハンドルを持つ

TWinControl クラスから直接新しいコンポーネントを派生させる場合はほとんどありません。新しいコントロールは，キャンバスを提供し描画メッセージを処理する TCustomControl か，あるいはさらに特殊化したコントロールである TButtonControl，TCustomComboBox，TCustomEdit，TCustomListBox などから派生させます。


TWinControl プロパティ3432002

TWinControl	アルファベット順	凡例

TWinControl

Brush

ClientOrigin

ClientRect

ControlCount

Controls

Ctl3D

DefWndProc

Handle

HelpContext

ImeMode

ImeName

ParentCtl3D

ParentWindow

Showing

TabOrder

TabStop

WindowHandle

TControl からの継承

Align

BoundsRect

ClientHeight

ClientWidth

ControlState

ControlStyle

Cursor

Enabled

Height

Hint

Left

Name

Parent

ShowHint

Top

Visible

Width

WindowProc

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TWinControl プロパティ3432003

TWinControl	オブジェクト順	凡例

Align

BoundsRect

Brush

ClientHeight

ClientOrigin

ClientRect

ClientWidth

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ControlCount

Controls

ControlState

ControlStyle

Ctl3D

Cursor

DefWndProc

DesignInfo

Enabled

Handle

Height

HelpContext

Hint

ImeMode

ImeName

Left

Name

Owner

Parent

ParentCtl3D

ParentWindow

ShowHint

Showing

TabOrder

TabStop

Tag

Top

VCLComObject

Visible

Width

WindowHandle

WindowProc


TWinControl.Brush
TWinControl.Brush3432004

TWinControl	参照

Brush プロパティは，コントロールの背景を塗りつぶす色と模様を指定します。

property Brush: TBrush;

説明

Brush プロパティは，コントロールの背景のスタイルと色を指定できます。Brush は読み出し専用プロパティですが，これはウィンドウコントロールが 1 つの Brush オブジェクトを所有してその背景の塗りつぶしを処理するためです。ただし，ブラシの属性を変更するには，TBrush オブジェクトの Color プロパティと Style プロパティを使います。さらに，ブラシのすべてのプロパティを変更して別のブラシのものと一致させるには，TBrush オブジェクトの Assign メソッドを使います。


TWinControl.ClientOrigin
TWinControl.ClientOrigin3432005

TWinControl	参照

ClientOrigin プロパティは，コントロールのクライアント領域の左上隅の画面座標（ピクセル単位）を指定します。

TPoint = record

  X: Longint;

  Y: Longint;

end;

property ClientOrigin: TPoint;

説明

ClientOrigin プロパティは，コントロールの左上隅が画面のどの位置にあるか取得できます。ClientOrigin は，TPoint 型のレコードで X 座標と Y 座標を返します。TPoint 型は，コントロールの左上隅を原点とする画面座標（ピクセル単位）で定義します。X は水平座標，Y は垂直座標を指定します。


TWinControl.ClientRect
TWinControl.ClientRect3432006

TWinControl	参照

ClientRect プロパティは，コントロールのクライアント領域のサイズをピクセル数です。

property ClientRect: TRect;

説明

ClientRect プロパティを読み出すと，コントロールのクライアント領域のサイズがわかります。ClientRect はコントロールのクライアント領域を定義する長方形を返します。これは Rect(0, 0, ClientWidth, ClientHeight) に相当します。


TWinControl.ControlCount
TWinControl.ControlCount3432007

TWinControl	参照

ControlCount プロパティは，ウィンドウコントロールの子コントロールの数を示します。

property ControlCount: Integer;

説明

ControlCount プロパティは，このコントロールのすべての子コントロールを繰り返し処理するときに使います。子コントロールは，Controls プロパティ配列に格納されています。

ControlCount は読み出し専用のプロパティです。

注意

Controls インデックスの最初の値は 0 なので，ControlCount の値は Controls インデックスの最大値より常に 1 だけ大きくなります。


TWinControl.Controls
TWinControl.Controls3432008

TWinControl	参照

Controls プロパティは，ウィンドウコントロールのすべての子コントロールの配列です。

property Controls[Index: Integer]: TControl;

説明

Controls プロパティはウィンドウコントロールのすべての子コントロールの配列です。ウィンドウコントロールのすべての子コントロールは，ウィンドウコントロールをその Parent プロパティとして格納します。名前でなく番号で子コントロールを参照する場合に Controls プロパティが役に立ちます。たとえば，Controls を使えばウィンドウコントロールのすべての子コントロールを繰り返し処理できます。

Controls プロパティと Components プロパティを混同しないでください。Components プロパティはコンポーネントが所有するすべてのコンポーネントをリストしますが，Controls プロパティはコントロールの子ウィンドウであるすべてのコントロールをリストします。フォームにあるすべてのコンポーネントはフォームが所有しているので，コンポーネントがフォーム上のコントロールの子ウィンドウであっても，フォームの Components プロパティリストに表示されます。

Controls は読み出し専用プロパティです。子コントロールを追加または削除するには，InsertControl メソッドまたは RemoveControl メソッドを使います。たとえば子コントロールを親の間で移動するには，その子コントロールの Parent を，元の親からの RemoveControl と新しい親への InsertControl の両方を処理するものとして設定します。


TWinControl.Ctl3D
TWinControl.Ctl3D3432009

TWinControl	参照

Ctl3D プロパティは，コントロールが 3 次元または 2 次元のどちらであるかを指定します。

property Ctl3D: Boolean

説明

Ctl3D プロパティは，コントロールの外観を制御できます。Ctl3D が True ならばコントロールは 3 次元です。Ctl3D が False ならばコントロールは2 次元です。Ctl3D のデフォルト値は True です。

コントロールの ParentCtl3D プロパティが True ならばコントロールの親の Ctl3D プロパティを変更するとコントロールの Ctl3D プロパティが自動的に変わります。コントロールの Ctl3D プロパティに直接値を代入すると，コントロールの ParentCtl3D プロパティが自動的に False に設定されます。

注意

Windows NT 3.51 で Ctl3D をラジオボタン，チェックボックス，コモンダイアログボックスに適用するには，CTL3D32.DLL が System32 ディレクトリにインストールされていなければなりません。Windows 95 と NT 4.0 では CTL3D32.DLL は必要ありません。


TWinControl.DefWndProc
TWinControl.DefWndProc3432010

TWinControl	参照

DefWndProc プロパティは，ウィンドウコントロールのデフォルトウィンドウプロシージャを指定します。

property DefWndProc: Pointer;

説明

ウィンドウメッセージの標準 Windows メッセージ処理機能を呼び出すには，Windows API の CallWindowProc 関数を DefWndProc プロパティとともに使います。WndProc メソッドで導入されるメッセージ処理を避けるには，WndProc メソッドのかわりに DefWndProc を使います。

DefWndProc は，DefaultHandler がすべてのオブジェクトに対して果たす役割をウィンドウコントロールに対して果たします。TWinControl の DefaultHandler は DefWndProc を使って，メッセージを Windows に渡して処理させます。

ウィンドウコントロールに対して，DefWndProc は最初は，CreateParams メソッドの Params パラメータで指定されるウィンドウクラスのウィンドウプロシージャに設定されます。DefWndProc を変更して，ウィンドウコントロールのウィンドウクラスを下位クラスにします。


TWinControl.Handle
TWinControl.Handle3432011

TWinControl	参照

Handle プロパティは，コントロールのウィンドウハンドルへのアクセスを提供します。

property Handle: HWND;

説明

Handle プロパティは，ウィンドウハンドルを要求する Windows API 関数呼び出しで使います。

コントロールにウィンドウハンドルがない場合は，アプリケーションが Handle プロパティ値を読み出したときに，Handle プロパティが HandleNeeded メソッドを呼び出してハンドルを 1 つ作成します。このため，コンポーネントを作成またはストリームするときは，Handle プロパティを使わないでください。

Handle は読み出し専用のプロパティです。


TWinControl.HelpContext
TWinControl.HelpContext3432012

TWinControl	参照

HelpContext プロパティは，状況感知型のヘルプの呼び出しに使うコンテキスト番号を指定します。

property HelpContext: THelpContext;

説明

HelpContext プロパティには，〔F1〕キーを押したときにどのヘルプ画面を表示するかを指定する値を割り当てます。

システムの各画面にはユニークなコンテキスト番号がなくてはなりません。アプリケーションでコンポーネントを選択するとき，〔F1〕キーを押してヘルプ画面を表示します。どのヘルプ画面が表示されるかは HelpContext プロパティの値によって決まります。

HelpContext がゼロの場合，コントロールは親コントロールのヘルプコンテキストを引き継ぎます。たとえば，ヘルプコンテキストがゼロ以外のフォームにヘルプコンテキストがゼロのボタンがある場合に〔F1〕キーを押すと，そのフォームのコンテキスト画面が表示されます。


TWinControl.ImeMode
TWinControl.ImeMode3432013

TWinControl	参照

ImeMode プロパティは，IME（かな漢字変換プログラム）の動作を決めます。

TImeMode = (imDisable, imClose, imOpen, imDontCare, imSAlpha, imAlpha, imHira, imSKata,

     imKata, imChinese, imSHanguel, imHanguel);

property ImeMode: TImeMode;

説明

ImeMode プロパティは，IME がユーザーのキーストロークを処理する方法を設定します。IME はアジア地域の言語の文字を処理するためのフロントエンド入力プロセッサです。IME はすべてのキーボード入力を受け取って，変換ウィンドウでアジア地域の言語の文字に変換し，変換した文字または文字列を Delphi アプリケーションに送ります。

ImeMode プロパティを使うと，コントロールが求める入力に対して適切になるように，IME が実行する変換処理の種類を制御できます。たとえば，数値の入力のみを受け入れるコントロールの場合は，変換処理は不要なので，ImeMode プロパティを imClose に設定します。

ImeMode プロパティには以下の値を指定できます。

値	意味

imDisable	IME を終了する。伝統的中国語語，簡体字中国語，韓国語の IME では無効

imClose	IME 変換ウィンドウを閉じる。ただし，IME はバックグラウンドで実行されているため，ホットキーの組み合わせにより再度アクティブ化できる

imOpen	IME 変換ウィンドウを開く。変換モードは IME が前回使った変換モードになる

imDontCare	無効になっている場合は IME を起動する。変換モードは IME が前回使った変換モードになる

imSAlpha	IME 変換ウィンドウを開き，変換モードを半角ローマ字入力を受け入れるように設定する

imAlpha	IME 変換ウィンドウを開き，変換モードを全角ローマ字入力を受け入れるように設定する

imHira	IME 変換ウィンドウを開き，変換モードを全角ひらがな入力を受け入れるように設定する。日本語の IME でのみ有効

imSKata	IME 変換ウィンドウを開き，変換モードを半角カタカナ入力を受け入れるように設定する。日本語の IME でのみ有効

imKata	IME 変換ウィンドウを開き，変換モードを全角カタカナ入力を受け入れるように設定する。日本語の IME でのみ有効

imChinese	IME 変換ウィンドウを開き，変換モードを全角漢字入力を受け入れるように設定する。中国語の IME でのみ有効

imSHanguel	IME 変換ウィンドウを開き，変換モードを半角ハングル文字入力を受け入れるように設定する。朝鮮語の IME でのみ有効

imHanguel	IME 変換ウィンドウを開き，変換モードを全角ハングル文字入力を受け入れるように設定する。朝鮮語の IME でのみ有効

注意

ImeMode プロパティの値は，コントロールにフォーカスがあるときにのみ有効です。ImeMode プロパティの値を変更するには，コントロールにフォーカスがないときに SetIme メソッドを呼び出します。


TWinControl.ImeName
TWinControl.ImeName3432014

TWinControl	参照

ImeName プロパティは，キーボード入力をアジア地域の言語の文字に変換するのに使う IME（かな漢字変換プログラム）を指定します。

TImeName = type string;

property ImeName: TImeName;

説明

ImeName プロパティを設定すると，キーストロークの変換にどの IME を使うかを指定できます。IME はアジア地域の言語の文字を処理するためのフロントエンド入力プロセッサです。IME はすべてのキーボード入力を受け取って，変換ウィンドウでアジア地域の言語の文字に変換し，変換した文字または文字列を Delphi アプリケーションに送ります。

ImeName プロパティには，Windows コントロールパネルでインストールされている IME のいずれかを指定する必要があります。プロパティインスペクタを使うと，現在システムにインストールされている IME のドロップダウンリストを表示できます。実行時にはアプリケーションは現在インストールされている IME のリストをグローバル Screen 変数から取得できます。

ImeName プロパティに使用できない IME を指定すると，アプリケーションの起動時にアクティブだった IME が使われます。例外は生成されません。

注意

ImeName プロパティの値は，コントロールにフォーカスがあるときにのみ有効です。ImeName プロパティの値を変更するには，コントロールにフォーカスがあるときに SetIme メソッドを呼び出します。


TWinControl.ParentCtl3D
TWinControl.ParentCtl3D3432015

TWinControl	参照

ParentCtl3D プロパティは，コンポーネントを 3 次元表示するかどうかを決める根拠を示します。

property ParentCtl3D: Boolean;

説明

ParentCtl3D を使うとフォーム上のすべてのコンポーネントを同じ外観にできます。たとえばフォーム上のすべてのコンポーネントを 3 次元表示にしたければ，フォームの Ctl3D プロパティを True に，各コンポーネントの ParentCtl3D プロパティを True に設定します。すべてのコンポーネントを 3 次元の外観にできるだけでなく，2 次元の外観に変える場合でもフォームの Ctl3D プロパティを変更するだけですべてのコンポーネントを 2 次元表示にできます。

ParentCtl3D が True ならば，コンポーネントは親コンポーネントの Ctl3D プロパティを使います。ParentCtl3D が False ならば，コントロールは自身の Ctl3D プロパティを使います。デフォルト値は True です。

特定のコンポーネントに異なる外観を指定したい場合は，そのコントロールの Ctl3D プロパティの値に 3 次元ならば True，2 次元ならば False を指定すれば，ParentCtl3D は自動的に False になります。


TWinControl.ParentWindow
TWinControl.ParentWindow3432016

TWinControl	参照

ParentWindow プロパティは，コントロールが入った非 VCL 親ウィンドウのウィンドウハンドルです。

property ParentWindow: HWnd;

説明

ParentWindow プロパティを設定すると，ウィンドウコントロールを非 VCL 親ウィンドウに入れることができます。ParentWindow を設定すると，コントロールは指定したウィンドウ内に移動します。たとえば，TActiveXControl オブジェクトは ParentWindow を使って ActiveX コンテナウィンドウにコントロールを挿入できます。CreateParented メソッドを使って作成されたコントロールの場合，ParentWindow は自動的に設定されます。

ParentWindow は，VB，OWL または MFC アプリケーションによる使用のために，DLL にパッケージされているウィンドウコントロールで使います。

TWinControl オブジェクトは，Parent プロパティと ParentWindow プロパティのいずれか一方を持つことができます。コントロールの Parent プロパティが nil でなければ，ParentWindow プロパティは無視されます。


TWinControl.Showing
TWinControl.Showing3432017

TWinControl	参照

Showing プロパティは，コンポーネントが現在画面上に表示されているかどうかを示します。

property Showing: Boolean;

説明

Showing プロパティは，ほかのコントロールで隠されていないという想定の下で，コントロールが画面上に表示されているかどうかを指定できます。

コンポーネントとその親階層内のすべての親の Visible プロパティが True ならば，Showing は True です。コンポーネントの上位オブジェクトの Visible プロパティ値が 1 つでも False ならば，Showing は False になります。

Showing は読み出し専用プロパティです。


TWinControl.TabOrder
TWinControl.TabOrder3432018

TWinControl	参照

TabOrder プロパティは，親のタブ順でコントロールの位置を示します。

TTabOrder = -1..32767;

property TabOrder: TTabOrder;

説明

TabOrder プロパティは，〔Tab〕キーを押したときに子ウィンドウがフォーカスを受け取る順序です。フォームが最初に表示されたときは，TabOrder 値が 0 のコントロールがフォーカスを受け取ります。

初期のタブ順は常にコンポーネントがフォームに追加された順序です。TabOrder はフォームに最初に追加されたコンポーネントでは 0，2 番目のコンポーネントでは 1，3 番目のコンポーネントでは 2 のようになります。TabOrder プロパティを変更すれば，この順序を変更できます。ただし，TabOrder プロパティの値が -1 の場合はタブ順とは無関係なため，そのコントロールには〔Tab〕キーを押しても移ることができません。

各コンポーネントは親の中でユニークなタブ順値を 1 つ持ちます。あるコンポーネントの TabOrder プロパティの値を別のコンポーネントと同じ値に変更すると，残りのすべてのコンポーネントの TabOrder の値が変わります。たとえば，あるコンポーネントのタブ順が 6 番目だとします。このコンポーネントの TabOrder プロパティの値を 3 に変更すると（このコンポーネントのタブ順を 4 番目にする），本来タブ順が 4 番目だったコンポーネントは 5 番目になり，5 番目だったコンポーネントは 6 番目になります。

親コントロールの中に入ったコントロール数よりも大きい値を TabOrder に指定すると，そのコントロールはタブ順の最後に回されます。そのコントロールは TabOrder の割り当て値を受け取らず，確実にタブ順の最後になるような数値を受け取ります。

注意

TabOrder が意味を持つのは，TabStop プロパティが True で，同時にそのコントロールが親を持つ場合だけです。フォームの TabOrder プロパティは、そのフォームがその親としてほかのフォームを指定しないかぎり使われません。


TWinControl.TabStop
TWinControl.TabStop3432019

TWinControl	参照

TabStop プロパティは，コントロールにタブ操作で移動できるかどうかを決めます。

property TabStop: Boolean;

説明

TabStop プロパティは，〔Tab〕キーによるコントロールへのアクセスを許可するかどうかを決められます。

TabStop が True ならば，コントロールがタブ順に入ります。TabStop が False ならばコントロールはタブ順に入らないため，ユーザーは〔Tab〕キーを押してもコントロールへ移動できません。

注意

フォームがほかのフォームを親として指定しないかぎり，TabStop はフォームにとって意味を持ちません。


TWinControl.WindowHandle
TWinControl.WindowHandle3432020

TWinControl	参照

WindowHandle プロパティは，コントロールのウィンドウハンドルへのアクセスを提供します。

property WindowHandle: Hwnd;

説明

WindowHandle プロパティは Handle プロパティと同じウィンドウハンドルへのアクセスを提供しますが，WindowHandle は保護されているのでアクセスできるのはコンポーネントの内部のコードだけです。

Handle が読み出し専用であるのに対し，WindowHandle の利点は読み書き込み可能であることです。WindowHandle は，コントロールウィンドウハンドルの値を変更するためのメソッドを実装するときに使うことが想定されています。Handle プロパティとは違って，WindowHandle の値を読み出しても，有効なハンドルが自動的に作成されるわけではありません。WindowHandle の読み出しではゼロの値が返される場合もあります。


TWinControl イベント3432021

TWinControl	アルファベット順	凡例

TWinControl

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp


TWinControl イベント3432022

TWinControl	オブジェクト順	凡例

OnEnter

OnExit

OnKeyDown

OnKeyPress

OnKeyUp


TWinControl.OnEnter
TWinControl.OnEnter3432023

TWinControl	参照

OnEnter イベントは，コントロールが入力フォーカスを受け取ったときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnEnter: TNotifyEvent;

説明

OnEnter イベントハンドラを記述すると，コンポーネントがアクティブになったときに実行する特定の処理を指定できます。

OnEnter イベントはフォームからフォームへの切り替え時や，そのアプリケーションと別の Windows アプリケーションとの切り替え時には発生しません。

たとえば TPanel と TGroupBox のように別々のコンテナコントロール内のコントロール間を切り替えると，コンテナ内のコントロールの OnEnter イベントの前にそのコンテナの OnEnter イベントが発生します。

同様に，コンテナ外の別のコントロールにフォーカスが移った場合，コンテナ内のコントロールの OnExit イベントの後で，コンテナの OnExit イベントが発生します。

たとえば，［OK］ボタンの付いたフォームに 3 つのラジオボタンを持つグループボックスがあり，そのフォーカスが現在［OK］に合っているとします。ラジオボタンの 1 つがクリックされたとすると，まず［OK］の OnExit イベント，次にグループボックスの OnEnter イベント，そしてクリックされたラジオボタンの OnEnter イベントが発生します。この状態から［OK］をクリックすると，ラジオボタンの OnExit イベント，次にグループボックスの OnExit イベント，最後に［OK］の OnEnter イベントが発生します。


TWinControl.OnExit
TWinControl.OnExit3432024

TWinControl	参照

OnExit イベントは，入力フォーカスがコントロールから別のコントロールへ移ったときに発生します。

TNotifyEvent = procedure(Sender: TObject) of object;

property OnExit: TNotifyEvent;

説明

OnExit イベントハンドラは，コントロールがアクティブでなくなったときに特定の処理を実行する場合に使います。

OnExit イベントはフォームからフォームへの切り替え時や，そのアプリケーションと別の Windows アプリケーションとの切り替え時には発生しません。

たとえば TPanel と TGroupBox のように別々のコンテナコントロール内のコントロール間を切り替えると，コンテナの OnExit イベントの前にそのコンテナ内のコントロールに対して OnExit イベントが発生します。

同様に，コンテナ内のコントロールにフォーカスが移った場合，コンテナ内のコントロールの OnEnter イベントの前にそのコンテナの OnEnter イベントが発生します。

たとえば，［OK］ボタンの付いたフォームに 3 つのラジオボタンのグループボックスがあり，そのフォーカスが現在［OK］に合っているとします。ラジオボタンの 1 つがクリックされたとすると，まず［OK］の OnExit イベント，次にグループボックスの OnEnter イベント，そして最後にクリックされたラジオボタンの OnEnter イベントが発生します。この状態から［OK］をクリックすると，ラジオボタンの OnExit イベント，次にグループボックスの OnExit イベント，最後に［OK］の OnEnter イベントが発生します。

注意

ActiveControl プロパティは OnExit イベントが発生する前に更新されます。


TWinControl.OnKeyDown
TWinControl.OnKeyDown3432025

TWinControl	参照

OnKeyDown イベントは，コントロールにフォーカスがある間にユーザーが任意のキーを押すと発生します。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

TKeyEvent = procedure (Sender: TObject; var Key: Word; Shift: TShiftState) of object;

property OnKeyDown: TKeyEvent;

説明

OnKeyDown イベントハンドラを記述すると，キーが押されたときに実行する特定の処理を指定できます。OnKeyDown ハンドラは〔Shift〕，〔Alt〕，〔Ctrl〕キーとの組み合わせやファンクションキーを含むすべてのキーボードキーと，押されたマウスボタンに応答できます。

TKeyEvent はキーボードイベントを処理するメソッドへのポインタの型です。Key パラメータはキーボード上のキーです。英数字キー以外については，Windows API の仮想キーコードを使って押されるキーを指定します。詳細については，Win32 Programmer�s Reference（WIN32.HLP）で VkKeyScan と VkKeyScanEx を検索してください。

Shift パラメータは，以下の値をいくつ使ってもかまいません（使わなくても可）。

状態	意味

ssShift	〔Shift〕キーが押されている

ssAlt	〔Alt〕キーが押されている

ssCtrl	〔Ctrl〕キーが押されている

ssLeft	マウスの左ボタンが押されている

ssMiddle	マウスの中央ボタンが押されている

ssDouble	マウスをダブルクリックした（キーストロ－クでは使用されない）


TWinControl.OnKeyPress
TWinControl.OnKeyPress3432026

TWinControl	参照

OnKeyPress イベントは，ユーザーが単一の文字キーを押したときに発生します。

TKeyPressEvent = procedure (Sender: TObject; var Key: Char) of object;

property OnKeyPress: TKeyPressEvent;

説明

OnKeyPress イベントハンドラは，単一のキーが押された結果として何かを処理するときに使います。

OnKeyPress イベントハンドラの Key パラメータは Char 型です。したがって，OnKeyPress イベントは押されたキーの ASCII 文字を登録します。ASCII の Char 値に対応しないキー（たとえば〔Shift〕キーや〔F1〕キーなど）は OnKeyPress イベントを生成しません。キーの組み合わせ（〔Shift〕+〔A〕キーなど）は OnKeyPress イベントを 1 つだけ生成します（この例では〔Shift〕+〔A〕キーを押すと，CapsLock がオフならば〔A〕キーの Key 値が生成されます）。ASCII 以外のキーまたはキーの組み合わせに応答したい場合は，OnKeyDown または OnKeyUp のイベントハンドラを使います。


TWinControl.OnKeyUp
TWinControl.OnKeyUp3432027

TWinControl	参照

OnKeyUp イベントは，ユーザーが押したキーから指を離したときに発生します。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

TKeyEvent = procedure (Sender: TObject; var Key: Word; Shift: TShiftState) of object;

property OnKeyUp: TKeyEvent;

説明

OnKeyUp イベントハンドラは，キーから指が離れたときに特定の処理を実行する場合に使います。OnKeyUp ハンドラは〔Shift〕，〔Alt〕，〔Ctrl〕キーとの組み合わせキーやファンクションキーを含むすべてのキーボードキーと，押されたマウスボタンに応答できます。

TKeyEvent はキーボードイベントを処理するメソッドへのポインタの型です。Key パラメータはキーボード上のキーです。英数字キー以外については，Windows API の仮想キーコードを使って押されるキーを指定します。詳細については，Win32 Developer's Reference（WIN32.HLP）で VkKeyScan と VkKeyScanEx を検索してください。

Shift パラメータは，以下のいくつかの値によるセットです。指定しなくてもかまいません。

状態	意味

ssShift	〔Shift〕キーが押されている

ssAlt	〔Alt〕キーが押されている

ssCtrl	〔Ctrl〕キーが押されている

ssLeft	マウスの左ボタンが押されている

ssMiddle	マウスの中央ボタンが押されている

ssDouble	マウスの左右両方のボタンが押されている


TWinControl メソッド3432028

TWinControl	アルファベット順	凡例

TWinControl

AlignControls

Broadcast

CanFocus

ChangeScale

ContainsControl

ControlAtPos

Create

CreateHandle

CreateParams

CreateParented

CreateSubClass

CreateWindowHandle

CreateWnd

DefaultHandler

Destroy

DestroyHandle

DestroyWindowHandle

DestroyWnd

DisableAlign

DoEnter

DoExit

DoKeyDown

DoKeyPress

DoKeyUp

EnableAlign

FindNextControl

FixupTabList

Focused

GetChildren

GetClientOrigin

GetClientRect

GetDeviceContext

GetParentHandle

GetTabOrderList

GetTopParentHandle

HandleAllocated

HandleNeeded

InsertControl

Invalidate

IsControlMouseMsg

KeyDown

KeyPress

KeyUp

MainWndProc

NotifyControls

PaintControls

PaintHandler

PaintTo

PaintWindow

PaletteChanged

ReadState

Realign

RecreateWnd

RemoveControl

Repaint

ResetIme

ResetImeComposition

ScaleBy

ScaleControls

ScrollBy

SelectFirst

SelectNext

SetBounds

SetChildOrder

SetFocus

SetIme

SetImeCompositionWindow

SetZOrder

ShowControl

Update

UpdateControlState

WndProc

TControl からの継承

BeginDrag

BringToFront

ClientToScreen

DragDrop

Dragging

EndDrag

GetTextBuf

GetTextLen

Hide

Perform

Refresh

ScreenToClient

SendToBack

SetTextBuf

Show

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

Assign

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TWinControl メソッド3432029

TWinControl	オブジェクト順	凡例

AlignControls

Assign

BeginDrag

BringToFront

Broadcast

CanFocus

ChangeScale

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClientToScreen

ContainsControl

ControlAtPos

Create

CreateHandle

CreateParams

CreateParented

CreateSubClass

CreateWindowHandle

CreateWnd

DefaultHandler

Destroy

DestroyComponents

DestroyHandle

Destroying

DestroyWindowHandle

DestroyWnd

DisableAlign

Dispatch

DoEnter

DoExit

DoKeyDown

DoKeyPress

DoKeyUp

DragDrop

Dragging

EnableAlign

EndDrag

FieldAddress

FindComponent

FindNextControl

FixupTabList

Focused

Free

FreeInstance

FreeNotification

FreeOnRelease

GetChildren

GetClientOrigin

GetClientRect

GetDeviceContext

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetParentHandle

GetTabOrderList

GetTextBuf

GetTextLen

GetTopParentHandle

HandleAllocated

HandleNeeded

HasParent

Hide

InheritsFrom

InitInstance

InsertComponent

InsertControl

InstanceSize

Invalidate

IsControlMouseMsg

KeyDown

KeyPress

KeyUp

MainWndProc

MethodAddress

MethodName

NewInstance

NotifyControls

PaintControls

PaintHandler

PaintTo

PaintWindow

PaletteChanged

Perform

ReadState

Realign

RecreateWnd

Refresh

RemoveComponent

RemoveControl

Repaint

ResetIme

ResetImeComposition

SafeCallException

ScaleBy

ScaleControls

ScreenToClient

ScrollBy

SelectFirst

SelectNext

SendToBack

SetBounds

SetChildOrder

SetFocus

SetIme

SetImeCompositionWindow

SetTextBuf

SetZOrder

Show

ShowControl

Update

UpdateControlState

WndProc


TWinControl.AlignControls
TWinControl.AlignControls3432030

TWinControl	参照

AlignControls メソッドは，コントロールの指定された領域内でそのコントロールの子であるすべてのコントロールの位置を合わせます。

TRect = record

  case Integer of

    0: (Left, Top, Right, Bottom: Integer);

    1: (TopLeft, BottomRight: TPoint);

end;

procedure AlignControls(AControl: TControl; var Rect: TRect); virtual;

説明

AlignControls メソッドを呼び出すと，フォーム，パネル，グループボックス，スクロールボックス，および他のコントロールを入れた任意のウィンドウコントロールの領域の中のすべてのコントロールの位置を合わせられます。コントロールの位置を合わせる領域を，Rect パラメータの値で指定します。

AlignControls は個々の子コントロールの Align プロパティ値を使って，その位置を合わせる方法を決めます。AControl パラメータは nil でもかまいません。AControl にコントロールを指定すると，そのコントロールは位置合わせに関して同様に位置合わせされる他のコントロールに優先します。


TWinControl.Broadcast
TWinControl.Broadcast3432031

TWinControl	参照

Broadcast メソッドは，メッセージをウィンドウコントロールの個々の子コントロールに送ります。

procedure Broadcast(var Message);

説明

Broadcast メソッドを呼び出すと，ウィンドウコントロール中の個々の子コントロールに同じメッセージを送ることができます。渡されるメッセージを Message パラメータの値で指定します。


TWinControl.CanFocus
TWinControl.CanFocus3432032

TWinControl	参照

CanFocus メソッドは，コントロールがフォーカスを受け取るかどうかを指定します。

function CanFocus: Boolean;

説明

CanFocus メソッドを呼び出すと，コントロールが入力を受け付けられる状態かどうかがわかります。

コントロールとその親の Visible プロパティと Enabled プロパティが True に設定されていれば，CanFocus は True を返します。コントロールとそのコントロールが配置されているコントロールの Visible プロパティと Enabled プロパティのどれかが True に設定されていなければ，CanFocus は False を返します。下位オブジェクトで CanFocus メソッドをオーバーライドすると，コントロールがいつフォーカスを受け取れるかについてさらに制約を加えることができます。


TWinControl.ChangeScale
TWinControl.ChangeScale3432033

TWinControl	参照

ChangeScale メソッドは，コントロールのサイズと位置を変更します。このとき，コントロール自体をスケール変更する前にその子コントロールをスケール変更します。

procedure ChangeScale(M, D: Integer); override;

説明

ChangeScale メソッドを呼び出すと，フォームとそのすべてのコントロールをさまざまな画面解像度またはフォントサイズに合わせてスケール変更できます。ChangeScale はコントロールの Top，Left，Width，Height の各プロパティを変更するため，コントロールとその子コントロールの位置だけでなくサイズも変更します。

M パラメータは乗数で，D パラメータは除数です。たとえば，コントロールとその子コントロールを以前のサイズの 75% に変更するには，M の値を 75，D の値を 100 に指定します（75/100）。M の値を 3，D の値を 4 に指定しても同じ結果が得られます（3/4）。どちらの分数も等しいのでコントロールは同じ量，つまり 75% にスケール変更されます。

コントロールとその子コントロールを以前のサイズより 33% 大きくするには，M の値を 133，D の値を 100 に指定します（133/100）。M の値を 4，D の値を 3 に指定しても分数 133/100 は 4/3 とほぼ等しいのでほぼ同じ結果が得られます。

注意

コントロールのサイズと座標は整数なので，M/D の割合によるスケール変更はある程度の丸めエラーが発生します。ChangeScale を繰り返し呼び出すと，ある時点でコントロールが消えてしまったり（丸めエラーがコントロールをより以上に小さくしたとき），フォーム外に押し出されてしまったり（丸めエラーがコントロール位置を移動したとき）といった現象が生じることがあります。フォームを繰り返しスケール変更するような場合には，何度かスケール変更したらフォームを破棄，再ロードして，積み重なった丸めエラーを排除してください。


TWinControl.ContainsControl
TWinControl.ContainsControl3432034

TWinControl	参照

ContainsControl メソッドは，指定するコントロールがコントロール内にあるかどうかを示します。

function ContainsControl(Control: TControl): Boolean;

説明

ContainsControl メソッドを呼び出すと，特定のコントロールがこのコントロール内に存在するかどうかを確認できます。ContainsControl が True を返すのは，Control パラメータの指定された値がウィンドウコントロールの子コントロールである場合です。Control パラメータは直接の子コントロール（Controls プロパティ内）である必要はありませんが，ウィンドウコントロールの子コントロール，さらにその子コントロールなど，その何層か下位レベルのものに含まれます。

False を返せば，指定するコントロールはコントロール内にありません。


TWinControl.ControlAtPos
TWinControl.ControlAtPos3432035

TWinControl	参照

ControlAtPos メソッドはコントロール内の指定された位置にある子コントロールを返します。

TPoint = record

  X: Longint;

  Y: Longint;

end;

function ControlAtPos(const Pos: TPoint; AllowDisabled: Boolean): TControl;

説明

ControlAtPos メソッドを呼び出すと，コントロール内の指定された位置にどの子コントロールがあるかを調べることができます。ControlAtPos はウィンドウコントロールの直接の子コントロールを返します。つまり，Controls プロパティのエントリの 1 つで，その Parent プロパティのウィンドウコントロールを持っています。

クライアント座標の位置を Pos パラメータの値で指定します。Pos は，子コントロールの左上隅以外なら境界内のどこに位置してもかまいません。

指定した位置にコントロールがないと nil を返します。AllowDisabled パラメータはコントロールの検索で使用不可コントロールも対象にするかどうかを指定します。


TWinControl.Create
TWinControl.Create3432036

TWinControl	参照

Create メソッドは，TWinControl のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

Create メソッドを呼び出すと，新しいウィンドウコントロールを作成および初期化し，その新規作成されたコントロールを AOwner パラメータで指定されたオーナーに挿入できます。Create はコントロールをオーナーに挿入するために，そのオーナーの InsertComponent メソッドを呼び出します。

継承されたコンストラクタを呼び出した後，Create は以下の処理を実行します。

・	Brush を作成して初期化する

・	ParentCtl3D プロパティを True に初期化する

・	TabOrder プロパティ を -1 に設定する

大半のコントロールは Create をオーバーライドして，その固有なプロパティを初期化します。Create メソッドをオーバーライドするオブジェクトは常に，継承された Create メソッドをまず呼び出して，次にコンポーネントに固有の初期化を処理します。Create メソッドのオーバーライド時には override 指令を指定してください。

コンポーネントの Create メソッドがリソースやメモリを割り当てるときは，Destroy メソッドをオーバーライドしてそのようなリソースを解放します。


TWinControl.CreateHandle
TWinControl.CreateHandle3432037

TWinControl	参照

CreateHandle メソッドは，ハンドルを持たないコントロールの Handle プロパティのためにハンドルを生成します。

procedure CreateHandle; virtual;

説明

CreateHandle メソッドは，コントロールが親を持っている場合にはウィンドウハンドルを作成するために CreateWnd メソッドを呼び出します。CreateHandle はそのコントロール自体のハンドルを作成する前に親コントロールのハンドルを作成します。

注意

Parent プロパティが nil の場合，CreateHandle は例外を生成します。


TWinControl.CreateParams
TWinControl.CreateParams3432038

TWinControl	参照

CreateParams メソッドは，Params パラメータで渡されたウィンドウ作成パラメータのレコードを初期化します。

type

  TCreateParams = record

    Caption: PChar;

    Style: Longint;

    ExStyle: Longint;

    X, Y: Integer;

    Width, Height: Integer;

    WndParent: HWND;

    Param: Pointer

    WindowClass: TWndClass;

    WinClassName: array[0..63] of Char;

  end;

procedure CreateParams(var Params: TCreateParams); virtual;

説明

CreateWnd メソッドは CreateWindowHandle へ渡すパラメータを初期化するために CreateParams を呼び出します。CreateParams をオーバーライドすれば，コントロールに固有の形状を指定することができます。CreateParams をオーバーライドする場合は常に，まず継承メソッドを呼び出してデフォルト値を設定し，次に必要な調整を加えるようにします。

パラメータレコードを Params パラメータ値で指定します。TCreateParams 型は，Windows にウィンドウハンドルを作成するように通知する際に必要となる情報を保持するデータ構造です。TCreateParams レコードのフィールドは，Windows API の CreateWindowEx 関数を呼び出すときのパラメータになります。

TWinControl では CreateParams を実装するために，Params のすべてのフィールドを汎用のデフォルト値に設定します。いくつかの標準コントロールは，Params 内のいくつかのデフォルト値を変更するために CreateParams をオーバーライドします。


TWinControl.CreateParented
TWinControl.CreateParented3432039

TWinControl	参照

CreateParented メソッドは，指定した非 VCL ウィンドウの子コントロールとしてコントロールを作成し，初期化します。

constructor CreateParented(ParentWindow: HWnd);

説明

CreateParented メソッドを呼び出すと，ウィンドウコントロールを非 VCL 親ウィンドウに埋め込むことができます。TActiveXControl オブジェクトは，ActiveX コントロールをホストアプリケーションのクライアントサイトウィンドウの子コントロールとして作成するために CreateParented を呼び出します。

CreateParented は Create メソッドを呼び出して，コントロールを通常と同じように初期化しますが，ParentWindow プロパティを ParentWindow パラメータに，Owner プロパティ nil に設定します。


TWinControl.CreateSubClass
TWinControl.CreateSubClass3432040

TWinControl	参照

CreateSubClass メソッドは，既存の Windows ウィンドウクラスから派生した Delphi ウィンドウコントロールを作成します。

type

  TCreateParams = record

    Caption: PChar;

    Style: Longint;

    ExStyle: Longint;

    X, Y: Integer;

    Width, Height: Integer;

    WndParent: HWND;

    Param: Pointer

    WindowClass: TWndClass;

    WinClassName: array[0..63] of Char;

  end;

procedure CreateSubClass(var Params: TCreateParams; ControlClassName: PChar);

説明

CreateSubClass メソッドを使うと，Windows API の CreateWindowEx 関数を呼び出すときの TCreateParams レコードを作成できます。TCreateParams 型は，Windows にウィンドウハンドルを作成するように通知する際に必要となる情報を保持するデータ構造です。

継承した CreateParams を呼び出した後に，CreateSubClass を下位クラスコントロールの CreateParams メソッドの中で呼び出します。そのパラメータレコードを Params パラメータの値で指定します。CreateSubClass では，VCL コントロールが標準の Windows コントロールを作成できるようになります。


TWinControl.CreateWindowHandle
TWinControl.CreateWindowHandle3432041

TWinControl	参照

CreateWindowHandle メソッドは，コントロールのウィンドウハンドルを作成します。

type

  TCreateParams = record

    Caption: PChar;

    Style: Longint;

    ExStyle: Longint;

    X, Y: Integer;

    Width, Height: Integer;

    WndParent: HWND;

    Param: Pointer

    WindowClass: TWndClass;

    WinClassName: array[0..63] of Char;

  end;

procedure CreateWindowHandle(const Params: TCreateParams); virtual;

説明

CreateWindowHandle メソッドを呼び出すと，コントロールのウィンドウハンドルを作成できます。この処理には，Windows API の CreateWindowEx 関数を呼び出し，Params パラメータで渡されたレコードに入っているパラメータを渡します。

TCreateParams 型は，Windows にウィンドウハンドルを作成するように通知する際に必要となる情報を保持するデータ構造です。


TWinControl.CreateWnd
TWinControl.CreateWnd3432042

TWinControl	参照

CreateWnd メソッドは，ウィンドウコントロールコンポーネントが使うウィンドウを作成します。

procedure CreateWnd; virtual;

説明

CreateWnd はまずウィンドウ作成パラメータを初期化するために CreateParams メソッドを呼び出し，次にコントロールのウィンドウハンドルを作成するために CreateWindowHandle を呼び出します。CreateWnd は新しく作成したウィンドウのサイズを調整した後，コントロールのフォントを設定するために Perform メソッドを呼び出し，WM_SETFONT メッセージを渡します。


TWinControl.DefaultHandler
TWinControl.DefaultHandler3432043

TWinControl	参照

DefaultHandler メソッドは，コントロールがそれ自体では完全には処理しないすべてのメッセージを処理します。

procedure DefaultHandler(var Message); virtual;

説明

DefaultHandler メソッドをオーバーライドすると，コントロールのデフォルトのメッセージ処理を変更できます。Message パラメータを TMessage 型に割り当てると，WParam，LParam，Result を取得することができます。メッセージの Result が 0 以外ならば，メッセージは処理済みです。Result 項目を 0 以外の値に設定すると，それ以上，継承メソッドによってメッセージ処理が行われなくなります。

メッセージ処理メソッドで inherited を呼び出した場合，処理対象メッセージのハンドラが上位オブジェクトで指定されていないときは，上位オブジェクトの DefaultHandler メソッドが呼び出されます。

TWinControl は，すべての下位型のメッセージの処理で TControl.DefaultHandler をオーバーライドします。DefaultHandler は，Windows API の CallWindowProc 関数を呼び出すことにより，この関数を呼び出さないと処理されないメッセージをコントロールのウィンドウプロシージャに渡します。


TWinControl.Destroy
TWinControl.Destroy3432044

TWinControl	参照

Destroy メソッドは，TWinControl のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションでは直接 Destroy メソッドを呼び出さずに，Free メソッドを呼び出してください。Free メソッドは TWinControl オブジェクトが解放されていないことを確認し，解放されていなければ Destroy メソッドを呼び出します。


TWinControl.DestroyHandle
TWinControl.DestroyHandle3432045

TWinControl	参照

DestroyHandle メソッドは，ウィンドウコントロールのウィンドウハンドルを破棄しますが，コントロール自体は破棄しません。

procedure DestroyHandle;

説明

DestroyHandle メソッドを呼び出すと，コントロールをそのまま残してハンドルを破棄できます。コントロールは必要であれば後でハンドルを再作成できます。DestroyHandle は CreateHandle の逆の処理を行います。アプリケーションはできるだけ CreateWnd や DestroyWnd などの低レベルメソッドを呼び出さずに，高レベルの CreateHandle と DestroyHandle を呼び出すようにしてください。

コントロールがウィンドウコントロールを子コントロールとして持っている場合，DestroyHandle はそれ自体のハンドルを破棄する DestroyWnd を呼び出す前に個々の子コントロールの DestroyHandle を呼び出します。


TWinControl.DestroyWindowHandle
TWinControl.DestroyWindowHandle3432046

TWinControl	参照

DestroyWindowHandle メソッドは，CreateWindowHandle メソッドで作成されたウィンドウハンドルを破棄するために Windows API の DestroyWindow 関数を呼び出します。

procedure DestroyWindowHandle; virtual;

説明

DestroyWindowHandle メソッドを呼び出すと，コントロールのウィンドウハンドルを破棄できます。

TWinControl の Destroy メソッドは，オブジェクトを破棄する前に，ウィンドウコントロールに関連付けられたウィンドウハンドルを破棄するために DestroyWindowHandle を呼び出します。DestroyWnd メソッドも DestroyWindowHandle を呼び出します。


TWinControl.DestroyWnd
TWinControl.DestroyWnd3432047

TWinControl	参照

DestroyWnd メソッドは，ウィンドウコントロールのウィンドウハンドルを破棄します。

procedure DestroyWnd; virtual;

説明

DestroyWnd メソッドはウィンドウハンドルを破棄する前に，まずコントロールのテキストのコピーを内部記憶域に保存し，次にデバイスコンテキストを解放し，最後に DestroyWindowHandle を呼び出します。


TWinControl.DisableAlign
TWinControl.DisableAlign3432048

TWinControl	参照

DisableAlign メソッドは，ウィンドウコントロール内のコントロールの位置合わせを一時的に使用不可にします。

procedure DisableAlign;

説明

DisableAlign メソッドを呼び出すと，子コントロールの位置合わせを停止できます。フォームファイルからの読み出しやスケール変更など，コントロールに対して複数の操作を実行している間の位置合わせを使用不可にしておくと役に立ちます。DisableAlign の呼び出しごとに，続けて対応する EnableAlign への呼び出しを行わなければなりません。

DisableAlign は参照カウントをインクリメントし，その参照カウントは EnableAlign が後でデクリメントします。参照カウントがゼロになった時点で EnableAlign は必要な位置合わせを実行します。


TWinControl.DoEnter
TWinControl.DoEnter3432049

TWinControl	参照

DoEnter メソッドは，ウィンドウコントロールの OnEnter イベント用のプロテクトメソッドです。

procedure DoEnter; dynamic;

説明

DoEnter メソッドは OnEnter イベントに結び付けられたイベントハンドラを呼び出す以外は何もしません。DoEnter をオーバーライドすれば，継承されたイベントハンドラ呼び出しのほかにも応答処理が行えます。


TWinControl.DoExit
TWinControl.DoExit3432050

TWinControl	参照

DoExit メソッドは，ウィンドウコントロールの OnExit イベント用のプロテクトメソッドです。

procedure DoExit; dynamic;

説明

DoExit メソッドは OnExit イベントに結び付けられたイベントハンドラを呼び出す以外は何もしません。DoExit をオーバーライドすれば，継承されたイベントハンドラ呼び出しのほかにも応答処理が行えます。


TWinControl.DoKeyDown
TWinControl.DoKeyDown3432051

TWinControl	参照

DoKeyDown メソッドは，OnKeyDown イベントを実装する KeyDown メソッドを呼び出す前に特定の事前処理を実行するプロテクトメソッドです。

type

  TWMKey = record

    Msg: Cardinal;

    CharCode: Word;

    KeyData: Longint;

    Result: Longint;

  end;

function DoKeyDown(var Message: TWMKey): Boolean;

説明

DoKeyDown メソッドを呼び出すと，Message パラメータで渡されたキーダウンメッセージの処理をアプリケーションが続行しなくてはならないかどうかを決められます。戻り値が True ならばキーダウンメッセージの処理は完了しており，それ以上の処理は必要ありません。戻り値が False ならば，アプリケーションは継承処理を通じてキーダウンメッセージを渡さなくてはなりません。

DoKeyDown は，親フォームの KeyPreview プロパティが True に設定されているかどうかをチェックします。True に設定されていれば，ウィンドウコントロールによって処理される前にフォームが優先的にキーダウンメッセージを処理できます。フォームがメッセージを処理しない場合，DoKeyDown はメッセージパラメータを適切な型に変換して KeyDown を呼び出し，続いて KeyDown が OnKeyDown イベントハンドラ（存在するとき）を呼び出します。

TWMKey 型は，すべての Windows キーボードメッセージのメッセージレコードです。


TWinControl.DoKeyPress
TWinControl.DoKeyPress3432052

TWinControl	参照

DoKeyPress メソッドは，OnKeyPress イベントを実装する KeyPress メソッドを呼び出す前に特定の事前処理を実行するプロテクトメソッドです。

type

  TWMKey = record

    Msg: Cardinal;

    CharCode: Word;

    KeyData: Longint;

    Result: Longint;

  end;

function DoKeyPress(var Message: TWMKey): Boolean;

説明

DoKeyPress の戻り値を使って，Message パラメータで渡されたキープレスメッセージの処理をアプリケーションが続行しなくてはならないかどうかを決めます。戻り値が True ならばキープレスメッセージの処理は完了しており，それ以上の処理は必要ありません。戻り値が False ならば，アプリケーションは継承処理を通じてキープレスメッセージを渡さなくてはなりません。

DoKeyPress は，親フォームの KeyPreview プロパティが True に設定されているかどうかをチェックします。True に設定されていれば，ウィンドウコントロールによって処理される前にフォームが優先的にキープレスメッセージを処理できます。フォームがメッセージを処理しない場合，DoKeyPress はメッセージパラメータを適切な型に変換して DoKeyPress を呼び出し，続いて DoKeyPress が OnKeyPress イベントハンドラ（存在するとき）を呼び出します。

TWMKey 型は，すべての Windows キーボードメッセージのメッセージレコードです。


TWinControl.DoKeyUp
TWinControl.DoKeyUp3432053

TWinControl	参照

DoKeyUp メソッドは，OnKeyUp イベントを実装する KeyUp メソッドを呼び出す前に特定の事前処理を実行するプロテクトメソッドです。

type

  TWMKey = record

    Msg: Cardinal;

    CharCode: Word;

    KeyData: Longint;

    Result: Longint;

  end;

function DoKeyUp(var Message: TWMKey): Boolean;

説明

DoKeyUp メソッドの戻り値を使って，Message パラメータで渡されたキーアップメッセージの処理をアプリケーションが続行しなくてはならないかどうかを決めます。戻り値が True ならばキーアップメッセージの処理は完了しており，それ以上の処理は必要ありません。戻り値が False ならば，アプリケーションは継承処理を通じてキーアップメッセージを渡さなくてはなりません。

DoKeyUp では，親フォームの KeyPreview プロパティが True に設定されているかどうかをチェックします。True に設定されていれば，ウィンドウコントロールによって処理される前にフォームが優先的にキーアップメッセージを処理できます。フォームがメッセージを処理しない場合，DoKeyUp はメッセージパラメータを適切な型に変換して KeyUp を呼び出し，続いて KeyUp が OnKeyUp イベントハンドラ（存在するとき）を呼び出します。

TWMKey 型は，すべての Windows キーボードメッセージのメッセージレコードです。


TWinControl.EnableAlign
TWinControl.EnableAlign3432054

TWinControl	参照

EnableAlign メソッドは，DisableAlign の呼び出しでインクリメントされた参照カウントをデクリメントします。実際には，ウィンドウコントロールの子コントロールの位置合わせが行われます。

procedure EnableAlign;

説明

EnableAlign メソッドを呼び出すと，DisableAlign の呼び出しにより停止されていたコントロール内の子コントロールの位置合わせを再度実行できるようにします。

DisableAlign は呼び出されるたびに，参照カウントをインクリメントします。EnableAlign は呼び出されるたびに，同じ参照カウントをデクリメントします。参照カウントがゼロになった時点で，EnableAlign は保留中の位置合わせを実行するために Realign メソッドを呼び出します。

DisableAlign の各呼び出しには，必ず対応する EnableAlign の呼び出しがなければなりません。DisableAlign を呼び出した後で例外が生成された場合は，対応する EnableAlign 呼び出しが確実に実行されるようにするために，try .. finally 文を使います。


TWinControl.FindNextControl
TWinControl.FindNextControl3432055

TWinControl	参照

FindNextControl メソッドは，ウィンドウコントロールの子コントロールのうち，指定されたコントロールのタブ順で次にある子コントロールを返します。

function FindNextControl(CurControl: TWinControl;

  GoForward, CheckTabStop, CheckParent: Boolean): TWinControl;

説明

FindNextControl メソッドを呼び出すと，タブ順で CurControl の次の子コントロールを見つけることができます。CurControl がウィンドウコントロールの子でない場合，FindNextControl はタブ順で最初の子コントロールを返します。

GoForward パラメータは検索の方向を制御します。GoForward が True ならば，FindNextControl は子コントロールをタブ順の順方向に検索します。False ならば，逆方向に検索します。

CheckTabStop パラメータと CheckParent パラメータは，FindNextControl で検出したコントロールに対して特定の検査を実行するかどうかを制御します。CheckTabStop が True ならば，返されたコントロールは TabStop プロパティが True に設定されています。CheckParent が True ならば，返されたコントロールの Parent プロパティはウィンドウコントロールを示さなければなりません。

FindNextControl は「次」になり得るコントロールのリストを構築するために GetTabOrderList メソッドを呼び出します。


TWinControl.FixupTabList
TWinControl.FixupTabList3432056

TWinControl	参照

FixupTabList メソッドは，このコントロールの子コントロールをタブ順に並べ替えます。

procedure FixupTabList;

説明

アプリケーションは，FixupTabList メソッドを直接呼び出してはなりません。Delphi は実装内の ReadState メソッドでこのメソッドを使って，ストリームから読み出されている子コントロールの TabOrder プロパティに基づいたタブ順リストを初期化します。


TWinControl.Focused
TWinControl.Focused3432057

TWinControl	参照

Focused メソッドは，ウィンドウコントロールに入力フォーカスがあるかどうか判定します。

function Focused: Boolean;

説明

Focused メソッドを使うと，コントロールがアクティブかどうかがわかります。Focused が True ならば，コントロールにフォーカスがあります。Focused が False ならば，ユーザーはコントロールを対話形式で操作できません。


TWinControl.GetChildren
TWinControl.GetChildren3432058

TWinControl	参照

GetChildren メソッドは，ウィンドウコントロールの個々の子に対して指定されたメソッドを呼び出します。

type

  TGetChildProc = procedure (Child: TComponent) of object;

procedure GetChildren(Proc: TGetChildProc; Root: TComponent); override;

説明

GetChildren メソッドは，VCL のストリーミングシステムによって呼び出されます。アプリケーションがこのルーチンを呼び出す必要はまずありません。ただし一部の特殊化したコントロールでは，GetChildren をオーバーライドしてその子コントロールのどれがストリームに書き込まれるのかを制限することがあります。GetChildren をオーバーライドするときは，ストリームに書き込まれるすべての子コントロールに対して Proc パラメータとして渡された手続きを呼び出します。

TGetChildProc 型は，GetChildren メソッドにパラメータとして渡されるメソッドのメソッドポインタ型を定義します。


TWinControl.GetClientOrigin
TWinControl.GetClientOrigin3432059

TWinControl	参照

GetClientOrigin メソッドは，ClientOrigin プロパティ用のプロテクトアクセスメソッドです。

TPoint = record

X: Longint;

Y: Longint;

end;

function GetClientOrigin: TPoint; override;

説明

GetClientOrigin メソッドを呼び出すと，コントロールのクライアント領域の原点を取得できます。

GetClientOrigin はコントロールの左上隅の位置を示す点を画面座標で返します。GetClientOrigin は画面上のウィンドウコントロールの左上隅の位置を示す点を画面座標で返すために，Windows API の ClientToScreen 関数を呼び出します。


TWinControl.GetClientRect
TWinControl.GetClientRect3432060

TWinControl	参照

GetClientRect メソッドは，ClientRect プロパティ用のプロテクトアクセスメソッドです。

TRect = record

  case Integer of

    0: (Left, Top, Right, Bottom: Integer);

    1: (TopLeft, BottomRight: TPoint);

end;

function GetClientRect: TRect; override;

説明

GetClientRect メソッドを呼び出すと，コントロールのクライアント領域を定義する長方形を返します。GetClientRect では，Top フィールドと Left フィールドをゼロに，Bottom フィールドと Right フィールドがコントロールの ClientHeight と ClientWidth にそれぞれ設定された長方形を返します。GetClientRect は Windows API 関数の GetClientRect を呼び出します。


TWinControl.GetDeviceContext
TWinControl.GetDeviceContext3432061

TWinControl	参照

GetDeviceContext メソッドは，コントロールのデバイスコンテキストを返します。

function GetDeviceContext(var WindowHandle: HWnd): HDC; override;

説明

GetDeviceContext メソッドを呼び出すと，コントロールのデバイスコンテキストが返されます。

GetDeviceContext はウィンドウコントロールの Handle プロパティを渡して Windows API の GetDC 関数を呼び出します。この呼び出しが失敗すると，EOutOfResources 例外が発生します。


TWinControl.GetParentHandle
TWinControl.GetParentHandle3432062

TWinControl	参照

GetParentHandle メソッドは，コントロールが入っているウィンドウのウィンドウハンドルを返します。

function GetParentHandle: HWnd;

説明

GetParentHandle メソッドによって返されるハンドルは，コントロールの親ウィンドウのウィンドウハンドルを必要とする Windows API 関数呼び出しのパラメータとして使います。Parent プロパティが nil でなければ，GetParentHandle は親コントロールの Handle プロパティを返します。Parent が nil ならば，GetParentHandle は ParentWindow の値を返します。


TWinControl.GetTabOrderList
TWinControl.GetTabOrderList3432063

TWinControl	参照

GetTabOrderList メソッドは，コントロールのタブ順リストを構築します。

procedure GetTabOrderList(List: TList);

説明

GetTabOrder メソッドを呼び出すと，子コントロールのタブ順リストが構築されます。

GetTabOrder はウィンドウコントロールの内部のタブ順リストを繰り返し処理し，個々のコントロールをそのコントロールに入っているコントロールも含めて List に追加します。その結果，すべてのコントロールとそれらが所有するコントロールのタブ順リストが作成されます。

FindNextControl メソッドは GetTabOrderList を呼び出して，FindNextControl がタブ順で次のコントロールを見つけるために使う完全なコントロールリストを構築します。


TWinControl.GetTopParentHandle
TWinControl.GetTopParentHandle3432064

TWinControl	参照

GetTopParentHandle メソッドは，ウィンドウコントロールが入っている VCL コントロールと関連付けられていない最初のウィンドウのウィンドウハンドルを返します。

function GetTopParentHandle: HWnd;

説明

GetTopParentHandle メソッドを使うと，ウィンドウコントロールのホストとなっているウィンドウのハンドルにアクセスできます。GetTopParentHandle は，Parent プロパティが nil のコントロールを見つけるまでウィンドウコントロールのコンテナをさかのぼります。一番上の親が非 VCL ウィンドウ（ParentWindow が 0 以外）内にある場合，GetTopParentHandle はその VCL ウィンドウを返します。ウィンドウコントロールが VCL ウィンドウ内にある場合は，GetTopParentHandle はそのウィンドウコントロール自身のウィンドウハンドルを返します。


TWinControl.HandleAllocated
TWinControl.HandleAllocated3432065

TWinControl	参照

HandleAllocated メソッドは，コントロールのウィンドウハンドルが存在するかどうかを報告します。

function HandleAllocated: Boolean;

説明

HandleAllocated メソッドを呼び出すと，コントロールがウィンドウハンドルを持っているかどうかがわかります。

コントロールのウィンドウハンドルが存在すれば True を返します。ウィンドウハンドルが存在しなければ False を返します。コントロールの Handle プロパティに直接問い合わせると，ハンドルが存在しなければ自動的にハンドルが作成されます。コントロールのハンドルの存在の有無を確認するだけで自動的にハンドルを作成しない場合は HandleAllocated メソッドを呼び出します。


TWinControl.HandleNeeded
TWinControl.HandleNeeded3432066

TWinControl	参照

HandleNeeded メソッドはコントロールのウィンドウハンドルが存在しなければそのハンドルを作成します。

procedure HandleNeeded;

説明

HandleNeeded メソッドを呼び出すと，コントロールのウィンドウハンドルを作成できます。

ウィンドウハンドルが存在しないときは，HandleNeeded はコントロールのウィンドウハンドルを作成する前にその親の CreateHandle メソッドを呼び出します。


TWinControl.InsertControl
TWinControl.InsertControl3432067

TWinControl	参照

InsertControl メソッドは，ウィンドウコントロールの Controls 配列プロパティにコントロールを挿入します。

procedure InsertControl(AControl: TControl);

説明

アプリケーションが直接このメソッドを呼び出す必要はありません。子コントロールは，設計時に追加または削除されるとき，自動的に挿入または破棄されます。Controls プロパティに挿入するには，InsertControl メソッドを呼び出します。実行時には，子コントロールの Parent プロパティを使うと，コントロールを Controls 配列に挿入できます。子コントロールがすでに他のウィンドウコントロールの子である場合，Parent プロパティを設定すると，元の親の Controls からその子コントロールを確実に削除できます。

InsertControl は挿入されたコントロールを子として，コンテナになるコントロールを親として設定します。AControl パラメータは Controls 配列に挿入する子コントロールです。


TWinControl.Invalidate
TWinControl.Invalidate3432068

TWinControl	参照

Invalidate メソッドは，ほかの重要な Windows メッセージが処理された後でコントロールを再描画するように Windows に指示します。

procedure Invalidate; override;

説明

Invalidate メソッドは，コントロール全体を再描画する必要があるときに使います。コントロール内の複数箇所を再描画しなければならないときは，繰り返し再描画することで生じるちらつきを避けるために Invalidate はそのコントロール全体を一回で再描画するようにします。コントロールが実際に再描画される前に複数回 Invalidate を呼び出しても処理速度の低下はありません。


TWinControl.IsControlMouseMsg
TWinControl.IsControlMouseMsg3432069

TWinControl	参照

IsControlMouseMsg メソッドは，指定されたマウスメッセージがウィンドウコントロールの子コントロールの 1 つへ向けられていれば True を返します。

function IsControlMouseMsg(var Message: TWMMouse): Boolean;

説明

IsControlMouseMsg メソッドを呼び出すと，マウスメッセージがコントロールの子コントロールの 1 つへ向けられているかどうかを確認できます。マウスメッセージを Message パラメータの値で指定します。

子ウィンドウコントロールへのメッセージの送信は Windows が担当します。しかし，子コントロールが非ウィンドウのときは，Windows はメッセージを親コントロールへ送り，親コントロールはどの子コントロールがメッセージを受け取るかを決めなくてはなりません。

ウィンドウコントロールの WndProc メソッドは，ウィンドウコントロールに送られたすべてのマウスメッセージを処理するために IsControlMouseMsg を呼び出します。


TWinControl.KeyDown
TWinControl.KeyDown3432070

TWinControl	参照

KeyDown メソッドは，ウィンドウコントロールの OnKeyDown イベントのためのプロテクトメソッドです。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

procedure KeyDown(var Key: Word; Shift: TShiftState); dynamic;

説明

TWinControl から継承された KeyDown メソッドは OnKeyDown イベントに結び付けられたイベントハンドラを呼び出す以外は何もしません。KeyDown をオーバーライドすれば，継承されたイベントハンドラ呼び出しのほかにも応答処理を行えます。

Key パラメータはキーボード上のキーを示します。英数字キー以外から押されるキーを指定するには，Windows API の仮想キーコードを使わなければなりません。詳細については，Win32 Developer's Reference（WIN32.HLP）で VkKeyScan と VkKeyScanEx を検索してください。

ウィンドウコントロールは Windows からのキーダウンメッセージ（WM_KEYDOWN）への応答として KeyDown を呼び出します。実際の動作としては，DoKeyDown メソッドを呼び出すプライベートメッセージハンドラへメッセージが送られます。DoKeyDown はコントロールに実際にその文字を処理させなくてはならないと判断した場合，キーダウンメッセージのパラメータを解析し，キーコードとシフトキー状態をそれぞれ Key パラメータと Shift パラメータの KeyDown に渡します。

KeyDown またはそれが呼び出す OnKeyDown イベントハンドラはどちらも Key パラメータをゼロに設定するので，それ以上のキーの処理が抑止されます。

Shift パラメータはシフトキーとマウス操作を組み合わせたセットで，以下の状態を指定できます。

状態	意味

ssShift	〔Shift〕キーが押されている

ssAlt	〔Alt〕キーが押されている

ssCtrl	〔Ctrl〕キーが押されている

ssLeft	マウスの左ボタンが押されている

ssMiddle	マウスの中央ボタンが押されている

ssDouble	マウスをダブルクリックした（キーストロ－クでは使用されない）


TWinControl.KeyPress
TWinControl.KeyPress3432071

TWinControl	参照

KeyPress メソッドは，ウィンドウコントロールの OnKeyPress イベントのためのプロテクトメソッドです。

procedure KeyPress(var Key: Char); dynamic;

説明

TWinControl から継承された KeyPress メソッドは OnKeyPress イベントに結び付けられたイベントハンドラを呼び出す以外は何もしません。KeyPress をオーバーライドすれば，継承されたイベントハンドラ呼び出しのほかにも応答処理を行えます。

ウィンドウコントロールは Windows からのキープレスメッセージ（WM_CHAR）への応答として KeyPress を呼び出します。実際の動作としては，DoKeyPress メソッドを呼び出すプライベートメッセージハンドラへメッセージが送られます。DoKeyPress はコントロールに実際にその文字を処理させなくてはならないと判断した場合，キープレスメッセージのパラメータを解読し，キーコードを Key パラメータの KeyPress に渡します。

KeyPress またはそれが呼び出す OnKeyPress イベントハンドラはどちらも Key パラメータをゼロに設定するので，それ以上の文字の処理が抑止されます。

注意

Key パラメータは，Windows の仮想キーコードではなく，押されるキーが表す文字です。


TWinControl.KeyUp
TWinControl.KeyUp3432072

TWinControl	参照

KeyUp メソッドは，ウィンドウコントロールの OnKeyUp イベントのためのプロテクトメソッドです。

TShiftState = set of (ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble);

procedure KeyUp(var Key: Word; Shift: TShiftState); dynamic;

説明

KeyUp メソッドは，OnKeyUp イベントハンドラが結び付けられたときにそれを呼び出すだけです。KeyUp をオーバーライドすれば，継承されたイベントハンドラ呼び出しのほかにも応答処理を行えます。

ウィンドウコントロールは Windows からのキーアップメッセージ（WM_KEYUP）への応答として KeyUp を呼び出します。実際には，キーを放したときに以下のような動作が発生します。

1.	DoKeyUp メソッドが，コントロールに実際にその文字を処理させなくてはならないかどうかを判断する

2.	文字を処理すると判断した場合，キーアップメッセージのパラメータを解析し，キーコードとシフトキー状態をそれぞれ Key パラメータと Shift パラメータの KeyUp に渡す

3.	KeyUp またはそれが呼び出す OnKeyUp イベントハンドラはどちらも Key パラメータをゼロに設定するので，それ以上のキーの処理を抑止する

Key パラメータはキーボード上のキーを示します。英数字キー以外から押されるキーを指定するには，Windows API 仮想キーコードを使わなければなりません。詳細については，Win32 Developer's Reference（WIN32.HLP）で VkKeyScan と VkKeyScanEx を検索してください。

TShiftState 型はシフトキーとマウス操作を組み合わせたセットで，以下の状態を指定できます。

状態	意味

ssShift	〔Shift〕キーが押されている

ssAlt	〔Alt〕キーが押されている

ssCtrl	〔Ctrl〕キーが押されている

ssLeft	マウスの左ボタンが押されている

ssMiddle	マウスの中央ボタンが押されている

ssDouble	マウスをダブルクリックした（キーストロ－クでは使用されない）


TWinControl.MainWndProc
TWinControl.MainWndProc3432073

TWinControl	参照

MainWndProc メソッドは，Windows がコントロール用のメッセージを持っているときに Windows 自体が呼び出すルーチンです。

procedure MainWndProc(var Message: TMessage);

説明

MainWndProc メソッドを呼び出すと，メッセージがコントロールに送られます。

MainWndProc はそれ自体ではメッセージの処理やディスパッチは実行せず，それを実行する WndProc メソッドを呼び出します。MainWndProc は WndProc を囲む例外処理ブロックを提供し，メッセージ処理時に未処理の例外が発生した場合でも，その例外の処理のために確実にアプリケーションの HandleException メソッドが呼び出されるようにします。


TWinControl.NotifyControls
TWinControl.NotifyControls3432074

TWinControl	参照

NotifyControls メソッドは，ウィンドウコントロールのすべての子ウィンドウへメッセージを送ります。

procedure NotifyControls(Msg: Word);

説明

NotifyControls メソッドは Msg パラメータで渡されたメッセージ ID を持つメッセージをウィンドウコントロールの Controls 配列プロパティ内にあるすべてのコントロールへ送ります。Delphi は親の色やフォントに変更があったことなどを NotifyControls を使ってフォーム内のすべてのコントロールへ通知します。

NotifyControls は汎用メッセージレコードを構築し，そのメッセージ ID フィールドに Msg の値を記入し，パラメータフィールドと結果フィールドをゼロに設定した後，メッセージをすべての子コントロールへ送るために Broadcast メソッドを呼び出します。


TWinControl.PaintControls
TWinControl.PaintControls3432075

TWinControl	参照

PaintControls メソッドは，指定されたデバイスコンテキストを使ってウィンドウコントロール内にある個々の子コントロールを描画します。

procedure PaintControls(DC: HDC; First: TControl);

説明

PaintControls メソッドを呼び出すと，このコントロールのすべての子コントロールを描画できます。デバイスコンテキストは DC パラメータの値で渡します。First パラメータはウィンドウコントロールの子コントロールリスト内の描画開始点を示します。First が nil であるか子コントロールの 1 つを示していない場合，PaintControls はすべての子コントロールを描画します。

Repaint メソッドはコントロールとそれが交差する可能性があるコントロールを再描画するために，コントロールの親の PaintControls を呼び出し，First 内のコントロールを渡します。PaintHandler も PaintWindow を呼び出した後に PaintControls を呼び出します。


TWinControl.PaintHandler
TWinControl.PaintHandler3432076

TWinControl	参照

PaintHandler メソッドは，WM_PAINT メッセージに応答するハンドラです。

procedure PaintHandler(var Message: TWMPaint);

説明

PaintHandler メソッドは API 関数 BeginPaint と EndPaint を呼び出し，この 2 つの関数の間でコントロールの背景を描画するために PaintWindow を，子コントロールを描画するために PaintControls を呼び出します。


TWinControl.PaintTo
TWinControl.PaintTo3432077

TWinControl	参照

PaintTo メソッドは，デバイスコンテキスト上にウィンドウコントロールを描画します。

procedure PaintTo(DC: HDC; X, Y: Integer);

説明

PaintTo メソッドを呼び出すと，デバイスコンテキスト上にコントロールを描画できます。デバイスコンテキストを DC パラメータの値で指定し，デバイスコンテキスト上でウィンドウコントロールの左上隅が描画される位置を X 座標と Y 座標で指定します。PaintTo はまずデバイスコンテキストの背景を消去し，次にコントロールを描画します。

PaintTo は，ビットマップ DC にコントロールのイメージを描画するときに役立ちます。


TWinControl.PaintWindow
TWinControl.PaintWindow3432078

TWinControl	参照

PaintWindow メソッドは，ウィンドウコントロールのイメージを描画します。

procedure PaintWindow(DC: HDC); virtual;

説明

PaintWindow メソッドを呼び出すと，コントロールを再描画できます。PaintWindow は WM_PAINT メッセージをウィンドウコントロールの DefaultHandler メソッドへ送ります。メッセージレコードの WParam フィールドは DC で渡された値に，パラメータフィールドと結果フィールドはゼロに設定されます。


TWinControl.PaletteChanged
TWinControl.PaletteChanged3432079

TWinControl	参照

PaletteChanged メソッドはシステムパレットの変更に応答するために，コントロールのパレットと個々の子コントロールのパレットを実現します。

function PaletteChanged(Foreground: Boolean): Boolean; dynamic;

説明

PaletteChanged メソッドをオーバーライドすると，システムパレットが変更中であるという Windows 通知に対するコントロールの応答方法を変更できます。TWinControl はこのような通知に対する応答として，ウィンドウコントロールのパレットがあればそれを現在のデバイスコンテキストに実現しようとした後に，今度は個々の子コントロールに対して PaletteChanged 通知を渡します。システムパレットの変更によってコントロールパレットの実際の値が変更されるときは，PaletteChanged はそのコントロールを無効にして新しいパレットで再描画できるようにします。

Windows はアクティブウィンドウを前景パレットで描画し，ほかのウィンドウが背景パレットを使うようにします。前景パレットの実装によって制限が設けられますが，背景パレットはコントロールの論理パレットで指定された色にほぼ合致します。Windows では，前景パレットは 1 つしか存在できません。

PaletteChanged では，システムパレットが変更されるときに，コントロールにそのパレットを新たに実現させるようにします。ForeGround が True であれば，フォームはアクティブになっており，コントロールは新しい前景パレットを指定しているところです。ForeGround が False であれば，別のアプリケーションまたはフォームが前景パレットを変更済みで，利用可能なパレットを感知するコントロールがその論理パレットにもっともよく合致するように新しい背景パレットを実現します。

コントロールが現在のデバイスコンテキストで実現するための論理パレットを持っていないときは，GetPalette は 0 のハンドルを返すので，PaletteChanged はウィンドウコントロール用のパレットを実現しようとはせずに，その通知を子コントロールに渡すだけになります。ウィンドウコントロールやその子コントロールが PaletteChanged への応答としてパレットを現在のデバイスコンテキストに実現するときは，このメソッドは True を返します。

PaletteChanged をオーバーライドすると，Windows システムパレットが変化したときにコントロールに新しいパレットを実現する機会を付与する方法を変更できます。たとえば，PaletteChanged をオーバーライドすることによって，フォームがアクティブにされた時点で特定のコントロールに前景パレットを与えるために子コントロールがパレットを実現する順序を変更したり，パレット変更通知を Delphi 以外（DLL など）で実現されたカスタムコントロールに渡したりできます。このかわりに GetPalette をオーバーライドすれば，ウィンドウコントロールに実際に実現するパレットを持たせるかどうかに影響を与えたり，コントロールの論理パレットの値を変更したりできます。

注意

PaletteChanged が呼び出されるのは，実行時ビデオモードが 256 色モードのようなパレットサポートを必要とする場合だけです（1,600 万色モードは除く）。


TWinControl.ReadState
TWinControl.ReadState3432080

TWinControl	参照

ReadState メソッドは，コントロールがそのプロパティにストリームから読み出された値を割り当てるように準備を整えます。

procedure ReadState(Reader: TReader); override;

説明

ReadState メソッドをオーバーライドすると，コントロールがストリームから読み出された値をそのプロパティに割り当てるように整えた準備を変更できます。たとえば，ウィンドウコントロールは，新しいインスタンスがストリームからロードされる前に一時的な内部データ構造やオブジェクトを破棄することがあります。ReadState をオーバーライドするときには，継承されたメソッドの呼び出しを必ず含めるようにしてください。

ReadState はすべての子コントロールがストリームから読み出されるまでコントロールの位置合わせを使用不可にし，継承された ReadState メソッドを呼び出した後で，すべてのコントロールの位置合わせを再び有効にします。このメソッドはこれで，コントロールのタブ順リストを構築し，その Ctl3D プロパティと可視性を親コントロールのそれぞれに同調させます。


TWinControl.Realign
TWinControl.Realign3432081

TWinControl	参照

Realign メソッドは，ウィンドウコントロールにその内部のコントロールの位置合わせを実行させます。

procedure Realign;

説明

Realign メソッドを呼び出すと，このコントロール内のすべての子コントロールの配置に影響を与える何らかの修正を加えた後でそれらの位置合わせを実行できます。

このコントロールを親とするすべてのコントロールがその Align プロパティを alNone に設定すると，Realign には有効性がなくなります。

EnableAlign メソッドは参照カウントがゼロになった時点で Realign を呼び出します。


TWinControl.RecreateWnd
TWinControl.RecreateWnd3432082

TWinControl	参照

RecreateWnd メソッドは，ウィンドウコントロールの現在の状態を反映した別のウィンドウを作成するために，そのコントロールに関連付けられたウィンドウを破棄します。

procedure RecreateWnd;

説明

RecreateWnd メソッドを呼び出すと，コントロールを再作成できます。RecreateWnd は，コントロールによって使用されているウィンドウを破棄し，ウィンドウハンドルを NULL に設定します。コントロールの描画が必要になった場合など，次にウィンドウハンドルが必要になったときには，コントロールのプロパティを反映した新しいウィンドウが作成されます。

Windows ではコントロールに対する特定の変更を反映させるためには，コントロールウィンドウをいったん破棄して再作成しなくてはならない場合があります。たとえば編集ボックスの境界スタイルの変更を反映させるには，コントロールのウィンドウを再作成しなくてはなりません。


TWinControl.RemoveControl
TWinControl.RemoveControl3432083

TWinControl	参照

RemoveControl メソッドは，指定されたコントロールを Controls 配列から削除します。

procedure RemoveControl(AControl: TControl);

説明

アプリケーションが直接 RemoveControl メソッドを呼び出す必要はありません。子コントロールは，設計時に追加または削除されるとき，自動的に挿入または破棄されます。実行時には，子コントロールの Parent プロパティを使うと，コントロールを Controls 配列から削除できます。

RemoveControl メソッドは，Controls プロパティから子コントロールを削除します。その結果，このコントロールは AControl パラメータで指定した子コントロールの親ではなくなります。


TWinControl.Repaint
TWinControl.Repaint3432084

TWinControl	参照

Repaint メソッドは，コントロールのイメージを画面上に再描画します。

procedure Repaint; override;

説明

Repaint メソッドを呼び出すと，コントロールを再描画できます。

Repaint メソッドは Invalidate メソッドを呼び出した後，コントロールを再描画するために Update メソッドを呼び出します。


TWinControl.ResetIme
TWinControl.ResetIme3432085

TWinControl	参照

ResetIme メソッドは，アプリケーション起動時にアクティブだった IME（かな漢字変換プログラム）を復元します。

procedure ResetIme;

説明

ImeName プロパティを指定するコントロールの場合，ResetIme メソッドを呼び出すと，アプリケーション起動時にアクティブだった IME に戻すことができます。ImeMode プロパティを imDisable にして IME が非アクティブ化されている場合は，ResetIme デフォルトの IME を再起動します。

アプリケーションは ResetIme を呼び出すことはできません。ResetIme はコントロールが入力フォーカスを失うと自動的に呼び出されます。ResetIme はプロテクトメソッドとしてエクスポーズされるので，下位オブジェクトは，ほかのときはデフォルトの IME を復元できます。


TWinControl.ResetImeComposition
TWinControl.ResetImeComposition3432086

TWinControl	参照

ResetImeComposition メソッドは，特定の処理を実行するために IME（かな漢字変換プログラム）のコンポジションウィンドウを指示します。

function ResetImeComposition(Action: DWORD): Boolean;

説明

ResetImeComposition メソッドを呼び出すと，ユーザーの入力に対してコンポジションウィンドウがどのような処理を行うかを指定できます。コンポジションウィンドウは，ユーザーが入力した文字や，アジア地域の言語の文字への変換方法についてのフィードバックを提供するために IME によって表示されるウィンドウです。

Action パラメータは，コンポジションウィンドウが現在の内容についてどのような処理を行うかを示します。Action には次の値のいずれかを指定できます。

値	意味

CPS_CANCEL	コンポジション文字列をクリアし，ステータスをコンポジション文字列なしの状態に設定する

CPS_COMPLETE	コンポジション文字列を結果文字列に設定する

CPS_CONVERT	コンポジション文字列を変換する

CPS_REVERT	現在のコンポジション文字列を取り消して，変換前の文字列に戻す

ResetImeComposition メソッドは，コンポジションウィンドウが要求された処理を実行すると，True を返します。


TWinControl.ScaleBy
TWinControl.ScaleBy3432087

TWinControl	参照

ScaleBy メソッドは，ウィンドウコントロールとその子コントロールを以前のサイズの何パーセントかにスケール変更します。

procedure ScaleBy(M, D: Integer);

説明

ScaleBy メソッドを呼び出すと，コントロールとそのすべての子コントロールをスケール変更できます。ScaleBy はコントロールの Height プロパティと Width プロパティを変更しますが，Top プロパティと Left プロパティは変更しません。このため，コントロールのサイズは変化しますが，左上隅の座標は変化しません。

M パラメータと D パラメータによって，コントロールとその子コントロールをスケール変更するパーセント値が指定されます。M パラメータは乗数で D パラメータは除数です。たとえばコントロールを元のサイズの 75% にしたければ M の値を 75，D の値を 100 として指定します（75/100）。M の値を 3，D の値を 4 に指定しても同じ結果が得られます（3/4）。どちらの分数も等しいのでコントロールは同じ量，つまり 75% にスケール変更されます。

コントロールを以前のサイズより 33% だけ大きくしたければ，M の値を 133，D の値を 100 に指定します（133/100）。M の値を 4，D の値を 3 に指定しても分数 133/100 は 4/3 とほぼ等しいのでほぼ同じ結果が得られます。

注意

コントロールのサイズと座標は整数なので，M/D の割合によるスケール変更はある程度の丸めエラーが発生します。ScaleBy を繰り返し呼び出すことは，ある時点でコントロールが消えてしまうことを意味します（丸めエラーがコントロールをより以上に小さくしたとき）。コントロールを繰り返しスケール変更する際には，何度かのスケール変更後に，積み重なった丸めエラーがほとんどない状態で座標をスケール変更できるようにフォームを破棄して再ロードすることを考慮してください。


TWinControl.ScaleControls
TWinControl.ScaleControls3432088

TWinControl	参照

ScaleControls メソッドは，ウィンドウコントロール自体をスケール変更せずにその子コントロールをスケール変更します。

procedure ScaleControls(M, D: Integer);

説明

ScaleControls メソッドを呼び出すと，コントロールのサイズを以前のままに保持しながら，その子コントロールのみをスケール変更できます。

ScaleControls は M パラメータと D パラメータでスケール変更率をパーセントで指定して，個々の子コントロールの ChangeScale メソッドを呼び出します。M は乗数で，D は除数です。たとえば，子コントロールのサイズを以前の 75% に変更するには，M の値を 75，D の値を 100 に指定します（75/100）。M の値を 3，D の値を 4 に指定しても同じ結果が得られます（3/4）。どちらの分数も等しいのでコントロールは同じ量，つまり 75% にスケール変更されます。

注意

コントロールのサイズと座標は整数なので，M/D の割合によるスケール変更はある程度の丸めエラーが発生します。ScaleBy を繰り返し呼び出すことは，ある時点でコントロールが消えてしまったり（丸めエラーがコントロールをより以上に小さくしたとき），フォーム外に押し出されてしまったり（丸めエラーがコントロール位置を移動したとき）することを意味します。コントロールを繰り返しスケール変更する際には，何度かのスケール変更後に，積み重なった丸めエラーがほとんどない状態で座標をスケール変更できるように，フォームを破棄して再ロードすることを考慮してください。


TWinControl.ScrollBy
TWinControl.ScrollBy3432089

TWinControl	参照

ScrollBy メソッドは，ウィンドウコントロールの内容をスクロールします。

procedure ScrollBy(DeltaX, DeltaY: Integer);

説明

ScrollBy メソッドを呼び出すと，コントロール内の内容をスクロールできます。ScrollBy はどのウィンドウコントロールにも使えますが，TScrollingWinControl の下位で使うときにもっとも役に立ちます。

アプリケーションはスクロールバーを使わずに独自のスクロールインターフェースを実装することがないかぎり，ほとんど ScrollBy メソッドを呼び出す必要はありません。

DeltaX パラメータは X 軸方向の変化量（ピクセル単位）です。正の DeltaX 値は内容を右へスクロールし，負の値は左へスクロールします。DeltaY パラメータは Y 軸方向の変化量（ピクセル単位）です。正の DeltaY 値は内容を下へスクロールし，負の値は上へスクロールします。


TWinControl.SelectFirst
TWinControl.SelectFirst3432090

TWinControl	参照

SelectFirst メソッドは，ウィンドウコントロール内で選択可能なタブ順で最初の子コントロールを見つけます。

procedure SelectFirst;

説明

SelectFirst メソッドを呼び出すと，コントロールのタブ順で選択可能な最初の子コントロールを見つけられます。SelectFirst は，現在のコントロールを nil に指定して FindNextControl を呼び出します。最初の選択可能なコントロールが見つかると，SelectFirst はそれをフォーム上でアクティブコントロールにします。


TWinControl.SelectNext
TWinControl.SelectNext3432091

TWinControl	参照

SelectNext メソッドは入力フォーカスを，現在の子コントロールからタブ順で次のコントロールに移します。

procedure SelectNext(CurControl: TWinControl; GoForward, CheckTabStop: Boolean);

説明

SelectNext メソッドを呼び出すと，コントロールのタブ順で次の子コントロールを見つけられます。検索を開始する現在のコントロールを CurControl パラメータの値で指定します。GoForward パラメータは検索の方向を制御します。GoForward が True であれば，FindNextControl はタブ順で順方向に子コントロールを検索します。GoForward が False であれば，FindNextControl はコントロールを逆方向に検索します。

CheckTabStop パラメータは，SelectNext で見つかるコントロールがタブストップでなければならないかどうかを制御します。CheckTabStop が True であれば，返されたコントロールはその TabStop プロパティを True に設定しなければなりません。つまり，次のコントロールの検索が続けられます。

SelectNext が GoForward パラメータと CheckTabStop パラメータで定義された適切なコントロールを見つけられない場合には，フォーカスは CurControl のままになります。


TWinControl.SetBounds
TWinControl.SetBounds3432092

TWinControl	参照

SetBounds メソッドは，ウィンドウコントロールの境界プロパティを一度にすべて設定します。

procedure SetBounds(ALeft, ATop, AWidth, AHeight: Integer); override;

説明

SetBounds メソッドを呼び出すと，コントロールの境界プロパティをすべて同時に変更できます。Left，Top，Width，Height の各プロパティを別々に設定しても同じ結果を得られます。SetBounds は 4 つのプロパティをすべて同時に変更できるので，変更のたびにコントロールが再描画されることがありません。

Left，Top，Width，Height の各プロパティの値を，それぞれ ALeft，ATop，AWidth，AHeight の各パラメータの値で指定してください。


TWinControl.SetChildOrder
TWinControl.SetChildOrder3432093

TWinControl	参照

SetChildOrder メソッドは，GetChildren メソッドで返される子コンポーネントのリストで子コンポーネントが現れる順序を変更します。

procedure SetChildOrder(Child: TComponent; Order: Integer); override;

説明

SetChildOrder メソッドを呼び出すと，子オブジェクトがストリームされる順序を変更できます。順序を変更する子コンポーネントを Child パラメータの値で，コンポーネントを挿入する順序の位置を Order パラメータの値で指定してください。

SetChildOrder が呼び出されると，目的の子コンポーネントの以前の位置より下位にあった項目が繰り上がり，新しい位置より下位にある項目が繰り下がります。


TWinControl.SetFocus
TWinControl.SetFocus3432094

TWinControl	参照

SetFocus メソッドは，コントロールに入力フォーカスを渡します。

procedure SetFocus; virtual;

説明

SetFocus メソッドを呼び出すと，フォーカスを別のコントロールに変更できます。


TWinControl.SetIme
TWinControl.SetIme3432095

TWinControl	参照

SetIme メソッドは，ImeMode および ImeName プロパティで指定した値を使って IME（かな漢字変換プログラム）をアクティブにします。

procedure SetIme;

説明

アプリケーションは SetIme メソッドを呼び出すことはできません。SetIme はコントロールが入力フォーカスを受け取ると自動的に呼び出されます。SetIme はプロテクトメソッドとしてエクスポーズされるので，下位オブジェクトは ImeMode および ImeName プロパティがほかのときに有効になるようにすることができます。


TWinControl.SetImeCompositionWindow
TWinControl.SetImeCompositionWindow3432096

TWinControl	参照

SetImeCompositionWindow メソッドは，コンポジションウィンドウの位置とフォントを設定します。

function SetImeCompositionWindow( Font: TFont; XPos, YPos: Integer): Boolean;

説明

SetImeCompositionWindow メソッドを呼び出すと，コンポジションウィンドウの位置とフォントを変更できます。コンポジションウィンドウは，ユーザーが入力したキーストロークや，アジア地域の言語の文字への変換方法についてのフィードバックを提供するために IME によって表示されるウィンドウです。

Font パラメータは，コンポジションウィンドウが使うフォントを示します。Font パラメータを nil に設定すると，フォントを変更せずにコンポジションウィンドウの位置が変更されます。XPos および YPos パラメータには，コンポジションウィンドウのグローバル座標を指定します。

SetImeCompositionWindow は，フォントおよび位置の割り当てに成功すると，True を返します。


TWinControl.SetZOrder
TWinControl.SetZOrder3432097

TWinControl	参照

SetZOrder メソッドは，コントロールを親のコントロールリスト内でウィンドウコントロールの最上位または最下位に移動するか，コントロールに親がないときには，コントロールを画面上の一番上または一番下のウィンドウにします。

procedure SetZOrder(TopMost: Boolean); override;

説明

SetZOrder メソッドを呼び出すと，親コントロール内のコントロールの重なりや，画面上のウィンドウの重なりの位置を移動できます。TopMost パラメータが True ならば，コントロールは一番上のコントロールになります。それ以外の場合，一番下のコントロールになります。

ウィンドウコントロールは常に非ウィンドウコントロールの上に置かれます。このため，Parent が非ウィンドウコントロールを 1 つも持たないときは，TopMost 値として False を持つ SetZOrder を呼び出しても，ウィンドウコントロールはすべての非ウィンドウコントロールの上に維持されます。

SetZOrder は順序の変更後，再描画で新しい順序が確実に反映されるようにコントロールを無効にします。


TWinControl.ShowControl
TWinControl.ShowControl3432098

TWinControl	参照

ShowControl メソッドは，指定された子コントロールが確実に可視になるようにします。

procedure ShowControl(AControl: TControl); virtual;

説明

ShowControl メソッドを呼び出すと，子コントロールを表示できます。確実に可視にするコントロールを AControl パラメータの値で指定してください。

TWinControl メソッド ShowControl は，ウィンドウコントロールの親の ShowControl メソッドを呼び出すにすぎません。派生したオブジェクトは ShowControl メソッドをオーバーライドして，指示された子オブジェクトを可視にするのに必要なあらゆる処理を実行します。実行可能な処理には，特定の子オブジェクトを可視にするようにスクロールしたり，適切なノートブックのページに変更するなどの操作があります。

ShowControl は，Show メソッドの実装で使われるプロテクトメソッドです。


TWinControl.Update
TWinControl.Update3432099

TWinControl	参照

Update メソッドは，保留中の描画メッセージをただちに処理します。

procedure Update; override;

説明

Update メソッドを呼び出すと，より時間がかかりそうな処理が開始される前にコントロールに再描画を実行させます。Update を使えば，Windows の描画メッセージが到着するのを待てないユーザーに対してただちにフィードバックを提供できます。Update はコントロールを無効にするのではなく，無効にされていた各領域の再描画を実行させるにすぎません。コントロールも同時に無効にするときは，かわりに Repaint を呼び出します。

Update は Windows API の UpdateWindow 関数を呼び出し，この関数が保留中の描画メッセージを処理します。詳細については，Win32 Developer's Reference（WIN32.HLP）を参照してください。


TWinControl.UpdateControlState
TWinControl.UpdateControlState3432100

TWinControl	参照

UpdateControlState メソッドは，ウィンドウコントロールを表示して，すべての親オブジェクトに必要な調整を実行させます。

procedure UpdateControlState;

説明

UpdateControlState メソッドは Delphi によって内部的に使われて，コントロールを表示し，その時点でコントロールのハンドルを作成します。UpdateControlState は Show メソッドを呼び出して，ウィンドウコントロールを表示します。ウィンドウコントロールを確実に可視にするために，これはウィンドウハンドルを持っていないオブジェクトや親オブジェクトに対してウィンドウハンドルを作成し，すべての親コントロールの ShowControl メソッドを呼び出します。

UpdateControlState がコントロールを表示するのは，その親が表示中でコントロールの Visible プロパティが True の場合だけです。


TWinControl.WndProc
TWinControl.WndProc3432101

TWinControl	参照

WndProc メソッドは，コントロールに特定のメッセージ応答を提供します。

procedure WndProc(var Message: TMessage); override;

説明

WndProc メソッドをオーバーライドすると，コントロールの初期 Windows メッセージハンドラを変更できます。TWindowProc プロパティは WndProc メソッドを指すように初期化されます。

TWinControl の WndProc は継承されるメソッドをオーバーライドして，フォーカス，マウス，キーボードの各メッセージに対する応答を定義し，ほかのすべてを継承した WndProc に送ります。

メッセージへの特殊な応答を提供するために WndProc をオーバイライドする場合は，未処理メッセージをディスパッチするために最後に必ず継承した WndProc を呼び出します。


スコープ3432102

protected

published

読み出し／書き込み

読み出し専用


スコープ3432103

protected


スコープ3432104

protected


継承3432105

TObject

TPersistent

TComponent

TControl


TWinControl 例3432106

TWinControl


TWordField
TWordField3433001

継承	プロパティ	メソッド	イベント	参照

TWordField オブジェクトは，データセット中の符号なし 16 ビット整数を表します。

ユニット

db

説明

ワード項目は，0～65535 の範囲内の値を保持できます。符号なし 16 ビットの整数の保持に使います。

TWordField とその上位オブジェクト TIntegerField の相違点は，表すデータ型のみです。コンストラクタを除いて，すべてのプロパティ，メソッド，およびイベントは TIntegerField のものと同じであり，データベースの整数値項目の値およびプロパティを管理するのに便利な機能を提供します。


TWordField プロパティ3433002

TWordField	アルファベット順	凡例

TWordField

DataSize

TIntegerField からの継承

AsFloat

AsInteger

AsString

AsVariant

MaxValue

MinValue

Value

TNumericField からの継承

DisplayFormat

EditFormat

TField からの継承

Alignment

AsBoolean

AsCurrency

AsDateTime

AttributeSet

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ReadOnly

Required

Size

Text

ValidChars

Visible

TComponent からの継承

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TWordField プロパティ3433003

TWordField	オブジェクト順	凡例

Alignment

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsString

AsVariant

AttributeSet

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayFormat

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditFormat

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

MaxValue

MinValue

Name

NewValue

Offset

OldValue

Origin

Owner

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TWordField.DataSize
TWordField.DataSize3433004

TWordField	参照

DataSize プロパティは，ネイティブなデータベース形式でワード項目の値を格納するのに必要なメモリの大きさです。

property DataSize: Word;

説明

DataSize プロパティha

，ワード項目コンポーネントの値を格納するのに何バイト必要かを取得できます。GetData や SetData メソッドと共にこのプロパティを使うと，必要なバッファの大きさを決めることができます。

ワード型項目の DataSize は常に 2 です。これはデータベーステーブルの符号なしワード値の大きさで，TSmallIntField が整数値を格納したり操作したりするのに使う LongInt データ型の大きさではありません。


TWordField イベント3433005

TWordField	アルファベット順	凡例

TField からの継承

OnChange

OnGetText

OnSetText

OnValidate


TWordField イベント3433006

TWordField	オブジェクト順	凡例

OnChange

OnGetText

OnSetText

OnValidate


TWordField メソッド3433007

TWordField	アルファベット順

TWordField

Create

TField からの継承

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

TComponent からの継承

DestroyComponents

Destroying

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

HasParent

InsertComponent

RemoveComponent

SafeCallException

TPersistent からの継承

GetNamePath

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TWordField メソッド3433008

TWordField	オブジェクト順

Assign

AssignValue

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsValidChar

MethodAddress

MethodName

NewInstance

RefreshLookupList

RemoveComponent

SafeCallException

SetData

SetFieldType

Validate


TWordField.Create
TWordField.Create3433009

TWordField	参照

Create メソッドは，TWordField のインスタンスを作成します。

constructor Create(AOwner: TComponent); override;

説明

ほとんどの場合，Create を直接呼び出す必要はありません。なぜなら，ワード項目のコンポーネントは，データセット中のワード値のみを含むすべての項目において，自動的にインスタンス化されるからです。

継承したコンストラクタを呼び出した後で，Create は次の値を指定します。

・	DataType は ftWord

・	MinValue は 0

・	MaxValue は 65535


スコープ3433010

published

読み出し／書き込み

読み出し専用


スコープ3433011

published


継承3433012

TObject

TPersistent

TComponent

TField

TNumericField

TIntegerField


TWordField 例3433013

TWordField


TWriter
TWriter3434001

継承	プロパティ	メソッド	参照

TWriter は関連付けられたストリームにデータを書き込む特殊なファイラオブジェクトです。

ユニット

classes

説明

TWriter は，コンポーネントの Published プロパティやカスタムプロパティデータなどのコンポーネントに関連付けられた各種の項目を書き込むために VCL ストリームシステムによって内部的に使用されます。TWriter は，コンポーネントに関連付けられたデータをストリームに書き込むメカニックを処理するストリーム用のヘルパーオブジェクトです。複雑なコンポーネントのストリームを処理するのは，ストリームオブジェクトではなくライターオブジェクトです。以下の処理のためのメソッドが含まれます。

・	各種の項目を関連付けられたストリームに書き込む

・	継承されたフォームおよびプロパティのストリームに使うプロパティデータをデフォルト値で書き込む

・	ネストされた項目グループまたはコレクションをストリームに書き込む

TWriter の他のメソッドおよびプロパティはストリームおよびコンポーネントとの対話に使われます。

ユーザーは直接ライターオブジェクトを作成しません。TWriter のコンストラクタはストリームをパラメータにとります。ライターオブジェクトは，ストリームオブジェクトメソッドまたはストリームプロセスを開始するグローバルルーチンで自動的に作成されます。つまり，次のような場合です。

・	グローバルルーチン ObjectBinaryToText 手続きを呼び出し，直接ライターオブジェクトを作成する

・	グローバルルーチン ReadComponentResFile 関数を呼び出し，ライターオブジェクトを作成するファイルストリームオブジェクトを作成する

・	TStream.WriteDescendentを呼び出して，ライターオブジェクトを作成する

パラメータとしてライターのコンストラクタに渡されるストリームは関連付けられたストリームを表します。したがって，ストリームプロセスが開始されれば，ユーザーは直接ライターオブジェクトを操作する必要がありません。ライター，コンポーネント，およびストリームオブジェクト間の対話は，互いの呼び出しを行うオブジェクトのメソッドで自動的に発生します。


TWriter プロパティ3434002

TWriter	アルファベット順

TWriter

Position

RootAncestor

TFiler からの継承

Ancestor

IgnoreChildren

Root


TWriter プロパティ3434003

TWriter	オブジェクト順

Ancestor

IgnoreChildren

Position

Root

RootAncestor


TWriter.Position
TWriter.Position3434004

TWriter	参照

 Position プロパティは，関連付けられたストリーム内での現在の書き込み位置を表します。

property Position: Longint;

説明

Position プロパティは，ストリーム内での現在の書き込み位置を示すためにライターオブジェクトによって内部的に使われます。

Position の値は，もっとも新しく読み込まれたバッファブロックか書き込まれる次のブロックにあります。したがって，書き込む場合の Position は，通常，ストリームの Position 未満です。Position を現在のバッファの外側に設定すると，ライターのバッファはストリームにフラッシュされます。


TWriter.RootAncestor
TWriter.RootAncestor3434005

TWriter	参照

RootAncestor プロパティは，Root プロパティの上位コンポーネントを表します。

property RootAncestor: TComponent;

説明

RootAncestorはフォームの継承を処理するためにライターオブジェクトによって内部的に使われます。すべての上位コンポーネントに継承されたフォームのプロパティを書き込むときに使われます。

RootAncestor は常に上位フォームです。Root の各コンポーネントは継承されたフォームで，Ancestor プロパティは RootAncestor 内の対応するコンポーネントを記録します。

ライターオブジェクトは，Root が所有するすべてのコンポーネントを RootAncestor フォーム内で対応するコンポーネントと比較します。そして現在のコンポーネントで Ancestor コンポーネントと差異のあるプロパティだけを書き込みます。


TWriter メソッド3434006

TWriter	アルファベット順

TWriter

DefineBinaryProperty

DefineProperty

Destroy

FlushBuffer

Write

WriteBoolean

WriteChar

WriteCollection

WriteComponent

WriteDescendent

WriteFloat

WriteIdent

WriteInteger

WriteListBegin

WriteListEnd

WriteRootComponent

WriteSignature

WriteStr

WriteString

TFiler からの継承

Create

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TWriter メソッド3434007

TWriter	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

DefineBinaryProperty

DefineProperty

Destroy

Dispatch

FieldAddress

FlushBuffer

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

Write

WriteBoolean

WriteChar

WriteCollection

WriteComponent

WriteDescendent

WriteFloat

WriteIdent

WriteInteger

WriteListBegin

WriteListEnd

WriteRootComponent

WriteSignature

WriteStr

WriteString


TWriter.DefineBinaryProperty
TWriter.DefineBinaryProperty3434008

TWriter	参照

DefineBinaryProperty メソッドは，プロパティであるかのようにバイナリデータを定義して，それを直接メモリストリームに書き込みます。

type

TStreamProc = procedure(Stream: TStream) of object;

procedure DefineBinaryProperty(const Name: string; ReadData, WriteData: TStreamProc; HasData: Boolean); override;

説明

DefineBinaryProperty プロパティは，格納する必要のあるデータを持っているオブジェクトの DefineProperties メソッドによって内部的に呼び出されます。DefineProperties は汎用ファイラオブジェクトをパラメータにとります。

バイナリデータを書き込む場合，DefineProperties は TWriter オブジェクトを受け取り，ライターオブジェクトの DefineBinaryProperties メソッドを呼び出します。次に DefineBinaryProperty は HasData パラメータが True の場合だけプロパティ名とそのデータを書き込みます。それ以外の場合はなにもしません。

Name パラメータはストリームに書き込む「偽の」プロパティの名前を指定します。「偽の」プロパティとは，Published になってはおらず，DefineBinaryProperty メソッドのコードとして存在しているだけのプロパティです。非ビジュアルコンポーネントの Top プロパティおよび Left プロパティは「偽の」プロパティの例です。これらのプロパティは「定義済みプロパティ」または「カスタム定義済みプロパティ」と呼ばれます。

TStreamProc 型は ReadData パラメータおよび WriteData パラメータ型です。TStreamProc 型は，Stream パラメータで渡されるストリームで直接オブジェクトのデータのバイナリ表現を読み書きする手続き（格納オブジェクトで定義されます）を指すメソッドポインタ型です。TWriter の場合， ReadData パラメータは無視されます。

HasData パラメータは「偽の」プロパティが格納（書き込む）するデータを持つかどうかを実行時に指定します。したがって，HasData はデータを書き込むときにライターオブジェクトによってのみ使われます。

バイナリプロパティを定義することはほとんどありません。バイナリデータとしてグラフィックを格納する VCL オブジェクトが，データの格納および取得するためのファイラオブジェクトのもっとも一般的な利用法です。オブジェクトが DefineProperty メソッドを使う方が一般的です。DefineBinaryProperty と DefineProperty の相違点は，コンポーネントがファイラオブジェクトを介すのではなく，メモリストリームオブジェクトに（から）直接バイナリプロパティを読み書きすることです。

注意

TPersistent の下位のストリーム可能なオブジェクトは DefineProperties メソッドを継承しますが，DefineProperties は TComponent が呼び出されるまでなにもしません。したがって，バイナリデータを書き出すときにライターの DefineBinaryProperty を呼び出すのは，コンポーネントオブジェクトの DefineProperties メソッドです。


TWriter.DefineProperty
TWriter.DefineProperty3434009

TWriter	参照

DefineProperty メソッドは，あたかもプロパティであるかのようにライターオブジェクトが書き込むデータを定義します。

type

TReaderProc = procedure(Reader: TReader) of object;

TWriterProc = procedure(Writer: TWriter) of object;

procedure DefineProperty(const Name: string; ReadData: TReaderProc; WriteData: TWriterProc; HasData: Boolean); override;

説明

DefineProperty プロパティは，格納する必要のあるデータを持つオブジェクトの DefineProperties メソッドによって内部的に呼び出されます。DefineProperties は汎用ファイラオブジェクトをパラメータにとります。データを書き込む場合，DefineProperties は TWriter を受け取ってから，ライターオブジェクトの DefineProperties メソッドを呼び出します。次に DefineProperty は HasData パラメータ True の場合にのみプロパティ名およびそのデータを書き込みます。それ以外の場合にはなにもしません。

Name パラメータはストリームに書き込む「偽の」プロパティの名前を指定します。

TWriterProc 型は WriteData パラメータ型です。TWriterProc 型は，プロパティ値を表すオブジェクトのデータをライターオブジェクトに書き込む手続き（コンポーネントオブジェクトで定義されます）を指すメソッドポインタ型です。TWriter の場合，ReadData パラメータは無視されます。

HasData パラメータは「偽の」プロパティが格納（書き込む）するデータを持つかどうかを実行時に指定します。したがって，HasData はデータを書き込むときにライターオブジェクトによってのみ使われます。

DefineBinaryProperty と DefineProperty の相違点は，コンポーネントがファイラオブジェクトを介すのではなく，メモリストリームオブジェクトに（から）直接バイナリプロパティを読み書きすることです。

特殊な（大きな）データ格納要求を持つコンポーネントを書き込むときには，そのコンポーネントの DefineProperties はオーバーライドされる場合があります。それぞれの特殊なまたは「偽の」プロパティ項目については，Filer.DefineProperty メソッドまたは Filer.DefineBinaryProperty を呼び出してください。ReadData パラメータおよび WriteData パラメータについては，特殊なデータ型を処理できるコンポーネントのメソッドに渡してください。読み出すときには ReadData が呼び出され，書き込むときには WriteData が呼び出されます。

注意

プロパティの書き込みメソッドを定義するときは継承元クラスを知らなければなりません。Ancestor プロパティが nil でない場合は元クラスから継承したもの以外の新たに追加したプロパティの値だけを書き込まなければならないからです。


TWriter.Destroy
TWriter.Destroy3434010

TWriter	参照

Destroy メソッドはライターのインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドはリストボックスオブジェクトが解放されていないことを確認してから Destroy メソッドを呼び出します。

Destroy はバッファへの書き込みを行ってから、バッファを解放する継承 Destroy メソッドを呼び出します。


TWriter.FlushBuffer
TWriter.FlushBuffer3434011

TWriter

FlushBuffer メソッドは，現在のバッファを書き込むことで関連付けられたストリームとライターのバッファとを同期させます。

procedure FlushBuffer; override;

説明

通常，FlushBuffer メソッドは Delphi での内部実装以外には使われません。

FlushBuffer は現在のバッファをストリームに書き込んでから，内部ポインタを正しい位置にリセットします。


TWriter.Write
TWriter.Write3434012

TWriter	参照

Write メソッドは，Buf から Count で指定するバイト数をライターオブジェクトの関連付けられたストリームに書き込みます。

procedure Write(const Buf; Count: Longint);

説明

Write メソッドを直接呼び出してはいけません。Write はデータをストリームに書き込むために内部的に使われます。他のライターメソッドの多くは，通常，適切な値を書き込むか，データ型を確認してから Write を呼び出します。


TWriter.WriteBoolean
TWriter.WriteBoolean3434013

TWriter	参照

WriteBoolean メソッドは，Value で指定する論理値をライターオブジェクトのストリームに書き込みます。

procedure WriteBoolean(Value: Boolean);

説明

WriteBoolean メソッドは，コンポーネントプロパティをストリームに書き込むために Delphi ストリームシステムによって内部的に使われます。コンポーネントの論理プロパティをストリームに書き込むには WriteBoolean を使ってください。

WriteBoolean は Write を呼び出す前に Value が論理値およびその値型をストリームに書き込むための正しい型であることを確認します。


TWriter.WriteChar
TWriter.WriteChar3434014

TWriter	参照

WriteChar メソッドは，Value で指定する文字をライターオブジェクトのストリームに書き込みます。

procedure WriteChar(Value: Char);

説明

WriteChar メソッドはコンポーネントプロパティをストリームに書き込むために Delphi ストリームシステムによって内部的に使われます。コンポーネントの文字プロパティをストリームに書き込むために使用します。

WriteChar は，Write を呼び出す前に Value が文字および値型をストリームに書き込むための正しい型であることを確認します。

注意

WriteChar は文字列プロパティと前方一致する文字プロパティを書き込めるように StringChar を呼び出します。


TWriter.WriteCollection
TWriter.WriteCollection3434015

TWriter	参照

WriteCollection メソッドは，Value に渡したオブジェクトのコレクションをライターオブジェクトのストリームに書き込みます。

procedure WriteCollection(Value: TCollection);

説明

WriteCollection メソッドは，コンポーネントプロパティをストリームに書き込むために Delphi ストリームシステムによって内部的に使われます。コレクションになっているコンポーネントプロパティをストリームに書き込むために使用します。

WriteCollection は Write を呼び出す前に Value がコレクションおよびその値型を書き込むための正しい型であることを確認します。WriteCollection はコレクションをリストの開始とリストの終了を示すマーカーで区切ります。


TWriter.WriteComponent
TWriter.WriteComponent3434016

TWriter	参照

WriteComponent メソッドは Component で指定するコンポーネントをストリームに書き込みます。

procedure WriteComponent(Component: TComponent);

説明

WriteComponent メソッドを直接呼び出してはいけません。WriteComponent は Root 内の各所有コンポーネントで再帰的に呼び出されます。

WriteComponent は，Component の WriteState メソッドを呼び出す前に Component の ComponentState プロパティに csWriting 状態を設定して，WriteState から制御が返るとcsWriting フラグをクリアします。

注意

イベントのシーケンスは次のとおりです。まずライターの WriteComponent メソッドが Component の WriteState メソッドを呼び出し，それがライターの WriteData メソッドを呼び出します。そのメソッドがそれぞれの子コンポーネントにプロパティを書き込み，それから WriteComponent を呼び出します。

Component の WriteState は仮想的なので，Component が準備を整えられる（すなわちデータを統合できるのは）のはストリーム出力されるときだけです。


TWriter.WriteDescendent
TWriter.WriteDescendent3434017

TWriter	参照

WriteDescendent は，継承フォームの下位コンポーネントの書き込みを発生させるために内部的に使われます。

procedure WriteDescendent(Root: TComponent; AAncestor: TComponent);

説明

WriteDescendent メソッドを直接呼び出してはいけません。WriteDescendent は継承フォームの下位コンポーネントのストリームに使う呼び出しシーケンスの一部です。

WriteDescendent は AAncestor に渡された値をライターオブジェクトの Ancestor プロパティと RootAncestor プロパティに書き込み，Root プロパティを Root に渡された値に設定してから，Root および Root が所有するコンポーネントをライターオブジェクトのストリームに書き込むために WriteSignature と WriteComponent を呼び出します。

WriteDescendent は，Root の型で定義されるプロパティ値ではなく，Ancestor を設定することによって Ancestor プロパティの値をデフォルトとして使う点が WriteComponent と異なります。


TWriter.WriteFloat
TWriter.WriteFloat3434018

TWriter	参照

WriteFloat メソッドは，Value で指定する浮動小数点値をライターオブジェクトのストリームに書き込みます。

procedure WriteFloat(Value: Extended);

説明

WriteFloat メソッドは，コンポーネントプロパティをストリームに書き込むために Delphi ストリームシステムによって内部的に使われます。浮動小数点値をストリームに書き込むために使用します。

WriteFloat は Write を呼び出す前に Value が浮動小数点値およびその値型をストリームに書き込むための正しい型であることを確認します。


TWriter.WriteIdent
TWriter.WriteIdent3434019

TWriter	参照

WriteIdent メソッドは，Ident で指定する識別子をライターオブジェクトのストリームに書き込みます。

procedure WriteIdent(const Ident: string);

説明

WriteIdent はコンポーネントプロパティをストリームに書き込むために Delphi ストリームシステムによって内部的に使われます。コンポーネントの識別子プロパティをストリームに書き込むために使用します。コンポーネント名および列挙型要素は Pascal 識別子として許される文字列です。

WriteFloat は Write を呼び出す前に Value が識別子および値型をストリームに書き込むための正しい型であることを確認します。


TWriter.WriteInteger
TWriter.WriteInteger3434020

TWriter	参照

WriteInteger メソッドは，Value で指定する整数値をライターオブジェクトのストリームに書き込みます。

procedure WriteInteger(Value: Longint);

説明

WriteInteger メソッドは，コンポーネントプロパティをストリームに書き込むために Delphi ストリームシステムによって内部的に使われます。コンポーネントの整数プロパティをストリームに書き込むには WriteInteger を使ってください。

WriteInteger は Write を呼び出す前に Value が整数値およびその値型をストリームに書き込むための正しい型であることを確認します。WriteInteger はさまざまなサイズの整数を処理します。


TWriter.WriteListBegin
TWriter.WriteListBegin3434021

TWriter	参照

WriteListBegine メソッドは，リストの開始マーカーをライターオブジェクトの関連付けられたストリームに書き込みます。

procedure WriteListBegin;

説明

WriteListBegin メソッドは，ストリームに書き込まれる予定の項目のグループを使って繰り返す他のメソッドによって使われます。WriteListBegin はリストの開始マーカーをライターオブジェクトの関連付けられたストリームに書き込みます。WriteListBegin を呼び出した場合，必ず対応する WriteListEnd を呼び出さなくてはなりません。


TWriter.WriteListEnd
TWriter.WriteListEnd3434022

TWriter	参照

WriteListEnd メソッドは，リストの終わりを示すマーカーをライターオブジェクトの関連付けられたストリームに書き込みます。

procedure WriteListEnd;

説明

WriteListEnd メソッドは，1 つの処理でストリームに連続して書き込まれる項目のグループを使って繰り返す他のメソッドによって使われます。

WriteListEnd の呼び出しは，通常，書き込みループの後になります。WriteListEnd を呼び出すには，先に対応する WriteListBegin を呼び出していなければなりません。


TWriter.WriteRootComponent
TWriter.WriteRootComponent3434023

TWriter	参照

WriteRootComponent メソッドは，後方一致の場合のみ提供されます。

procedure WriteRootComponent(Root: TComponent);

説明

WriteRootComponent メソッドは，WriteDescendent を呼び出します。


TWriter.WriteSignature
TWriter.WriteSignature3434024

TWriter

WriteSignature メソッドは，Delphi ファイラの署名をライターオブジェクトの関連付けられたストリームに書き込みます。

procedure WriteSignature;

説明

WriteSignature メソッドは，アクションを処理する前にファイラの署名を書き込むメソッドによって内部的に使われます。たとえば，WriteRootComponent メソッドはそのコンポーネントをストリームに書き込む前に WriteSignature を呼び出します。オブジェクトをロードする前に署名を確認するので，リーダーオブジェクトは無効なまたはこわれたデータを読み出さないで済みます。

ファイラの署名は 4 文字です。このバージョンの Delphi では TPF0 です。


TWriter.WriteStr
TWriter.WriteStr3434025

TWriter	参照

WriteStr メソッドは，そのままのデータをライターオブジェクトのストリームに書き込みます。

procedure WriteStr(const Value: string);

説明

WriteStr メソッドを直接呼び出してはいけません。WriteStr は特定の VCL コンポーネントがその内部で使うものです。WriteStr は Value で指定する文字列をライターオブジェクトのストリームに書き込みます。

警告

コンポーネントの文字列をストリームに書き込むには必ず WriteString を使ってください。WriteStr を使わないとデータが破損する可能性があります。


TWriter.WriteString
TWriter.WriteString3434026

TWriter	参照

WriteString メソッドは，タグの付いたデータをライターオブジェクトのストリームに書き込みます。

procedure WriteString(const Value: string);

説明

WriteString メソッドは，コンポーネントのプロパティをストリームに書き込むために Delphi ストリームシステムによって内部的に使われます。それ以外では WriteString は DefineProperties 手続きおよび WriteData 手続きでコンポーネントライターによって使われるだけです。

WriteString は Value で指定する文字列をライターオブジェクトのストリームに書き込みます。WriteString は Write を呼び出す前に Value が文字列およびその値型をストリームに書き込むための正しい型であることを確認します。

警告

コンポーネントの文字列をストリームに書き込むには必ず WriteString を使ってください。同じような名前の WriteStr メソッドは特定の VCL コンポーネントがその内部で使うものなので，これを使うとデータが破損する可能性があります。


継承3434027

TObject

TFiler


TWriter 例3434028

TWriter


TWinSocketStream
TWinSocketStream3435001

継承	プロパティ	メソッド	参照

TWinSocketStream オブジェクトは，アプリケーションがソケット接続との間での読み書きを行えるようにするサービスを提供するストリームです。

ユニット

scktcomp

説明

TWinSocketStream オブジェクトを使うと，ブロッキングソケット接続で情報を読み書きできます。Windows ソケットオブジェクトには，それらのオブジェクトが表すソケット接続との間で読み書きを行うためのメソッドがあります。ただし，それらのメソッドでは，ソケット接続が不通になったときにタイムアウトしたり，読み出しの前にソケット接続の用意ができるまで待ったりするメカニズムは提供されません。

ソケットが非ブロッキングソケットのときは，読み書きはソケット接続からの通知に対する応答として非同期的に行われるので，タイムアウトまたは待機メカニズムがなくても問題はありません。しかし，ブロッキングソケットの場合は，ソケットを使っているアプリケーションが無期限にハングしないようにするために，TWinSocketStream によって提供されるこれらのメカニズムが必要になります。

Windows ソケットストリームを使用するには，TWinSocketStream のインスタンスを作成し，ストリームのメソッドを使ってデータの読み出しまたは書き込みを行い，Windows ソケットストリームを解放します。

注意

TWinSocketStream オブジェクトは，非ブロッキングソケットでは使用できません。


TWinSocketStream プロパティ3435002

TWinSocketStream	アルファベット順

TWinSocketStream

TimeOut

TStream からの継承

Position

Size


TWinSocketStream プロパティ3435003

TWinSocketStream	オブジェクト順

Position

Size

TimeOut


TWinSocketStream.TimeOut

TWinSocketStream	参照

Timeout は，WaitForDate メソッドが参照するタイムアウト時間を保持します。

property TimeOut: Longint;

説明

WaitForData メソッドは，ソケット接続でのデータ転送の用意が整うのを一定時間だけ待ちます。TimeOut プロパティに，この時間をミリ秒単位で設定します。


TWinSocketStream メソッド3435004

TWinSocketStream	アルファベット順

TWinSocketStream

Create

Destroy

Read

Seek

WaitForData

Write

TStream からの継承

CopyFrom

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

TObject からの継承

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TWinSocketStream メソッド3435005

TWinSocketStream	オブジェクト順

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyFrom

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Read

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

SafeCallException

Seek

WaitForData

Write

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes


TWinSocketStream.Create
TWinSocketStream.Create3435006

TWinSocketStream	参照

Create メソッドは，Windows ソケットオブジェクトの TWinSocketStream のインスタンスを作成します。

constructor Create(ASocket: TCustomWinSocket);

説明

Create メソッドを呼び出すと，TWinSocketStream のインスタンスを取得して，ASocket パラメータによって表されるソケット接続で情報を読み書きできます。ASocket は，別の Windows ソケットへのオープンしているブロッキングソケット接続のエンドポイントである必要があります。

Create はストリームをソケット接続に関連付け，ヘルパーオブジェクトを割り当てます。これによりストリームは，いつソケット接続で情報を読み書きできるようになるかを判断できます。ASocket が非ブロッキングソケット接続を表す場合，Create は ESocketError 例外を生成します。


TWinSocketStream.Destroy
TWinSocketStream.Destroy3435007

TWinSocketStream	参照

Destroy メソッドは，TWinSocketStream のインスタンスを破棄します。

destructor Destroy; override;

説明

アプリケーションで直接 Destroy メソッドを呼び出さないでください。かわりに Free メソッドを呼び出します。Free メソッドは TWinSocketStream オブジェクトが解放されていないことを確認してからのみ Destroy メソッドを呼び出します。

TWinSocketStream オブジェクトは，ソケット接続での読み書きで必要なくなったときに解放してください。

Destroy は，Create メソッドで割り当てられたヘルパーオブジェクトを解放してから，デフォルトデストラクタを呼び出します。


TWinSocketStream.Read
TWinSocketStream.Read3435008

TWinSocketStream	参照

Read メソッドは，ソケット接続から最大で Count で指定するバイト数を Buffer に読み出します。

function Read(var Buffer; Count: Longint): Longint; override;

説明

Read メソッドを呼び出すと，転送されるバイト数が不明なときに，ソケット接続からデータを読み出すことができます。Buffer は，接続から読み出されるデータを格納するために割り当てられた Count のバイト数以上のバイト数でなければなりません。Read は，実際に転送されたバイト数を返します。その値は Count で要求された数より少ないこともあります。

ソケット接続が極度に低速で，読み出し処理が 20 秒たっても完了しないと，Read は 0 を返すことがあります。これにより，ソケット接続で問題が生じても Read メソッドが無期限に待ち受け状態にならないことが保証されます。

接続速度の遅さのために Read メソッドがタイムアウトするのを防ぐには，Count の値を大きくして呼び出しを少なくするのではなく，Count を小さめの値に設定して Read を複数回呼び出すようにします。

Read を呼び出す前に，ソケット接続がデータ送信の用意を整えておくようにするには，WaitForData メソッドを呼び出します。

ReadBuffer メソッドとは異なり，ソケット接続から Count で指定したバイト数のデータが読み出されなくても Read は例外を生成しません。


TWinSocketStream.Seek
TWinSocketStream.Seek3435009

TWinSocketStream	参照

Seek メソッドは，常に 0 を返します。

function Seek(Offset: Longint; Origin: Word): Longint; override;

説明

Seek メソッドは継承メソッドをオーバーライドして TWinSocketStream オブジェクトの Position プロパティを常に 0 に設定します。ソケット接続はランダムアクセスをサポートしません。Windows ソケットストリームの Position プロパティは，残りのすべてのデータの先頭位置を反映するだけです。


TWinSocketStream.WaitForData
TWinSocketStream.WaitForData3435010

TWinSocketStream	参照

WaitForData メソッドは，ソケット接続でデータ転送の用意が整うのを Timeout に指定したミリ秒間まで待ちます。

function WaitForData(Timeout: Longint): Boolean;

説明

WaitForData メソッドを呼び出すと，ソケット接続が確実に情報を読み書きする用意を整えていることが保証されるようになります。WaitForData は，ソケット接続で用意が整っていれば True を返します。WaitForData は，Timeout ミリ秒後にソケット接続で用意が整っていなければ False を返します。

WaitForData はソケット接続で情報の読み書きを行う前に呼び出します。そうしないと，Read または Write メソッドの呼び出しは，データがまったく転送されないうちにタイムアウトになってしまうことがあります。


TWinSocketStream.Write
TWinSocketStream.Write3435011

TWinSocketStream	参照

Write メソッドは，Buffer から Count で指定するバイト数をソケット接続に書き込みます。

function Write(const Buffer; Count: Longint): Longint; override;

説明

Write メソッドを呼び出すと，Buffer からソケット接続にデータを書き込むことができます。Write は転送されたバイト数を返します。

ソケット接続が極度に低速で，書き込み処理が 20 秒たっても完了しないと，Write は 0 を返すことがあります。これにより，ソケット接続で問題が生じても Write メソッドが無期限に待ち受け状態にならないことが保証されます。

接続速度の遅さのために Write メソッドがタイムアウトするのを防ぐには，Count の値を大きくして呼び出しを少なくするのではなく，Count を小さめの値に設定して Write を複数回呼び出すようにします。

WriteBuffer メソッドとは異なり，Count で指定したバイト数が書き込まれなくても Write は例外を生成しません。たとえば，回線速度が低速すぎてすべてのデータを送信できない場合，Write は 0 を返しますが，WriteBuffer は例外を生成します。


継承3435012

TObject

TStream


TWinSocketStream 例3435013

TWinSocketStream


TMenu example 1
TMenu example 1 (menudemo.pas)

menuform.pas	about.pas	menudemo.dfm	menuform.dfm	about.dfm

Objects

The example demonstrates using TMainMenu, TMenuItem, TPopupMenu, TColorDialog, TShape, and TPanel  objects. To run this example, load the project file from the Help\Examples\Menu directory.

Description

This example demonstrates using a main menu, menu items, and a popup menu.  Clicking on the various menu options allows the user to modify the shape and color of an image.

unit menudemo;

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  Menus, ExtCtrls, ComCtrls;

type

  TMenuForm = class(TForm)

    DisplayPanel: TPanel;

    DemoShape: TShape;

    MainMenu: TMainMenu;

    Application1: TMenuItem;

    Exit1: TMenuItem;

    Color1: TMenuItem;

    Outline1: TMenuItem;

    Randomize1: TMenuItem;

    Select1: TMenuItem;

    Inside1: TMenuItem;

    Randomize2: TMenuItem;

    Select2: TMenuItem;

    Shape1: TMenuItem;

    Circle1: TMenuItem;

    Ellipse1: TMenuItem;

    Rectangle1: TMenuItem;

    Square1: TMenuItem;

    Misc1: TMenuItem;

    ThickOutline1: TMenuItem;

    RoundedShape1: TMenuItem;

    Help1: TMenuItem;

    About1: TMenuItem;

    SolidColorDialog: TColorDialog;

    AnyColorDialog: TColorDialog;

    PopupMenu: TPopupMenu;

    Random1: TMenuItem;

    RandomizeColors1: TMenuItem;

    InvertColors1: TMenuItem;

    procedure DisplayPanelResize(Sender: TObject);

    procedure Exit1Click(Sender: TObject);

    procedure Randomize1Click(Sender: TObject);

    procedure Select1Click(Sender: TObject);

    procedure Randomize2Click(Sender: TObject);

    procedure Select2Click(Sender: TObject);

    procedure Circle1Click(Sender: TObject);

    procedure Ellipse1Click(Sender: TObject);

    procedure Rectangle1Click(Sender: TObject);

    procedure Square1Click(Sender: TObject);

    procedure ThickOutline1Click(Sender: TObject);

    procedure RoundedShape1Click(Sender: TObject);

    procedure About1Click(Sender: TObject);

    procedure Random1Click(Sender: TObject);

    procedure RandomizeColors1Click(Sender: TObject);

    procedure InvertColors1Click(Sender: TObject);

  private

    { Private declarations }

    Roundable: Boolean;

    function RandomColor: TColor;

    procedure AlterShape(shape: TShapeType; roundable: Boolean);

  public

    { Public declarations }

  end;

const

  SHAPE_OFFSET = 4;

var

  MenuForm: TMenuForm;

implementation

uses about;

{$R *.DFM}

procedure TMenuForm.DisplayPanelResize(Sender: TObject);

begin

  DemoShape.Top := SHAPE_OFFSET;

  DemoShape.Left := DemoShape.Top;

  DemoShape.Height := DisplayPanel.Height - 2 * SHAPE_OFFSET;

  DemoShape.Width := DisplayPanel.Width - 2 * SHAPE_OFFSET;

end;

procedure TMenuForm.Exit1Click(Sender: TObject);

begin

  Close;

end;

function TMenuForm.RandomColor;

var

  red, green, blue: Byte;

begin

  red := Random(255);

  green := Random(255);

  blue := Random(255);

  Result := red or (green shl 8) or (blue shl 16);

end;

procedure TMenuForm.Randomize1Click(Sender: TObject);

begin

  DemoShape.Pen.Color := RandomColor;

end;

procedure TMenuForm.Select1Click(Sender: TObject);

begin

  try

    SolidColorDialog.Color := DemoShape.Pen.Color;

    if SolidColorDialog.Execute then

      DemoShape.Pen.Color := SolidColorDialog.Color;

  except

    ShowMessage('Color selection dialog failed to load');

  end;

end;

procedure TMenuForm.Randomize2Click(Sender: TObject);

begin

  DemoShape.Brush.Color := RandomColor;

end;

procedure TMenuForm.Select2Click(Sender: TObject);

begin

  AnyColorDialog.Color := DemoShape.Brush.Color;

  try

    if AnyColorDialog.Execute then

      DemoShape.Brush.Color := AnyColorDialog.Color;

  except

    ShowMessage('Color selection dialog failed to load.');

  end;

end;

procedure ToggleCheck(Sender: TObject);

var

  Item: TMenuItem;

begin

  Item := Sender as TMenuItem;

  Item.Checked := not Item.Checked;

end;

procedure SetCheck(Sender: TObject);

var

  Item: TMenuItem;

begin

  Item := Sender as TMenuItem;

  Item.Checked := True;

end;

procedure TMenuForm.AlterShape(shape: TShapeType; roundable: Boolean);

begin

  Self.Roundable := roundable;

  DemoShape.Shape := shape;

end;

procedure TMenuForm.Circle1Click(Sender: TObject);

begin

  SetCheck(Sender);

  AlterShape(stCircle, False);

end;

procedure TMenuForm.Ellipse1Click(Sender: TObject);

begin

  SetCheck(Sender);

  AlterShape(stEllipse, False);

end;

procedure TMenuForm.Rectangle1Click(Sender: TObject);

begin

  SetCheck(Sender);

  if RoundedShape1.Checked then

    AlterShape(stRoundRect, True)

  else

    AlterShape(stRectangle, True);

end;

procedure TMenuForm.Square1Click(Sender: TObject);

begin

  SetCheck(Sender);

  if RoundedShape1.Checked then

    AlterShape(stRoundSquare, True)

  else

    AlterShape(stSquare, True);

end;

procedure TMenuForm.ThickOutline1Click(Sender: TObject);

begin

  ToggleCheck(Sender);

  DemoShape.Pen.Width := 11 - DemoShape.Pen.Width;

end;

procedure TMenuForm.RoundedShape1Click(Sender: TObject);

begin

  ToggleCheck(Sender);

  case DemoShape.Shape of

    stRectangle:   DemoShape.Shape := stRoundRect;

    stRoundRect:   DemoShape.Shape := stRectangle;

    stSquare:      DemoShape.Shape := stRoundSquare;

    stRoundSquare: DemoShape.Shape := stSquare;

  end;

end;

procedure TMenuForm.About1Click(Sender: TObject);

var

  AboutBox: TAboutBox;

begin

  AboutBox := TAboutBox.Create(Self);

  try

    AboutBox.ShowModal;

  finally

    AboutBox.Free;

  end;

end;

procedure TMenuForm.Random1Click(Sender: TObject);

var

  newshape: TShapeType;

begin

  // Ensure we actually change the shape.

  repeat newshape := TShapeType(Random(6)) until

    newshape <> DemoShape.Shape;

  // Adjust the "Shape" and Rounded Shape" menu selections.

  case newshape of

    stEllipse: Ellipse1Click(Ellipse1);

    stCircle: Circle1Click(Circle1);

    stRectangle, stRoundRect:

      begin

        RoundedShape1.Checked := newshape = stRoundRect;

        Rectangle1Click(Rectangle1);

      end;

    stSquare, stRoundSquare:

      begin

        RoundedShape1.Checked := newshape = stRoundSquare;

        Square1Click(Square1);

      end;

    end;

end;

procedure TMenuForm.RandomizeColors1Click(Sender: TObject);

begin

  DemoShape.Brush.Color := RandomColor;

  DemoShape.Pen.Color := RandomColor;

end;

procedure TMenuForm.InvertColors1Click(Sender: TObject);

var

  i : Integer;

begin

  i := Integer(DemoShape.Brush.Color) xor $FFFFFF;

  DemoShape.Brush.Color := TColor(i);

end;

end.


TMenu example 1 (about.pas)

menudemo.pas	menuform.pas	menudemo.dfm	menuform.dfm	about.dfm

This example shows a simple about box for an application.

unit about;

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  StdCtrls;

type

  TAboutBox = class(TForm)

    Label1: TLabel;

    Label2: TLabel;

    Button1: TButton;

    procedure Button1Click(Sender: TObject);

  private

    { Private declarations }

  public

    { Public declarations }

  end;

var

  AboutBox: TAboutBox;

implementation

{$R *.DFM}

procedure TAboutBox.Button1Click(Sender: TObject);

begin

  Close;

end;

end.


TMenu example 1 (menuform.pas)

menudemo.pas	about.pas	menudemo.dfm	menuform.dfm	about.dfm

This is the code for the main form of the menu example.

unit menuform;

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  Menus, ExtCtrls;

type

  TForm1 = class(TForm)

    DisplayPanel: TPanel;

    DemoShape: TShape;

    MainMenu: TMainMenu;

    Application1: TMenuItem;

    Exit1: TMenuItem;

    Color1: TMenuItem;

    Outline1: TMenuItem;

    Randomize1: TMenuItem;

    Select1: TMenuItem;

    Inside1: TMenuItem;

    Randomize2: TMenuItem;

    Select2: TMenuItem;

    Shape1: TMenuItem;

    Circle1: TMenuItem;

    Ellipse1: TMenuItem;

    Rectangle1: TMenuItem;

    Square1: TMenuItem;

    Misc1: TMenuItem;

    ThickOutline1: TMenuItem;

    RoundedShape1: TMenuItem;

    Help1: TMenuItem;

    About1: TMenuItem;

    SolidColorDialog: TColorDialog;

    AnyColorDialog: TColorDialog;

    PopupMenu: TPopupMenu;

    Random1: TMenuItem;

    RandomizeColors1: TMenuItem;

    InvertColors1: TMenuItem;

    procedure DisplayPanelResize(Sender: TObject);

    procedure Exit1Click(Sender: TObject);

  private

    { Private declarations }

  public

    { Public declarations }

  end;

const

  SHAPE_OFFSET = 4;

var

  Form1: TForm1;

implementation

{$R *.DFM}

procedure TForm1.DisplayPanelResize(Sender: TObject);

begin

  DemoShape.Top := SHAPE_OFFSET;

  DemoShape.Left := DemoShape.Top;

  DemoShape.Height := DisplayPanel.Height - 2 * SHAPE_OFFSET;

  DemoShape.Width := DisplayPanel.Width - 2 * SHAPE_OFFSET;

end;

procedure TForm1.Exit1Click(Sender: TObject);

begin

  Close;

end;

end.


TMenu example 1 (menudemo.dfm)

menudemo.pas	menuform.pas	about.pas	menuform.dfm	about.dfm

object MenuForm: TMenuForm

  Left = 180

  Top = 233

  Width = 696

  Height = 480

  Caption = 'MenuForm'

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  Menu = MainMenu

  Position = poDefaultPosOnly

  ShowHint = True

  Visible = True

  PixelsPerInch = 96

  TextHeight = 13

  object DisplayPanel: TPanel

    Left = 0

    Top = 0

    Width = 688

    Height = 434

    Align = alClient

    BevelInner = bvLowered

    BevelOuter = bvLowered

    PopupMenu = PopupMenu

    TabOrder = 0

    OnResize = DisplayPanelResize

    object DemoShape: TShape

      Left = 120

      Top = 8

      Width = 193

      Height = 217

      Shape = stCircle

    end

  end

  object MainMenu: TMainMenu

    Left = 16

    Top = 56

    object Application1: TMenuItem

      Caption = '&Application'

      Hint = 'Simple command menu item'

      object Exit1: TMenuItem

        Caption = 'E&xit'

        Hint = 'Close the application'

        OnClick = Exit1Click

      end

    end

    object Color1: TMenuItem

      Caption = '&Color'

      Hint = 'Submenus'

      object Outline1: TMenuItem

        Caption = '&Outline'

        Hint = 'Adjust shape outline color'

        object Randomize1: TMenuItem

          Caption = '&Randomize'

          Hint = 'Set shape outline to a random color'

          OnClick = Randomize1Click

        end

        object Select1: TMenuItem

          Caption = '&Select...'

          Hint = 'Select shape outline color'

          OnClick = Select1Click

        end

      end

      object Inside1: TMenuItem

        Caption = '&Inside'

        Hint = 'Adjust shape inside color'

        object Randomize2: TMenuItem

          Caption = '&Randomize'

          Hint = 'Set shape inside to a random color'

          OnClick = Randomize2Click

        end

        object Select2: TMenuItem

          Caption = '&Select...'

          Hint = 'Select a color for the shape filling'

          OnClick = Select2Click

        end

      end

    end

    object Shape1: TMenuItem

      Caption = '&Shape'

      GroupIndex = 1

      Hint = 'Mutually-exclusive toggle group'

      object Circle1: TMenuItem

        Caption = '&Circle'

        Checked = True

        GroupIndex = 1

        Hint = 'Make the shape a circle'

        RadioItem = True

        OnClick = Circle1Click

      end

      object Ellipse1: TMenuItem

        Caption = '&Ellipse'

        GroupIndex = 1

        Hint = 'Make the shape an ellipse'

        RadioItem = True

        OnClick = Ellipse1Click

      end

      object Rectangle1: TMenuItem

        Caption = '&Rectangle'

        GroupIndex = 1

        Hint = 'Make the shape a rectangle'

        RadioItem = True

        OnClick = Rectangle1Click

      end

      object Square1: TMenuItem

        Caption = '&Square'

        GroupIndex = 1

        Hint = 'Make the shape a square'

        RadioItem = True

        OnClick = Square1Click

      end

    end

    object Misc1: TMenuItem

      Caption = '&Misc'

      GroupIndex = 1

      Hint = 'Simple checkable menu items with a superfluous bar break in between'

      object ThickOutline1: TMenuItem

        Caption = '&Thick Outline'

        Hint = 'Controls whether or not the outline is thick'

        OnClick = ThickOutline1Click

      end

      object RoundedShape1: TMenuItem

        Break = mbBarBreak

        Caption = '&Rounded Shape'

        Hint = 'Makes rectangle or square have rounded corners'

        OnClick = RoundedShape1Click

      end

    end

    object Help1: TMenuItem

      Caption = '&Help'

      GroupIndex = 1

      Hint = 'Simple command menu item'

      object About1: TMenuItem

        Caption = '&About...'

        Hint = 'Summons an About box'

        OnClick = About1Click

      end

    end

  end

  object SolidColorDialog: TColorDialog

    Ctl3D = True

    Options = [cdSolidColor]

    Left = 48

    Top = 56

  end

  object AnyColorDialog: TColorDialog

    Ctl3D = True

    Options = [cdAnyColor]

    Left = 80

    Top = 56

  end

  object PopupMenu: TPopupMenu

    Left = 16

    Top = 88

    object Random1: TMenuItem

      Caption = 'Randomize &Shape'

      OnClick = Random1Click

    end

    object RandomizeColors1: TMenuItem

      Caption = 'Randomize &Colors'

      OnClick = RandomizeColors1Click

    end

    object InvertColors1: TMenuItem

      Caption = '&Invert Inside Color'

      OnClick = InvertColors1Click

    end

  end

end


TMenu example 1 (about.dfm)

menudemo.pas	menuform.pas	about.pas	menudemo.dfm	menuform.dfm

object AboutBox: TAboutBox

  Left = 200

  Top = 108

  BorderIcons = []

  BorderStyle = bsDialog

  Caption = 'About Menu'

  ClientHeight = 134

  ClientWidth = 239

  Font.Charset = DEFAULT_CHARSET

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  Position = poScreenCenter

  PixelsPerInch = 96

  TextHeight = 13

  object Label1: TLabel

    Left = 60

    Top = 24

    Width = 123

    Height = 16

    Alignment = taCenter

    Caption = 'Menu Demonstration'

    Font.Charset = ANSI_CHARSET

    Font.Color = clBlack

    Font.Height = -13

    Font.Name = 'MS Sans Serif'

    Font.Style = []

    ParentFont = False

  end

  object Label2: TLabel

    Left = 32

    Top = 56

    Width = 186

    Height = 13

    Caption = 'Copyright (c) 1997 Borland International'

  end

  object Button1: TButton

    Left = 80

    Top = 88

    Width = 75

    Height = 25

    Caption = 'OK'

    TabOrder = 0

    OnClick = Button1Click

  end

end


TMenu example 1 (menuform.dfm)

menudemo.pas	menuform.pas	about.pas	menudemo.dfm	about.dfm

object Form1: TForm1

  Left = 134

  Top = 226

  Width = 696

  Height = 480

  Caption = 'Form1'

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  Menu = MainMenu

  Visible = True

  PixelsPerInch = 96

  TextHeight = 13

  object DisplayPanel: TPanel

    Left = 0

    Top = 0

    Width = 688

    Height = 434

    Align = alClient

    BevelInner = bvLowered

    BevelOuter = bvLowered

    Caption = 'DisplayPanel'

    PopupMenu = PopupMenu

    TabOrder = 0

    OnResize = DisplayPanelResize

    object DemoShape: TShape

      Left = 120

      Top = 8

      Width = 193

      Height = 217

      Shape = stCircle

    end

  end

  object MainMenu: TMainMenu

    Left = 16

    Top = 56

    object Application1: TMenuItem

      Caption = '&Application'

      Hint = 'Simple command menu item'

      object Exit1: TMenuItem

        Caption = 'E&xit'

        OnClick = Exit1Click

      end

    end

    object Color1: TMenuItem

      Caption = '&Color'

      Hint = 'Submenus'

      object Outline1: TMenuItem

        Caption = '&Outline'

        Hint = 'Adjust shape outline color'

        object Randomize1: TMenuItem

          Caption = '&Randomize'

          Hint = 'Set shape outline to a random color'

        end

        object Select1: TMenuItem

          Caption = '&Select...'

          Hint = 'Select shape outline color'

        end

      end

      object Inside1: TMenuItem

        Caption = '&Inside'

        Hint = 'Adjust shape inside color'

        object Randomize2: TMenuItem

          Caption = '&Randomize'

          Hint = 'Set shape inside to a random color'

        end

        object Select2: TMenuItem

          Caption = '&Select...'

          Hint = 'Select a color for the shape filling'

        end

      end

    end

    object Shape1: TMenuItem

      Caption = '&Shape'

      GroupIndex = 1

      Hint = 'Mutually-exclusive toggle group'

      object Circle1: TMenuItem

        Caption = '&Circle'

        Checked = True

        GroupIndex = 1

        Hint = 'Make the shape a circle'

        RadioItem = True

      end

      object Ellipse1: TMenuItem

        Caption = '&Ellipse'

        GroupIndex = 1

        Hint = 'Make the shape an ellipse'

        RadioItem = True

      end

      object Rectangle1: TMenuItem

        Caption = '&Rectangle'

        GroupIndex = 1

        Hint = 'Make the shape a rectangle'

        RadioItem = True

      end

      object Square1: TMenuItem

        Caption = '&Square'

        GroupIndex = 1

        Hint = 'Make the shape a square'

        RadioItem = True

      end

    end

    object Misc1: TMenuItem

      Caption = '&Misc'

      GroupIndex = 1

      Hint = 'Simple checkable menu items with a superfluous bar break in between'

      object ThickOutline1: TMenuItem

        Caption = '&Thick Outline'

        Hint = 'Controls whether or not the outline is thick'

      end

      object RoundedShape1: TMenuItem

        Break = mbBarBreak

        Caption = '&Rounded Shape'

        Hint = 'Makes rectangle or square have rounded corners'

      end

    end

    object Help1: TMenuItem

      Caption = '&Help'

      GroupIndex = 1

      Hint = 'Simple command menu item'

      object About1: TMenuItem

        Caption = '&About...'

        Hint = 'Summons an About box'

      end

    end

  end

  object SolidColorDialog: TColorDialog

    Ctl3D = True

    Options = [cdSolidColor]

    Left = 48

    Top = 56

  end

  object AnyColorDialog: TColorDialog

    Ctl3D = True

    Options = [cdAnyColor]

    Left = 80

    Top = 56

  end

  object PopupMenu: TPopupMenu

    Left = 16

    Top = 88

    object Random1: TMenuItem

      Caption = 'Randomize &Shape'

    end

    object RandomizeColors1: TMenuItem

      Caption = 'Randomize &Colors'

    end

    object InvertColors1: TMenuItem

      Caption = '&Invert Inside Color'

    end

  end

end


TMenu example 2
TMenu example 2 (umnudmo.pas)

umnudmo.dfm

Objects

The example demonstrates using TMainMenu, TMenuItem, and TPopupMenu objects. To run this example, load the project file from the Help\Examples\Menu2 directory.

Description

This example demonstrates creating a main menu, menu items, and a popup menu.

unit UMnuDmo;

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  StdCtrls, ExtCtrls,Menus;

type

  TForm1 = class(TForm)

    Panel1: TPanel;

    Button1: TButton;

    Button2: TButton;

    Button3: TButton;

    Button4: TButton;

    Button5: TButton;

    Button6: TButton;

    Button7: TButton;

    Button8: TButton;

    Button9: TButton;

    procedure Button1Click(Sender: TObject);

    procedure Button2Click(Sender: TObject);

    procedure Button7Click(Sender: TObject);

    procedure Button3Click(Sender: TObject);

    procedure MyPopupHandler(Sender: TObject);

    procedure Button4Click(Sender: TObject);

    procedure Button5Click(Sender: TObject);

    procedure Button6Click(Sender: TObject);

    procedure Button8Click(Sender: TObject);

    procedure Button9Click(Sender: TObject);

  private

    { Private declarations }

  public

    { Public declarations }

  end;

var

  Form1: TForm1;

  MyMainMenu: TMainMenu;

  MyPopUpMenu: TPopUpMenu;

  MySubItem1,MySubItem2 : TMenuItem;

  MySubItems: array[0..3] of TMenuItem;

  MyPopUpItems: array[0..3] of TMenuItem;

implementation

{$R *.DFM}

procedure TForm1.MyPopupHandler(Sender: TObject);

begin

  with Sender as TMenuItem do begin

    ShowMessage(Caption);

  end;

end;

procedure TForm1.Button1Click(Sender: TObject);

begin

  MyMainMenu:= TMainMenu.Create(Self);

  Button4.Enabled := true;

  ShowMessage('MainMenu created but no items' + #13+

              'are added so it does not show.');

  Button1.Enabled := False;

end;

procedure TForm1.Button2Click(Sender: TObject);

begin

  MyPopUpMenu := TPopUpMenu.Create(self);

  Button3.Enabled := true;

  ShowMessage('PopUpMenu created.');

  Button2.Enabled := False;

end;

procedure TForm1.Button7Click(Sender: TObject);

begin

  MyPopUpMenu.Popup(Form1.Left + 60, Form1.Top + 140);

  Button9.Enabled := true;

end;

procedure TForm1.Button3Click(Sender: TObject);

var

  i: Integer;

begin

  for i := 0 to 3 do begin

    MyPopUpItems[i] := TMenuItem.Create(Self);

    MyPopUpItems[i].Caption := 'New item ' + IntToStr(i);

    MyPopUpMenu.Items.Add(MyPopUpItems[i]);

  end;

  Button7.Enabled := true;

  Button3.Enabled := False;

end;

procedure TForm1.Button4Click(Sender: TObject);

var

  MyItem: array[0..2] of TMenuItem;

  i: Integer;

begin

  for i := 0 to 2 do begin

    MyItem[i] := TMenuItem.Create(Self);

    MyItem[i].Caption := 'New item ' + IntToStr(i);

    MyMainMenu.Items.Add(MyItem[i]);

    end;

  Button4.Enabled := False;

  Button5.Enabled := true;

end;

procedure TForm1.Button5Click(Sender: TObject);

var

  i: Integer;

begin

  for i := 0 to 3 do begin

    MySubItems[i] := TMenuItem.Create(Self);

    MySubItems[i].Caption := 'New item ' + IntToStr(i);

    MySubItems[i].OnClick := MyPopUpHandler;

    MyMainMenu.Items[0].Add(MySubItems[i]);

  end;

  Button6.Enabled := true;

  Button8.Enabled := true;

  Button5.Enabled := False;

end;

procedure TForm1.Button6Click(Sender: TObject);

begin

  MySubItems[3].Break := mbBarBreak;

end;

procedure TForm1.Button8Click(Sender: TObject);

begin

  MySubItems[2].Caption :='-';

end;

procedure TForm1.Button9Click(Sender: TObject);

var

  i: Integer;

begin

  for i := 0 to 3 do begin

    MyPopUpItems[i].OnClick := MyPopupHandler;

  end;

end;

end.


TMenu example 2 (umnudmo.dfm)

umnudmo.pas

object Form1: TForm1

  Left = 199

  Top = 67

  Width = 467

  Height = 341

  Caption = 'Menu Demo'

  Font.Charset = DEFAULT_CHARSET

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  PixelsPerInch = 96

  TextHeight = 13

  object Panel1: TPanel

    Left = 56

    Top = 56

    Width = 345

    Height = 209

    TabOrder = 0

    object Button1: TButton

      Left = 32

      Top = 16

      Width = 110

      Height = 25

      Caption = 'Create Main Menu'

      TabOrder = 0

      OnClick = Button1Click

    end

    object Button2: TButton

      Left = 200

      Top = 14

      Width = 110

      Height = 25

      Caption = 'Create PopUp Menu'

      TabOrder = 1

      OnClick = Button2Click

    end

    object Button3: TButton

      Left = 200

      Top = 52

      Width = 110

      Height = 25

      Caption = 'Add PopUp Items'

      Enabled = False

      TabOrder = 2

      OnClick = Button3Click

    end

    object Button4: TButton

      Left = 32

      Top = 54

      Width = 110

      Height = 25

      Caption = 'Add Main Items'

      Enabled = False

      TabOrder = 3

      OnClick = Button4Click

    end

    object Button5: TButton

      Left = 32

      Top = 92

      Width = 110

      Height = 25

      Caption = 'Add Sub-Menu'

      Enabled = False

      TabOrder = 4

      OnClick = Button5Click

    end

    object Button6: TButton

      Left = 32

      Top = 130

      Width = 110

      Height = 25

      Caption = 'Add  Vertical Break'

      Enabled = False

      TabOrder = 5

      OnClick = Button6Click

    end

    object Button7: TButton

      Left = 200

      Top = 90

      Width = 110

      Height = 25

      Caption = 'Show PopUp'

      Enabled = False

      TabOrder = 6

      OnClick = Button7Click

    end

    object Button8: TButton

      Left = 32

      Top = 168

      Width = 110

      Height = 25

      Caption = 'Add Horizontal Break'

      Enabled = False

      TabOrder = 7

      OnClick = Button8Click

    end

    object Button9: TButton

      Left = 200

      Top = 128

      Width = 110

      Height = 25

      Caption = 'Assign OnClick Event'

      Enabled = False

      TabOrder = 8

      OnClick = Button9Click

    end

  end

end


TBitmap example
TBitmap example (bmpformu.pas)

bmpformu.dfm

Objects

The example demonstrates using the TBitmap object. To run this example, load the project file from the Help\Examples\Bitmap directory.

Description

This example demonstrates changing the palette of a TBitmap object. A TBitmap is an encapsulation of the windows BITMAP and PALETTE which manages realizing of the palette automatically. The bitmap can be loaded from a .BMP file (LoadFromFile method) or a resource (LoadFromResourceName or LoadFromResourceID method) and saved back to a file (SaveToFile method).  It can be drawn on a canvas by using the TCanvas' Draw or StretchDraw method.  The size of the bitmap can be determined by using the Height and Width properties of TBitmap.

The example below illustrates the use of TBitmap�s Palette, LoadFromFile, Draw, Height, and Width. Be sure that a small bitmap file named bor6.bmp is present in the same directory as the .exe file.

Disclaimer

This is an example of using TBitmaps and is not intended to be an efficient method of tiling a form.

unit bmpformu;

//

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  StdCtrls;

type

  TBmpForm = class(TForm)

    Button1: TButton;

    procedure FormDestroy(Sender: TObject);

    procedure FormPaint(Sender: TObject);

    procedure Button1Click(Sender: TObject);

    procedure FormCreate(Sender: TObject);

  private

    { Private declarations }

    Bitmap: TBitmap;

    procedure ScrambleBitmap;

    procedure WMEraseBkgnd(var m: TWMEraseBkgnd); message WM_ERASEBKGND;

  public

    { Public declarations }

  end;

var

  BmpForm: TBmpForm;

implementation

{$R *.DFM}

procedure TBmpForm.FormCreate(Sender: TObject);

begin

  Bitmap := TBitmap.Create;

  Bitmap.LoadFromFile('bor6.bmp');

end;

procedure TBmpForm.FormDestroy(Sender: TObject);

begin

  Bitmap.Free;

end;

// since we're going to be painting the whole form, handling this

// message will suppress the uneccessary repainting of the background

// which can result in flicker.

procedure TBmpform.WMEraseBkgnd(var m : TWMEraseBkgnd);

begin

  m.Result := LRESULT(False);

end;

procedure TBmpForm.FormPaint(Sender: TObject);

var

  x, y: Integer;

begin

  y := 0;

  while y < Height do

  begin

    x := 0;

    while x < Width do

    begin

      Canvas.Draw(x, y, Bitmap);

      x := x + Bitmap.Width;

    end;

    y := y + Bitmap.Height;

  end;

end;

procedure TBmpForm.Button1Click(Sender: TObject);

begin

  ScrambleBitmap;

  Invalidate;

end;

//

// scrambling the bitmap is easy when it's has 256 colors:

// we just need to change each of the color in the palette

// to some other value.

//

procedure TBmpForm.ScrambleBitmap;

var

  pal: PLogPalette;

  hpal: HPALETTE;

  i: Integer;

begin

  pal := nil;

  try

    GetMem(pal, sizeof(TLogPalette) + sizeof(TPaletteEntry) * 255);

    pal.palVersion := $300;

    pal.palNumEntries := 256;

    for i := 0 to 255 do

    begin

      pal.palPalEntry[i].peRed := Random(255);

      pal.palPalEntry[i].peGreen := Random(255);

      pal.palPalEntry[i].peBlue := Random(255);

    end;

    hpal := CreatePalette(pal^);

    if hpal <> 0 then

      Bitmap.Palette := hpal;

  finally

    FreeMem(pal);

  end;

end;

end.


TBitmap example (bmpformu.dfm)

bmpformu.pas

object BmpForm: TBmpForm

  Left = 311

  Top = 321

  Width = 466

  Height = 334

  Caption = 'BmpForm'

  Font.Charset = DEFAULT_CHARSET

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  OnCreate = FormCreate

  OnDestroy = FormDestroy

  OnPaint = FormPaint

  PixelsPerInch = 96

  TextHeight = 13

  object Button1: TButton

    Left = 56

    Top = 40

    Width = 113

    Height = 25

    Caption = 'Scramble Palette'

    TabOrder = 0

    OnClick = Button1Click

  end

end


TRegIniFile example
TRegIniFile example (regini.pas)

reginid.pas	reginid.dfm

Objects

The example demonstrates using TRegIniFile, TGroupBox, TLabel, TCheckBox, TRadioGroup, TEdit and TMemo objects. To run this example, load the project file from the Help\Examples\Regini directory.

Description

This example demonstrates using a TRegIniFile object to make changes to the Windows registry.  Changes made to the system registry will not be permanent and will be deleted upon termination of the example application.

program regini;

uses

  Forms,

  reginid in 'reginid.pas' {Form1};

{$R *.RES}

begin

  Application.Initialize;

  Application.CreateForm(TForm1, Form1);

  Application.Run;

end.


TRegIniFile example (reginid.pas)

regini.pas	reginid.dfm

unit reginid;

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  StdCtrls, ExtCtrls, Registry;

type

  TRegIniForm = class(TForm)

    GroupBox1: TGroupBox;

    Label1: TLabel;

    CheckBox_Write: TCheckBox;

    RadioGroup_Write: TRadioGroup;

    Edit_Write: TEdit;

    GroupBox2: TGroupBox;

    Label3: TLabel;

    CheckBox_Read: TCheckBox;

    RadioGroup_Read: TRadioGroup;

    Edit_Read: TEdit;

    Memo_Read: TMemo;

    Button_Write: TButton;

    Button_Read: TButton;

    procedure FormCreate(Sender: TObject);

    procedure FormDestroy(Sender: TObject);

    procedure Button_WriteClick(Sender: TObject);

    procedure Button_ReadClick(Sender: TObject);

    procedure CheckBox_ReadClick(Sender: TObject);

    procedure RadioGroup_ReadClick(Sender: TObject);

  private

    { Private declarations }

    procedure Read_Registry;

    procedure Write_Registry;

  public

    { Public declarations }

    FIniFile: TRegIniFile;

  end;

var

  RegIniForm: TRegIniForm;

implementation

{$R *.DFM}

const

  SECTION = 'Sample';

procedure TRegIniForm.FormCreate(Sender: TObject);

begin

  FIniFile := TRegIniFile.Create('Sample Registry');

end;

procedure TRegIniForm.FormDestroy(Sender: TObject);

var

  Cleanup: TRegistry;

  key: string;

begin

  key := FIniFile.FileName;

  FIniFile.Free;

  // make sure we don't leave junk in the registry behind.

  Cleanup := TRegistry.Create;

  try

    Cleanup.DeleteKey(key);

  finally

    Cleanup.Free;

  end;

end;

procedure TRegIniForm.Write_Registry;

begin

  FIniFile.WriteBool(SECTION, 'BooleanTest', CheckBox_Write.Checked);

  FIniFile.WriteInteger(SECTION, 'IntegerTest', RadioGroup_Write.ItemIndex);

  FIniFile.WriteString(SECTION, 'StringTest', Edit_Write.Text);

  if not Button_Read.Enabled then Button_Read.Enabled := True;

end;

procedure TRegIniForm.Read_Registry;

begin

  CheckBox_Read.Checked := FIniFile.ReadBool(SECTION, 'BooleanTest', False);

  RadioGroup_Read.ItemIndex := FIniFile.ReadInteger(SECTION, 'IntegerTest', 0);

  Edit_Read.Text := FIniFile.ReadString(SECTION, 'StringTest', '');

  Memo_Read.Lines.Clear;

  FIniFile.ReadSectionValues(SECTION, Memo_Read.Lines);

  Button_Read.Enabled := False;

end;

procedure TRegIniForm.Button_WriteClick(Sender: TObject);

begin

  Write_Registry;

end;

procedure TRegIniForm.Button_ReadClick(Sender: TObject);

begin

  Read_Registry;

end;

procedure TRegIniForm.CheckBox_ReadClick(Sender: TObject);

begin

  Read_Registry;

end;

procedure TRegIniForm.RadioGroup_ReadClick(Sender: TObject);

begin

  Read_Registry;

end;

end.


TRegIniFile example (reginid.dfm)

regini.pas	reginid.pas

object RegIniForm: TRegIniForm

  Left = 200

  Top = 108

  Width = 476

  Height = 264

  Caption = 'RegIniForm'

  Font.Charset = DEFAULT_CHARSET

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  OnCreate = FormCreate

  OnDestroy = FormDestroy

  PixelsPerInch = 96

  TextHeight = 13

  object GroupBox1: TGroupBox

    Left = 8

    Top = 16

    Width = 145

    Height = 169

    Caption = 'Write to Registry'

    TabOrder = 0

    object Label1: TLabel

      Left = 16

      Top = 120

      Width = 51

      Height = 13

      Caption = 'String Test'

    end

    object CheckBox_Write: TCheckBox

      Left = 16

      Top = 24

      Width = 97

      Height = 17

      Caption = 'Boolean Test'

      TabOrder = 0

    end

    object RadioGroup_Write: TRadioGroup

      Left = 16

      Top = 48

      Width = 105

      Height = 65

      Caption = 'Interger Test'

      Columns = 3

      ItemIndex = 0

      Items.Strings = (

        '0'

        '1'

        '2'

        '3'

        '4'

        '5')

      TabOrder = 1

    end

    object Edit_Write: TEdit

      Left = 16

      Top = 136

      Width = 105

      Height = 21

      TabOrder = 2

      Text = 'Edit_Write'

    end

  end

  object GroupBox2: TGroupBox

    Left = 160

    Top = 16

    Width = 289

    Height = 169

    Caption = 'Read from Registry'

    TabOrder = 1

    object Label3: TLabel

      Left = 16

      Top = 120

      Width = 51

      Height = 13

      Caption = 'String Test'

    end

    object CheckBox_Read: TCheckBox

      Left = 16

      Top = 24

      Width = 97

      Height = 17

      Caption = 'Boolean Test'

      TabOrder = 0

      OnClick = CheckBox_ReadClick

    end

    object RadioGroup_Read: TRadioGroup

      Left = 16

      Top = 48

      Width = 105

      Height = 65

      Caption = 'Interger Test'

      Columns = 3

      ItemIndex = 0

      Items.Strings = (

        '0'

        '1'

        '2'

        '3'

        '4'

        '5')

      TabOrder = 1

      OnClick = RadioGroup_ReadClick

    end

    object Edit_Read: TEdit

      Left = 16

      Top = 136

      Width = 105

      Height = 21

      ReadOnly = True

      TabOrder = 2

      Text = 'Edit_Read'

    end

    object Memo_Read: TMemo

      Left = 144

      Top = 24

      Width = 129

      Height = 137

      Lines.Strings = (

        '')

      ReadOnly = True

      TabOrder = 3

    end

  end

  object Button_Write: TButton

    Left = 24

    Top = 200

    Width = 105

    Height = 25

    Caption = 'Write to Registry'

    TabOrder = 2

    OnClick = Button_WriteClick

  end

  object Button_Read: TButton

    Left = 176

    Top = 200

    Width = 105

    Height = 25

    Caption = 'Read from Registry'

    TabOrder = 3

    OnClick = Button_ReadClick

  end

end


TScrollBar example
TScrollBar example (scroldem.pas)

scroldem.dfm

Objects

The example demonstrates using TScrollBar, TImage, TEdit, TUpDown, TOpenDialog, TMenuItem, TBevel, TLabel and TPanel objects. To run this example, load the project file from the Help\Examples\Scrollba directory.

Description

This example demonstrates the use of TScrollBar, including how to properly set scrolling ranges and how to respond to the scroll bar notification events.  In addition, an interface is provided for the user to adjust the values to see how the different parameters affect the scrolling behavior.  No attempt is made to verify that the parameters supplied by the user make any sense.

unit scroldem;

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  Menus, StdCtrls, ComCtrls, ExtCtrls;

type

  TScrollForm1 = class(TForm)

    Bevel1: TBevel;

    Label3: TLabel;

    Label4: TLabel;

    Label5: TLabel;

    Label1: TLabel;

    Vertical: TLabel;

    ImgPanel: TPanel;

    Image: TImage;

    HScrollb: TScrollBar;

    VScrollb: TScrollBar;

    HUnits: TEdit;

    HPage: TEdit;

    HMax: TEdit;

    VUnits: TEdit;

    VPage: TEdit;

    VMax: TEdit;

    HUnitsUpDown: TUpDown;

    HPageUpDown: TUpDown;

    HMaxUpDown: TUpDown;

    VUnitsUpDown: TUpDown;

    VMaxUpDown: TUpDown;

    VPageUpDown: TUpDown;

    DefaultBtn: TButton;

    ApplyBtn: TButton;

    MainMenu1: TMainMenu;

    File1: TMenuItem;

    Open1: TMenuItem;

    N1: TMenuItem;

    Exit1: TMenuItem;

    View1: TMenuItem;

    VScrollMenu: TMenuItem;

    HScrollMenu: TMenuItem;

    Help1: TMenuItem;

    About1: TMenuItem;

    OpenDialog: TOpenDialog;

    procedure FormCreate(Sender: TObject);

    procedure Exit1Click(Sender: TObject);

    procedure View1Click(Sender: TObject);

    procedure VScrollMenuClick(Sender: TObject);

    procedure HScrollMenuClick(Sender: TObject);

    procedure Open1Click(Sender: TObject);

    procedure VScrollbChange(Sender: TObject);

    procedure HScrollbScroll(Sender: TObject; ScrollCode: TScrollCode; var ScrollPos: Integer);

    procedure ImgPanelResize(Sender: TObject);

    procedure About1Click(Sender: TObject);

    procedure ApplyBtnClick(Sender: TObject);

    procedure DefaultBtnClick(Sender: TObject);

    procedure UpDownClick(Sender: TObject; Button: TUDBtnType);

  private

    { Private declarations }

    Units: TPoint;

    FDirty: Boolean;

    procedure SetDirty(d: Boolean);

    procedure ImageLoad(filename: string);

    procedure ScrollAdjust(update: Boolean);

    procedure ScrollReset;

    procedure UpdateDisplay;

    property Dirty: Boolean read FDirty write SetDirty;

  public

    //constructor Create(Owner: TComponent); override;

    { Public declarations }

  end;

var

  ScrollForm1: TScrollForm1;

implementation

uses about;

{$R *.DFM}

const

  DEF_SCROLL_UNITS = 8;

procedure TScrollForm1.FormCreate(Sender: TObject);

begin

  ScrollReset;

end;

procedure TScrollForm1.Exit1Click(Sender: TObject);

begin

  Close;

end;

procedure TScrollForm1.View1Click(Sender: TObject);

begin

  HScrollMenu.Checked := HScrollb.Visible;

  VScrollMenu.Checked := VScrollb.Visible;

end;

procedure TScrollForm1.VScrollMenuClick(Sender: TObject);

begin

  VScrollb.Visible := not VScrollb.Visible;

end;

procedure TScrollForm1.HScrollMenuClick(Sender: TObject);

begin

  HScrollb.Visible := not HScrollb.Visible;

end;

procedure TScrollForm1.Open1Click(Sender: TObject);

begin

  if OpenDialog.Execute then

    ImageLoad(OpenDialog.FileName);

end;

//

// Hooking the OnChange event is the simplest way to handle the

// scrollbar notification.  Note the check to ensure that the

// that the sender is the vertical scrollbar.  While irrelevant for

// this example, some forms may need to distinguish between various

// scrollbars.

//

procedure TScrollForm1.VScrollbChange(Sender: TObject);

begin

  if Sender as TScrollBar = VScrollb then

    Image.Top := -Units.y * VScrollb.Position;

end;

//

// Hooking the OnScroll event is another option for handling the

// scrollbar notification.  This is needed for a few reasons:

//   1) you want to do something special with particular scroll

//      events

//   2) the range of your scrollbar is larger than [0, 65535].  in

//      this case, the ScrollPos element is invalid and much of the

//      scrolling has to be done manually.

//

procedure TScrollForm1.HScrollbScroll(Sender: TObject; ScrollCode: TScrollCode; var ScrollPos: Integer);

begin

  if HScrollb.Max <= 65535 then

    Image.Left := -Units.x * ScrollPos

  else

    ShowMessage('Scrollbar ranges > 65535 not supported');

end;

//

// The panel's size doesn't change in this example, so

// this event will only happen once.  In general, the range

// of the scrollbars will need to be changed when the size of

// the visible window is changed.

//

procedure TScrollForm1.ImgPanelResize(Sender: TObject);

begin

  ScrollAdjust(True);

end;

function scale(n, u: Integer): Integer;

begin

  Result := (n + u - 1) div u;

end;

function maxval(a, b: Integer): Integer;

begin

  if a >= b then

    Result := a

  else

    Result := b;

end;

//

// Readjust the range of the scrollbars to match the new size

// of the visible window.  (Also called by ScrollReset to avoid

// duplicating the code).

//

procedure TScrollForm1.ScrollAdjust(update: Boolean);

begin

  // set the maximum scrolling to be large enough to scroll the whole

  // image, but not so much that it can scroll off the window.  we

  // divide by the number of Units (>1) because scrolling one pixel at

  // a time is way too slow for most images of any size.

  if Image.Picture <> nil then

  begin

    HScrollb.Max := maxval(0, scale(Image.Width - ImgPanel.Width, Units.x));

    VScrollb.Max := maxval(0, scale(Image.Height - ImgPanel.Height, Units.y));

  end;

  if update then

    UpdateDisplay;

end;

//

// ScrollReset() is used to put the scrollbars into a sane "initial"

// state.  this needs to be done each time the image is changed,

// since the amount we scroll depends upon the image size.  for

// simplicity, the special case of "new image size" == "old image size"

// is ignored.

//

procedure TScrollForm1.ScrollReset;

begin

  // this fixed size works nice, although in some cases basing

  // the scroll units upon the size of the image works well, too.

  Units.x := DEF_SCROLL_UNITS;

  Units.y := DEF_SCROLL_UNITS;

  if Image.Picture <> nil then

  begin

    // move the image and the scrollbars to their "home" location

    Image.Top := 0;

    Image.Left := 0;

    HScrollb.Position := 0;

    VScrollb.Position := 0;

    // negative scrolling ranges aren't worth the trouble, so set

    // the range to go from [0, M].  See 'ScrollAdjust' to see how M

    // is calculated.

    HScrollb.Min := 0;

    VScrollb.Min := 0;

    ScrollAdjust(False);

    HScrollb.LargeChange := scale(HScrollb.Max, Units.x);

    VScrollb.LargeChange := scale(VScrollb.Max, Units.y);

    HScrollb.Visible := True;

    VScrollb.Visible := True;

  end;

  UpdateDisplay;

end;

procedure TScrollForm1.SetDirty(d: Boolean);

begin

  if d <> FDirty then

  begin

    FDirty := d;

    ApplyBtn.Enabled := FDirty;

  end;

end;

procedure TScrollForm1.ImageLoad(filename: string);

begin

  Image.Picture.LoadFromFile(filename);

  ScrollReset;

end;

procedure TScrollForm1.About1Click(Sender: TObject);

var

  about: TAboutBox;

begin

  about := TAboutBox.Create(Self);

  try

    about.ShowModal;

  finally

    about.Free;

  end;

end;

procedure TScrollForm1.ApplyBtnClick(Sender: TObject);

begin

  Units.x := HUnitsUpDown.Position;

  HScrollb.LargeChange := HPageUpDown.Position;

  HScrollb.Max := HMaxUpDown.Position;

  Units.y := VUnitsUpDown.Position;

  VScrollb.LargeChange := VPageUpDown.Position;

  VScrollb.Max := VMaxUpDown.Position;

  Dirty := False;

end;

procedure TScrollForm1.DefaultBtnClick(Sender: TObject);

begin

  ScrollReset;

  Dirty := False;

end;

procedure TScrollForm1.UpDownClick(Sender: TObject; Button: TUDBtnType);

begin

  Dirty := True;

end;

procedure TScrollForm1.UpdateDisplay;

begin

  HUnitsUpDown.Position := Units.x;

  HPageUpDown.Position := HScrollb.LargeChange;

  HMaxUpDown.Position := HScrollb.Max;

  VUnitsUpDown.Position := Units.y;

  VPageUpDown.Position := VScrollb.LargeChange;

  VMaxUpDown.Position := VScrollb.Max;

  Dirty := False;

end;

end.


TScrollBar example (scroldem.dfm)

scroldem.pas

object ScrollForm1: TScrollForm1

  Left = 200

  Top = 108

  BorderIcons = [biSystemMenu, biMinimize]

  BorderStyle = bsSingle

  Caption = 'ScrollDemo'

  ClientHeight = 194

  ClientWidth = 436

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  Menu = MainMenu1

  OnCreate = FormCreate

  PixelsPerInch = 96

  TextHeight = 13

  object Bevel1: TBevel

    Left = 0

    Top = 0

    Width = 436

    Height = 9

    Align = alTop

    Shape = bsTopLine

  end

  object Label3: TLabel

    Left = 238

    Top = 42

    Width = 24

    Height = 13

    Caption = 'Units'

  end

  object Label4: TLabel

    Left = 198

    Top = 78

    Width = 64

    Height = 13

    Caption = 'LargeChange'

  end

  object Label5: TLabel

    Left = 242

    Top = 117

    Width = 20

    Height = 13

    Caption = 'Max'

  end

  object Label1: TLabel

    Left = 280

    Top = 16

    Width = 47

    Height = 13

    Caption = 'Horizontal'

  end

  object Vertical: TLabel

    Left = 376

    Top = 16

    Width = 35

    Height = 13

    Caption = 'Vertical'

  end

  object HScrollb: TScrollBar

    Left = 9

    Top = 169

    Width = 159

    Height = 16

    Max = 32767

    TabOrder = 1

    OnScroll = HScrollbScroll

  end

  object VScrollb: TScrollBar

    Left = 169

    Top = 9

    Width = 16

    Height = 157

    Kind = sbVertical

    TabOrder = 2

    OnChange = VScrollbChange

  end

  object HUnits: TEdit

    Left = 275

    Top = 38

    Width = 48

    Height = 20

    ReadOnly = True

    TabOrder = 3

    Text = '1'

  end

  object HPage: TEdit

    Left = 275

    Top = 74

    Width = 48

    Height = 20

    ReadOnly = True

    TabOrder = 4

    Text = '0'

  end

  object HMax: TEdit

    Left = 276

    Top = 113

    Width = 48

    Height = 20

    ReadOnly = True

    TabOrder = 5

    Text = '0'

  end

  object VUnits: TEdit

    Left = 363

    Top = 38

    Width = 48

    Height = 20

    ReadOnly = True

    TabOrder = 6

    Text = '1'

  end

  object VPage: TEdit

    Left = 363

    Top = 74

    Width = 48

    Height = 20

    ReadOnly = True

    TabOrder = 7

    Text = '0'

  end

  object VMax: TEdit

    Left = 363

    Top = 113

    Width = 48

    Height = 20

    ReadOnly = True

    TabOrder = 8

    Text = '0'

  end

  object HUnitsUpDown: TUpDown

    Left = 323

    Top = 38

    Width = 16

    Height = 20

    Associate = HUnits

    Min = 1

    Max = 32767

    Position = 1

    TabOrder = 9

    Wrap = False

    OnClick = UpDownClick

  end

  object HPageUpDown: TUpDown

    Left = 323

    Top = 74

    Width = 16

    Height = 20

    Associate = HPage

    Min = 0

    Max = 32767

    Position = 0

    TabOrder = 10

    Wrap = False

    OnClick = UpDownClick

  end

  object HMaxUpDown: TUpDown

    Left = 324

    Top = 113

    Width = 16

    Height = 20

    Associate = HMax

    Min = 0

    Max = 32767

    Position = 0

    TabOrder = 11

    Wrap = False

    OnClick = UpDownClick

  end

  object VUnitsUpDown: TUpDown

    Left = 411

    Top = 38

    Width = 16

    Height = 20

    Associate = VUnits

    Min = 1

    Max = 32767

    Position = 1

    TabOrder = 12

    Wrap = False

    OnClick = UpDownClick

  end

  object VMaxUpDown: TUpDown

    Left = 411

    Top = 113

    Width = 16

    Height = 20

    Associate = VMax

    Min = 0

    Max = 32767

    Position = 0

    TabOrder = 13

    Wrap = False

    OnClick = UpDownClick

  end

  object VPageUpDown: TUpDown

    Left = 411

    Top = 74

    Width = 16

    Height = 20

    Associate = VPage

    Min = 0

    Max = 32767

    Position = 0

    TabOrder = 14

    Wrap = False

    OnClick = UpDownClick

  end

  object DefaultBtn: TButton

    Left = 348

    Top = 157

    Width = 75

    Height = 25

    Caption = '&Defaults'

    ParentShowHint = False

    ShowHint = False

    TabOrder = 15

    OnClick = DefaultBtnClick

  end

  object ApplyBtn: TButton

    Left = 265

    Top = 157

    Width = 75

    Height = 25

    Caption = '&Apply'

    Enabled = False

    TabOrder = 16

    OnClick = ApplyBtnClick

  end

  object ImgPanel: TPanel

    Left = 8

    Top = 8

    Width = 160

    Height = 160

    BevelOuter = bvNone

    BorderStyle = bsSingle

    TabOrder = 0

    object Image: TImage

      Left = 0

      Top = 0

      Width = 600

      Height = 470

      AutoSize = True

      Picture.Data = {

// rest of bitmap goes here

                }

       end

  end

  object MainMenu1: TMainMenu

    Left = 196

    Top = 159

    object File1: TMenuItem

      Caption = '&File'

      object Open1: TMenuItem

        Caption = '&Open...'

        OnClick = Open1Click

      end

      object N1: TMenuItem

        Caption = '-'

      end

      object Exit1: TMenuItem

        Caption = 'E&xit'

        OnClick = Exit1Click

      end

    end

    object View1: TMenuItem

      Caption = '&Scroll'

      OnClick = View1Click

      object VScrollMenu: TMenuItem

        Caption = '&Vertical'

        OnClick = VScrollMenuClick

      end

      object HScrollMenu: TMenuItem

        Caption = '&Horizontal'

        OnClick = HScrollMenuClick

      end

    end

    object Help1: TMenuItem

      Caption = '&Help'

      object About1: TMenuItem

        Caption = '&About...'

        OnClick = About1Click

      end

    end

  end

  object OpenDialog: TOpenDialog

    DefaultExt = '.bmp'

    FileEditStyle = fsEdit

    Filter = 'Images (*.bmp;*.ico)|*.bmp;*.ico|Bitmaps (*.bmp)|*.bmp|Icons (*.ico)|*.ico'

    Options = [ofHideReadOnly, ofPathMustExist, ofFileMustExist]

    Left = 230

    Top = 158

  end

end


TProgressBar example
TProgressBar example (pg1.pas)

pg1.dfm

Objects

The example demonstrates using the TProgressBar object. To run this example, load the project file from the Help\Examples\PrgrsBar directory.

Description

This example creates a TProgressBar control, aligned to the bottom of the form. A for loop represents a lengthy process, and within that loop, the TProgressBar position is updated.  At the conclusion of the example, the component is freed from memory.

For another example using TProgress bar see Technical Information Document #3103 on our website: www.borland.com/techsupport/delphi/techdocs/bds.html.

unit PG1;

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  StdCtrls;

type

  TForm1 = class(TForm)

    Button1: TButton;

    procedure Button1Click(Sender: TObject);

   end;

var

  Form1: TForm1;

implementation

{$R *.DFM}

uses ComCtrls; // Supports the TProgressBar control

procedure TestProgress(Form: TForm; Count: SmallInt);

var

  ProgressBar1: TProgressBar;

  i: SmallInt;

begin

  ProgressBar1 := TProgressBar.Create(Form);

  try

    ProgressBar1.Parent := Form;

    ProgressBar1.Align := alBottom;

    ProgressBar1.Min := 0;

    ProgressBar1.Max := Count;

    ProgressBar1.Step := 1; // the amount to move with the StepIt method

    for i := 1 to Count do

      ProgressBar1.Stepit; // Move one Step amount

    // Instead of StepIt, we could also

    // have coded: Position := i;

    ShowMessage('Now the ProgressBar control will be freed');

  finally

    ProgressBar1.Free;

  end;

end;

procedure TForm1.Button1Click(Sender: TObject);

begin

  TestProgress(Self, 1000);

end;

end.


TProgressBar example (pg1.dfm)

pg1.pas

object Form1: TForm1

  Left = 200

  Top = 108

  Width = 544

  Height = 375

  Caption = 'Form1'

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  PixelsPerInch = 96

  TextHeight = 13

  object Button1: TButton

    Left = 432

    Top = 296

    Width = 75

    Height = 25

    Caption = 'Button1'

    TabOrder = 0

    OnClick = Button1Click

  end

end


TTabControl example
TTabControl example (clsexm1.pas)

clsexm1.dfm

Objects

The example demonstrates using TTabControl, TTable, TDataSource, TIntegerField, TStringField, TFloatField, TDateTimeField, TDBEdit and TLabel objects. To run this example, load the project file from the Help\Examples\TabCntrl directory.

Description

This project shows how to use a tab control to display records from a database table, including the creation of a calculated field.

unit clsexm1;

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  Db, DBTables, ComCtrls, ExtCtrls, DBCtrls, StdCtrls, Mask;

type

  TForm1 = class(TForm)

    TabControl1: TTabControl;

    Table1: TTable;

    DataSource1: TDataSource;

    Table1EmpNo: TIntegerField;

    Table1LastName: TStringField;

    Table1FirstName: TStringField;

    Table1PhoneExt: TStringField;

    Table1HireDate: TDateTimeField;

    Table1Salary: TFloatField;

    Label1: TLabel;

    DBEdit1: TDBEdit;

    Label2: TLabel;

    DBEdit2: TDBEdit;

    Label3: TLabel;

    DBEdit3: TDBEdit;

    Label4: TLabel;

    DBEdit4: TDBEdit;

    Label5: TLabel;

    DBEdit5: TDBEdit;

    Label6: TLabel;

    DBEdit6: TDBEdit;

    DBText1: TDBText;

    Table1FullName: TStringField;

    procedure FormCreate(Sender: TObject);

    procedure TabControl1Change(Sender: TObject);

    procedure Table1CalcFields(DataSet: TDataSet);

  end;

var

  Form1: TForm1;

implementation

{$R *.DFM}

procedure TForm1.FormCreate(Sender: TObject);

begin

  TabControl1.Align := alClient;

  TabControl1.TabHeight := 30;

  with Table1 do

  begin

    Close;

    IndexName := 'ByName';

    Open;

    while not EOF do

    begin

      TabControl1.Tabs.Add(FieldByName('LASTNAME').AsString);

      Next;

    end;

    // Sync page and table.

    First;

  end;

end;

procedure TForm1.TabControl1Change(Sender: TObject);

begin

  with TabControl1 do

  begin

    if TabIndex <> -1 then

      if not Table1.Locate('LASTNAME', Tabs[TabIndex], []) then

        ShowMessage(Tabs[TabIndex -1] + ' not found.');

  end;

end;

procedure TForm1.Table1CalcFields(DataSet: TDataSet);

begin

  DataSet['FullName'] := DataSet['LASTNAME'] + ', ' + DataSet['FIRSTNAME'];

end;

end.


TTabControl example (clsexm1.dfm)

clsexm1.pas

object Form1: TForm1

  Left = 266

  Top = 182

  Width = 366

  Height = 354

  Caption = 'Form1'

  Font.Charset = DEFAULT_CHARSET

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  OnCreate = FormCreate

  PixelsPerInch = 96

  TextHeight = 13

  object TabControl1: TTabControl

    Left = 0

    Top = 0

    Width = 358

    Height = 327

    Align = alClient

    TabOrder = 0

    OnChange = TabControl1Change

    object Label1: TLabel

      Left = 16

      Top = 72

      Width = 35

      Height = 13

      Caption = 'EmpNo'

      FocusControl = DBEdit1

    end

    object Label2: TLabel

      Left = 16

      Top = 112

      Width = 48

      Height = 13

      Caption = 'LastName'

      FocusControl = DBEdit2

    end

    object Label3: TLabel

      Left = 16

      Top = 152

      Width = 47

      Height = 13

      Caption = 'FirstName'

      FocusControl = DBEdit3

    end

    object Label4: TLabel

      Left = 16

      Top = 192

      Width = 46

      Height = 13

      Caption = 'PhoneExt'

      FocusControl = DBEdit4

    end

    object Label5: TLabel

      Left = 16

      Top = 232

      Width = 42

      Height = 13

      Caption = 'HireDate'

      FocusControl = DBEdit5

    end

    object Label6: TLabel

      Left = 16

      Top = 272

      Width = 29

      Height = 13

      Caption = 'Salary'

      FocusControl = DBEdit6

    end

    object DBText1: TDBText

      Left = 56

      Top = 48

      Width = 6

      Height = 20

      AutoSize = True

      DataField = 'FullName'

      DataSource = DataSource1

      Font.Charset = ANSI_CHARSET

      Font.Color = clBlack

      Font.Height = -16

      Font.Name = 'MS Sans Serif'

      Font.Style = [fsBold]

      ParentFont = False

    end

    object DBEdit1: TDBEdit

      Left = 16

      Top = 88

      Width = 64

      Height = 20

      DataField = 'EmpNo'

      DataSource = DataSource1

      TabOrder = 0

    end

    object DBEdit2: TDBEdit

      Left = 16

      Top = 128

      Width = 124

      Height = 20

      DataField = 'LastName'

      DataSource = DataSource1

      TabOrder = 1

    end

    object DBEdit3: TDBEdit

      Left = 16

      Top = 168

      Width = 94

      Height = 20

      DataField = 'FirstName'

      DataSource = DataSource1

      TabOrder = 2

    end

    object DBEdit4: TDBEdit

      Left = 16

      Top = 208

      Width = 28

      Height = 20

      DataField = 'PhoneExt'

      DataSource = DataSource1

      TabOrder = 3

    end

    object DBEdit5: TDBEdit

      Left = 16

      Top = 248

      Width = 64

      Height = 20

      DataField = 'HireDate'

      DataSource = DataSource1

      TabOrder = 4

    end

    object DBEdit6: TDBEdit

      Left = 16

      Top = 288

      Width = 64

      Height = 20

      DataField = 'Salary'

      DataSource = DataSource1

      TabOrder = 5

    end

  end

  object Table1: TTable

    Active = True

    OnCalcFields = Table1CalcFields

    DatabaseName = 'DBDEMOS'

    TableName = 'EMPLOYEE.DB'

    Left = 32

    Top = 48

    object Table1EmpNo: TIntegerField

      FieldName = 'EmpNo'

      DisplayFormat = 'Emp'#39'#'#39' 0000'

      MaxValue = 9999

      MinValue = 1

    end

    object Table1LastName: TStringField

      FieldName = 'LastName'

    end

    object Table1FirstName: TStringField

      FieldName = 'FirstName'

      Size = 15

    end

    object Table1PhoneExt: TStringField

      FieldName = 'PhoneExt'

      Size = 4

    end

    object Table1HireDate: TDateTimeField

      FieldName = 'HireDate'

    end

    object Table1Salary: TFloatField

      FieldName = 'Salary'

    end

    object Table1FullName: TStringField

      FieldName = 'FullName'

      Size = 30

      Calculated = True

    end

  end

  object DataSource1: TDataSource

    DataSet = Table1

    Left = 64

    Top = 48

  end

end


TUpdateSQL example
TUpdateSQL example (cupdm.pas)

cuperror.pas	cupmnfrm.pas	cupdm.dfm	cuperror.dfm	cupmnfrm.dfm

Objects

The example demonstrates using TUpdateSQL, TDataModule, TTable, TDataSource, TQuery, TIntegerField, TStringField, TDBGrid, TDBNavigator, TButton, TLabel, TPanel and TEdit objects. To run this example, load the project file from the Help\Examples\Update directory.

Description

This project shows how to use TUpdateSQL to update the records of a read-only query (QueryCache). The UpdateSQLCache TUpdateSQL object contains SQL statements in its DeleteSQL, InsertSQL and ModifySQL properties that are executed when ApplyUpdates of the TQuery (QueryCache) object is called.  Note that the CachedUpdates property of QueryCache is True.

This example uses the local InterBase database \Demos\Data\EMPLOYEE.GDB. You may need to update this path in the Params property of the DBaseCache TDatabase object.

unit CUpMnFrm;

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  StdCtrls, ExtCtrls, DBCtrls, Grids, DBGrids;

type

  TForm1 = class(TForm)

    DBGridRefresh: TDBGrid;

    DBGridCache: TDBGrid;

    DBNavigator1: TDBNavigator;

    ButtonApply: TButton;

    ButtonCancel: TButton;

    ButtonUndo: TButton;

    ButtonRefresh: TButton;

    Label1: TLabel;

    Label2: TLabel;

    procedure ButtonApplyClick(Sender: TObject);

    procedure ButtonCancelClick(Sender: TObject);

    procedure ButtonUndoClick(Sender: TObject);

    procedure ButtonRefreshClick(Sender: TObject);

  private

    { Private declarations }

  public

    { Public declarations }

  end;

var

  Form1: TForm1;

implementation

uses  CUpDM;

{$R *.DFM}

procedure TForm1.ButtonApplyClick(Sender: TObject);

begin

  DataModuleCache.DBaseCache.ApplyUpdates([DataModuleCache.QueryCache]);

end;

procedure TForm1.ButtonCancelClick(Sender: TObject);

begin

  DataModuleCache.QueryCache.CancelUpdates;

end;

procedure TForm1.ButtonUndoClick(Sender: TObject);

begin

  DataModuleCache.QueryCache.RevertRecord;

end;

procedure TForm1.ButtonRefreshClick(Sender: TObject);

begin

  With DataModuleCache.TableRefresh do

  begin

    close;

    open;

  end;

end;

end.


TUpdateSQL example (cuperror.pas)

cupdm.pas	cupmnfrm.pas	cupdm.dfm	cuperror.dfm	cupmnfrm.dfm

 unit CUpError;

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  StdCtrls, ExtCtrls,DB,dbitypes,dbiprocs,dbtables;

type

  TFormError = class(TForm)

    Panel1: TPanel;

    LabelOld: TLabel;

    LabelNew: TLabel;

    LabelMessage: TLabel;

    EditOld: TEdit;

    EditNew: TEdit;

    ButtonIgnore: TButton;

    ButtonRetry: TButton;

    ButtonAbort: TButton;

  private

    { Private declarations }

  public

  function ErrorDecision(DataSet : TDataSet; E: EDataBaseError;

                                 UpdateKind: TUpdateKind):TUpdateAction;

    { Public declarations }

  end;

var

  FormError: TFormError;

implementation

uses CUpDM;

{$R *.DFM}

function TFormError.Errordecision(Dataset: TDataSet;

             E: EDataBaseError; UpdateKind: TUpdateKind):

             TUpdateAction;

    const

      UpdateKindStr: array[TUpdateKind] of String =('Modify Error',

                     'Insert Error','Delete Error');

      begin

        Panel1.caption := UpdateKindStr[UpdateKind];

        LabelMessage.Caption := E.Message;

        EditOld.text := DataModuleCache.QueryCache.Fields[0].OldValue;

        EditNew.text := DataModuleCache.QueryCache.Fields[0].NewValue;

        ShowModal;

        case ModalResult of

        mrRetry:

        begin

          DataModuleCache.QueryCache.Fields[0].newvalue := EditNew.text;

          Result := uaRetry;

        end;

        mrIgnore: Result := uaSkip;

        else

          result := uaAbort;

      end;

   end;

end.


TUpdateSQL example (cupmnfrm.pas)

cupdm.pas	cuperror.pas	cupdm.dfm	cuperror.dfm	cupmnfrm.dfm

 unit CUpDM;

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  DB, DBTables;

type

  TDataModuleCache = class(TDataModule)

    DBaseCache: TDatabase;

    TableRefresh: TTable;

    DataSourceCache: TDataSource;

    DataSourceRefresh: TDataSource;

    QueryCache: TQuery;

    UpdateSQLCache: TUpdateSQL;

    QueryCacheCUST_NO: TIntegerField;

    QueryCacheCUSTOMER: TStringField;

    QueryCacheCONTACT_FIRST: TStringField;

    QueryCacheCONTACT_LAST: TStringField;

    QueryCachePHONE_NO: TStringField;

    QueryCacheADDRESS_LINE1: TStringField;

    QueryCacheADDRESS_LINE2: TStringField;

    QueryCacheCITY: TStringField;

    QueryCacheSTATE_PROVINCE: TStringField;

    QueryCacheCOUNTRY: TStringField;

    QueryCachePOSTAL_CODE: TStringField;

    QueryCacheON_HOLD: TStringField;

    procedure QueryCacheUpdateError(DataSet: TDataSet; E: EDatabaseError;

      UpdateKind: TUpdateKind; var UpdateAction: TUpdateAction);

  private

    { Private declarations }

  public

    { Public declarations }

  end;

var

  DataModuleCache: TDataModuleCache;

implementation

uses CUpError;

{$R *.DFM}

procedure TDataModuleCache.QueryCacheUpdateError(DataSet: TDataSet;

  E: EDatabaseError; UpdateKind: TUpdateKind;

  var UpdateAction: TUpdateAction);

begin

  if EDBEngineError(e).errors[0].errorcode = 9729 then

  begin

    UpdateAction := FormError.ErrorDecision(DataSet, E, UpdateKind);

  end;

end;

end.


TUpdateSQL example (cupdm.dfm)

cupdm.pas	cuperror.pas	cupmnfrm.pas	cuperror.dfm	cupmnfrm.dfm

object Form1: TForm1

  Left = 181

  Top = 96

  Width = 435

  Height = 358

  Caption = 'CachedUpdate Demo'

  Font.Charset = DEFAULT_CHARSET

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  PixelsPerInch = 96

  TextHeight = 13

  object Label1: TLabel

    Left = 40

    Top = 40

    Width = 227

    Height = 13

    Caption = 'This grid is Hooked to the  TQuery  QueryCache'

  end

  object Label2: TLabel

    Left = 48

    Top = 184

    Width = 214

    Height = 13

    Caption = 'This grid is hooked to a TTable TableRefresh'

  end

  object DBGridRefresh: TDBGrid

    Left = 0

    Top = 200

    Width = 320

    Height = 120

    DataSource = DataModuleCache.DataSourceRefresh

    Options = [dgTitles, dgIndicator, dgColumnResize, dgColLines, dgRowLines,

dgTabs, dgConfirmDelete, dgCancelOnExit]

    ReadOnly = True

    TabOrder = 0

    TitleFont.Charset = DEFAULT_CHARSET

    TitleFont.Color = clWindowText

    TitleFont.Height = -11

    TitleFont.Name = 'MS Sans Serif'

    TitleFont.Style = []

  end

  object DBGridCache: TDBGrid

    Left = 0

    Top = 56

    Width = 320

    Height = 120

    DataSource = DataModuleCache.DataSourceCache

    TabOrder = 1

    TitleFont.Charset = DEFAULT_CHARSET

    TitleFont.Color = clWindowText

    TitleFont.Height = -11

    TitleFont.Name = 'MS Sans Serif'

    TitleFont.Style = []

  end

  object DBNavigator1: TDBNavigator

    Left = 0

    Top = 0

    Width = 320

    Height = 25

    DataSource = DataModuleCache.DataSourceCache

    ParentShowHint = False

    ShowHint = True

    TabOrder = 2

  end

  object ButtonApply: TButton

    Left = 336

    Top = 40

    Width = 75

    Height = 25

    Caption = 'Apply'

    TabOrder = 3

    OnClick = ButtonApplyClick

  end

  object ButtonCancel: TButton

    Left = 336

    Top = 80

    Width = 75

    Height = 25

    Caption = 'Cancel'

    TabOrder = 4

    OnClick = ButtonCancelClick

  end

  object ButtonUndo: TButton

    Left = 336

    Top = 120

    Width = 75

    Height = 25

    Caption = 'Undo'

    TabOrder = 5

    OnClick = ButtonUndoClick

  end

  object ButtonRefresh: TButton

    Left = 336

    Top = 216

    Width = 75

    Height = 25

    Caption = 'Refresh'

    TabOrder = 6

    OnClick = ButtonRefreshClick

  end

end


TUpdateSQL example (cuperror.dfm)

cupdm.pas	cuperror.pas	cupmnfrm.pas	cupdm.dfm	cupmnfrm.dfm

 object FormError: TFormError

  Left = 191

  Top = 96

  Width = 383

  Height = 192

  Caption = 'FormError'

  Font.Charset = DEFAULT_CHARSET

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  PixelsPerInch = 96

  TextHeight = 13

  object LabelOld: TLabel

    Left = 24

    Top = 72

    Width = 57

    Height = 13

    Caption = 'Old Cust No'

  end

  object LabelNew: TLabel

    Left = 24

    Top = 104

    Width = 48

    Height = 13

    Caption = 'LabelNew'

  end

  object LabelMessage: TLabel

    Left = 24

    Top = 136

    Width = 69

    Height = 13

    Caption = 'LabelMessage'

    WordWrap = True

  end

  object Panel1: TPanel

    Left = 64

    Top = 8

    Width = 185

    Height = 41

    Caption = 'Panel1'

    TabOrder = 0

  end

  object EditOld: TEdit

    Left = 96

    Top = 64

    Width = 121

    Height = 21

    TabOrder = 1

  end

  object EditNew: TEdit

    Left = 96

    Top = 96

    Width = 121

    Height = 21

    TabOrder = 2

  end

  object ButtonIgnore: TButton

    Left = 272

    Top = 16

    Width = 75

    Height = 25

    Caption = 'Ignore'

    ModalResult = 5

    TabOrder = 3

  end

  object ButtonRetry: TButton

    Left = 272

    Top = 64

    Width = 75

    Height = 25

    Caption = 'Retry'

    ModalResult = 4

    TabOrder = 4

  end

  object ButtonAbort: TButton

    Left = 272

    Top = 112

    Width = 75

    Height = 25

    Caption = 'Abort'

    ModalResult = 3

    TabOrder = 5

  end

end


TUpdateSQL example (cupmnfrm.dfm)

cupdm.pas	cuperror.pas	cupmnfrm.pas	cupdm.dfm	cuperror.dfm

object DataModuleCache: TDataModuleCache

  Left = 728

  Top = 102

  Height = 260

  Width = 290

  object TableRefresh: TTable

    Filtered = True

    DatabaseName = 'myib'

    TableName = 'CUSTOMER'

    Left = 96

    Top = 104

  end

  object DataSourceCache: TDataSource

    DataSet = QueryCache

    Left = 32

    Top = 152

  end

  object DataSourceRefresh: TDataSource

    DataSet = TableRefresh

    Left = 120

    Top = 152

  end

  object QueryCache: TQuery

    CachedUpdates = True

    OnUpdateError = QueryCacheUpdateError

    DatabaseName = 'myib'

    SQL.Strings = (

      'select * from customer')

    UpdateObject = UpdateSQLCache

    Left = 32

    Top = 104

    object QueryCacheCUST_NO: TIntegerField

      FieldName = 'CUST_NO'

    end

    object QueryCacheCUSTOMER: TStringField

      FieldName = 'CUSTOMER'

      Size = 25

    end

    object QueryCacheCONTACT_FIRST: TStringField

      FieldName = 'CONTACT_FIRST'

      Size = 15

    end

    object QueryCacheCONTACT_LAST: TStringField

      FieldName = 'CONTACT_LAST'

    end

    object QueryCachePHONE_NO: TStringField

      FieldName = 'PHONE_NO'

    end

    object QueryCacheADDRESS_LINE1: TStringField

      FieldName = 'ADDRESS_LINE1'

      Size = 30

    end

    object QueryCacheADDRESS_LINE2: TStringField

      FieldName = 'ADDRESS_LINE2'

      Size = 30

    end

    object QueryCacheCITY: TStringField

      FieldName = 'CITY'

      Size = 25

    end

    object QueryCacheSTATE_PROVINCE: TStringField

      FieldName = 'STATE_PROVINCE'

      Size = 15

    end

    object QueryCacheCOUNTRY: TStringField

      FieldName = 'COUNTRY'

      Size = 15

    end

    object QueryCachePOSTAL_CODE: TStringField

      FieldName = 'POSTAL_CODE'

      Size = 12

    end

    object QueryCacheON_HOLD: TStringField

      FieldName = 'ON_HOLD'

      Size = 1

    end

  end

  object UpdateSQLCache: TUpdateSQL

    ModifySQL.Strings = (

      'update customer'

      'set'

      '  CUST_NO = :CUST_NO,'

      '  CUSTOMER = :CUSTOMER,'

      '  CONTACT_FIRST = :CONTACT_FIRST,'

      '  CONTACT_LAST = :CONTACT_LAST,'

      '  PHONE_NO = :PHONE_NO,'

      '  ADDRESS_LINE1 = :ADDRESS_LINE1,'

      '  ADDRESS_LINE2 = :ADDRESS_LINE2,'

      '  CITY = :CITY,'

      '  STATE_PROVINCE = :STATE_PROVINCE,'

      '  COUNTRY = :COUNTRY,'

      '  POSTAL_CODE = :POSTAL_CODE,'

      '  ON_HOLD = :ON_HOLD'

      'where'

      '  CUST_NO = :OLD_CUST_NO')

    InsertSQL.Strings = (

      'insert into customer'

      '  (CUST_NO, CUSTOMER, CONTACT_FIRST, CONTACT_LAST, PHONE_NO, '

      'ADDRESS_LINE1, '

      '   ADDRESS_LINE2, CITY, STATE_PROVINCE, COUNTRY, POSTAL_CODE, '

      'ON_HOLD)'

      'values'

        '  (:CUST_NO, :CUSTOMER, :CONTACT_FIRST, :CONTACT_LAST, :PHONE_NO' +

        ', '

      ':ADDRESS_LINE1, '

        '   :ADDRESS_LINE2, :CITY, :STATE_PROVINCE, :COUNTRY, :POSTAL_COD' +

        'E, '

      ':ON_HOLD)')

    DeleteSQL.Strings = (

      'delete from customer'

      'where'

      '  CUST_NO = :OLD_CUST_NO')

    Left = 32

    Top = 48

  end

  object DBaseCache: TDatabase

    AliasName = 'IBLOCAL'

    Connected = True

    DatabaseName = 'myib'

    Params.Strings = (

        'SERVER NAME=c:\Program Files\Borland\Delphi 3\Demos\Data\EMPLOYE' +

        'E.GDB'

      'USER NAME=SYSDBA'

      'OPEN MODE=READ/WRITE'

      'SCHEMA CACHE SIZE=8'

      'LANGDRIVER='

      'SQLQRYMODE='

      'SQLPASSTHRU MODE=SHARED AUTOCOMMIT'

      'SCHEMA CACHE TIME=-1'

      'MAX ROWS=-1'

      'BATCH COUNT=200'

      'ENABLE SCHEMA CACHE=FALSE'

      'SCHEMA CACHE DIR='

      'ENABLE BCD=FALSE'

      'BLOBS TO CACHE=64'

      'BLOB SIZE=32'

      'PASSWORD=')

    SessionName = 'Default'

    Left = 112

    Top = 24

  end

end


TBatchMove example
TBatchMove example (batmov.pas)

batmov.dfm

Objects

The example demonstrates using TBatchMove, TBevel, TComboBox, TPageControl, TDatabase, and TOpenDialog  objects. To run this example, load the project file from the Help\Examples\Batchmv directory.

Description

This example demonstrates using TBatchMove to manipulate the records in a database table.

program batmv;

uses

  Forms,

  batmove in 'batmove.pas' {Form1};

{$R *.RES}

begin

  Application.Initialize;

  Application.CreateForm(TfrmBatchMove, frmBatchMove);

  Application.Run;

end.


TBatchMove example (batmov.dfm)

batmov.pas

object frmBatchMove: TfrmBatchMove

  Left = 196

  Top = 113

  BorderStyle = bsSingle

  Caption = 'Batch Move Example'

  ClientHeight = 471

  ClientWidth = 468

  Font.Charset = DEFAULT_CHARSET

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  Position = poDefaultPosOnly

  OnCreate = FormCreate

  PixelsPerInch = 96

  TextHeight = 13

  object Bevel3: TBevel

    Left = 8

    Top = 128

    Width = 449

    Height = 97

    Shape = bsFrame

    Style = bsRaised

  end

  object Bevel1: TBevel

    Left = 8

    Top = 24

    Width = 217

    Height = 97

    Shape = bsFrame

    Style = bsRaised

  end

  object Label1: TLabel

    Left = 8

    Top = 8

    Width = 41

    Height = 13

    Caption = 'Source'

    Font.Charset = DEFAULT_CHARSET

    Font.Color = clBlack

    Font.Height = -11

    Font.Name = 'MS Sans Serif'

    Font.Style = [fsBold]

    ParentFont = False

  end

  object Bevel2: TBevel

    Left = 240

    Top = 24

    Width = 217

    Height = 97

    Shape = bsFrame

    Style = bsRaised

  end

  object Label2: TLabel

    Left = 240

    Top = 8

    Width = 65

    Height = 13

    Caption = 'Destination'

    Font.Charset = DEFAULT_CHARSET

    Font.Color = clBlack

    Font.Height = -11

    Font.Name = 'MS Sans Serif'

    Font.Style = [fsBold]

    ParentFont = False

  end

  object Label3: TLabel

    Left = 17

    Top = 36

    Width = 22

    Height = 13

    Caption = '&Alias'

    FocusControl = cbSourceAlias

  end

  object Label4: TLabel

    Left = 12

    Top = 64

    Width = 27

    Height = 13

    Caption = 'Ta&ble'

    FocusControl = cbSourceTable

  end

  object Label5: TLabel

    Left = 249

    Top = 36

    Width = 22

    Height = 13

    Caption = 'Alia&s'

    FocusControl = cbDestAlias

  end

  object Label6: TLabel

    Left = 244

    Top = 64

    Width = 27

    Height = 13

    Caption = 'Tabl&e'

    FocusControl = cbDestTable

  end

  object Label7: TLabel

    Left = 16

    Top = 138

    Width = 83

    Height = 13

    Caption = 'Transfer &Mode'

    FocusControl = cbMode

    Font.Charset = DEFAULT_CHARSET

    Font.Color = clBlack

    Font.Height = -11

    Font.Name = 'MS Sans Serif'

    Font.Style = [fsBold]

    ParentFont = False

  end

  object Label8: TLabel

    Left = 8

    Top = 232

    Width = 44

    Height = 13

    Caption = 'Options'

    Font.Charset = DEFAULT_CHARSET

    Font.Color = clBlack

    Font.Height = -11

    Font.Name = 'MS Sans Serif'

    Font.Style = [fsBold]

    ParentFont = False

  end

  object Label9: TLabel

    Left = 13

    Top = 92

    Width = 26

    Height = 13

    Caption = 'In&dex'

  end

  object Label10: TLabel

    Left = 248

    Top = 92

    Width = 26

    Height = 13

    Caption = 'Inde&x'

  end

  object cbSourceAlias: TComboBox

    Left = 48

    Top = 32

    Width = 169

    Height = 21

    Style = csDropDownList

    ItemHeight = 13

    Sorted = True

    TabOrder = 0

    OnChange = cbSourceAliasChange

  end

  object cbSourceTable: TComboBox

    Left = 48

    Top = 60

    Width = 169

    Height = 21

    Style = csDropDownList

    ItemHeight = 13

    Sorted = True

    TabOrder = 1

    OnChange = cbSourceTableChange

  end

  object cbDestAlias: TComboBox

    Left = 280

    Top = 32

    Width = 169

    Height = 21

    Style = csDropDownList

    ItemHeight = 13

    Sorted = True

    TabOrder = 3

    OnChange = cbSourceAliasChange

  end

  object cbDestTable: TComboBox

    Left = 280

    Top = 60

    Width = 169

    Height = 21

    ItemHeight = 13

    Sorted = True

    TabOrder = 4

    OnChange = cbSourceTableChange

  end

  object cbMode: TComboBox

    Left = 104

    Top = 136

    Width = 185

    Height = 21

    Style = csDropDownList

    ItemHeight = 13

    Items.Strings = (

      'Append'

      'Update'

      'AppendUpdate'

      'Copy'

      'Delete')

    TabOrder = 6

    OnChange = cbModeChange

  end

  object Memo1: TMemo

    Left = 16

    Top = 166

    Width = 433

    Height = 51

    TabStop = False

    Color = clBtnFace

    ReadOnly = True

    ScrollBars = ssVertical

    TabOrder = 7

    WantReturns = False

  end

  object BitBtn1: TBitBtn

    Left = 157

    Top = 432

    Width = 75

    Height = 25

    TabOrder = 9

    OnClick = BitBtn1Click

    Kind = bkOK

  end

  object BitBtn2: TBitBtn

    Left = 245

    Top = 432

    Width = 75

    Height = 25

    TabOrder = 10

    Kind = bkClose

  end

  object PageControl1: TPageControl

    Left = 8

    Top = 248

    Width = 449

    Height = 169

    ActivePage = TabSheet1

    TabOrder = 8

    object TabSheet1: TTabSheet

      Caption = 'Error Handling'

      object txtKeyViolTableName: TLabel

        Left = 28

        Top = 40

        Width = 91

        Height = 13

        Caption = '&Key Violation Table'

        FocusControl = edKeyViolTableName

      end

      object txtProblemTableName: TLabel

        Left = 51

        Top = 112

        Width = 68

        Height = 13

        Caption = 'Pr&oblem Table'

        FocusControl = edProblemTableName

      end

      object Bevel4: TBevel

        Left = 0

        Top = 72

        Width = 441

        Height = 2

        Shape = bsTopLine

      end

      object sbKeyViolTbl: TSpeedButton

        Left = 404

        Top = 38

        Width = 25

        Height = 21

        Enabled = False

        Glyph.Data = {

          76010000424D7601000000000000760000002800000020000000100000000100

          04000000000000010000130B0000130B00001000000000000000000000000000

          800000800000008080008000000080008000808000007F7F7F00BFBFBF000000

          FF0000FF000000FFFF00FF000000FF00FF00FFFF0000FFFFFF00333333330070

          7700333333337777777733333333008088003333333377F73377333333330088

          88003333333377FFFF7733333333000000003FFFFFFF77777777000000000000

          000077777777777777770FFFFFFF0FFFFFF07F3333337F3333370FFFFFFF0FFF

          FFF07F3FF3FF7FFFFFF70F00F0080CCC9CC07F773773777777770FFFFFFFF039

          99337F3FFFF3F7F777F30F0000F0F09999937F7777373777777F0FFFFFFFF999

          99997F3FF3FFF77777770F00F000003999337F773777773777F30FFFF0FF0339

          99337F3FF7F3733777F30F08F0F0337999337F7737F73F7777330FFFF0039999

          93337FFFF7737777733300000033333333337777773333333333}

        NumGlyphs = 2

        OnClick = sbKeyViolTblClick

      end

      object sbProbTbl: TSpeedButton

        Left = 404

        Top = 110

        Width = 25

        Height = 21

        Enabled = False

        Glyph.Data = {

          76010000424D7601000000000000760000002800000020000000100000000100

          04000000000000010000130B0000130B00001000000000000000000000000000

          800000800000008080008000000080008000808000007F7F7F00BFBFBF000000

          FF0000FF000000FFFF00FF000000FF00FF00FFFF0000FFFFFF00333333330070

          7700333333337777777733333333008088003333333377F73377333333330088

          88003333333377FFFF7733333333000000003FFFFFFF77777777000000000000

          000077777777777777770FFFFFFF0FFFFFF07F3333337F3333370FFFFFFF0FFF

          FFF07F3FF3FF7FFFFFF70F00F0080CCC9CC07F773773777777770FFFFFFFF039

          99337F3FFFF3F7F777F30F0000F0F09999937F7777373777777F0FFFFFFFF999

          99997F3FF3FFF77777770F00F000003999337F773777773777F30FFFF0FF0339

          99337F3FF7F3733777F30F08F0F0337999337F7737F73F7777330FFFF0039999

          93337FFFF7737777733300000033333333337777773333333333}

        NumGlyphs = 2

      end

      object ckAbortOnKeyViol: TCheckBox

        Left = 8

        Top = 16

        Width = 129

        Height = 17

        Hint = 'Terminate on integrity (key) violation'

        Caption = 'Abort On Key &Violation'

        ParentShowHint = False

        ShowHint = True

        TabOrder = 0

        OnClick = ckAbortOnKeyViolClick

      end

      object edKeyViolTableName: TEdit

        Left = 128

        Top = 38

        Width = 273

        Height = 21

        Hint = 'Table containing all records from the source table that caused an integrity violation'

        ParentShowHint = False

        ShowHint = True

        TabOrder = 1

      end

      object ckAbortOnProblem: TCheckBox

        Left = 8

        Top = 88

        Width = 105

        Height = 17

        Hint = 'Terminate on data truncation'

        Caption = 'Abort On &Problem'

        ParentShowHint = False

        ShowHint = True

        TabOrder = 2

        OnClick = ckAbortOnProblemClick

      end

      object edProblemTableName: TEdit

        Left = 128

        Top = 110

        Width = 273

        Height = 21

        Hint = 'Table containing records that could not be moved because of field width conflict'

        ParentShowHint = False

        ShowHint = True

        TabOrder = 3

      end

    end

    object TabSheet2: TTabSheet

      Caption = 'Record Control'

      object Label11: TLabel

        Left = 8

        Top = 16

        Width = 66

        Height = 13

        Caption = '&Record Count'

        FocusControl = edRecordCount

      end

      object Label12: TLabel

        Left = 9

        Top = 40

        Width = 65

        Height = 13

        Caption = 'Commit Co&unt'

        FocusControl = edCommitCount

      end

      object Label13: TLabel

        Left = 9

        Top = 64

        Width = 104

        Height = 13

        Caption = 'Changed Table &Name'

        FocusControl = edChangedTableName

      end

      object sbChangeTbl: TSpeedButton

        Left = 404

        Top = 62

        Width = 25

        Height = 21

        Glyph.Data = {

          76010000424D7601000000000000760000002800000020000000100000000100

          04000000000000010000130B0000130B00001000000000000000000000000000

          800000800000008080008000000080008000808000007F7F7F00BFBFBF000000

          FF0000FF000000FFFF00FF000000FF00FF00FFFF0000FFFFFF00333333330070

          7700333333337777777733333333008088003333333377F73377333333330088

          88003333333377FFFF7733333333000000003FFFFFFF77777777000000000000

          000077777777777777770FFFFFFF0FFFFFF07F3333337F3333370FFFFFFF0FFF

          FFF07F3FF3FF7FFFFFF70F00F0080CCC9CC07F773773777777770FFFFFFFF039

          99337F3FFFF3F7F777F30F0000F0F09999937F7777373777777F0FFFFFFFF999

          99997F3FF3FFF77777770F00F000003999337F773777773777F30FFFF0FF0339

          99337F3FF7F3733777F30F08F0F0337999337F7737F73F7777330FFFF0039999

          93337FFFF7737777733300000033333333337777773333333333}

        NumGlyphs = 2

      end

      object edRecordCount: TSpinEdit

        Left = 82

        Top = 10

        Width = 121

        Height = 22

        Hint = 'Records to move. 0 means all records.'

        MaxValue = 0

        MinValue = 0

        ParentShowHint = False

        ShowHint = True

        TabOrder = 0

        Value = 0

      end

      object edChangedTableName: TEdit

        Left = 118

        Top = 62

        Width = 281

        Height = 21

        Hint = 'Table containing all records in the destination table that changed as a result of the batch operation'

        ParentShowHint = False

        ShowHint = True

        TabOrder = 2

      end

      object edCommitCount: TSpinEdit

        Left = 82

        Top = 36

        Width = 121

        Height = 22

        Hint = 'Records moved before commit'

        MaxValue = 0

        MinValue = 0

        ParentShowHint = False

        ShowHint = True

        TabOrder = 1

        Value = 0

      end

      object ckTransliterate: TCheckBox

        Left = 9

        Top = 96

        Width = 136

        Height = 17

        Hint = 'Data in character fields of source table transliterated into the character set of the destination table'

        Caption = '&Translate character set'

        ParentShowHint = False

        ShowHint = True

        TabOrder = 3

      end

    end

  end

  object cbSourceIndex: TComboBox

    Left = 48

    Top = 88

    Width = 169

    Height = 21

    Style = csDropDownList

    ItemHeight = 13

    TabOrder = 2

  end

  object cbDestIndex: TComboBox

    Left = 280

    Top = 88

    Width = 169

    Height = 21

    Style = csDropDownList

    ItemHeight = 13

    TabOrder = 5

  end

  object BatchMove1: TBatchMove

    Destination = tblDest

    Source = tblSource

    Left = 424

  end

  object dbSource: TDatabase

    DatabaseName = 'dbSource'

    SessionName = 'Default'

    Left = 64

    Top = 56

  end

  object tblSource: TTable

    DatabaseName = 'dbSource'

    Left = 96

    Top = 56

  end

  object dbDest: TDatabase

    DatabaseName = 'dbDestination'

    SessionName = 'Default'

    Left = 296

    Top = 56

  end

  object tblDest: TTable

    DatabaseName = 'dbDestination'

    Left = 328

    Top = 56

  end

  object OpenDialog1: TOpenDialog

    DefaultExt = 'DB'

    Filter = 'Paradox Files|*.DB'

    Title = 'Choose Table'

    Left = 416

    Top = 272

  end

end


TComboBox example
TComboBox example (combform.pas)

inptform.pas	combform.dfm	inptform.dfm

Objects

The example demonstrates using the TComboBox object. To run this example, load the project file from the Help\Examples\ComboBox directory.

Description

This example demonstrates the properties and methods of a combo box by allowing the user to manipulate them by clicking buttons.

unit combform;

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  StdCtrls, ComCtrls, Menus, ExtCtrls;

type

  TComboForm = class(TForm)

    CbDrop: TComboBox;

    CbDropList: TComboBox;

    CbSimple: TComboBox;

    Label1: TLabel;

    Label2: TLabel;

    Label3: TLabel;

    Label4: TLabel;

    MainMenu1: TMainMenu;

    ComboStyle: TMenuItem;

    CmSimple: TMenuItem;

    CmDrop: TMenuItem;

    CmDropList: TMenuItem;

    Add1: TMenuItem;

    CmAddString: TMenuItem;

    CmAddStringAt: TMenuItem;

    Search1: TMenuItem;

    CmFindString: TMenuItem;

    CmFindIndex: TMenuItem;

    CmDelete: TMenuItem;

    CmList: TMenuItem;

    CmDelString: TMenuItem;

    CmDelIndex: TMenuItem;

    CmShowList: TMenuItem;

    CmClear: TMenuItem;

    N1: TMenuItem;

    Label5: TLabel;

    EdCursel: TEdit;

    EdCuridx: TEdit;

    EdCurlen: TEdit;

    EdEdit: TEdit;

    EdEditlen: TEdit;

    CmSortList: TMenuItem;

    Bevel1: TBevel;

    procedure ComboStyleClick(Sender: TObject);

    procedure CmSimpleClick(Sender: TObject);

    procedure CmDropClick(Sender: TObject);

    procedure CmDropListClick(Sender: TObject);

    procedure FormCreate(Sender: TObject);

    procedure ComboChange(Sender: TObject);

    procedure CmClearClick(Sender: TObject);

    procedure CmDelStringClick(Sender: TObject);

    procedure CmDelIndexClick(Sender: TObject);

    procedure CmFindStringClick(Sender: TObject);

    procedure CmFindIndexClick(Sender: TObject);

    procedure CmAddStringClick(Sender: TObject);

    procedure CmAddStringAtClick(Sender: TObject);

    procedure Button1Click(Sender: TObject);

    procedure CmSortListClick(Sender: TObject);

    procedure CmListClick(Sender: TObject);

    procedure CmShowListClick(Sender: TObject);

  private

    { Private declarations }

    FCbActive: TComboBox;

    procedure SetCbActive(cb: TComboBox);

    procedure NewSelection;

    procedure DeleteAt(idx: Integer);

    procedure AddAt(idx: Integer; s: string);

    procedure SelectAt(idx: Integer);

    function FindString(s: string): Integer;

    property CbActive: TComboBox read FCbActive write SetCbActive;

  public

    { Public declarations }

  end;

var

  ComboForm: TComboForm;

implementation

uses inptform;

{$R *.DFM}

// -------------- //

// event handlers //

// -------------- //

procedure TComboForm.FormCreate(Sender: TObject);

begin

  FCbActive := CbSimple;

  CbSimple.Visible := True;

  CbDrop.Visible := False;

  CbDropList.Visible := False;

  NewSelection;

end;

// Control notifications

// ---------------------

//

// close form

//

procedure TComboForm.Button1Click(Sender: TObject);

begin

  Close;

end;

procedure TComboForm.ComboChange(Sender: TObject);

begin

  NewSelection;

end;

// ComboBox menu

// -------------

procedure TComboForm.ComboStyleClick(Sender: TObject);

begin

  CmSimple.Checked := CbActive = CbSimple;

  CmDrop.Checked := CbActive = CbDrop;

  CmDropList.Checked := CbActive = CbDropList;

end;

procedure TComboForm.CmSimpleClick(Sender: TObject);

begin

  CbActive := CbSimple;

end;

procedure TComboForm.CmDropClick(Sender: TObject);

begin

  CbActive := CbDrop;

end;

procedure TComboForm.CmDropListClick(Sender: TObject);

begin

  CbActive := CbDropList;

end;

// Add menu

// --------

procedure TComboForm.CmAddStringClick(Sender: TObject);

var

  s: string;

begin

  if InputForm.GetString('String to add:', s) then

    AddAt(0, s);

end;

procedure TComboForm.CmAddStringAtClick(Sender: TObject);

var

  i: Integer;

  s: string;

begin

  if InputForm.GetString('String to add:', s)

      and InputForm.GetInteger('Index to insert at:', i) then

    AddAt(i, s);

end;

// Find menu

// ---------

procedure TComboForm.CmFindStringClick(Sender: TObject);

var

  s: string;

begin

  if InputForm.GetString('String to select:', s) then

    SelectAt(FindString(s));

end;

procedure TComboForm.CmFindIndexClick(Sender: TObject);

var

  i: Integer;

begin

  if InputForm.GetInteger('Index to select:', i) then

    SelectAt(i);

end;

// Delete menu

// -----------

procedure TComboForm.CmDelStringClick(Sender: TObject);

var

  s: string;

begin

  if InputForm.GetString('String to delete:', s) then

    DeleteAt(FindString(s));

end;

procedure TComboForm.CmDelIndexClick(Sender: TObject);

var

  i: Integer;

begin

  if InputForm.GetInteger('Index to delete:', i) then

    DeleteAt(i);

end;

procedure TComboForm.CmClearClick(Sender: TObject);

begin

  CbActive.Clear;

end;

// List menu

// ---------

procedure TComboForm.CmShowListClick(Sender: TObject);

begin

  CbActive.DroppedDown := not CbActive.DroppedDown;

end;

procedure TComboForm.CmSortListClick(Sender: TObject);

begin

  CbActive.Sorted := not CbActive.Sorted;

end;

procedure TComboForm.CmListClick(Sender: TObject);

begin

  CmShowList.Enabled := CbActive <> CbSimple;

  CmSortList.Checked := CbActive.Sorted;

end;

// --------------- //

// private methods //

// --------------- //

procedure TComboForm.NewSelection;

begin

  if CbActive.ItemIndex = -1 then

    EdCursel.Text := ''

  else

    EdCursel.Text := CbActive.Items[CbActive.ItemIndex];

  EdCuridx.Text := IntToStr(CbActive.ItemIndex);

  EdCurlen.Text := IntToStr(length(EdCursel.Text));

  EdEdit.Text := CbActive.Text;

  EdEditlen.Text := IntToStr(length(EdEdit.Text));

end;

procedure TComboForm.SetCbActive(cb: TComboBox);

begin

  if FCbActive <> cb then

  begin

    FCbActive.Visible := False;

    FCbActive := cb;

    FCbActive.Visible := True;

    NewSelection;

  end;

end;

//

// Delete an item from the active combobox given its index.

// Ignores bogus indices.

//

procedure TComboForm.DeleteAt(idx: Integer);

begin

  if idx >= 0 then

    CbActive.Items.Delete(idx);

end;

//

// Add a string into the active combobox at the given index.

// If the index is too big, append the item, if too small,

// insert it at the top.

//

procedure TComboForm.AddAt(idx: Integer; s: string);

begin

  if idx > CbActive.Items.Count then

    CbActive.Items.Append(s)

  else

  begin

    if idx < 0 then

      idx := 0;

    CbActive.Items.Insert(idx, s);

  end;

end;

//

// Select an item in the active combobox given it's index.

// A bogus index will result in an exception.

procedure TComboForm.SelectAt(idx: Integer);

begin

  CbActive.ItemIndex := idx;

  NewSelection;

end;

//

// Find the index of an item in the combobox given a string.

// If the string does not exist, return -1.

//

function TComboForm.FindString(s: string): Integer;

var

  i: Integer;

begin

  i := 0;

  while (i < CbActive.Items.Count) and (CbActive.Items[i] <> s) do

    inc(i);

  Result := i;

end;

end.


TComboBox example (combform.dfm)

combform.pas	inptform.pas	inptform.dfm

object ComboForm: TComboForm

  Left = 200

  Top = 108

  BorderIcons = [biSystemMenu, biMinimize]

  BorderStyle = bsSingle

  Caption = 'ComboBox demo'

  ClientHeight = 281

  ClientWidth = 611

  Font.Charset = DEFAULT_CHARSET

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  Menu = MainMenu1

  OnCreate = FormCreate

  PixelsPerInch = 96

  TextHeight = 13

  object Label1: TLabel

    Left = 288

    Top = 48

    Width = 82

    Height = 13

    Caption = 'Current selection:'

  end

  object Label2: TLabel

    Left = 305

    Top = 82

    Width = 65

    Height = 13

    Caption = 'Current index:'

  end

  object Label3: TLabel

    Left = 241

    Top = 116

    Width = 129

    Height = 13

    Caption = 'Length of current selection:'

  end

  object Label4: TLabel

    Left = 321

    Top = 150

    Width = 49

    Height = 13

    Caption = 'Edit string:'

  end

  object Label5: TLabel

    Left = 271

    Top = 176

    Width = 99

    Height = 13

    Caption = 'Length of Edit String:'

  end

  object Bevel1: TBevel

    Left = 0

    Top = 0

    Width = 611

    Height = 2

    Align = alTop

  end

  object CbDrop: TComboBox

    Left = 40

    Top = 48

    Width = 178

    Height = 20

    ItemHeight = 13

    Items.Strings = (

      'in'

      'this'

      'box'

      'we'

      'have'

      'a'

      'list'

      'of'

      'strings')

    TabOrder = 0

    Visible = False

    OnChange = ComboChange

  end

  object CbDropList: TComboBox

    Left = 40

    Top = 48

    Width = 178

    Height = 20

    Style = csDropDownList

    ItemHeight = 13

    Items.Strings = (

      'Closer'

      'Still'

      'Substance'

      'Little Earthquakes'

      'Under the Pink'

      'Boys for Pele')

    TabOrder = 1

    Visible = False

    OnChange = ComboChange

  end

  object CbSimple: TComboBox

    Left = 40

    Top = 48

    Width = 178

    Height = 129

    Style = csSimple

    ItemHeight = 13

    Items.Strings = (

      'Return of the Native'

      'Jude the Obscure'

      'One Hundred Years of Solitude'

      'The Autumn of the Patriarch'

      'Idoru'

      'Neuromancer')

    TabOrder = 2

    OnChange = ComboChange

  end

  object EdCursel: TEdit

    Left = 384

    Top = 48

    Width = 178

    Height = 20

    ReadOnly = True

    TabOrder = 3

  end

  object EdCuridx: TEdit

    Left = 384

    Top = 80

    Width = 178

    Height = 20

    ReadOnly = True

    TabOrder = 4

  end

  object EdCurlen: TEdit

    Left = 384

    Top = 112

    Width = 178

    Height = 20

    ReadOnly = True

    TabOrder = 5

  end

  object EdEdit: TEdit

    Left = 384

    Top = 144

    Width = 178

    Height = 20

    ReadOnly = True

    TabOrder = 6

  end

  object EdEditlen: TEdit

    Left = 384

    Top = 176

    Width = 178

    Height = 20

    ReadOnly = True

    TabOrder = 7

  end

  object MainMenu1: TMainMenu

    Left = 8

    Top = 8

    object ComboStyle: TMenuItem

      Caption = '&ComboBox'

      OnClick = ComboStyleClick

      object CmSimple: TMenuItem

        Caption = '&Simple'

        OnClick = CmSimpleClick

      end

      object CmDrop: TMenuItem

        Caption = '&Dropdown'

        OnClick = CmDropClick

      end

      object CmDropList: TMenuItem

        Caption = 'Dropdown &list'

        OnClick = CmDropListClick

      end

    end

    object Add1: TMenuItem

      Caption = '&Add'

      object CmAddString: TMenuItem

        Caption = '&String...'

        OnClick = CmAddStringClick

      end

      object CmAddStringAt: TMenuItem

        Caption = 'String &at...'

        OnClick = CmAddStringAtClick

      end

    end

    object Search1: TMenuItem

      Caption = '&Find'

      object CmFindString: TMenuItem

        Caption = '&String...'

        OnClick = CmFindStringClick

      end

      object CmFindIndex: TMenuItem

        Caption = '&Index...'

        OnClick = CmFindIndexClick

      end

    end

    object CmDelete: TMenuItem

      Caption = '&Delete'

      object CmDelString: TMenuItem

        Caption = '&String...'

        OnClick = CmDelStringClick

      end

      object CmDelIndex: TMenuItem

        Caption = '&Index...'

        OnClick = CmDelIndexClick

      end

      object N1: TMenuItem

        Caption = '-'

      end

      object CmClear: TMenuItem

        Caption = '&All'

        OnClick = CmClearClick

      end

    end

    object CmList: TMenuItem

      Caption = '&List'

      OnClick = CmListClick

      object CmShowList: TMenuItem

        Caption = '&Show'

        OnClick = CmShowListClick

      end

      object CmSortList: TMenuItem

        Caption = 'So&rt'

        OnClick = CmSortListClick

      end

    end

  end

end


TComboBox example (inptform.pas)

combform.pas	combform.dfm	inptform.dfm

unit inptform;

interface

uses

  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,

  StdCtrls;

type

  TInputForm = class(TForm)

    Button1: TButton;

    Button2: TButton;

    PromptLabel: TLabel;

    InputEdit: TEdit;

  private

    { Private declarations }

    function Execute: Boolean;

  public

    { Public declarations }

    function GetString(prompt: string; var s: string): Boolean;

    function GetInteger(prompt: string; var i: Integer): Boolean;

  end;

var

  InputForm: TInputForm;

implementation

{$R *.DFM}

function TInputForm.Execute: Boolean;

begin

  InputEdit.Text := '';

  Result := ShowModal = mrOk;

end;

function TInputForm.GetString(prompt: string; var s: string): Boolean;

begin

  PromptLabel.Caption := prompt;

  Result := InputForm.Execute;

  if Result then

    s := InputEdit.Text;

end;

function TInputForm.GetInteger(prompt: string; var i: Integer): Boolean;

begin

  PromptLabel.Caption := prompt;

  Result := InputForm.Execute;

  if Result then

    i := StrToInt(InputEdit.Text);

end;

end.


TComboBox example (inptform.dfm)

combform.pas	inptform.pas	combform.dfm

object InputForm: TInputForm

  Left = 200

  Top = 108

  Width = 274

  Height = 140

  ActiveControl = InputEdit

  Caption = 'InputForm'

  Font.Charset = DEFAULT_CHARSET

  Font.Color = clWindowText

  Font.Height = -11

  Font.Name = 'MS Sans Serif'

  Font.Style = []

  Position = poScreenCenter

  PixelsPerInch = 96

  TextHeight = 13

  object PromptLabel: TLabel

    Left = 40

    Top = 8

    Width = 5

    Height = 13

    Font.Charset = DEFAULT_CHARSET

    Font.Color = clWindowText

    Font.Height = -11

    Font.Name = 'MS Sans Serif'

    Font.Style = [fsBold]

    ParentFont = False

  end

  object InputEdit: TEdit

    Left = 36

    Top = 24

    Width = 193

    Height = 20

    TabOrder = 0

  end

  object Button1: TButton

    Left = 43

    Top = 72

    Width = 75

    Height = 25

    Caption = '&OK'

    Default = True

    ModalResult = 1

    TabOrder = 1

  end

  object Button2: TButton

    Left = 147

    Top = 72

    Width = 75

    Height = 25

    Caption = '&Cancel'

    ModalResult = 2

    TabOrder = 2

  end

end


CommonAVI example

// To run this example, create a new project, place a button on the form,

// and insert the example code to the button click event.

// Place the button on the bottom of the form to leave

// room for the TAnimate component that will be created on the fly.

procedure TForm1.Button1Click(Sender: TObject);

var

  TempForm: TForm;

  I: Integer;

begin

  TempForm := TForm.Create(Self);

  with TAnimate.Create(TempForm) do

  try

    Parent := TempForm;

    CommonAVI := aviFindFile;

    Active := True;

    TempForm.Show;

    // Simulate a lengthy process.  Alter this value

    // to accomodate your machine speed.

    for I := 0 to 900000 do Application.ProcessMessages;

  finally

    TempForm.Release;

  end;

end;


Assign, Dormant, FreeImage, Monochrome, ReleaseHandle example

procedure TForm1.Button1Click(Sender: TObject);

var

 BitMap1,BitMap2 : TBitMap;

 MyFormat : Word;

begin

 try

   BitMap2 := TBitMap.Create;

   BitMap1 := TBitMap.Create;

   BitMap1.LoadFromFile('C:\Program Files\Borland\Delphi 3\Images\Splash\256color\factory.bmp');

   BitMap2.Assign(BitMap1);                                 // Copy BitMap1 into BitMap2

   BitMap2.Dormant;                                    // Free up GDI resources

   BitMap2.FreeImage;                                  // Free up Memory.

   Canvas.Draw(20,20,BitMap2);                         // Note that previous calls don't lose the image

   BitMap2.Monochrome := true;

   Canvas.Draw(80,80,BitMap2);

   BitMap2.ReleaseHandle;                              // This will actually lose the bitmap;

 finally

   BitMap1.Free;

   BitMap2.Free;

 end;

end;


LoadFromClipboard example

procedure TForm1.Button1Click(Sender: TObject);

var

  Bitmap : TBitmap;

begin

 Bitmap := TBitMap.create;

 try

   Bitmap.LoadFromClipBoardFormat(cf_BitMap,ClipBoard.GetAsHandle(cf_Bitmap),0);

   canvas.draw(0,0,Bitmap);

 finally

   Bitmap.free;

 end;

end;


LoadFromResourceName example

procedure TForm1.Button1Click(Sender: TObject);

var

 BitMap1 : TBitMap;

begin

  try

    BitMap1 := TBitMap.Create;

    BitMap1.LoadFromResourceName(HInstance,'THEBITMAP');

    Canvas.Draw(12,12,BitMap1);

  finally

    BitMap1.Free;

  end;

end;


SaveToClipBoardFormat example

procedure TForm1.Button1Click(Sender: TObject);

var

  MyFormat : Word;

  Bitmap : TBitMap;

  AData,APalette : Thandle;

begin

  try

    Bitmap := TBitmap.Create;

    Bitmap.LoadFromFile('C:\Program Files\Borland\Delphi 3\Images\Splash\256color\factory.bmp');

    Bitmap.SaveToClipBoardFormat(MyFormat,AData,APalette);

    ClipBoard.SetAsHandle(MyFormat,AData);

  finally

    Bitmap.Free;

  end;

end;


SaveToStream, LoadFromStream example

procedure TForm1.Button1Click(Sender: TObject);

// This example shows drawing directly to the BitMap

var

  x,y : integer;

  BitMap : TBitMap;

  P : PByteArray;

begin

  BitMap := TBitMap.create;

  try

    BitMap.LoadFromFile('C:\Program Files\Borland\Delphi 3\Images\Splash\256color\factory.bmp');

    for y := 0 to BitMap.height -1 do

    begin

      P := BitMap.ScanLine[y];

      for x := 0 to BitMap.width -1 do

        P[x] := y;

    end;

  canvas.draw(0,0,BitMap);

  finally

    BitMap.free;

  end;

end;


ScanLine example

procedure TForm1.Button1Click(Sender: TObject);

// This example shows drawing directly to the BitMap

var

  x,y : integer;

  BitMap : TBitMap;

  P : PByteArray;

begin

  BitMap := TBitMap.create;

  try

    BitMap.LoadFromFile('C:\Program Files\Borland\Delphi 3\Images\Splash\256color\factory.bmp');

    for y := 0 to BitMap.height -1 do

    begin

      P := BitMap.ScanLine[y];

      for x := 0 to BitMap.width -1 do

        P[x] := y;

    end;

  canvas.draw(0,0,BitMap);

  finally

    BitMap.free;

  end;

end;


Canvas, Transparent, TransparentMode, TransparentColor example

procedure TForm1.Button1Click(Sender: TObject);

var

  Bitmap : TBitMap;

begin

  Bitmap := TBitmap.Create;

  try

    with Bitmap do begin

      LoadFromFile('C:\Program Files\Borland\Delphi 3\Images\Splash\256color\factory.bmp');

      Transparent := true;

      TransParentColor := BitMap.canvas.pixels[50,50];

      Form1.Canvas.Draw(0,0,BitMap);

      TransparentMode := tmAuto;   // Transparent color now is clDefault = TColor($20000000);

      Form1.canvas.Draw(50,50,BitMap);

    end;

  finally

    Bitmap.Free;

  end;

end;


Control, TCoolBar.Create example

// To run this example, add the example code to a new project.

// The example code dynamically creates a TCoolbar and three TCoolBand

// objects populated with a windowed control in each TCoolBand.

procedure AddBand(CoolBar: TCoolBar; Const ControlClasses: array of TControlClass);

var

  CurrentControl: TControl;

  I: Integer;

begin

  for I := 0 to High(ControlClasses) do

    begin

      CurrentControl := ControlClasses[i].Create(CoolBar);

      if (CurrentControl is TWinControl) then

      begin

        // Placing the control onto the CoolBar causes the TCoolBar object

        // to create a TCoolBand and place the control within the band.

        CurrentControl.Parent := Coolbar;

        // Get the reference of the last TCoolBand created and assign text.

        with CoolBar.Bands do

          Items[count - 1].Text := CurrentControl.ClassName;

      end;

    end;

end;

procedure TForm1.FormCreate(Sender: TObject);

var

  CoolBar: TCoolBar;

begin

  CoolBar := TCoolBar.Create(Self);

  CoolBar.Parent := Self;

  CoolBar.Align := alClient;

  AddBand(CoolBar, [TCheckBox, TEdit, TButton]);

end;


OnDrawSection, Sections example

procedure TForm1.FormCreate(Sender: TObject);

var

  HeaderSection: THeaderSection;

  I: integer;

begin

  for I := 0 to 4 do

  begin

    HeaderSection := HeaderControl1.Sections.Add;

    HeaderSection.Text := 'Text Section ' + IntToStr(I);

    HeaderSection.MinWidth := length(HeaderSection.Text) * Font.Size;

    // Owner draw every other section

    if (I mod 2 = 0) then

      HeaderSection.Style := hsOwnerDraw

    else

      HeaderSection.Style := hsText;

  end;

end;

procedure TForm1.HeaderControl1DrawSection(HeaderControl: THeaderControl;

  Section: THeaderSection; const Rect: TRect; Pressed: Boolean);

begin

  with HeaderControl.Canvas do

  begin

    // highlight pressed sections

    if Pressed then

      Font.Color := clRed

    else

      Font.Color := clBlue;

    TextOut(Rect.Left + Font.Size, Rect.Top + 2, 'Owner Drawn text');

  end;

end;


HotKey example

procedure TForm1.File1Click(Sender: TObject);

begin

  // Assign hotkey to the menu's File "New" item.

  New1.ShortCut := HotKey1.HotKey;

end;

procedure TForm1.FormCreate(Sender: TObject);

begin

  // Default to "Ctrl + A"

  HotKey1.Modifiers := [hkCtrl];

  // Don't allow shift or alt

  HotKey1.InvalidKeys := [hcShift, hcAlt];

end;


Align, Columns, Items, TListView.Create example

{ This example requires only a blank form.  All other objects:

  TListView, TListColumns, TListItems, are created dynamically.

}

procedure TForm1.FormCreate(Sender: TObject);

const

  Names: array[0..5, 0..1] of ShortString = (

    ('Rubble', 'Barney'),

    ('Michael', 'Johnson'),

    ('Bunny', 'Bugs'),

    ('Silver', 'HiHo'),

    ('Simpson', 'Bart'),

    ('Squirrel', 'Rockey')

    );

var

  I: integer;

  NewColumn: TListColumn;

  ListItem: TListItem;

  ListView: TListView;

begin

  ListView := TListView.Create(Self);

  with ListView do

  begin

    Parent := Self;

    Align := alClient;

    ViewStyle := vsReport;

    NewColumn := Columns.Add;

    NewColumn.Caption := 'Last';

    NewColumn := Columns.Add;

    NewColumn.Caption := 'First';

    for I := 0 to High(Names) do

    begin

      ListItem := Items.Add;

      ListItem.Caption := Names[I][0];

      ListItem.SubItems.Add(Names[I][1]);

    end;

  end;

end;


Column, Items, ViewStyle example

{

This example requires a TListView, an TImageList and a TComboBox.

You will need to double click the image list and add several images

to the image list prior to running the project.

You can use *.bmp or *.ico files from the \Images\Icons directory.

During the form OnCreate event handler, items for the List View control

are created for each image in the Image List and the ImageIndex is assigned

the number of the image within the ImageList.  Two columns are created

so that when ViewStyle is vsReport, you will have columns to view.

Also within the forms OnCreate event handler assign the ComboBox each of

the four TViewStyle constants. to the Items Objects property.

You could also simply code this, for example within a series of OnClick

event handlers as, for instance, ListView1.ViewStyle := vsIcon.

}

procedure TForm1.FormCreate(Sender: TObject);

var

  I: integer;

  ListItem: TListItem;

  NewColumn: TListColumn;

begin

  // Create a ListView item for each image in the ImageList

  with ListView1 do

  begin

    SmallImages := ImageList1;

    LargeImages := ImageList1;

    for I := 0 to ImageList1.Count - 1 do

    begin

      ListItem := Items.Add;

      Listitem.Caption := 'Image' + IntToStr(I);

      ListItem.ImageIndex := I;

    end;

    // Create two columns to show during viewing as vsReport

    NewColumn := Columns.add;

    NewColumn.Caption := 'Column 1';

    NewColumn := Columns.add;

    NewColumn.Caption := 'Column 2';

    // Add View styles and constants to the Combo Box

    ComboBox1.Items.AddObject('vsIcon', TObject(vsIcon));

    ComboBox1.Items.AddObject('vsList', TObject(vsList));

    ComboBox1.Items.AddObject('vsReport', TObject(vsReport));

    ComboBox1.Items.AddObject('vsSmallIcon', TObject(vsSmallIcon));

    // Display first item in the Combo Box

    ComboBox1.ItemIndex := 0;

  end;

end;

procedure TForm1.ComboBox1Click(Sender: TObject);

begin

  with ComboBox1 do

    ListView1.ViewStyle := TViewStyle(Items.Objects[ItemIndex]);

end;


Open, VisibleButtons example

begin

With MediaPlayer1 do begin

     Filename := 'c:\win95\roaring.wav'; //specify sound file

     ShowHint := True; //show buttons hints

     Shareable := True; //allow others to use the same .wav file

     VisibleButtons := [btPlay, btStop]; //limit to just two buttons

     Open; //play it

end;

end;


DeviceType, Display, Play example

var sWinDir: String;

    iLength: Integer;

begin

// Initialize Variable

iLength := 255;

setLength(sWinDir, iLength);

iLength := GetWindowsDirectory(PChar(sWinDir), iLength);

setLength(sWinDir, iLength);

With MediaPlayer1 do begin

     Filename := sWinDir + '\Clock.avi'; //specify video file

     DeviceType := dtAVIVideo; //set Device compatibility to AVI

     Display := Panel1; //Set display device to a TPanel

     Open;

     Play;

end;

end;


ActivePage example

{

This project requires a TPageControl already on the form.

Also, you must add pages to the TPageControl by right clicking and

selecting New Page.

The example code will allow the user to select the ActivePage property

through selection of a ComboBox item.  During the form create, the

Combo Box control is loaded with the names of each of the tabs, as well as

the instance pointers to the corrosponding tab.  When the user selects

the Combo Box item, the associated TTabSheet object contained in the

Combo Box Objects array is used to set the ActivePage property.

}

procedure TForm1.FormCreate(Sender: TObject);

var

  i: integer;

begin

  for i := 0 to PageControl1.PageCount - 1 do

    ComboBox1.Items.AddObject(PageControl1.Pages[i].Name,

      PageControl1.Pages[i]);

  ComboBox1.ItemIndex := 0;

end;

procedure TForm1.ComboBox1Change(Sender: TObject);

begin

  if (Sender is TComboBox) then

    with (Sender as TComboBox) do

      PageControl1.ActivePage := TTabSheet(Items.Objects[ItemIndex]);

end;


Align, PageControl, TPageControl.Create example

{

This example dynamically creates a Page Control, then a series of

Tab Sheets on the Page Control.

}

procedure TForm1.FormCreate(Sender: TObject);

const

  TabTitles: array[0..3] of ShortString = ('Customer', 'Orders',	'Items',       'Parts' );

var

  i: integer;

  PageControl1: TPageControl;

begin

  PageControl1 := TPageControl.Create(Self);

  PageControl1.Parent := Self;

  PageControl1.Align := alClient;

  for i := Low(TabTitles) to High(TabTitles) do

    with TTabSheet.Create(PageControl1) do

    begin

      PageControl := PageControl1;

      Name := 'ts' + TabTitles[i];

      Caption := TabTitles[i];

   end;

end;


FindNextPage example

{

This project requires a new TPageControl, as-is, with no new pages

created at design time.

The form OnCreate event handler adds several new TabSheet controls

to the Page Control.  The Page Controls OnChange event handler displays

a message dialog when the user changes tabs.  The message dialog

contains the captions for the tabs immediately before and after the

active tab.

}

procedure TForm1.FormCreate(Sender: TObject);

var

  i: integer;

begin

  for i := 0 to 9 do

    with TTabSheet.Create(Self) do

    begin

      PageControl := PageControl1;

      Caption := 'TabSheet #' + IntToStr(i);

    end;

end;

procedure TForm1.PageControl1Change(Sender: TObject);

var

  PrevCaption, NextCaption: ShortString;

begin

  with (Sender as TPageControl) do

  begin

    PrevCaption := FindNextPage(ActivePage, True, False).Caption;

    NextCaption := FindNextPage(ActivePage, False, False).Caption;

  end;

  ShowMessage('Previous tab caption: "' + PrevCaption +

    '"    Next tab Caption: "' + NextCaption + '"');

end;


MultiLine example

{

This project requires a PageControl with no pages created, and a TCheckBox.

During the form create, a series of tabs will be created on the Page Control

that exceed the Page Control's width.  When the Check Box control is clicked,

the setting of the MultiLine property is toggled, alternately stacking the

tabs vertically, or along a single line horizontally.

}

procedure TForm1.CheckBox1Click(Sender: TObject);

begin

  PageControl1.MultiLine := CheckBox1.Checked;

end;

procedure TForm1.FormCreate(Sender: TObject);

var

  i: integer;

begin

  Checkbox1.Caption := 'Stack Tabs?';

  for i := 0 to 20 do

    with TTabSheet.Create(Self) do

    begin

      PageControl := PageControl1;

      Caption := 'Tab #' + IntToStr(i);

    end;

end;


OnChange example

{

This project requires a Page Control.  You will need to  populate the

Page Control by right clicking and selecting New Page from the context menu.

As the tabs are selected by the user, the Page Control OnChange event fires

which causes the form caption to display the captions of each of the

TTabSheets attached to the Page Control.

}

procedure TForm1.PageControl1Change(Sender: TObject);

begin

  Caption := Now working on tab:  ' + PageControl1.ActivePage.Caption;

end;

procedure TForm1.FormShow(Sender: TObject);

begin

  PageControl1Change(Sender);

end;


OnChanging example

{

This project requires a TPageControl, several TTabSheets (to add sheets,

right click the Page Control and select "New Page" from the context menu),

and a TEdit control on the first tab sheet.

The user is not allowed to change to a new page if the active page is

"TabSheet1" and there is no text in the Edit Control.

}

procedure TForm1.PageControl1Changing(Sender: TObject;

  var AllowChange: Boolean);

begin

  if ((Sender as TPageControl).ActivePage = TabSheet1) then

    AllowChange := (Edit1.Text <> '')

  else

    AllowChange := True;

end;


SelectNextPage example

{

This example requires a new TPageControl, as-is, with no new pages

created at design time, and a TUpDown control, also from the Win95 page

of the component palette.

The form OnCreate event handler adds several new TabSheet controls to

the Page Control.

The UpDown1Click event handler fires when the user clicks the up or

down button on the TUpDown control.  The SelectNextPage method of the

Page Control goes forward the comparison (Button = btNext) evaluates

as true.  If Button is not btNext, the previous Tab Page is selected.

}

procedure TForm1.FormCreate(Sender: TObject);

var

  i: integer;

begin

  for i := 0 to 9 do

    with TTabSheet.Create(Self) do

    begin

      PageControl := PageControl1;

      Caption := 'TabSheet #' + IntToStr(i);

    end;

end;

procedure TForm1.UpDown1Click(Sender: TObject; Button: TUDBtnType);

begin

  PageControl1.SelectNextPage(Button = btNext);

end;


TabHeight example
Pages, TabHeight, TabWidth example

{

This project requires a TPageControl and several TTabPages.

To add new pages, right click the TPageControl and select "New Page".

During the form creation the width and height of all tabs on the Page

Control becomes double the largest previous value.  So if there are three

tabs with captions that are 12, 23 and 19 characters long, the TabWidth

would be the number of pixels required to fit 46 characters.

}

procedure TForm1.FormCreate(Sender: TObject);

var

  i: integer;

begin

  with PageControl1 do

  begin

    for i := 0 to PageCount - 1 do

    begin

      if (Canvas.TextWidth(Pages[i].Caption) * 2) > TabWidth then

        TabWidth := Canvas.TextWidth(Pages[i].Caption) * 2;

      if (Canvas.TextHeight(Pages[i].Caption) * 2) > TabHeight then

        TabHeight := Canvas.TextHeight(Pages[i].Caption) * 2;

    end;

end;

end;


Align, TProgressBar.Create example

// dynamically create a TProgressBar control

// and align it to the bottom of the form.

procedure TForm1.Button1Click(Sender: TObject);

var

  ProgressBar: TProgressBar;

begin

  ProgressBar := TProgressBar.Create(Self);

  with ProgressBar do

  begin

    Parent := Self;

    Align := alBottom;

  end;

end;


Min, Max, Position example

// Read through all records in a table and update

// the ProgressBar accordingly.

procedure TForm1.Button1Click(Sender: TObject);

var

  i: integer;

begin

  with ProgressBar1 do

  begin

    Min := 0;

    Max := Table1.RecordCount;

    Table1.First;

    for i := Min to Max do

    begin

      Position := i;

      Table1.Next;

    end;

  end;

end;


Step, StepIt example

{

 This example reads bytes from a file in tenths of the size of the file.

The ProgressBar displays the status of each  1/10th step as it's read into

the buffer.

The example assumes a TButton and a TProgressBar control already placed

on the form.

}

procedure TForm1.Button1Click(Sender: TObject);

const

  FName = 'c:\autoexec.bat';

var

  F: File;

  MyData: array[1..2048] of byte;

  BytesRead: LongInt;

begin

  AssignFile(F, FName);

  try

    Reset(F);

    ProgressBar1.Max := FileSize(F);

    if (ProgressBar1.Max > 10) then

      // amount to move when StepIt method called

      ProgressBar1.Step := ProgressBar1.Max div 10

    else

      ProgressBar1.Step := ProgressBar1.Max;

    while (ProgressBar1.Position < ProgressBar1.Max) do

    begin

      // read one Step size chunk of data to buffer

      BlockRead(F, MyData, ProgressBar1.Step, BytesRead);

      // move the ProgressBar Position using StepIt

      ProgressBar1.StepIt; // move by Step amount

    end;

  finally;

    CloseFile(F);

  end;

end;


StepBy example

{

This example shows progress of loading forms as an application starts up.

The code example is placed in the project source (*.dpr) file.  To see

project source, select the View | Project Source menu item.

You will need to set up your project with the following steps before using

the code example:

Add four additional forms to a default project.

Place a TProgressBar on Form5

Take the  Project | Options | Forms menu option and place Form5 on the

available forms list.

Change the code of your project (*.dpr) file to look like the example.

}

begin

  Application.Initialize;

  with TForm5.Create(nil) do

  try

    ProgressBar1.Max := 100;

    Show;   // show a splash screen contain ProgressBar control

    Update; // force display of Form5

    Application.CreateForm(TForm1, Form1);

    ProgressBar1.StepBy(25);

    Application.CreateForm(TForm2, Form2);

    ProgressBar1.StepBy(25);

    Application.CreateForm(TForm3, Form3);

    ProgressBar1.StepBy(25);

    Application.CreateForm(TForm4, Form4);

    ProgressBar1.StepBy(25);

  finally

    Free;

  end;

  Application.Run;

end.


Alignment example

{

To use this example, place a Toolbar and a RichEdit on the form.

Right click the toolbar and select New Button three times.  Place the

ToolButton1Click handling code in the on click event of the first

TToolButton, then attach the same OnClick handler for each button.

}

procedure TForm1.ToolButton1Click(Sender: TObject);

begin

  if (Sender = ToolButton1) then

    RichEdit1.Paragraph.Alignment := taLeftJustify

  else if (Sender = Toolbutton2) then

    RichEdit1.Paragraph.Alignment := taCenter

  else if (Sender = Toolbutton3) then

    RichEdit1.Paragraph.Alignment := taRightJustify;

end;


Align, TRichEdit.Create example

{

This example requires no additional controls.  All controls are

created dynamically within the form's OnCreate event handler.

Note: Be sure to add ComCtrls to your uses clause to support

TRichEdit.

}

uses ComCtrls;

procedure TForm1.FormCreate(Sender: TObject);

var

  i: integer;

begin

  with TStatusBar.Create(Self) do

  begin

    // Display the StatusBar control on the surface

    // of the form.

    Parent := Self;

    // Allow a single line of text -- no panels.

    SimplePanel := True;

    // Provide sample text.

    // Create a new instance of TRichEdit, set it's

    // properties, and display on the form.

    with TRichEdit.Create(Self) do

    begin

      // Display the RichEdit control on the surface

      // of the form.

      Parent := Self;

      // The RichText control takes all space left

      // over from the StatusBar.

      Align := alClient;

      // Add 50 lines to the RichText

      for i := 1 to 50 do

        Lines.Add('Adding line ' + IntToStr(i));

      SelStart := 0; // set text cursor to first character

      SimpleText := 'Number of Lines loaded to RichText: ' +

        IntToStr(Lines.Count);

    end;

  end;

end;


DefAttributes example
DefAttributes, SelAttributes example

{

This example requires a TRichEdit and two TButtons.

Leave the default text, usually "RichEdit1", in the lines property.

The DefAttributes will apply to this text.

}

procedure TForm1.Button1Click(Sender: TObject);

begin

  with RichEdit1.SelAttributes do

  begin

    Color := clRed;

    Height := Height + 5;

  end;

  RichEdit1.Lines.Add('This line of text will be red.');

end;

procedure TForm1.Button2Click(Sender: TObject);

begin

  RichEdit1.DefAttributes.Color := clBlue;

  RichEdit1.DefAttributes.Style := [fsBold, fsItalic];

end;


FindText example

{

This example requires a TRichEdit, a TButton, and a TFindDialog.

Executing the button click will display a Find Dialog.  Filling in

the "FInd what" text and pressing the Find Next button will select

the first string in the Rich Edit control that matches.

}

procedure TForm1.Button1Click(Sender: TObject);

begin

  FindDialog1.Execute;

end;

procedure TForm1.FindDialog1Find(Sender: TObject);

var

  FoundAt: LongInt;

begin

  with RichEdit1 do

  begin

    FoundAt := Pos(FindDialog1.FindText, Text) - 1;

    if (FoundAt <> 0) then

    begin

      SetFocus;

      SelStart := FoundAt;

      SelLength := Length(FindDialog1.FindText);

    end;

  end;

end;


Font example

{

To use this example, place a TComboBox and TRichEdit on a form.

During form creation, a list of font names are loaded into the combo box.

When the combo box is clicked, the Rich Edit control font is set to the

corrosponding font name in the combo box.

}

procedure TForm1.FormCreate(Sender: TObject);

var

  i: integer;

begin

  for i := 0 to Screen.Fonts.Count - 1 do

    ComboBox1.Items.Add(Screen.Fonts[i]);

end;

procedure TForm1.ComboBox1Click(Sender: TObject);

begin

  RichEdit1.Font.Name := ComboBox1.Items[ComboBox1.ItemIndex];

end;


HideSelection example

{

This example needs only a blank form.  Three Rich Edit controls are placed

vertically on the form, each contain a line of text, and the second form has

HideSelection set to false.

Try tabbing between the three Rich Edit controls and observe the effect on

the selected text.

}

uses ComCtrls;

procedure TForm1.FormCreate(Sender: TObject);

var

  I: integer;

begin

  for I := 0 to 2 do

    with TRichEdit.Create(Self) do

    begin

      Parent := Self;

      Top := Height * I;

      Text := 'This text will take the focus.';

      SelStart := 0;

      SelLength := Length(Text);

      if (I = 1) then

        HideSelection := False;

    end;

end;


OnSelectionChange example

{

This example requires a TStatusBar and a TRichEdit.  The code

within the form's OnCreate will take care of sizing the Rich Edit

and setting the OnSelectionChange event to be handled by

RichEdit1SelectionChange.

As you type in the Rich Edit control, the current character location

the selection begin and end will display in the status bar control.

}

procedure TForm1.RichEdit1SelectionChange(Sender: TObject);

begin

  with RichEdit1 do

    StatusBar1.SimpleText := '  Selection Start: ' + IntToStr(SelStart) +

      '  Selection End: ' + IntToStr(SelStart + SelLength);

end;

procedure TForm1.FormCreate(Sender: TObject);

begin

  with RichEdit1 do

  begin

    Align := alClient;

    OnSelectionChange := RichEdit1SelectionChange;

  end;

  StatusBar1.SimplePanel := True;

end;


Lines, Paragraph example

{

This example only requires a form and ComCtrls in the uses clause.

A Rich Edit control is created on the form and aligned to take the

entire client area of the form.  A series of lines are written to the

Rich Edit control's Lines property, and the Paragraph property

manipulated such that the first items displayed are bulletted,

a second group of lines are un-bulletted and centered, and the

last group is left justified and indented.

}

uses ComCtrls;

procedure TForm1.FormCreate(Sender: TObject);

begin

  with TRichEdit.Create(Self) do

  begin

    Parent := Self;

    Align := alClient;

    Lines.Clear;

    // set numbering style

    Paragraph.Numbering := nsBullet;

    Lines.Add('Introduction');

    Lines.Add('New members to our team');

    Lines.Add('New Budget discussion');

    Lines.Add('Facilities');

    Lines.Add('Q & A');

    Paragraph.Numbering := nsNone;

    Paragraph.Alignment := taCenter;

    Lines.Add('');

    Lines.Add('Suggested Topics:');

    Lines.Add('');

    ParaGraph.Alignment := taLeftJustify;

    ParaGraph.FirstIndent := 10;

    Lines.Add('');

    Lines.Add('Parking lot repair');

    Lines.Add('Cost overruns');

  end;

end;


PlainText example

{

This example requires two TRichEdit controls placed on the form.

When the form becomes visible, the first Rich Edit control will

display the rich text in it's raw form, including formatting characters.

The second will show the rich text in it's intended format.

}

procedure TForm1.FormCreate(Sender: TObject);

const

  // you may need to change this path to suit your environment

  Path = 'c:\Program files\Borland\Delphi 3.0\Demos\RichEdit\OverView.RTF';

begin

  RichEdit1.PlainText := True;

  RichEdit1.Lines.LoadFromFile(Path);

  RichEdit2.PlainText := False;

  RichEdit2.Lines.LoadFromFile(Path);

end;


Print example

procedure TForm1.FormCreate(Sender: TObject);

const

  // The path may need to be changed to accomodate locations of files

  // on your system.

  Path = 'C:\PROGRAM FILES\BORLAND\DELPHI 3.0\DEMOS\RICHEDIT\OVERVIEW.RTF';

begin

   RichEdit1.Lines.LoadFromFile(Path);

end;

procedure TForm1.Button1Click(Sender: TObject);

begin

  // The parameter string shows in the print queue under "Document   // name".

  RichEdit1.Print('My Document Name');

end;


HideScrollBars, ScrollBars example

{

This example requires: TRichEdit, TRadioGroup, TCheckBox, TButton.

Clicking the Radio Group control sets the ScrollBar style of the RichEdit.

Toggling the Check Box turns HideScrollBars on and off.  Clicking the button

loads the Rich Edit with a large amount of contiguous text.

}

procedure TForm1.Button1Click(Sender: TObject);

var

  I: integer;

begin

  RichEdit1.Lines.Clear;

  for I := 0 to 500 do

    RichEdit1.Text := RichEdit1.Text + 'test line ' + IntToStr(I);

  RichEdit1.SelStart := 0; // move text cursor to top of edit

end;

procedure TForm1.CheckBox1Click(Sender: TObject);

begin

  RichEdit1.HideScrollbars := CheckBox1.Checked;

end;

procedure TForm1.RadioGroup1Click(Sender: TObject);

const

  ScrollBarA: array[0..3] of TScrollStyle = (

    ssBoth,

    ssHorizontal,

    ssNone,

    ssVertical);

begin

  RichEdit1.ScrollBars := ScrollBarA[RadioGroup1.ItemIndex];

end;

procedure TForm1.FormCreate(Sender: TObject);

begin

  with RadioGroup1, Items do

  begin

    Caption := 'Scroll Bars';

    Clear;

    Add('ssBoth');

    Add('ssHorizontal');

    Add('ssNone');

    Add('ssVertical');

  end;

  with CheckBox1 do

  begin

    Caption := 'HideScrollBars';

    Checked := True;

  end;

  Button1.Caption := 'Loaded';

end;


Align, Assign, TStringList.Create, TStrings.Create example
Align, Assign, TStringList.Create, TStrings.Create

var

  StringList: TStrings;

begin

  StringList := TStringList.Create;

  try

    with StringList do begin

      Add('This example uses A string List.');

      Add('It is the easiest way to add strings');

      Add('to a combobox''s list of strings.');

      Add('Always remember TStrings.Create method');

      Add('is abstract; So use TStringList.Create');

      Add('method instead.');

    end;

    with ComboBox1 do begin

      Width := 210;

      Items.Assign(StringList);

      ItemIndex := 0;

    end;

  finally

    StringList.free;

  end;

end;


Caption example

{

This example requires a TPageControl, a TEdit and a TButton.

When the button is clicked, the caption of the active tab changes

to that of the TEdit.

These lines of code could also be written like the example below.

This would obviate the need for a TTabSheet variable since

PageControl.ActivePage is already of type TTabSheet.

 Example:

 PageControl1.ActivePage.Caption := Edit1.Text;

}

procedure TForm1.Button1Click(Sender: TObject);

var

  TSheet: TTabSheet;

begin

  TSheet := PageControl1.ActivePage;

  TSheet.Caption := Edit1.Text;

end;


PageIndex, TabIndex, TabVisible example

{

This example creates ten Tab Sheets and sets the captions to display

PageIndex and TabIndex for each tab.  Odd numbered tabs have their

TabVisible property set off to demonstrate the effect on PageIndex

vs TabIndex.  On the series of visible tabs, PageIndex will read

0, 2, 4, 6, 8, and TabIndex will read 0, 1, 2, 3, 4.  PageIndex

counts only visible tabs.

Note: Pages[i] is of type TTabSheet.

}

procedure TForm1.FormCreate(Sender: TObject);

var

  i: integer;

begin

  with PageControl1 do

    for i := 0 to 9 do

      with TTabSheet.Create(Self) do

      begin

        PageControl := PageControl1;

        Caption := 'PageIndex: ' +

        IntToStr(Pages[i].PageIndex) + '  TabIndex: ' +

          IntToStr(Pages[i].TabIndex);

        Pages[i].TabVisible := (i mod 2 = 0);

     end;

end;


Visible example

{

This examples requires a TPageControl and a TCheckBox.  The form

OnCreate event handler populates each sheet with an edit control

placed somewhere on the client area of the sheet.

Clicking the checkbox will cause the client area (not the tab area)

of the Tab Control to become invisible when the Check Box is unchecked.

}

procedure TForm1.PageControl1Change(Sender: TObject);

begin

  CheckBox1.Checked := PageControl1.ActivePage.Visible;

end;

procedure TForm1.CheckBox1Click(Sender: TObject);

begin

  PageControl1.ActivePage.Visible := CheckBox1.Checked;

end;

procedure TForm1.FormCreate(Sender: TObject);

var

  i: integer;

begin

  for i := 0 to 9 do

    with TTabSheet.Create(Self) do

    begin

      PageControl := PageControl1;

      Caption := 'TabSheet' + IntToStr(i);

      with TEdit.Create(Self) do

      begin

        Parent := PageControl1.Pages[i];

        Left := Random(PageControl1.ActivePage.ClientWidth - Width);

        Top := Random(PageControl1.ActivePage.ClientHeight - Height);

      end;

    end;

    PageControl1Change(Sender);

end;


TToolBar.Create example

{

To use this example, create a new application and add the example code to the unit.

}

procedure AddButtons(ToolBar: TToolBar;

  Const ButtonCaptions: array of String);

var

  I: Integer;

begin

  for I := 0 to High(ButtonCaptions) do

    begin

      with TToolButton.Create(ToolBar) do

      begin

        Parent := ToolBar;

        Caption := ButtonCaptions[I];

        if (ButtonCaptions[I] = '|') then

          Style := tbsSeparator

        else

          Style := tbsButton;

      end;

    end;

end;

procedure TForm1.FormCreate(Sender: TObject);

var

  ToolBar: TToolBar;

begin

  ToolBar := TToolBar.Create(Self);

  ToolBar.Parent := Self;

  AddButtons(ToolBar, ['New', 'Save', '|', 'Cut', 'Copy', 'Paste']);

  ToolBar.ShowCaptions := True;

  ToolBar.Height := 40;

end;