/* ==================================================================== 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.SS.Util; /** * Error style constants for error box */ public static class ERRORSTYLE { /** STOP style */ public const int STOP = 0x00; /** WARNING style */ public const int WARNING = 0x01; /** INFO style */ public const int INFO = 0x02; } public interface IDataValidation { IDataValidationConstraint ValidationConstraint { get; } /// /// get or set the error style for error box /// int ErrorStyle { get; set; } /// /// Setting this allows an empty object as a valid value. Retrieve the settings for empty cells allowed. /// @return True if this object should treats empty as valid value , false otherwise /// /// true if this object should treats empty as valid value, false otherwise bool EmptyCellAllowed { get; set; } /// /// Useful for list validation objects . /// Useful only list validation objects . This method always returns false if the object isn't a list validation object /// bool SuppressDropDownArrow { get; set; } /* * Useful for list validation objects . * * @param suppress * True if a list should display the values into a drop down list , * false otherwise . In other words , if a list should display * the arrow sign on its right side */ //void SetSuppressDropDownArrow(bool suppress); /* * Useful only list validation objects . This method always returns false if * the object isn't a list validation object * * @return true if a list should display the values into a drop down list , * false otherwise . */ //bool GetSuppressDropDownArrow(); /** * Sets the behaviour when a cell which belongs to this object is selected * * true if an prompt box should be displayed , false otherwise */ bool ShowPromptBox { get; set; } //void SetShowPromptBox(bool Show); /* * @return true if an prompt box should be displayed , false otherwise */ //bool GetShowPromptBox(); /** * Sets the behaviour when an invalid value is entered * * true if an error box should be displayed , false otherwise */ bool ShowErrorBox { get; set; } //void SetShowErrorBox(bool Show); /* * @return true if an error box should be displayed , false otherwise */ //bool GetShowErrorBox(); /** * Sets the title and text for the prompt box . Prompt box is displayed when * the user selects a cell which belongs to this validation object . In * order for a prompt box to be displayed you should also use method * SetShowPromptBox( bool show ) * * @param title The prompt box's title * @param text The prompt box's text */ void CreatePromptBox(String title, String text); /** * @return Prompt box's title or null */ String PromptBoxTitle { get; } /** * @return Prompt box's text or null */ String PromptBoxText { get; } /** * Sets the title and text for the error box . Error box is displayed when * the user enters an invalid value int o a cell which belongs to this * validation object . In order for an error box to be displayed you should * also use method SetShowErrorBox( bool show ) * * @param title The error box's title * @param text The error box's text */ void CreateErrorBox(String title, String text); /** * @return Error box's title or null */ String ErrorBoxTitle { get; } /** * @return Error box's text or null */ String ErrorBoxText { get; } CellRangeAddressList Regions { get; } } }