ExcelScript.ConditionalFormat interface

  • Referenz
Paket:
ExcelScript

Ein Objekt, das den Bereich, das Format, die Regel und andere Eigenschaften eines bedingten Formats kapselt.

Methoden

delete()

Löscht dieses bedingte Format.
getCellValue()

Gibt die Eigenschaften des bedingten Formats des Zellwerts zurück, wenn das aktuelle bedingte Format ein CellValue Typ ist.
getColorScale()

Gibt die Eigenschaften des bedingten Formats der Farbskala zurück, wenn das aktuelle bedingte Format ein ColorScale Typ ist.
getCustom()

Gibt die eigenschaften des benutzerdefinierten bedingten Formats zurück, wenn das aktuelle bedingte Format ein benutzerdefinierter Typ ist.
getDataBar()

Gibt die Datenbalkeneigenschaften zurück, wenn das aktuelle bedingte Format ein Datenbalken ist.
getIconSet()

Gibt die Eigenschaften des bedingten Formats zurück, wenn das aktuelle bedingte Format ein IconSet Typ ist.
getId()

Die Priorität des bedingten Formats im aktuellen ConditionalFormatCollection.
getPreset()

Gibt das bedingte Format der voreingestellten Kriterien zurück. Weitere Details finden Sie unter ExcelScript.PresetCriteriaConditionalFormat.
getPriority()

Die Priorität (oder der Index) in der Auflistung des bedingten Formats, in der dieses bedingte Format derzeit vorhanden ist. Wenn Sie dies ändern, ändern sich auch die Prioritäten anderer bedingter Formate, um eine zusammenhängende Prioritätsreihenfolge zu ermöglichen. Verwenden Sie eine negative Priorität, um von hinten zu beginnen. Prioritäten, die größer als die Begrenzungen sind, werden auf die maximale (oder minimale, wenn negative) Priorität festgelegt. Beachten Sie außerdem, dass Sie beim Ändern der Priorität eine neue Kopie des Objekts an dieser neuen Prioritätsposition abrufen müssen, wenn Sie weitere Änderungen daran vornehmen möchten.
getRange()

Gibt den Bereich zurück, auf den das bedingte Format angewendet wird. Wenn das bedingte Format auf mehrere Bereiche angewendet wird, gibt diese Methode zurück undefined.
getRanges()

Gibt den zurück, der RangeAreaseinen oder mehrere rechteckige Bereiche umfasst, auf die das bedingte Format angewendet wird.
getStopIfTrue()

Wenn die Bedingungen dieses bedingten Formats erfüllt sind, werden keine Formate niedrigerer Priorität für diese Zelle wirksam. Der Wert ergibt sich null aus Datenbalken, Symbolsätzen und Farbskalen, da es für diese kein Konzept von StopIfTrue gibt.
getTextComparison()

Gibt die spezifischen Eigenschaften des bedingten Textformats zurück, wenn das aktuelle bedingte Format ein Texttyp ist. Beispielsweise, um Zellen zu formatieren, die dem Wort "Text" entsprechen.
getTopBottom()

Gibt die Eigenschaften des oberen/unteren bedingten Formats zurück, wenn das aktuelle bedingte Format ein TopBottom Typ ist. Beispielsweise, um die obersten 10 % oder die unteren 10 Elemente zu formatieren.
getType()

Ein Typ des bedingten Formats. Es kann jeweils nur eine festgelegt werden.
setPriority(priority)

Die Priorität (oder der Index) in der Auflistung des bedingten Formats, in der dieses bedingte Format derzeit vorhanden ist. Wenn Sie dies ändern, ändern sich auch die Prioritäten anderer bedingter Formate, um eine zusammenhängende Prioritätsreihenfolge zu ermöglichen. Verwenden Sie eine negative Priorität, um von hinten zu beginnen. Prioritäten, die größer als die Begrenzungen sind, werden auf die maximale (oder minimale, wenn negative) Priorität festgelegt. Beachten Sie außerdem, dass Sie beim Ändern der Priorität eine neue Kopie des Objekts an dieser neuen Prioritätsposition abrufen müssen, wenn Sie weitere Änderungen daran vornehmen möchten.
setStopIfTrue(stopIfTrue)

