DockPattern.SetDockPosition(DockPosition) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Docks the AutomationElement at the requested DockPosition within a docking container.
public:
void SetDockPosition(System::Windows::Automation::DockPosition dockPosition);
public void SetDockPosition (System.Windows.Automation.DockPosition dockPosition);
member this.SetDockPosition : System.Windows.Automation.DockPosition -> unit
Public Sub SetDockPosition (dockPosition As DockPosition)
Parameters
- dockPosition
- DockPosition
The dock position relative to the boundaries of the docking container and other elements within the container.
Exceptions
When a control is not able to execute the requested dock style.
Examples
In the following example, an AutomationElement representing a control that supports the DockPattern control pattern has its dockPosition
modified.
///--------------------------------------------------------------------
/// <summary>
/// Obtains a DockPattern control pattern from an
/// automation element.
/// </summary>
/// <param name="targetControl">
/// The automation element of interest.
/// </param>
/// <returns>
/// A DockPattern object.
/// </returns>
///--------------------------------------------------------------------
private DockPattern GetDockPattern(
AutomationElement targetControl)
{
DockPattern dockPattern = null;
try
{
dockPattern =
targetControl.GetCurrentPattern(
DockPattern.Pattern)
as DockPattern;
}
// Object doesn't support the DockPattern control pattern
catch (InvalidOperationException)
{
return null;
}
return dockPattern;
}
'''--------------------------------------------------------------------
''' <summary>
''' Obtains a DockPattern control pattern from an
''' automation element.
''' </summary>
''' <param name="targetControl">
''' The automation element of interest.
''' </param>
''' <returns>
''' A DockPattern object.
''' </returns>
'''--------------------------------------------------------------------
Private Function GetDockPattern( _
ByVal targetControl As AutomationElement) As DockPattern
Dim dockPattern As DockPattern = Nothing
Try
dockPattern = DirectCast( _
targetControl.GetCurrentPattern(dockPattern.Pattern), _
DockPattern)
Catch exc As InvalidOperationException
' Object doesn't support the DockPattern control pattern
Return Nothing
End Try
Return dockPattern
End Function 'GetDockPattern
///--------------------------------------------------------------------
/// <summary>
/// Sets the dock position of a target.
/// </summary>
/// <param name="dockControl">
/// The automation element of interest.
/// </param>
/// <param name="dockPosition">
/// The requested DockPosition.
/// </param>
///--------------------------------------------------------------------
private void SetDockPositionOfControl(
AutomationElement dockControl, DockPosition dockPosition)
{
if (dockControl == null)
{
throw new ArgumentNullException(
"AutomationElement parameter must not be null.");
}
try
{
DockPattern dockPattern = GetDockPattern(dockControl);
if (dockPattern == null)
{
return;
}
dockPattern.SetDockPosition(dockPosition);
}
catch (InvalidOperationException)
{
// When a control is not able to dock.
// TO DO: error handling
}
}
'''--------------------------------------------------------------------
''' <summary>
''' Sets the dock position of a target.
''' </summary>
''' <param name="dockControl">
''' The automation element of interest.
''' </param>
''' <param name="dockPosition">
''' The requested DockPosition.
''' </param>
'''--------------------------------------------------------------------
Private Sub SetDockPositionOfControl( _
ByVal dockControl As AutomationElement, _
ByVal dockPosition As DockPosition)
If dockControl Is Nothing Then
Throw New ArgumentNullException( _
"AutomationElement parameter must not be null.")
End If
Try
Dim dockPattern As DockPattern = GetDockPattern(dockControl)
If dockPattern Is Nothing Then
Return
End If
dockPattern.SetDockPosition(dockPosition)
Catch exc As InvalidOperationException
' When a control is not able to dock.
' TO DO: error handling
End Try
End Sub
Remarks
A docking container is a control that allows the arrangement of child elements, both horizontally and vertically, relative to the boundaries of the docking container and other elements within the container.
Applies to
.NET
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示