summaryrefslogtreecommitdiffhomepage
path: root/examples/list_validation_example.md
diff options
context:
space:
mode:
authorZsolt Kozaroczy <[email protected]>2020-09-11 00:36:29 +0200
committerGitHub <[email protected]>2020-09-11 00:36:29 +0200
commit282eec44ef01746ee25931fa6cd287ad083fd40b (patch)
tree14504bf429ca264812679ca971c1592853d3f762 /examples/list_validation_example.md
parent317e8244e4d17c394c1e181f86df3974623fb865 (diff)
downloadcaxlsx-282eec44ef01746ee25931fa6cd287ad083fd40b.tar.gz
caxlsx-282eec44ef01746ee25931fa6cd287ad083fd40b.zip
Restructure examples folder (#47)
Split examples into separate markdown files, each containing a description, sample code, and a screenshot of the resulting xlsx document. The script `generate.rb` is provided to actually generate the example documents by executing the sample code contained in the markdown files.
Diffstat (limited to 'examples/list_validation_example.md')
-rw-r--r--examples/list_validation_example.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/examples/list_validation_example.md b/examples/list_validation_example.md
new file mode 100644
index 00000000..1f2cfc0c
--- /dev/null
+++ b/examples/list_validation_example.md
@@ -0,0 +1,52 @@
+## Description
+
+You could validate data based on an explicit list or a given range of cells.
+
+## Code
+
+```ruby
+require 'axlsx'
+
+p = Axlsx::Package.new
+wb = p.workbook
+
+wb.add_worksheet(name: 'Basic Worksheet') do |sheet|
+ sheet.add_row ['First', 'Second', 'Third']
+ sheet.add_row [1, 6, 11]
+
+ sheet.add_data_validation('A2:A2',
+ type: :list,
+ formula1: 'A1:C1',
+ showDropDown: false,
+ showErrorMessage: true,
+ errorTitle: '',
+ error: 'Only values from A1:C1',
+ errorStyle: :stop,
+ showInputMessage: true,
+ promptTitle: '',
+ prompt: 'Only values from A1:C1')
+
+ sheet.add_data_validation('B2:B2',
+ type: :list,
+ formula1: '"Red, Orange, NavyBlue"',
+ showDropDown: false,
+ showErrorMessage: true,
+ errorTitle: '',
+ error: 'Please use the dropdown selector to choose the value',
+ errorStyle: :stop,
+ showInputMessage: true,
+ prompt: 'Choose the value from the dropdown')
+end
+
+p.serialize 'list_validation_example.xlsx'
+```
+
+## Output
+
+Validating by cells:
+
+![Output](images/list_validation_example_1.png "Output")
+
+Validating by list:
+
+![Output](images/list_validation_example_2.png "Output")