Wenn die Bedingungen dieses bedingten Formats erfüllt sind, werden keine Formate niedrigerer Priorität für diese Zelle wirksam. Der Wert ergibt sich null aus Datenbalken, Symbolsätzen und Farbskalen, da es für diese kein Konzept von StopIfTrue gibt.

Details zur Methode

delete()

Löscht dieses bedingte Format.

delete(): void;

Gibt zurück

void

getCellValue()

Gibt die Eigenschaften des bedingten Formats des Zellwerts zurück, wenn das aktuelle bedingte Format ein CellValue Typ ist.

getCellValue(): CellValueConditionalFormat | undefined;

Gibt zurück

ExcelScript.CellValueConditionalFormat | undefined

Beispiele

/**
 * This script applies conditional formatting to a range.
 * That formatting is conditional upon the cell's numerical value.
 * Any value between 50 and 75 will have the cell fill color changed and the font made italic.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range to format.
  const sheet = workbook.getActiveWorksheet();
  const ratingColumn = sheet.getRange("D2:D20");

  // Add cell value conditional formatting.
  const cellValueConditionalFormatting =
    ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
  
  // Create the condition, in this case when the cell value is between 50 and 75.
  let rule: ExcelScript.ConditionalCellValueRule = {
    formula1: "50",
    formula2: "75",
    operator: ExcelScript.ConditionalCellValueOperator.between
  };
  cellValueConditionalFormatting.setRule(rule);

  // Set the format to apply when the condition is met.
  let format = cellValueConditionalFormatting.getFormat();
  format.getFill().setColor("yellow");
  format.getFont().setItalic(true);

}

getColorScale()

Gibt die Eigenschaften des bedingten Formats der Farbskala zurück, wenn das aktuelle bedingte Format ein ColorScale Typ ist.

getColorScale(): ColorScaleConditionalFormat | undefined;

Gibt zurück

ExcelScript.ColorScaleConditionalFormat | undefined

Beispiele

/**
 * This script applies a red, white, and blue color scale to the selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  let selectedRange = workbook.getSelectedRange();

  // Create a new conditional formatting object by adding one to the range.
  let conditionalFormatting = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.colorScale);

  // Set the colors for the three parts of the scale: minimum, midpoint, and maximum.
  conditionalFormatting.getColorScale().setCriteria({
    minimum: {
      color:"#F8696B", /* A pale red. */
      type:ExcelScript.ConditionalFormatColorCriterionType.lowestValue
    },
    midpoint: {
      color: "#FCFCFF", /* Slightly off-white. */
      formula:'=50',type:ExcelScript.ConditionalFormatColorCriterionType.percentile
    },
    maximum: {
      color: "#5A8AC6", /* A pale blue. */
      type:ExcelScript.ConditionalFormatColorCriterionType.highestValue
    }
  });
}

getCustom()

Gibt die eigenschaften des benutzerdefinierten bedingten Formats zurück, wenn das aktuelle bedingte Format ein benutzerdefinierter Typ ist.

getCustom(): CustomConditionalFormat | undefined;

Gibt zurück

ExcelScript.CustomConditionalFormat | undefined

Beispiele

