Method SetConditionalFormat

styles.go:2813–2878

SetConditionalFormat provides a function to create conditional formatting rule for cell value. Conditional formatting is a feature of Excel which allows you to apply a format to a cell or a range of cells based on certain criteria. The type option is a required parameter and it has no default value

(sheet, rangeRef string, opts []ConditionalFormatOptions)

// cells. When this parameter is set then subsequent rules are not evaluated
// if the current rule is true.
func (f *File) SetConditionalFormat(sheet, rangeRef string, opts []ConditionalFormatOptions) error {
	ws, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}
	SQRef, mastCell, err := prepareConditionalFormatRange(rangeRef)
	if err != nil {
		return err
	}
	// Create a pseudo GUID for each unique rule.
	var rules int
	for _, cf := range ws.ConditionalFormatting {
		rules += len(cf.CfRule)
	}
	var (
		cfRule          []*xlsxCfRule
		noCriteriaTypes = []string{
			"containsBlanks",
			"notContainsBlanks",
			"containsErrors",
			"notContainsErrors",
			"expression",
			"iconSet",
		}
	)
	for i, opt := range opts {
		var vt, ct string
		var ok bool
		// "type" is a required parameter, check for valid validation types.
		vt, ok = validType[opt.Type]
		if ok {
			// Check for valid criteria types.
			ct, ok = criteriaType[opt.Criteria]
			if ok || inStrSlice(noCriteriaTypes, vt, true) != -1 {
				drawFunc, ok := drawContFmtFunc[vt]
				if ok {
					priority := rules + i
					rule, x14rule := drawFunc(priority, ct, mastCell,
						fmt.Sprintf("{00000000-0000-0000-%04X-%012X}", f.getSheetID(sheet), priority), &opt)
					if rule == nil && x14rule == nil {
						return ErrParameterInvalid
					}
					if rule != nil {
						cfRule = append(cfRule, rule)
					}
					if x14rule != nil {
						if err = f.appendCfRule(ws, x14rule, SQRef); err != nil {
							return err
						}
						f.addSheetNameSpace(sheet, NameSpaceSpreadSheetX14)
					}
					continue
				}
			}
			return ErrParameterInvalid
		}
		return ErrParameterInvalid
	}