# Prose.Mask struct

Namespace: [Grasshopper2](https://developer.rhino3d.com/api/gh2/namespace/grasshopper2.md) · Assembly: [Grasshopper2](https://developer.rhino3d.com/api/gh2/assembly/grasshopper2.md)

```cs
public struct Prose.Mask
```

Represents a boolean mask for each character in a string.

## Constructors

- [Prose.Mask](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/ctor.md): (2 overloads) Create a new string mask.

## Properties

- [Empty](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/empty.md): (static) Gets an empty mask.
- [Length](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/length.md): Gets the length of the mask.
- [MaskedBlocks](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/maskedblocks.md): Enumerate over all the masked ranges.
- [MaskedCount](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/maskedcount.md): Gets the number of true values in the mask.
- [UnmaskedBlocks](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/unmaskedblocks.md): Enumerate over all the unmasked ranges.
- [UnmaskedCount](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/unmaskedcount.md): Gets the number of false values in the mask.

## Indexers

- [this[]](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/item.md): Gets the mask boolean at the given index.

## Methods

- [Apply](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/apply.md): Apply this mask to a string of the same length.
- [Excise](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/excise.md): Cut out all masked parts of a string.
- [GrowMaskedBlocks](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/growmaskedblocks.md): Return a new mask whose masked blocks are one character bigger on either end.
- [IsFullyMasked](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/isfullymasked.md): Test whether the entire range is masked.
- [IsFullyUnmasked](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/isfullyunmasked.md): Test whether the entire range is unmasked.
- [IsMasked](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/ismasked.md): Gets whether the specific index is masked.
- [IsUnmasked](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/isunmasked.md): Gets whether the specific index is unmasked.
- [ShrinkMaskedBlocks](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/shrinkmaskedblocks.md): Return a new mask whose masked blocks are one character smaller on either end.
- [ToString](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/tostring.md): (2 overloads) Gets a string representation of the mask.

## Operators

- [operator &](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/op-bitwiseand.md): (static) 'And' two masks together.
- [operator |](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/op-bitwiseor.md): (static) 'Or' two masks together.
- [operator !](https://developer.rhino3d.com/api/gh2/type/grasshopper2.prose.mask/op-logicalnot.md): (static) Negate a string mask.
