https://github.com/userr00t/typewritereffect
Adds a TypeWriter effect to Windows Forms Application.
https://github.com/userr00t/typewritereffect
Last synced: 7 months ago
JSON representation
Adds a TypeWriter effect to Windows Forms Application.
- Host: GitHub
- URL: https://github.com/userr00t/typewritereffect
- Owner: UserR00T
- License: gpl-3.0
- Created: 2018-10-05T19:24:07.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-22T11:51:01.000Z (over 6 years ago)
- Last Synced: 2025-10-09T07:35:22.410Z (8 months ago)
- Language: C#
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeWriterEffect
> Adds a TypeWriter effect to Windows Forms Application.
Version: [MP4](https://puu.sh/BGe5p/a6d56a0711.mp4) | [GIF](https://i.imgur.com/8AqlUU3.gif)
## Installation
1. Goto ``'Releases'``.
2. Download the latest version.
3. Reference the ``.dll`` into your Windows Forms Application project.
## How to use
1. Create a new ``Typewriter`` by typing
```CSharp
new Typewriter(Label, List, delayInMiliSeconds, repeatCursorTimes = 5, waitAtEndDelay = 0, start = true)
```
2. You can use the ``.Stop()``, ``.Start()``, and ``.Toggle()`` methods on the ``Typewriter`` instance.
## Example
```CSharp
// ...
using TypewriterEffect;
// ...
public static Typewriter typeWriter;
private void Main_Load(object sender, EventArgs e)
{
var list = new List
{
new Typewriter.Label("TypeWriterEffect", Typewriter.Label.LabelMode.OverwriteText),
new Typewriter.Label("Adds a TypeWriter effect to Windows Forms Application.", Typewriter.Label.LabelMode.OverwriteText),
new Typewriter.Label("Created by UserR00T.", Typewriter.Label.LabelMode.OverwriteText)
};
typeWriter = new Typewriter(mainLabel, list, 70, 2, 300);
}
private void ToggleBtn_Click(object sender, EventArgs e)
{
typeWriter.Toggle();
}
private void ForceEnableBtn_Click(object sender, EventArgs e)
{
typeWriter.Start();
}
private void ForceDisableBtn_Click(object sender, EventArgs e)
{
typeWriter.Stop();
}
private void DisposeBtn_Click(object sender, EventArgs e)
{
typeWriter.Dispose();
}
```
## Methods
Method | Function
--- | ---
``.Start()`` | Starts the typewriter.
``.Stop()`` | Stops the typewriter.
``.Toggle()`` | Toggles the typewriter.
## Constructor Arguments
```CSharp
public Typewriter(System.Windows.Forms.Label textLabel, List messages, int delayInMiliSeconds, int repeatCursorTimes = 5, int waitAtEndDelay = 0, bool start = true)
```
Argument | Type | Default | Function
--- | --- | --- | ---
``Label`` | ``Label`` | --- | The label this instance should work on.
``messages`` | ``List`` | --- | List of messages it'll go through.
``delayInMiliSeconds`` | ``int`` | --- | The delay between ticks in milliseconds.
``repeatCursorTimes`` | ``int`` | ``5`` | How many times should it repeat the ending cursor?
``waitAtEndDelay`` | ``int`` | ``0`` | Should it wait at the end for a specified amount of milliseconds?
``start`` | ``bool`` | ``true`` | Start typewriter once constructed?