Types: VBA and macros

Definitions of the names from the “TypeScript type” column on the operation pages.

Other dictionary topics: session, workbook, and sheets · cells and ranges · formulas and calculation · formatting · data and sheet objects · pivot tables · charts and graphics · printing and page layout · Power Query · VBA and macros · protection and review · general and utility.

Types on this page — 36

• ContractMacroTrustIntent
• ContractMacroTrustInventoryCounts
• ContractMacroTrustProvenance
• ContractMacroTrustResult
• ContractMacroTrustState
• ContractTrustCenterMacroPolicy
• VbaBlockerSourceSpan
• VbaCapabilityBlocker
• VbaCapabilityBlockerKind
• VbaEntrypointDescriptor
• VbaExecutionOutcome
• VbaExecutionOutcomeKind
• VbaExecutionPlan
• VbaExecutionRoute
• VbaExecutionSessionId
• VbaMacroKind
• VbaMacroVisibility
• VbaModuleCapability
• VbaModuleKind
• VbaMutationPreview
• VbaMutationPreviewCell
• VbaProjectBlockerTally
• VbaProjectCapabilitySummary
• VbaProjectInspection
• VbaProjectReference
• VbaScheduledMacro
• VbaStructuralChange
• VbaStructuralChangeOperation
• VbaStructuralPreview
• VbaSuppliedAnswer
• VbaSystemFacts
• VbaUserForm
• VbaUserFormAction
• VbaUserFormField
• VbaUserFormFieldKind
• VbaUserFormUnsupportedControl

ContractMacroTrustIntent

type ContractMacroTrustIntent =
  | { action: "inspect" }
  | { action: "inspect_signatures" }
  | { action: "keep_macros" }
  | { action: "remove_macros_from_copy"; destinationUri: string }
  | { action: "save_signature_copy"; destinationUri: string }
  | { action: "remove_signatures" }
  | { action: "cancel" };

ContractMacroTrustInventoryCounts

interface ContractMacroTrustInventoryCounts {
  packageParts: number;
  vbaProjects: number;
  vbaRelationships: number;
  signatureParts: number;
  customUiParts: number;
  activeXParts: number;
  oleParts: number;
  formControlParts?: number;
  externalLinkParts?: number;
  externalRelationships?: number;
}

ContractMacroTrustProvenance

type ContractMacroTrustProvenance = "package-inventory" | "protected-view-policy" | "trusted-location-policy";

ContractMacroTrustResult

interface ContractMacroTrustResult {
  states: ContractMacroTrustState[];
  counts: ContractMacroTrustInventoryCounts;

  cryptographicSignatureValidated: false;

  vbaRuntimeAvailable: false;
  packageFormat?: ContractFileFormat;
  trustProvenance?: ContractMacroTrustProvenance[];
  opaquePreservationVerified?: boolean;
  sourceBytesUnchanged: boolean;
  copied: boolean;
  outputByteCount: number;
  removedPartCount: number;
  removedRelationshipCount: number;
  macroFreeRemainderCount?: number;
  sourceMutated?: boolean;
  signatureInventory?: OpcSignatureInventory;
  reasonCode?: string;
}

ContractMacroTrustState

type ContractMacroTrustState =
  | "macro-present"
  | "signature-part-present"
  | "unsigned"
  | "modified-after-signature-risk"
  | "malformed"
  | "blocked-by-protected-view"
  | "blocked-by-trusted-location"
  | "unsupported";

ContractTrustCenterMacroPolicy

type ContractTrustCenterMacroPolicy = "block_with_notification" | "block_without_notification";

VbaBlockerSourceSpan

interface VbaBlockerSourceSpan {

  line: number;

  column: number;

  length: number;

  offset: number;
}

VbaCapabilityBlocker

interface VbaCapabilityBlocker {
  kind: VbaCapabilityBlockerKind;

  detail: string;

  evidence: string;

  sourceSpan: VbaBlockerSourceSpan | null;

  module: string;

  procedure: string | null;
}

VbaCapabilityBlockerKind

type VbaCapabilityBlockerKind =
  | "external-automation"
  | "event-or-document-module"
  | "language-pending"
  | "host-member-pending"
  | "unparsed"
  | "run-declaration-pending"
  | "excel-compile-error";

VbaEntrypointDescriptor

interface VbaEntrypointDescriptor {

  entrypoint: string;
  module: string;
  procedure: string;
  kind: VbaMacroKind;
  visibility: VbaMacroVisibility;
  userRunnable: boolean;
  route: VbaExecutionRoute;

  nativeClaim: boolean;

  nativeLowerable: number;
  blockers: VbaCapabilityBlocker[];
}

VbaExecutionOutcome

interface VbaExecutionOutcome {
  kind: VbaExecutionOutcomeKind;

  stop: string | null;

  detail: string;

  rolledBack: boolean;

  progress?: {
    phase: "pending" | "running" | "finished";
    steps: number;
    instructionBudget: number;
    cancellationRequested: boolean;
  };
}

