Class HeaderFoldout

UITK component to display header styled foldout

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
BindableElement
Foldout
HeaderFoldout
HeaderToggleFoldout
Implements
IEventHandler
IResolvedStyle
ITransform
ITransitionAnimations
IExperimentalFeatures
IVisualElementScheduler
IBindable
INotifyValueChanged<bool>
Inherited Members
Foldout.ussClassName
Foldout.toggleUssClassName
Foldout.contentUssClassName
Foldout.inputUssClassName
Foldout.checkmarkUssClassName
Foldout.textUssClassName
Foldout.contentContainer
Foldout.focusable
Foldout.toggleOnLabelClick
Foldout.value
BindableElement.binding
BindableElement.bindingPath
VisualElement.disabledUssClassName
VisualElement.Focus()
VisualElement.SendEvent(EventBase)
VisualElement.MarkDirtyRepaint()
VisualElement.IsMarkedForRepaint()
VisualElement.ContainsPoint(Vector2)
VisualElement.Overlaps(Rect)
VisualElement.ToString()
VisualElement.GetClasses()
VisualElement.ClearClassList()
VisualElement.FindAncestorUserData()
VisualElement.SetBinding(BindingId, Binding)
VisualElement.GetBinding(BindingId)
VisualElement.TryGetBinding(BindingId, out Binding)
VisualElement.GetBindingInfos()
VisualElement.HasBinding(BindingId)
VisualElement.ClearBinding(BindingId)
VisualElement.ClearBindings()
VisualElement.GetHierarchicalDataSourceContext()
VisualElement.GetDataSourceContext(BindingId)
VisualElement.TryGetDataSourceContext(BindingId, out DataSourceContext)
VisualElement.TryGetLastBindingToUIResult(in BindingId, out BindingResult)
VisualElement.TryGetLastBindingToSourceResult(in BindingId, out BindingResult)
VisualElement.Add(VisualElement)
VisualElement.Remove(VisualElement)
VisualElement.Clear()
VisualElement.IndexOf(VisualElement)
VisualElement.Children()
VisualElement.BringToFront()
VisualElement.SendToBack()
VisualElement.PlaceBehind(VisualElement)
VisualElement.PlaceInFront(VisualElement)
VisualElement.RemoveFromHierarchy()
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.Contains(VisualElement)
VisualElement.FindCommonAncestor(VisualElement)
VisualElement.viewDataKey
VisualElement.userData
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.disablePlayModeTint
VisualElement.usageHints
VisualElement.transform
VisualElement.scaledPixelsPerPoint
VisualElement.layout
VisualElement.contentRect
VisualElement.paddingRect
VisualElement.worldBound
VisualElement.localBound
VisualElement.worldTransform
VisualElement.hasActivePseudoState
VisualElement.hasInactivePseudoState
VisualElement.hasHoverPseudoState
VisualElement.hasCheckedPseudoState
VisualElement.hasEnabledPseudoState
VisualElement.hasDisabledPseudoState
VisualElement.hasFocusPseudoState
VisualElement.hasRootPseudoState
VisualElement.pickingMode
VisualElement.name
VisualElement.enabledInHierarchy
VisualElement.enabledSelf
VisualElement.languageDirection
VisualElement.visible
VisualElement.generateVisualContent
VisualElement.dataSource
VisualElement.dataSourcePath
VisualElement.dataSourceType
VisualElement.experimental
VisualElement.hierarchy
VisualElement.cacheAsBitmap
VisualElement.parent
VisualElement.panel
VisualElement.visualTreeAssetSource
VisualElement.childCount
VisualElement.schedule
VisualElement.style
VisualElement.resolvedStyle
VisualElement.customStyle
VisualElement.styleSheets
VisualElement.tooltip
Focusable.Blur()
Focusable.tabIndex
Focusable.delegatesFocus
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallbackOnce<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.RegisterCallbackOnce<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
CallbackEventHandler.HasTrickleDownHandlers()
CallbackEventHandler.HasBubbleUpHandlers()
CallbackEventHandler.ExecuteDefaultActionAtTarget(EventBase)
CallbackEventHandler.HandleEventBubbleUp(EventBase)
CallbackEventHandler.HandleEventTrickleDown(EventBase)
CallbackEventHandler.ExecuteDefaultAction(EventBase)
CallbackEventHandler.NotifyPropertyChanged(in BindingId)
Namespace: UnityEditor.Rendering
Assembly: Unity.RenderPipelines.Core.Editor.dll
Syntax
[UxmlElement]
public class HeaderFoldout : Foldout, IEventHandler, IResolvedStyle, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IBindable, INotifyValueChanged<bool>

Constructors

HeaderFoldout()

Constructor

Declaration
public HeaderFoldout()

Properties

contextMenuGenerator

Context menu to show on click of the context button. If null, button don't show.

Declaration
public Func<GenericMenu> contextMenuGenerator { get; set; }
Property Value
Type Description
Func<GenericMenu>

documentationURL

URL to use on documentation icon. If null, button don't show.

Declaration
public string documentationURL { get; set; }
Property Value
Type Description
string

enableToggle

Quick access to the enable toggle if one need to register events

Declaration
public Toggle enableToggle { get; }
Property Value
Type Description
Toggle

enabled

Property to get the enablement state

Declaration
public bool enabled { get; set; }
Property Value
Type Description
bool

icon

Optional icon image. If not set, no icon is shown.

Declaration
public Texture2D icon { get; set; }
Property Value
Type Description
Texture2D

showEnableCheckbox

Property to get the enablement visibility state

Declaration
public bool showEnableCheckbox { get; set; }
Property Value
Type Description
bool

text

Property to get the title

Declaration
public string text { get; set; }
Property Value
Type Description
string

Implements

UnityEngine.UIElements.IEventHandler
UnityEngine.UIElements.IResolvedStyle
UnityEngine.UIElements.ITransform
UnityEngine.UIElements.Experimental.ITransitionAnimations
UnityEngine.UIElements.IExperimentalFeatures
UnityEngine.UIElements.IVisualElementScheduler
UnityEngine.UIElements.IBindable
UnityEngine.UIElements.INotifyValueChanged<T>

Extension Methods