/**
 * This script applies a custom conditional formatting to the selected range.
 * A light-green fill is applied to a cell if the value is larger than the value in the row's previous column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected cells.
  let selectedRange = workbook.getSelectedRange();

  // Apply a rule for positive change from the previous column.
  let positiveChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
  positiveChange.getCustom().getFormat().getFill().setColor("lightgreen");
  positiveChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
}

getDataBar()

Gibt die Datenbalkeneigenschaften zurück, wenn das aktuelle bedingte Format ein Datenbalken ist.

getDataBar(): DataBarConditionalFormat | undefined;

Gibt zurück

ExcelScript.DataBarConditionalFormat | undefined

Beispiele

/**
 * This script creates data bar conditional formatting on the selected range.
 * The scale of the data bar goes from 0 to 1000.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  const selected = workbook.getSelectedRange();
  
  // Create new conditional formatting on the range.
  const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
  const dataBarFormat = format.getDataBar();

  // Set the lower bound of the data bar formatting to be 0.
  const lowerBound: ExcelScript.ConditionalDataBarRule = {
    type: ExcelScript.ConditionalFormatRuleType.number,
    formula: "0"
  };
  dataBarFormat.setLowerBoundRule(lowerBound);

  // Set the upper bound of the data bar formatting to be 1000.
  const upperBound: ExcelScript.ConditionalDataBarRule = {
    type: ExcelScript.ConditionalFormatRuleType.number,
    formula: "1000"
  };
  dataBarFormat.setUpperBoundRule(upperBound);
}

getIconSet()

Gibt die Eigenschaften des bedingten Formats zurück, wenn das aktuelle bedingte Format ein IconSet Typ ist.

getIconSet(): IconSetConditionalFormat | undefined;

Gibt zurück

ExcelScript.IconSetConditionalFormat | undefined

Beispiele

/**
 * This script applies icon set conditional formatting to a range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range "A1:A5" on the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const range = sheet.getRange("A1:A5");

  // Create icon set conditional formatting on the range.
  const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);

  // Use the "3 Traffic Lights (Unrimmed)" set.
  conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTrafficLights1);

  // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
  conditionalFormatting.getIconSet().setCriteria([
    {
      formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
      type:ExcelScript.ConditionalFormatIconRuleType.percent
    },
    {
      formula:'=33',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
      type:ExcelScript.ConditionalFormatIconRuleType.percent},
    {
      formula:'=67',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
      type:ExcelScript.ConditionalFormatIconRuleType.percent
    }]);
}

getId()

Die Priorität des bedingten Formats im aktuellen ConditionalFormatCollection.

getId(): string;

Gibt zurück

string

getPreset()

Gibt das bedingte Format der voreingestellten Kriterien zurück. Weitere Details finden Sie unter ExcelScript.PresetCriteriaConditionalFormat.

getPreset(): PresetCriteriaConditionalFormat | undefined;

Gibt zurück

ExcelScript.PresetCriteriaConditionalFormat | undefined

Beispiele

/**
 * This script applies a conditional format that uses a preset criterion.
 * Any cell in row 1 will have the color fill set to green if it is a duplicate value
 * (of anything else in row 1).
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range for row 1.
  const sheet = workbook.getActiveWorksheet();
  const formattedRange = sheet.getRange("1:1");

  // Add new conditional formatting to that range.
  const conditionalFormat = formattedRange.addConditionalFormat(
    ExcelScript.ConditionalFormatType.presetCriteria);

  // Set the conditional formatting to apply a green fill.
  const presetFormat = conditionalFormat.getPreset();
  presetFormat.getFormat().getFill().setColor("green");

  // Set a rule to apply the conditional format when values are duplicated in the range.
  const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = {
    criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
  };
  presetFormat.setRule(duplicateRule);
}

getPriority()

Die Priorität (oder der Index) in der Auflistung des bedingten Formats, in der dieses bedingte Format derzeit vorhanden ist. Wenn Sie dies ändern, ändern sich auch die Prioritäten anderer bedingter Formate, um eine zusammenhängende Prioritätsreihenfolge zu ermöglichen. Verwenden Sie eine negative Priorität, um von hinten zu beginnen. Prioritäten, die größer als die Begrenzungen sind, werden auf die maximale (oder minimale, wenn negative) Priorität festgelegt. Beachten Sie außerdem, dass Sie beim Ändern der Priorität eine neue Kopie des Objekts an dieser neuen Prioritätsposition abrufen müssen, wenn Sie weitere Änderungen daran vornehmen möchten.

getPriority(): number;

Gibt zurück

number

getRange()

Gibt den Bereich zurück, auf den das bedingte Format angewendet wird. Wenn das bedingte Format auf mehrere Bereiche angewendet wird, gibt diese Methode zurück undefined.

getRange(): Range;

Gibt zurück

ExcelScript.Range

getRanges()

Gibt den zurück, der RangeAreaseinen oder mehrere rechteckige Bereiche umfasst, auf die das bedingte Format angewendet wird.

getRanges(): RangeAreas;

Gibt zurück

ExcelScript.RangeAreas

getStopIfTrue()

Wenn die Bedingungen dieses bedingten Formats erfüllt sind, werden keine Formate niedrigerer Priorität für diese Zelle wirksam. Der Wert ergibt sich null aus Datenbalken, Symbolsätzen und Farbskalen, da es für diese kein Konzept von StopIfTrue gibt.

getStopIfTrue(): boolean;

Gibt zurück

boolean

getTextComparison()

Gibt die spezifischen Eigenschaften des bedingten Textformats zurück, wenn das aktuelle bedingte Format ein Texttyp ist. Beispielsweise, um Zellen zu formatieren, die dem Wort "Text" entsprechen.

getTextComparison(): TextConditionalFormat | undefined;

Gibt zurück

ExcelScript.TextConditionalFormat | undefined

Beispiele

/**
 * This script adds conditional formatting to the first column in the worksheet.
 * This formatting gives the cells a green fill if they have text starting with "Excel".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first column in the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const firstColumn = currentSheet.getRange("A:A");

  // Add conditional formatting based on the text in the cells.
  const textConditionFormat = 
    firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsText).getTextComparison();

  // Set the conditional format to provide a green fill.
  textConditionFormat.getFormat().getFill().setColor("green");

  // Apply the condition rule that the text begins with "Excel".
  const textRule: ExcelScript.ConditionalTextComparisonRule = {
    operator: ExcelScript.ConditionalTextOperator.beginsWith,
    text: "Excel"
  };
  textConditionFormat.setRule(textRule);
}

getTopBottom()

Gibt die Eigenschaften des oberen/unteren bedingten Formats zurück, wenn das aktuelle bedingte Format ein TopBottom Typ ist. Beispielsweise, um die obersten 10 % oder die unteren 10 Elemente zu formatieren.

getTopBottom(): TopBottomConditionalFormat | undefined;

Gibt zurück

ExcelScript.TopBottomConditionalFormat | undefined

Beispiele

/**
 * This script applies top/bottom conditional formatting to a range.
 * The top 2 values in the range will have the cell fill color changed to green.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range to format.
  const sheet = workbook.getWorksheet("TopBottom");
  const dataRange = sheet.getRange("B2:D5");

  // Set the fill color to green for the top 2 values in the range.
  const topBottomFormat = dataRange.addConditionalFormat(
    ExcelScript.ConditionalFormatType.topBottom).getTopBottom();
  topBottomFormat.getFormat().getFill().setColor("green");
  topBottomFormat.setRule({
    rank: 2, /* The numeric threshold. */
    type: ExcelScript.ConditionalTopBottomCriterionType.topItems /* The type of the top/bottom condition. */
  });
}