VbaExecutionOutcomeKind

type VbaExecutionOutcomeKind =
  | "running"
  | "completed"
  | "refused-by-capability"
  | "unknown-entrypoint"
  | "unresolved-code-module"
  | "runtime-error"
  | "runtime-stopped";

VbaExecutionPlan

interface VbaExecutionPlan {

  planId: string;

  planHash: string;
  entrypoint: string;

  route: VbaExecutionRoute | null;

  mayRunNatively: boolean;
  blockers: VbaCapabilityBlocker[];

  instructionBudget: number;

  steps: null;
}

VbaExecutionRoute

type VbaExecutionRoute = "native" | "excel-bridge" | "excel-bridge-legacy" | "preserve-only";

VbaExecutionSessionId

type VbaExecutionSessionId = string;

VbaMacroKind

type VbaMacroKind = "sub" | "function" | "property-get" | "property-let" | "property-set";

VbaMacroVisibility

type VbaMacroVisibility = "public" | "private" | "friend";

VbaModuleCapability

interface VbaModuleCapability {
  name: string;
  kind: VbaModuleKind;

  supportedLines: number;
  unsupportedLines: number;
  syntaxErrorLines: number;
  entrypointCount: number;
}

VbaModuleKind

type VbaModuleKind = "standard" | "document" | "class" | "form" | "unknown";

VbaMutationPreview

interface VbaMutationPreview {
  cells: VbaMutationPreviewCell[];

  structural: VbaStructuralPreview;

  structureTouched: boolean;

  sessionStateTouched: boolean;
}

VbaMutationPreviewCell

interface VbaMutationPreviewCell {
  sheet: string;
  row: number;
  col: number;

  beforeDisplayText: string | null;

  afterDisplayText: string | null;

  beforeFormula: string | null;
  afterFormula: string | null;
}

VbaProjectBlockerTally

interface VbaProjectBlockerTally {
  kind: VbaCapabilityBlockerKind;
  macros: number;
}

VbaProjectCapabilitySummary

interface VbaProjectCapabilitySummary {
  modules: number;
  macros: number;
  nativeCandidates: number;
  excelBridge: number;
  excelBridgeLegacy: number;
  preserveOnly: number;
  userRunnable: number;
  userRunnableNative: number;
  nativeCandidateRatio: number;
  topBlockers: VbaProjectBlockerTally[];
}

VbaProjectInspection

interface VbaProjectInspection {

  capabilityContractVersion: number;
  sourceLabel: string;
  projectName: string | null;

  codePage: number;
  modules: VbaModuleCapability[];
  references: VbaProjectReference[];
  entrypoints: VbaEntrypointDescriptor[];
  userForms: VbaUserForm[];
  summary: VbaProjectCapabilitySummary;
}

VbaProjectReference

interface VbaProjectReference {
  key: string;
  value: string;
}

VbaScheduledMacro

interface VbaScheduledMacro {
  earliestTimeSerial: number;
  procedure: string;
  latestTimeSerial?: number;
  schedule: boolean;
}

VbaStructuralChange

interface VbaStructuralChange {
  operation: VbaStructuralChangeOperation;

  sheet: string | null;

  description: string;
}

VbaStructuralChangeOperation

type VbaStructuralChangeOperation =
  | "sheet-added"
  | "sheet-renamed"
  | "sheet-deleted"
  | "cells-inserted"
  | "cells-deleted"
  | "name-defined"
  | "save-as-staged";

VbaStructuralPreview

type VbaStructuralPreview =
  | { state: "none" }
  | { state: "listed"; changes: VbaStructuralChange[] }
  | { state: "incomplete"; named: VbaStructuralChange[] };

VbaSuppliedAnswer

interface VbaSuppliedAnswer {

  kind: string;

  prompt?: string;

  value: string;
}

VbaSystemFacts

interface VbaSystemFacts {
  operatingSystem: string;
  userLibraryPath: string;
}

VbaUserForm

interface VbaUserForm {
  name: string;
  title: string;
  fields: VbaUserFormField[];
  actions: VbaUserFormAction[];
  unsupportedControls: VbaUserFormUnsupportedControl[];

  importError: string | null;
}

VbaUserFormAction

interface VbaUserFormAction {
  id: string;
  label: string;
  kind: "submit" | "cancel" | "custom";
  requiresConfirmation: boolean;
}

VbaUserFormField

interface VbaUserFormField {
  id: string;
  label: string;
  kind: VbaUserFormFieldKind;
  required: boolean;
  choices: string[];
  default: string | null;

  group: string | null;
}

VbaUserFormFieldKind

type VbaUserFormFieldKind =
  | "text"
  | "number"
  | "date"
  | "boolean"
  | "choice"
  | "multi_choice"
  | "range_picker"
  | "file_picker";

VbaUserFormUnsupportedControl

interface VbaUserFormUnsupportedControl {
  name: string;
  controlType: string;
}