RibbonGroupSizeDefinition Class

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Specifies information about the size of controls in a RibbonGroup and the visual state of the group.

Namespace: System.Windows.Controls.Ribbon
Assembly: System.Windows.Controls.Ribbon (in System.Windows.Controls.Ribbon.dll)

Inheritance Hierarchy

System.Object
System.Windows.Threading.DispatcherObject
System.Windows.DependencyObject
System.Windows.Freezable
System.Windows.Controls.Ribbon.RibbonGroupSizeDefinitionBase
System.Windows.Controls.Ribbon.RibbonGroupSizeDefinition

Syntax

C++

[ContentPropertyAttribute("ControlSizeDefinitions")]
public class RibbonGroupSizeDefinition : RibbonGroupSizeDefinitionBase

Constructors

	Name	Description
	RibbonGroupSizeDefinition()	Initializes a new instance of the RibbonGroupSizeDefinition class.

Properties

	Name	Description
	CanFreeze	Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
	ControlSizeDefinitions	Gets or sets a collection of RibbonControlSizeDefinition items that specify the size of controls in the group.
	DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)
	Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
	IsCollapsed	Gets or sets a value that indicates whether the control group is collapsed.(Inherited from RibbonGroupSizeDefinitionBase.)
	IsFrozen	Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
	IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.)

Methods

	Name	Description
	CheckAccess()	Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)
	ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
	ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
	Clone()	Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values. (Inherited from Freezable.)
	CloneCore(Freezable)	Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. (Inherited from Freezable.)
	CloneCurrentValue()	Creates a modifiable clone (deep copy) of the Freezable using its current values.(Inherited from Freezable.)
	CloneCurrentValueCore(Freezable)	Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values.(Inherited from Freezable.)
	CoerceValue(DependencyProperty)	Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.(Inherited from DependencyObject.)
	CreateInstance()	Initializes a new instance of the Freezable class. (Inherited from Freezable.)
	CreateInstanceCore()	Creates a new instance of the RibbonGroupSizeDefinition class.(Overrides Freezable.CreateInstanceCore().)
	Equals(Object)	Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	Freeze()	Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
	FreezeCore(Boolean)	Makes the Freezable object unmodifiable or tests whether it can be made unmodifiable.(Inherited from Freezable.)
	GetAsFrozen()	Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
	GetAsFrozenCore(Freezable)	Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values.(Inherited from Freezable.)
	GetCurrentValueAsFrozen()	Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.(Inherited from Freezable.)
	GetCurrentValueAsFrozenCore(Freezable)	Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied.(Inherited from Freezable.)
	GetHashCode()	Gets a hash code for this DependencyObject.(Inherited from DependencyObject.)
	GetLocalValueEnumerator()	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	GetValue(DependencyProperty)	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
	InvalidateProperty(DependencyProperty)	Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	OnChanged()	Called when the current Freezable object is modified. (Inherited from Freezable.)
	OnFreezablePropertyChanged(DependencyObject, DependencyObject)	Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set.(Inherited from Freezable.)
	OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)	This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.(Inherited from Freezable.)
	OnPropertyChanged(DependencyPropertyChangedEventArgs)	Overrides the DependencyObject implementation of OnPropertyChanged to also invoke any Changed handlers in response to a changing dependency property of type Freezable.(Inherited from Freezable.)
	ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
	ReadPreamble()	Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties.(Inherited from Freezable.)
	SetCurrentValue(DependencyProperty, Object)	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
	SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
	SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
	ShouldSerializeProperty(DependencyProperty)	Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	VerifyAccess()	Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)
	WritePostscript()	Raises the Changed event for the Freezable and invokes its OnChanged method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties.(Inherited from Freezable.)
	WritePreamble()	Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable.)

Fields

	Name	Description
	ControlSizeDefinitionsProperty	Identifies the ControlSizeDefinitions dependency property.

Events

	Name	Description
	Changed	Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)

Examples

The following example shows a GroupSizeDefinitions collection that specifies three different group sizes.

<ribbon:RibbonGroup.GroupSizeDefinitions>
  <ribbon:RibbonGroupSizeDefinition>
    <ribbon:RibbonControlSizeDefinition ImageSize="Large" IsLabelVisible="True" />
    <ribbon:RibbonControlSizeDefinition ImageSize="Small" IsLabelVisible="True" />
    <ribbon:RibbonControlSizeDefinition ImageSize="Small" IsLabelVisible="True" />
  </ribbon:RibbonGroupSizeDefinition>
  <ribbon:RibbonGroupSizeDefinition>
    <ribbon:RibbonControlSizeDefinition ImageSize="Large" IsLabelVisible="True" />
    <ribbon:RibbonControlSizeDefinition ImageSize="Small" IsLabelVisible="False" />
    <ribbon:RibbonControlSizeDefinition ImageSize="Small" IsLabelVisible="False" />
  </ribbon:RibbonGroupSizeDefinition>
  <ribbon:RibbonGroupSizeDefinition IsCollapsed="True" />
</ribbon:RibbonGroup.GroupSizeDefinitions>

Version Information

.NET Framework
Available since 4.5

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.