Share via


GridLayout.LayoutParams Class

Definition

Layout information associated with each of the children of a GridLayout.

[Android.Runtime.Register("android/widget/GridLayout$LayoutParams", DoNotGenerateAcw=true)]
public class GridLayout.LayoutParams : Android.Views.ViewGroup.MarginLayoutParams
[<Android.Runtime.Register("android/widget/GridLayout$LayoutParams", DoNotGenerateAcw=true)>]
type GridLayout.LayoutParams = class
    inherit ViewGroup.MarginLayoutParams
Inheritance
Attributes

Remarks

Layout information associated with each of the children of a GridLayout.

GridLayout supports both row and column spanning and arbitrary forms of alignment within each cell group. The fundamental parameters associated with each cell group are gathered into their vertical and horizontal components and stored in the #rowSpec and #columnSpec layout parameters. GridLayout.Spec Specs are immutable structures and may be shared between the layout parameters of different children.

The row and column specs contain the leading and trailing indices along each axis and together specify the four grid indices that delimit the cells of this cell group.

The alignment properties of the row and column specs together specify both aspects of alignment within the cell group. It is also possible to specify a child's alignment within its cell group by using the GridLayout.LayoutParams#setGravity(int) method.

The weight property is also included in Spec and specifies the proportion of any excess space that is due to the associated view.

<h4>WRAP_CONTENT and MATCH_PARENT</h4>

Because the default values of the #width and #height properties are both #WRAP_CONTENT, this value never needs to be explicitly declared in the layout parameters of GridLayout's children. In addition, GridLayout does not distinguish the special size value #MATCH_PARENT from #WRAP_CONTENT. A component's ability to expand to the size of the parent is instead controlled by the principle of <em>flexibility</em>, as discussed in GridLayout.

<h4>Summary</h4>

You should not need to use either of the special size values: WRAP_CONTENT or MATCH_PARENT when configuring the children of a GridLayout.

<h4>Default values</h4>

<ul> <li>#width = #WRAP_CONTENT</li> <li>#height = #WRAP_CONTENT</li> <li>#topMargin = 0 when GridLayout#setUseDefaultMargins(boolean) useDefaultMargins is false; otherwise #UNDEFINED, to indicate that a default value should be computed on demand. </li> <li>#leftMargin = 0 when GridLayout#setUseDefaultMargins(boolean) useDefaultMargins is false; otherwise #UNDEFINED, to indicate that a default value should be computed on demand. </li> <li>#bottomMargin = 0 when GridLayout#setUseDefaultMargins(boolean) useDefaultMargins is false; otherwise #UNDEFINED, to indicate that a default value should be computed on demand. </li> <li>#rightMargin = 0 when GridLayout#setUseDefaultMargins(boolean) useDefaultMargins is false; otherwise #UNDEFINED, to indicate that a default value should be computed on demand. </li> <li>#rowSpec.row = #UNDEFINED</li> <li>#rowSpec.rowSpan = 1 </li> <li>#rowSpec.alignment = #BASELINE</li> <li>#rowSpec.weight = 0 </li> <li>#columnSpec.column = #UNDEFINED</li> <li>#columnSpec.columnSpan = 1 </li> <li>#columnSpec.alignment = #START</li> <li>#columnSpec.weight = 0 </li> </ul>

See GridLayout for a more complete description of the conventions used by GridLayout in the interpretation of the properties of this class.

Java documentation for android.widget.GridLayout.LayoutParams.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

GridLayout.LayoutParams()

Constructs a new LayoutParams with default values as defined in LayoutParams.

GridLayout.LayoutParams(Context, IAttributeSet)

To be added

        Values not defined in the attribute set take the default values
        defined in <code data-dev-comment-type="c">LayoutParams</code>.
GridLayout.LayoutParams(GridLayout+LayoutParams)
GridLayout.LayoutParams(GridLayout+Spec, GridLayout+Spec)

Constructs a new LayoutParams instance for this rowSpec and columnSpec.

GridLayout.LayoutParams(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

GridLayout.LayoutParams(ViewGroup+LayoutParams)
GridLayout.LayoutParams(ViewGroup+MarginLayoutParams)

Fields

FillParent
Obsolete.

Special value for the height or width requested by a View.

(Inherited from ViewGroup.LayoutParams)
MatchParent

Special value for the height or width requested by a View.

(Inherited from ViewGroup.LayoutParams)
WrapContent

Special value for the height or width requested by a View.

(Inherited from ViewGroup.LayoutParams)

Properties

BottomMargin

The bottom margin in pixels of the child.

(Inherited from ViewGroup.MarginLayoutParams)
Class

Returns the runtime class of this Object.

(Inherited from Object)
ColumnSpec

The spec that defines the horizontal characteristics of the cell group described by these layout parameters.

Handle

The handle to the underlying Android instance.

(Inherited from Object)
Height

Information about how tall the view wants to be.

(Inherited from ViewGroup.LayoutParams)
IsMarginRelative

Check if margins are relative.

(Inherited from ViewGroup.MarginLayoutParams)
JniIdentityHashCode (Inherited from Object)
JniPeerMembers
LayoutAnimationParameters

Used to animate layouts.

(Inherited from ViewGroup.LayoutParams)
LayoutDirection

Retuns the layout direction. -or- Set the layout direction

(Inherited from ViewGroup.MarginLayoutParams)
LeftMargin

The left margin in pixels of the child.

(Inherited from ViewGroup.MarginLayoutParams)
MarginEnd

Returns the end margin in pixels. -or- Sets the relative end margin.

(Inherited from ViewGroup.MarginLayoutParams)
MarginStart

Returns the start margin in pixels. -or- Sets the relative start margin.

(Inherited from ViewGroup.MarginLayoutParams)
PeerReference (Inherited from Object)
RightMargin

The right margin in pixels of the child.

(Inherited from ViewGroup.MarginLayoutParams)
RowSpec

The spec that defines the vertical characteristics of the cell group described by these layout parameters.

ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

TopMargin

The top margin in pixels of the child.

(Inherited from ViewGroup.MarginLayoutParams)
Width

Information about how wide the view wants to be.

(Inherited from ViewGroup.LayoutParams)

Methods

Clone()

Creates and returns a copy of this object.

(Inherited from Object)
Dispose() (Inherited from Object)
Dispose(Boolean) (Inherited from Object)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
JavaFinalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
ResolveLayoutDirection(LayoutDirection)

Resolve layout parameters depending on the layout direction.

(Inherited from ViewGroup.LayoutParams)
SetBaseAttributes(TypedArray, Int32, Int32)

Extracts the layout parameters from the supplied attributes.

(Inherited from ViewGroup.LayoutParams)
SetGravity(GravityFlags)

Describes how the child views are positioned.

SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
SetMargins(Int32, Int32, Int32, Int32)

Sets the margins, in pixels.

(Inherited from ViewGroup.MarginLayoutParams)
ToArray<T>() (Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime() (Inherited from Object)
Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed() (Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced() (Inherited from Object)
IJavaPeerable.Finalized() (Inherited from Object)
IJavaPeerable.JniManagedPeerState (Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32) (Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) (Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference) (Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to