SnapLine クラス

定義

コンテナー内のコントロールのデザイン時にレイアウト操作を支援するために、ユーザー インターフェイス (UI) に動的に作成される水平の線分と垂直の線分を表します。Represents the horizontal and vertical line segments that are dynamically created in the user interface (UI) to assist in the design-time layout of controls in a container. このクラスは継承できません。This class cannot be inherited.

public ref class SnapLine sealed
public sealed class SnapLine
type SnapLine = class
Public NotInheritable Class SnapLine
継承
SnapLine

注釈

次の表は、デザイン画面でのコントロールの配置とサイズ設定を支援するために、ビジュアルデザインツールがサポートする共通モードを示しています。The following table lists the common modes that visual design tools support to assist you with positioning and sizing controls on a design surface.

モードMode 説明Description
Freeform コントロールを自由に配置できます。Enables you to freely lay out controls.
グリッドGrid コントロールのレイアウトを支援する静的なオーバーレイグリッドを表示します。Displays a static overlaid grid that assists you in laying out controls.
スナップSnapline コンテナーのコントロールを相互に相対的にレイアウトする際に役立つガイドラインを表示します。Displays guide lines that assist you in laying out the container's controls relative to each other. スナップガイドラインは、コントロールとそのコンテナーから生成されます。Snaplines originate from controls and their container.

クラスSnapLineおよび関連する型は、スナップ線モードをサポートします。The SnapLine class and related types help support the Snapline mode.

スナップ線は、コントロールのエッジが別のコントロールの近くまたはコンテナーの境界の近くに移動すると、動的に自動的に生成されます。Snaplines are generated dynamically and automatically as a control edge moves near another control or near the boundaries of its container. これは、コントロールがツールボックスから追加されたとき、またはマウス操作またはキーボードコマンドによって移動またはサイズ変更されたときに発生する可能性があります。This can occur when a control is added from the toolbox, or moved or resized by mouse operations or keyboard commands. コントロールには、通常、水平と垂直の両方のスナップ線が定義されています。四角形コントロールの場合、これらは通常、4つのすべての端から拡張します。Controls typically have both horizontal and vertical snaplines defined; for rectangular controls, these typically extend from all four edges.

クラスSnapLineでは、次の表に示すように、各スナップ線を説明するためにいくつかのプロパティのみを使用します。The SnapLine class uses only a few properties to describe each snapline, as shown in the following table.

プロパティProperty 説明Description
SnapLineType 関連付けられたコントロールに対する線の位置と方向を指定します。Specifies the location and direction of the line with respect to its associated control. 通常、類似した型のスナップ線だけが自動的にアラインされます。Typically, only snaplines of similar types will auto-align to each other.
Offset コントロールの左上隅からスナップ線が開始されるまでの距離をピクセル単位で指定します。Specifies the distance in pixels from the origin, which is the upper-left corner of the control, to where the snapline starts.
Priority スナップ線の相対的な重要度を指定します。Specifies the relative importance of the snapline. 特定のレイアウトの決定ポイントでは、アクティブで最も高い優先順位を持つスナップ線のみが表示されます。During any given layout decision point, only the snaplines that are active and have the highest priority are displayed.
Filter スナップ線のカスタムカテゴリを定義します。Defines custom categories of snaplines. これは省略可能な文字列です。This is an optional string.
IsHorizontal および IsVerticalIsHorizontal and IsVertical スナップ線が水平方向と垂直方向のどちらであるかを示します。Indicates whether a snapline has horizontal or vertical orientation, respectively.

クラスControlDesignerは、対応するコントロール型のスナップ線をSnapLinesプロパティに格納します。The ControlDesigner class stores snaplines for its corresponding control type in the SnapLines property. この基本クラスのスナップガイドラインLeftではTop、コントロールの端に沿って調整される、 Right Bottom 、、の各スナップ線が定義されているため、ほとんどのコントロールで十分です。This base class handling of snaplines will suffice for the majority of controls, as it defines the Left, Right, Top, and Bottom snaplines, which are aligned along the edges of the control. カスタムコントロールを開発するときに、この既定の組織では不十分な場合はSnapLines 、からControlDesigner派生したクラスのプロパティをオーバーライドします。When you are developing a custom control, if this default organization does not suffice, override the SnapLines property of the class derived from ControlDesigner. たとえば、ラベルなどのテキストベースのコントロールの水平方向のスナップ線を、テキストの上端およびベースライン (コントロールの上端と下端ではなく) に配置することができます。For example, you may want to align the horizontal snaplines of text-based controls, such as labels, with the top and base lines of the text (instead of the top and bottom edges of the control).

SnapLineTypeクラスをから派生させることはできません。The SnapLineType class cannot be derived from.

この機能は Visual Studio で幅広くサポートされています。「チュートリアル:スナップ線を使用した Windows フォーム上のコントロールの配置。There is extensive support for this feature in Visual Studio, see Walkthrough: Arranging Controls on Windows Forms Using Snaplines.

コンストラクター

SnapLine(SnapLineType, Int32)

スナップ線の種類とオフセットを指定して、SnapLine クラスの新しいインスタンスを初期化します。Initializes a new instance of the SnapLine class using the specified snapline type and offset.

SnapLine(SnapLineType, Int32, SnapLinePriority)

スナップ線の種類、オフセット、および優先順位を指定して、SnapLine クラスの新しいインスタンスを初期化します。Initializes a new instance of the SnapLine class using the specified snapline type, offset, and priority.

SnapLine(SnapLineType, Int32, String)

スナップ線の種類、オフセット、およびフィルター名を指定して、SnapLine クラスの新しいインスタンスを初期化します。Initializes a new instance of the SnapLine class using the specified snapline type, offset, and filter name.

SnapLine(SnapLineType, Int32, String, SnapLinePriority)

スナップ線の種類、オフセット、フィルター名、および優先順位を指定して、SnapLine クラスの新しいインスタンスを初期化します。Initializes a new instance of the SnapLine class using the specified snapline type, offset, filter name, and priority.

プロパティ

Filter

このスナップ線に関連付けられている、プログラマが定義したフィルター カテゴリを取得します。Gets the programmer-defined filter category associated with this snapline.

IsHorizontal

スナップ線が水平方向かどうかを示す値を取得します。Gets a value indicating whether the snapline has a horizontal orientation.

IsVertical

スナップ線が垂直方向かどうかを示す値を取得します。Gets a value indicating whether the snapline has a vertical orientation.

Offset

関連付けられたコントロールの原点からのスナップ線のオフセットをピクセル数で取得します。Gets the number of pixels that the snapline is offset from the origin of the associated control.

Priority

スナップ線の相対的な優先順位を示す値を取得します。Gets a value indicating the relative importance of the snapline.

SnapLineType

大まかな位置と方向を示す、スナップ線の種類を取得します。Gets the type of a snapline, which indicates the general location and orientation.

メソッド

AdjustOffset(Int32)

スナップ線の Offset プロパティを調整します。Adjusts the Offset property of the snapline.

Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ShouldSnap(SnapLine, SnapLine)

指定した SnapLine が別の SnapLine とスナップする必要があるかどうかを示す値を返します。Returns a value indicating whether the specified SnapLine should snap to another SnapLine.

ToString()

現在のスナップ線の文字列形式を返します。Returns a string representation of the current snapline.

適用対象

こちらもご覧ください