/* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for Additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * ==================================================================== */ namespace HH.WMS.Utils.NPOI.SS.UserModel { using System; using HH.WMS.Utils.NPOI.HSSF.Record.CF; public enum ConditionType : byte { /// /// Allow accessing the Initial value. /// None = 0, /** * This conditional formatting rule Compares a cell value * to a formula calculated result, using an operator */ CELL_VALUE_IS = 1, /** * This conditional formatting rule Contains a formula to Evaluate. * When the formula result is true, the cell is highlighted. */ FORMULA = 2 } /** * Represents a description of a conditional formatting rule * * @author Dmitriy Kumshayev * @author Yegor Kozlov */ public interface IConditionalFormattingRule { /** * Create a new border formatting structure if it does not exist, * otherwise just return existing object. * * @return - border formatting object, never returns null. */ IBorderFormatting CreateBorderFormatting(); /** * @return - border formatting object if defined, null otherwise */ IBorderFormatting GetBorderFormatting(); /** * Create a new font formatting structure if it does not exist, * otherwise just return existing object. * * @return - font formatting object, never returns null. */ IFontFormatting CreateFontFormatting(); /** * @return - font formatting object if defined, null otherwise */ IFontFormatting GetFontFormatting(); /** * Create a new pattern formatting structure if it does not exist, * otherwise just return existing object. * * @return - pattern formatting object, never returns null. */ IPatternFormatting CreatePatternFormatting(); /** * @return - pattern formatting object if defined, null otherwise */ IPatternFormatting GetPatternFormatting(); /** * Type of conditional formatting rule. *

* MUST be either {@link #CONDITION_TYPE_CELL_VALUE_IS} or {@link #CONDITION_TYPE_FORMULA} *

* * @return the type of condition */ ConditionType ConditionType { get; } /** * The comparison function used when the type of conditional formatting is Set to * {@link #CONDITION_TYPE_CELL_VALUE_IS} *

* MUST be a constant from {@link ComparisonOperator} *

* * @return the conditional format operator */ ComparisonOperator ComparisonOperation { get; } /** * The formula used to Evaluate the first operand for the conditional formatting rule. *

* If the condition type is {@link #CONDITION_TYPE_CELL_VALUE_IS}, * this field is the first operand of the comparison. * If type is {@link #CONDITION_TYPE_FORMULA}, this formula is used * to determine if the conditional formatting is applied. *

*

* If comparison type is {@link #CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function *

* * @return the first formula */ String Formula1 { get; } /** * The formula used to Evaluate the second operand of the comparison when * comparison type is {@link #CONDITION_TYPE_CELL_VALUE_IS} and operator * is either {@link ComparisonOperator#BETWEEN} or {@link ComparisonOperator#NOT_BETWEEN} * * @return the second formula */ String Formula2 { get; } } }