github-starred/libxlsxwriter

Fork 0

mirror of https://github.com/jmcnamara/libxlsxwriter.git synced 2026-05-15 14:15:54 -06:00

[GH-ISSUE #393] A bug in documentation #314

New issue

Closed

opened 2026-05-05 12:08:31 -06:00 by gitea-mirror · 6 comments

gitea-mirror commented

2026-05-05 12:08:31 -06:00

Owner

Originally created by @Horseechen on GitHub (Feb 14, 2023).
Original GitHub issue: https://github.com/jmcnamara/libxlsxwriter/issues/393

There is a confusing error in the 7th example in the following code(http://libxlsxwriter.github.io/data_validate_8c-example.html ): data_validation->validate should be assigned with a value of LXW_VALIDATION_TYPE_LIST_FORMULA rather than LXW_VALIDATION_TYPE_LIST.

original code:

    /*
     * Example 7. Limiting input to a value in a dropdown list.
     */
    worksheet_write_string(worksheet,
                           CELL("A15"),
                           "Select a value from a drop down list (using a cell range)",
                           NULL);
 
    data_validation->validate     = LXW_VALIDATION_TYPE_LIST;
    data_validation->value_formula = "=$E$4:$G$4";
 
    worksheet_data_validation_cell(worksheet, CELL("B15"), data_validation);

it should be

    /*
     * Example 7. Limiting input to a value in a dropdown list.
     */
    worksheet_write_string(worksheet,
                           CELL("A15"),
                           "Select a value from a drop down list (using a cell range)",
                           NULL);
 
    data_validation->validate     = LXW_VALIDATION_TYPE_LIST_FORMULA;
    data_validation->value_formula = "=$E$4:$G$4";
 
    worksheet_data_validation_cell(worksheet, CELL("B15"), data_validation);

Originally created by @Horseechen on GitHub (Feb 14, 2023). Original GitHub issue: https://github.com/jmcnamara/libxlsxwriter/issues/393 There is a confusing error in the 7th example in the following code(http://libxlsxwriter.github.io/data_validate_8c-example.html ): `data_validation->validate` should be assigned with a value of `LXW_VALIDATION_TYPE_LIST_FORMULA` rather than `LXW_VALIDATION_TYPE_LIST`. original code: ```cpp /* * Example 7. Limiting input to a value in a dropdown list. */ worksheet_write_string(worksheet, CELL("A15"), "Select a value from a drop down list (using a cell range)", NULL); data_validation->validate = LXW_VALIDATION_TYPE_LIST; data_validation->value_formula = "=$E$4:$G$4"; worksheet_data_validation_cell(worksheet, CELL("B15"), data_validation); ``` it should be ```cpp /* * Example 7. Limiting input to a value in a dropdown list. */ worksheet_write_string(worksheet, CELL("A15"), "Select a value from a drop down list (using a cell range)", NULL); data_validation->validate = LXW_VALIDATION_TYPE_LIST_FORMULA; data_validation->value_formula = "=$E$4:$G$4"; worksheet_data_validation_cell(worksheet, CELL("B15"), data_validation); ```

gitea-mirror closed this issue

2026-05-05 12:08:33 -06:00

gitea-mirror commented

2026-05-05 12:08:36 -06:00

Author

Owner

@jmcnamara commented on GitHub (Feb 14, 2023):

The member name for data_validation->value_formula is a little bit confusing but the example is correct. The data validation list comes from a range in the spreadsheet:

Probably the member should be called something like value_range or value_source but I was trying to reuse/minimise the number of fields.

@jmcnamara commented on GitHub (Feb 14, 2023): The member name for `data_validation->value_formula` is a little bit confusing but the example is correct. The data validation list comes from a range in the spreadsheet: ![Screenshot 2023-02-14 at 14 25 31](https://user-images.githubusercontent.com/94267/218766788-e66fe7cc-499b-4dc4-b633-609244ddb520.png) Probably the member should be called something like `value_range` or `value_source` but I was trying to reuse/minimise the number of fields.

gitea-mirror commented

2026-05-05 12:08:37 -06:00

Author

Owner

@Horseechen commented on GitHub (Feb 14, 2023):

No, the example is incorrect. The parameter in Example 6 works in Example 7. You get the "right" result just by chance. You may try to change the value in reference cells then you will find that truth. Or you may comment Example 6's code, if you do so, the program will return a warning message.

@Horseechen commented on GitHub (Feb 14, 2023): No, the example is incorrect. The parameter in Example 6 works in Example 7. You get the "right" result just by chance. You may try to change the value in reference cells then you will find that truth. Or you may comment Example 6's code, if you do so, the program will return a warning message. ![2](https://user-images.githubusercontent.com/19280960/218786606-c97c41b9-c1f1-4356-9e5e-27c1e21a6759.png)

gitea-mirror commented

2026-05-05 12:08:39 -06:00

Author

Owner

@Horseechen commented on GitHub (Feb 14, 2023):

By the way, in this page http://libxlsxwriter.github.io/working_with_data_validation.html
data_validation->validate is assigned with LXW_VALIDATION_TYPE_LIST_FORMULA

Just check it, I believe that the example code is incorrect.
I followed the http://libxlsxwriter.github.io/working_with_data_validation.html page and got the right result.

@Horseechen commented on GitHub (Feb 14, 2023): By the way, in this page http://libxlsxwriter.github.io/working_with_data_validation.html `data_validation->validate` is assigned with `LXW_VALIDATION_TYPE_LIST_FORMULA` ![image](https://user-images.githubusercontent.com/19280960/218788613-09661f20-d0ae-4543-ae74-529fac236d7d.png) Just check it, I believe that the example code is incorrect. I followed the http://libxlsxwriter.github.io/working_with_data_validation.html page and got the right result.

gitea-mirror commented

2026-05-05 12:08:41 -06:00

Author

Owner

@jmcnamara commented on GitHub (Feb 14, 2023):

Ok, thanks. I get it now.

You are right the example is incorrect. The validation type should be LXW_VALIDATION_TYPE_LIST_FORMULA. I will fix it.

@jmcnamara commented on GitHub (Feb 14, 2023): Ok, thanks. I get it now. You are right the example is incorrect. The validation type should be `LXW_VALIDATION_TYPE_LIST_FORMULA`. I will fix it.

gitea-mirror commented

2026-05-05 12:08:42 -06:00

Author

Owner

@Horseechen commented on GitHub (Feb 14, 2023):

I would like to say thank you because the libxlsxwriter is really useful. Thank you for your sharing.

@Horseechen commented on GitHub (Feb 14, 2023): I would like to say thank you because the libxlsxwriter is really useful. Thank you for your sharing.

gitea-mirror commented

2026-05-05 12:08:44 -06:00

Author

Owner

@jmcnamara commented on GitHub (Feb 14, 2023):

Fixed on main and the documentation has been updated. Thanks for the report.

@jmcnamara commented on GitHub (Feb 14, 2023): Fixed on main and the documentation has been updated. Thanks for the report.