| File: System\Windows\Trigger.cs | Web Access |
| Project: src\wpf\src\Microsoft.DotNet.Wpf\src\PresentationFramework\PresentationFramework.csproj (PresentationFramework) |
// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. using System.Collections.Specialized; using System.ComponentModel; using System.Windows.Markup; using System.Globalization; namespace System.Windows { /// <summary> /// A single Style property conditional dependency driver /// </summary> [ContentProperty("Setters")] [XamlSetTypeConverterAttribute("ReceiveTypeConverter")] public class Trigger : TriggerBase, IAddChild, ISupportInitialize { /// <summary> /// DependencyProperty of the conditional /// </summary> [Ambient] [Localizability(LocalizationCategory.None, Modifiability = Modifiability.Unmodifiable, Readability = Readability.Unreadable)] // Not localizable by-default public DependencyProperty Property { get { // Verify Context Access VerifyAccess(); return _property; } set { // Verify Context Access VerifyAccess(); if (IsSealed) { throw new InvalidOperationException(SR.Format(SR.CannotChangeAfterSealed, "Trigger")); } _property = value; } } /// <summary> /// Value of the condition (equality check) /// </summary> [DependsOn("Property")] [DependsOn("SourceName")] [Localizability(LocalizationCategory.None, Readability = Readability.Unreadable)] // Not localizable by-default [TypeConverter(typeof(SetterTriggerConditionValueConverter))] public object Value { get { // Verify Context Access VerifyAccess(); return _value; } set { // Verify Context Access VerifyAccess(); if (IsSealed) { throw new InvalidOperationException(SR.Format(SR.CannotChangeAfterSealed, "Trigger")); } if (value is NullExtension) { value = null; } if (value is MarkupExtension) { throw new ArgumentException(SR.Format(SR.ConditionValueOfMarkupExtensionNotSupported, value.GetType().Name)); } if (value is Expression) { throw new ArgumentException(SR.ConditionValueOfExpressionNotSupported); } _value = value; } } /// <summary> /// The x:Name of the object whose property shall /// trigger the associated setters to be applied. /// If null, then this is the object being Styled /// and not anything under its Template Tree. /// </summary> [DefaultValue(null)] [Ambient] public string SourceName { get { // Verify Context Access VerifyAccess(); return _sourceName; } set { // Verify Context Access VerifyAccess(); if( IsSealed ) { throw new InvalidOperationException(SR.Format(SR.CannotChangeAfterSealed, "Trigger")); } _sourceName = value; } } /// <summary> /// Collection of Setter objects, which describes what to apply /// when this trigger is active. /// </summary> [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)] public SetterBaseCollection Setters { get { // Verify Context Access VerifyAccess(); if( _setters == null ) { _setters = new SetterBaseCollection(); } return _setters; } } ///<summary> /// This method is called to Add a Setter object as a child of the Style. ///</summary> ///<param name="value"> /// The object to add as a child; it must be a Setter or subclass. ///</param> void IAddChild.AddChild (Object value) { // Verify Context Access VerifyAccess(); Setters.Add(Trigger.CheckChildIsSetter(value)); } ///<summary> /// This method is called by the parser when text appears under the tag in markup. /// As default Styles do not support text, calling this method has no effect. ///</summary> ///<param name="text"> /// Text to add as a child. ///</param> void IAddChild.AddText (string text) { // Verify Context Access VerifyAccess(); XamlSerializerUtil.ThrowIfNonWhiteSpaceInAddText(text, this); } // Shared by PropertyTrigger, MultiPropertyTrigger, DataTrigger, MultiDataTrigger internal static Setter CheckChildIsSetter( object o ) { ArgumentNullException.ThrowIfNull(o); Setter setter = o as Setter; if (setter == null) { throw new ArgumentException(SR.Format(SR.UnexpectedParameterType, o.GetType(), typeof(Setter)), nameof(o)); } return setter; } internal sealed override void Seal() { if (IsSealed) { return; } if (_property != null) { // Ensure valid condition if (!_property.IsValidValue(_value)) { throw new InvalidOperationException(SR.Format(SR.InvalidPropertyValue, _value, _property.Name )); } } // Freeze the condition for the trigger StyleHelper.SealIfSealable(_value); // Process the _setters collection: Copy values into PropertyValueList and seal the Setter objects. ProcessSettersCollection(_setters); // Build conditions array from collection TriggerConditions = new TriggerCondition[] { new TriggerCondition( _property, LogicalOp.Equals, _value, _sourceName ?? StyleHelper.SelfName) }; // Set Condition for all property triggers for (int i = 0; i < PropertyValues.Count; i++) { PropertyValue propertyValue = PropertyValues[i]; propertyValue.Conditions = TriggerConditions; // Put back modified struct PropertyValues[i] = propertyValue; } base.Seal(); } // evaluate the current state of the trigger internal override bool GetCurrentState(DependencyObject container, UncommonField<HybridDictionary[]> dataField) { Debug.Assert( TriggerConditions != null && TriggerConditions.Length == 1, "This method assumes there is exactly one TriggerCondition." ); Debug.Assert( TriggerConditions[0].SourceChildIndex == 0, "This method was created to handle properties on the containing object, more work is needed to handle templated children too." ); return TriggerConditions[0].Match(container.GetValue(TriggerConditions[0].Property)); } #region ISupportInitialize Members void ISupportInitialize.BeginInit() { } void ISupportInitialize.EndInit() { // Resolve all properties here if (_unresolvedProperty != null) { try { Property = DependencyPropertyConverter.ResolveProperty(_serviceProvider, SourceName, _unresolvedProperty); } finally { _unresolvedProperty = null; } } if (_unresolvedValue != null) { try { Value = SetterTriggerConditionValueConverter.ResolveValue(_serviceProvider, Property, _cultureInfoForTypeConverter, _unresolvedValue); } finally { _unresolvedValue = null; } } _serviceProvider = null; _cultureInfoForTypeConverter = null; } #endregion public static void ReceiveTypeConverter(object targetObject, XamlSetTypeConverterEventArgs eventArgs) { Trigger trigger = targetObject as Trigger; if (trigger == null) { throw new ArgumentNullException(nameof(targetObject)); } ArgumentNullException.ThrowIfNull(eventArgs); if (eventArgs.Member.Name == "Property") { trigger._unresolvedProperty = eventArgs.Value; trigger._serviceProvider = eventArgs.ServiceProvider; trigger._cultureInfoForTypeConverter = eventArgs.CultureInfo; eventArgs.Handled = true; } else if (eventArgs.Member.Name == "Value") { trigger._unresolvedValue = eventArgs.Value; trigger._serviceProvider = eventArgs.ServiceProvider; trigger._cultureInfoForTypeConverter = eventArgs.CultureInfo; eventArgs.Handled = true; } } private DependencyProperty _property; private object _value = DependencyProperty.UnsetValue; private string _sourceName = null; private SetterBaseCollection _setters = null; private object _unresolvedProperty = null; private object _unresolvedValue = null; private ITypeDescriptorContext _serviceProvider = null; private CultureInfo _cultureInfoForTypeConverter = null; } }