getType()

Ein Typ des bedingten Formats. Es kann jeweils nur eine festgelegt werden.

getType(): ConditionalFormatType;

Gibt zurück

ExcelScript.ConditionalFormatType

setPriority(priority)

Die Priorität (oder der Index) in der Auflistung des bedingten Formats, in der dieses bedingte Format derzeit vorhanden ist. Wenn Sie dies ändern, ändern sich auch die Prioritäten anderer bedingter Formate, um eine zusammenhängende Prioritätsreihenfolge zu ermöglichen. Verwenden Sie eine negative Priorität, um von hinten zu beginnen. Prioritäten, die größer als die Begrenzungen sind, werden auf die maximale (oder minimale, wenn negative) Priorität festgelegt. Beachten Sie außerdem, dass Sie beim Ändern der Priorität eine neue Kopie des Objekts an dieser neuen Prioritätsposition abrufen müssen, wenn Sie weitere Änderungen daran vornehmen möchten.

setPriority(priority: number): void;

Parameter

priority

number

Gibt zurück

void

setStopIfTrue(stopIfTrue)

Wenn die Bedingungen dieses bedingten Formats erfüllt sind, werden keine Formate niedrigerer Priorität für diese Zelle wirksam. Der Wert ergibt sich null aus Datenbalken, Symbolsätzen und Farbskalen, da es für diese kein Konzept von StopIfTrue gibt.

setStopIfTrue(stopIfTrue: boolean): void;

Parameter

stopIfTrue

boolean

Gibt zurück

void